class OvirtSDK4::DomainsService

Constants

LIST

Public Instance Methods

domain_service(id) click to toggle source

Reference to a service to view details of a domain.

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

@return [DomainService] A reference to the `domain` service.

# File lib/ovirtsdk4/services.rb, line 8578
def domain_service(id)
  DomainService.new(self, id)
end
list(opts = {}) click to toggle source

List all the authentication domains in the system.

Usage:

.… GET /ovirt-engine/api/domains .…

Will return the list of domains:

source,xml

<domains>

<domain href="/ovirt-engine/api/domains/5678" id="5678">
  <name>internal-authz</name>
  <link href="/ovirt-engine/api/domains/5678/users" rel="users"/>
  <link href="/ovirt-engine/api/domains/5678/groups" rel="groups"/>
  <link href="/ovirt-engine/api/domains/5678/users?search={query}" rel="users/search"/>
  <link href="/ovirt-engine/api/domains/5678/groups?search={query}" rel="groups/search"/>
</domain>

</domains>


The order of the returned list of domains 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 domains to return. If not specified all the domains 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<Domain>]

# File lib/ovirtsdk4/services.rb, line 8567
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 8589
def service(path)
  if path.nil? || path == ''
    return self
  end
  index = path.index('/')
  if index.nil?
    return domain_service(path)
  end
  return domain_service(path[0..(index - 1)]).service(path[(index + 1)..-1])
end