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 25055 def initialize(connection, path) @connection = connection @path = path end
Locates the `disks` service.
@return [StorageDomainContentDisksService] A reference to `disks` service.
# File lib/ovirtsdk4/services.rb, line 25239 def disks_service StorageDomainContentDisksService.new(@connection, "#{@path}/disks") end
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.
@return [Template]
# File lib/ovirtsdk4/services.rb, line 25071 def get(opts = {}) headers = opts[:headers] || {} query = opts[:query] || {} request = HttpRequest.new(method: :GET, url: @path, headers: headers, query: query) response = @connection.send(request) case response.code when 200 begin reader = XmlReader.new(response.body) return TemplateReader.read_one(reader) ensure reader.close end else check_fault(response) end end
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:
POST /ovirt-engine/api/storagedomains/123/templates/456/import
With the following request body:
<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.
# File lib/ovirtsdk4/services.rb, line 25136 def import(opts = {}) headers = opts[:headers] || {} query = opts[:query] || {} 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, headers: headers, query: query ) response = @connection.send(request) case response.code when 200 action = check_action(response) else check_action(response) end end
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.
# File lib/ovirtsdk4/services.rb, line 25185 def register(opts = {}) headers = opts[:headers] || {} query = opts[:query] || {} 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, headers: headers, query: query ) response = @connection.send(request) case response.code when 200 action = check_action(response) else check_action(response) end end
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.
# File lib/ovirtsdk4/services.rb, line 25219 def remove(opts = {}) headers = opts[:headers] || {} query = opts[:query] || {} value = opts[:async] unless value.nil? value = Writer.render_boolean(value) query['async'] = value end request = HttpRequest.new(method: :DELETE, url: @path, headers: headers, query: query) response = @connection.send(request) unless response.code == 200 check_fault(response) end end
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 25250 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
Returns an string representation of this service.
@return [String]
# File lib/ovirtsdk4/services.rb, line 25268 def to_s "#<#{StorageDomainTemplateService}:#{@path}>" end