Class: OvirtSDK4::VmSessionsService

Inherits:
Service
  • Object
show all
Defined in:
lib/ovirtsdk4/services.rb,
lib/ovirtsdk4/services.rb

Instance Method Summary collapse

Methods inherited from Service

#inspect, #to_s

Instance Method Details

#list(opts = {}) ⇒ Array<Session>

Lists all user sessions for this virtual machine.

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

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

The response body will contain something like this:

<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>

The order of the returned list of sessions isn’t guaranteed.

Parameters:

  • opts (Hash) (defaults to: {}) —

    Additional options.

Options Hash (opts):

  • :follow (String) —

    Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.

  • :max (Integer) —

    Sets the maximum number of sessions to return. If not specified all the sessions are returned.

  • :headers (Hash) — default: {} —

    Additional HTTP headers.

  • :query (Hash) — default: {} —

    Additional URL query parameters.

  • :timeout (Integer) — default: 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.

  • :wait (Boolean) — default: true —

    If true wait for the response.

Returns:



35339
35340
35341
 
# File 'lib/ovirtsdk4/services.rb', line 35339

def list(opts = {})
  internal_get(LIST, opts)
end

#service(path) ⇒ Service

Locates the service corresponding to the given path.

Parameters:

  • path (String) —

    The path of the service.

Returns:

  • (Service) —

    A reference to the service.



35361
35362
35363
35364
35365
35366
35367
35368
35369
35370
 
# File 'lib/ovirtsdk4/services.rb', line 35361

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) ⇒ VmSessionService

Reference to the service that manages a specific session.

Parameters:

  • id (String) —

    The identifier of the session.

Returns:



35350
35351
35352
 
# File 'lib/ovirtsdk4/services.rb', line 35350

def session_service(id)
  VmSessionService.new(self, id)
end