class OvirtSDK4::RolesService

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 19880
def initialize(connection, path)
  @connection = connection
  @path = path
end

Public Instance Methods

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

Create a new role. The role can be administrative or non-administrative and can have different permits.

For example, to add the `MyRole` non-administrative role with permits to login and create virtual machines send a request like this (note that you have to pass permit id):

source

POST /ovirt-engine/api/roles


With a request body like this:

source,xml

<role>

<name>MyRole</name>
<description>My custom role to create virtual machines</description>
<administrative>false</administrative>
<permits>
  <permit id="1"/>
  <permit id="1300"/>
</permits>

</group>


@param role [Role] Role that will be added.

@param opts [Hash] Additional options.

@return [Role]

# File lib/ovirtsdk4/services.rb, line 19917
def add(role, opts = {})
  if role.is_a?(Hash)
    role = OvirtSDK4::Role.new(role)
  end
  query = {}
  request = HttpRequest.new(method: :POST, url: @path, query: query)
  begin
    writer = XmlWriter.new(nil, true)
    RoleWriter.write_one(role, 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 RoleReader.read_one(reader)
    ensure
      reader.close
    end
  else
    check_fault(response)
  end
end
list(opts = {}) click to toggle source

List roles.

source

GET /ovirt-engine/api/roles


You will receive response in XML like this one:

source,xml

<roles>

<role id="123">
   <name>SuperUser</name>
   <description>Roles management administrator</description>
   <link href="/ovirt-engine/api/roles/123/permits" rel="permits"/>
   <administrative>true</administrative>
   <mutable>false</mutable>
</role>
...

</roles>


@param opts [Hash] Additional options.

@option opts [Integer] :max Sets the maximum number of roles to return. If not specified all the roles are returned.

@return [Array<Role>]

# File lib/ovirtsdk4/services.rb, line 19974
def list(opts = {})
  query = {}
  value = opts[:max]
  unless value.nil?
    value = Writer.render_integer(value)
    query['max'] = value
  end
  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 RoleReader.read_many(reader)
    ensure
      reader.close
    end
  else
    check_fault(response)
  end
end
role_service(id) click to toggle source

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

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

@return [RoleService] A reference to the `role` service.

# File lib/ovirtsdk4/services.rb, line 20003
def role_service(id)
  RoleService.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 20014
def service(path)
  if path.nil? || path == ''
    return self
  end
  index = path.index('/')
  if index.nil?
    return role_service(path)
  end
  return role_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 20030
def to_s
  "#<#{RolesService}:#{@path}>"
end