class OvirtSDK4::VmGraphicsConsolesService

Constants

ADD
LIST

Public Instance Methods

add(console, opts = {}) click to toggle source

Add new graphics console to the virtual machine.

@param console [GraphicsConsole] The `console` to add.

@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 [GraphicsConsole]

# File lib/ovirtsdk4/services.rb, line 27368
def add(console, opts = {})
  internal_add(console, GraphicsConsole, ADD, opts)
end
console_service(id) click to toggle source

Returns a reference to the service that manages a specific virtual machine graphics console.

@param id [String] The identifier of the `console`.

@return [VmGraphicsConsoleService] A reference to the `console` service.

# File lib/ovirtsdk4/services.rb, line 27419
def console_service(id)
  VmGraphicsConsoleService.new(@connection, "#{@path}/#{id}")
end
list(opts = {}) click to toggle source

Lists all the configured graphics consoles of the virtual machine.

The order of the returned list of graphics consoles isn't guaranteed.

@param opts [Hash] Additional options.

@option opts [Boolean] :current Use the following query to obtain the current run-time configuration of the graphics consoles.

[source]
----
GET /ovirt-engine/api/vms/123/graphicsconsoles?current=true
----

The default value is `false`.

@option opts [Integer] :max Sets the maximum number of consoles to return. If not specified all the consoles are returned.

@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 [Array<GraphicsConsole>]

# File lib/ovirtsdk4/services.rb, line 27408
def list(opts = {})
  internal_get(LIST, 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 27430
def service(path)
  if path.nil? || path == ''
    return self
  end
  index = path.index('/')
  if index.nil?
    return console_service(path)
  end
  return console_service(path[0..(index - 1)]).service(path[(index +1)..-1])
end
to_s() click to toggle source

Returns an string representation of this service.

@return [String]

# File lib/ovirtsdk4/services.rb, line 27446
def to_s
  "#<#{VmGraphicsConsolesService}:#{@path}>"
end