class OvirtSDK4::VmSessionsService

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

Public Instance Methods

list(opts = {}) click to toggle source

Lists all user sessions for this virtual machine.

For example, to retrieve the session information for virtual machine `123` send a request like this:

source

GET /ovirt-engine/api/vms/123/sessions


The response body will contain something like this:

source,xml

<sessions>

<session href="/ovirt-engine/api/vms/123/sessions/456" id="456">
  <console_user>true</console_user>
  <ip>
    <address>192.168.122.1</address>
  </ip>
  <user href="/ovirt-engine/api/users/789" id="789"/>
  <vm href="/ovirt-engine/api/vms/123" id="123"/>
</session>
...

</sessions>


@param opts [Hash] Additional options.

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

@return [Array<Session>]

# File lib/ovirtsdk4/services.rb, line 32885
def list(opts = {})
  query = {}
  value = opts[:max]
  unless value.nil?
    value = Writer.render_integer(value)
    query['max'] = 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 SessionReader.read_many(reader)
    ensure
      reader.close
    end
  else
    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 32925
def service(path)
  if path.nil? || path == ''
    return self
  end
  index = path.index('/')
  if index.nil?
    return session_service(path)
  end
  return session_service(path[0..(index - 1)]).service(path[(index +1)..-1])
end
session_service(id) click to toggle source

Reference to the service that manages a specific session.

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

@return [VmSessionService] A reference to the `session` service.

# File lib/ovirtsdk4/services.rb, line 32914
def session_service(id)
  VmSessionService.new(@connection, "#{@path}/#{id}")
end
to_s() click to toggle source

Returns an string representation of this service.

@return [String]

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