class OvirtSDK4::StorageDomainVmService

Public Class Methods

new(connection, path) click to toggle source

Creates a new implementation of the service.

@param connection [Connection] The connection to be used by this service.

@param path [String] The relative path of this service, for example `vms/123/disks`.

@api private

# File lib/ovirtsdk4/services.rb, line 23436
def initialize(connection, path)
  @connection = connection
  @path = path
end

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 23653
def disk_attachments_service
  StorageDomainVmDiskAttachmentsService.new(@connection, "#{@path}/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 23662
def disks_service
  StorageDomainContentDisksService.new(@connection, "#{@path}/disks")
end
get(opts = {}) click to toggle source

Returns the representation of the object managed by this service.

@param opts [Hash] Additional options.

@return [Vm]

# File lib/ovirtsdk4/services.rb, line 23448
def get(opts = {})
  query = {}
  request = HttpRequest.new(method: :GET, url: @path, query: query)
  response = @connection.send(request)
  case response.code
  when 200
    begin
      reader = XmlReader.new(response.body)
      return VmReader.read_one(reader)
    ensure
      reader.close
    end
  else
    check_fault(response)
  end
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>


@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] :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 [StorageDomain] :storage_domain

@option opts [Vm] :vm

@option opts [Array<VnicProfileMapping>] :vnic_profile_mappings Mapping rules for virtual NIC profiles that will be applied during the import process.

# File lib/ovirtsdk4/services.rb, line 23561
def import(opts = {})
  action = Action.new(opts)
  writer = XmlWriter.new(nil, true)
  ActionWriter.write_one(action, writer)
  body = writer.string
  writer.close
  request = HttpRequest.new(
    method: :POST,
    url: "#{@path}/import",
    body: body
  )
  response = @connection.send(request)
  case response.code
  when 200
    action = check_action(response)
  else
    check_action(response)
  end
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 [Vm] :vm

# File lib/ovirtsdk4/services.rb, line 23601
def register(opts = {})
  action = Action.new(opts)
  writer = XmlWriter.new(nil, true)
  ActionWriter.write_one(action, writer)
  body = writer.string
  writer.close
  request = HttpRequest.new(
    method: :POST,
    url: "#{@path}/register",
    body: body
  )
  response = @connection.send(request)
  case response.code
  when 200
    action = check_action(response)
  else
    check_action(response)
  end
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.

# File lib/ovirtsdk4/services.rb, line 23634
def remove(opts = {})
  query = {}
  value = opts[:async]
  unless value.nil?
    value = Writer.render_boolean(value)
    query['async'] = value
  end
  request = HttpRequest.new(method: :DELETE, url: @path, query: query)
  response = @connection.send(request)
  unless response.code == 200
    check_fault(response)
  end
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 23673
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
to_s() click to toggle source

Returns an string representation of this service.

@return [String]

# File lib/ovirtsdk4/services.rb, line 23697
def to_s
  "#<#{StorageDomainVmService}:#{@path}>"
end