user_pools

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

Overview

Name	user_pools
Type	Resource
Id	ovh.dedicated_ceph.user_pools

Fields

The following fields are returned by SELECT queries:

list

List of permissions

Name	Datatype	Description
pool_name	string	Name of Ceph pool (wire: poolName)
class_read	boolean	Class read permission (wire: classRead)
class_write	boolean	Class write permission (wire: classWrite)
execute	boolean	Execute permission
read	boolean	Read permission
write	boolean	Write permission

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list	select	service_name, user_name		Returns the permissions of the user on each pool.
create	insert	service_name, user_name		Replaces all pool permissions of the user with the given list. Pools left out of the list lose their permissions.
update	update	service_name, user_name, class_read, class_write, execute, pool_name, read, write		Updates the permissions of the user on one pool.
delete	delete	pool_name, service_name, user_name		Removes all permissions of the user on the pool.

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"}})
pool_name	string	Pool name (wire: poolName)
service_name	string	Service name (wire: serviceName)
user_name	string	User name (wire: userName)

SELECT examples

list

Returns the permissions of the user on each pool.

SELECT
pool_name,
class_read,
class_write,
execute,
read,
write
FROM ovh.dedicated_ceph.user_pools
WHERE service_name = '{{ service_name }}' -- required
AND user_name = '{{ user_name }}' -- required
;

INSERT examples

create

Replaces all pool permissions of the user with the given list. Pools left out of the list lose their permissions.

INSERT INTO ovh.dedicated_ceph.user_pools (
permissions,
service_name,
user_name
)
SELECT 
'{{ permissions }}',
'{{ service_name }}',
'{{ user_name }}'
;

Manifest

# Description fields are for documentation purposes
- name: user_pools
props:
  - name: service_name
    value: "{{ service_name }}"
    description: Required parameter for the user_pools resource.
  - name: user_name
    value: "{{ user_name }}"
    description: Required parameter for the user_pools resource.
  - name: permissions
    description: |
      Permissions
    value:
      - classRead: {{ classRead }}
        classWrite: {{ classWrite }}
        execute: {{ execute }}
        poolName: "{{ poolName }}"
        read: {{ read }}
        write: {{ write }}

UPDATE examples

update

Updates the permissions of the user on one pool.

UPDATE ovh.dedicated_ceph.user_pools
SET 
class_read = {{ class_read }},
class_write = {{ class_write }},
execute = {{ execute }},
pool_name = '{{ pool_name }}',
read = {{ read }},
write = {{ write }}
WHERE 
service_name = '{{ service_name }}' --required
AND user_name = '{{ user_name }}' --required
AND class_read = {{ class_read }} --required
AND class_write = {{ class_write }} --required
AND execute = {{ execute }} --required
AND pool_name = '{{ pool_name }}' --required
AND read = {{ read }} --required
AND write = {{ write }} --required;

DELETE examples

delete

Removes all permissions of the user on the pool.

DELETE FROM ovh.dedicated_ceph.user_pools
WHERE pool_name = '{{ pool_name }}' --required
AND service_name = '{{ service_name }}' --required
AND user_name = '{{ user_name }}' --required
;