class OvirtSDK4::StorageDomainTemplateService

Constants

GET
IMPORT
REGISTER
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 23724
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 [Template]

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


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 Use the optional `clone` parameter to generate new UUIDs for the imported template and its entities.

You can import a template with the `clone` parameter set to `false` when importing a template
from an export domain, with templates that were 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 23629
def import(opts = {})
  internal_action(:import, nil, IMPORT, opts)
end
register(opts = {}) click to toggle source

Register the Template means importing the Template from the data domain by inserting the configuration of the Template and disks into the database without the copy process.

@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 system 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 [RegistrationConfiguration] :registration_configuration This parameter describes how the template should be

registered.

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

@option opts [Template] :template

@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 23690
def register(opts = {})
  internal_action(:register, nil, REGISTER, 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 23715
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 23735
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