class OvirtSDK4::SystemPermissionsService

Constants

ADD
LIST

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.

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

# File lib/ovirtsdk4/services.rb, line 24938
def add(permission, opts = {})
  internal_add(permission, Permission, ADD, opts)
end
cluster_permission(opts = {}) click to toggle source

Add a new permission on the cluster to the group in the system.

@param opts [Hash] Additional options.

@option opts [Permission] :permission The permission.

@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 24958
def cluster_permission(opts = {})
  internal_action(:clusterpermission, :permission, opts)
end
data_center_permission(opts = {}) click to toggle source

Add a new permission on the data center to the group in the system.

@param opts [Hash] Additional options.

@option opts [Permission] :permission The permission.

@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 24978
def data_center_permission(opts = {})
  internal_action(:datacenterpermission, :permission, opts)
end
group_level(opts = {}) click to toggle source

Add a new group level permission for a given virtual machine.

@param opts [Hash] Additional options.

@option opts [Permission] :permission The permission.

@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 24998
def group_level(opts = {})
  internal_action(:grouplevel, :permission, opts)
end
host_permission(opts = {}) click to toggle source

Add a new permission on the host to the group in the system.

@param opts [Hash] Additional options.

@option opts [Permission] :permission The permission.

@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 25018
def host_permission(opts = {})
  internal_action(:hostpermission, :permission, opts)
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>


The order of the returned permissions isn't guaranteed.

@param opts [Hash] Additional options.

@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<Permission>]

# File lib/ovirtsdk4/services.rb, line 25067
def list(opts = {})
  internal_get(LIST, opts)
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 25179
def permission_service(id)
  PermissionService.new(self, 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 25190
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
storage_domain_permission(opts = {}) click to toggle source

Add a new permission on the storage domain to the group in the system.

@param opts [Hash] Additional options.

@option opts [Permission] :permission The permission.

@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 25087
def storage_domain_permission(opts = {})
  internal_action(:storagedomainpermission, :permission, opts)
end
template_permission(opts = {}) click to toggle source

Add a new permission on the template to the group in the system.

@param opts [Hash] Additional options.

@option opts [Permission] :permission The permission.

@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 25107
def template_permission(opts = {})
  internal_action(:templatepermission, :permission, opts)
end
to_s() click to toggle source

Returns an string representation of this service.

@return [String]

# File lib/ovirtsdk4/services.rb, line 25206
def to_s
  "#<#{SystemPermissionsService}:#{absolute_path}>"
end
user_level(opts = {}) click to toggle source

Add a new user level permission for a given virtual machine.

@param opts [Hash] Additional options.

@option opts [Permission] :permission The permission.

@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 25127
def user_level(opts = {})
  internal_action(:userlevel, :permission, opts)
end
vm_permission(opts = {}) click to toggle source

Add a new permission on the vm to the group in the system.

@param opts [Hash] Additional options.

@option opts [Permission] :permission The permission.

@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 25147
def vm_permission(opts = {})
  internal_action(:vmpermission, :permission, opts)
end
vm_pool_permission(opts = {}) click to toggle source

Add a new permission on the vm pool to the group in the system.

@param opts [Hash] Additional options.

@option opts [Permission] :permission The permission.

@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 25167
def vm_pool_permission(opts = {})
  internal_action(:vmpoolpermission, :permission, opts)
end