users

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

Overview

Name	users
Type	Resource
Id	ovh.dedicated_ceph.users

Fields

The following fields are returned by SELECT queries:

get

successful operation

Name	Datatype	Description
name	string	Name of ceph user
service_name	string	ID of cluster (wire: serviceName)
key	string	Key of user to connect into cluster
key_type	string	Type of the user key (AES, AES256K) (wire: keyType)
mds_caps	string	Capabilities of user on MDS (wire: mdsCaps)
mon_caps	string	Capabilities of user on MON (wire: monCaps)
osd_caps	string	Capabilities of user on OSD (wire: osdCaps)

list

Ceph user

Name	Datatype	Description
name	string	Name of ceph user
service_name	string	ID of cluster (wire: serviceName)
key	string	Key of user to connect into cluster
key_type	string	Type of the user key (AES, AES256K) (wire: keyType)
mds_caps	string	Capabilities of user on MDS (wire: mdsCaps)
mon_caps	string	Capabilities of user on MON (wire: monCaps)
osd_caps	string	Capabilities of user on OSD (wire: osdCaps)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	service_name, user_name		Returns a Ceph user. Use its key to connect a client to the cluster.
list	select	service_name		Returns the Ceph users of the cluster.
create	insert	service_name, user_name		Creates a Ceph user with no pool permissions. The name must contain at least three characters.
delete	delete	service_name, user_name		Deletes the Ceph user from the cluster.

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

SELECT examples

get

Returns a Ceph user. Use its key to connect a client to the cluster.

SELECT
name,
service_name,
key,
key_type,
mds_caps,
mon_caps,
osd_caps
FROM ovh.dedicated_ceph.users
WHERE service_name = '{{ service_name }}' -- required
AND user_name = '{{ user_name }}' -- required
;

list

Returns the Ceph users of the cluster.

SELECT
name,
service_name,
key,
key_type,
mds_caps,
mon_caps,
osd_caps
FROM ovh.dedicated_ceph.users
WHERE service_name = '{{ service_name }}' -- required
;

INSERT examples

create

Creates a Ceph user with no pool permissions. The name must contain at least three characters.

INSERT INTO ovh.dedicated_ceph.users (
key_type,
user_name,
service_name
)
SELECT 
'{{ key_type }}',
'{{ user_name }}' /* required */,
'{{ service_name }}'
;

Manifest

# Description fields are for documentation purposes
- name: users
props:
  - name: service_name
    value: "{{ service_name }}"
    description: Required parameter for the users resource.
  - name: key_type
    value: "{{ key_type }}"
    description: |
      Type of the generated user key, AES unless given
    valid_values: ['AES', 'AES256K']
  - name: user_name
    value: "{{ user_name }}"
    description: |
      Name of the new user

DELETE examples

delete

Deletes the Ceph user from the cluster.

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