Class: OvirtSDK4::DomainService

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

#get(opts = {}) ⇒ Domain

Gets the authentication domain information.

Usage:

GET /ovirt-engine/api/domains/5678 HTTP/1.1

Will return the domain information:

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

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.

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



8027
8028
8029
 
# File 'lib/ovirtsdk4/services.rb', line 8027

def get(opts = {})
  internal_get(GET, opts)
end

#groups_service ⇒ DomainGroupsService

Reference to a service to manage domain groups.

Returns:



8036
8037
8038
 
# File 'lib/ovirtsdk4/services.rb', line 8036

def groups_service
  @groups_service ||= DomainGroupsService.new(self, 'groups')
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.

Raises:



8056
8057
8058
8059
8060
8061
8062
8063
8064
8065
8066
8067
8068
8069
8070
8071
8072
8073
 
# File 'lib/ovirtsdk4/services.rb', line 8056

def service(path)
  if path.nil? || path == ''
    return self
  end
  if path == 'groups'
    return groups_service
  end
  if path.start_with?('groups/')
    return groups_service.service(path[7..-1])
  end
  if path == 'users'
    return users_service
  end
  if path.start_with?('users/')
    return users_service.service(path[6..-1])
  end
  raise Error.new("The path \"#{path}\" doesn't correspond to any service")
end

#users_service ⇒ DomainUsersService

Reference to a service to manage domain users.

Returns:



8045
8046
8047
 
# File 'lib/ovirtsdk4/services.rb', line 8045

def users_service
  @users_service ||= DomainUsersService.new(self, 'users')
end