ovirt-engine-sdk 4.2.5 → 4.3.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -716,6 +716,18 @@ module OvirtSDK4
716
716
  class VmApplicationsService < Service
717
717
  end
718
718
 
719
+ class VmBackupService < Service
720
+ end
721
+
722
+ class VmBackupDiskService < Service
723
+ end
724
+
725
+ class VmBackupDisksService < Service
726
+ end
727
+
728
+ class VmBackupsService < Service
729
+ end
730
+
719
731
  class VmCdromService < Service
720
732
  end
721
733
 
@@ -4060,7 +4072,7 @@ module OvirtSDK4
4060
4072
  # <ballooning_enabled>false</ballooning_enabled>
4061
4073
  # <cpu>
4062
4074
  # <architecture>x86_64</architecture>
4063
- # <type>Intel Penryn Family</type>
4075
+ # <type>Intel Nehalem Family</type>
4064
4076
  # </cpu>
4065
4077
  # <error_handling>
4066
4078
  # <on_error>migrate</on_error>
@@ -4081,7 +4093,6 @@ module OvirtSDK4
4081
4093
  # <enabled>true</enabled>
4082
4094
  # <merge_across_nodes>true</merge_across_nodes>
4083
4095
  # </ksm>
4084
- # <maintenance_reason_required>false</maintenance_reason_required>
4085
4096
  # <memory_policy>
4086
4097
  # <over_commit>
4087
4098
  # <percent>100</percent>
@@ -4097,7 +4108,6 @@ module OvirtSDK4
4097
4108
  # </bandwidth>
4098
4109
  # <compressed>inherit</compressed>
4099
4110
  # </migration>
4100
- # <optional_reason>false</optional_reason>
4101
4111
  # <required_rng_sources>
4102
4112
  # <required_rng_source>random</required_rng_source>
4103
4113
  # </required_rng_sources>
@@ -4863,7 +4873,7 @@ module OvirtSDK4
4863
4873
  # <cluster_level id="3.6">
4864
4874
  # <cpu_types>
4865
4875
  # <cpu_type>
4866
- # <name>Intel Conroe Family</name>
4876
+ # <name>Intel Nehalem Family</name>
4867
4877
  # <level>3</level>
4868
4878
  # <architecture>x86_64</architecture>
4869
4879
  # </cpu_type>
@@ -5240,7 +5250,7 @@ module OvirtSDK4
5240
5250
  # <cluster>
5241
5251
  # <name>mycluster</name>
5242
5252
  # <cpu>
5243
- # <type>Intel Penryn Family</type>
5253
+ # <type>Intel Nehalem Family</type>
5244
5254
  # </cpu>
5245
5255
  # <data_center id="123"/>
5246
5256
  # </cluster>
@@ -5261,7 +5271,7 @@ module OvirtSDK4
5261
5271
  # <cluster>
5262
5272
  # <name>mycluster</name>
5263
5273
  # <cpu>
5264
- # <type>Intel Penryn Family</type>
5274
+ # <type>Intel Nehalem Family</type>
5265
5275
  # </cpu>
5266
5276
  # <data_center id="123"/>
5267
5277
  # <external_network_providers>
@@ -5565,14 +5575,14 @@ module OvirtSDK4
5565
5575
  #
5566
5576
  # Returns the list of CPU profiles of the system.
5567
5577
  #
5568
- # The order of the returned list of CPU profiles isn't guranteed.
5578
+ # The order of the returned list of CPU profiles is random.
5569
5579
  #
5570
5580
  # @param opts [Hash] Additional options.
5571
5581
  #
5572
5582
  # @option opts [String] :follow Indicates which inner links should be _followed_. The objects referenced by these links will be fetched as part
5573
5583
  # of the current request. See <<documents/003_common_concepts/follow, here>> for details.
5574
5584
  #
5575
- # @option opts [Integer] :max Sets the maximum number of profiles to return. If not specified all the profiles are returned.
5585
+ # @option opts [Integer] :max Sets the maximum number of profiles to return. If not specified, all the profiles are returned.
5576
5586
  #
5577
5587
  # @option opts [Hash] :headers ({}) Additional HTTP headers.
5578
5588
  #
@@ -8781,7 +8791,7 @@ module OvirtSDK4
8781
8791
  private_constant :ADD
8782
8792
 
8783
8793
  #
8784
- # Adds a new external host provider to the system.
8794
+ # Add a new external host provider to the system.
8785
8795
  #
8786
8796
  # @param provider [ExternalHostProvider] The `provider` to add.
8787
8797
  #
@@ -8813,14 +8823,14 @@ module OvirtSDK4
8813
8823
  #
8814
8824
  # Returns the list of external host providers.
8815
8825
  #
8816
- # The order of the returned list of host providers is not guaranteed.
8826
+ # The order of the returned list of host providers isn't guaranteed.
8817
8827
  #
8818
8828
  # @param opts [Hash] Additional options.
8819
8829
  #
8820
8830
  # @option opts [String] :follow Indicates which inner links should be _followed_. The objects referenced by these links will be fetched as part
8821
8831
  # of the current request. See <<documents/003_common_concepts/follow, here>> for details.
8822
8832
  #
8823
- # @option opts [Integer] :max Sets the maximum number of providers to return. If not specified, all the providers are returned.
8833
+ # @option opts [Integer] :max Sets the maximum number of providers to return. If not specified all the providers are returned.
8824
8834
  #
8825
8835
  # @option opts [String] :search A query string used to restrict the returned external host providers.
8826
8836
  #
@@ -11159,14 +11169,14 @@ module OvirtSDK4
11159
11169
  #
11160
11170
  # Returns the list of hooks configured for the host.
11161
11171
  #
11162
- # The order of the returned list of hooks isn't guranteed.
11172
+ # The order of the returned list of hooks is random.
11163
11173
  #
11164
11174
  # @param opts [Hash] Additional options.
11165
11175
  #
11166
11176
  # @option opts [String] :follow Indicates which inner links should be _followed_. The objects referenced by these links will be fetched as part
11167
11177
  # of the current request. See <<documents/003_common_concepts/follow, here>> for details.
11168
11178
  #
11169
- # @option opts [Integer] :max Sets the maximum number of hooks to return. If not specified all the hooks are returned.
11179
+ # @option opts [Integer] :max Sets the maximum number of hooks to return. If not specified, all the hooks are returned.
11170
11180
  #
11171
11181
  # @option opts [Hash] :headers ({}) Additional HTTP headers.
11172
11182
  #
@@ -11483,6 +11493,7 @@ module OvirtSDK4
11483
11493
  class HostsService < Service
11484
11494
 
11485
11495
  ADD = [
11496
+ [:activate, TrueClass].freeze,
11486
11497
  [:deploy_hosted_engine, TrueClass].freeze,
11487
11498
  [:undeploy_hosted_engine, TrueClass].freeze,
11488
11499
  ].freeze
@@ -11492,10 +11503,10 @@ module OvirtSDK4
11492
11503
  #
11493
11504
  # Creates a new host.
11494
11505
  #
11495
- # The host is created based on the attributes of the `host` parameter. The `name`, `address` and `root_password`
11506
+ # The host is created based on the attributes of the `host` parameter. The `name`, `address`, and `root_password`
11496
11507
  # properties are required.
11497
11508
  #
11498
- # For example, to add a host send the following request:
11509
+ # For example, to add a host, send the following request:
11499
11510
  #
11500
11511
  # [source]
11501
11512
  # ----
@@ -11516,8 +11527,8 @@ module OvirtSDK4
11516
11527
  # NOTE: The `root_password` element is only included in the client-provided initial representation and is not
11517
11528
  # exposed in the representations returned from subsequent requests.
11518
11529
  #
11519
- # IMPORTANT: Since version 4.1.2 of the engine when a host is newly added we override the host firewall
11520
- # definitions by default.
11530
+ # IMPORTANT: Since version 4.1.2 of the engine, when a host is newly added, the host's firewall
11531
+ # definitions are overridden by default.
11521
11532
  #
11522
11533
  # To add a hosted engine host, use the optional `deploy_hosted_engine` parameter:
11523
11534
  #
@@ -11526,11 +11537,11 @@ module OvirtSDK4
11526
11537
  # POST /ovirt-engine/api/hosts?deploy_hosted_engine=true
11527
11538
  # ----
11528
11539
  #
11529
- # If the cluster has a default external network provider which is supported for automatic deployment,
11540
+ # If the cluster has a default external network provider that is supported for automatic deployment,
11530
11541
  # the external network provider is deployed when adding the host.
11531
11542
  # Only external network providers for OVN are supported for the automatic deployment.
11532
- # To deploy an external network provider that differs to what is defined in the clusters, overwrite the external
11533
- # network provider when adding hosts by sending a request like this:
11543
+ # To deploy an external network provider other than the one defined in the clusters, overwrite the external
11544
+ # network provider when adding hosts, by sending the following request:
11534
11545
  #
11535
11546
  # [source]
11536
11547
  # ----
@@ -11554,18 +11565,22 @@ module OvirtSDK4
11554
11565
  # </host>
11555
11566
  # ----
11556
11567
  #
11557
- # @param host [Host] The host definition from which to create the new host is passed as parameter, and the newly created host
11568
+ # @param host [Host] The host definition with which the new host is created is passed as a parameter, and the newly created host
11558
11569
  # is returned.
11559
11570
  #
11560
11571
  # @param opts [Hash] Additional options.
11561
11572
  #
11562
- # @option opts [Boolean] :deploy_hosted_engine When set to `true` it means this host should deploy also hosted engine components. Missing value is treated
11563
- # as `true` i.e deploy. Omitting this parameter means `false` and will perform no operation in hosted engine
11564
- # area.
11573
+ # @option opts [Boolean] :activate When set to `true`, this host will be activated after its installation completes. When set to `false`
11574
+ # the host will remain in `maintenance` status after its installation. Absence of this parameter will be
11575
+ # interpreted as `true`, since the desired default behavior is activating the host after install.
11576
+ #
11577
+ # @option opts [Boolean] :deploy_hosted_engine When set to `true`, this host deploys the hosted engine components. A missing value is treated
11578
+ # as `true`, i.e., deploy the hosted engine components. Omitting this parameter equals `false`, and
11579
+ # the host performs no operation in the hosted engine area.
11565
11580
  #
11566
- # @option opts [Boolean] :undeploy_hosted_engine When set to `true` it means this host should un-deploy hosted engine components and this host will not
11567
- # function as part of the High Availability cluster. Missing value is treated as `true` i.e un-deploy.
11568
- # Omitting this parameter means `false` and will perform no operation in hosted engine area.
11581
+ # @option opts [Boolean] :undeploy_hosted_engine When set to `true`, this host un-deploys the hosted engine components and does not
11582
+ # function as part of the High Availability cluster. A missing value is treated as `true`, i.e., un-deploy.
11583
+ # Omitting this parameter equals `false` and the host performs no operation in the hosted engine area.
11569
11584
  #
11570
11585
  # @option opts [Hash] :headers ({}) Additional HTTP headers.
11571
11586
  #
@@ -11588,6 +11603,7 @@ module OvirtSDK4
11588
11603
  [:filter, TrueClass].freeze,
11589
11604
  [:follow, String].freeze,
11590
11605
  [:max, Integer].freeze,
11606
+ [:migration_target_of, String].freeze,
11591
11607
  [:search, String].freeze,
11592
11608
  ].freeze
11593
11609
 
@@ -11602,7 +11618,7 @@ module OvirtSDK4
11602
11618
  # GET /ovirt-engine/api/hosts
11603
11619
  # ....
11604
11620
  #
11605
- # The response body will be something like this:
11621
+ # The response body will be similar to this:
11606
11622
  #
11607
11623
  # [source,xml]
11608
11624
  # ----
@@ -11649,6 +11665,16 @@ module OvirtSDK4
11649
11665
  #
11650
11666
  # @option opts [Integer] :max Sets the maximum number of hosts to return. If not specified all the hosts are returned.
11651
11667
  #
11668
+ # @option opts [String] :migration_target_of Accepts a comma-separated list of virtual machine IDs and returns the hosts
11669
+ # that these virtual machines can be migrated to.
11670
+ #
11671
+ # For example, to retrieve the list of hosts to which the virtual machine with ID 123 and
11672
+ # the virtual machine with ID 456 can be migrated to, send the following request:
11673
+ #
11674
+ # ....
11675
+ # GET /ovirt-engine/api/hosts?migration_target_of=123,456
11676
+ # ....
11677
+ #
11652
11678
  # @option opts [String] :search A query string used to restrict the returned hosts.
11653
11679
  #
11654
11680
  # @option opts [Hash] :headers ({}) Additional HTTP headers.
@@ -11667,6 +11693,7 @@ module OvirtSDK4
11667
11693
  end
11668
11694
 
11669
11695
  ADD_USING_ROOT_PASSWORD = [
11696
+ [:activate, TrueClass].freeze,
11670
11697
  [:deploy_hosted_engine, TrueClass].freeze,
11671
11698
  [:undeploy_hosted_engine, TrueClass].freeze,
11672
11699
  ].freeze
@@ -11676,18 +11703,22 @@ module OvirtSDK4
11676
11703
  #
11677
11704
  # Add a new host to the system providing the host root password. This has been deprecated and provided for backwards compatibility.
11678
11705
  #
11679
- # @param host [Host] The host definition from which to create the new host is passed as parameter, and the newly created host
11706
+ # @param host [Host] The host definition with which the new host is created is passed as a parameter, and the newly created host
11680
11707
  # is returned.
11681
11708
  #
11682
11709
  # @param opts [Hash] Additional options.
11683
11710
  #
11684
- # @option opts [Boolean] :deploy_hosted_engine When set to `true` it means this host should deploy also hosted engine components. Missing value is treated
11685
- # as `true` i.e deploy. Omitting this parameter means `false` and will perform no operation in hosted engine
11686
- # area.
11711
+ # @option opts [Boolean] :activate When set to `true`, this host will be activated after its installation completes. When set to `false`
11712
+ # the host will remain in `maintenance` status after its installation. Absence of this parameter will be
11713
+ # interpreted as `true`, since the desired default behavior is activating the host after install.
11687
11714
  #
11688
- # @option opts [Boolean] :undeploy_hosted_engine When set to `true` it means this host should un-deploy hosted engine components and this host will not
11689
- # function as part of the High Availability cluster. Missing value is treated as `true` i.e un-deploy.
11690
- # Omitting this parameter means `false` and will perform no operation in hosted engine area.
11715
+ # @option opts [Boolean] :deploy_hosted_engine When set to `true`, this host deploys the hosted engine components. A missing value is treated
11716
+ # as `true`, i.e., deploy the hosted engine components. Omitting this parameter equals `false`, and
11717
+ # the host performs no operation in the hosted engine area.
11718
+ #
11719
+ # @option opts [Boolean] :undeploy_hosted_engine When set to `true`, this host un-deploys the hosted engine components and does not
11720
+ # function as part of the High Availability cluster. A missing value is treated as `true`, i.e., un-deploy.
11721
+ # Omitting this parameter equals `false` and the host performs no operation in the hosted engine area.
11691
11722
  #
11692
11723
  # @option opts [Hash] :headers ({}) Additional HTTP headers.
11693
11724
  #
@@ -11705,6 +11736,7 @@ module OvirtSDK4
11705
11736
  end
11706
11737
 
11707
11738
  ADD_USING_SSH = [
11739
+ [:activate, TrueClass].freeze,
11708
11740
  [:deploy_hosted_engine, TrueClass].freeze,
11709
11741
  [:undeploy_hosted_engine, TrueClass].freeze,
11710
11742
  ].freeze
@@ -11714,18 +11746,22 @@ module OvirtSDK4
11714
11746
  #
11715
11747
  # Add a new host to the system providing the ssh password or fingerprint.
11716
11748
  #
11717
- # @param host [Host] The host definition from which to create the new host is passed as parameter, and the newly created host
11749
+ # @param host [Host] The host definition with which the new host is created is passed as a parameter, and the newly created host
11718
11750
  # is returned.
11719
11751
  #
11720
11752
  # @param opts [Hash] Additional options.
11721
11753
  #
11722
- # @option opts [Boolean] :deploy_hosted_engine When set to `true` it means this host should deploy also hosted engine components. Missing value is treated
11723
- # as `true` i.e deploy. Omitting this parameter means `false` and will perform no operation in hosted engine
11724
- # area.
11754
+ # @option opts [Boolean] :activate When set to `true`, this host will be activated after its installation completes. When set to `false`
11755
+ # the host will remain in `maintenance` status after its installation. Absence of this parameter will be
11756
+ # interpreted as `true`, since the desired default behavior is activating the host after install.
11757
+ #
11758
+ # @option opts [Boolean] :deploy_hosted_engine When set to `true`, this host deploys the hosted engine components. A missing value is treated
11759
+ # as `true`, i.e., deploy the hosted engine components. Omitting this parameter equals `false`, and
11760
+ # the host performs no operation in the hosted engine area.
11725
11761
  #
11726
- # @option opts [Boolean] :undeploy_hosted_engine When set to `true` it means this host should un-deploy hosted engine components and this host will not
11727
- # function as part of the High Availability cluster. Missing value is treated as `true` i.e un-deploy.
11728
- # Omitting this parameter means `false` and will perform no operation in hosted engine area.
11762
+ # @option opts [Boolean] :undeploy_hosted_engine When set to `true`, this host un-deploys the hosted engine components and does not
11763
+ # function as part of the High Availability cluster. A missing value is treated as `true`, i.e., un-deploy.
11764
+ # Omitting this parameter equals `false` and the host performs no operation in the hosted engine area.
11729
11765
  #
11730
11766
  # @option opts [Hash] :headers ({}) Additional HTTP headers.
11731
11767
  #
@@ -14756,6 +14792,8 @@ module OvirtSDK4
14756
14792
  # </network>
14757
14793
  # ----
14758
14794
  #
14795
+ # NOTE: Updating external networks is not propagated to the provider.
14796
+ #
14759
14797
  # @param network [Network] The `network` to update.
14760
14798
  # @param opts [Hash] Additional options.
14761
14799
  #
@@ -16057,7 +16095,7 @@ module OvirtSDK4
16057
16095
  private_constant :ADD
16058
16096
 
16059
16097
  #
16060
- # Adds a new OpenStack image provider to the system.
16098
+ # Add a new OpenStack image provider to the system.
16061
16099
  #
16062
16100
  # @param provider [OpenStackImageProvider] The `provider` to add.
16063
16101
  #
@@ -16089,14 +16127,14 @@ module OvirtSDK4
16089
16127
  #
16090
16128
  # Returns the list of providers.
16091
16129
  #
16092
- # The order of the returned list of providers is not guaranteed.
16130
+ # The order of the returned list of providers isn't guaranteed.
16093
16131
  #
16094
16132
  # @param opts [Hash] Additional options.
16095
16133
  #
16096
16134
  # @option opts [String] :follow Indicates which inner links should be _followed_. The objects referenced by these links will be fetched as part
16097
16135
  # of the current request. See <<documents/003_common_concepts/follow, here>> for details.
16098
16136
  #
16099
- # @option opts [Integer] :max Sets the maximum number of providers to return. If not specified, all the providers are returned.
16137
+ # @option opts [Integer] :max Sets the maximum number of providers to return. If not specified all the providers are returned.
16100
16138
  #
16101
16139
  # @option opts [String] :search A query string used to restrict the returned OpenStack image providers.
16102
16140
  #
@@ -16545,7 +16583,7 @@ module OvirtSDK4
16545
16583
  private_constant :ADD
16546
16584
 
16547
16585
  #
16548
- # Adds a new network provider to the system.
16586
+ # The operation adds a new network provider to the system.
16549
16587
  # If the `type` property is not present, a default value of `NEUTRON` will be used.
16550
16588
  #
16551
16589
  # @param provider [OpenStackNetworkProvider] The `provider` to add.
@@ -16578,14 +16616,14 @@ module OvirtSDK4
16578
16616
  #
16579
16617
  # Returns the list of providers.
16580
16618
  #
16581
- # The order of the returned list of providers is not guaranteed.
16619
+ # The order of the returned list of providers isn't guaranteed.
16582
16620
  #
16583
16621
  # @param opts [Hash] Additional options.
16584
16622
  #
16585
16623
  # @option opts [String] :follow Indicates which inner links should be _followed_. The objects referenced by these links will be fetched as part
16586
16624
  # of the current request. See <<documents/003_common_concepts/follow, here>> for details.
16587
16625
  #
16588
- # @option opts [Integer] :max Sets the maximum number of providers to return. If not specified, all the providers are returned.
16626
+ # @option opts [Integer] :max Sets the maximum number of providers to return. If not specified all the providers are returned.
16589
16627
  #
16590
16628
  # @option opts [String] :search A query string used to restrict the returned OpenStack network providers.
16591
16629
  #
@@ -16605,7 +16643,7 @@ module OvirtSDK4
16605
16643
  end
16606
16644
 
16607
16645
  #
16608
- # Reference to the OpenStack network provider service.
16646
+ # Reference to OpenStack network provider service.
16609
16647
  #
16610
16648
  # @param id [String] The identifier of the `provider`.
16611
16649
  #
@@ -17333,14 +17371,14 @@ module OvirtSDK4
17333
17371
  #
17334
17372
  # Retrieves the list of volume providers.
17335
17373
  #
17336
- # The order of the returned list of volume providers is not guaranteed.
17374
+ # The order of the returned list of volume providers isn't guaranteed.
17337
17375
  #
17338
17376
  # @param opts [Hash] Additional options.
17339
17377
  #
17340
17378
  # @option opts [String] :follow Indicates which inner links should be _followed_. The objects referenced by these links will be fetched as part
17341
17379
  # of the current request. See <<documents/003_common_concepts/follow, here>> for details.
17342
17380
  #
17343
- # @option opts [Integer] :max Sets the maximum number of providers to return. If not specified, all the providers are returned.
17381
+ # @option opts [Integer] :max Sets the maximum number of providers to return. If not specified all the providers are returned.
17344
17382
  #
17345
17383
  # @option opts [String] :search A query string used to restrict the returned volume providers.
17346
17384
  #
@@ -27218,6 +27256,20 @@ module OvirtSDK4
27218
27256
  # </template>
27219
27257
  # ----
27220
27258
  #
27259
+ # Since version 4.3, in order to create virtual machine template from a snapshot send a request body like this:
27260
+ #
27261
+ # [source,xml]
27262
+ # ----
27263
+ # <template>
27264
+ # <name>mytemplate</name>
27265
+ # <vm id="123">
27266
+ # <snapshots>
27267
+ # <snapshot id="456"/>
27268
+ # </snapshots>
27269
+ # </vm>
27270
+ # </template>
27271
+ # ----
27272
+ #
27221
27273
  # The disks of the template can be customized, making some of their characteristics different from the disks of the
27222
27274
  # original virtual machine. To do so use the `vm.disk_attachments` attribute, specifying the identifier of the disk
27223
27275
  # of the original virtual machine and the characteristics that you want to change. For example, if the original
@@ -27488,6 +27540,70 @@ module OvirtSDK4
27488
27540
  internal_add(template, Template, ADD_FROM_VM, opts)
27489
27541
  end
27490
27542
 
27543
+ ADD_FROM_VM_SNAPSHOT = [
27544
+ [:clone_permissions, TrueClass].freeze,
27545
+ [:seal, TrueClass].freeze,
27546
+ ].freeze
27547
+
27548
+ private_constant :ADD_FROM_VM_SNAPSHOT
27549
+
27550
+ #
27551
+ # Add a virtual machine template to the system from a snapshot.
27552
+ #
27553
+ # @param template [Template] The information about the template or template version.
27554
+ #
27555
+ # @param opts [Hash] Additional options.
27556
+ #
27557
+ # @option opts [Boolean] :clone_permissions Specifies if the permissions of the virtual machine should be copied to the template.
27558
+ #
27559
+ # If this optional parameter is provided, and its value is `true`, then the permissions of the virtual machine
27560
+ # (only the direct ones, not the inherited ones) will be copied to the created template. For example, to create
27561
+ # a template from the `myvm` virtual machine copying its permissions, send a request like this:
27562
+ #
27563
+ # [source]
27564
+ # ----
27565
+ # POST /ovirt-engine/api/templates?clone_permissions=true
27566
+ # ----
27567
+ #
27568
+ # With a request body like this:
27569
+ #
27570
+ # [source,xml]
27571
+ # ----
27572
+ # <template>
27573
+ # <name>mytemplate<name>
27574
+ # <vm>
27575
+ # <name>myvm<name>
27576
+ # </vm>
27577
+ # </template>
27578
+ # ----
27579
+ #
27580
+ # @option opts [Boolean] :seal Seals the template.
27581
+ #
27582
+ # If this optional parameter is provided and its value is `true`,
27583
+ # then the template is sealed after creation.
27584
+ #
27585
+ # Sealing erases all host-specific configuration from the filesystem:
27586
+ # SSH keys, UDEV rules, MAC addresses, system ID, hostname, and so on,
27587
+ # thus making it easier to use the template to create multiple virtual
27588
+ # machines without manual intervention.
27589
+ #
27590
+ # Currently, sealing is supported only for Linux operating systems.
27591
+ #
27592
+ # @option opts [Hash] :headers ({}) Additional HTTP headers.
27593
+ #
27594
+ # @option opts [Hash] :query ({}) Additional URL query parameters.
27595
+ #
27596
+ # @option opts [Integer] :timeout (nil) The timeout for this request, in seconds. If no value is explicitly
27597
+ # given then the timeout set globally for the connection will be used.
27598
+ #
27599
+ # @option opts [Boolean] :wait (true) If `true` wait for the response.
27600
+ #
27601
+ # @return [Template]
27602
+ #
27603
+ def add_from_vm_snapshot(template, opts = {})
27604
+ internal_add(template, Template, ADD_FROM_VM_SNAPSHOT, opts)
27605
+ end
27606
+
27491
27607
  LIST = [
27492
27608
  [:case_sensitive, TrueClass].freeze,
27493
27609
  [:filter, TrueClass].freeze,
@@ -29377,6 +29493,15 @@ module OvirtSDK4
29377
29493
  @applications_service ||= VmApplicationsService.new(self, 'applications')
29378
29494
  end
29379
29495
 
29496
+ #
29497
+ # List of backups of this virtual machine.
29498
+ #
29499
+ # @return [VmBackupsService] A reference to `backups` service.
29500
+ #
29501
+ def backups_service
29502
+ @backups_service ||= VmBackupsService.new(self, 'backups')
29503
+ end
29504
+
29380
29505
  #
29381
29506
  # Locates the `cdroms` service.
29382
29507
  #
@@ -29527,6 +29652,12 @@ module OvirtSDK4
29527
29652
  if path.start_with?('applications/')
29528
29653
  return applications_service.service(path[13..-1])
29529
29654
  end
29655
+ if path == 'backups'
29656
+ return backups_service
29657
+ end
29658
+ if path.start_with?('backups/')
29659
+ return backups_service.service(path[8..-1])
29660
+ end
29530
29661
  if path == 'cdroms'
29531
29662
  return cdroms_service
29532
29663
  end
@@ -29736,6 +29867,336 @@ module OvirtSDK4
29736
29867
 
29737
29868
  end
29738
29869
 
29870
+ class VmBackupService < Service
29871
+
29872
+ FINALIZE = [
29873
+ ].freeze
29874
+
29875
+ private_constant :FINALIZE
29876
+
29877
+ #
29878
+ # Finalize the virtual machine backup entity.
29879
+ #
29880
+ # End backup, unlock resources, and perform cleanups.
29881
+ #
29882
+ # @param opts [Hash] Additional options.
29883
+ #
29884
+ # @option opts [Hash] :headers ({}) Additional HTTP headers.
29885
+ #
29886
+ # @option opts [Hash] :query ({}) Additional URL query parameters.
29887
+ #
29888
+ # @option opts [Integer] :timeout (nil) The timeout for this request, in seconds. If no value is explicitly
29889
+ # given then the timeout set globally for the connection will be used.
29890
+ #
29891
+ # @option opts [Boolean] :wait (true) If `true` wait for the response.
29892
+ #
29893
+ def finalize(opts = {})
29894
+ internal_action(:finalize, nil, FINALIZE, opts)
29895
+ end
29896
+
29897
+ GET = [
29898
+ [:follow, String].freeze,
29899
+ ].freeze
29900
+
29901
+ private_constant :GET
29902
+
29903
+ #
29904
+ # Returns information about the virtual machine backup.
29905
+ #
29906
+ # @param opts [Hash] Additional options.
29907
+ #
29908
+ # @option opts [String] :follow Indicates which inner links should be _followed_. The objects referenced by these links will be fetched as part
29909
+ # of the current request. See <<documents/003_common_concepts/follow, here>> for details.
29910
+ #
29911
+ # @option opts [Hash] :headers ({}) Additional HTTP headers.
29912
+ #
29913
+ # @option opts [Hash] :query ({}) Additional URL query parameters.
29914
+ #
29915
+ # @option opts [Integer] :timeout (nil) The timeout for this request, in seconds. If no value is explicitly
29916
+ # given then the timeout set globally for the connection will be used.
29917
+ #
29918
+ # @option opts [Boolean] :wait (true) If `true` wait for the response.
29919
+ #
29920
+ # @return [Backup]
29921
+ #
29922
+ def get(opts = {})
29923
+ internal_get(GET, opts)
29924
+ end
29925
+
29926
+ #
29927
+ # A reference to the service that lists the disks in backup.
29928
+ #
29929
+ # @return [VmBackupDisksService] A reference to `disks` service.
29930
+ #
29931
+ def disks_service
29932
+ @disks_service ||= VmBackupDisksService.new(self, 'disks')
29933
+ end
29934
+
29935
+ #
29936
+ # Locates the service corresponding to the given path.
29937
+ #
29938
+ # @param path [String] The path of the service.
29939
+ #
29940
+ # @return [Service] A reference to the service.
29941
+ #
29942
+ def service(path)
29943
+ if path.nil? || path == ''
29944
+ return self
29945
+ end
29946
+ if path == 'disks'
29947
+ return disks_service
29948
+ end
29949
+ if path.start_with?('disks/')
29950
+ return disks_service.service(path[6..-1])
29951
+ end
29952
+ raise Error.new("The path \"#{path}\" doesn't correspond to any service")
29953
+ end
29954
+
29955
+ end
29956
+
29957
+ class VmBackupDiskService < Service
29958
+
29959
+ GET = [
29960
+ [:follow, String].freeze,
29961
+ ].freeze
29962
+
29963
+ private_constant :GET
29964
+
29965
+ #
29966
+ # Retrieves the description of the disk.
29967
+ #
29968
+ # @param opts [Hash] Additional options.
29969
+ #
29970
+ # @option opts [String] :follow Indicates which inner links should be _followed_. The objects referenced by these links will be fetched as part
29971
+ # of the current request. See <<documents/003_common_concepts/follow, here>> for details.
29972
+ #
29973
+ # @option opts [Hash] :headers ({}) Additional HTTP headers.
29974
+ #
29975
+ # @option opts [Hash] :query ({}) Additional URL query parameters.
29976
+ #
29977
+ # @option opts [Integer] :timeout (nil) The timeout for this request, in seconds. If no value is explicitly
29978
+ # given then the timeout set globally for the connection will be used.
29979
+ #
29980
+ # @option opts [Boolean] :wait (true) If `true` wait for the response.
29981
+ #
29982
+ # @return [Disk]
29983
+ #
29984
+ def get(opts = {})
29985
+ internal_get(GET, opts)
29986
+ end
29987
+
29988
+ #
29989
+ # Locates the service corresponding to the given path.
29990
+ #
29991
+ # @param path [String] The path of the service.
29992
+ #
29993
+ # @return [Service] A reference to the service.
29994
+ #
29995
+ def service(path)
29996
+ if path.nil? || path == ''
29997
+ return self
29998
+ end
29999
+ raise Error.new("The path \"#{path}\" doesn't correspond to any service")
30000
+ end
30001
+
30002
+ end
30003
+
30004
+ class VmBackupDisksService < Service
30005
+
30006
+ LIST = [
30007
+ [:follow, String].freeze,
30008
+ [:max, Integer].freeze,
30009
+ ].freeze
30010
+
30011
+ private_constant :LIST
30012
+
30013
+ #
30014
+ # Returns the list of disks in backup.
30015
+ #
30016
+ # @param opts [Hash] Additional options.
30017
+ #
30018
+ # @option opts [String] :follow Indicates which inner links should be _followed_. The objects referenced by these links will be fetched as part
30019
+ # of the current request. See <<documents/003_common_concepts/follow, here>> for details.
30020
+ #
30021
+ # @option opts [Integer] :max Sets the maximum number of disks to return. If not specified, all the disks are returned.
30022
+ #
30023
+ # @option opts [Hash] :headers ({}) Additional HTTP headers.
30024
+ #
30025
+ # @option opts [Hash] :query ({}) Additional URL query parameters.
30026
+ #
30027
+ # @option opts [Integer] :timeout (nil) The timeout for this request, in seconds. If no value is explicitly
30028
+ # given then the timeout set globally for the connection will be used.
30029
+ #
30030
+ # @option opts [Boolean] :wait (true) If `true` wait for the response.
30031
+ #
30032
+ # @return [Array<Disk>]
30033
+ #
30034
+ def list(opts = {})
30035
+ internal_get(LIST, opts)
30036
+ end
30037
+
30038
+ #
30039
+ # A reference to the service that manages a specific disk.
30040
+ #
30041
+ # @param id [String] The identifier of the `disk`.
30042
+ #
30043
+ # @return [VmBackupDiskService] A reference to the `disk` service.
30044
+ #
30045
+ def disk_service(id)
30046
+ VmBackupDiskService.new(self, id)
30047
+ end
30048
+
30049
+ #
30050
+ # Locates the service corresponding to the given path.
30051
+ #
30052
+ # @param path [String] The path of the service.
30053
+ #
30054
+ # @return [Service] A reference to the service.
30055
+ #
30056
+ def service(path)
30057
+ if path.nil? || path == ''
30058
+ return self
30059
+ end
30060
+ index = path.index('/')
30061
+ if index.nil?
30062
+ return disk_service(path)
30063
+ end
30064
+ return disk_service(path[0..(index - 1)]).service(path[(index +1)..-1])
30065
+ end
30066
+
30067
+ end
30068
+
30069
+ class VmBackupsService < Service
30070
+
30071
+ ADD = [
30072
+ ].freeze
30073
+
30074
+ private_constant :ADD
30075
+
30076
+ #
30077
+ # Adds a new backup entity to a virtual machine.
30078
+ #
30079
+ # For example, to start a new incremental backup of a virtual machine
30080
+ # since checkpoint id `previous-checkpoint-uuid`, send a request like this:
30081
+ #
30082
+ # [source]
30083
+ # ----
30084
+ # POST /ovirt-engine/api/vms/123/backups
30085
+ # ----
30086
+ #
30087
+ # With a request body like this:
30088
+ #
30089
+ # [source,xml]
30090
+ # ----
30091
+ # POST /ovirt-engine/api/vms/123/backups
30092
+ # <backup>
30093
+ # <from_checkpoint_id>previous-checkpoint-uuid</from_checkpoint_id>
30094
+ # <disks>
30095
+ # <disk id="disk-uuid" />
30096
+ # ...
30097
+ # </disks>
30098
+ # </backup>
30099
+ # ----
30100
+ #
30101
+ # The response body:
30102
+ #
30103
+ # [source,xml]
30104
+ # ----
30105
+ # <backup id="backup-uuid">
30106
+ # <from_checkpoint_id>previous-checkpoint-uuid</from_checkpoint_id>
30107
+ # <to_checkpoint_id>new-checkpoint-uuid</to_checkpoint_id>
30108
+ # <disks>
30109
+ # <disk id="disk-uuid" />
30110
+ # ...
30111
+ # ...
30112
+ # </disks>
30113
+ # <status>initializing</status>
30114
+ # <creation_date>
30115
+ # </backup>
30116
+ # ----
30117
+ #
30118
+ # @param backup [Backup] The information about the virtual machine backup entity.
30119
+ #
30120
+ # @param opts [Hash] Additional options.
30121
+ #
30122
+ # @option opts [Hash] :headers ({}) Additional HTTP headers.
30123
+ #
30124
+ # @option opts [Hash] :query ({}) Additional URL query parameters.
30125
+ #
30126
+ # @option opts [Integer] :timeout (nil) The timeout for this request, in seconds. If no value is explicitly
30127
+ # given then the timeout set globally for the connection will be used.
30128
+ #
30129
+ # @option opts [Boolean] :wait (true) If `true` wait for the response.
30130
+ #
30131
+ # @return [Backup]
30132
+ #
30133
+ def add(backup, opts = {})
30134
+ internal_add(backup, Backup, ADD, opts)
30135
+ end
30136
+
30137
+ LIST = [
30138
+ [:follow, String].freeze,
30139
+ [:max, Integer].freeze,
30140
+ ].freeze
30141
+
30142
+ private_constant :LIST
30143
+
30144
+ #
30145
+ # The list of virtual machine backups.
30146
+ #
30147
+ # @param opts [Hash] Additional options.
30148
+ #
30149
+ # @option opts [String] :follow Indicates which inner links should be _followed_. The objects referenced by these links will be fetched as part
30150
+ # of the current request. See <<documents/003_common_concepts/follow, here>> for details.
30151
+ #
30152
+ # @option opts [Integer] :max Sets the maximum number of virtual machine backups to return. If not specified, all the virtual machine backups are returned.
30153
+ #
30154
+ # @option opts [Hash] :headers ({}) Additional HTTP headers.
30155
+ #
30156
+ # @option opts [Hash] :query ({}) Additional URL query parameters.
30157
+ #
30158
+ # @option opts [Integer] :timeout (nil) The timeout for this request, in seconds. If no value is explicitly
30159
+ # given then the timeout set globally for the connection will be used.
30160
+ #
30161
+ # @option opts [Boolean] :wait (true) If `true` wait for the response.
30162
+ #
30163
+ # @return [Array<Backup>]
30164
+ #
30165
+ def list(opts = {})
30166
+ internal_get(LIST, opts)
30167
+ end
30168
+
30169
+ #
30170
+ # Returns a reference to the service that manages a specific VM backup.
30171
+ #
30172
+ # @param id [String] The identifier of the `backup`.
30173
+ #
30174
+ # @return [VmBackupService] A reference to the `backup` service.
30175
+ #
30176
+ def backup_service(id)
30177
+ VmBackupService.new(self, id)
30178
+ end
30179
+
30180
+ #
30181
+ # Locates the service corresponding to the given path.
30182
+ #
30183
+ # @param path [String] The path of the service.
30184
+ #
30185
+ # @return [Service] A reference to the service.
30186
+ #
30187
+ def service(path)
30188
+ if path.nil? || path == ''
30189
+ return self
30190
+ end
30191
+ index = path.index('/')
30192
+ if index.nil?
30193
+ return backup_service(path)
30194
+ end
30195
+ return backup_service(path[0..(index - 1)]).service(path[(index +1)..-1])
30196
+ end
30197
+
30198
+ end
30199
+
29739
30200
  class VmCdromService < Service
29740
30201
 
29741
30202
  GET = [
@@ -32479,6 +32940,7 @@ module OvirtSDK4
32479
32940
  ADD = [
32480
32941
  [:clone, TrueClass].freeze,
32481
32942
  [:clone_permissions, TrueClass].freeze,
32943
+ [:filter, TrueClass].freeze,
32482
32944
  ].freeze
32483
32945
 
32484
32946
  private_constant :ADD
@@ -32699,6 +33161,15 @@ module OvirtSDK4
32699
33161
  # </vm>
32700
33162
  # ----
32701
33163
  #
33164
+ # @option opts [Boolean] :filter Relevant for admin users only. Indicates whether to assign UserVmManager role
33165
+ # on the created Virtual Machine for this user. This will enable the user to later access
33166
+ # the Virtual Machine as though he were a non-admin user, foregoing his admin permissions
33167
+ # (by providing filter=true).
33168
+ #
33169
+ # NOTE: admin-as-user (meaning providing filter=true) POST requests on an existing Virtual
33170
+ # Machine will fail unless the Virtual Machine has been previously created by the admin as
33171
+ # a user (meaning with filter=true).
33172
+ #
32702
33173
  # @option opts [Hash] :headers ({}) Additional HTTP headers.
32703
33174
  #
32704
33175
  # @option opts [Hash] :query ({}) Additional URL query parameters.
@@ -32717,6 +33188,7 @@ module OvirtSDK4
32717
33188
  ADD_FROM_CONFIGURATION = [
32718
33189
  [:clone, TrueClass].freeze,
32719
33190
  [:clone_permissions, TrueClass].freeze,
33191
+ [:filter, TrueClass].freeze,
32720
33192
  ].freeze
32721
33193
 
32722
33194
  private_constant :ADD_FROM_CONFIGURATION
@@ -32785,6 +33257,15 @@ module OvirtSDK4
32785
33257
  # </vm>
32786
33258
  # ----
32787
33259
  #
33260
+ # @option opts [Boolean] :filter Relevant for admin users only. Indicates whether to assign UserVmManager role
33261
+ # on the created Virtual Machine for this user. This will enable the user to later access
33262
+ # the Virtual Machine as though he were a non-admin user, foregoing his admin permissions
33263
+ # (by providing filter=true).
33264
+ #
33265
+ # NOTE: admin-as-user (meaning providing filter=true) POST requests on an existing Virtual
33266
+ # Machine will fail unless the Virtual Machine has been previously created by the admin as
33267
+ # a user (meaning with filter=true).
33268
+ #
32788
33269
  # @option opts [Hash] :headers ({}) Additional HTTP headers.
32789
33270
  #
32790
33271
  # @option opts [Hash] :query ({}) Additional URL query parameters.
@@ -32803,6 +33284,7 @@ module OvirtSDK4
32803
33284
  ADD_FROM_SCRATCH = [
32804
33285
  [:clone, TrueClass].freeze,
32805
33286
  [:clone_permissions, TrueClass].freeze,
33287
+ [:filter, TrueClass].freeze,
32806
33288
  ].freeze
32807
33289
 
32808
33290
  private_constant :ADD_FROM_SCRATCH
@@ -32871,6 +33353,15 @@ module OvirtSDK4
32871
33353
  # </vm>
32872
33354
  # ----
32873
33355
  #
33356
+ # @option opts [Boolean] :filter Relevant for admin users only. Indicates whether to assign UserVmManager role
33357
+ # on the created Virtual Machine for this user. This will enable the user to later access
33358
+ # the Virtual Machine as though he were a non-admin user, foregoing his admin permissions
33359
+ # (by providing filter=true).
33360
+ #
33361
+ # NOTE: admin-as-user (meaning providing filter=true) POST requests on an existing Virtual
33362
+ # Machine will fail unless the Virtual Machine has been previously created by the admin as
33363
+ # a user (meaning with filter=true).
33364
+ #
32874
33365
  # @option opts [Hash] :headers ({}) Additional HTTP headers.
32875
33366
  #
32876
33367
  # @option opts [Hash] :query ({}) Additional URL query parameters.
@@ -32889,6 +33380,7 @@ module OvirtSDK4
32889
33380
  ADD_FROM_SNAPSHOT = [
32890
33381
  [:clone, TrueClass].freeze,
32891
33382
  [:clone_permissions, TrueClass].freeze,
33383
+ [:filter, TrueClass].freeze,
32892
33384
  ].freeze
32893
33385
 
32894
33386
  private_constant :ADD_FROM_SNAPSHOT
@@ -32957,6 +33449,15 @@ module OvirtSDK4
32957
33449
  # </vm>
32958
33450
  # ----
32959
33451
  #
33452
+ # @option opts [Boolean] :filter Relevant for admin users only. Indicates whether to assign UserVmManager role
33453
+ # on the created Virtual Machine for this user. This will enable the user to later access
33454
+ # the Virtual Machine as though he were a non-admin user, foregoing his admin permissions
33455
+ # (by providing filter=true).
33456
+ #
33457
+ # NOTE: admin-as-user (meaning providing filter=true) POST requests on an existing Virtual
33458
+ # Machine will fail unless the Virtual Machine has been previously created by the admin as
33459
+ # a user (meaning with filter=true).
33460
+ #
32960
33461
  # @option opts [Hash] :headers ({}) Additional HTTP headers.
32961
33462
  #
32962
33463
  # @option opts [Hash] :query ({}) Additional URL query parameters.
@@ -33815,7 +34316,7 @@ module OvirtSDK4
33815
34316
  #
33816
34317
  # This operation copies a disk to the specified storage domain.
33817
34318
  #
33818
- # For example, copy of a disk can be facilitated using the following request:
34319
+ # For example, a disk can be copied using the following request:
33819
34320
  #
33820
34321
  # [source]
33821
34322
  # ----
@@ -33834,10 +34335,10 @@ module OvirtSDK4
33834
34335
  # </action>
33835
34336
  # ----
33836
34337
  #
33837
- # If the disk profile or the quota used currently by the disk aren't defined for the new storage domain, then they
33838
- # can be explicitly specified. If they aren't then the first available disk profile and the default quota are used.
34338
+ # If the disk profile or the quota currently used by the disk are not defined for the new storage domain, they
34339
+ # can be explicitly specified. If they are not specified, the first available disk profile and the default quota are used.
33839
34340
  #
33840
- # For example, to explicitly use disk profile `987` and quota `753` send a request body like this:
34341
+ # For example, to specify disk profile `987` and quota `753`, send a request body like this:
33841
34342
  #
33842
34343
  # [source,xml]
33843
34344
  # ----
@@ -33870,8 +34371,8 @@ module OvirtSDK4
33870
34371
  # If this parameter is not used and the old quota is not defined for the new storage domain,
33871
34372
  # the default (unlimited) quota will be assigned to the disk.
33872
34373
  #
33873
- # @option opts [StorageDomain] :storage_domain The storage domain where the new disk will be created. Can be specified using the `id` or `name`
33874
- # attributes. For example, to copy a disk to the storage domain named `mydata` send a request like this:
34374
+ # @option opts [StorageDomain] :storage_domain The storage domain where the new disk is created. This can be specified using the `id` or `name`
34375
+ # attributes. For example, to copy a disk to the storage domain called `mydata`, send a request like this:
33875
34376
  #
33876
34377
  # ....
33877
34378
  # POST /ovirt-engine/api/storagedomains/123/disks/789
@@ -33918,7 +34419,7 @@ module OvirtSDK4
33918
34419
  #
33919
34420
  # @option opts [Boolean] :filter Indicates if the results should be filtered according to the permissions of the user.
33920
34421
  #
33921
- # @option opts [StorageDomain] :storage_domain
34422
+ # @option opts [StorageDomain] :storage_domain The export storage domain where the disk will be exported to.
33922
34423
  #
33923
34424
  # @option opts [Hash] :headers ({}) Additional HTTP headers.
33924
34425
  #
@@ -34043,7 +34544,7 @@ module OvirtSDK4
34043
34544
  # If this parameter is not used and the old quota is not defined for the new storage domain,
34044
34545
  # the default (unlimited) quota will be assigned to the disk.
34045
34546
  #
34046
- # @option opts [StorageDomain] :storage_domain
34547
+ # @option opts [StorageDomain] :storage_domain The storage domain where the disk will be moved to.
34047
34548
  #
34048
34549
  # @option opts [Hash] :headers ({}) Additional HTTP headers.
34049
34550
  #
@@ -34199,7 +34700,7 @@ module OvirtSDK4
34199
34700
  # This operation updates the disk with the appropriate parameters.
34200
34701
  # The only field that can be updated is `qcow_version`.
34201
34702
  #
34202
- # For example, update disk can be facilitated using the following request:
34703
+ # For example, disk update can be done using the following request:
34203
34704
  #
34204
34705
  # [source]
34205
34706
  # ----
@@ -34215,7 +34716,7 @@ module OvirtSDK4
34215
34716
  # </disk>
34216
34717
  # ----
34217
34718
  #
34218
- # Since the backend operation is asynchronous the disk element which will be returned
34719
+ # Since the backend operation is asynchronous, the disk element that is returned
34219
34720
  # to the user might not be synced with the changed properties.
34220
34721
  #
34221
34722
  # @param disk [Disk] The update to apply to the disk.
@@ -35375,6 +35876,7 @@ module OvirtSDK4
35375
35876
  end
35376
35877
 
35377
35878
  APPROVE = [
35879
+ [:activate, TrueClass].freeze,
35378
35880
  [:async, TrueClass].freeze,
35379
35881
  [:cluster, Cluster].freeze,
35380
35882
  [:host, Host].freeze,
@@ -35389,6 +35891,10 @@ module OvirtSDK4
35389
35891
  #
35390
35892
  # @param opts [Hash] Additional options.
35391
35893
  #
35894
+ # @option opts [Boolean] :activate When set to 'true', this host will be activated after its approval completes. When set to 'false'
35895
+ # the host will remain in 'maintenance' status after its approval. Absence of this parameter will be
35896
+ # interpreted as 'true', since the desired default behavior is activating the host after approval.
35897
+ #
35392
35898
  # @option opts [Boolean] :async Indicates if the approval should be performed asynchronously.
35393
35899
  #
35394
35900
  # @option opts [Cluster] :cluster The cluster where the host will be added after it is approved.
@@ -35438,6 +35944,12 @@ module OvirtSDK4
35438
35944
  # <action/>
35439
35945
  # ----
35440
35946
  #
35947
+ # IMPORTANT: Since {engine-name} 4.3, it is possible to also specify `commit_on_success` in
35948
+ # the <<services/host/methods/setup_networks, setupnetworks>> request, in which case the new
35949
+ # configuration is automatically saved in the {hypervisor-name} upon completing the setup and
35950
+ # re-establishing connectivity between the {hypervisor-name} and {engine-name}, and without
35951
+ # waiting for a separate <<services/host/methods/commit_net_config, commitnetconfig>> request.
35952
+ #
35441
35953
  # @param opts [Hash] Additional options.
35442
35954
  #
35443
35955
  # @option opts [Boolean] :async Indicates if the action should be performed asynchronously.
@@ -35665,6 +36177,7 @@ module OvirtSDK4
35665
36177
  end
35666
36178
 
35667
36179
  INSTALL = [
36180
+ [:activate, TrueClass].freeze,
35668
36181
  [:async, TrueClass].freeze,
35669
36182
  [:deploy_hosted_engine, TrueClass].freeze,
35670
36183
  [:host, Host].freeze,
@@ -35730,6 +36243,10 @@ module OvirtSDK4
35730
36243
  #
35731
36244
  # @param opts [Hash] Additional options.
35732
36245
  #
36246
+ # @option opts [Boolean] :activate When set to 'true', this host will be activated after its installation completes. When set to 'false'
36247
+ # the host will remain in 'maintenance' status after its installation. Absence of this parameter will be
36248
+ # interpreted as 'true', since the desired default behavior is activating the host after install.
36249
+ #
35733
36250
  # @option opts [Boolean] :async Indicates if the installation should be performed asynchronously.
35734
36251
  #
35735
36252
  # @option opts [Boolean] :deploy_hosted_engine When set to `true` it means this host should also deploy the self-hosted engine components. A missing value
@@ -35931,6 +36448,7 @@ module OvirtSDK4
35931
36448
  SETUP_NETWORKS = [
35932
36449
  [:async, TrueClass].freeze,
35933
36450
  [:check_connectivity, TrueClass].freeze,
36451
+ [:commit_on_success, TrueClass].freeze,
35934
36452
  [:connectivity_timeout, Integer].freeze,
35935
36453
  [:modified_bonds, List].freeze,
35936
36454
  [:modified_labels, List].freeze,
@@ -36109,12 +36627,25 @@ module OvirtSDK4
36109
36627
  # IMPORTANT: To make sure that the network configuration has been saved in the host, and that it will be applied
36110
36628
  # when the host is rebooted, remember to call <<services/host/methods/commit_net_config, commitnetconfig>>.
36111
36629
  #
36630
+ # IMPORTANT: Since {engine-name} 4.3, it is possible to also specify `commit_on_success` in
36631
+ # the <<services/host/methods/setup_networks, setupnetworks>> request, in which case the new
36632
+ # configuration is automatically saved in the {hypervisor-name} upon completing the setup and
36633
+ # re-establishing connectivity between the {hypervisor-name} and {engine-name}, and without
36634
+ # waiting for a separate <<services/host/methods/commit_net_config, commitnetconfig>> request.
36635
+ #
36112
36636
  # @param opts [Hash] Additional options.
36113
36637
  #
36114
36638
  # @option opts [Boolean] :async Indicates if the action should be performed asynchronously.
36115
36639
  #
36116
36640
  # @option opts [Boolean] :check_connectivity
36117
36641
  #
36642
+ # @option opts [Boolean] :commit_on_success Specifies whether to automatically save the configuration in the {hypervisor-name} upon completing
36643
+ # the setup and re-establishing connectivity between the {hypervisor-name} and {engine-name},
36644
+ # and without waiting for a separate <<services/host/methods/commit_net_config, commitnetconfig>>
36645
+ # request.
36646
+ # The default value is `false`, which means that the configuration will not be
36647
+ # saved automatically.
36648
+ #
36118
36649
  # @option opts [Integer] :connectivity_timeout
36119
36650
  #
36120
36651
  # @option opts [Array<HostNic>] :modified_bonds
@@ -36324,6 +36855,7 @@ module OvirtSDK4
36324
36855
  end
36325
36856
 
36326
36857
  APPROVE_USING_ROOT_PASSWORD = [
36858
+ [:activate, TrueClass].freeze,
36327
36859
  [:async, TrueClass].freeze,
36328
36860
  [:cluster, Cluster].freeze,
36329
36861
  [:host, Host].freeze,
@@ -36332,11 +36864,14 @@ module OvirtSDK4
36332
36864
  private_constant :APPROVE_USING_ROOT_PASSWORD
36333
36865
 
36334
36866
  #
36335
- # Approve the specified host to be added to the engine by using the root password (deprecated verb). This
36336
- # occurs when the host registers itself with the engine.
36867
+ # Executes the `approve_using_root_password` method.
36337
36868
  #
36338
36869
  # @param opts [Hash] Additional options.
36339
36870
  #
36871
+ # @option opts [Boolean] :activate When set to 'true', this host will be activated after its approval completes. When set to 'false'
36872
+ # the host will remain in 'maintenance' status after its approval. Absence of this parameter will be
36873
+ # interpreted as 'true', since the desired default behavior is activating the host after approval.
36874
+ #
36340
36875
  # @option opts [Boolean] :async Indicates if the approval should be performed asynchronously.
36341
36876
  #
36342
36877
  # @option opts [Cluster] :cluster The cluster where the host will be added after it is approved.
@@ -36357,6 +36892,7 @@ module OvirtSDK4
36357
36892
  end
36358
36893
 
36359
36894
  INSTALL_USING_ROOT_PASSWORD = [
36895
+ [:activate, TrueClass].freeze,
36360
36896
  [:async, TrueClass].freeze,
36361
36897
  [:deploy_hosted_engine, TrueClass].freeze,
36362
36898
  [:host, Host].freeze,
@@ -36374,6 +36910,10 @@ module OvirtSDK4
36374
36910
  #
36375
36911
  # @param opts [Hash] Additional options.
36376
36912
  #
36913
+ # @option opts [Boolean] :activate When set to 'true', this host will be activated after its installation completes. When set to 'false'
36914
+ # the host will remain in 'maintenance' status after its installation. Absence of this parameter will be
36915
+ # interpreted as 'true', since the desired default behavior is activating the host after install.
36916
+ #
36377
36917
  # @option opts [Boolean] :async Indicates if the installation should be performed asynchronously.
36378
36918
  #
36379
36919
  # @option opts [Boolean] :deploy_hosted_engine When set to `true` it means this host should also deploy the self-hosted engine components. A missing value
@@ -36436,6 +36976,7 @@ module OvirtSDK4
36436
36976
  end
36437
36977
 
36438
36978
  APPROVE_USING_SSH = [
36979
+ [:activate, TrueClass].freeze,
36439
36980
  [:async, TrueClass].freeze,
36440
36981
  [:cluster, Cluster].freeze,
36441
36982
  [:host, Host].freeze,
@@ -36449,6 +36990,10 @@ module OvirtSDK4
36449
36990
  #
36450
36991
  # @param opts [Hash] Additional options.
36451
36992
  #
36993
+ # @option opts [Boolean] :activate When set to 'true', this host will be activated after its approval completes. When set to 'false'
36994
+ # the host will remain in 'maintenance' status after its approval. Absence of this parameter will be
36995
+ # interpreted as 'true', since the desired default behavior is activating the host after approval.
36996
+ #
36452
36997
  # @option opts [Boolean] :async Indicates if the approval should be performed asynchronously.
36453
36998
  #
36454
36999
  # @option opts [Cluster] :cluster The cluster where the host will be added after it is approved.
@@ -36469,6 +37014,7 @@ module OvirtSDK4
36469
37014
  end
36470
37015
 
36471
37016
  INSTALL_USING_SSH = [
37017
+ [:activate, TrueClass].freeze,
36472
37018
  [:async, TrueClass].freeze,
36473
37019
  [:deploy_hosted_engine, TrueClass].freeze,
36474
37020
  [:host, Host].freeze,
@@ -36486,6 +37032,10 @@ module OvirtSDK4
36486
37032
  #
36487
37033
  # @param opts [Hash] Additional options.
36488
37034
  #
37035
+ # @option opts [Boolean] :activate When set to 'true', this host will be activated after its installation completes. When set to 'false'
37036
+ # the host will remain in 'maintenance' status after its installation. Absence of this parameter will be
37037
+ # interpreted as 'true', since the desired default behavior is activating the host after install.
37038
+ #
36489
37039
  # @option opts [Boolean] :async Indicates if the installation should be performed asynchronously.
36490
37040
  #
36491
37041
  # @option opts [Boolean] :deploy_hosted_engine When set to `true` it means this host should also deploy the self-hosted engine components. A missing value