class OvirtSDK4::StorageDomainVmService

Constants

GET
IMPORT
REGISTER
REMOVE

Public Instance Methods

disk_attachments_service() click to toggle source

Returns a reference to the service that manages the disk attachments of the virtual machine.

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

# File lib/ovirtsdk4/services.rb, line 24081
def disk_attachments_service
  @disk_attachments_service ||= StorageDomainVmDiskAttachmentsService.new(self, 'diskattachments')
end
disks_service() click to toggle source

Locates the `disks` service.

@return [StorageDomainContentDisksService] A reference to `disks` service.

# File lib/ovirtsdk4/services.rb, line 24090
def disks_service
  @disks_service ||= StorageDomainContentDisksService.new(self, 'disks')
end
get(opts = {}) click to toggle source

Returns the representation of the object managed by this service.

@param opts [Hash] Additional options.

@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 [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 23856
def get(opts = {})
  internal_get(GET, opts)
end
import(opts = {}) click to toggle source

Imports a virtual machine from an export storage domain.

For example, send a request like this:

source

POST /ovirt-engine/api/storagedomains/123/vms/456/import


With a request body like this:

source,xml

<action>

<storage_domain>
  <name>mydata</name>
</storage_domain>
<cluster>
  <name>mycluster</name>
</cluster>

</action>


To import a virtual machine as a new entity add the `clone` parameter:

source,xml

<action>

<storage_domain>
  <name>mydata</name>
</storage_domain>
<cluster>
  <name>mycluster</name>
</cluster>
<clone>true</clone>
<vm>
  <name>myvm</name>
</vm>

</action>


Include an optional `disks` parameter to choose which disks to import. For example, to import the disks of the template that have the identifiers `123` and `456` send the following request body:

source,xml

<action>

<cluster>
  <name>mycluster</name>
</cluster>
<vm>
  <name>myvm</name>
</vm>
<disks>
  <disk id="123"/>
  <disk id="456"/>
</disks>

</action>


If you register an entity without specifying the cluster ID or name, the cluster name from the entity's OVF will be used (unless the register request also includes the cluster mapping).

@param opts [Hash] Additional options.

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

@option opts [Boolean] :clone Indicates if the identifiers of the imported virtual machine

should be regenerated.

By default when a virtual machine is imported the identifiers
are preserved. This means that the same virtual machine can't
be imported multiple times, as that identifiers needs to be
unique. To allow importing the same machine multiple times set
this parameter to `true`, as the default is `false`.

@option opts [Cluster] :cluster

@option opts [Boolean] :collapse_snapshots Indicates of the snapshots of the virtual machine that is imported

should be collapsed, so that the result will be a virtual machine
without snapshots.

This parameter is optional, and if it isn't explicitly specified the
default value is `false`.

@option opts [Boolean] :exclusive

@option opts [StorageDomain] :storage_domain

@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 23974
def import(opts = {})
  internal_action(:import, nil, IMPORT, opts)
end
register(opts = {}) click to toggle source

Executes the `register` method.

@param opts [Hash] Additional options.

@option opts [Boolean] :allow_partial_import Indicates whether a virtual machine is allowed to be registered with only some of its disks.

If this flag is `true`, the engine will not fail in the validation process if an image is not found, but
instead it will allow the virtual machine to be registered without the missing disks. This is mainly used
during registration of a virtual machine when some of the storage domains are not available. The default
value is `false`.

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

@option opts [Boolean] :clone

@option opts [Cluster] :cluster

@option opts [Boolean] :reassign_bad_macs Indicates if the problematic MAC addresses should be re-assigned during the import process by the engine.

A MAC address would be considered as a problematic one if one of the following is true:

- It conflicts with a MAC address that is already allocated to a virtual machine in the target environment.
- It's out of the range of the target MAC address pool.

@option opts [RegistrationConfiguration] :registration_configuration This parameter describes how the virtual machine should be

registered.

This parameter is optional. If the parameter is not specified, the virtual
machine will be registered with the same configuration that
it had in the original environment where it was created.

@option opts [Vm] :vm

@option opts [Array<VnicProfileMapping>] :vnic_profile_mappings Deprecated attribute describing mapping rules for virtual NIC profiles that will be applied during the importregister process.

WARNING: Please note that this attribute has been deprecated since version 4.2.1 of the engine, and preserved only for backward
compatibility. It will be removed in the future. To specify `vnic_profile_mappings` use the `vnic_profile_mappings`
attribute inside the xref:types-registration_configuration[RegistrationConfiguration] type.

@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 24040
def register(opts = {})
  internal_action(:register, nil, REGISTER, opts)
end
remove(opts = {}) click to toggle source

Deletes a virtual machine from an export storage domain.

For example, to delete the virtual machine `456` from the storage domain `123`, send a request like this:

source

DELETE /ovirt-engine/api/storagedomains/123/vms/456


@param opts [Hash] Additional options.

@option opts [Boolean] :async Indicates if the remove 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 24072
def remove(opts = {})
  internal_remove(REMOVE, 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 24101
def service(path)
  if path.nil? || path == ''
    return self
  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 == 'disks'
    return disks_service
  end
  if path.start_with?('disks/')
    return disks_service.service(path[6..-1])
  end
  raise Error.new("The path \"#{path}\" doesn't correspond to any service")
end