class OvirtSDK4::VmSessionsService
Constants
- LIST
Public Instance Methods
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>
The order of the returned list of sessions isn't guaranteed.
@param opts [Hash] Additional options.
@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 [Integer] :max Sets the maximum number of sessions to return. If not specified all the sessions 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<Session>]
# File lib/ovirtsdk4/services.rb, line 35339 def list(opts = {}) internal_get(LIST, 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 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
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 35350 def session_service(id) VmSessionService.new(self, id) end