class OvirtSDK4::DiskAttachmentService

Public Class Methods

new(connection, path) click to toggle source

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 6040
def initialize(connection, path)
  @connection = connection
  @path = path
end

Public Instance Methods

get(opts = {}) click to toggle source

Returns the details of the attachment, including the bootable flag and link to the disk.

An example of getting a disk attachment:

source

GET /ovirt-engine/api/vms/123/diskattachments/456


source,xml

<disk_attachment href=“/ovirt-engine/api/vms/123/diskattachments/456” id=“456”>

<active>true</active>
<bootable>true</bootable>
<interface>virtio</interface>
<disk href="/ovirt-engine/api/disks/456" id="456"/>
<vm href="/ovirt-engine/api/vms/123" id="123"/>

</disk_attachment>


@param opts [Hash] Additional options.

@return [DiskAttachment]

# File lib/ovirtsdk4/services.rb, line 6070
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 DiskAttachmentReader.read_one(reader)
    ensure
      reader.close
    end
  else
    check_fault(response)
  end
end
remove(opts = {}) click to toggle source

Removes the disk attachment.

This will only detach the disk from the virtual machine, but won't remove it from the system, unless the `detach_only` parameter is `false`.

An example of removing a disk attachment:

source

DELETE /ovirt-engine/api/vms/123/diskattachments/456?detach_only=true


@param opts [Hash] Additional options.

@option opts [Boolean] :detach_only Indicates if the disk should only be detached from the virtual machine, but not removed from the system.

The default value is `true`, which won't remove the disk from the system.
# File lib/ovirtsdk4/services.rb, line 6104
def remove(opts = {})
  query = {}
  value = opts[:detach_only]
  unless value.nil?
    value = Writer.render_boolean(value)
    query['detach_only'] = value
  end
  request = HttpRequest.new(method: :DELETE, url: @path, query: query)
  response = @connection.send(request)
  unless response.code == 200
    check_fault(response)
  end
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 6176
def service(path)
  if path.nil? || path == ''
    return self
  end
  raise Error.new("The path \"#{path}\" doesn't correspond to any service")
end
to_s() click to toggle source

Returns an string representation of this service.

@return [String]

# File lib/ovirtsdk4/services.rb, line 6188
def to_s
  "#<#{DiskAttachmentService}:#{@path}>"
end
update(disk_attachment, opts = {}) click to toggle source

Update the disk attachment and the disk properties within it.

source

PUT /vms/{vm:id}/disksattachments/{attachment:id} <disk_attachment>

<bootable>true</bootable>
<interface>ide</interface>
<active>true</active>
<disk>
  <name>mydisk</name>
  <provisioned_size>1024</provisioned_size>
  ...
</disk>

</disk_attachment>


@param disk_attachment [DiskAttachment] The `disk_attachment` to update. @param opts [Hash] Additional options.

@return [DiskAttachment]

# File lib/ovirtsdk4/services.rb, line 6141
def update(disk_attachment, opts = {})
  if disk_attachment.is_a?(Hash)
    disk_attachment = OvirtSDK4::DiskAttachment.new(disk_attachment)
  end
  query = {}
  request = HttpRequest.new(method: :PUT, url: @path, query: query)
  begin
    writer = XmlWriter.new(nil, true)
    DiskAttachmentWriter.write_one(disk_attachment, 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 DiskAttachmentReader.read_one(reader)
    ensure
      reader.close
    end
    return result
  else
    check_fault(response)
  end
end