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 34208 def initialize(connection, path) @connection = connection @path = path end
This operation copies a disk to the specified storage domain.
For example, copy of a disk can be facilitated using the following request:
POST /ovirt-engine/api/disks/123/copy
With a request body like this:
<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
# File lib/ovirtsdk4/services.rb, line 34245 def copy(opts = {}) 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 ) 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
# File lib/ovirtsdk4/services.rb, line 34276 def export(opts = {}) 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 ) 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.
@return [Disk]
# File lib/ovirtsdk4/services.rb, line 34303 def get(opts = {}) query = {} request = HttpRequest.new(method: :GET, url: @path, 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:
POST /ovirt-engine/api/disks/123/move
With the following request body:
<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
# File lib/ovirtsdk4/services.rb, line 34348 def move(opts = {}) 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 ) 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 34480 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.
# File lib/ovirtsdk4/services.rb, line 34374 def remove(opts = {}) query = {} value = opts[:async] unless value.nil? value = Writer.render_boolean(value) query['async'] = value end request = HttpRequest.new(method: :DELETE, url: @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 34500 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.
# File lib/ovirtsdk4/services.rb, line 34399 def sparsify(opts = {}) 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 ) 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 34489 def statistics_service StatisticsService.new(@connection, "#{@path}/statistics") end
Returns an string representation of this service.
@return [String]
# File lib/ovirtsdk4/services.rb, line 34524 def to_s "#<#{DiskService}:#{@path}>" end
This operation updates the disk with the appropriate parameters. The only field that can be updated is `qcow_version`.
For example, update disk can be facilitated using the following request:
PUT /ovirt-engine/api/disks/123
With a request body like this:
<disk>
<qcow_version>qcow2_v3</qcow_version>
</disk>
Since the backend operation is asynchronous the disk element which will be returned to the user might not be synced with the changed properties.
@param disk [Disk] The update to apply to the disk. @param opts [Hash] Additional options.
@return [Disk]
# File lib/ovirtsdk4/services.rb, line 34447 def update(disk, opts = {}) if disk.is_a?(Hash) disk = OvirtSDK4::Disk.new(disk) end query = {} request = HttpRequest.new(method: :PUT, url: @path, query: query) begin writer = XmlWriter.new(nil, true) DiskWriter.write_one(disk, writer) request.body = writer.string ensure writer.close end response = @connection.send(request) case response.code when 200 begin reader = XmlReader.new(response.body) return DiskReader.read_one(reader) ensure reader.close end return result else check_fault(response) end end