class OvirtSDK4::DiskAttachmentService

Constants

GET
REMOVE
UPDATE

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.

@option opts [String] :follow Indicates which inner links should be followed. The objects referenced by these links will be fetched as part

of the current request. See <<documents/003_common_concepts/follow, here>> for details.

@option opts [Hash] :headers ({}) Additional HTTP headers.

@option opts [Hash] :query ({}) Additional URL query parameters.

@option opts [Integer] :timeout (nil) The timeout for this request, in seconds. If no value is explicitly

given then the timeout set globally for the connection will be used.

@option opts [Boolean] :wait (true) If `true` wait for the response.

@return [DiskAttachment]

# File lib/ovirtsdk4/services.rb, line 7124
def get(opts = {})
  internal_get(GET, opts)
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.

@option opts [Hash] :headers ({}) Additional HTTP headers.

@option opts [Hash] :query ({}) Additional URL query parameters.

@option opts [Integer] :timeout (nil) The timeout for this request, in seconds. If no value is explicitly

given then the timeout set globally for the connection will be used.

@option opts [Boolean] :wait (true) If `true` wait for the response.

# File lib/ovirtsdk4/services.rb, line 7160
def remove(opts = {})
  internal_remove(REMOVE, opts)
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 7212
def service(path)
  if path.nil? || path == ''
    return self
  end
  raise Error.new("The path \"#{path}\" doesn't correspond to any service")
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.

@option opts [Hash] :headers ({}) Additional HTTP headers.

@option opts [Hash] :query ({}) Additional URL query parameters.

@option opts [Integer] :timeout (nil) The timeout for this request, in seconds. If no value is explicitly

given then the timeout set globally for the connection will be used.

@option opts [Boolean] :wait (true) If `true` wait for the response.

@return [DiskAttachment]

# File lib/ovirtsdk4/services.rb, line 7201
def update(disk_attachment, opts = {})
  internal_update(disk_attachment, DiskAttachment, UPDATE, opts)
end