class OvirtSDK4::StorageDomainTemplateService

Constants

GET
REMOVE

Public Instance Methods

disks_service() click to toggle source

Locates the `disks` service.

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

# File lib/ovirtsdk4/services.rb, line 20539
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.

@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 [Template]

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

Action to import a template from an export storage domain.

For example, to import the template `456` from the storage domain `123` send the following request:

source

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


With the following request body:

source, xml

<action>

<storage_domain>
  <name>myexport</name>
</storage_domain>
<cluster>
  <name>mycluster</name>
</cluster>

</action>


@param opts [Hash] Additional options.

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

@option opts [Boolean] :clone Use the optional `clone` parameter to generate new UUIDs for the imported template and its entities.

The user might want to import a template with the `clone` parameter set to `false` when importing a template
from an export domain, with templates that was exported by a different {product-name} environment.

@option opts [Cluster] :cluster

@option opts [Boolean] :exclusive

@option opts [StorageDomain] :storage_domain

@option opts [Template] :template

@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 20471
def import(opts = {})
  internal_action(:import, nil, 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 template 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 template to be registered without the missing disks. This is mainly used during
registration of a template 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] :exclusive

@option opts [Template] :template

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

Deletes the object managed by this service.

@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 20530
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 20550
def service(path)
  if path.nil? || path == ''
    return self
  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 20568
def to_s
  "#<#{StorageDomainTemplateService}:#{@path}>"
end