class OvirtSDK4::VmCdromService
Constants
- GET
- UPDATE
Public Instance Methods
Returns the information about this CDROM device.
The information consists of `cdrom` attribute containing reference to the CDROM device, the virtual machine, and optionally the inserted disk.
If there is a disk inserted then the `file` attribute will contain a reference to the ISO image:
- source,xml
<cdrom href=“…” id=“00000000-0000-0000-0000-000000000000”>
<file id="mycd.iso"/> <vm href="/ovirt-engine/api/vms/123" id="123"/>
</cdrom>
If there is no disk inserted then the `file` attribute won't be reported:
- source,xml
<cdrom href=“…” id=“00000000-0000-0000-0000-000000000000”>
<vm href="/ovirt-engine/api/vms/123" id="123"/>
</cdrom>
@param opts [Hash] Additional options.
@option opts [Boolean] :current Indicates if the operation should return the information for the currently running virtual machine. This
parameter is optional, and the default value is `false`.
@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 [Cdrom]
# File lib/ovirtsdk4/services.rb, line 32381 def get(opts = {}) internal_get(GET, opts) 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 32474 def service(path) if path.nil? || path == '' return self end raise Error.new("The path \"#{path}\" doesn't correspond to any service") end
Updates the information about this CDROM device.
It allows to change or eject the disk by changing the value of the `file` attribute. For example, to insert or change the disk send a request like this:
- source
PUT /ovirt-engine/api/vms/123/cdroms/00000000-0000-0000-0000-000000000000
The body should contain the new value for the `file` attribute:
- source,xml
<cdrom>
<file id="mycd.iso"/>
</cdrom>
The value of the `id` attribute, `mycd.iso` in this example, should correspond to a file available in an attached ISO storage domain.
To eject the disk use a `file` with an empty `id`:
- source,xml
<cdrom>
<file id=""/>
</cdrom>
By default the above operations change permanently the disk that will be visible to the virtual machine after the next boot, but they do not have any effect on the currently running virtual machine. If you want to change the disk that is visible to the current running virtual machine, add the `current=true` parameter. For example, to eject the current disk send a request like this:
- source
PUT /ovirt-engine/api/vms/123/cdroms/00000000-0000-0000-0000-000000000000?current=true
With a request body like this:
- source,xml
<cdrom>
<file id=""/>
</cdrom>
IMPORTANT: The changes made with the `current=true` parameter are never persisted, so they won't have any effect after the virtual machine is rebooted.
@param cdrom [Cdrom] The information about the CDROM device. @param opts [Hash] Additional options.
@option opts [Boolean] :current Indicates if the update should apply to the currently running virtual machine, or to the virtual machine
after the next boot. This parameter is optional, and the default value is `false`, which means that by default the update will have effect only after the next boot.
@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 [Cdrom]
# File lib/ovirtsdk4/services.rb, line 32463 def update(cdrom, opts = {}) internal_update(cdrom, Cdrom, UPDATE, opts) end