class OvirtSDK4::DiskService
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 37058 def initialize(connection, path) @connection = connection @path = path end
Public Instance Methods
This operation copies a disk to the specified storage domain.
For example, copy of a disk can be facilitated using the following request:
- source
POST /ovirt-engine/api/disks/123/copy
With a request body like this:
- source,xml
<action>
<storage_domain id="456"/> <disk> <name>mydisk</name> </disk>
</action>
@param opts [Hash] Additional options.
@option opts [Boolean] :async Indicates if the copy should be performed asynchronously.
@option opts [Disk] :disk
@option opts [Boolean] :filter Indicates if the results should be filtered according to the permissions of the user.
@option opts [StorageDomain] :storage_domain
@option opts [Hash] :headers Additional HTTP headers.
@option opts [Hash] :query Additional URL query parameters.
# File lib/ovirtsdk4/services.rb, line 37099 def copy(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}/copy", 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 `export` method.
@param opts [Hash] Additional options.
@option opts [Boolean] :async Indicates if the export should be performed asynchronously.
@option opts [Boolean] :filter Indicates if the results should be filtered according to the permissions of the user.
@option opts [StorageDomain] :storage_domain
@option opts [Hash] :headers Additional HTTP headers.
@option opts [Hash] :query Additional URL query parameters.
# File lib/ovirtsdk4/services.rb, line 37138 def export(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}/export", 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
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 [Disk]
# File lib/ovirtsdk4/services.rb, line 37173 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 DiskReader.read_one(reader) ensure reader.close end else check_fault(response) end end
Moves a disk to another storage domain.
For example, to move the disk with identifier `123` to a storage domain with identifier `456` send the following request:
- source
POST /ovirt-engine/api/disks/123/move
With the following request body:
- source,xml
<action>
<storage_domain id="456"/>
</action>
@param opts [Hash] Additional options.
@option opts [Boolean] :async Indicates if the move should be performed asynchronously.
@option opts [Boolean] :filter Indicates if the results should be filtered according to the permissions of the user.
@option opts [StorageDomain] :storage_domain
@option opts [Hash] :headers Additional HTTP headers.
@option opts [Hash] :query Additional URL query parameters.
# File lib/ovirtsdk4/services.rb, line 37223 def move(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}/move", 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
Locates the `permissions` service.
@return [AssignedPermissionsService] A reference to `permissions` service.
# File lib/ovirtsdk4/services.rb, line 37316 def permissions_service AssignedPermissionsService.new(@connection, "#{@path}/permissions") 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 37257 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 37336 def service(path) if path.nil? || path == '' return self end if path == 'permissions' return permissions_service end if path.start_with?('permissions/') return permissions_service.service(path[12..-1]) end if path == 'statistics' return statistics_service end if path.start_with?('statistics/') return statistics_service.service(path[11..-1]) end raise Error.new("The path \"#{path}\" doesn't correspond to any service") end
Sparsify the disk.
Sparsification frees space in the disk image that is not used by its filesystem. As a result, the image will occupy less space on the storage.
Currently sparsification works only on disks without snapshots. Disks having derived disks are also not allowed.
@param opts [Hash] Additional options.
@option opts [Hash] :headers Additional HTTP headers.
@option opts [Hash] :query Additional URL query parameters.
# File lib/ovirtsdk4/services.rb, line 37287 def sparsify(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}/sparsify", 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
Locates the `statistics` service.
@return [StatisticsService] A reference to `statistics` service.
# File lib/ovirtsdk4/services.rb, line 37325 def statistics_service StatisticsService.new(@connection, "#{@path}/statistics") end
Returns an string representation of this service.
@return [String]
# File lib/ovirtsdk4/services.rb, line 37360 def to_s "#<#{DiskService}:#{@path}>" end