user_object_rights

Creates, updates, deletes, gets or lists a user_object_rights resource.

Overview

Name	user_object_rights
Type	Resource
Id	ovh.dedicated_cloud.user_object_rights

Fields

The following fields are returned by SELECT queries:

get

successful operation

Name	Datatype	Description
name	string	Name of the object
object_right_id	integer	(wire: objectRightId)
vmware_object_id	string	The VMware MoRef of the object (wire: vmwareObjectId)
propagate	boolean	Right propagation on children objects
right	string	User access on the VMware object (admin, disabled, readonly, readwrite)
type	string	Type of the object (cluster, datastore, dvportgroup, folder, pool, vm)

list

User object right

Name	Datatype	Description
name	string	Name of the object
object_right_id	integer	(wire: objectRightId)
vmware_object_id	string	The VMware MoRef of the object (wire: vmwareObjectId)
propagate	boolean	Right propagation on children objects
right	string	User access on the VMware object (admin, disabled, readonly, readwrite)
type	string	Type of the object (cluster, datastore, dvportgroup, folder, pool, vm)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	object_right_id, service_name, user_id		Get a user object right. Returns the right of the user on a VMware object: object type, MoRef, access level and propagation.
list	select	service_name, user_id	x_pagination_mode	List user object rights
create	insert	service_name, user_id, right, type, vmware_object_id		Create a user object right. Gives the user a right on a VMware object, given by its MoRef: cluster, datastore, portgroup, folder, pool or virtual machine. The right can propagate to child objects. Returns a task to track progress.
delete	delete	object_right_id, service_name, user_id		Delete a user object right. Removes the right of the user on the VMware object. Returns a task to track progress.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
api_host	string	The OVHcloud API host. Selected by OVH_ENDPOINT (ovh-eu, ovh-ca or ovh-us; default ovh-eu). (default: api.eu.ovhcloud.com, x-stackQL-envVarSelector: {"envVar":"OVH_ENDPOINT","default":"ovh-eu","values":{"ovh-eu":"api.eu.ovhcloud.com","ovh-ca":"api.ca.ovhcloud.com","ovh-us":"api.us.ovhcloud.com"}})
object_right_id	integer	(wire: objectRightId)
service_name	string	Domain of the service (wire: serviceName)
user_id	integer	(wire: userId)
x_pagination_mode	string	Sent as CachedObjectList-Pages by default so the list returns the full objects rather than their identifiers. (wire: X-Pagination-Mode)

SELECT examples

get

Get a user object right. Returns the right of the user on a VMware object: object type, MoRef, access level and propagation.

SELECT
name,
object_right_id,
vmware_object_id,
propagate,
right,
type
FROM ovh.dedicated_cloud.user_object_rights
WHERE object_right_id = '{{ object_right_id }}' -- required
AND service_name = '{{ service_name }}' -- required
AND user_id = '{{ user_id }}' -- required
;

list

List user object rights

SELECT
name,
object_right_id,
vmware_object_id,
propagate,
right,
type
FROM ovh.dedicated_cloud.user_object_rights
WHERE service_name = '{{ service_name }}' -- required
AND user_id = '{{ user_id }}' -- required
AND x_pagination_mode = '{{ x_pagination_mode }}'
;

INSERT examples

create

Create a user object right. Gives the user a right on a VMware object, given by its MoRef: cluster, datastore, portgroup, folder, pool or virtual machine. The right can propagate to child objects. Returns a task to track progress.

INSERT INTO ovh.dedicated_cloud.user_object_rights (
propagate,
right,
type,
vmware_object_id,
service_name,
user_id
)
SELECT 
{{ propagate }},
'{{ right }}' /* required */,
'{{ type }}' /* required */,
'{{ vmware_object_id }}' /* required */,
'{{ service_name }}',
'{{ user_id }}'
RETURNING
name,
datacenter_id,
filer_id,
host_id,
network_access_id,
order_id,
parent_task_id,
task_id,
user_id,
vlan_id,
created_by,
created_from,
description,
end_date,
execution_date,
last_modification_date,
maintenance_date_from,
maintenance_date_to,
network,
progress,
state,
type
;

Manifest

# Description fields are for documentation purposes
- name: user_object_rights
props:
  - name: service_name
    value: "{{ service_name }}"
    description: Required parameter for the user_object_rights resource.
  - name: user_id
    value: {{ user_id }}
    description: Required parameter for the user_object_rights resource.
  - name: propagate
    value: {{ propagate }}
    description: |
      Right propagation on children objects
  - name: right
    value: "{{ right }}"
    description: |
      User access on the VMware object
    valid_values: ['admin', 'disabled', 'readonly', 'readwrite']
  - name: type
    value: "{{ type }}"
    description: |
      Type of the object
    valid_values: ['cluster', 'datastore', 'dvportgroup', 'folder', 'pool', 'vm']
  - name: vmware_object_id
    value: "{{ vmware_object_id }}"
    description: |
      The VMware MoRef of the object

DELETE examples

delete

Delete a user object right. Removes the right of the user on the VMware object. Returns a task to track progress.

DELETE FROM ovh.dedicated_cloud.user_object_rights
WHERE object_right_id = '{{ object_right_id }}' --required
AND service_name = '{{ service_name }}' --required
AND user_id = '{{ user_id }}' --required
;