class OvirtSDK4::VmService

Constants

AUTO_PIN_CPU_AND_NUMA_NODES
CANCEL_MIGRATION
CLONE
COMMIT_SNAPSHOT
DETACH
EXPORT
EXPORT_TO_EXPORT_DOMAIN
EXPORT_TO_PATH_ON_HOST
FREEZE_FILESYSTEMS
GET
LOGON
MAINTENANCE
MIGRATE
PREVIEW_SNAPSHOT
REBOOT
REMOVE
REORDER_MAC_ADDRESSES
RESET
SCREENSHOT
SHUTDOWN
START
STOP
SUSPEND
THAW_FILESYSTEMS
TICKET
UNDO_SNAPSHOT
UPDATE

Public Instance Methods

affinity_labels_service() click to toggle source

List of scheduling labels assigned to this virtual machine.

@return [AssignedAffinityLabelsService] A reference to `affinity_labels` service.

# File lib/ovirtsdk4/services.rb, line 31521
def affinity_labels_service
  @affinity_labels_service ||= AssignedAffinityLabelsService.new(self, 'affinitylabels')
end
applications_service() click to toggle source

Locates the `applications` service.

@return [VmApplicationsService] A reference to `applications` service.

# File lib/ovirtsdk4/services.rb, line 31530
def applications_service
  @applications_service ||= VmApplicationsService.new(self, 'applications')
end
auto_pin_cpu_and_numa_nodes(opts = {}) click to toggle source

Apply an automatic CPU and NUMA configuration on the VM.

IMPORTANT: Since version 4.5 of the engine this operation is deprecated, and preserved only for backwards compatibility. It will be removed in the future. Instead please use PUT followed by xref:services-vm-methods-update[update operation].

An example for a request:

source

POST /ovirt-engine/api/vms/123/autopincpuandnumanodes


With a request body like this:

source,xml

<action>

<optimize_cpu_settings>true</optimize_cpu_settings>

</action>


@param opts [Hash] Additional options.

@option opts [Boolean] :async Indicates if the detach action should be performed asynchronously.

@option opts [Boolean] :optimize_cpu_settings Specifies how the auto CPU and NUMA configuration is applied.

If set to true, will adjust the CPU topology to fit the VM pinned host hardware.
Otherwise, it will use the VM CPU topology.

@option opts [Hash] :headers ({}) Additional HTTP headers.

@option opts [Hash] :query ({}) Additional URL query parameters.

@option opts [Integer] :timeout (nil) The timeout for this request, in seconds. If no value is explicitly

given then the timeout set globally for the connection will be used.

@option opts [Boolean] :wait (true) If `true` wait for the response.

# File lib/ovirtsdk4/services.rb, line 30197
def auto_pin_cpu_and_numa_nodes(opts = {})
  internal_action(:autopincpuandnumanodes, nil, AUTO_PIN_CPU_AND_NUMA_NODES, opts)
end
backups_service() click to toggle source

List of backups of this virtual machine.

@return [VmBackupsService] A reference to `backups` service.

# File lib/ovirtsdk4/services.rb, line 31539
def backups_service
  @backups_service ||= VmBackupsService.new(self, 'backups')
end
cancel_migration(opts = {}) click to toggle source

This operation stops any migration of a virtual machine to another physical host.

source

POST /ovirt-engine/api/vms/123/cancelmigration


The cancel migration action does not take any action specific parameters; therefore, the request body should contain an empty `action`:

source,xml

<action/>


@param opts [Hash] Additional options.

@option opts [Boolean] :async Indicates if the migration should cancelled asynchronously.

@option opts [Hash] :headers ({}) Additional HTTP headers.

@option opts [Hash] :query ({}) Additional URL query parameters.

@option opts [Integer] :timeout (nil) The timeout for this request, in seconds. If no value is explicitly

given then the timeout set globally for the connection will be used.

@option opts [Boolean] :wait (true) If `true` wait for the response.

# File lib/ovirtsdk4/services.rb, line 30236
def cancel_migration(opts = {})
  internal_action(:cancelmigration, nil, CANCEL_MIGRATION, opts)
end
cdroms_service() click to toggle source

Locates the `cdroms` service.

@return [VmCdromsService] A reference to `cdroms` service.

# File lib/ovirtsdk4/services.rb, line 31548
def cdroms_service
  @cdroms_service ||= VmCdromsService.new(self, 'cdroms')
end
checkpoints_service() click to toggle source

List of checkpoints of this virtual machine.

@return [VmCheckpointsService] A reference to `checkpoints` service.

# File lib/ovirtsdk4/services.rb, line 31557
def checkpoints_service
  @checkpoints_service ||= VmCheckpointsService.new(self, 'checkpoints')
end
clone(opts = {}) click to toggle source

Executes the `clone` method.

@param opts [Hash] Additional options.

@option opts [Boolean] :async Indicates if the clone should be performed asynchronously.

@option opts [Boolean] :discard_snapshots Use the `discard_snapshots` parameter when the virtual machine should be clone with its

snapshots collapsed. Default is true.

@option opts [StorageDomain] :storage_domain The storage domain on which the virtual machines disks will be copied to.

@option opts [Vm] :vm

@option opts [Hash] :headers ({}) Additional HTTP headers.

@option opts [Hash] :query ({}) Additional URL query parameters.

@option opts [Integer] :timeout (nil) The timeout for this request, in seconds. If no value is explicitly

given then the timeout set globally for the connection will be used.

@option opts [Boolean] :wait (true) If `true` wait for the response.

# File lib/ovirtsdk4/services.rb, line 30272
def clone(opts = {})
  internal_action(:clone, nil, CLONE, opts)
end
commit_snapshot(opts = {}) click to toggle source

Permanently restores the virtual machine to the state of the previewed snapshot.

See the xref:services-vm-methods-preview_snapshot operation for details.

@param opts [Hash] Additional options.

@option opts [Boolean] :async Indicates if the snapshots should be committed asynchronously.

@option opts [Hash] :headers ({}) Additional HTTP headers.

@option opts [Hash] :query ({}) Additional URL query parameters.

@option opts [Integer] :timeout (nil) The timeout for this request, in seconds. If no value is explicitly

given then the timeout set globally for the connection will be used.

@option opts [Boolean] :wait (true) If `true` wait for the response.

# File lib/ovirtsdk4/services.rb, line 30300
def commit_snapshot(opts = {})
  internal_action(:commitsnapshot, nil, COMMIT_SNAPSHOT, opts)
end
detach(opts = {}) click to toggle source

Detaches a virtual machine from a pool.

source

POST /ovirt-engine/api/vms/123/detach


The detach action does not take any action specific parameters; therefore, the request body should contain an empty `action`:

source,xml

<action/>


@param opts [Hash] Additional options.

@option opts [Boolean] :async Indicates if the detach action should be performed asynchronously.

@option opts [Hash] :headers ({}) Additional HTTP headers.

@option opts [Hash] :query ({}) Additional URL query parameters.

@option opts [Integer] :timeout (nil) The timeout for this request, in seconds. If no value is explicitly

given then the timeout set globally for the connection will be used.

@option opts [Boolean] :wait (true) If `true` wait for the response.

# File lib/ovirtsdk4/services.rb, line 30339
def detach(opts = {})
  internal_action(:detach, nil, DETACH, opts)
end
disk_attachments_service() click to toggle source

List of disks attached to this virtual machine.

@return [DiskAttachmentsService] A reference to `disk_attachments` service.

# File lib/ovirtsdk4/services.rb, line 31566
def disk_attachments_service
  @disk_attachments_service ||= DiskAttachmentsService.new(self, 'diskattachments')
end
export(opts = {}) click to toggle source

Exports the virtual machine.

A virtual machine can be exported to an export domain. For example, to export virtual machine `123` to the export domain `myexport`:

source

POST /ovirt-engine/api/vms/123/export


With a request body like this:

source,xml

<action>

<storage_domain>
  <name>myexport</name>
</storage_domain>
<exclusive>true</exclusive>
<discard_snapshots>true</discard_snapshots>

</action>


Since version 4.2 of the engine it is also possible to export a virtual machine as a virtual appliance (OVA). For example, to export virtual machine `123` as an OVA file named `myvm.ova` that is placed in the directory `/home/ovirt/` on host `myhost`:

source

POST /ovirt-engine/api/vms/123/export


With a request body like this:

source,xml

<action>

<host>
  <name>myhost</name>
</host>
<directory>/home/ovirt</directory>
<filename>myvm.ova</filename>

</action>


NOTE: Confirm that the export operation has completed before attempting any actions on the export domain.

@param opts [Hash] Additional options.

@option opts [Boolean] :async Indicates if the export should be performed asynchronously.

@option opts [Boolean] :discard_snapshots Use the `discard_snapshots` parameter when the virtual machine should be exported with all of its

snapshots collapsed.

@option opts [Boolean] :exclusive Use the `exclusive` parameter when the virtual machine should be exported even if another copy of

it already exists in the export domain (override).

@option opts [StorageDomain] :storage_domain The (export) storage domain to export the virtual machine to.

@option opts [Hash] :headers ({}) Additional HTTP headers.

@option opts [Hash] :query ({}) Additional URL query parameters.

@option opts [Integer] :timeout (nil) The timeout for this request, in seconds. If no value is explicitly

given then the timeout set globally for the connection will be used.

@option opts [Boolean] :wait (true) If `true` wait for the response.

# File lib/ovirtsdk4/services.rb, line 30420
def export(opts = {})
  internal_action(:export, nil, EXPORT, opts)
end
export_to_export_domain(opts = {}) click to toggle source

Exports a virtual machine to an export domain.

@param opts [Hash] Additional options.

@option opts [Boolean] :async Indicates if the export should be performed asynchronously.

@option opts [Boolean] :discard_snapshots Use the `discard_snapshots` parameter when the virtual machine should be exported with all of its

snapshots collapsed.

@option opts [Boolean] :exclusive Use the `exclusive` parameter when the virtual machine should be exported even if another copy of

it already exists in the export domain (override).

@option opts [StorageDomain] :storage_domain The (export) storage domain to export the virtual machine to.

@option opts [Hash] :headers ({}) Additional HTTP headers.

@option opts [Hash] :query ({}) Additional URL query parameters.

@option opts [Integer] :timeout (nil) The timeout for this request, in seconds. If no value is explicitly

given then the timeout set globally for the connection will be used.

@option opts [Boolean] :wait (true) If `true` wait for the response.

# File lib/ovirtsdk4/services.rb, line 31401
def export_to_export_domain(opts = {})
  internal_action(:export, nil, EXPORT_TO_EXPORT_DOMAIN, opts)
end
export_to_path_on_host(opts = {}) click to toggle source

Exports a virtual machine as an OVA file to a given path on a specified host.

@param opts [Hash] Additional options.

@option opts [Boolean] :async Indicates if the export should be performed asynchronously.

@option opts [String] :directory An absolute path of a directory on the host to generate the OVA file in.

@option opts [Boolean] :discard_snapshots Use the `discard_snapshots` parameter when the virtual machine should be exported with all of its

snapshots collapsed.

@option opts [Boolean] :exclusive Use the `exclusive` parameter when the virtual machine should be exported even if another copy of

it already exists in the export domain (override).

@option opts [String] :filename The name of the OVA file.

This is an optional parameter, if it is not specified then the name of OVA file is determined according
to the name of the virtual machine. It will conform the following pattern: "<virtual machine name>.ova".

@option opts [Host] :host The host to generate the OVA file on.

@option opts [StorageDomain] :storage_domain The (export) storage domain to export the virtual machine to.

@option opts [Hash] :headers ({}) Additional HTTP headers.

@option opts [Hash] :query ({}) Additional URL query parameters.

@option opts [Integer] :timeout (nil) The timeout for this request, in seconds. If no value is explicitly

given then the timeout set globally for the connection will be used.

@option opts [Boolean] :wait (true) If `true` wait for the response.

# File lib/ovirtsdk4/services.rb, line 31450
def export_to_path_on_host(opts = {})
  internal_action(:export, nil, EXPORT_TO_PATH_ON_HOST, opts)
end
freeze_filesystems(opts = {}) click to toggle source

Freezes virtual machine file systems.

This operation freezes a virtual machine's file systems using the QEMU guest agent when taking a live snapshot of a running virtual machine. Normally, this is done automatically by the manager, but this must be executed manually with the API for virtual machines using OpenStack Volume (Cinder) disks.

Example:

source

POST /ovirt-engine/api/vms/123/freezefilesystems


source,xml

<action/>


@param opts [Hash] Additional options.

@option opts [Boolean] :async Indicates if the freeze should be performed asynchronously.

@option opts [Hash] :headers ({}) Additional HTTP headers.

@option opts [Hash] :query ({}) Additional URL query parameters.

@option opts [Integer] :timeout (nil) The timeout for this request, in seconds. If no value is explicitly

given then the timeout set globally for the connection will be used.

@option opts [Boolean] :wait (true) If `true` wait for the response.

# File lib/ovirtsdk4/services.rb, line 30462
def freeze_filesystems(opts = {})
  internal_action(:freezefilesystems, nil, FREEZE_FILESYSTEMS, opts)
end
get(opts = {}) click to toggle source

Retrieves the description of the virtual machine.

@param opts [Hash] Additional options.

@option opts [Boolean] :all_content Indicates if all of the attributes of the virtual machine should be included in the response.

By default the following attributes are excluded:

- `console`
- `initialization.configuration.data` - The OVF document describing the virtual machine.
- `rng_source`
- `soundcard`
- `virtio_scsi`

For example, to retrieve the complete representation of the virtual machine '123':

....
GET /ovirt-engine/api/vms/123?all_content=true
....

NOTE: These attributes are not included by default as they reduce performance. These attributes are seldom used
and require additional queries to the database. Only use this parameter when required as it will reduce performance.

@option opts [Boolean] :filter Indicates if the results should be filtered according to the permissions of the user.

@option opts [String] :follow Indicates which inner links should be followed. The objects referenced by these links will be fetched as part

of the current request. See <<documents/003_common_concepts/follow, here>> for details.

@option opts [Boolean] :next_run Indicates if the returned result describes the virtual machine as it is currently running or if describes

the virtual machine with the modifications that have already been performed but that will only come into
effect when the virtual machine is restarted. By default the value is `false`.

If the parameter is included in the request, but without a value, it is assumed that the value is `true`. The
the following request:

[source]
----
GET /vms/{vm:id};next_run
----

Is equivalent to using the value `true`:

[source]
----
GET /vms/{vm:id};next_run=true
----

@option opts [Boolean] :ovf_as_ova Indicates if the results should expose the OVF as it appears in OVA files of that VM. The OVF document

describing the virtual machine. This parameter will work only when all_content=True is set.
The OVF will be presented in `initialization.configuration.data`.

For example:
[source]
----
GET /vms/{vm:id}?all_content=true&ovf_as_ova=true
----

@option opts [Hash] :headers ({}) Additional HTTP headers.

@option opts [Hash] :query ({}) Additional URL query parameters.

@option opts [Integer] :timeout (nil) The timeout for this request, in seconds. If no value is explicitly

given then the timeout set globally for the connection will be used.

@option opts [Boolean] :wait (true) If `true` wait for the response.

@return [Vm]

# File lib/ovirtsdk4/services.rb, line 30545
def get(opts = {})
  internal_get(GET, opts)
end
graphics_consoles_service() click to toggle source

Locates the `graphics_consoles` service.

@return [VmGraphicsConsolesService] A reference to `graphics_consoles` service.

# File lib/ovirtsdk4/services.rb, line 31575
def graphics_consoles_service
  @graphics_consoles_service ||= VmGraphicsConsolesService.new(self, 'graphicsconsoles')
end
host_devices_service() click to toggle source

Locates the `host_devices` service.

@return [VmHostDevicesService] A reference to `host_devices` service.

# File lib/ovirtsdk4/services.rb, line 31584
def host_devices_service
  @host_devices_service ||= VmHostDevicesService.new(self, 'hostdevices')
end
katello_errata_service() click to toggle source

Reference to the service that can show the applicable errata available on the virtual machine. This information is taken from Katello.

@return [KatelloErrataService] A reference to `katello_errata` service.

# File lib/ovirtsdk4/services.rb, line 31594
def katello_errata_service
  @katello_errata_service ||= KatelloErrataService.new(self, 'katelloerrata')
end
logon(opts = {}) click to toggle source

Initiates the automatic user logon to access a virtual machine from an external console.

This action requires the `ovirt-guest-agent-gdm-plugin` and the `ovirt-guest-agent-pam-module` packages to be installed and the `ovirt-guest-agent` service to be running on the virtual machine.

Users require the appropriate user permissions for the virtual machine in order to access the virtual machine from an external console.

For example:

source

POST /ovirt-engine/api/vms/123/logon


Request body:

source,xml

<action/>


@param opts [Hash] Additional options.

@option opts [Boolean] :async Indicates if the logon should be performed asynchronously.

@option opts [Hash] :headers ({}) Additional HTTP headers.

@option opts [Hash] :query ({}) Additional URL query parameters.

@option opts [Integer] :timeout (nil) The timeout for this request, in seconds. If no value is explicitly

given then the timeout set globally for the connection will be used.

@option opts [Boolean] :wait (true) If `true` wait for the response.

# File lib/ovirtsdk4/services.rb, line 30591
def logon(opts = {})
  internal_action(:logon, nil, LOGON, opts)
end
maintenance(opts = {}) click to toggle source

Sets the global maintenance mode on the hosted engine virtual machine.

This action has no effect on other virtual machines.

Example:

source

POST /ovirt-engine/api/vms/123/maintenance


source,xml

<action>

<maintenance_enabled>true<maintenance_enabled/>

</action>


@param opts [Hash] Additional options.

@option opts [Boolean] :async Indicates if the global maintenance action should be performed asynchronously.

@option opts [Boolean] :maintenance_enabled Indicates if global maintenance should be enabled or disabled.

@option opts [Hash] :headers ({}) Additional HTTP headers.

@option opts [Hash] :query ({}) Additional URL query parameters.

@option opts [Integer] :timeout (nil) The timeout for this request, in seconds. If no value is explicitly

given then the timeout set globally for the connection will be used.

@option opts [Boolean] :wait (true) If `true` wait for the response.

# File lib/ovirtsdk4/services.rb, line 30636
def maintenance(opts = {})
  internal_action(:maintenance, nil, MAINTENANCE, opts)
end
mediated_devices_service() click to toggle source

Reference to the service that manages mediated devices associated with the VM.

@return [VmMediatedDevicesService] A reference to `mediated_devices` service.

# File lib/ovirtsdk4/services.rb, line 31603
def mediated_devices_service
  @mediated_devices_service ||= VmMediatedDevicesService.new(self, 'mediateddevices')
end
migrate(opts = {}) click to toggle source

Migrates a virtual machine to another physical host.

Example:

source

POST /ovirt-engine/api/vms/123/migrate


To specify a specific host to migrate the virtual machine to:

source,xml

<action>

<host id="2ab5e1da-b726-4274-bbf7-0a42b16a0fc3"/>

</action>


@param opts [Hash] Additional options.

@option opts [Boolean] :async Indicates if the migration should be performed asynchronously.

@option opts [Cluster] :cluster Specifies the cluster the virtual machine should migrate to. This is an optional parameter. By default, the

virtual machine is migrated to another host within the same cluster.

WARNING: Live migration to another cluster is not supported. Strongly consider the target cluster's hardware
architecture and network architecture before attempting a migration.

@option opts [Boolean] :force Specifies that the virtual machine should migrate even if the virtual machine is defined as non-migratable.

This is an optional parameter. By default, it is set to `false`.

@option opts [Host] :host Specifies a specific host that the virtual machine should migrate to. This is an optional parameter. By default,

the {engine-name} automatically selects a default host for migration within the same cluster. If an API user
requires a specific host, the user can specify the host with either an `id` or `name` parameter.

@option opts [Boolean] :migrate_vms_in_affinity_closure Migrate also all other virtual machines in positive enforcing affinity groups with this virtual machine,

that are running on the same host.

The default value is `false`.

@option opts [Hash] :headers ({}) Additional HTTP headers.

@option opts [Hash] :query ({}) Additional URL query parameters.

@option opts [Integer] :timeout (nil) The timeout for this request, in seconds. If no value is explicitly

given then the timeout set globally for the connection will be used.

@option opts [Boolean] :wait (true) If `true` wait for the response.

# File lib/ovirtsdk4/services.rb, line 30700
def migrate(opts = {})
  internal_action(:migrate, nil, MIGRATE, opts)
end
nics_service() click to toggle source

Locates the `nics` service.

@return [VmNicsService] A reference to `nics` service.

# File lib/ovirtsdk4/services.rb, line 31612
def nics_service
  @nics_service ||= VmNicsService.new(self, 'nics')
end
numa_nodes_service() click to toggle source

Locates the `numa_nodes` service.

@return [VmNumaNodesService] A reference to `numa_nodes` service.

# File lib/ovirtsdk4/services.rb, line 31621
def numa_nodes_service
  @numa_nodes_service ||= VmNumaNodesService.new(self, 'numanodes')
end
permissions_service() click to toggle source

Locates the `permissions` service.

@return [AssignedPermissionsService] A reference to `permissions` service.

# File lib/ovirtsdk4/services.rb, line 31630
def permissions_service
  @permissions_service ||= AssignedPermissionsService.new(self, 'permissions')
end
preview_snapshot(opts = {}) click to toggle source

Temporarily restores the virtual machine to the state of a snapshot.

The snapshot is indicated with the `snapshot.id` parameter. It is restored temporarily, so that the content can be inspected. Once that inspection is finished, the state of the virtual machine can be made permanent, using the xref:services-vm-methods-commit_snapshot method, or discarded using the xref:services-vm-methods-undo_snapshot method.

@param opts [Hash] Additional options.

@option opts [Boolean] :async Indicates if the preview should be performed asynchronously.

@option opts [Array<Disk>] :disks Specify the disks included in the snapshot's preview.

For each disk parameter, it is also required to specify its `image_id`.

For example, to preview a snapshot with identifier `456` which includes a disk with identifier `111` and its
`image_id` as `222`, send a request like this:

[source]
----
POST /ovirt-engine/api/vms/123/previewsnapshot
----

Request body:

[source,xml]
----
<action>
  <disks>
    <disk id="111">
      <image_id>222</image_id>
    </disk>
  </disks>
  <snapshot id="456"/>
</action>
----

@option opts [StorageDomainLease] :lease Specify the lease storage domain ID to use in the preview of the snapshot.

If lease parameter is not passed, then the previewed snapshot lease storage domain will be used.
If lease parameter is passed with empty storage domain parameter, then no lease will be used
for the snapshot preview.
If lease parameter is passed with storage domain parameter then the storage domain ID can be
only one of the leases domain IDs that belongs to one of the virtual machine snapshots.
This is an optional parameter, set by default to `null`

@option opts [Boolean] :restore_memory

@option opts [Snapshot] :snapshot

@option opts [Vm] :vm

@option opts [Hash] :headers ({}) Additional HTTP headers.

@option opts [Hash] :query ({}) Additional URL query parameters.

@option opts [Integer] :timeout (nil) The timeout for this request, in seconds. If no value is explicitly

given then the timeout set globally for the connection will be used.

@option opts [Boolean] :wait (true) If `true` wait for the response.

# File lib/ovirtsdk4/services.rb, line 30776
def preview_snapshot(opts = {})
  internal_action(:previewsnapshot, nil, PREVIEW_SNAPSHOT, opts)
end
reboot(opts = {}) click to toggle source

Sends a reboot request to a virtual machine.

For example:

source

POST /ovirt-engine/api/vms/123/reboot


The reboot action does not take any action specific parameters; therefore, the request body should contain an empty `action`:

source,xml

<action/>


To reboot the VM even if a backup is running for it, the action should include the 'force' element.

For example, to force reboot virtual machine `123`:


POST /ovirt-engine/api/vms/123/reboot


source,xml

<action>

<force>true</force>

</action>


@param opts [Hash] Additional options.

@option opts [Boolean] :async Indicates if the reboot should be performed asynchronously.

@option opts [Boolean] :force Indicates if the VM should be forcibly rebooted even

if a backup is running for it.

@option opts [Hash] :headers ({}) Additional HTTP headers.

@option opts [Hash] :query ({}) Additional URL query parameters.

@option opts [Integer] :timeout (nil) The timeout for this request, in seconds. If no value is explicitly

given then the timeout set globally for the connection will be used.

@option opts [Boolean] :wait (true) If `true` wait for the response.

# File lib/ovirtsdk4/services.rb, line 30837
def reboot(opts = {})
  internal_action(:reboot, nil, REBOOT, opts)
end
remove(opts = {}) click to toggle source

Removes the virtual machine, including the virtual disks attached to it.

For example, to remove the virtual machine with identifier `123`:

source

DELETE /ovirt-engine/api/vms/123


@param opts [Hash] Additional options.

@option opts [Boolean] :async Indicates if the remove should be performed asynchronously. @option opts [Boolean] :detach_only Indicates if the attached virtual disks should be detached first and preserved instead of being removed. @option opts [Boolean] :force Indicates if the virtual machine should be forcibly removed.

Locked virtual machines and virtual machines with locked disk images
cannot be removed without this flag set to true.

@option opts [Hash] :headers ({}) Additional HTTP headers.

@option opts [Hash] :query ({}) Additional URL query parameters.

@option opts [Integer] :timeout (nil) The timeout for this request, in seconds. If no value is explicitly

given then the timeout set globally for the connection will be used.

@option opts [Boolean] :wait (true) If `true` wait for the response.

# File lib/ovirtsdk4/services.rb, line 30876
def remove(opts = {})
  internal_remove(REMOVE, opts)
end
reorder_mac_addresses(opts = {}) click to toggle source

Executes the `reorder_mac_addresses` method.

@param opts [Hash] Additional options.

@option opts [Boolean] :async Indicates if the action should be performed asynchronously.

@option opts [Hash] :headers ({}) Additional HTTP headers.

@option opts [Hash] :query ({}) Additional URL query parameters.

@option opts [Integer] :timeout (nil) The timeout for this request, in seconds. If no value is explicitly

given then the timeout set globally for the connection will be used.

@option opts [Boolean] :wait (true) If `true` wait for the response.

# File lib/ovirtsdk4/services.rb, line 30902
def reorder_mac_addresses(opts = {})
  internal_action(:reordermacaddresses, nil, REORDER_MAC_ADDRESSES, opts)
end
reported_devices_service() click to toggle source

Locates the `reported_devices` service.

@return [VmReportedDevicesService] A reference to `reported_devices` service.

# File lib/ovirtsdk4/services.rb, line 31639
def reported_devices_service
  @reported_devices_service ||= VmReportedDevicesService.new(self, 'reporteddevices')
end
reset(opts = {}) click to toggle source

Sends a reset request to a virtual machine.

For example:

source

POST /ovirt-engine/api/vms/123/reset


The reset action does not take any action specific parameters; therefore, the request body should contain an empty `action`:

source,xml

<action/>


@param opts [Hash] Additional options.

@option opts [Boolean] :async Indicates if the reset should be performed asynchronously.

@option opts [Hash] :headers ({}) Additional HTTP headers.

@option opts [Hash] :query ({}) Additional URL query parameters.

@option opts [Integer] :timeout (nil) The timeout for this request, in seconds. If no value is explicitly

given then the timeout set globally for the connection will be used.

@option opts [Boolean] :wait (true) If `true` wait for the response.

# File lib/ovirtsdk4/services.rb, line 30943
def reset(opts = {})
  internal_action(:reset, nil, RESET, opts)
end
screenshot(opts = {}) click to toggle source

Captures screenshot of the current state of the VM.

For example:

source

POST /ovirt-engine/api/vms/123/screenshot


The screenshot action does not take any action specific parameters; therefore, the request body should contain an empty `action`:

source,xml

<action/>


@param opts [Hash] Additional options.

@option opts [Hash] :headers ({}) Additional HTTP headers.

@option opts [Hash] :query ({}) Additional URL query parameters.

@option opts [Integer] :timeout (nil) The timeout for this request, in seconds. If no value is explicitly

given then the timeout set globally for the connection will be used.

@option opts [Boolean] :wait (true) If `true` wait for the response.

# File lib/ovirtsdk4/services.rb, line 30983
def screenshot(opts = {})
  internal_action(:screenshot, nil, SCREENSHOT, opts)
end
service(path) click to toggle source

Locates the service corresponding to the given path.

@param path [String] The path of the service.

@return [Service] A reference to the service.

# File lib/ovirtsdk4/services.rb, line 31695
def service(path)
  if path.nil? || path == ''
    return self
  end
  if path == 'affinitylabels'
    return affinity_labels_service
  end
  if path.start_with?('affinitylabels/')
    return affinity_labels_service.service(path[15..-1])
  end
  if path == 'applications'
    return applications_service
  end
  if path.start_with?('applications/')
    return applications_service.service(path[13..-1])
  end
  if path == 'backups'
    return backups_service
  end
  if path.start_with?('backups/')
    return backups_service.service(path[8..-1])
  end
  if path == 'cdroms'
    return cdroms_service
  end
  if path.start_with?('cdroms/')
    return cdroms_service.service(path[7..-1])
  end
  if path == 'checkpoints'
    return checkpoints_service
  end
  if path.start_with?('checkpoints/')
    return checkpoints_service.service(path[12..-1])
  end
  if path == 'diskattachments'
    return disk_attachments_service
  end
  if path.start_with?('diskattachments/')
    return disk_attachments_service.service(path[16..-1])
  end
  if path == 'graphicsconsoles'
    return graphics_consoles_service
  end
  if path.start_with?('graphicsconsoles/')
    return graphics_consoles_service.service(path[17..-1])
  end
  if path == 'hostdevices'
    return host_devices_service
  end
  if path.start_with?('hostdevices/')
    return host_devices_service.service(path[12..-1])
  end
  if path == 'katelloerrata'
    return katello_errata_service
  end
  if path.start_with?('katelloerrata/')
    return katello_errata_service.service(path[14..-1])
  end
  if path == 'mediateddevices'
    return mediated_devices_service
  end
  if path.start_with?('mediateddevices/')
    return mediated_devices_service.service(path[16..-1])
  end
  if path == 'nics'
    return nics_service
  end
  if path.start_with?('nics/')
    return nics_service.service(path[5..-1])
  end
  if path == 'numanodes'
    return numa_nodes_service
  end
  if path.start_with?('numanodes/')
    return numa_nodes_service.service(path[10..-1])
  end
  if path == 'permissions'
    return permissions_service
  end
  if path.start_with?('permissions/')
    return permissions_service.service(path[12..-1])
  end
  if path == 'reporteddevices'
    return reported_devices_service
  end
  if path.start_with?('reporteddevices/')
    return reported_devices_service.service(path[16..-1])
  end
  if path == 'sessions'
    return sessions_service
  end
  if path.start_with?('sessions/')
    return sessions_service.service(path[9..-1])
  end
  if path == 'snapshots'
    return snapshots_service
  end
  if path.start_with?('snapshots/')
    return snapshots_service.service(path[10..-1])
  end
  if path == 'statistics'
    return statistics_service
  end
  if path.start_with?('statistics/')
    return statistics_service.service(path[11..-1])
  end
  if path == 'tags'
    return tags_service
  end
  if path.start_with?('tags/')
    return tags_service.service(path[5..-1])
  end
  if path == 'watchdogs'
    return watchdogs_service
  end
  if path.start_with?('watchdogs/')
    return watchdogs_service.service(path[10..-1])
  end
  raise Error.new("The path \"#{path}\" doesn't correspond to any service")
end
sessions_service() click to toggle source

Reference to the service that provides information about virtual machine user sessions.

@return [VmSessionsService] A reference to `sessions` service.

# File lib/ovirtsdk4/services.rb, line 31648
def sessions_service
  @sessions_service ||= VmSessionsService.new(self, 'sessions')
end
shutdown(opts = {}) click to toggle source

This operation sends a shutdown request to a virtual machine.

For example:

source

POST /ovirt-engine/api/vms/123/shutdown


The shutdown action does not take any action specific parameters; therefore, the request body should contain an empty `action`:

source,xml

<action/>


To shutdown the VM even if a backup is running for it, the action should include the 'force' element.

For example, to force shutdown virtual machine `123`:


POST /ovirt-engine/api/vms/123/shutdown


source,xml

<action>

<force>true</force>

</action>


@param opts [Hash] Additional options.

@option opts [Boolean] :async Indicates if the shutdown should be performed asynchronously.

@option opts [Boolean] :force Indicates if the VM should be forcibly shutdown even

if a backup is running for it.

@option opts [String] :reason The reason the virtual machine was stopped.

Optionally set by user when shutting down the virtual machine.

@option opts [Hash] :headers ({}) Additional HTTP headers.

@option opts [Hash] :query ({}) Additional URL query parameters.

@option opts [Integer] :timeout (nil) The timeout for this request, in seconds. If no value is explicitly

given then the timeout set globally for the connection will be used.

@option opts [Boolean] :wait (true) If `true` wait for the response.

# File lib/ovirtsdk4/services.rb, line 31048
def shutdown(opts = {})
  internal_action(:shutdown, nil, SHUTDOWN, opts)
end
snapshots_service() click to toggle source

Locates the `snapshots` service.

@return [SnapshotsService] A reference to `snapshots` service.

# File lib/ovirtsdk4/services.rb, line 31657
def snapshots_service
  @snapshots_service ||= SnapshotsService.new(self, 'snapshots')
end
start(opts = {}) click to toggle source

Starts the virtual machine.

If the virtual environment is complete and the virtual machine contains all necessary components to function, it can be started.

This example starts the virtual machine:

source

POST /ovirt-engine/api/vms/123/start


With a request body:

source,xml

<action/>


@param opts [Hash] Additional options.

@option opts [Boolean] :async Indicates if the start action should be performed asynchronously.

@option opts [AuthorizedKey] :authorized_key

@option opts [Boolean] :filter Indicates if the results should be filtered according to the permissions of the user.

@option opts [Boolean] :pause If set to `true`, start the virtual machine in paused mode. The default is `false`.

@option opts [Boolean] :use_cloud_init If set to `true`, the initialization type is set to cloud-init. The default value is `false`.

See link:https://cloudinit.readthedocs.io/en/latest[cloud-init documentation] for details.

@option opts [Boolean] :use_ignition If set to `true`, the initialization type is set to Ignition. The default value is `false`.

See link:https://coreos.com/ignition/docs/latest/[Ignition documentation] for details.

@option opts [Boolean] :use_initialization If set to `true`, the initialization type is set by the VM's OS.

Windows will set to _Sysprep_, Linux to _cloud-init_ and RedHat CoreOS to _Ignition_.
If any of the initialization-types are explicitly set (useCloudInit, useSysprep or useIgnition),
they will be prioritized and this flag will be ignored.
The default value is `false`.

@option opts [Boolean] :use_sysprep If set to `true`, the initialization type is set to Sysprep. The default value is `false`.

See link:https://en.wikipedia.org/wiki/Sysprep[Sysprep] for details.

@option opts [Vm] :vm The definition of the virtual machine for this specific run.

For example:

[source,xml]
----
<action>
  <vm>
    <os>
      <boot>
        <devices>
          <device>cdrom</device>
        </devices>
      </boot>
    </os>
  </vm>
</action>
----

This will set the boot device to the CDROM only for this specific start. After the virtual machine is
powered off, this definition will be reverted.

@option opts [Boolean] :volatile Indicates that this run configuration will be discarded even in the case of guest-initiated reboot.

The default value is `false`.

@option opts [Hash] :headers ({}) Additional HTTP headers.

@option opts [Hash] :query ({}) Additional URL query parameters.

@option opts [Integer] :timeout (nil) The timeout for this request, in seconds. If no value is explicitly

given then the timeout set globally for the connection will be used.

@option opts [Boolean] :wait (true) If `true` wait for the response.

# File lib/ovirtsdk4/services.rb, line 31146
def start(opts = {})
  internal_action(:start, nil, START, opts)
end
statistics_service() click to toggle source

Locates the `statistics` service.

@return [StatisticsService] A reference to `statistics` service.

# File lib/ovirtsdk4/services.rb, line 31666
def statistics_service
  @statistics_service ||= StatisticsService.new(self, 'statistics')
end
stop(opts = {}) click to toggle source

This operation forces a virtual machine to power-off.

For example:

source

POST /ovirt-engine/api/vms/123/stop


The stop action does not take any action specific parameters; therefore, the request body should contain an empty `action`:

source,xml

<action/>


To stop the VM even if a backup is running for it, the action should include the 'force' element.

For example, to force stop virtual machine `123`:


POST /ovirt-engine/api/vms/123/stop


source,xml

<action>

<force>true</force>

</action>


@param opts [Hash] Additional options.

@option opts [Boolean] :async Indicates if the stop action should be performed asynchronously.

@option opts [Boolean] :force Indicates if the VM should be forcibly stop even

if a backup is running for it.

@option opts [String] :reason The reason the virtual machine was stopped.

Optionally set by user when shutting down the virtual machine.

@option opts [Hash] :headers ({}) Additional HTTP headers.

@option opts [Hash] :query ({}) Additional URL query parameters.

@option opts [Integer] :timeout (nil) The timeout for this request, in seconds. If no value is explicitly

given then the timeout set globally for the connection will be used.

@option opts [Boolean] :wait (true) If `true` wait for the response.

# File lib/ovirtsdk4/services.rb, line 31211
def stop(opts = {})
  internal_action(:stop, nil, STOP, opts)
end
suspend(opts = {}) click to toggle source

This operation saves the virtual machine state to disk and stops it. Start a suspended virtual machine and restore the virtual machine state with the start action.

For example:

source

POST /ovirt-engine/api/vms/123/suspend


The suspend action does not take any action specific parameters; therefore, the request body should contain an empty `action`:

source,xml

<action/>


@param opts [Hash] Additional options.

@option opts [Boolean] :async Indicates if the suspend action should be performed asynchronously.

@option opts [Hash] :headers ({}) Additional HTTP headers.

@option opts [Hash] :query ({}) Additional URL query parameters.

@option opts [Integer] :timeout (nil) The timeout for this request, in seconds. If no value is explicitly

given then the timeout set globally for the connection will be used.

@option opts [Boolean] :wait (true) If `true` wait for the response.

# File lib/ovirtsdk4/services.rb, line 31253
def suspend(opts = {})
  internal_action(:suspend, nil, SUSPEND, opts)
end
tags_service() click to toggle source

Locates the `tags` service.

@return [AssignedTagsService] A reference to `tags` service.

# File lib/ovirtsdk4/services.rb, line 31675
def tags_service
  @tags_service ||= AssignedTagsService.new(self, 'tags')
end
thaw_filesystems(opts = {}) click to toggle source

Thaws virtual machine file systems.

This operation thaws a virtual machine's file systems using the QEMU guest agent when taking a live snapshot of a running virtual machine. Normally, this is done automatically by the manager, but this must be executed manually with the API for virtual machines using OpenStack Volume (Cinder) disks.

Example:

source

POST /api/vms/123/thawfilesystems


source,xml

<action/>


@param opts [Hash] Additional options.

@option opts [Boolean] :async Indicates if the thaw file systems action should be performed asynchronously.

@option opts [Hash] :headers ({}) Additional HTTP headers.

@option opts [Hash] :query ({}) Additional URL query parameters.

@option opts [Integer] :timeout (nil) The timeout for this request, in seconds. If no value is explicitly

given then the timeout set globally for the connection will be used.

@option opts [Boolean] :wait (true) If `true` wait for the response.

# File lib/ovirtsdk4/services.rb, line 31295
def thaw_filesystems(opts = {})
  internal_action(:thawfilesystems, nil, THAW_FILESYSTEMS, opts)
end
ticket(opts = {}) click to toggle source

Generates a time-sensitive authentication token for accessing a virtual machine's display.

For example:

source

POST /ovirt-engine/api/vms/123/ticket


The client-provided action optionally includes a desired ticket value and/or an expiry time in seconds.

The response specifies the actual ticket value and expiry used.

source,xml

<action>

<ticket>
  <value>abcd12345</value>
  <expiry>120</expiry>
</ticket>

</action>


IMPORTANT

If the virtual machine is configured to support only one graphics protocol then the generated authentication token will be valid for that protocol. But if the virtual machine is configured to support multiple protocols, VNC and SPICE, then the authentication token will only be valid for the SPICE protocol.

In order to obtain an authentication token for a specific protocol, for example for VNC, use the `ticket` method of the xref:services-vm_graphics_console, which manages the graphics consoles of the virtual machine, by sending a request:

source

POST /ovirt-engine/api/vms/123/graphicsconsoles/456/ticket


@param opts [Hash] Additional options.

@option opts [Boolean] :async Indicates if the generation of the ticket should be performed asynchronously.

@option opts [Ticket] :ticket

@option opts [Hash] :headers ({}) Additional HTTP headers.

@option opts [Hash] :query ({}) Additional URL query parameters.

@option opts [Integer] :timeout (nil) The timeout for this request, in seconds. If no value is explicitly

given then the timeout set globally for the connection will be used.

@option opts [Boolean] :wait (true) If `true` wait for the response.

# File lib/ovirtsdk4/services.rb, line 31364
def ticket(opts = {})
  internal_action(:ticket, :ticket, TICKET, opts)
end
undo_snapshot(opts = {}) click to toggle source

Restores the virtual machine to the state it had before previewing the snapshot.

See the xref:services-vm-methods-preview_snapshot operation for details.

@param opts [Hash] Additional options.

@option opts [Boolean] :async Indicates if the undo snapshot action should be performed asynchronously.

@option opts [Hash] :headers ({}) Additional HTTP headers.

@option opts [Hash] :query ({}) Additional URL query parameters.

@option opts [Integer] :timeout (nil) The timeout for this request, in seconds. If no value is explicitly

given then the timeout set globally for the connection will be used.

@option opts [Boolean] :wait (true) If `true` wait for the response.

# File lib/ovirtsdk4/services.rb, line 31478
def undo_snapshot(opts = {})
  internal_action(:undosnapshot, nil, UNDO_SNAPSHOT, opts)
end
update(vm, opts = {}) click to toggle source

Update the virtual machine in the system for the given virtual machine id.

@param vm [Vm] The `vm` to update. @param opts [Hash] Additional options.

@option opts [Boolean] :async Indicates if the update should be performed asynchronously.

@option opts [Boolean] :next_run Indicates if the update should be applied to the virtual machine immediately or if it should be applied only

when the virtual machine is restarted. The default value is `false`, so by default changes are applied
immediately.

@option opts [Hash] :headers ({}) Additional HTTP headers.

@option opts [Hash] :query ({}) Additional URL query parameters.

@option opts [Integer] :timeout (nil) The timeout for this request, in seconds. If no value is explicitly

given then the timeout set globally for the connection will be used.

@option opts [Boolean] :wait (true) If `true` wait for the response.

@return [Vm]

# File lib/ovirtsdk4/services.rb, line 31512
def update(vm, opts = {})
  internal_update(vm, Vm, UPDATE, opts)
end
watchdogs_service() click to toggle source

Locates the `watchdogs` service.

@return [VmWatchdogsService] A reference to `watchdogs` service.

# File lib/ovirtsdk4/services.rb, line 31684
def watchdogs_service
  @watchdogs_service ||= VmWatchdogsService.new(self, 'watchdogs')
end