cephfs

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

Overview

Name	cephfs
Type	Resource
Id	ovh.dedicated_ceph.cephfs

Fields

The following fields are returned by SELECT queries:

get

successful operation

Name	Datatype	Description
fs_name	string	Filesystem name (wire: fsName)
enabled	boolean	Filesystem state

list

CephFS filesystem data

Name	Datatype	Description
fs_name	string	Filesystem name (wire: fsName)
enabled	boolean	Filesystem state

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	fs_name, service_name		Returns a CephFS filesystem of the cluster.
list	select	service_name		Returns the CephFS filesystems of the cluster. The list is empty until a filesystem is enabled.
delete	delete	fs_name, service_name		Permanently deletes the filesystem and all its data. Only a disabled filesystem can be deleted.
disable	exec	fsName, serviceName		Blocks access to the filesystem and keeps its data. The filesystem can be enabled again later.
enable	exec	fsName, serviceName		Enables the filesystem, which becomes available within a few minutes. Only one filesystem can be enabled, and it must be named fs-default.

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"}})
fsName	string	Fs name
fs_name	string	Fs name (wire: fsName)
serviceName	string	Service name
service_name	string	Service name (wire: serviceName)

SELECT examples

get

Returns a CephFS filesystem of the cluster.

SELECT
fs_name,
enabled
FROM ovh.dedicated_ceph.cephfs
WHERE fs_name = '{{ fs_name }}' -- required
AND service_name = '{{ service_name }}' -- required
;

list

Returns the CephFS filesystems of the cluster. The list is empty until a filesystem is enabled.

SELECT
fs_name,
enabled
FROM ovh.dedicated_ceph.cephfs
WHERE service_name = '{{ service_name }}' -- required
;

DELETE examples

delete

Permanently deletes the filesystem and all its data. Only a disabled filesystem can be deleted.

DELETE FROM ovh.dedicated_ceph.cephfs
WHERE fs_name = '{{ fs_name }}' --required
AND service_name = '{{ service_name }}' --required
;

Lifecycle Methods

EXEC variables use wire (API) names.

disable

Blocks access to the filesystem and keeps its data. The filesystem can be enabled again later.

EXEC ovh.dedicated_ceph.cephfs.disable 
@fsName='{{ fsName }}' --required, 
@serviceName='{{ serviceName }}' --required
;

enable

Enables the filesystem, which becomes available within a few minutes. Only one filesystem can be enabled, and it must be named fs-default.

EXEC ovh.dedicated_ceph.cephfs.enable 
@fsName='{{ fsName }}' --required, 
@serviceName='{{ serviceName }}' --required
;