ruby-linstor-client 1.0.0 → 1.1.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (132) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +4 -4
  3. data/codegen.sh +1 -1
  4. data/generator/custom/one_of_drbd_volume_luks_volume_storage_nvme_volme_writecache_volume.rb +1 -1
  5. data/generator/custom/one_of_drbd_volume_luks_volume_storage_nvme_volme_writecache_volume_cache_volume.rb +11 -0
  6. data/lib/ruby-linstor-client/api/developers_api.rb +923 -103
  7. data/lib/ruby-linstor-client/api_client.rb +2 -2
  8. data/lib/ruby-linstor-client/api_error.rb +2 -2
  9. data/lib/ruby-linstor-client/configuration.rb +2 -2
  10. data/lib/ruby-linstor-client/models/api_call_rc.rb +2 -2
  11. data/lib/ruby-linstor-client/models/auto_place_request.rb +2 -2
  12. data/lib/ruby-linstor-client/models/auto_select_filter.rb +25 -3
  13. data/lib/ruby-linstor-client/models/cache_resource.rb +220 -0
  14. data/lib/ruby-linstor-client/models/cache_volume.rb +276 -0
  15. data/lib/ruby-linstor-client/models/candidate.rb +2 -2
  16. data/lib/ruby-linstor-client/models/controller_config.rb +272 -0
  17. data/lib/ruby-linstor-client/models/controller_config_config.rb +218 -0
  18. data/lib/ruby-linstor-client/models/controller_config_db.rb +263 -0
  19. data/lib/ruby-linstor-client/models/controller_config_db_etcd.rb +227 -0
  20. data/lib/ruby-linstor-client/models/controller_config_debug.rb +218 -0
  21. data/lib/ruby-linstor-client/models/controller_config_http.rb +236 -0
  22. data/lib/ruby-linstor-client/models/controller_config_https.rb +236 -0
  23. data/lib/ruby-linstor-client/models/controller_config_ldap.rb +263 -0
  24. data/lib/ruby-linstor-client/models/controller_config_log.rb +315 -0
  25. data/lib/ruby-linstor-client/models/controller_props_modify.rb +2 -2
  26. data/lib/ruby-linstor-client/models/controller_version.rb +2 -2
  27. data/lib/ruby-linstor-client/models/drbd_connection.rb +262 -0
  28. data/lib/ruby-linstor-client/models/drbd_proxy_enable.rb +2 -2
  29. data/lib/ruby-linstor-client/models/drbd_proxy_modify.rb +2 -2
  30. data/lib/ruby-linstor-client/models/drbd_resource.rb +35 -6
  31. data/lib/ruby-linstor-client/models/drbd_resource_definition_layer.rb +2 -2
  32. data/lib/ruby-linstor-client/models/drbd_volume.rb +2 -2
  33. data/lib/ruby-linstor-client/models/drbd_volume_definition.rb +2 -2
  34. data/lib/ruby-linstor-client/models/error_report.rb +87 -7
  35. data/lib/ruby-linstor-client/models/error_report_delete.rb +273 -0
  36. data/lib/ruby-linstor-client/models/event_may_promote_change.rb +237 -0
  37. data/lib/ruby-linstor-client/models/key_value_store.rb +2 -2
  38. data/lib/ruby-linstor-client/models/key_value_store_modify.rb +2 -2
  39. data/lib/ruby-linstor-client/models/layer_type.rb +4 -2
  40. data/lib/ruby-linstor-client/models/log_level.rb +40 -0
  41. data/lib/ruby-linstor-client/models/luks_resource.rb +2 -2
  42. data/lib/ruby-linstor-client/models/luks_volume.rb +2 -2
  43. data/lib/ruby-linstor-client/models/max_volume_sizes.rb +2 -2
  44. data/lib/ruby-linstor-client/models/net_interface.rb +2 -2
  45. data/lib/ruby-linstor-client/models/node.rb +4 -4
  46. data/lib/ruby-linstor-client/models/node_modify.rb +2 -2
  47. data/lib/ruby-linstor-client/models/nvme_resource.rb +2 -2
  48. data/lib/ruby-linstor-client/models/nvme_volume.rb +2 -2
  49. data/lib/ruby-linstor-client/models/one_of_drbd_volume_luks_volume_storage_nvme_volme_writecache_volume.rb +1 -1
  50. data/lib/ruby-linstor-client/models/one_of_drbd_volume_luks_volume_storage_nvme_volme_writecache_volume_cache_volume.rb +11 -0
  51. data/lib/ruby-linstor-client/models/openflex_resource.rb +229 -0
  52. data/lib/ruby-linstor-client/models/openflex_resource_definition_layer.rb +227 -0
  53. data/lib/ruby-linstor-client/models/openflex_volume.rb +256 -0
  54. data/lib/ruby-linstor-client/models/pass_phrase_create.rb +2 -2
  55. data/lib/ruby-linstor-client/models/physical_storage.rb +2 -2
  56. data/lib/ruby-linstor-client/models/physical_storage_create.rb +2 -2
  57. data/lib/ruby-linstor-client/models/physical_storage_device.rb +2 -2
  58. data/lib/ruby-linstor-client/models/physical_storage_storage_pool_create.rb +2 -2
  59. data/lib/ruby-linstor-client/models/provider_kind.rb +3 -2
  60. data/lib/ruby-linstor-client/models/resource.rb +16 -6
  61. data/lib/ruby-linstor-client/models/resource_connection.rb +2 -2
  62. data/lib/ruby-linstor-client/models/resource_connection_modify.rb +2 -2
  63. data/lib/ruby-linstor-client/models/resource_create.rb +2 -2
  64. data/lib/ruby-linstor-client/models/resource_definition.rb +2 -2
  65. data/lib/ruby-linstor-client/models/resource_definition_create.rb +2 -2
  66. data/lib/ruby-linstor-client/models/resource_definition_layer.rb +3 -3
  67. data/lib/ruby-linstor-client/models/resource_definition_modify.rb +16 -6
  68. data/lib/ruby-linstor-client/models/resource_group.rb +2 -2
  69. data/lib/ruby-linstor-client/models/resource_group_modify.rb +2 -2
  70. data/lib/ruby-linstor-client/models/resource_group_spawn.rb +22 -3
  71. data/lib/ruby-linstor-client/models/resource_layer.rb +24 -6
  72. data/lib/ruby-linstor-client/models/resource_modify.rb +2 -2
  73. data/lib/ruby-linstor-client/models/resource_state.rb +2 -2
  74. data/lib/ruby-linstor-client/models/resource_with_volumes.rb +13 -3
  75. data/lib/ruby-linstor-client/models/resource_with_volumes_all_of.rb +2 -2
  76. data/lib/ruby-linstor-client/models/satellite_config.rb +272 -0
  77. data/lib/ruby-linstor-client/models/satellite_config_log.rb +245 -0
  78. data/lib/ruby-linstor-client/models/satellite_config_net.rb +236 -0
  79. data/lib/ruby-linstor-client/models/snapshot.rb +17 -6
  80. data/lib/ruby-linstor-client/models/snapshot_node.rb +261 -0
  81. data/lib/ruby-linstor-client/models/snapshot_restore.rb +2 -2
  82. data/lib/ruby-linstor-client/models/snapshot_shipping.rb +259 -0
  83. data/lib/ruby-linstor-client/models/snapshot_shipping_status.rb +279 -0
  84. data/lib/ruby-linstor-client/models/snapshot_volume_definition.rb +2 -2
  85. data/lib/ruby-linstor-client/models/storage_pool.rb +2 -2
  86. data/lib/ruby-linstor-client/models/storage_pool_definition.rb +2 -2
  87. data/lib/ruby-linstor-client/models/storage_pool_definition_modify.rb +2 -2
  88. data/lib/ruby-linstor-client/models/storage_resource.rb +2 -2
  89. data/lib/ruby-linstor-client/models/storage_volume.rb +2 -2
  90. data/lib/ruby-linstor-client/models/volume.rb +2 -2
  91. data/lib/ruby-linstor-client/models/volume_definition.rb +2 -2
  92. data/lib/ruby-linstor-client/models/volume_definition_create.rb +2 -2
  93. data/lib/ruby-linstor-client/models/volume_definition_layer.rb +2 -2
  94. data/lib/ruby-linstor-client/models/volume_definition_modify.rb +2 -2
  95. data/lib/ruby-linstor-client/models/volume_group.rb +2 -2
  96. data/lib/ruby-linstor-client/models/volume_group_modify.rb +2 -2
  97. data/lib/ruby-linstor-client/models/volume_layer.rb +3 -3
  98. data/lib/ruby-linstor-client/models/volume_modify.rb +2 -2
  99. data/lib/ruby-linstor-client/models/volume_state.rb +2 -2
  100. data/lib/ruby-linstor-client/models/writecache_resource.rb +2 -2
  101. data/lib/ruby-linstor-client/models/writecache_volume.rb +2 -2
  102. data/lib/ruby-linstor-client/version.rb +3 -3
  103. data/lib/ruby-linstor-client.rb +26 -2
  104. data/pkg/ruby-linstor-client-1.0.0.gem +0 -0
  105. data/spec/api_client_spec.rb +2 -2
  106. data/spec/configuration_spec.rb +2 -2
  107. data/spec/models/cache_resource_spec.rb +34 -0
  108. data/spec/models/cache_volume_spec.rb +70 -0
  109. data/spec/models/controller_config_config_spec.rb +34 -0
  110. data/spec/models/controller_config_db_etcd_spec.rb +40 -0
  111. data/spec/models/controller_config_db_spec.rb +64 -0
  112. data/spec/models/controller_config_debug_spec.rb +34 -0
  113. data/spec/models/controller_config_http_spec.rb +46 -0
  114. data/spec/models/controller_config_https_spec.rb +46 -0
  115. data/spec/models/controller_config_ldap_spec.rb +64 -0
  116. data/spec/models/controller_config_log_spec.rb +80 -0
  117. data/spec/models/controller_config_spec.rb +70 -0
  118. data/spec/models/drbd_connection_spec.rb +44 -0
  119. data/spec/models/error_report_delete_spec.rb +64 -0
  120. data/spec/models/event_may_promote_change_spec.rb +46 -0
  121. data/spec/models/log_level_spec.rb +28 -0
  122. data/spec/models/openflex_resource_definition_layer_spec.rb +40 -0
  123. data/spec/models/openflex_resource_spec.rb +40 -0
  124. data/spec/models/openflex_volume_spec.rb +58 -0
  125. data/spec/models/satellite_config_log_spec.rb +52 -0
  126. data/spec/models/satellite_config_net_spec.rb +46 -0
  127. data/spec/models/satellite_config_spec.rb +70 -0
  128. data/spec/models/snapshot_node_spec.rb +58 -0
  129. data/spec/models/snapshot_shipping_spec.rb +52 -0
  130. data/spec/models/snapshot_shipping_status_spec.rb +56 -0
  131. data/spec/spec_helper.rb +2 -2
  132. metadata +77 -3
@@ -0,0 +1,276 @@
1
+ =begin
2
+ #Linstor REST API
3
+
4
+ #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
5
+
6
+ The version of the OpenAPI document: 1.5.0
7
+ Contact: rene.peinthor@linbit.com
8
+ Generated by: https://openapi-generator.tech
9
+ OpenAPI Generator version: 5.3.1
10
+
11
+ =end
12
+
13
+ require 'date'
14
+ require 'time'
15
+
16
+ module LinstorClient
17
+ class CacheVolume
18
+ attr_accessor :volume_number
19
+
20
+ # block device path
21
+ attr_accessor :device_path
22
+
23
+ # block device path used as cache device
24
+ attr_accessor :device_path_cache
25
+
26
+ # block device path used as meta device
27
+ attr_accessor :device_meta_cache
28
+
29
+ attr_accessor :allocated_size_kib
30
+
31
+ attr_accessor :usable_size_kib
32
+
33
+ # String describing current volume state
34
+ attr_accessor :disk_state
35
+
36
+ # Attribute mapping from ruby-style variable name to JSON key.
37
+ def self.attribute_map
38
+ {
39
+ :'volume_number' => :'volume_number',
40
+ :'device_path' => :'device_path',
41
+ :'device_path_cache' => :'device_path_cache',
42
+ :'device_meta_cache' => :'device_meta_cache',
43
+ :'allocated_size_kib' => :'allocated_size_kib',
44
+ :'usable_size_kib' => :'usable_size_kib',
45
+ :'disk_state' => :'disk_state'
46
+ }
47
+ end
48
+
49
+ # Returns all the JSON keys this model knows about
50
+ def self.acceptable_attributes
51
+ attribute_map.values
52
+ end
53
+
54
+ # Attribute type mapping.
55
+ def self.openapi_types
56
+ {
57
+ :'volume_number' => :'Integer',
58
+ :'device_path' => :'String',
59
+ :'device_path_cache' => :'String',
60
+ :'device_meta_cache' => :'String',
61
+ :'allocated_size_kib' => :'Integer',
62
+ :'usable_size_kib' => :'Integer',
63
+ :'disk_state' => :'String'
64
+ }
65
+ end
66
+
67
+ # List of attributes with nullable: true
68
+ def self.openapi_nullable
69
+ Set.new([
70
+ ])
71
+ end
72
+
73
+ # Initializes the object
74
+ # @param [Hash] attributes Model attributes in the form of hash
75
+ def initialize(attributes = {})
76
+ if (!attributes.is_a?(Hash))
77
+ fail ArgumentError, "The input argument (attributes) must be a hash in `LinstorClient::CacheVolume` initialize method"
78
+ end
79
+
80
+ # check to see if the attribute exists and convert string to symbol for hash key
81
+ attributes = attributes.each_with_object({}) { |(k, v), h|
82
+ if (!self.class.attribute_map.key?(k.to_sym))
83
+ fail ArgumentError, "`#{k}` is not a valid attribute in `LinstorClient::CacheVolume`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
84
+ end
85
+ h[k.to_sym] = v
86
+ }
87
+
88
+ if attributes.key?(:'volume_number')
89
+ self.volume_number = attributes[:'volume_number']
90
+ end
91
+
92
+ if attributes.key?(:'device_path')
93
+ self.device_path = attributes[:'device_path']
94
+ end
95
+
96
+ if attributes.key?(:'device_path_cache')
97
+ self.device_path_cache = attributes[:'device_path_cache']
98
+ end
99
+
100
+ if attributes.key?(:'device_meta_cache')
101
+ self.device_meta_cache = attributes[:'device_meta_cache']
102
+ end
103
+
104
+ if attributes.key?(:'allocated_size_kib')
105
+ self.allocated_size_kib = attributes[:'allocated_size_kib']
106
+ end
107
+
108
+ if attributes.key?(:'usable_size_kib')
109
+ self.usable_size_kib = attributes[:'usable_size_kib']
110
+ end
111
+
112
+ if attributes.key?(:'disk_state')
113
+ self.disk_state = attributes[:'disk_state']
114
+ end
115
+ end
116
+
117
+ # Show invalid properties with the reasons. Usually used together with valid?
118
+ # @return Array for valid properties with the reasons
119
+ def list_invalid_properties
120
+ invalid_properties = Array.new
121
+ invalid_properties
122
+ end
123
+
124
+ # Check to see if the all the properties in the model are valid
125
+ # @return true if the model is valid
126
+ def valid?
127
+ true
128
+ end
129
+
130
+ # Checks equality by comparing each attribute.
131
+ # @param [Object] Object to be compared
132
+ def ==(o)
133
+ return true if self.equal?(o)
134
+ self.class == o.class &&
135
+ volume_number == o.volume_number &&
136
+ device_path == o.device_path &&
137
+ device_path_cache == o.device_path_cache &&
138
+ device_meta_cache == o.device_meta_cache &&
139
+ allocated_size_kib == o.allocated_size_kib &&
140
+ usable_size_kib == o.usable_size_kib &&
141
+ disk_state == o.disk_state
142
+ end
143
+
144
+ # @see the `==` method
145
+ # @param [Object] Object to be compared
146
+ def eql?(o)
147
+ self == o
148
+ end
149
+
150
+ # Calculates hash code according to all attributes.
151
+ # @return [Integer] Hash code
152
+ def hash
153
+ [volume_number, device_path, device_path_cache, device_meta_cache, allocated_size_kib, usable_size_kib, disk_state].hash
154
+ end
155
+
156
+ # Builds the object from hash
157
+ # @param [Hash] attributes Model attributes in the form of hash
158
+ # @return [Object] Returns the model itself
159
+ def self.build_from_hash(attributes)
160
+ new.build_from_hash(attributes)
161
+ end
162
+
163
+ # Builds the object from hash
164
+ # @param [Hash] attributes Model attributes in the form of hash
165
+ # @return [Object] Returns the model itself
166
+ def build_from_hash(attributes)
167
+ return nil unless attributes.is_a?(Hash)
168
+ self.class.openapi_types.each_pair do |key, type|
169
+ if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
170
+ self.send("#{key}=", nil)
171
+ elsif type =~ /\AArray<(.*)>/i
172
+ # check to ensure the input is an array given that the attribute
173
+ # is documented as an array but the input is not
174
+ if attributes[self.class.attribute_map[key]].is_a?(Array)
175
+ self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
176
+ end
177
+ elsif !attributes[self.class.attribute_map[key]].nil?
178
+ self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
179
+ end
180
+ end
181
+
182
+ self
183
+ end
184
+
185
+ # Deserializes the data based on type
186
+ # @param string type Data type
187
+ # @param string value Value to be deserialized
188
+ # @return [Object] Deserialized data
189
+ def _deserialize(type, value)
190
+ case type.to_sym
191
+ when :Time
192
+ Time.parse(value)
193
+ when :Date
194
+ Date.parse(value)
195
+ when :String
196
+ value.to_s
197
+ when :Integer
198
+ value.to_i
199
+ when :Float
200
+ value.to_f
201
+ when :Boolean
202
+ if value.to_s =~ /\A(true|t|yes|y|1)\z/i
203
+ true
204
+ else
205
+ false
206
+ end
207
+ when :Object
208
+ # generic object (usually a Hash), return directly
209
+ value
210
+ when /\AArray<(?<inner_type>.+)>\z/
211
+ inner_type = Regexp.last_match[:inner_type]
212
+ value.map { |v| _deserialize(inner_type, v) }
213
+ when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
214
+ k_type = Regexp.last_match[:k_type]
215
+ v_type = Regexp.last_match[:v_type]
216
+ {}.tap do |hash|
217
+ value.each do |k, v|
218
+ hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
219
+ end
220
+ end
221
+ else # model
222
+ # models (e.g. Pet) or oneOf
223
+ klass = LinstorClient.const_get(type)
224
+ klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
225
+ end
226
+ end
227
+
228
+ # Returns the string representation of the object
229
+ # @return [String] String presentation of the object
230
+ def to_s
231
+ to_hash.to_s
232
+ end
233
+
234
+ # to_body is an alias to to_hash (backward compatibility)
235
+ # @return [Hash] Returns the object in the form of hash
236
+ def to_body
237
+ to_hash
238
+ end
239
+
240
+ # Returns the object in the form of hash
241
+ # @return [Hash] Returns the object in the form of hash
242
+ def to_hash
243
+ hash = {}
244
+ self.class.attribute_map.each_pair do |attr, param|
245
+ value = self.send(attr)
246
+ if value.nil?
247
+ is_nullable = self.class.openapi_nullable.include?(attr)
248
+ next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
249
+ end
250
+
251
+ hash[param] = _to_hash(value)
252
+ end
253
+ hash
254
+ end
255
+
256
+ # Outputs non-array value in the form of hash
257
+ # For object, use to_hash. Otherwise, just return the value
258
+ # @param [Object] value Any valid value
259
+ # @return [Hash] Returns the value in the form of hash
260
+ def _to_hash(value)
261
+ if value.is_a?(Array)
262
+ value.compact.map { |v| _to_hash(v) }
263
+ elsif value.is_a?(Hash)
264
+ {}.tap do |hash|
265
+ value.each { |k, v| hash[k] = _to_hash(v) }
266
+ end
267
+ elsif value.respond_to? :to_hash
268
+ value.to_hash
269
+ else
270
+ value
271
+ end
272
+ end
273
+
274
+ end
275
+
276
+ end
@@ -1,9 +1,9 @@
1
1
  =begin
2
2
  #Linstor REST API
3
3
 
4
- #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
4
+ #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
5
5
 
6
- The version of the OpenAPI document: 1.0.13
6
+ The version of the OpenAPI document: 1.5.0
7
7
  Contact: rene.peinthor@linbit.com
8
8
  Generated by: https://openapi-generator.tech
9
9
  OpenAPI Generator version: 5.3.1
@@ -0,0 +1,272 @@
1
+ =begin
2
+ #Linstor REST API
3
+
4
+ #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
5
+
6
+ The version of the OpenAPI document: 1.5.0
7
+ Contact: rene.peinthor@linbit.com
8
+ Generated by: https://openapi-generator.tech
9
+ OpenAPI Generator version: 5.3.1
10
+
11
+ =end
12
+
13
+ require 'date'
14
+ require 'time'
15
+
16
+ module LinstorClient
17
+ class ControllerConfig
18
+ attr_accessor :config
19
+
20
+ attr_accessor :debug
21
+
22
+ attr_accessor :log
23
+
24
+ attr_accessor :db
25
+
26
+ attr_accessor :http
27
+
28
+ attr_accessor :https
29
+
30
+ attr_accessor :ldap
31
+
32
+ # Attribute mapping from ruby-style variable name to JSON key.
33
+ def self.attribute_map
34
+ {
35
+ :'config' => :'config',
36
+ :'debug' => :'debug',
37
+ :'log' => :'log',
38
+ :'db' => :'db',
39
+ :'http' => :'http',
40
+ :'https' => :'https',
41
+ :'ldap' => :'ldap'
42
+ }
43
+ end
44
+
45
+ # Returns all the JSON keys this model knows about
46
+ def self.acceptable_attributes
47
+ attribute_map.values
48
+ end
49
+
50
+ # Attribute type mapping.
51
+ def self.openapi_types
52
+ {
53
+ :'config' => :'ControllerConfigConfig',
54
+ :'debug' => :'ControllerConfigDebug',
55
+ :'log' => :'ControllerConfigLog',
56
+ :'db' => :'ControllerConfigDb',
57
+ :'http' => :'ControllerConfigHttp',
58
+ :'https' => :'ControllerConfigHttps',
59
+ :'ldap' => :'ControllerConfigLdap'
60
+ }
61
+ end
62
+
63
+ # List of attributes with nullable: true
64
+ def self.openapi_nullable
65
+ Set.new([
66
+ ])
67
+ end
68
+
69
+ # Initializes the object
70
+ # @param [Hash] attributes Model attributes in the form of hash
71
+ def initialize(attributes = {})
72
+ if (!attributes.is_a?(Hash))
73
+ fail ArgumentError, "The input argument (attributes) must be a hash in `LinstorClient::ControllerConfig` initialize method"
74
+ end
75
+
76
+ # check to see if the attribute exists and convert string to symbol for hash key
77
+ attributes = attributes.each_with_object({}) { |(k, v), h|
78
+ if (!self.class.attribute_map.key?(k.to_sym))
79
+ fail ArgumentError, "`#{k}` is not a valid attribute in `LinstorClient::ControllerConfig`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
80
+ end
81
+ h[k.to_sym] = v
82
+ }
83
+
84
+ if attributes.key?(:'config')
85
+ self.config = attributes[:'config']
86
+ end
87
+
88
+ if attributes.key?(:'debug')
89
+ self.debug = attributes[:'debug']
90
+ end
91
+
92
+ if attributes.key?(:'log')
93
+ self.log = attributes[:'log']
94
+ end
95
+
96
+ if attributes.key?(:'db')
97
+ self.db = attributes[:'db']
98
+ end
99
+
100
+ if attributes.key?(:'http')
101
+ self.http = attributes[:'http']
102
+ end
103
+
104
+ if attributes.key?(:'https')
105
+ self.https = attributes[:'https']
106
+ end
107
+
108
+ if attributes.key?(:'ldap')
109
+ self.ldap = attributes[:'ldap']
110
+ end
111
+ end
112
+
113
+ # Show invalid properties with the reasons. Usually used together with valid?
114
+ # @return Array for valid properties with the reasons
115
+ def list_invalid_properties
116
+ invalid_properties = Array.new
117
+ invalid_properties
118
+ end
119
+
120
+ # Check to see if the all the properties in the model are valid
121
+ # @return true if the model is valid
122
+ def valid?
123
+ true
124
+ end
125
+
126
+ # Checks equality by comparing each attribute.
127
+ # @param [Object] Object to be compared
128
+ def ==(o)
129
+ return true if self.equal?(o)
130
+ self.class == o.class &&
131
+ config == o.config &&
132
+ debug == o.debug &&
133
+ log == o.log &&
134
+ db == o.db &&
135
+ http == o.http &&
136
+ https == o.https &&
137
+ ldap == o.ldap
138
+ end
139
+
140
+ # @see the `==` method
141
+ # @param [Object] Object to be compared
142
+ def eql?(o)
143
+ self == o
144
+ end
145
+
146
+ # Calculates hash code according to all attributes.
147
+ # @return [Integer] Hash code
148
+ def hash
149
+ [config, debug, log, db, http, https, ldap].hash
150
+ end
151
+
152
+ # Builds the object from hash
153
+ # @param [Hash] attributes Model attributes in the form of hash
154
+ # @return [Object] Returns the model itself
155
+ def self.build_from_hash(attributes)
156
+ new.build_from_hash(attributes)
157
+ end
158
+
159
+ # Builds the object from hash
160
+ # @param [Hash] attributes Model attributes in the form of hash
161
+ # @return [Object] Returns the model itself
162
+ def build_from_hash(attributes)
163
+ return nil unless attributes.is_a?(Hash)
164
+ self.class.openapi_types.each_pair do |key, type|
165
+ if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
166
+ self.send("#{key}=", nil)
167
+ elsif type =~ /\AArray<(.*)>/i
168
+ # check to ensure the input is an array given that the attribute
169
+ # is documented as an array but the input is not
170
+ if attributes[self.class.attribute_map[key]].is_a?(Array)
171
+ self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
172
+ end
173
+ elsif !attributes[self.class.attribute_map[key]].nil?
174
+ self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
175
+ end
176
+ end
177
+
178
+ self
179
+ end
180
+
181
+ # Deserializes the data based on type
182
+ # @param string type Data type
183
+ # @param string value Value to be deserialized
184
+ # @return [Object] Deserialized data
185
+ def _deserialize(type, value)
186
+ case type.to_sym
187
+ when :Time
188
+ Time.parse(value)
189
+ when :Date
190
+ Date.parse(value)
191
+ when :String
192
+ value.to_s
193
+ when :Integer
194
+ value.to_i
195
+ when :Float
196
+ value.to_f
197
+ when :Boolean
198
+ if value.to_s =~ /\A(true|t|yes|y|1)\z/i
199
+ true
200
+ else
201
+ false
202
+ end
203
+ when :Object
204
+ # generic object (usually a Hash), return directly
205
+ value
206
+ when /\AArray<(?<inner_type>.+)>\z/
207
+ inner_type = Regexp.last_match[:inner_type]
208
+ value.map { |v| _deserialize(inner_type, v) }
209
+ when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
210
+ k_type = Regexp.last_match[:k_type]
211
+ v_type = Regexp.last_match[:v_type]
212
+ {}.tap do |hash|
213
+ value.each do |k, v|
214
+ hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
215
+ end
216
+ end
217
+ else # model
218
+ # models (e.g. Pet) or oneOf
219
+ klass = LinstorClient.const_get(type)
220
+ klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
221
+ end
222
+ end
223
+
224
+ # Returns the string representation of the object
225
+ # @return [String] String presentation of the object
226
+ def to_s
227
+ to_hash.to_s
228
+ end
229
+
230
+ # to_body is an alias to to_hash (backward compatibility)
231
+ # @return [Hash] Returns the object in the form of hash
232
+ def to_body
233
+ to_hash
234
+ end
235
+
236
+ # Returns the object in the form of hash
237
+ # @return [Hash] Returns the object in the form of hash
238
+ def to_hash
239
+ hash = {}
240
+ self.class.attribute_map.each_pair do |attr, param|
241
+ value = self.send(attr)
242
+ if value.nil?
243
+ is_nullable = self.class.openapi_nullable.include?(attr)
244
+ next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
245
+ end
246
+
247
+ hash[param] = _to_hash(value)
248
+ end
249
+ hash
250
+ end
251
+
252
+ # Outputs non-array value in the form of hash
253
+ # For object, use to_hash. Otherwise, just return the value
254
+ # @param [Object] value Any valid value
255
+ # @return [Hash] Returns the value in the form of hash
256
+ def _to_hash(value)
257
+ if value.is_a?(Array)
258
+ value.compact.map { |v| _to_hash(v) }
259
+ elsif value.is_a?(Hash)
260
+ {}.tap do |hash|
261
+ value.each { |k, v| hash[k] = _to_hash(v) }
262
+ end
263
+ elsif value.respond_to? :to_hash
264
+ value.to_hash
265
+ else
266
+ value
267
+ end
268
+ end
269
+
270
+ end
271
+
272
+ end