module LinstorClient
Linstor REST API
Linstor REST API V1 The V1 rest api of Linstor should stay compatible and only additions are made to the API, If there are breaking changes or redesigned a new major REST API version will be issued. Server runs per default on port ‘3370` on `::` ipv6 and ipv4. To change the bind address or port you can use the following linstor client commands: “` linstor controller set-property REST/bindAddress 127.0.0.1 linstor controller set-property REST/port 8080 “` After setting this properties restart the controller and the new values should be used. Changelog: * 1.0.13 - Fixed broken volume definition modify `flags` handling - Added flags to volume groups (create/modify) * 1.0.12 - Added WritecacheResource
and WritecacheVolume
schemas. - Removed support for swordfish - Added `with_storage_pool` to PhysicalStorageCreate
post request, allowing to create linstor storage pools too - Added `gross` flag for volume-definition size - Added flags to VolumeDefinitionModify
(so that `gross` flag can be changed) - Added query-max-volume-size to resource-groups * 1.0.11 - Added /v1/physical-storage endpoint, that lets you query and create lvm/zfs pools - Extended Node
with list of supported providers and layers as well as lists of reasons for unsupported providers and layers * 1.0.10 - Added `reports` array field to Volume
object, contains ApiCallRcs for problems - Changed `ResourceDefinitions` can now include `VolumeDefinitions` in `volume_definitions` field - Added various filter query parameters * 1.0.9 - Added supports_snapshots to StoragePool
* 1.0.8 - Added /v1/resource-groups - Added /v1/resource-groups/{rscgrp}/volume-groups - Moved AutoSelectFilter::place_count default indirectly to create resource implementation - Added diskless_on_remaining to AutoSelectFilter
- Changed /v1/view/resources return type to ResourceWithVolumes
ResourceWithVolumes
is now a child type of Resource
(removed volumes from Resource
) * 1.0.7 - Added ext_meta_stor_pool to DrbdVolume
- Added is_active field to the NetInterface
type * 1.0.6 - Added /v1/resource-definitions/{rscName}/resources/{nodeName}/volumes/{vlmnr} PUT * 1.0.5 - Added `reports` field to StoragePool
object * 1.0.4 - Added /v1/view/storage-pools overview path - Added uuid fields for objects * 1.0.3 - Added /v1/view/resources overview path - documentation schema extraction * 1.0.2 - Added /v1/storage-pool-definitions object path - added NVME layer object type * 1.0.1 - Documentation review and updates - no functional changes * 1.0.0 - Initial REST API v1
The version of the OpenAPI document: 1.0.13 Contact: rene.peinthor@linbit.com Generated by: openapi-generator.tech OpenAPI Generator version: 5.3.1
Linstor REST API
Linstor REST API V1 The V1 rest api of Linstor should stay compatible and only additions are made to the API, If there are breaking changes or redesigned a new major REST API version will be issued. Server runs per default on port ‘3370` on `::` ipv6 and ipv4. To change the bind address or port you can use the following linstor client commands: “` linstor controller set-property REST/bindAddress 127.0.0.1 linstor controller set-property REST/port 8080 “` After setting this properties restart the controller and the new values should be used. Changelog: * 1.0.13 - Fixed broken volume definition modify `flags` handling - Added flags to volume groups (create/modify) * 1.0.12 - Added WritecacheResource
and WritecacheVolume
schemas. - Removed support for swordfish - Added `with_storage_pool` to PhysicalStorageCreate
post request, allowing to create linstor storage pools too - Added `gross` flag for volume-definition size - Added flags to VolumeDefinitionModify
(so that `gross` flag can be changed) - Added query-max-volume-size to resource-groups * 1.0.11 - Added /v1/physical-storage endpoint, that lets you query and create lvm/zfs pools - Extended Node
with list of supported providers and layers as well as lists of reasons for unsupported providers and layers * 1.0.10 - Added `reports` array field to Volume
object, contains ApiCallRcs for problems - Changed `ResourceDefinitions` can now include `VolumeDefinitions` in `volume_definitions` field - Added various filter query parameters * 1.0.9 - Added supports_snapshots to StoragePool
* 1.0.8 - Added /v1/resource-groups - Added /v1/resource-groups/{rscgrp}/volume-groups - Moved AutoSelectFilter::place_count default indirectly to create resource implementation - Added diskless_on_remaining to AutoSelectFilter
- Changed /v1/view/resources return type to ResourceWithVolumes
ResourceWithVolumes
is now a child type of Resource
(removed volumes from Resource
) * 1.0.7 - Added ext_meta_stor_pool to DrbdVolume
- Added is_active field to the NetInterface
type * 1.0.6 - Added /v1/resource-definitions/{rscName}/resources/{nodeName}/volumes/{vlmnr} PUT * 1.0.5 - Added `reports` field to StoragePool
object * 1.0.4 - Added /v1/view/storage-pools overview path - Added uuid fields for objects * 1.0.3 - Added /v1/view/resources overview path - documentation schema extraction * 1.0.2 - Added /v1/storage-pool-definitions object path - added NVME layer object type * 1.0.1 - Documentation review and updates - no functional changes * 1.0.0 - Initial REST API v1
The version of the OpenAPI document: 1.0.13 Contact: rene.peinthor@linbit.com Generated by: openapi-generator.tech OpenAPI Generator version: 5.3.1
Linstor REST API
Linstor REST API V1 The V1 rest api of Linstor should stay compatible and only additions are made to the API, If there are breaking changes or redesigned a new major REST API version will be issued. Server runs per default on port ‘3370` on `::` ipv6 and ipv4. To change the bind address or port you can use the following linstor client commands: “` linstor controller set-property REST/bindAddress 127.0.0.1 linstor controller set-property REST/port 8080 “` After setting this properties restart the controller and the new values should be used. Changelog: * 1.0.13 - Fixed broken volume definition modify `flags` handling - Added flags to volume groups (create/modify) * 1.0.12 - Added WritecacheResource
and WritecacheVolume
schemas. - Removed support for swordfish - Added `with_storage_pool` to PhysicalStorageCreate
post request, allowing to create linstor storage pools too - Added `gross` flag for volume-definition size - Added flags to VolumeDefinitionModify
(so that `gross` flag can be changed) - Added query-max-volume-size to resource-groups * 1.0.11 - Added /v1/physical-storage endpoint, that lets you query and create lvm/zfs pools - Extended Node
with list of supported providers and layers as well as lists of reasons for unsupported providers and layers * 1.0.10 - Added `reports` array field to Volume
object, contains ApiCallRcs for problems - Changed `ResourceDefinitions` can now include `VolumeDefinitions` in `volume_definitions` field - Added various filter query parameters * 1.0.9 - Added supports_snapshots to StoragePool
* 1.0.8 - Added /v1/resource-groups - Added /v1/resource-groups/{rscgrp}/volume-groups - Moved AutoSelectFilter::place_count default indirectly to create resource implementation - Added diskless_on_remaining to AutoSelectFilter
- Changed /v1/view/resources return type to ResourceWithVolumes
ResourceWithVolumes
is now a child type of Resource
(removed volumes from Resource
) * 1.0.7 - Added ext_meta_stor_pool to DrbdVolume
- Added is_active field to the NetInterface
type * 1.0.6 - Added /v1/resource-definitions/{rscName}/resources/{nodeName}/volumes/{vlmnr} PUT * 1.0.5 - Added `reports` field to StoragePool
object * 1.0.4 - Added /v1/view/storage-pools overview path - Added uuid fields for objects * 1.0.3 - Added /v1/view/resources overview path - documentation schema extraction * 1.0.2 - Added /v1/storage-pool-definitions object path - added NVME layer object type * 1.0.1 - Documentation review and updates - no functional changes * 1.0.0 - Initial REST API v1
The version of the OpenAPI document: 1.0.13 Contact: rene.peinthor@linbit.com Generated by: openapi-generator.tech OpenAPI Generator version: 5.3.1
Constants
- VERSION
Public Class Methods
Customize default settings for the SDK using block.
LinstorClient.configure do |config| config.username = "xxx" config.password = "xxx" end
If no block given, return the default Configuration
object.
# File lib/ruby-linstor-client.rb, line 101 def configure if block_given? yield(Configuration.default) else Configuration.default end end