Module: LinstorClient

Defined in:: lib/ruby-linstor-client/version.rb,
lib/ruby-linstor-client.rb,
lib/ruby-linstor-client/api_error.rb,
lib/ruby-linstor-client/api_client.rb,
lib/ruby-linstor-client/models/node.rb,
lib/ruby-linstor-client/configuration.rb,
lib/ruby-linstor-client/models/volume.rb,
lib/ruby-linstor-client/models/resource.rb,
lib/ruby-linstor-client/models/snapshot.rb,
lib/ruby-linstor-client/models/candidate.rb,
lib/ruby-linstor-client/models/log_level.rb,
lib/ruby-linstor-client/models/layer_type.rb,
lib/ruby-linstor-client/api/developers_api.rb,
lib/ruby-linstor-client/models/api_call_rc.rb,
lib/ruby-linstor-client/models/drbd_volume.rb,
lib/ruby-linstor-client/models/luks_volume.rb,
lib/ruby-linstor-client/models/node_modify.rb,
lib/ruby-linstor-client/models/nvme_volume.rb,
lib/ruby-linstor-client/models/cache_volume.rb,
lib/ruby-linstor-client/models/error_report.rb,
lib/ruby-linstor-client/models/storage_pool.rb,
lib/ruby-linstor-client/models/volume_group.rb,
lib/ruby-linstor-client/models/volume_layer.rb,
lib/ruby-linstor-client/models/volume_state.rb,
lib/ruby-linstor-client/models/drbd_resource.rb,
lib/ruby-linstor-client/models/luks_resource.rb,
lib/ruby-linstor-client/models/net_interface.rb,
lib/ruby-linstor-client/models/nvme_resource.rb,
lib/ruby-linstor-client/models/provider_kind.rb,
lib/ruby-linstor-client/models/snapshot_node.rb,
lib/ruby-linstor-client/models/volume_modify.rb,
lib/ruby-linstor-client/models/cache_resource.rb,
lib/ruby-linstor-client/models/resource_group.rb,
lib/ruby-linstor-client/models/resource_layer.rb,
lib/ruby-linstor-client/models/resource_state.rb,
lib/ruby-linstor-client/models/storage_volume.rb,
lib/ruby-linstor-client/models/drbd_connection.rb,
lib/ruby-linstor-client/models/key_value_store.rb,
lib/ruby-linstor-client/models/openflex_volume.rb,
lib/ruby-linstor-client/models/resource_create.rb,
lib/ruby-linstor-client/models/resource_modify.rb,
lib/ruby-linstor-client/models/max_volume_sizes.rb,
lib/ruby-linstor-client/models/physical_storage.rb,
lib/ruby-linstor-client/models/satellite_config.rb,
lib/ruby-linstor-client/models/snapshot_restore.rb,
lib/ruby-linstor-client/models/storage_resource.rb,
lib/ruby-linstor-client/models/controller_config.rb,
lib/ruby-linstor-client/models/drbd_proxy_enable.rb,
lib/ruby-linstor-client/models/drbd_proxy_modify.rb,
lib/ruby-linstor-client/models/openflex_resource.rb,
lib/ruby-linstor-client/models/snapshot_shipping.rb,
lib/ruby-linstor-client/models/volume_definition.rb,
lib/ruby-linstor-client/models/writecache_volume.rb,
lib/ruby-linstor-client/models/auto_place_request.rb,
lib/ruby-linstor-client/models/auto_select_filter.rb,
lib/ruby-linstor-client/models/controller_version.rb,
lib/ruby-linstor-client/models/pass_phrase_create.rb,
lib/ruby-linstor-client/models/error_report_delete.rb,
lib/ruby-linstor-client/models/resource_connection.rb,
lib/ruby-linstor-client/models/resource_definition.rb,
lib/ruby-linstor-client/models/volume_group_modify.rb,
lib/ruby-linstor-client/models/writecache_resource.rb,
lib/ruby-linstor-client/models/controller_config_db.rb,
lib/ruby-linstor-client/models/resource_group_spawn.rb,
lib/ruby-linstor-client/models/satellite_config_log.rb,
lib/ruby-linstor-client/models/satellite_config_net.rb,
lib/ruby-linstor-client/models/controller_config_log.rb,
lib/ruby-linstor-client/models/resource_group_modify.rb,
lib/ruby-linstor-client/models/resource_with_volumes.rb,
lib/ruby-linstor-client/models/controller_config_http.rb,
lib/ruby-linstor-client/models/controller_config_ldap.rb,
lib/ruby-linstor-client/models/drbd_volume_definition.rb,
lib/ruby-linstor-client/models/key_value_store_modify.rb,
lib/ruby-linstor-client/models/controller_config_debug.rb,
lib/ruby-linstor-client/models/controller_config_https.rb,
lib/ruby-linstor-client/models/controller_props_modify.rb,
lib/ruby-linstor-client/models/physical_storage_create.rb,
lib/ruby-linstor-client/models/physical_storage_device.rb,
lib/ruby-linstor-client/models/storage_pool_definition.rb,
lib/ruby-linstor-client/models/volume_definition_layer.rb,
lib/ruby-linstor-client/models/controller_config_config.rb,
lib/ruby-linstor-client/models/event_may_promote_change.rb,
lib/ruby-linstor-client/models/snapshot_shipping_status.rb,
lib/ruby-linstor-client/models/volume_definition_create.rb,
lib/ruby-linstor-client/models/volume_definition_modify.rb,
lib/ruby-linstor-client/models/controller_config_db_etcd.rb,
lib/ruby-linstor-client/models/resource_definition_layer.rb,
lib/ruby-linstor-client/models/resource_connection_modify.rb,
lib/ruby-linstor-client/models/resource_definition_create.rb,
lib/ruby-linstor-client/models/resource_definition_modify.rb,
lib/ruby-linstor-client/models/snapshot_volume_definition.rb,
lib/ruby-linstor-client/models/resource_with_volumes_all_of.rb,
lib/ruby-linstor-client/models/one_of_drbd_volume_definition.rb,
lib/ruby-linstor-client/models/drbd_resource_definition_layer.rb,
lib/ruby-linstor-client/models/storage_pool_definition_modify.rb,
lib/ruby-linstor-client/models/openflex_resource_definition_layer.rb,
lib/ruby-linstor-client/models/physical_storage_storage_pool_create.rb,
lib/ruby-linstor-client/models/one_of_drbd_resource_definition_layer.rb,
lib/ruby-linstor-client/models/one_of_drbd_volume_luks_volume_storage_nvme_volme_writecache_volume.rb,
lib/ruby-linstor-client/models/one_of_drbd_volume_luks_volume_storage_nvme_volme_writecache_volume_cache_volume.rb

Overview

#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.5.0 - Added etcd.prefix to ControllerConfigDbEtcd parameters * 1.4.0 - Added promotion_score and may_promote to DrbdResource object - Added /v1/error-reports DELETE method, to delete a range of error reports or single ones - Added SSE (Server Sent Events) url /v1/events/drbd/promotion * 1.3.0 - Added /v1/view/snapshot-shippings * 1.2.0 - Added optional AutoSelectFilter to resource-group/spawn - Added /v1/nodes/node/config, that allows you to get and set the satellite config - Added /v1/sos-report to create bug reports you can send to linbit - Added new fields to the ErrorReport object - Added /v1/resource-definitions/resource/snapshot-shipping - Allow to modify the resource group in Resource definitions - Added createTimestamp to Resource and Snapshot - Added default value (null) for AutoPlaceRequest’s layer_list * 1.1.0 - Added /v1/view/snapshots for a faster all in one snapshot list - Filter lists by properties: - /v1/nodes - /v1/resource-definitions - /v1/resource-groups - /v1/view/storage-pools - /v1/view/resources * 1.0.16 - Added CacheResource and CacheVolume schemas - AutSelectFilter arrays are now null per default * 1.0.15 - Added connections map to the DRBD resource layer data - Added support for Openflex * 1.0.14 - Added /v1/controller/config, that gives you the controller config information * 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.5.0 Contact: [email protected] Generated by: openapi-generator.tech OpenAPI Generator version: 5.3.1

Defined Under Namespace

Classes: ApiCallRc, ApiClient, ApiError, AutoPlaceRequest, AutoSelectFilter, CacheResource, CacheVolume, Candidate, Configuration, ControllerConfig, ControllerConfigConfig, ControllerConfigDb, ControllerConfigDbEtcd, ControllerConfigDebug, ControllerConfigHttp, ControllerConfigHttps, ControllerConfigLdap, ControllerConfigLog, ControllerPropsModify, ControllerVersion, DevelopersApi, DrbdConnection, DrbdProxyEnable, DrbdProxyModify, DrbdResource, DrbdResourceDefinitionLayer, DrbdVolume, DrbdVolumeDefinition, ErrorReport, ErrorReportDelete, EventMayPromoteChange, KeyValueStore, KeyValueStoreModify, LUKSResource, LUKSVolume, LayerType, LogLevel, MaxVolumeSizes, NVMEResource, NVMEVolume, NetInterface, Node, NodeModify, OneOfDrbdResourceDefinitionLayer, OneOfDrbdVolumeDefinition, OneOfDrbdVolumeLUKSVolumeStorageVolumeNVMEVolumeWritecacheVolume, OneOfDrbdVolumeLUKSVolumeStorageVolumeNVMEVolumeWritecacheVolumeCacheVolume, OpenflexResource, OpenflexResourceDefinitionLayer, OpenflexVolume, PassPhraseCreate, PhysicalStorage, PhysicalStorageCreate, PhysicalStorageDevice, PhysicalStorageStoragePoolCreate, ProviderKind, Resource, ResourceConnection, ResourceConnectionModify, ResourceCreate, ResourceDefinition, ResourceDefinitionCreate, ResourceDefinitionLayer, ResourceDefinitionModify, ResourceGroup, ResourceGroupModify, ResourceGroupSpawn, ResourceLayer, ResourceModify, ResourceState, ResourceWithVolumes, ResourceWithVolumesAllOf, SatelliteConfig, SatelliteConfigLog, SatelliteConfigNet, Snapshot, SnapshotNode, SnapshotRestore, SnapshotShipping, SnapshotShippingStatus, SnapshotVolumeDefinition, StoragePool, StoragePoolDefinition, StoragePoolDefinitionModify, StorageResource, StorageVolume, Volume, VolumeDefinition, VolumeDefinitionCreate, VolumeDefinitionLayer, VolumeDefinitionModify, VolumeGroup, VolumeGroupModify, VolumeLayer, VolumeModify, VolumeState, WritecacheResource, WritecacheVolume

Constant Summary collapse

VERSION =

'1.1.1'

Class Method Summary collapse

.configure ⇒ Object

Customize default settings for the SDK using block.

Class Method Details

.configure ⇒ `Object`

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 125

def configure
  if block_given?
    yield(Configuration.default)
  else
    Configuration.default
  end
end