class OvirtSDK4::StorageDomainVmService
Public Class Methods
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 20850 def initialize(connection, path) @connection = connection @path = path end
Public Instance Methods
Locates the `disks` service.
@return [StorageDomainContentDisksService] A reference to `disks` service.
# File lib/ovirtsdk4/services.rb, line 20985 def disks_service return StorageDomainContentDisksService.new(@connection, "#{@path}/disks") end
Returns the representation of the object managed by this service.
@param opts [Hash] Additional options.
@return [Vm]
# File lib/ovirtsdk4/services.rb, line 20862 def get(opts = {}) query = {} request = Request.new(:method => :GET, :path => @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
Executes the `import` method.
@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 explicity specified the default value is `false`.
@option opts [StorageDomain] :storage_domain
@option opts [Vm] :vm
# File lib/ovirtsdk4/services.rb, line 20908 def import(opts = {}) action = Action.new(opts) writer = XmlWriter.new(nil, true) ActionWriter.write_one(action, writer) body = writer.string writer.close request = Request.new({ :method => :POST, :path => "#{@path}/import", :body => body, }) 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] :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 20941 def register(opts = {}) action = Action.new(opts) writer = XmlWriter.new(nil, true) ActionWriter.write_one(action, writer) body = writer.string writer.close request = Request.new({ :method => :POST, :path => "#{@path}/register", :body => body, }) 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.
# File lib/ovirtsdk4/services.rb, line 20967 def remove(opts = {}) query = {} value = opts[:async] unless value.nil? value = Writer.render_boolean(value) query['async'] = value end request = Request.new(:method => :DELETE, :path => @path, :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 20996 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 21014 def to_s return "#<#{StorageDomainVmService}:#{@path}>" end