class OvirtSDK4::SystemPermissionsService
Constants
- ADD
- ADD_CLUSTER_PERMISSION
- ADD_DATA_CENTER_PERMISSION
- ADD_GROUP_LEVEL
- ADD_HOST_PERMISSION
- ADD_STORAGE_DOMAIN_PERMISSION
- ADD_TEMPLATE_PERMISSION
- ADD_USER_LEVEL
- ADD_VM_PERMISSION
- ADD_VM_POOL_PERMISSION
- LIST
Public Instance Methods
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 26432 def add(permission, opts = {}) internal_add(permission, Permission, ADD, opts) end
Add a new permission on the cluster to the group in the system.
@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 26459 def add_cluster_permission(permission, opts = {}) internal_add(permission, Permission, ADD_CLUSTER_PERMISSION, opts) end
Add a new permission on the data center to the group in the system.
@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 26486 def add_data_center_permission(permission, opts = {}) internal_add(permission, Permission, ADD_DATA_CENTER_PERMISSION, opts) end
Add a new group level permission for a given virtual machine.
@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 26513 def add_group_level(permission, opts = {}) internal_add(permission, Permission, ADD_GROUP_LEVEL, opts) end
Add a new permission on the host to the group in the system.
@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 26540 def add_host_permission(permission, opts = {}) internal_add(permission, Permission, ADD_HOST_PERMISSION, opts) end
Add a new permission on the storage domain to the group in the system.
@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 26620 def add_storage_domain_permission(permission, opts = {}) internal_add(permission, Permission, ADD_STORAGE_DOMAIN_PERMISSION, opts) end
Add a new permission on the template to the group in the system.
@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 26647 def add_template_permission(permission, opts = {}) internal_add(permission, Permission, ADD_TEMPLATE_PERMISSION, opts) end
Add a new user level permission for a given virtual machine.
@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 26674 def add_user_level(permission, opts = {}) internal_add(permission, Permission, ADD_USER_LEVEL, opts) end
Add a new permission on the vm to the group in the system.
@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 26701 def add_vm_permission(permission, opts = {}) internal_add(permission, Permission, ADD_VM_PERMISSION, opts) end
Add a new permission on the vm pool to the group in the system.
@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 26728 def add_vm_pool_permission(permission, opts = {}) internal_add(permission, Permission, ADD_VM_POOL_PERMISSION, opts) end
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 [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 [Array<Permission>]
# File lib/ovirtsdk4/services.rb, line 26593 def list(opts = {}) internal_get(LIST, opts) end
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 26740 def permission_service(id) PermissionService.new(self, id) end
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 26751 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