ovirt-engine-sdk 4.2.4 → 4.2.5

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
- SHA1:
3
- metadata.gz: 0acdc6d86eabc4cce313feae53d6b93730dec503
4
- data.tar.gz: cfc08b042e974243286497c29e426d700407ec05
2
+ SHA256:
3
+ metadata.gz: ce3cb14730b32020324d3d3f7198d1127fe9bd809dce515307784b7da6c9442b
4
+ data.tar.gz: ee2e8b28b31383e8cc791fcfcd7ae0d2346f99d02e3ca4c04e2976a90bb2a9f8
5
5
  SHA512:
6
- metadata.gz: 2735fbbba05029dd00f7af23acebc26f777f958abdca5c380df63b804c3c984099f07f1d4d7dcf22f3803bd209dcc567e32967d5d5d8dc4f8de2f8da77aedc47
7
- data.tar.gz: b045671bbb4687ff020cbe5cc66bd31128a21fbc00a65157e8d70ebaee3e73e081ba237be7313b020443fb52480e80e65c16a139fec476445eb38ac51b89a9ad
6
+ metadata.gz: eeb06a7986d89e77a522f630bd623cc64ea7a0750aa3a120fcba0209d1da78d8aec84efdd4131eb30835e07cfa6f6c4237a2274b9ad58a9ec1a3c36f56c92453
7
+ data.tar.gz: a7dcfea368438b9c3bceb7b0cdcfb9e25f452c15709821133110f6c9188b75ee14aba3899b9fb231f0a7006d5294a966c375ef1d500ac383c37029a2fa76dd6d
@@ -2,6 +2,42 @@
2
2
 
3
3
  This document describes the relevant changes between releases of the SDK.
4
4
 
5
+ == 4.2.5 / Oct 5 2018
6
+ Update to model 4.2.32.
7
+
8
+ New features:
9
+
10
+ * Add support for OpenStack Identity API v3
11
+ https://bugzilla.redhat.com/1598391[1598391].
12
+
13
+ * Added linkedGlusterVolume to the StorageServerConnection
14
+ type and services
15
+ https://bugzilla.redhat.com/1563257[1563257].
16
+
17
+ * Add sync all networks in cluster
18
+ https://bugzilla.redhat.com/1558847[1558847].
19
+
20
+ * Add note to upgrade host
21
+ https://bugzilla.redhat.com/1603020[1603020].
22
+
23
+ * Indicate network operation in progress
24
+ https://bugzilla.redhat.com/1477599[1477599].
25
+
26
+ * Poly dhcpv6 and autoconf iface config
27
+ https://bugzilla.redhat.com/1360839[1360839].
28
+
29
+ * Add 'Multi Queues Enabled' to VmBase
30
+ https://bugzilla.redhat.com/1574771[1574771].
31
+
32
+ * Added Reduce action to Disk services
33
+ https://bugzilla.redhat.com/1443963[#1443963].
34
+
35
+ * Add documentation to DiskService
36
+ https://bugzilla.redhat.com/1585572[1585572].
37
+
38
+ * Add search parameter to providers
39
+ https://bugzilla.redhat.com/1572071[#1572071].
40
+
5
41
  == 4.2.4 / Apr 17 2018
6
42
  Update to model 4.2.32.
7
43
 
@@ -7213,6 +7213,8 @@ module OvirtSDK4
7213
7213
  object.memory = value if not value.nil?
7214
7214
  value = reader.get_attribute('name')
7215
7215
  object.name = value if not value.nil?
7216
+ value = reader.get_attribute('network_operation_in_progress')
7217
+ object.network_operation_in_progress = value if not value.nil?
7216
7218
  value = reader.get_attribute('numa_supported')
7217
7219
  object.numa_supported = value if not value.nil?
7218
7220
  value = reader.get_attribute('override_iptables')
@@ -7278,6 +7280,8 @@ module OvirtSDK4
7278
7280
  object.memory = Reader.read_integer(reader)
7279
7281
  when 'name'
7280
7282
  object.name = Reader.read_string(reader)
7283
+ when 'network_operation_in_progress'
7284
+ object.network_operation_in_progress = Reader.read_boolean(reader)
7281
7285
  when 'numa_supported'
7282
7286
  object.numa_supported = Reader.read_boolean(reader)
7283
7287
  when 'os'
@@ -8548,6 +8552,8 @@ module OvirtSDK4
8548
8552
  object.memory = value if not value.nil?
8549
8553
  value = reader.get_attribute('migration_downtime')
8550
8554
  object.migration_downtime = value if not value.nil?
8555
+ value = reader.get_attribute('multi_queues_enabled')
8556
+ object.multi_queues_enabled = value if not value.nil?
8551
8557
  value = reader.get_attribute('name')
8552
8558
  object.name = value if not value.nil?
8553
8559
  value = reader.get_attribute('origin')
@@ -8623,6 +8629,8 @@ module OvirtSDK4
8623
8629
  object.migration = MigrationOptionsReader.read_one(reader)
8624
8630
  when 'migration_downtime'
8625
8631
  object.migration_downtime = Reader.read_integer(reader)
8632
+ when 'multi_queues_enabled'
8633
+ object.multi_queues_enabled = Reader.read_boolean(reader)
8626
8634
  when 'name'
8627
8635
  object.name = Reader.read_string(reader)
8628
8636
  when 'origin'
@@ -11625,6 +11633,10 @@ module OvirtSDK4
11625
11633
  object.password = value if not value.nil?
11626
11634
  value = reader.get_attribute('plugin_type')
11627
11635
  object.plugin_type = value if not value.nil?
11636
+ value = reader.get_attribute('project_domain_name')
11637
+ object.project_domain_name = value if not value.nil?
11638
+ value = reader.get_attribute('project_name')
11639
+ object.project_name = value if not value.nil?
11628
11640
  value = reader.get_attribute('read_only')
11629
11641
  object.read_only = value if not value.nil?
11630
11642
  value = reader.get_attribute('requires_authentication')
@@ -11637,6 +11649,8 @@ module OvirtSDK4
11637
11649
  object.unmanaged = value if not value.nil?
11638
11650
  value = reader.get_attribute('url')
11639
11651
  object.url = value if not value.nil?
11652
+ value = reader.get_attribute('user_domain_name')
11653
+ object.user_domain_name = value if not value.nil?
11640
11654
  value = reader.get_attribute('username')
11641
11655
  object.username = value if not value.nil?
11642
11656
 
@@ -11668,6 +11682,10 @@ module OvirtSDK4
11668
11682
  object.password = Reader.read_string(reader)
11669
11683
  when 'plugin_type'
11670
11684
  object.plugin_type = Reader.read_enum(NetworkPluginType, reader)
11685
+ when 'project_domain_name'
11686
+ object.project_domain_name = Reader.read_string(reader)
11687
+ when 'project_name'
11688
+ object.project_name = Reader.read_string(reader)
11671
11689
  when 'properties'
11672
11690
  object.properties = PropertyReader.read_many(reader)
11673
11691
  when 'read_only'
@@ -11682,6 +11700,8 @@ module OvirtSDK4
11682
11700
  object.unmanaged = Reader.read_boolean(reader)
11683
11701
  when 'url'
11684
11702
  object.url = Reader.read_string(reader)
11703
+ when 'user_domain_name'
11704
+ object.user_domain_name = Reader.read_string(reader)
11685
11705
  when 'username'
11686
11706
  object.username = Reader.read_string(reader)
11687
11707
  when 'certificates'
@@ -15337,6 +15357,8 @@ module OvirtSDK4
15337
15357
  object.memory = value if not value.nil?
15338
15358
  value = reader.get_attribute('migration_downtime')
15339
15359
  object.migration_downtime = value if not value.nil?
15360
+ value = reader.get_attribute('multi_queues_enabled')
15361
+ object.multi_queues_enabled = value if not value.nil?
15340
15362
  value = reader.get_attribute('name')
15341
15363
  object.name = value if not value.nil?
15342
15364
  value = reader.get_attribute('next_run_configuration_exists')
@@ -15444,6 +15466,8 @@ module OvirtSDK4
15444
15466
  object.migration = MigrationOptionsReader.read_one(reader)
15445
15467
  when 'migration_downtime'
15446
15468
  object.migration_downtime = Reader.read_integer(reader)
15469
+ when 'multi_queues_enabled'
15470
+ object.multi_queues_enabled = Reader.read_boolean(reader)
15447
15471
  when 'name'
15448
15472
  object.name = Reader.read_string(reader)
15449
15473
  when 'next_run_configuration_exists'
@@ -16332,6 +16356,8 @@ module OvirtSDK4
16332
16356
  object.username = Reader.read_string(reader)
16333
16357
  when 'vfs_type'
16334
16358
  object.vfs_type = Reader.read_string(reader)
16359
+ when 'gluster_volume'
16360
+ object.gluster_volume = GlusterVolumeReader.read_one(reader)
16335
16361
  when 'host'
16336
16362
  object.host = HostReader.read_one(reader)
16337
16363
  else
@@ -16980,6 +17006,8 @@ module OvirtSDK4
16980
17006
  object.memory = value if not value.nil?
16981
17007
  value = reader.get_attribute('migration_downtime')
16982
17008
  object.migration_downtime = value if not value.nil?
17009
+ value = reader.get_attribute('multi_queues_enabled')
17010
+ object.multi_queues_enabled = value if not value.nil?
16983
17011
  value = reader.get_attribute('name')
16984
17012
  object.name = value if not value.nil?
16985
17013
  value = reader.get_attribute('origin')
@@ -17055,6 +17083,8 @@ module OvirtSDK4
17055
17083
  object.migration = MigrationOptionsReader.read_one(reader)
17056
17084
  when 'migration_downtime'
17057
17085
  object.migration_downtime = Reader.read_integer(reader)
17086
+ when 'multi_queues_enabled'
17087
+ object.multi_queues_enabled = Reader.read_boolean(reader)
17058
17088
  when 'name'
17059
17089
  object.name = Reader.read_string(reader)
17060
17090
  when 'origin'
@@ -18315,6 +18345,8 @@ module OvirtSDK4
18315
18345
  object.memory = value if not value.nil?
18316
18346
  value = reader.get_attribute('migration_downtime')
18317
18347
  object.migration_downtime = value if not value.nil?
18348
+ value = reader.get_attribute('multi_queues_enabled')
18349
+ object.multi_queues_enabled = value if not value.nil?
18318
18350
  value = reader.get_attribute('name')
18319
18351
  object.name = value if not value.nil?
18320
18352
  value = reader.get_attribute('next_run_configuration_exists')
@@ -18414,6 +18446,8 @@ module OvirtSDK4
18414
18446
  object.migration = MigrationOptionsReader.read_one(reader)
18415
18447
  when 'migration_downtime'
18416
18448
  object.migration_downtime = Reader.read_integer(reader)
18449
+ when 'multi_queues_enabled'
18450
+ object.multi_queues_enabled = Reader.read_boolean(reader)
18417
18451
  when 'name'
18418
18452
  object.name = Reader.read_string(reader)
18419
18453
  when 'next_run_configuration_exists'
@@ -18642,6 +18676,8 @@ module OvirtSDK4
18642
18676
  object.memory = value if not value.nil?
18643
18677
  value = reader.get_attribute('migration_downtime')
18644
18678
  object.migration_downtime = value if not value.nil?
18679
+ value = reader.get_attribute('multi_queues_enabled')
18680
+ object.multi_queues_enabled = value if not value.nil?
18645
18681
  value = reader.get_attribute('name')
18646
18682
  object.name = value if not value.nil?
18647
18683
  value = reader.get_attribute('origin')
@@ -18715,6 +18751,8 @@ module OvirtSDK4
18715
18751
  object.migration = MigrationOptionsReader.read_one(reader)
18716
18752
  when 'migration_downtime'
18717
18753
  object.migration_downtime = Reader.read_integer(reader)
18754
+ when 'multi_queues_enabled'
18755
+ object.multi_queues_enabled = Reader.read_boolean(reader)
18718
18756
  when 'name'
18719
18757
  object.name = Reader.read_string(reader)
18720
18758
  when 'origin'
@@ -3498,7 +3498,7 @@ module OvirtSDK4
3498
3498
  #
3499
3499
  # Attaches an existing storage domain to the data center.
3500
3500
  #
3501
- # @param storage_domain [StorageDomain] The `storage_domain` to add.
3501
+ # @param storage_domain [StorageDomain] The storage domain to attach to the data center.
3502
3502
  #
3503
3503
  # @param opts [Hash] Additional options.
3504
3504
  #
@@ -4192,6 +4192,44 @@ module OvirtSDK4
4192
4192
  internal_action(:resetemulatedmachine, nil, RESET_EMULATED_MACHINE, opts)
4193
4193
  end
4194
4194
 
4195
+ SYNC_ALL_NETWORKS = [
4196
+ [:async, TrueClass].freeze,
4197
+ ].freeze
4198
+
4199
+ private_constant :SYNC_ALL_NETWORKS
4200
+
4201
+ #
4202
+ # Synchronizes all networks on the cluster.
4203
+ #
4204
+ # [source]
4205
+ # ----
4206
+ # POST /ovirt-engine/api/clusters/123/syncallnetworks
4207
+ # ----
4208
+ #
4209
+ # With a request body like this:
4210
+ #
4211
+ # [source,xml]
4212
+ # ----
4213
+ # <action/>
4214
+ # ----
4215
+ #
4216
+ # @param opts [Hash] Additional options.
4217
+ #
4218
+ # @option opts [Boolean] :async Indicates if the action should be performed asynchronously.
4219
+ #
4220
+ # @option opts [Hash] :headers ({}) Additional HTTP headers.
4221
+ #
4222
+ # @option opts [Hash] :query ({}) Additional URL query parameters.
4223
+ #
4224
+ # @option opts [Integer] :timeout (nil) The timeout for this request, in seconds. If no value is explicitly
4225
+ # given then the timeout set globally for the connection will be used.
4226
+ #
4227
+ # @option opts [Boolean] :wait (true) If `true` wait for the response.
4228
+ #
4229
+ def sync_all_networks(opts = {})
4230
+ internal_action(:syncallnetworks, nil, SYNC_ALL_NETWORKS, opts)
4231
+ end
4232
+
4195
4233
  UPDATE = [
4196
4234
  [:async, TrueClass].freeze,
4197
4235
  ].freeze
@@ -6468,7 +6506,7 @@ module OvirtSDK4
6468
6506
  # avoid issues it is strongly recommended to always include the `active` attribute with the desired
6469
6507
  # value.
6470
6508
  #
6471
- # @param attachment [DiskAttachment] The `attachment` to add.
6509
+ # @param attachment [DiskAttachment] The disk attachment to add to the virtual machine.
6472
6510
  #
6473
6511
  # @param opts [Hash] Additional options.
6474
6512
  #
@@ -6526,7 +6564,7 @@ module OvirtSDK4
6526
6564
  #
6527
6565
  # Adds a new `attachment`.
6528
6566
  #
6529
- # @param attachment [DiskAttachment] The `attachment` to add.
6567
+ # @param attachment [DiskAttachment] The disk attachment to add to the virtual machine.
6530
6568
  #
6531
6569
  # @param opts [Hash] Additional options.
6532
6570
  #
@@ -6553,7 +6591,7 @@ module OvirtSDK4
6553
6591
  #
6554
6592
  # Adds a new `attachment`.
6555
6593
  #
6556
- # @param attachment [DiskAttachment] The `attachment` to add.
6594
+ # @param attachment [DiskAttachment] The disk attachment to add to the virtual machine.
6557
6595
  #
6558
6596
  # @param opts [Hash] Additional options.
6559
6597
  #
@@ -8743,7 +8781,7 @@ module OvirtSDK4
8743
8781
  private_constant :ADD
8744
8782
 
8745
8783
  #
8746
- # Add a new external host provider to the system.
8784
+ # Adds a new external host provider to the system.
8747
8785
  #
8748
8786
  # @param provider [ExternalHostProvider] The `provider` to add.
8749
8787
  #
@@ -8767,6 +8805,7 @@ module OvirtSDK4
8767
8805
  LIST = [
8768
8806
  [:follow, String].freeze,
8769
8807
  [:max, Integer].freeze,
8808
+ [:search, String].freeze,
8770
8809
  ].freeze
8771
8810
 
8772
8811
  private_constant :LIST
@@ -8774,14 +8813,16 @@ module OvirtSDK4
8774
8813
  #
8775
8814
  # Returns the list of external host providers.
8776
8815
  #
8777
- # The order of the returned list of host providers isn't guaranteed.
8816
+ # The order of the returned list of host providers is not guaranteed.
8778
8817
  #
8779
8818
  # @param opts [Hash] Additional options.
8780
8819
  #
8781
8820
  # @option opts [String] :follow Indicates which inner links should be _followed_. The objects referenced by these links will be fetched as part
8782
8821
  # of the current request. See <<documents/003_common_concepts/follow, here>> for details.
8783
8822
  #
8784
- # @option opts [Integer] :max Sets the maximum number of providers to return. If not specified all the providers are returned.
8823
+ # @option opts [Integer] :max Sets the maximum number of providers to return. If not specified, all the providers are returned.
8824
+ #
8825
+ # @option opts [String] :search A query string used to restrict the returned external host providers.
8785
8826
  #
8786
8827
  # @option opts [Hash] :headers ({}) Additional HTTP headers.
8787
8828
  #
@@ -12217,7 +12258,7 @@ module OvirtSDK4
12217
12258
  # </image_transfer>
12218
12259
  # ----
12219
12260
  #
12220
- # @param image_transfer [ImageTransfer] The `image_transfer` to add.
12261
+ # @param image_transfer [ImageTransfer] The image transfer to add.
12221
12262
  #
12222
12263
  # @param opts [Hash] Additional options.
12223
12264
  #
@@ -12244,7 +12285,7 @@ module OvirtSDK4
12244
12285
  #
12245
12286
  # Adds a new `image_transfer`.
12246
12287
  #
12247
- # @param image_transfer [ImageTransfer] The `image_transfer` to add.
12288
+ # @param image_transfer [ImageTransfer] The image transfer to add.
12248
12289
  #
12249
12290
  # @param opts [Hash] Additional options.
12250
12291
  #
@@ -12271,7 +12312,7 @@ module OvirtSDK4
12271
12312
  #
12272
12313
  # Adds a new `image_transfer`.
12273
12314
  #
12274
- # @param image_transfer [ImageTransfer] The `image_transfer` to add.
12315
+ # @param image_transfer [ImageTransfer] The image transfer to add.
12275
12316
  #
12276
12317
  # @param opts [Hash] Additional options.
12277
12318
  #
@@ -12298,7 +12339,7 @@ module OvirtSDK4
12298
12339
  #
12299
12340
  # Adds a new `image_transfer`.
12300
12341
  #
12301
- # @param image_transfer [ImageTransfer] The `image_transfer` to add.
12342
+ # @param image_transfer [ImageTransfer] The image transfer to add.
12302
12343
  #
12303
12344
  # @param opts [Hash] Additional options.
12304
12345
  #
@@ -13476,7 +13517,7 @@ module OvirtSDK4
13476
13517
  # </iscsi_bond>
13477
13518
  # ----
13478
13519
  #
13479
- # @param bond [IscsiBond] The `bond` to update.
13520
+ # @param bond [IscsiBond] The iSCSI bond to update.
13480
13521
  # @param opts [Hash] Additional options.
13481
13522
  #
13482
13523
  # @option opts [Boolean] :async Indicates if the update should be performed asynchronously.
@@ -14646,6 +14687,12 @@ module OvirtSDK4
14646
14687
  # DELETE /ovirt-engine/api/datacenters/123/networks/456
14647
14688
  # ----
14648
14689
  #
14690
+ # NOTE: To remove an external logical network, the network has to be removed directly from its provider by
14691
+ # https://developer.openstack.org/api-ref/network[OpenStack Networking API].
14692
+ # The entity representing the external network inside {product-name} is removed automatically,
14693
+ # if <<types/open_stack_network_provider/attributes/auto_sync,`auto_sync`>> is enabled for the provider,
14694
+ # otherwise the entity has to be removed using this method.
14695
+ #
14649
14696
  # @param opts [Hash] Additional options.
14650
14697
  #
14651
14698
  # @option opts [Boolean] :async Indicates if the remove should be performed asynchronously.
@@ -16010,7 +16057,7 @@ module OvirtSDK4
16010
16057
  private_constant :ADD
16011
16058
 
16012
16059
  #
16013
- # Add a new OpenStack image provider to the system.
16060
+ # Adds a new OpenStack image provider to the system.
16014
16061
  #
16015
16062
  # @param provider [OpenStackImageProvider] The `provider` to add.
16016
16063
  #
@@ -16034,6 +16081,7 @@ module OvirtSDK4
16034
16081
  LIST = [
16035
16082
  [:follow, String].freeze,
16036
16083
  [:max, Integer].freeze,
16084
+ [:search, String].freeze,
16037
16085
  ].freeze
16038
16086
 
16039
16087
  private_constant :LIST
@@ -16041,14 +16089,16 @@ module OvirtSDK4
16041
16089
  #
16042
16090
  # Returns the list of providers.
16043
16091
  #
16044
- # The order of the returned list of providers isn't guaranteed.
16092
+ # The order of the returned list of providers is not guaranteed.
16045
16093
  #
16046
16094
  # @param opts [Hash] Additional options.
16047
16095
  #
16048
16096
  # @option opts [String] :follow Indicates which inner links should be _followed_. The objects referenced by these links will be fetched as part
16049
16097
  # of the current request. See <<documents/003_common_concepts/follow, here>> for details.
16050
16098
  #
16051
- # @option opts [Integer] :max Sets the maximum number of providers to return. If not specified all the providers are returned.
16099
+ # @option opts [Integer] :max Sets the maximum number of providers to return. If not specified, all the providers are returned.
16100
+ #
16101
+ # @option opts [String] :search A query string used to restrict the returned OpenStack image providers.
16052
16102
  #
16053
16103
  # @option opts [Hash] :headers ({}) Additional HTTP headers.
16054
16104
  #
@@ -16202,8 +16252,8 @@ module OvirtSDK4
16202
16252
  private_constant :IMPORT
16203
16253
 
16204
16254
  #
16205
- # This operation imports an external network into oVirt.
16206
- # The network will be added to the data center specified.
16255
+ # This operation imports an external network into {product-name}.
16256
+ # The network will be added to the specified data center.
16207
16257
  #
16208
16258
  # @param opts [Hash] Additional options.
16209
16259
  #
@@ -16211,13 +16261,13 @@ module OvirtSDK4
16211
16261
  #
16212
16262
  # @option opts [DataCenter] :data_center The data center into which the network is to be imported.
16213
16263
  # Data center is mandatory, and can be specified
16214
- # using the `id` or `name` attributes, the rest of
16264
+ # using the `id` or `name` attributes. The rest of
16215
16265
  # the attributes will be ignored.
16216
16266
  #
16217
16267
  # NOTE: If <<types/open_stack_network_provider/attributes/auto_sync,`auto_sync`>> is
16218
- # enabled for the provider, the network might be already imported automatically. To
16219
- # prevent this, automatic import can be disabled by setting the `auto_sync` to false
16220
- # and enabled after importing the network again.
16268
+ # enabled for the provider, the network might be imported automatically. To
16269
+ # prevent this, automatic import can be disabled by setting the `auto_sync` to false,
16270
+ # and enabling it again after importing the network.
16221
16271
  #
16222
16272
  # @option opts [Hash] :headers ({}) Additional HTTP headers.
16223
16273
  #
@@ -16495,7 +16545,7 @@ module OvirtSDK4
16495
16545
  private_constant :ADD
16496
16546
 
16497
16547
  #
16498
- # The operation adds a new network provider to the system.
16548
+ # Adds a new network provider to the system.
16499
16549
  # If the `type` property is not present, a default value of `NEUTRON` will be used.
16500
16550
  #
16501
16551
  # @param provider [OpenStackNetworkProvider] The `provider` to add.
@@ -16520,6 +16570,7 @@ module OvirtSDK4
16520
16570
  LIST = [
16521
16571
  [:follow, String].freeze,
16522
16572
  [:max, Integer].freeze,
16573
+ [:search, String].freeze,
16523
16574
  ].freeze
16524
16575
 
16525
16576
  private_constant :LIST
@@ -16527,14 +16578,16 @@ module OvirtSDK4
16527
16578
  #
16528
16579
  # Returns the list of providers.
16529
16580
  #
16530
- # The order of the returned list of providers isn't guaranteed.
16581
+ # The order of the returned list of providers is not guaranteed.
16531
16582
  #
16532
16583
  # @param opts [Hash] Additional options.
16533
16584
  #
16534
16585
  # @option opts [String] :follow Indicates which inner links should be _followed_. The objects referenced by these links will be fetched as part
16535
16586
  # of the current request. See <<documents/003_common_concepts/follow, here>> for details.
16536
16587
  #
16537
- # @option opts [Integer] :max Sets the maximum number of providers to return. If not specified all the providers are returned.
16588
+ # @option opts [Integer] :max Sets the maximum number of providers to return. If not specified, all the providers are returned.
16589
+ #
16590
+ # @option opts [String] :search A query string used to restrict the returned OpenStack network providers.
16538
16591
  #
16539
16592
  # @option opts [Hash] :headers ({}) Additional HTTP headers.
16540
16593
  #
@@ -16552,7 +16605,7 @@ module OvirtSDK4
16552
16605
  end
16553
16606
 
16554
16607
  #
16555
- # Reference to OpenStack network provider service.
16608
+ # Reference to the OpenStack network provider service.
16556
16609
  #
16557
16610
  # @param id [String] The identifier of the `provider`.
16558
16611
  #
@@ -17272,6 +17325,7 @@ module OvirtSDK4
17272
17325
  LIST = [
17273
17326
  [:follow, String].freeze,
17274
17327
  [:max, Integer].freeze,
17328
+ [:search, String].freeze,
17275
17329
  ].freeze
17276
17330
 
17277
17331
  private_constant :LIST
@@ -17279,14 +17333,16 @@ module OvirtSDK4
17279
17333
  #
17280
17334
  # Retrieves the list of volume providers.
17281
17335
  #
17282
- # The order of the returned list of volume providers isn't guaranteed.
17336
+ # The order of the returned list of volume providers is not guaranteed.
17283
17337
  #
17284
17338
  # @param opts [Hash] Additional options.
17285
17339
  #
17286
17340
  # @option opts [String] :follow Indicates which inner links should be _followed_. The objects referenced by these links will be fetched as part
17287
17341
  # of the current request. See <<documents/003_common_concepts/follow, here>> for details.
17288
17342
  #
17289
- # @option opts [Integer] :max Sets the maximum number of providers to return. If not specified all the providers are returned.
17343
+ # @option opts [Integer] :max Sets the maximum number of providers to return. If not specified, all the providers are returned.
17344
+ #
17345
+ # @option opts [String] :search A query string used to restrict the returned volume providers.
17290
17346
  #
17291
17347
  # @option opts [Hash] :headers ({}) Additional HTTP headers.
17292
17348
  #
@@ -21740,6 +21796,36 @@ module OvirtSDK4
21740
21796
  internal_action(:move, nil, MOVE, opts)
21741
21797
  end
21742
21798
 
21799
+ REDUCE = [
21800
+ [:async, TrueClass].freeze,
21801
+ ].freeze
21802
+
21803
+ private_constant :REDUCE
21804
+
21805
+ #
21806
+ # Reduces the size of the disk image.
21807
+ #
21808
+ # Invokes _reduce_ on the logical volume (i.e. this is only applicable for block storage domains).
21809
+ # This is applicable for floating disks and disks attached to non-running virtual machines.
21810
+ # There is no need to specify the size as the optimal size is calculated automatically.
21811
+ #
21812
+ # @param opts [Hash] Additional options.
21813
+ #
21814
+ # @option opts [Boolean] :async Indicates if the remove should be performed asynchronously.
21815
+ #
21816
+ # @option opts [Hash] :headers ({}) Additional HTTP headers.
21817
+ #
21818
+ # @option opts [Hash] :query ({}) Additional URL query parameters.
21819
+ #
21820
+ # @option opts [Integer] :timeout (nil) The timeout for this request, in seconds. If no value is explicitly
21821
+ # given then the timeout set globally for the connection will be used.
21822
+ #
21823
+ # @option opts [Boolean] :wait (true) If `true` wait for the response.
21824
+ #
21825
+ def reduce(opts = {})
21826
+ internal_action(:reduce, nil, REDUCE, opts)
21827
+ end
21828
+
21743
21829
  REMOVE = [
21744
21830
  ].freeze
21745
21831
 
@@ -22982,21 +23068,21 @@ module OvirtSDK4
22982
23068
  #
22983
23069
  # Adds a new storage domain.
22984
23070
  #
22985
- # Creation of a new <<types/storage_domain,StorageDomain>> requires the `name`, `type`, `host` and `storage`
22986
- # attributes. Identify the `host` attribute with the `id` or `name` attributes. In oVirt 3.6 and later you can
22987
- # enable the wipe after delete option by default on the storage domain. To configure this, specify
23071
+ # Creation of a new <<types/storage_domain,StorageDomain>> requires the `name`, `type`, `host`, and `storage`
23072
+ # attributes. Identify the `host` attribute with the `id` or `name` attributes. In {product-name} 3.6 and
23073
+ # later you can enable the wipe after delete option by default on the storage domain. To configure this, specify
22988
23074
  # `wipe_after_delete` in the POST request. This option can be edited after the domain is created, but doing so will
22989
23075
  # not change the wipe after delete property of disks that already exist.
22990
23076
  #
22991
- # To add a new storage domain with specified `name`, `type`, `storage.type`, `storage.address` and `storage.path`
22992
- # and by using a host with an id `123`, send a request as follows:
23077
+ # To add a new storage domain with specified `name`, `type`, `storage.type`, `storage.address`, and `storage.path`,
23078
+ # and using a host with an id `123`, send a request like this:
22993
23079
  #
22994
23080
  # [source]
22995
23081
  # ----
22996
23082
  # POST /ovirt-engine/api/storageDomains
22997
23083
  # ----
22998
23084
  #
22999
- # With a request body as follows:
23085
+ # With a request body like this:
23000
23086
  #
23001
23087
  # [source,xml]
23002
23088
  # ----
@@ -23052,7 +23138,7 @@ module OvirtSDK4
23052
23138
  # </storage_domain>
23053
23139
  # ----
23054
23140
  #
23055
- # @param storage_domain [StorageDomain] The `storage_domain` to add.
23141
+ # @param storage_domain [StorageDomain] The storage domain to add.
23056
23142
  #
23057
23143
  # @param opts [Hash] Additional options.
23058
23144
  #
@@ -23079,7 +23165,7 @@ module OvirtSDK4
23079
23165
  #
23080
23166
  # Import an existing block storage domain to the system using the targets already connected to the host.
23081
23167
  #
23082
- # @param storage_domain [StorageDomain] The `storage_domain` to add.
23168
+ # @param storage_domain [StorageDomain] The storage domain to add.
23083
23169
  #
23084
23170
  # @param opts [Hash] Additional options.
23085
23171
  #
@@ -23106,7 +23192,7 @@ module OvirtSDK4
23106
23192
  #
23107
23193
  # Add a new storage domain to the system using the storage on the given host and path.
23108
23194
  #
23109
- # @param storage_domain [StorageDomain] The `storage_domain` to add.
23195
+ # @param storage_domain [StorageDomain] The storage domain to add.
23110
23196
  #
23111
23197
  # @param opts [Hash] Additional options.
23112
23198
  #
@@ -23131,9 +23217,9 @@ module OvirtSDK4
23131
23217
  private_constant :ADD_DIRECT_LUN
23132
23218
 
23133
23219
  #
23134
- # Add a new storage domain to the system using a direct lun.
23220
+ # Add a new storage domain to the system using a direct LUN.
23135
23221
  #
23136
- # @param storage_domain [StorageDomain] The `storage_domain` to add.
23222
+ # @param storage_domain [StorageDomain] The storage domain to add.
23137
23223
  #
23138
23224
  # @param opts [Hash] Additional options.
23139
23225
  #
@@ -23158,9 +23244,9 @@ module OvirtSDK4
23158
23244
  private_constant :ADD_GLUSTER_OR_POSTFS
23159
23245
 
23160
23246
  #
23161
- # Add a new storage domain to the system using the gluster or posixfs storage.
23247
+ # Add a new storage domain to the system using Gluster or POSIX FS storage.
23162
23248
  #
23163
- # @param storage_domain [StorageDomain] The `storage_domain` to add.
23249
+ # @param storage_domain [StorageDomain] The storage domain to add.
23164
23250
  #
23165
23251
  # @param opts [Hash] Additional options.
23166
23252
  #
@@ -23190,23 +23276,23 @@ module OvirtSDK4
23190
23276
  private_constant :LIST
23191
23277
 
23192
23278
  #
23193
- # Returns the list of storage domains of the system.
23279
+ # Returns the list of storage domains in the system.
23194
23280
  #
23195
23281
  # The order of the returned list of storage domains is guaranteed only if the `sortby` clause is included
23196
23282
  # in the `search` parameter.
23197
23283
  #
23198
23284
  # @param opts [Hash] Additional options.
23199
23285
  #
23200
- # @option opts [Boolean] :case_sensitive Indicates if the search performed using the `search` parameter should be performed taking case into
23201
- # account. The default value is `true`, which means that case is taken into account. If you want to search
23202
- # ignoring case set it to `false`.
23286
+ # @option opts [Boolean] :case_sensitive Indicates if the search should be performed taking case into account.
23287
+ # The default value is `true`, which means that case is taken into account. If you want to search
23288
+ # ignoring case, set it to `false`.
23203
23289
  #
23204
23290
  # @option opts [Boolean] :filter Indicates if the results should be filtered according to the permissions of the user.
23205
23291
  #
23206
23292
  # @option opts [String] :follow Indicates which inner links should be _followed_. The objects referenced by these links will be fetched as part
23207
23293
  # of the current request. See <<documents/003_common_concepts/follow, here>> for details.
23208
23294
  #
23209
- # @option opts [Integer] :max Sets the maximum number of storage domains to return. If not specified all the storage domains are returned.
23295
+ # @option opts [Integer] :max Sets the maximum number of storage domains to return. If not specified, all the storage domains are returned.
23210
23296
  #
23211
23297
  # @option opts [String] :search A query string used to restrict the returned storage domains.
23212
23298
  #
@@ -23231,9 +23317,9 @@ module OvirtSDK4
23231
23317
  private_constant :ADD_LOCAL
23232
23318
 
23233
23319
  #
23234
- # Add a new storage domain to the system using the storage on the localhost at the given path.
23320
+ # Add a new storage domain to the system using the storage on the local host at the given path.
23235
23321
  #
23236
- # @param storage_domain [StorageDomain] The `storage_domain` to add.
23322
+ # @param storage_domain [StorageDomain] The storage domain to add.
23237
23323
  #
23238
23324
  # @param opts [Hash] Additional options.
23239
23325
  #
@@ -23314,6 +23400,41 @@ module OvirtSDK4
23314
23400
  internal_get(GET, opts)
23315
23401
  end
23316
23402
 
23403
+ UPDATE_GLUSTERFS = [
23404
+ [:async, TrueClass].freeze,
23405
+ [:force, TrueClass].freeze,
23406
+ ].freeze
23407
+
23408
+ private_constant :UPDATE_GLUSTERFS
23409
+
23410
+ #
23411
+ # Update the specified Glusterfs storage connection in the system.
23412
+ #
23413
+ # @param connection [StorageConnection] The `connection` to update.
23414
+ # @param opts [Hash] Additional options.
23415
+ #
23416
+ # @option opts [Boolean] :async Indicates if the update should be performed asynchronously.
23417
+ #
23418
+ # @option opts [Boolean] :force Indicates if the operation should succeed regardless to the relevant storage domain's status
23419
+ # (i.e. updating is also applicable when storage domain's status is not maintenance).
23420
+ #
23421
+ # This parameter is optional, and the default value is `false`.
23422
+ #
23423
+ # @option opts [Hash] :headers ({}) Additional HTTP headers.
23424
+ #
23425
+ # @option opts [Hash] :query ({}) Additional URL query parameters.
23426
+ #
23427
+ # @option opts [Integer] :timeout (nil) The timeout for this request, in seconds. If no value is explicitly
23428
+ # given then the timeout set globally for the connection will be used.
23429
+ #
23430
+ # @option opts [Boolean] :wait (true) If `true` wait for the response.
23431
+ #
23432
+ # @return [StorageConnection]
23433
+ #
23434
+ def update_glusterfs(connection, opts = {})
23435
+ internal_update(connection, StorageConnection, UPDATE_GLUSTERFS, opts)
23436
+ end
23437
+
23317
23438
  UPDATE_ISCSI = [
23318
23439
  [:async, TrueClass].freeze,
23319
23440
  [:force, TrueClass].freeze,
@@ -23392,7 +23513,7 @@ module OvirtSDK4
23392
23513
  private_constant :UPDATE_NFS
23393
23514
 
23394
23515
  #
23395
- # Update the specified nfs storage connection in the system.
23516
+ # Update the specified NFS storage connection in the system.
23396
23517
  #
23397
23518
  # @param connection [StorageConnection] The `connection` to update.
23398
23519
  # @param opts [Hash] Additional options.
@@ -23468,7 +23589,7 @@ module OvirtSDK4
23468
23589
  #
23469
23590
  # Updates the storage connection.
23470
23591
  #
23471
- # For example, to change the address of the storage server send a request like this:
23592
+ # For example, to change the address of an NFS storage server, send a request like this:
23472
23593
  #
23473
23594
  # [source,xml]
23474
23595
  # ----
@@ -23481,9 +23602,23 @@ module OvirtSDK4
23481
23602
  # ----
23482
23603
  # <storage_connection>
23483
23604
  # <address>mynewnfs.example.com</address>
23484
- # <host>
23485
- # <name>myhost</name>
23486
- # </host>
23605
+ # </storage_connection>
23606
+ # ----
23607
+ #
23608
+ # To change the connection of an iSCSI storage server, send a request like this:
23609
+ #
23610
+ # [source,xml]
23611
+ # ----
23612
+ # PUT /ovirt-engine/api/storageconnections/123
23613
+ # ----
23614
+ #
23615
+ # With a request body like this:
23616
+ #
23617
+ # [source,xml]
23618
+ # ----
23619
+ # <storage_connection>
23620
+ # <port>3260</port>
23621
+ # <target>iqn.2017-01.com.myhost:444</target>
23487
23622
  # </storage_connection>
23488
23623
  # ----
23489
23624
  #
@@ -23520,7 +23655,7 @@ module OvirtSDK4
23520
23655
  private_constant :UPDATE_VFS
23521
23656
 
23522
23657
  #
23523
- # Update the specified vfs storage connection in the system.
23658
+ # Update the specified VFS storage connection in the system.
23524
23659
  #
23525
23660
  # @param connection [StorageConnection] The `connection` to update.
23526
23661
  # @param opts [Hash] Additional options.
@@ -23847,6 +23982,33 @@ module OvirtSDK4
23847
23982
  internal_add(connection, StorageConnection, ADD, opts)
23848
23983
  end
23849
23984
 
23985
+ ADD_GLUSTERFS = [
23986
+ ].freeze
23987
+
23988
+ private_constant :ADD_GLUSTERFS
23989
+
23990
+ #
23991
+ # Add a Glusterfs storage connection to the system.
23992
+ #
23993
+ # @param connection [StorageConnection] The `connection` to add.
23994
+ #
23995
+ # @param opts [Hash] Additional options.
23996
+ #
23997
+ # @option opts [Hash] :headers ({}) Additional HTTP headers.
23998
+ #
23999
+ # @option opts [Hash] :query ({}) Additional URL query parameters.
24000
+ #
24001
+ # @option opts [Integer] :timeout (nil) The timeout for this request, in seconds. If no value is explicitly
24002
+ # given then the timeout set globally for the connection will be used.
24003
+ #
24004
+ # @option opts [Boolean] :wait (true) If `true` wait for the response.
24005
+ #
24006
+ # @return [StorageConnection]
24007
+ #
24008
+ def add_glusterfs(connection, opts = {})
24009
+ internal_add(connection, StorageConnection, ADD_GLUSTERFS, opts)
24010
+ end
24011
+
23850
24012
  ADD_ISCSI = [
23851
24013
  ].freeze
23852
24014
 
@@ -28521,6 +28683,9 @@ module OvirtSDK4
28521
28683
  #
28522
28684
  # @option opts [Cluster] :cluster Specifies the cluster the virtual machine should migrate to. This is an optional parameter. By default, the
28523
28685
  # virtual machine is migrated to another host within the same cluster.
28686
+ #
28687
+ # WARNING: Live migration to another cluster is not supported. Strongly consider the target cluster's hardware
28688
+ # architecture and network architecture before attempting a migration.
28524
28689
  #
28525
28690
  # @option opts [Boolean] :force Specifies that the virtual machine should migrate even if the virtual machine is defined as non-migratable.
28526
28691
  # This is an optional parameter. By default, it is set to `false`.
@@ -29961,6 +30126,36 @@ module OvirtSDK4
29961
30126
  internal_action(:move, nil, MOVE, opts)
29962
30127
  end
29963
30128
 
30129
+ REDUCE = [
30130
+ [:async, TrueClass].freeze,
30131
+ ].freeze
30132
+
30133
+ private_constant :REDUCE
30134
+
30135
+ #
30136
+ # Reduces the size of the disk image.
30137
+ #
30138
+ # Invokes _reduce_ on the logical volume (i.e. this is only applicable for block storage domains).
30139
+ # This is applicable for floating disks and disks attached to non-running virtual machines.
30140
+ # There is no need to specify the size as the optimal size is calculated automatically.
30141
+ #
30142
+ # @param opts [Hash] Additional options.
30143
+ #
30144
+ # @option opts [Boolean] :async Indicates if the remove should be performed asynchronously.
30145
+ #
30146
+ # @option opts [Hash] :headers ({}) Additional HTTP headers.
30147
+ #
30148
+ # @option opts [Hash] :query ({}) Additional URL query parameters.
30149
+ #
30150
+ # @option opts [Integer] :timeout (nil) The timeout for this request, in seconds. If no value is explicitly
30151
+ # given then the timeout set globally for the connection will be used.
30152
+ #
30153
+ # @option opts [Boolean] :wait (true) If `true` wait for the response.
30154
+ #
30155
+ def reduce(opts = {})
30156
+ internal_action(:reduce, nil, REDUCE, opts)
30157
+ end
30158
+
29964
30159
  REMOVE = [
29965
30160
  [:async, TrueClass].freeze,
29966
30161
  ].freeze
@@ -31219,6 +31414,9 @@ module OvirtSDK4
31219
31414
  # DELETE /ovirt-engine/api/vms/123/numanodes/456
31220
31415
  # ----
31221
31416
  #
31417
+ # NOTE: It's required to remove the numa nodes from the highest index
31418
+ # first.
31419
+ #
31222
31420
  # @param opts [Hash] Additional options.
31223
31421
  #
31224
31422
  # @option opts [Boolean] :async Indicates if the remove should be performed asynchronously.
@@ -33021,6 +33219,8 @@ module OvirtSDK4
33021
33219
  # For more details of how the default network filter is calculated please refer to
33022
33220
  # the documentation in <<services/network_filters,NetworkFilters>>.
33023
33221
  #
33222
+ # NOTE: The automatically created vNIC profile for the external network will be without network filter.
33223
+ #
33024
33224
  # The output of creating a new VNIC profile depends in the body arguments that were given.
33025
33225
  # In case no network filter was given, the default network filter will be configured. For example:
33026
33226
  #
@@ -33734,6 +33934,7 @@ module OvirtSDK4
33734
33934
  end
33735
33935
 
33736
33936
  GET = [
33937
+ [:all_content, TrueClass].freeze,
33737
33938
  [:follow, String].freeze,
33738
33939
  ].freeze
33739
33940
 
@@ -33744,6 +33945,18 @@ module OvirtSDK4
33744
33945
  #
33745
33946
  # @param opts [Hash] Additional options.
33746
33947
  #
33948
+ # @option opts [Boolean] :all_content Indicates if all of the attributes of the disk should be included in the response.
33949
+ #
33950
+ # By default the following disk attributes are excluded:
33951
+ #
33952
+ # - `vms`
33953
+ #
33954
+ # For example, to retrieve the complete representation of disk '123':
33955
+ #
33956
+ # ....
33957
+ # GET /ovirt-engine/api/disks/123?all_content=true
33958
+ # ....
33959
+ #
33747
33960
  # @option opts [String] :follow Indicates which inner links should be _followed_. The objects referenced by these links will be fetched as part
33748
33961
  # of the current request. See <<documents/003_common_concepts/follow, here>> for details.
33749
33962
  #
@@ -33845,6 +34058,36 @@ module OvirtSDK4
33845
34058
  internal_action(:move, nil, MOVE, opts)
33846
34059
  end
33847
34060
 
34061
+ REDUCE = [
34062
+ [:async, TrueClass].freeze,
34063
+ ].freeze
34064
+
34065
+ private_constant :REDUCE
34066
+
34067
+ #
34068
+ # Reduces the size of the disk image.
34069
+ #
34070
+ # Invokes _reduce_ on the logical volume (i.e. this is only applicable for block storage domains).
34071
+ # This is applicable for floating disks and disks attached to non-running virtual machines.
34072
+ # There is no need to specify the size as the optimal size is calculated automatically.
34073
+ #
34074
+ # @param opts [Hash] Additional options.
34075
+ #
34076
+ # @option opts [Boolean] :async Indicates if the remove should be performed asynchronously.
34077
+ #
34078
+ # @option opts [Hash] :headers ({}) Additional HTTP headers.
34079
+ #
34080
+ # @option opts [Hash] :query ({}) Additional URL query parameters.
34081
+ #
34082
+ # @option opts [Integer] :timeout (nil) The timeout for this request, in seconds. If no value is explicitly
34083
+ # given then the timeout set globally for the connection will be used.
34084
+ #
34085
+ # @option opts [Boolean] :wait (true) If `true` wait for the response.
34086
+ #
34087
+ def reduce(opts = {})
34088
+ internal_action(:reduce, nil, REDUCE, opts)
34089
+ end
34090
+
33848
34091
  REFRESH_LUN = [
33849
34092
  [:host, Host].freeze,
33850
34093
  ].freeze
@@ -35496,7 +35739,7 @@ module OvirtSDK4
35496
35739
  # @option opts [Host] :host The `override_iptables` property is used to indicate if the firewall configuration should be replaced by the
35497
35740
  # default one.
35498
35741
  #
35499
- # @option opts [String] :image When installing an {product-name} node a image ISO file is required.
35742
+ # @option opts [String] :image When installing {hypervisor-name}, an ISO image file is required.
35500
35743
  #
35501
35744
  # @option opts [String] :root_password The password of of the `root` user, used to connect to the host via SSH.
35502
35745
  #
@@ -36038,6 +36281,8 @@ module OvirtSDK4
36038
36281
  #
36039
36282
  # @option opts [Boolean] :reboot Indicates if the host should be rebooted after upgrade.
36040
36283
  # By default the host is rebooted.
36284
+ #
36285
+ # NOTE: This parameter is ignored for {hypervisor-name}, which is always rebooted after upgrade.
36041
36286
  #
36042
36287
  # @option opts [Hash] :headers ({}) Additional HTTP headers.
36043
36288
  #
@@ -36138,7 +36383,7 @@ module OvirtSDK4
36138
36383
  # @option opts [Host] :host The `override_iptables` property is used to indicate if the firewall configuration should be replaced by the
36139
36384
  # default one.
36140
36385
  #
36141
- # @option opts [String] :image When installing an {product-name} node a image ISO file is required.
36386
+ # @option opts [String] :image When installing {hypervisor-name}, an ISO image file is required.
36142
36387
  #
36143
36388
  # @option opts [String] :root_password The password of of the `root` user, used to connect to the host via SSH.
36144
36389
  #
@@ -36250,7 +36495,7 @@ module OvirtSDK4
36250
36495
  # @option opts [Host] :host The `override_iptables` property is used to indicate if the firewall configuration should be replaced by the
36251
36496
  # default one.
36252
36497
  #
36253
- # @option opts [String] :image When installing an {product-name} node a image ISO file is required.
36498
+ # @option opts [String] :image When installing {hypervisor-name}, an ISO image file is required.
36254
36499
  #
36255
36500
  # @option opts [String] :root_password The password of of the `root` user, used to connect to the host via SSH.
36256
36501
  #