class OvirtSDK4::AssignedPermissionsService

Public Class Methods

new(connection, path) click to toggle source

Creates a new implementation of the service.

@param connection [Connection] The connection to be used by this service.

@param path [String] The relative path of this service, for example `vms/123/disks`.

@api private

# File lib/ovirtsdk4/services.rb, line 2797
def initialize(connection, path)
  @connection = connection
  @path = path
end

Public Instance Methods

add(permission, opts = {}) click to toggle source

Assign a new permission to a user or group for specific entity.

For example, to assign the `UserVmManager` role to the virtual machine with id `123` to the user with id `456` send a request like this:

.… POST /ovirt-engine/api/vms/123/permissions .…

With a request body like this:

source,xml

<permission>

<role>
  <name>UserVmManager</name>
</role>
<user id="456"/>

</permission>


To assign the `SuperUser` role to the system to the user with id `456` send a request like this:

.… POST /ovirt-engine/api/permissions .…

With a request body like this:

source,xml

<permission>

<role>
  <name>SuperUser</name>
</role>
<user id="456"/>

</permission>


If you want to assign permission to the group instead of the user please replace the `user` element with the `group` element with proper `id` of the group. For example to assign the `UserRole` role to the cluster with id `123` to the group with id `789` send a request like this:

.… POST /ovirt-engine/api/clusters/123/permissions .…

With a request body like this:

source,xml

<permission>

<role>
  <name>UserRole</name>
</role>
<group id="789"/>

</permission>


@param permission [Permission] The permission.

@param opts [Hash] Additional options.

@return [Permission]

# File lib/ovirtsdk4/services.rb, line 2868
def add(permission, opts = {})
  if permission.is_a?(Hash)
    permission = OvirtSDK4::Permission.new(permission)
  end
  query = {}
  request = HttpRequest.new(method: :POST, url: @path, query: query)
  begin
    writer = XmlWriter.new(nil, true)
    PermissionWriter.write_one(permission, writer)
    request.body = writer.string
  ensure
    writer.close
  end
  response = @connection.send(request)
  case response.code
  when 200, 201, 202
    begin
      reader = XmlReader.new(response.body)
      return PermissionReader.read_one(reader)
    ensure
      reader.close
    end
  else
    check_fault(response)
  end
end
list(opts = {}) click to toggle source

List all the permissions of the specific entity.

For example to list all the permissions of the cluster with id `123` send a request like this:

.… GET /ovirt-engine/api/clusters/123/permissions .…

source,xml

<permissions>

<permission id="456">
  <cluster id="123"/>
  <role id="789"/>
  <user id="451"/>
</permission>
<permission id="654">
  <cluster id="123"/>
  <role id="789"/>
  <group id="127"/>
</permission>

</permissions>


@param opts [Hash] Additional options.

@return [Array<Permission>]

# File lib/ovirtsdk4/services.rb, line 2924
def list(opts = {})
  query = {}
  request = HttpRequest.new(method: :GET, url: @path, query: query)
  response = @connection.send(request)
  case response.code
  when 200
    begin
      reader = XmlReader.new(response.body)
      return PermissionReader.read_many(reader)
    ensure
      reader.close
    end
  else
    check_fault(response)
  end
end
permission_service(id) click to toggle source

Sub-resource locator method, returns individual permission resource on which the remainder of the URI is dispatched.

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

@return [PermissionService] A reference to the `permission` service.

# File lib/ovirtsdk4/services.rb, line 2949
def permission_service(id)
  PermissionService.new(@connection, "#{@path}/#{id}")
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 2960
def service(path)
  if path.nil? || path == ''
    return self
  end
  index = path.index('/')
  if index.nil?
    return permission_service(path)
  end
  return permission_service(path[0..(index - 1)]).service(path[(index +1)..-1])
end
to_s() click to toggle source

Returns an string representation of this service.

@return [String]

# File lib/ovirtsdk4/services.rb, line 2976
def to_s
  "#<#{AssignedPermissionsService}:#{@path}>"
end