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 30103 def initialize(connection, path) @connection = connection @path = path end
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:
<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:
<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`.
@return [Cdrom]
# File lib/ovirtsdk4/services.rb, line 30140 def get(opts = {}) query = {} value = opts[:current] unless value.nil? value = Writer.render_boolean(value) query['current'] = value end 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 CdromReader.read_one(reader) ensure reader.close end else 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 30265 def service(path) if path.nil? || path == '' return self end raise Error.new("The path \"#{path}\" doesn't correspond to any service") end
Returns an string representation of this service.
@return [String]
# File lib/ovirtsdk4/services.rb, line 30277 def to_s "#<#{VmCdromService}:#{@path}>" 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:
PUT /ovirt-engine/api/vms/123/cdroms/00000000-0000-0000-0000-000000000000
The body should contain the new value for the `file` attribute:
<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`:
<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 don't 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:
PUT /ovirt-engine/api/vms/123/cdroms/00000000-0000-0000-0000-000000000000?current=true
With a request body like this:
<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.
@return [Cdrom]
# File lib/ovirtsdk4/services.rb, line 30225 def update(cdrom, opts = {}) if cdrom.is_a?(Hash) cdrom = OvirtSDK4::Cdrom.new(cdrom) end query = {} value = opts[:current] unless value.nil? value = Writer.render_boolean(value) query['current'] = value end request = HttpRequest.new(method: :PUT, url: @path, query: query) begin writer = XmlWriter.new(nil, true) CdromWriter.write_one(cdrom, 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 CdromReader.read_one(reader) ensure reader.close end return result else check_fault(response) end end