class OvirtSDK4::GroupService

Constants

GET
REMOVE

Public Instance Methods

get(opts = {}) click to toggle source

Gets the system group information.

Usage:

.… GET /ovirt-engine/api/groups/123 .…

Will return the group information:

source,xml

<group href=“/ovirt-engine/api/groups/123” id=“123”>

<name>mygroup</name>
<link href="/ovirt-engine/api/groups/123/roles" rel="roles"/>
<link href="/ovirt-engine/api/groups/123/permissions" rel="permissions"/>
<link href="/ovirt-engine/api/groups/123/tags" rel="tags"/>
<domain_entry_id>476652557A382F67696B6D2B32762B37796E46476D513D3D</domain_entry_id>
<namespace>DC=example,DC=com</namespace>
<domain href="/ovirt-engine/api/domains/ABCDEF" id="ABCDEF">
  <name>myextension-authz</name>
</domain>

</group>


@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 [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 [Group]

# File lib/ovirtsdk4/services.rb, line 11842
def get(opts = {})
  internal_get(GET, opts)
end
permissions_service() click to toggle source

Reference to the service that manages the collection of permissions assigned to this system group.

@return [AssignedPermissionsService] A reference to `permissions` service.

# File lib/ovirtsdk4/services.rb, line 11882
def permissions_service
  @permissions_service ||= AssignedPermissionsService.new(self, 'permissions')
end
remove(opts = {}) click to toggle source

Removes the system group.

Usage:

.… DELETE /ovirt-engine/api/groups/123 .…

@param opts [Hash] Additional options.

@option opts [Boolean] :async Indicates if the remove should be performed asynchronously. @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.

# File lib/ovirtsdk4/services.rb, line 11873
def remove(opts = {})
  internal_remove(REMOVE, opts)
end
roles_service() click to toggle source

Reference to the service that manages the collection of roles assigned to this system group.

@return [AssignedRolesService] A reference to `roles` service.

# File lib/ovirtsdk4/services.rb, line 11891
def roles_service
  @roles_service ||= AssignedRolesService.new(self, 'roles')
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 11911
def service(path)
  if path.nil? || path == ''
    return self
  end
  if path == 'permissions'
    return permissions_service
  end
  if path.start_with?('permissions/')
    return permissions_service.service(path[12..-1])
  end
  if path == 'roles'
    return roles_service
  end
  if path.start_with?('roles/')
    return roles_service.service(path[6..-1])
  end
  if path == 'tags'
    return tags_service
  end
  if path.start_with?('tags/')
    return tags_service.service(path[5..-1])
  end
  raise Error.new("The path \"#{path}\" doesn't correspond to any service")
end
tags_service() click to toggle source

Reference to the service that manages the collection of tags assigned to this system group.

@return [AssignedTagsService] A reference to `tags` service.

# File lib/ovirtsdk4/services.rb, line 11900
def tags_service
  @tags_service ||= AssignedTagsService.new(self, 'tags')
end