Ceph Command Line API¶

This is an automatically generated reference.

class ceph_command_api.MonCommandApi(rados)¶

MonCommandApi is a class that provides access to the whole Ceph command line API in a type save way.

Usage:

>>> import rados
... from ceph_command_api import MonCommandApi
... cluster = rados.Rados(conffile='/etc/ceph/ceph.conf')
... cluster.connect()
... print(MonCommandApi(cluster).version())

add_bootstrap_peer_hint(addr)¶

add peer address as potential bootstrap peer for cluster bringup

Example command:

ceph add_bootstrap_peer_hint --addr=0.0.0.0

module=mon perm=rw flags=hidden, no_forward

Parameters:	addr (`str`) – CephIPAddr

add_bootstrap_peer_hintv(addrv)¶

add peer address vector as potential bootstrap peer for cluster bringup

Example command:

ceph add_bootstrap_peer_hintv --addrv=string

module=mon perm=rw flags=hidden, no_forward

Parameters:	addrv (`str`) –

alerts_send()¶

(re)send alerts immediately

Example command:

ceph alerts send

module=mgr perm=r flags=mgr

ansible_set_ssl_certificate(mgr_id=None)¶

Example command:

ceph ansible set-ssl-certificate --mgr_id=string

module=mgr perm=w flags=mgr

Parameters:	mgr_id (`Optional`[`str`]) –

ansible_set_ssl_certificate_key(mgr_id=None)¶

Example command:

ceph ansible set-ssl-certificate-key --mgr_id=string

module=mgr perm=w flags=mgr

Parameters:	mgr_id (`Optional`[`str`]) –

auth_add(entity, caps=None)¶

add auth info for <entity> from input file, or random key if no input is given, and/or any caps specified in the command

Example command:

ceph auth add --entity=string --caps=string

module=auth perm=rwx flags=

Parameters:	entity (`str`) – caps (`Optional`[`List`[`str`]]) –

auth_caps(entity, caps)¶

update caps for <name> from caps specified in the command

Example command:

ceph auth caps --entity=string --caps=string

module=auth perm=rwx flags=

Parameters:	entity (`str`) – caps (`List`[`str`]) –

auth_del(entity)¶

delete all caps for <name>

Example command:

ceph auth del --entity=string

module=auth perm=rwx flags=deprecated

Parameters:	entity (`str`) –

auth_export(entity=None)¶

write keyring for requested entity, or master keyring if none given

Example command:

ceph auth export --entity=string

module=auth perm=rx flags=

Parameters:	entity (`Optional`[`str`]) –

auth_get(entity)¶

write keyring file with requested key

Example command:

ceph auth get --entity=string

module=auth perm=rx flags=

Parameters:	entity (`str`) –

auth_get_key(entity)¶

display requested key

Example command:

ceph auth get-key --entity=string

module=auth perm=rx flags=

Parameters:	entity (`str`) –

auth_get_or_create(entity, caps=None)¶

add auth info for <entity> from input file, or random key if no input given, and/or any caps specified in the command

Example command:

ceph auth get-or-create --entity=string --caps=string

module=auth perm=rwx flags=

Parameters:	entity (`str`) – caps (`Optional`[`List`[`str`]]) –

auth_get_or_create_key(entity, caps=None)¶

get, or add, key for <name> from system/caps pairs specified in the command. If key already exists, any given caps must match the existing caps for that key.

Example command:

ceph auth get-or-create-key --entity=string --caps=string

module=auth perm=rwx flags=

Parameters:	entity (`str`) – caps (`Optional`[`List`[`str`]]) –

auth_import()¶

auth import: read keyring file from -i <file>

Example command:

ceph auth import

module=auth perm=rwx flags=

auth_list()¶

list authentication state

Example command:

ceph auth list

module=auth perm=rx flags=deprecated

auth_ls()¶

list authentication state

Example command:

ceph auth ls

module=auth perm=rx flags=

auth_rm(entity)¶

remove all caps for <name>

Example command:

ceph auth rm --entity=string

module=auth perm=rwx flags=

Parameters:	entity (`str`) –

balancer_dump(plan)¶

Show an optimization plan

Example command:

ceph balancer dump --plan=string

module=mgr perm=r flags=mgr

Parameters:	plan (`str`) –

balancer_eval(option=None)¶

Evaluate data distribution for the current cluster or specific pool or specific plan

Example command:

ceph balancer eval --option=string

module=mgr perm=r flags=mgr

Parameters:	option (`Optional`[`str`]) –

balancer_eval_verbose(option=None)¶

Evaluate data distribution for the current cluster or specific pool or specific plan (verbosely)

Example command:

ceph balancer eval-verbose --option=string

module=mgr perm=r flags=mgr

Parameters:	option (`Optional`[`str`]) –

balancer_execute(plan)¶

Execute an optimization plan

Example command:

ceph balancer execute --plan=string

module=mgr perm=rw flags=mgr

Parameters:	plan (`str`) –

balancer_ls()¶

List all plans

Example command:

ceph balancer ls

module=mgr perm=r flags=mgr

balancer_mode(mode)¶

Set balancer mode

Example command:

ceph balancer mode --mode=choice

module=mgr perm=rw flags=mgr

Parameters:	mode (`str`) – CephChoices strings=none\|crush-compat\|upmap

balancer_off()¶

Disable automatic balancing

Example command:

ceph balancer off

module=mgr perm=rw flags=mgr

balancer_on()¶

Enable automatic balancing

Example command:

ceph balancer on

module=mgr perm=rw flags=mgr

balancer_optimize(plan, pools=None)¶

Run optimizer to create a new plan

Example command:

ceph balancer optimize --plan=string --pools=string

module=mgr perm=rw flags=mgr

Parameters:	plan (`str`) – pools (`Optional`[`List`[`str`]]) –

balancer_pool_add(pools)¶

Enable automatic balancing for specific pools

Example command:

ceph balancer pool add --pools=string

module=mgr perm=rw flags=mgr

Parameters:	pools (`List`[`str`]) –

balancer_pool_ls()¶

List automatic balancing pools. Note that empty list means all existing pools will be automatic balancing targets, which is the default behaviour of balancer.

Example command:

ceph balancer pool ls

module=mgr perm=r flags=mgr

balancer_pool_rm(pools)¶

Disable automatic balancing for specific pools

Example command:

ceph balancer pool rm --pools=string

module=mgr perm=rw flags=mgr

Parameters:	pools (`List`[`str`]) –

balancer_reset()¶

Discard all optimization plans

Example command:

ceph balancer reset

module=mgr perm=rw flags=mgr

balancer_rm(plan)¶

Discard an optimization plan

Example command:

ceph balancer rm --plan=string

module=mgr perm=rw flags=mgr

Parameters:	plan (`str`) –

balancer_show(plan)¶

Show details of an optimization plan

Example command:

ceph balancer show --plan=string

module=mgr perm=r flags=mgr

Parameters:	plan (`str`) –

balancer_status()¶

Show balancer status

Example command:

ceph balancer status

module=mgr perm=r flags=mgr

cephadm_check_host(host)¶

Check whether we can access and manage a remote host

Example command:

ceph cephadm check-host --host=string

module=mgr perm=r flags=mgr

Parameters:	host (`str`) –

cephadm_clear_key()¶

Clear cluster SSH key

Example command:

ceph cephadm clear-key

module=mgr perm=rw flags=mgr

cephadm_clear_ssh_config()¶

Clear the ssh_config file

Example command:

ceph cephadm clear-ssh-config

module=mgr perm=rw flags=mgr

cephadm_generate_key()¶

Generate a cluster SSH key (if not present)

Example command:

ceph cephadm generate-key

module=mgr perm=rw flags=mgr

cephadm_get_pub_key()¶

Show SSH public key for connecting to cluster hosts

Example command:

ceph cephadm get-pub-key

module=mgr perm=r flags=mgr

cephadm_get_user()¶

Show user for SSHing to cluster hosts

Example command:

ceph cephadm get-user

module=mgr perm=r flags=mgr

cephadm_set_ssh_config()¶

Set the ssh_config file (use -i <ssh_config>)

Example command:

ceph cephadm set-ssh-config

module=mgr perm=rw flags=mgr

compact()¶

cause compaction of monitor’s leveldb/rocksdb storage

Example command:

ceph compact

module=mon perm=rw flags=hidden, no_forward

config_assimilate_conf()¶

Assimilate options from a conf, and return a new, minimal conf file

Example command:

ceph config assimilate-conf

module=config perm=rw flags=

config_dump()¶

Show all configuration option(s)

Example command:

ceph config dump

module=mon perm=r flags=

config_generate_minimal_conf()¶

Generate a minimal ceph.conf file

Example command:

ceph config generate-minimal-conf

module=config perm=r flags=

config_get(who, key)¶

Show configuration option(s) for an entity

Example command:

ceph config get --who=string --key=string

module=config perm=r flags=

Parameters:	who (`str`) – key (`str`) –

config_help(key)¶

Describe a configuration option

Example command:

ceph config help --key=string

module=config perm=r flags=

Parameters:	key (`str`) –

config_key_del(key)¶

delete <key>

Example command:

ceph config-key del --key=string

module=config-key perm=rw flags=deprecated

Parameters:	key (`str`) –

config_key_dump(key=None)¶

dump keys and values (with optional prefix)

Example command:

ceph config-key dump --key=string

module=config-key perm=r flags=

Parameters:	key (`Optional`[`str`]) –

config_key_exists(key)¶

check for <key>’s existence

Example command:

ceph config-key exists --key=string

module=config-key perm=r flags=

Parameters:	key (`str`) –

config_key_get(key)¶

get <key>

Example command:

ceph config-key get --key=string

module=config-key perm=r flags=

Parameters:	key (`str`) –

config_key_list()¶

list keys

Example command:

ceph config-key list

module=config-key perm=r flags=deprecated

config_key_ls()¶

list keys

Example command:

ceph config-key ls

module=config-key perm=r flags=

config_key_put(key, val=None)¶

put <key>, value <val>

Example command:

ceph config-key put --key=string --val=string

module=config-key perm=rw flags=deprecated

Parameters:	key (`str`) – val (`Optional`[`str`]) –

config_key_rm(key)¶

rm <key>

Example command:

ceph config-key rm --key=string

module=config-key perm=rw flags=

Parameters:	key (`str`) –

config_key_set(key, val=None)¶

set <key> to value <val>

Example command:

ceph config-key set --key=string --val=string

module=config-key perm=rw flags=

Parameters:	key (`str`) – val (`Optional`[`str`]) –

config_log(num)¶

Show recent history of config changes

Example command:

ceph config log --num=1

module=config perm=r flags=

Parameters:	num (`int`) – CephInt

config_ls()¶

List available configuration options

Example command:

ceph config ls

module=config perm=r flags=

config_reset(num)¶

Revert configuration to a historical version specified by <num>

Example command:

ceph config reset --num=1

module=config perm=rw flags=

Parameters:	num (`int`) – CephInt range= `0`

config_rm(who, name)¶

Clear a configuration option for one or more entities

Example command:

ceph config rm --who=string --name=string

module=config perm=rw flags=

Parameters:	who (`str`) – name (`str`) –

config_set(who, name, value, force=None)¶

Set a configuration option for one or more entities

Example command:

ceph config set --who=string --name=string --value=string --force=true

module=config perm=rw flags=

Parameters:	who (`str`) – name (`str`) – value (`str`) – force (`Optional`[`bool`]) – CephBool

config_show(who, key)¶

Show running configuration

Example command:

ceph config show --who=string --key=string

module=mgr perm=r flags=mgr

Parameters:	who (`str`) – key (`str`) –

config_show_with_defaults(who)¶

Show running configuration (including compiled-in defaults)

Example command:

ceph config show-with-defaults --who=string

module=mgr perm=r flags=mgr

Parameters:	who (`str`) –

count(num)¶

Do some counting

Example command:

ceph count --num=1

module=mgr perm=r flags=mgr

Parameters:	num (`int`) – CephInt

crash_archive(id_1)¶

Acknowledge a crash and silence health warning(s)

Example command:

ceph crash archive --id=string

module=mgr perm=w flags=mgr

Parameters:	id_1 (`str`) – Real name is `id`

crash_archive_all()¶

Acknowledge all new crashes and silence health warning(s)

Example command:

ceph crash archive-all

module=mgr perm=w flags=mgr

crash_info(id_1)¶

show crash dump metadata

Example command:

ceph crash info --id=string

module=mgr perm=r flags=mgr

Parameters:	id_1 (`str`) – Real name is `id`

crash_json_report(hours)¶

Crashes in the last <hours> hours

Example command:

ceph crash json_report --hours=string

module=mgr perm=r flags=mgr

Parameters:	hours (`str`) –

crash_ls()¶

Show new and archived crash dumps

Example command:

ceph crash ls

module=mgr perm=r flags=mgr

crash_ls_new()¶

Show new crash dumps

Example command:

ceph crash ls-new

module=mgr perm=r flags=mgr

crash_post()¶

Add a crash dump (use -i <jsonfile>)

Example command:

ceph crash post

module=mgr perm=rw flags=mgr

crash_prune(keep)¶

Remove crashes older than <keep> days

Example command:

ceph crash prune --keep=string

module=mgr perm=rw flags=mgr

Parameters:	keep (`str`) –

crash_rm(id_1)¶

Remove a saved crash <id>

Example command:

ceph crash rm --id=string

module=mgr perm=rw flags=mgr

Parameters:	id_1 (`str`) – Real name is `id`

crash_stat()¶

Summarize recorded crashes

Example command:

ceph crash stat

module=mgr perm=r flags=mgr

dashboard_ac_role_add_scope_perms(rolename, scopename, permissions)¶

Add the scope permissions for a role

Example command:

ceph dashboard ac-role-add-scope-perms --rolename=string --scopename=string --permissions=string

module=mgr perm=w flags=mgr

Parameters:	rolename (`str`) – scopename (`str`) – permissions (`List`[`str`]) –

dashboard_ac_role_create(rolename, description=None)¶

Create a new access control role

Example command:

ceph dashboard ac-role-create --rolename=string --description=string

module=mgr perm=w flags=mgr

Parameters:	rolename (`str`) – description (`Optional`[`str`]) –

dashboard_ac_role_del_scope_perms(rolename, scopename)¶

Delete the scope permissions for a role

Example command:

ceph dashboard ac-role-del-scope-perms --rolename=string --scopename=string

module=mgr perm=w flags=mgr

Parameters:	rolename (`str`) – scopename (`str`) –

dashboard_ac_role_delete(rolename)¶

Delete an access control role

Example command:

ceph dashboard ac-role-delete --rolename=string

module=mgr perm=w flags=mgr

Parameters:	rolename (`str`) –

dashboard_ac_role_show(rolename=None)¶

Show role info

Example command:

ceph dashboard ac-role-show --rolename=string

module=mgr perm=r flags=mgr

Parameters:	rolename (`Optional`[`str`]) –

dashboard_ac_user_add_roles(username, roles)¶

Add roles to user

Example command:

ceph dashboard ac-user-add-roles --username=string --roles=string

module=mgr perm=w flags=mgr

Parameters:	username (`str`) – roles (`List`[`str`]) –

dashboard_ac_user_create(username, password=None, rolename=None, name=None, email=None, enabled=None, force_password=None, pwd_expiration_date=None)¶

Create a user

Example command:

ceph dashboard ac-user-create --username=string --password=string --rolename=string --name=string --email=string --enabled=true --force_password=true --pwd_expiration_date=1

module=mgr perm=w flags=mgr

Parameters:	username (`str`) – password (`Optional`[`str`]) – rolename (`Optional`[`str`]) – name (`Optional`[`str`]) – email (`Optional`[`str`]) – enabled (`Optional`[`bool`]) – CephBool force_password (`Optional`[`bool`]) – CephBool pwd_expiration_date (`Optional`[`int`]) – CephInt

dashboard_ac_user_del_roles(username, roles)¶

Delete roles from user

Example command:

ceph dashboard ac-user-del-roles --username=string --roles=string

module=mgr perm=w flags=mgr

Parameters:	username (`str`) – roles (`List`[`str`]) –

dashboard_ac_user_delete(username)¶

Delete user

Example command:

ceph dashboard ac-user-delete --username=string

module=mgr perm=w flags=mgr

Parameters:	username (`str`) –

dashboard_ac_user_disable(username)¶

Disable a user

Example command:

ceph dashboard ac-user-disable --username=string

module=mgr perm=w flags=mgr

Parameters:	username (`str`) –

dashboard_ac_user_enable(username)¶

Enable a user

Example command:

ceph dashboard ac-user-enable --username=string

module=mgr perm=w flags=mgr

Parameters:	username (`str`) –

dashboard_ac_user_set_info(username, name, email)¶

Set user info

Example command:

ceph dashboard ac-user-set-info --username=string --name=string --email=string

module=mgr perm=w flags=mgr

Parameters:	username (`str`) – name (`str`) – email (`str`) –

dashboard_ac_user_set_password(username, password, force_password=None)¶

Set user password

Example command:

ceph dashboard ac-user-set-password --username=string --password=string --force_password=true

module=mgr perm=w flags=mgr

Parameters:	username (`str`) – password (`str`) – force_password (`Optional`[`bool`]) – CephBool

dashboard_ac_user_set_password_hash(username, hashed_password)¶

Set user password bcrypt hash

Example command:

ceph dashboard ac-user-set-password-hash --username=string --hashed_password=string

module=mgr perm=w flags=mgr

Parameters:	username (`str`) – hashed_password (`str`) –

dashboard_ac_user_set_roles(username, roles)¶

Set user roles

Example command:

ceph dashboard ac-user-set-roles --username=string --roles=string

module=mgr perm=w flags=mgr

Parameters:	username (`str`) – roles (`List`[`str`]) –

dashboard_ac_user_show(username=None)¶

Show user info

Example command:

ceph dashboard ac-user-show --username=string

module=mgr perm=r flags=mgr

Parameters:	username (`Optional`[`str`]) –

dashboard_create_self_signed_cert()¶

Create self signed certificate

Example command:

ceph dashboard create-self-signed-cert

module=mgr perm=w flags=mgr

dashboard_debug(action)¶

Control and report debug status in Ceph-Dashboard

Example command:

ceph dashboard debug --action=choice

module=mgr perm=rw flags=mgr

Parameters:	action (`str`) – CephChoices strings=enable\|disable\|status

dashboard_feature(action, features=None)¶

Enable or disable features in Ceph-Mgr Dashboard

Example command:

ceph dashboard feature --action=choice --features=choice

module=mgr perm=rw flags=mgr

Parameters:	action (`str`) – CephChoices strings=enable\|disable\|status features (`Optional`[`List`[`str`]]) – CephChoices strings=rbd\|mirroring\|iscsi\|cephfs\|rgw

dashboard_get_alertmanager_api_host()¶

Get the ALERTMANAGER_API_HOST option value

Example command:

ceph dashboard get-alertmanager-api-host

module=mgr perm=r flags=mgr

dashboard_get_audit_api_enabled()¶

Get the AUDIT_API_ENABLED option value

Example command:

ceph dashboard get-audit-api-enabled

module=mgr perm=r flags=mgr

dashboard_get_audit_api_log_payload()¶

Get the AUDIT_API_LOG_PAYLOAD option value

Example command:

ceph dashboard get-audit-api-log-payload

module=mgr perm=r flags=mgr

dashboard_get_enable_browsable_api()¶

Get the ENABLE_BROWSABLE_API option value

Example command:

ceph dashboard get-enable-browsable-api

module=mgr perm=r flags=mgr

dashboard_get_ganesha_clusters_rados_pool_namespace()¶

Get the GANESHA_CLUSTERS_RADOS_POOL_NAMESPACE option value

Example command:

ceph dashboard get-ganesha-clusters-rados-pool-namespace

module=mgr perm=r flags=mgr

dashboard_get_grafana_api_password()¶

Get the GRAFANA_API_PASSWORD option value

Example command:

ceph dashboard get-grafana-api-password

module=mgr perm=r flags=mgr

dashboard_get_grafana_api_ssl_verify()¶

Get the GRAFANA_API_SSL_VERIFY option value

Example command:

ceph dashboard get-grafana-api-ssl-verify

module=mgr perm=r flags=mgr

dashboard_get_grafana_api_url()¶

Get the GRAFANA_API_URL option value

Example command:

ceph dashboard get-grafana-api-url

module=mgr perm=r flags=mgr

dashboard_get_grafana_api_username()¶

Get the GRAFANA_API_USERNAME option value

Example command:

ceph dashboard get-grafana-api-username

module=mgr perm=r flags=mgr

dashboard_get_grafana_update_dashboards()¶

Get the GRAFANA_UPDATE_DASHBOARDS option value

Example command:

ceph dashboard get-grafana-update-dashboards

module=mgr perm=r flags=mgr

dashboard_get_iscsi_api_ssl_verification()¶

Get the ISCSI_API_SSL_VERIFICATION option value

Example command:

ceph dashboard get-iscsi-api-ssl-verification

module=mgr perm=r flags=mgr

dashboard_get_jwt_token_ttl()¶

Get the JWT token TTL in seconds

Example command:

ceph dashboard get-jwt-token-ttl

module=mgr perm=r flags=mgr

dashboard_get_prometheus_api_host()¶

Get the PROMETHEUS_API_HOST option value

Example command:

ceph dashboard get-prometheus-api-host

module=mgr perm=r flags=mgr

dashboard_get_rest_requests_timeout()¶

Get the REST_REQUESTS_TIMEOUT option value

Example command:

ceph dashboard get-rest-requests-timeout

module=mgr perm=r flags=mgr

dashboard_get_rgw_api_access_key()¶

Get the RGW_API_ACCESS_KEY option value

Example command:

ceph dashboard get-rgw-api-access-key

module=mgr perm=r flags=mgr

dashboard_get_rgw_api_admin_resource()¶

Get the RGW_API_ADMIN_RESOURCE option value

Example command:

ceph dashboard get-rgw-api-admin-resource

module=mgr perm=r flags=mgr

dashboard_get_rgw_api_host()¶

Get the RGW_API_HOST option value

Example command:

ceph dashboard get-rgw-api-host

module=mgr perm=r flags=mgr

dashboard_get_rgw_api_port()¶

Get the RGW_API_PORT option value

Example command:

ceph dashboard get-rgw-api-port

module=mgr perm=r flags=mgr

dashboard_get_rgw_api_scheme()¶

Get the RGW_API_SCHEME option value

Example command:

ceph dashboard get-rgw-api-scheme

module=mgr perm=r flags=mgr

dashboard_get_rgw_api_secret_key()¶

Get the RGW_API_SECRET_KEY option value

Example command:

ceph dashboard get-rgw-api-secret-key

module=mgr perm=r flags=mgr

dashboard_get_rgw_api_ssl_verify()¶

Get the RGW_API_SSL_VERIFY option value

Example command:

ceph dashboard get-rgw-api-ssl-verify

module=mgr perm=r flags=mgr

dashboard_get_rgw_api_user_id()¶

Get the RGW_API_USER_ID option value

Example command:

ceph dashboard get-rgw-api-user-id

module=mgr perm=r flags=mgr

dashboard_get_user_pwd_expiration_span()¶

Get the USER_PWD_EXPIRATION_SPAN option value

Example command:

ceph dashboard get-user-pwd-expiration-span

module=mgr perm=r flags=mgr

dashboard_get_user_pwd_expiration_warning_1()¶

Get the USER_PWD_EXPIRATION_WARNING_1 option value

Example command:

ceph dashboard get-user-pwd-expiration-warning-1

module=mgr perm=r flags=mgr

dashboard_get_user_pwd_expiration_warning_2()¶

Get the USER_PWD_EXPIRATION_WARNING_2 option value

Example command:

ceph dashboard get-user-pwd-expiration-warning-2

module=mgr perm=r flags=mgr

dashboard_grafana_dashboards_update()¶

Push dashboards to Grafana

Example command:

ceph dashboard grafana dashboards update

module=mgr perm=w flags=mgr

dashboard_iscsi_gateway_add(service_url)¶

Add iSCSI gateway configuration

Example command:

ceph dashboard iscsi-gateway-add --service_url=string

module=mgr perm=w flags=mgr

Parameters:	service_url (`str`) –

dashboard_iscsi_gateway_list()¶

List iSCSI gateways

Example command:

ceph dashboard iscsi-gateway-list

module=mgr perm=r flags=mgr

dashboard_iscsi_gateway_rm(name)¶

Remove iSCSI gateway configuration

Example command:

ceph dashboard iscsi-gateway-rm --name=string

module=mgr perm=w flags=mgr

Parameters:	name (`str`) –

dashboard_reset_alertmanager_api_host()¶

Reset the ALERTMANAGER_API_HOST option to its default value

Example command:

ceph dashboard reset-alertmanager-api-host

module=mgr perm=w flags=mgr

dashboard_reset_audit_api_enabled()¶

Reset the AUDIT_API_ENABLED option to its default value

Example command:

ceph dashboard reset-audit-api-enabled

module=mgr perm=w flags=mgr

dashboard_reset_audit_api_log_payload()¶

Reset the AUDIT_API_LOG_PAYLOAD option to its default value

Example command:

ceph dashboard reset-audit-api-log-payload

module=mgr perm=w flags=mgr

dashboard_reset_enable_browsable_api()¶

Reset the ENABLE_BROWSABLE_API option to its default value

Example command:

ceph dashboard reset-enable-browsable-api

module=mgr perm=w flags=mgr

dashboard_reset_ganesha_clusters_rados_pool_namespace()¶

Reset the GANESHA_CLUSTERS_RADOS_POOL_NAMESPACE option to its default value

Example command:

ceph dashboard reset-ganesha-clusters-rados-pool-namespace

module=mgr perm=w flags=mgr

dashboard_reset_grafana_api_password()¶

Reset the GRAFANA_API_PASSWORD option to its default value

Example command:

ceph dashboard reset-grafana-api-password

module=mgr perm=w flags=mgr

dashboard_reset_grafana_api_ssl_verify()¶

Reset the GRAFANA_API_SSL_VERIFY option to its default value

Example command:

ceph dashboard reset-grafana-api-ssl-verify

module=mgr perm=w flags=mgr

dashboard_reset_grafana_api_url()¶

Reset the GRAFANA_API_URL option to its default value

Example command:

ceph dashboard reset-grafana-api-url

module=mgr perm=w flags=mgr

dashboard_reset_grafana_api_username()¶

Reset the GRAFANA_API_USERNAME option to its default value

Example command:

ceph dashboard reset-grafana-api-username

module=mgr perm=w flags=mgr

dashboard_reset_grafana_update_dashboards()¶

Reset the GRAFANA_UPDATE_DASHBOARDS option to its default value

Example command:

ceph dashboard reset-grafana-update-dashboards

module=mgr perm=w flags=mgr

dashboard_reset_iscsi_api_ssl_verification()¶

Reset the ISCSI_API_SSL_VERIFICATION option to its default value

Example command:

ceph dashboard reset-iscsi-api-ssl-verification

module=mgr perm=w flags=mgr

dashboard_reset_prometheus_api_host()¶

Reset the PROMETHEUS_API_HOST option to its default value

Example command:

ceph dashboard reset-prometheus-api-host

module=mgr perm=w flags=mgr

dashboard_reset_rest_requests_timeout()¶

Reset the REST_REQUESTS_TIMEOUT option to its default value

Example command:

ceph dashboard reset-rest-requests-timeout

module=mgr perm=w flags=mgr

dashboard_reset_rgw_api_access_key()¶

Reset the RGW_API_ACCESS_KEY option to its default value

Example command:

ceph dashboard reset-rgw-api-access-key

module=mgr perm=w flags=mgr

dashboard_reset_rgw_api_admin_resource()¶

Reset the RGW_API_ADMIN_RESOURCE option to its default value

Example command:

ceph dashboard reset-rgw-api-admin-resource

module=mgr perm=w flags=mgr

dashboard_reset_rgw_api_host()¶

Reset the RGW_API_HOST option to its default value

Example command:

ceph dashboard reset-rgw-api-host

module=mgr perm=w flags=mgr

dashboard_reset_rgw_api_port()¶

Reset the RGW_API_PORT option to its default value

Example command:

ceph dashboard reset-rgw-api-port

module=mgr perm=w flags=mgr

dashboard_reset_rgw_api_scheme()¶

Reset the RGW_API_SCHEME option to its default value

Example command:

ceph dashboard reset-rgw-api-scheme

module=mgr perm=w flags=mgr

dashboard_reset_rgw_api_secret_key()¶

Reset the RGW_API_SECRET_KEY option to its default value

Example command:

ceph dashboard reset-rgw-api-secret-key

module=mgr perm=w flags=mgr

dashboard_reset_rgw_api_ssl_verify()¶

Reset the RGW_API_SSL_VERIFY option to its default value

Example command:

ceph dashboard reset-rgw-api-ssl-verify

module=mgr perm=w flags=mgr

dashboard_reset_rgw_api_user_id()¶

Reset the RGW_API_USER_ID option to its default value

Example command:

ceph dashboard reset-rgw-api-user-id

module=mgr perm=w flags=mgr

dashboard_reset_user_pwd_expiration_span()¶

Reset the USER_PWD_EXPIRATION_SPAN option to its default value

Example command:

ceph dashboard reset-user-pwd-expiration-span

module=mgr perm=w flags=mgr

dashboard_reset_user_pwd_expiration_warning_1()¶

Reset the USER_PWD_EXPIRATION_WARNING_1 option to its default value

Example command:

ceph dashboard reset-user-pwd-expiration-warning-1

module=mgr perm=w flags=mgr

dashboard_reset_user_pwd_expiration_warning_2()¶

Reset the USER_PWD_EXPIRATION_WARNING_2 option to its default value

Example command:

ceph dashboard reset-user-pwd-expiration-warning-2

module=mgr perm=w flags=mgr

dashboard_set_alertmanager_api_host(value)¶

Set the ALERTMANAGER_API_HOST option value

Example command:

ceph dashboard set-alertmanager-api-host --value=string

module=mgr perm=w flags=mgr

Parameters:	value (`str`) –

dashboard_set_audit_api_enabled(value)¶

Set the AUDIT_API_ENABLED option value

Example command:

ceph dashboard set-audit-api-enabled --value=string

module=mgr perm=w flags=mgr

Parameters:	value (`str`) –

dashboard_set_audit_api_log_payload(value)¶

Set the AUDIT_API_LOG_PAYLOAD option value

Example command:

ceph dashboard set-audit-api-log-payload --value=string

module=mgr perm=w flags=mgr

Parameters:	value (`str`) –

dashboard_set_enable_browsable_api(value)¶

Set the ENABLE_BROWSABLE_API option value

Example command:

ceph dashboard set-enable-browsable-api --value=string

module=mgr perm=w flags=mgr

Parameters:	value (`str`) –

dashboard_set_ganesha_clusters_rados_pool_namespace(value)¶

Set the GANESHA_CLUSTERS_RADOS_POOL_NAMESPACE option value

Example command:

ceph dashboard set-ganesha-clusters-rados-pool-namespace --value=string

module=mgr perm=w flags=mgr

Parameters:	value (`str`) –

dashboard_set_grafana_api_password(value)¶

Set the GRAFANA_API_PASSWORD option value

Example command:

ceph dashboard set-grafana-api-password --value=string

module=mgr perm=w flags=mgr

Parameters:	value (`str`) –

dashboard_set_grafana_api_ssl_verify(value)¶

Set the GRAFANA_API_SSL_VERIFY option value

Example command:

ceph dashboard set-grafana-api-ssl-verify --value=string

module=mgr perm=w flags=mgr

Parameters:	value (`str`) –

dashboard_set_grafana_api_url(value)¶

Set the GRAFANA_API_URL option value

Example command:

ceph dashboard set-grafana-api-url --value=string

module=mgr perm=w flags=mgr

Parameters:	value (`str`) –

dashboard_set_grafana_api_username(value)¶

Set the GRAFANA_API_USERNAME option value

Example command:

ceph dashboard set-grafana-api-username --value=string

module=mgr perm=w flags=mgr

Parameters:	value (`str`) –

dashboard_set_grafana_update_dashboards(value)¶

Set the GRAFANA_UPDATE_DASHBOARDS option value

Example command:

ceph dashboard set-grafana-update-dashboards --value=string

module=mgr perm=w flags=mgr

Parameters:	value (`str`) –

dashboard_set_iscsi_api_ssl_verification(value)¶

Set the ISCSI_API_SSL_VERIFICATION option value

Example command:

ceph dashboard set-iscsi-api-ssl-verification --value=string

module=mgr perm=w flags=mgr

Parameters:	value (`str`) –

dashboard_set_jwt_token_ttl(seconds)¶

Set the JWT token TTL in seconds

Example command:

ceph dashboard set-jwt-token-ttl --seconds=1

module=mgr perm=w flags=mgr

Parameters:	seconds (`int`) – CephInt

dashboard_set_login_credentials(username, password)¶

Set the login credentials

Example command:

ceph dashboard set-login-credentials --username=string --password=string

module=mgr perm=w flags=mgr

Parameters:	username (`str`) – password (`str`) –

dashboard_set_prometheus_api_host(value)¶

Set the PROMETHEUS_API_HOST option value

Example command:

ceph dashboard set-prometheus-api-host --value=string

module=mgr perm=w flags=mgr

Parameters:	value (`str`) –

dashboard_set_rest_requests_timeout(value)¶

Set the REST_REQUESTS_TIMEOUT option value

Example command:

ceph dashboard set-rest-requests-timeout --value=1

module=mgr perm=w flags=mgr

Parameters:	value (`int`) – CephInt

dashboard_set_rgw_api_access_key(value)¶

Set the RGW_API_ACCESS_KEY option value

Example command:

ceph dashboard set-rgw-api-access-key --value=string

module=mgr perm=w flags=mgr

Parameters:	value (`str`) –

dashboard_set_rgw_api_admin_resource(value)¶

Set the RGW_API_ADMIN_RESOURCE option value

Example command:

ceph dashboard set-rgw-api-admin-resource --value=string

module=mgr perm=w flags=mgr

Parameters:	value (`str`) –

dashboard_set_rgw_api_host(value)¶

Set the RGW_API_HOST option value

Example command:

ceph dashboard set-rgw-api-host --value=string

module=mgr perm=w flags=mgr

Parameters:	value (`str`) –

dashboard_set_rgw_api_port(value)¶

Set the RGW_API_PORT option value

Example command:

ceph dashboard set-rgw-api-port --value=1

module=mgr perm=w flags=mgr

Parameters:	value (`int`) – CephInt

dashboard_set_rgw_api_scheme(value)¶

Set the RGW_API_SCHEME option value

Example command:

ceph dashboard set-rgw-api-scheme --value=string

module=mgr perm=w flags=mgr

Parameters:	value (`str`) –

dashboard_set_rgw_api_secret_key(value)¶

Set the RGW_API_SECRET_KEY option value

Example command:

ceph dashboard set-rgw-api-secret-key --value=string

module=mgr perm=w flags=mgr

Parameters:	value (`str`) –

dashboard_set_rgw_api_ssl_verify(value)¶

Set the RGW_API_SSL_VERIFY option value

Example command:

ceph dashboard set-rgw-api-ssl-verify --value=string

module=mgr perm=w flags=mgr

Parameters:	value (`str`) –

dashboard_set_rgw_api_user_id(value)¶

Set the RGW_API_USER_ID option value

Example command:

ceph dashboard set-rgw-api-user-id --value=string

module=mgr perm=w flags=mgr

Parameters:	value (`str`) –

dashboard_set_ssl_certificate(mgr_id=None)¶

Example command:

ceph dashboard set-ssl-certificate --mgr_id=string

module=mgr perm=w flags=mgr

Parameters:	mgr_id (`Optional`[`str`]) –

dashboard_set_ssl_certificate_key(mgr_id=None)¶

Example command:

ceph dashboard set-ssl-certificate-key --mgr_id=string

module=mgr perm=w flags=mgr

Parameters:	mgr_id (`Optional`[`str`]) –

dashboard_set_user_pwd_expiration_span(value)¶

Set the USER_PWD_EXPIRATION_SPAN option value

Example command:

ceph dashboard set-user-pwd-expiration-span --value=1

module=mgr perm=w flags=mgr

Parameters:	value (`int`) – CephInt

dashboard_set_user_pwd_expiration_warning_1(value)¶

Set the USER_PWD_EXPIRATION_WARNING_1 option value

Example command:

ceph dashboard set-user-pwd-expiration-warning-1 --value=1

module=mgr perm=w flags=mgr

Parameters:	value (`int`) – CephInt

dashboard_set_user_pwd_expiration_warning_2(value)¶

Set the USER_PWD_EXPIRATION_WARNING_2 option value

Example command:

ceph dashboard set-user-pwd-expiration-warning-2 --value=1

module=mgr perm=w flags=mgr

Parameters:	value (`int`) – CephInt

dashboard_sso_disable()¶

Disable Single Sign-On

Example command:

ceph dashboard sso disable

module=mgr perm=w flags=mgr

dashboard_sso_enable_saml2()¶

Enable SAML2 Single Sign-On

Example command:

ceph dashboard sso enable saml2

module=mgr perm=w flags=mgr

dashboard_sso_setup_saml2(ceph_dashboard_base_url, idp_metadata, idp_username_attribute=None, idp_entity_id=None, sp_x_509_cert=None, sp_private_key=None)¶

Setup SAML2 Single Sign-On

Example command:

ceph dashboard sso setup saml2 --ceph_dashboard_base_url=string --idp_metadata=string --idp_username_attribute=string --idp_entity_id=string --sp_x_509_cert=/path/to/file --sp_private_key=/path/to/file

module=mgr perm=w flags=mgr

Parameters:	ceph_dashboard_base_url (`str`) – idp_metadata (`str`) – idp_username_attribute (`Optional`[`str`]) – idp_entity_id (`Optional`[`str`]) – sp_x_509_cert (`Optional`[`str`]) – CephFilepath sp_private_key (`Optional`[`str`]) – CephFilepath

dashboard_sso_show_saml2()¶

Show SAML2 configuration

Example command:

ceph dashboard sso show saml2

module=mgr perm=r flags=mgr

dashboard_sso_status()¶

Get Single Sign-On status

Example command:

ceph dashboard sso status

module=mgr perm=r flags=mgr

deepsea_config_set(key, value)¶

Set a configuration value

Example command:

ceph deepsea config-set --key=string --value=string

module=mgr perm=rw flags=mgr

Parameters:	key (`str`) – value (`str`) –

deepsea_config_show()¶

Show current configuration

Example command:

ceph deepsea config-show

module=mgr perm=r flags=mgr

device_check_health()¶

Check life expectancy of devices

Example command:

ceph device check-health

module=mgr perm=rw flags=mgr

device_debug_metrics_forced()¶

Run metrics agent forced

Example command:

ceph device debug metrics-forced

module=mgr perm=r flags=mgr

device_debug_smart_forced()¶

Run smart agent forced

Example command:

ceph device debug smart-forced

module=mgr perm=r flags=mgr

device_get_health_metrics(devid, sample)¶

Show stored device metrics for the device

Example command:

ceph device get-health-metrics --devid=string --sample=string

module=mgr perm=r flags=mgr

Parameters:	devid (`str`) – sample (`str`) –

device_info(devid)¶

Show information about a device

Example command:

ceph device info --devid=string

module=mgr perm=r flags=mgr

Parameters:	devid (`str`) –

device_light(enable, devid, light_type=None, force=None)¶

Enable or disable the device light. Default type is ident Usage: device light (on|off) <devid> [ident|fault] [–force]

Example command:

ceph device light --enable=choice --devid=string --light_type=choice --force=true

module=mgr perm=rw flags=mgr

Parameters:	enable (`str`) – CephChoices strings=on\|off devid (`str`) – light_type (`Optional`[`str`]) – CephChoices strings=ident\|fault force (`Optional`[`bool`]) – CephBool

device_ls()¶

Show devices

Example command:

ceph device ls

module=mgr perm=r flags=mgr

device_ls_by_daemon(who)¶

Show devices associated with a daemon

Example command:

ceph device ls-by-daemon --who=string

module=mgr perm=r flags=mgr

Parameters:	who (`str`) –

device_ls_by_host(host)¶

Show devices on a host

Example command:

ceph device ls-by-host --host=string

module=mgr perm=r flags=mgr

Parameters:	host (`str`) –

device_ls_lights()¶

List currently active device indicator lights

Example command:

ceph device ls-lights

module=mgr perm=r flags=mgr

device_monitoring_off()¶

Disable device health monitoring

Example command:

ceph device monitoring off

module=mgr perm=rw flags=mgr

device_monitoring_on()¶

Enable device health monitoring

Example command:

ceph device monitoring on

module=mgr perm=rw flags=mgr

device_predict_life_expectancy(devid)¶

Predict life expectancy with local predictor

Example command:

ceph device predict-life-expectancy --devid=string

module=mgr perm=r flags=mgr

Parameters:	devid (`str`) –

device_query_daemon_health_metrics(who)¶

Get device health metrics for a given daemon

Example command:

ceph device query-daemon-health-metrics --who=string

module=mgr perm=r flags=mgr

Parameters:	who (`str`) –

device_rm_life_expectancy(devid)¶

Clear predicted device life expectancy

Example command:

ceph device rm-life-expectancy --devid=string

module=mgr perm=rw flags=mgr

Parameters:	devid (`str`) –

device_scrape_daemon_health_metrics(who)¶

Scrape and store device health metrics for a given daemon

Example command:

ceph device scrape-daemon-health-metrics --who=string

module=mgr perm=r flags=mgr

Parameters:	who (`str`) –

device_scrape_health_metrics(devid)¶

Scrape and store health metrics

Example command:

ceph device scrape-health-metrics --devid=string

module=mgr perm=r flags=mgr

Parameters:	devid (`str`) –

device_set_cloud_prediction_config(server, user, password, certfile, port=None)¶

Configure Disk Prediction service

Example command:

ceph device set-cloud-prediction-config --server=string --user=string --password=string --certfile=string --port=string

module=mgr perm=rw flags=mgr

Parameters:	server (`str`) – user (`str`) – password (`str`) – certfile (`str`) – port (`Optional`[`str`]) –

device_set_life_expectancy(devid, from_1, to)¶

Set predicted device life expectancy

Example command:

ceph device set-life-expectancy --devid=string --from=string --to=string

module=mgr perm=rw flags=mgr

Parameters:	devid (`str`) – from_1 (`str`) – Real name is `from` to (`str`) –

device_show_prediction_config()¶

Prints diskprediction configuration

Example command:

ceph device show-prediction-config

module=mgr perm=r flags=mgr

df(detail=None)¶

show cluster free space stats

Example command:

ceph df --detail=choice

module=mon perm=r flags=

Parameters:	detail (`Optional`[`str`]) – CephChoices strings=detail

diskprediction_cloud_status()¶

Check diskprediction_cloud status

Example command:

ceph diskprediction_cloud status

module=mgr perm=r flags=mgr

dump_historic_ops()¶

Example command:

ceph dump_historic_ops

module=mon perm=r flags=hidden, no_forward

features()¶

report of connected features

Example command:

ceph features

module=mon perm=r flags=

fs_add_data_pool(fs_name, pool)¶

add data pool <pool>

Example command:

ceph fs add_data_pool --fs_name=string --pool=string

module=mds perm=rw flags=

Parameters:	fs_name (`str`) – pool (`str`) –

fs_authorize(filesystem, entity, caps)¶

add auth for <entity> to access file system <filesystem> based on following directory and permissions pairs

Example command:

ceph fs authorize --filesystem=string --entity=string --caps=string

module=auth perm=rwx flags=

Parameters:	filesystem (`str`) – entity (`str`) – caps (`List`[`str`]) –

fs_dump(epoch=None)¶

dump all CephFS status, optionally from epoch

Example command:

ceph fs dump --epoch=1

module=mds perm=r flags=

Parameters:	epoch (`Optional`[`int`]) – CephInt range= `0`

fs_fail(fs_name)¶

bring the file system down and all of its ranks

Example command:

ceph fs fail --fs_name=string

module=fs perm=rw flags=

Parameters:	fs_name (`str`) –

fs_flag_set(flag_name, val, yes_i_really_mean_it=None)¶

Set a global CephFS flag

Example command:

ceph fs flag set --flag_name=choice --val=string --yes_i_really_mean_it=true

module=fs perm=rw flags=

Parameters:	flag_name (`str`) – CephChoices strings=enable_multiple val (`str`) – yes_i_really_mean_it (`Optional`[`bool`]) – CephBool

fs_get(fs_name)¶

get info about one filesystem

Example command:

ceph fs get --fs_name=string

module=fs perm=r flags=

Parameters:	fs_name (`str`) –

fs_ls()¶

list filesystems

Example command:

ceph fs ls

module=fs perm=r flags=

fs_new(fs_name, metadata, data, force=None, allow_dangerous_metadata_overlay=None)¶

make new filesystem using named pools <metadata> and <data>

Example command:

ceph fs new --fs_name=string --metadata=string --data=string --force=true --allow_dangerous_metadata_overlay=true

module=fs perm=rw flags=

Parameters:	fs_name (`str`) – metadata (`str`) – data (`str`) – force (`Optional`[`bool`]) – CephBool allow_dangerous_metadata_overlay (`Optional`[`bool`]) – CephBool

fs_reset(fs_name, yes_i_really_mean_it=None)¶

disaster recovery only: reset to a single-MDS map

Example command:

ceph fs reset --fs_name=string --yes_i_really_mean_it=true

module=fs perm=rw flags=

Parameters:	fs_name (`str`) – yes_i_really_mean_it (`Optional`[`bool`]) – CephBool

fs_rm(fs_name, yes_i_really_mean_it=None)¶

disable the named filesystem

Example command:

ceph fs rm --fs_name=string --yes_i_really_mean_it=true

module=fs perm=rw flags=

Parameters:	fs_name (`str`) – yes_i_really_mean_it (`Optional`[`bool`]) – CephBool

fs_rm_data_pool(fs_name, pool)¶

remove data pool <pool>

Example command:

ceph fs rm_data_pool --fs_name=string --pool=string

module=mds perm=rw flags=

Parameters:	fs_name (`str`) – pool (`str`) –

fs_set(fs_name, var, val, yes_i_really_mean_it=None, yes_i_really_really_mean_it=None)¶

set fs parameter <var> to <val>

Example command:

ceph fs set --fs_name=string --var=choice --val=string --yes_i_really_mean_it=true --yes_i_really_really_mean_it=true

module=mds perm=rw flags=

Parameters:

fs_name (str) –
var (str) – CephChoices strings=max_mds|max_file_size|allow_new_snaps| inline_data|cluster_down|allow_dirfrags|balancer|standby_count_wanted| session_timeout|session_autoclose|allow_standby_replay|down|joinable|m in_compat_client
val (str) –
yes_i_really_mean_it (Optional[bool]) – CephBool
yes_i_really_really_mean_it (Optional[bool]) – CephBool

fs_status(fs=None)¶

Show the status of a CephFS filesystem

Example command:

ceph fs status --fs=string

module=mgr perm=r flags=mgr

Parameters:	fs (`Optional`[`str`]) –

fs_subvolume_create(vol_name, sub_name, size=None, group_name=None, pool_layout=None, uid=None, gid=None, mode=None)¶

Create a CephFS subvolume in a volume, and optionally, with a specific size (in bytes), a specific data pool layout, a specific mode, and in a specific subvolume group

Example command:

ceph fs subvolume create --vol_name=string --sub_name=string --size=1 --group_name=string --pool_layout=string --uid=1 --gid=1 --mode=string

module=mgr perm=rw flags=mgr

Parameters:	vol_name (`str`) – sub_name (`str`) – size (`Optional`[`int`]) – CephInt group_name (`Optional`[`str`]) – pool_layout (`Optional`[`str`]) – uid (`Optional`[`int`]) – CephInt gid (`Optional`[`int`]) – CephInt mode (`Optional`[`str`]) –

fs_subvolume_getpath(vol_name, sub_name, group_name=None)¶

Get the mountpath of a CephFS subvolume in a volume, and optionally, in a specific subvolume group

Example command:

ceph fs subvolume getpath --vol_name=string --sub_name=string --group_name=string

module=mgr perm=rw flags=mgr

Parameters:	vol_name (`str`) – sub_name (`str`) – group_name (`Optional`[`str`]) –

fs_subvolume_ls(vol_name, group_name=None)¶

List subvolumes

Example command:

ceph fs subvolume ls --vol_name=string --group_name=string

module=mgr perm=r flags=mgr

Parameters:	vol_name (`str`) – group_name (`Optional`[`str`]) –

fs_subvolume_resize(vol_name, sub_name, new_size, group_name=None, no_shrink=None)¶

Resize a CephFS subvolume

Example command:

ceph fs subvolume resize --vol_name=string --sub_name=string --new_size=string --group_name=string --no_shrink=true

module=mgr perm=rw flags=mgr

Parameters:	vol_name (`str`) – sub_name (`str`) – new_size (`str`) – group_name (`Optional`[`str`]) – no_shrink (`Optional`[`bool`]) – CephBool

fs_subvolume_rm(vol_name, sub_name, group_name=None, force=None)¶

Delete a CephFS subvolume in a volume, and optionally, in a specific subvolume group

Example command:

ceph fs subvolume rm --vol_name=string --sub_name=string --group_name=string --force=true

module=mgr perm=rw flags=mgr

Parameters:	vol_name (`str`) – sub_name (`str`) – group_name (`Optional`[`str`]) – force (`Optional`[`bool`]) – CephBool

fs_subvolume_snapshot_create(vol_name, sub_name, snap_name, group_name=None)¶

Create a snapshot of a CephFS subvolume in a volume, and optionally, in a specific subvolume group

Example command:

ceph fs subvolume snapshot create --vol_name=string --sub_name=string --snap_name=string --group_name=string

module=mgr perm=rw flags=mgr

Parameters:	vol_name (`str`) – sub_name (`str`) – snap_name (`str`) – group_name (`Optional`[`str`]) –

fs_subvolume_snapshot_ls(vol_name, sub_name, group_name=None)¶

List subvolume snapshots

Example command:

ceph fs subvolume snapshot ls --vol_name=string --sub_name=string --group_name=string

module=mgr perm=r flags=mgr

Parameters:	vol_name (`str`) – sub_name (`str`) – group_name (`Optional`[`str`]) –

fs_subvolume_snapshot_rm(vol_name, sub_name, snap_name, group_name=None, force=None)¶

Delete a snapshot of a CephFS subvolume in a volume, and optionally, in a specific subvolume group

Example command:

ceph fs subvolume snapshot rm --vol_name=string --sub_name=string --snap_name=string --group_name=string --force=true

module=mgr perm=rw flags=mgr

Parameters:	vol_name (`str`) – sub_name (`str`) – snap_name (`str`) – group_name (`Optional`[`str`]) – force (`Optional`[`bool`]) – CephBool

fs_subvolumegroup_create(vol_name, group_name, pool_layout=None, uid=None, gid=None, mode=None)¶

Create a CephFS subvolume group in a volume, and optionally, with a specific data pool layout, and a specific numeric mode

Example command:

ceph fs subvolumegroup create --vol_name=string --group_name=string --pool_layout=string --uid=1 --gid=1 --mode=string

module=mgr perm=rw flags=mgr

Parameters:	vol_name (`str`) – group_name (`str`) – pool_layout (`Optional`[`str`]) – uid (`Optional`[`int`]) – CephInt gid (`Optional`[`int`]) – CephInt mode (`Optional`[`str`]) –

fs_subvolumegroup_getpath(vol_name, group_name)¶

Get the mountpath of a CephFS subvolume group in a volume

Example command:

ceph fs subvolumegroup getpath --vol_name=string --group_name=string

module=mgr perm=r flags=mgr

Parameters:	vol_name (`str`) – group_name (`str`) –

fs_subvolumegroup_ls(vol_name)¶

List subvolumegroups

Example command:

ceph fs subvolumegroup ls --vol_name=string

module=mgr perm=r flags=mgr

Parameters:	vol_name (`str`) –

fs_subvolumegroup_rm(vol_name, group_name, force=None)¶

Delete a CephFS subvolume group in a volume

Example command:

ceph fs subvolumegroup rm --vol_name=string --group_name=string --force=true

module=mgr perm=rw flags=mgr

Parameters:	vol_name (`str`) – group_name (`str`) – force (`Optional`[`bool`]) – CephBool

fs_subvolumegroup_snapshot_create(vol_name, group_name, snap_name)¶

Create a snapshot of a CephFS subvolume group in a volume

Example command:

ceph fs subvolumegroup snapshot create --vol_name=string --group_name=string --snap_name=string

module=mgr perm=rw flags=mgr

Parameters:	vol_name (`str`) – group_name (`str`) – snap_name (`str`) –

fs_subvolumegroup_snapshot_ls(vol_name, group_name)¶

List subvolumegroup snapshots

Example command:

ceph fs subvolumegroup snapshot ls --vol_name=string --group_name=string

module=mgr perm=r flags=mgr

Parameters:	vol_name (`str`) – group_name (`str`) –

fs_subvolumegroup_snapshot_rm(vol_name, group_name, snap_name, force=None)¶

Delete a snapshot of a CephFS subvolume group in a volume

Example command:

ceph fs subvolumegroup snapshot rm --vol_name=string --group_name=string --snap_name=string --force=true

module=mgr perm=rw flags=mgr

Parameters:	vol_name (`str`) – group_name (`str`) – snap_name (`str`) – force (`Optional`[`bool`]) – CephBool

fs_volume_create(name)¶

Create a CephFS volume

Example command:

ceph fs volume create --name=string

module=mgr perm=rw flags=mgr

Parameters:	name (`str`) –

fs_volume_ls()¶

List volumes

Example command:

ceph fs volume ls

module=mgr perm=r flags=mgr

fs_volume_rm(vol_name, yes_i_really_mean_it=None)¶

Delete a FS volume by passing –yes-i-really-mean-it flag

Example command:

ceph fs volume rm --vol_name=string --yes-i-really-mean-it=string

module=mgr perm=rw flags=mgr

Parameters:	vol_name (`str`) – yes_i_really_mean_it (`Optional`[`str`]) – Real name is `yes-i-really-mean-it`

fsid()¶

show cluster FSID/UUID

Example command:

ceph fsid

module=mon perm=r flags=

health(detail=None)¶

show cluster health

Example command:

ceph health --detail=choice

module=mon perm=r flags=

Parameters:	detail (`Optional`[`str`]) – CephChoices strings=detail

health_mute(code, ttl=None, sticky=None)¶

mute health alert

Example command:

ceph health mute --code=string --ttl=string --sticky=true

module=mon perm=w flags=

Parameters:	code (`str`) – ttl (`Optional`[`str`]) – sticky (`Optional`[`bool`]) – CephBool

health_unmute(code=None)¶

unmute existing health alert mute(s)

Example command:

ceph health unmute --code=string

module=mon perm=w flags=

Parameters:	code (`Optional`[`str`]) –

heap(heapcmd, value=None)¶

show heap usage info (available only if compiled with tcmalloc)

Example command:

ceph heap --heapcmd=choice --value=string

module=mon perm=rw flags=hidden, no_forward

Parameters:	heapcmd (`str`) – CephChoices strings=dump\|start_profiler\|stop_profiler\|release\|stats value (`Optional`[`str`]) –

hello(person_name=None)¶

Say hello

Example command:

ceph hello --person_name=string

module=mgr perm=r flags=mgr

Parameters:	person_name (`Optional`[`str`]) –

influx_config_set(key, value)¶

Set a configuration value

Example command:

ceph influx config-set --key=string --value=string

module=mgr perm=rw flags=mgr

Parameters:	key (`str`) – value (`str`) –

influx_config_show()¶

Show current configuration

Example command:

ceph influx config-show

module=mgr perm=r flags=mgr

influx_send()¶

Force sending data to Influx

Example command:

ceph influx send

module=mgr perm=rw flags=mgr

injectargs(injected_args)¶

inject config arguments into monitor

Example command:

ceph injectargs --injected_args=string

module=mon perm=rw flags=hidden, no_forward

Parameters:	injected_args (`List`[`str`]) –

insights()¶

Retrieve insights report

Example command:

ceph insights

module=mgr perm=r flags=mgr

insights_prune_health(hours)¶

Remove health history older than <hours> hours

Example command:

ceph insights prune-health --hours=string

module=mgr perm=rw flags=mgr

Parameters:	hours (`str`) –

iostat()¶

Get IO rates

Example command:

ceph iostat

module=mgr perm=r flags=mgr, poll

k8sevents_ceph()¶

List Ceph events tracked & sent to the kubernetes cluster

Example command:

ceph k8sevents ceph

module=mgr perm=r flags=mgr

k8sevents_clear_config()¶

Clear external kubernetes configuration settings

Example command:

ceph k8sevents clear-config

module=mgr perm=rw flags=mgr

k8sevents_ls()¶

List all current Kuberenetes events from the Ceph namespace

Example command:

ceph k8sevents ls

module=mgr perm=r flags=mgr

k8sevents_set_access(key)¶

Set kubernetes access credentials. <key> must be cacrt or token and use -i <filename> syntax. e.g. ceph k8sevents set-access cacrt -i /root/ca.crt

Example command:

ceph k8sevents set-access --key=string

module=mgr perm=rw flags=mgr

Parameters:	key (`str`) –

k8sevents_set_config(key, value)¶

Set kubernetes config paramters. <key> must be server or namespace. e.g. ceph k8sevents set-config server https://localhost:30433

Example command:

ceph k8sevents set-config --key=string --value=string

module=mgr perm=rw flags=mgr

Parameters:	key (`str`) – value (`str`) –

k8sevents_status()¶

Show the status of the data gathering threads

Example command:

ceph k8sevents status

module=mgr perm=r flags=mgr

log(logtext)¶

log supplied text to the monitor log

Example command:

ceph log --logtext=string

module=mon perm=rw flags=

Parameters:	logtext (`List`[`str`]) –

log_last(num=None, level=None, channel=None)¶

print last few lines of the cluster log

Example command:

ceph log last --num=1 --level=choice --channel=choice

module=mon perm=r flags=

Parameters:	num (`Optional`[`int`]) – CephInt range= `1` level (`Optional`[`str`]) – CephChoices strings=debug\|info\|sec\|warn\|error channel (`Optional`[`str`]) – CephChoices strings=*\|cluster\|audit

mds_add_data_pool(pool)¶

add data pool <pool>

Example command:

ceph mds add_data_pool --pool=string

module=mds perm=rw flags=obsolete

Parameters:	pool (`str`) –

mds_cluster_down()¶

take MDS cluster down

Example command:

ceph mds cluster_down

module=mds perm=rw flags=obsolete

mds_cluster_up()¶

bring MDS cluster up

Example command:

ceph mds cluster_up

module=mds perm=rw flags=obsolete

mds_compat_rm_compat(feature)¶

remove compatible feature

Example command:

ceph mds compat rm_compat --feature=1

module=mds perm=rw flags=

Parameters:	feature (`int`) – CephInt range= `0`

mds_compat_rm_incompat(feature)¶

remove incompatible feature

Example command:

ceph mds compat rm_incompat --feature=1

module=mds perm=rw flags=

Parameters:	feature (`int`) – CephInt range= `0`

mds_compat_show()¶

show mds compatibility settings

Example command:

ceph mds compat show

module=mds perm=r flags=

mds_count_metadata(property_1)¶

count MDSs by metadata field property

Example command:

ceph mds count-metadata --property=string

module=mds perm=r flags=

Parameters:	property_1 (`str`) – Real name is `property`

mds_deactivate(role)¶

clean up specified MDS rank (use with set max_mds to shrink cluster)

Example command:

ceph mds deactivate --role=string

module=mds perm=rw flags=obsolete

Parameters:	role (`str`) –

mds_dump(epoch=None)¶

dump legacy MDS cluster info, optionally from epoch

Example command:

ceph mds dump --epoch=1

module=mds perm=r flags=obsolete

Parameters:	epoch (`Optional`[`int`]) – CephInt range= `0`

mds_fail(role_or_gid)¶

Mark MDS failed: trigger a failover if a standby is available

Example command:

ceph mds fail --role_or_gid=string

module=mds perm=rw flags=

Parameters:	role_or_gid (`str`) –

mds_freeze(role_or_gid, val)¶

freeze MDS yes/no

Example command:

ceph mds freeze --role_or_gid=string --val=string

module=mds perm=rw flags=hidden

Parameters:	role_or_gid (`str`) – val (`str`) –

mds_getmap(epoch=None)¶

get MDS map, optionally from epoch

Example command:

ceph mds getmap --epoch=1

module=mds perm=r flags=obsolete

Parameters:	epoch (`Optional`[`int`]) – CephInt range= `0`

mds_metadata(who=None)¶

fetch metadata for mds <role>

Example command:

ceph mds metadata --who=string

module=mds perm=r flags=

Parameters:	who (`Optional`[`str`]) –

mds_newfs(metadata, data, yes_i_really_mean_it=None)¶

make new filesystem using pools <metadata> and <data>

Example command:

ceph mds newfs --metadata=1 --data=1 --yes_i_really_mean_it=true

module=mds perm=rw flags=obsolete

Parameters:	metadata (`int`) – CephInt range= `0` data (`int`) – CephInt range= `0` yes_i_really_mean_it (`Optional`[`bool`]) – CephBool

mds_ok_to_stop(ids)¶

check whether stopping the specified MDS would reduce immediate availability

Example command:

ceph mds ok-to-stop --ids=string

module=mds perm=r flags=

Parameters:	ids (`List`[`str`]) –

mds_remove_data_pool(pool)¶

remove data pool <pool>

Example command:

ceph mds remove_data_pool --pool=string

module=mds perm=rw flags=obsolete

Parameters:	pool (`str`) –

mds_repaired(role)¶

mark a damaged MDS rank as no longer damaged

Example command:

ceph mds repaired --role=string

module=mds perm=rw flags=

Parameters:	role (`str`) –

mds_rm(gid)¶

remove nonactive mds

Example command:

ceph mds rm --gid=1

module=mds perm=rw flags=

Parameters:	gid (`int`) – CephInt range= `0`

mds_rm_data_pool(pool)¶

remove data pool <pool>

Example command:

ceph mds rm_data_pool --pool=string

module=mds perm=rw flags=obsolete

Parameters:	pool (`str`) –

mds_rmfailed(role, yes_i_really_mean_it=None)¶

remove failed rank

Example command:

ceph mds rmfailed --role=string --yes_i_really_mean_it=true

module=mds perm=rw flags=hidden

Parameters:	role (`str`) – yes_i_really_mean_it (`Optional`[`bool`]) – CephBool

mds_set(var, val, yes_i_really_mean_it=None)¶

set mds parameter <var> to <val>

Example command:

ceph mds set --var=choice --val=string --yes_i_really_mean_it=true

module=mds perm=rw flags=obsolete

Parameters:	var (`str`) – CephChoices strings=max_mds\|max_file_size\|inline_data\|allo w_new_snaps\|allow_multimds\|allow_multimds_snaps\|allow_dirfrags val (`str`) – yes_i_really_mean_it (`Optional`[`bool`]) – CephBool

mds_set_max_mds(maxmds)¶

set max MDS index

Example command:

ceph mds set_max_mds --maxmds=1

module=mds perm=rw flags=obsolete

Parameters:	maxmds (`int`) – CephInt range= `0`

mds_set_state(gid, state)¶

set mds state of <gid> to <numeric-state>

Example command:

ceph mds set_state --gid=1 --state=1

module=mds perm=rw flags=hidden

Parameters:	gid (`int`) – CephInt range= `0` state (`int`) – CephInt range= `0..20`

mds_stat()¶

show MDS status

Example command:

ceph mds stat

module=mds perm=r flags=hidden

mds_stop(role)¶

stop mds

Example command:

ceph mds stop --role=string

module=mds perm=rw flags=obsolete

Parameters:	role (`str`) –

mds_tell(who, args)¶

send command to particular mds

Example command:

ceph mds tell --who=string --args=string

module=mds perm=rw flags=obsolete

Parameters:	who (`str`) – args (`List`[`str`]) –

mds_versions()¶

check running versions of MDSs

Example command:

ceph mds versions

module=mds perm=r flags=

mgr_count_metadata(property_1)¶

count ceph-mgr daemons by metadata field property

Example command:

ceph mgr count-metadata --property=string

module=mgr perm=r flags=

Parameters:	property_1 (`str`) – Real name is `property`

mgr_dump(epoch=None)¶

dump the latest MgrMap

Example command:

ceph mgr dump --epoch=1

module=mgr perm=r flags=

Parameters:	epoch (`Optional`[`int`]) – CephInt range= `0`

mgr_fail(who)¶

treat the named manager daemon as failed

Example command:

ceph mgr fail --who=string

module=mgr perm=rw flags=

Parameters:	who (`str`) –

mgr_metadata(who=None)¶

dump metadata for all daemons or a specific daemon

Example command:

ceph mgr metadata --who=string

module=mgr perm=r flags=

Parameters:	who (`Optional`[`str`]) –

mgr_module_disable(module)¶

disable mgr module

Example command:

ceph mgr module disable --module=string

module=mgr perm=rw flags=

Parameters:	module (`str`) –

mgr_module_enable(module, force=None)¶

enable mgr module

Example command:

ceph mgr module enable --module=string --force=choice

module=mgr perm=rw flags=

Parameters:	module (`str`) – force (`Optional`[`str`]) – CephChoices strings=–force

mgr_module_ls()¶

list active mgr modules

Example command:

ceph mgr module ls

module=mgr perm=r flags=

mgr_self_test_background_start(workload)¶

Activate a background workload (one of command_spam, throw_exception)

Example command:

ceph mgr self-test background start --workload=string

module=mgr perm=rw flags=mgr

Parameters:	workload (`str`) –

mgr_self_test_background_stop()¶

Stop background workload if any is running

Example command:

ceph mgr self-test background stop

module=mgr perm=rw flags=mgr

mgr_self_test_cluster_log(channel, priority, message)¶

Create an audit log record.

Example command:

ceph mgr self-test cluster-log --channel=string --priority=string --message=string

module=mgr perm=rw flags=mgr

Parameters:	channel (`str`) – priority (`str`) – message (`str`) –

mgr_self_test_config_get(key)¶

Peek at a configuration value

Example command:

ceph mgr self-test config get --key=string

module=mgr perm=rw flags=mgr

Parameters:	key (`str`) –

mgr_self_test_config_get_localized(key)¶

Peek at a configuration value (localized variant)

Example command:

ceph mgr self-test config get_localized --key=string

module=mgr perm=rw flags=mgr

Parameters:	key (`str`) –

mgr_self_test_health_clear(checks)¶

Clear health checks by name. If no names provided, clear all.

Example command:

ceph mgr self-test health clear --checks=string

module=mgr perm=rw flags=mgr

Parameters:	checks (`List`[`str`]) –

mgr_self_test_health_set(checks)¶

Set a health check from a JSON-formatted description.

Example command:

ceph mgr self-test health set --checks=string

module=mgr perm=rw flags=mgr

Parameters:	checks (`str`) –

mgr_self_test_insights_set_now_offset(hours)¶

Set the now time for the insights module.

Example command:

ceph mgr self-test insights_set_now_offset --hours=string

module=mgr perm=rw flags=mgr

Parameters:	hours (`str`) –

mgr_self_test_module(module)¶

Run another module’s self_test() method

Example command:

ceph mgr self-test module --module=string

module=mgr perm=rw flags=mgr

Parameters:	module (`str`) –

mgr_self_test_remote()¶

Test inter-module calls

Example command:

ceph mgr self-test remote

module=mgr perm=rw flags=mgr

mgr_self_test_run()¶

Run mgr python interface tests

Example command:

ceph mgr self-test run

module=mgr perm=rw flags=mgr

mgr_services()¶

list service endpoints provided by mgr modules

Example command:

ceph mgr services

module=mgr perm=r flags=

mgr_versions()¶

check running versions of ceph-mgr daemons

Example command:

ceph mgr versions

module=mgr perm=r flags=

mon_add(name, addr)¶

add new monitor named <name> at <addr>

Example command:

ceph mon add --name=string --addr=0.0.0.0

module=mon perm=rw flags=

Parameters:	name (`str`) – addr (`str`) – CephIPAddr

mon_count_metadata(property_1)¶

count mons by metadata field property

Example command:

ceph mon count-metadata --property=string

module=mon perm=r flags=

Parameters:	property_1 (`str`) – Real name is `property`

mon_dump(epoch=None)¶

dump formatted monmap (optionally from epoch)

Example command:

ceph mon dump --epoch=1

module=mon perm=r flags=

Parameters:	epoch (`Optional`[`int`]) – CephInt range= `0`

mon_enable_msgr2()¶

enable the msgr2 protocol on port 3300

Example command:

ceph mon enable-msgr2

module=mon perm=rw flags=

mon_feature_ls(with_value=None)¶

list available mon map features to be set/unset

Example command:

ceph mon feature ls --with_value=choice

module=mon perm=r flags=

Parameters:	with_value (`Optional`[`str`]) – CephChoices strings=–with-value

mon_feature_set(feature_name, yes_i_really_mean_it=None)¶

set provided feature on mon map

Example command:

ceph mon feature set --feature_name=string --yes_i_really_mean_it=true

module=mon perm=rw flags=

Parameters:	feature_name (`str`) – yes_i_really_mean_it (`Optional`[`bool`]) – CephBool

mon_getmap(epoch=None)¶

get monmap

Example command:

ceph mon getmap --epoch=1

module=mon perm=r flags=

Parameters:	epoch (`Optional`[`int`]) – CephInt range= `0`

mon_metadata(id_1=None)¶

fetch metadata for mon <id>

Example command:

ceph mon metadata --id=string

module=mon perm=r flags=

Parameters:	id_1 (`Optional`[`str`]) – Real name is `id`

mon_ok_to_add_offline()¶

check whether adding a mon and not starting it would break quorum

Example command:

ceph mon ok-to-add-offline

module=mon perm=r flags=

mon_ok_to_rm(id_1)¶

check whether removing the specified mon would break quorum

Example command:

ceph mon ok-to-rm --id=string

module=mon perm=r flags=

Parameters:	id_1 (`str`) – Real name is `id`

mon_ok_to_stop(ids)¶

check whether mon(s) can be safely stopped without reducing immediate availability

Example command:

ceph mon ok-to-stop --ids=string

module=mon perm=r flags=

Parameters:	ids (`List`[`str`]) –

mon_remove(name)¶

remove monitor named <name>

Example command:

ceph mon remove --name=string

module=mon perm=rw flags=deprecated

Parameters:	name (`str`) –

mon_rm(name)¶

remove monitor named <name>

Example command:

ceph mon rm --name=string

module=mon perm=rw flags=

Parameters:	name (`str`) –

mon_scrub()¶

scrub the monitor stores

Example command:

ceph mon scrub

module=mon perm=rw flags=

mon_set_addrs(name, addrs)¶

set the addrs (IPs and ports) a specific monitor binds to

Example command:

ceph mon set-addrs --name=string --addrs=string

module=mon perm=rw flags=

Parameters:	name (`str`) – addrs (`str`) –

mon_set_rank(name, rank)¶

set the rank for the specified mon

Example command:

ceph mon set-rank --name=string --rank=1

module=mon perm=rw flags=

Parameters:	name (`str`) – rank (`int`) – CephInt

mon_set_weight(name, weight)¶

set the weight for the specified mon

Example command:

ceph mon set-weight --name=string --weight=1

module=mon perm=rw flags=

Parameters:	name (`str`) – weight (`int`) – CephInt range= `0..65535`

mon_stat()¶

summarize monitor status

Example command:

ceph mon stat

module=mon perm=r flags=

mon_status()¶

report status of monitors

Example command:

ceph mon_status

module=mon perm=r flags=hidden, no_forward

mon_versions()¶

check running versions of monitors

Example command:

ceph mon versions

module=mon perm=r flags=

node_ls(type_1=None)¶

list all nodes in cluster [type]

Example command:

ceph node ls --type=choice

module=mon perm=r flags=

Parameters:	type_1 (`Optional`[`str`]) – CephChoices strings=all\|osd\|mon\|mds\|mgr Real name is `type`

ops()¶

show the ops currently in flight

Example command:

ceph ops

module=mon perm=r flags=hidden, no_forward

orchestrator_cancel()¶

cancels ongoing operations

Example command:

ceph orchestrator cancel

module=mgr perm=rw flags=mgr

orchestrator_device_ls(host=None, format=None, refresh=None)¶

List devices on a node

Example command:

ceph orchestrator device ls --host=string --format=choice --refresh=true

module=mgr perm=r flags=mgr

Parameters:	host (`Optional`[`List`[`str`]]) – format (`Optional`[`str`]) – CephChoices strings=json\|plain refresh (`Optional`[`bool`]) – CephBool

orchestrator_host_add(host)¶

Add a host

Example command:

ceph orchestrator host add --host=string

module=mgr perm=rw flags=mgr

Parameters:	host (`str`) –

orchestrator_host_label_add(host, label)¶

Add a host label

Example command:

ceph orchestrator host label add --host=string --label=string

module=mgr perm=rw flags=mgr

Parameters:	host (`str`) – label (`str`) –

orchestrator_host_label_rm(host, label)¶

Add a host label

Example command:

ceph orchestrator host label rm --host=string --label=string

module=mgr perm=rw flags=mgr

Parameters:	host (`str`) – label (`str`) –

orchestrator_host_ls(format=None)¶

List hosts

Example command:

ceph orchestrator host ls --format=choice

module=mgr perm=r flags=mgr

Parameters:	format (`Optional`[`str`]) – CephChoices strings=json\|plain

orchestrator_host_rm(host)¶

Remove a host

Example command:

ceph orchestrator host rm --host=string

module=mgr perm=rw flags=mgr

Parameters:	host (`str`) –

orchestrator_mds_add(fs_name, num=None, hosts=None)¶

Create an MDS service

Example command:

ceph orchestrator mds add --fs_name=string --num=1 --hosts=string

module=mgr perm=rw flags=mgr

Parameters:	fs_name (`str`) – num (`Optional`[`int`]) – CephInt hosts (`Optional`[`List`[`str`]]) –

orchestrator_mds_rm(name)¶

Remove an MDS service (mds id or fs_name)

Example command:

ceph orchestrator mds rm --name=string

module=mgr perm=rw flags=mgr

Parameters:	name (`str`) –

orchestrator_mds_update(fs_name, num=None, hosts=None, label=None)¶

Update the number of MDS instances for the given fs_name

Example command:

ceph orchestrator mds update --fs_name=string --num=1 --hosts=string --label=string

module=mgr perm=rw flags=mgr

Parameters:	fs_name (`str`) – num (`Optional`[`int`]) – CephInt hosts (`Optional`[`List`[`str`]]) – label (`Optional`[`str`]) –

orchestrator_mgr_update(num=None, hosts=None, label=None)¶

Update the number of manager instances

Example command:

ceph orchestrator mgr update --num=1 --hosts=string --label=string

module=mgr perm=rw flags=mgr

Parameters:	num (`Optional`[`int`]) – CephInt hosts (`Optional`[`List`[`str`]]) – label (`Optional`[`str`]) –

orchestrator_mon_update(num=None, hosts=None, label=None)¶

Update the number of monitor instances

Example command:

ceph orchestrator mon update --num=1 --hosts=string --label=string

module=mgr perm=rw flags=mgr

Parameters:	num (`Optional`[`int`]) – CephInt hosts (`Optional`[`List`[`str`]]) – label (`Optional`[`str`]) –

orchestrator_nfs_add(svc_arg, pool, namespace=None, num=None, hosts=None, label=None)¶

Create an NFS service

Example command:

ceph orchestrator nfs add --svc_arg=string --pool=string --namespace=string --num=1 --hosts=string --label=string

module=mgr perm=rw flags=mgr

Parameters:	svc_arg (`str`) – pool (`str`) – namespace (`Optional`[`str`]) – num (`Optional`[`int`]) – CephInt hosts (`Optional`[`List`[`str`]]) – label (`Optional`[`str`]) –

orchestrator_nfs_rm(svc_id)¶

Remove an NFS service

Example command:

ceph orchestrator nfs rm --svc_id=string

module=mgr perm=rw flags=mgr

Parameters:	svc_id (`str`) –

orchestrator_nfs_update(svc_id, num=None, hosts=None, label=None)¶

Scale an NFS service

Example command:

ceph orchestrator nfs update --svc_id=string --num=1 --hosts=string --label=string

module=mgr perm=rw flags=mgr

Parameters:	svc_id (`str`) – num (`Optional`[`int`]) – CephInt hosts (`Optional`[`List`[`str`]]) – label (`Optional`[`str`]) –

orchestrator_osd_create(svc_arg=None)¶

Create an OSD service. Either –svc_arg=host:drives or -i <drive_group>

Example command:

ceph orchestrator osd create --svc_arg=string

module=mgr perm=rw flags=mgr

Parameters:	svc_arg (`Optional`[`str`]) –

orchestrator_osd_rm(svc_id)¶

Remove OSD services

Example command:

ceph orchestrator osd rm --svc_id=string

module=mgr perm=rw flags=mgr

Parameters:	svc_id (`List`[`str`]) –

orchestrator_rbd_mirror_add(num=None, hosts=None)¶

Create an rbd-mirror service

Example command:

ceph orchestrator rbd-mirror add --num=1 --hosts=string

module=mgr perm=rw flags=mgr

Parameters:	num (`Optional`[`int`]) – CephInt hosts (`Optional`[`List`[`str`]]) –

orchestrator_rbd_mirror_rm(name=None)¶

Remove rbd-mirror service or rbd-mirror service instance

Example command:

ceph orchestrator rbd-mirror rm --name=string

module=mgr perm=rw flags=mgr

Parameters:	name (`Optional`[`str`]) –

orchestrator_rbd_mirror_update(num=None, hosts=None, label=None)¶

Update the number of rbd-mirror instances

Example command:

ceph orchestrator rbd-mirror update --num=1 --hosts=string --label=string

module=mgr perm=rw flags=mgr

Parameters:	num (`Optional`[`int`]) – CephInt hosts (`Optional`[`List`[`str`]]) – label (`Optional`[`str`]) –

orchestrator_rgw_add(realm_name, zone_name, num=None, hosts=None)¶

Create an RGW service. A complete <rgw_spec> can be provided using <-i> to customize completelly the RGW service

Example command:

ceph orchestrator rgw add --realm_name=string --zone_name=string --num=1 --hosts=string

module=mgr perm=rw flags=mgr

Parameters:	realm_name (`str`) – zone_name (`str`) – num (`Optional`[`int`]) – CephInt hosts (`Optional`[`List`[`str`]]) –

orchestrator_rgw_rm(realm_name, zone_name)¶

Remove an RGW service

Example command:

ceph orchestrator rgw rm --realm_name=string --zone_name=string

module=mgr perm=rw flags=mgr

Parameters:	realm_name (`str`) – zone_name (`str`) –

orchestrator_rgw_update(zone_name, realm_name, num=None, hosts=None, label=None)¶

Update the number of RGW instances for the given zone

Example command:

ceph orchestrator rgw update --zone_name=string --realm_name=string --num=1 --hosts=string --label=string

module=mgr perm=rw flags=mgr

Parameters:	zone_name (`str`) – realm_name (`str`) – num (`Optional`[`int`]) – CephInt hosts (`Optional`[`List`[`str`]]) – label (`Optional`[`str`]) –

orchestrator_service(action, svc_type, svc_name)¶

Start, stop, restart, redeploy, or reconfig an entire service (i.e. all daemons)

Example command:

ceph orchestrator service --action=choice --svc_type=string --svc_name=string

module=mgr perm=rw flags=mgr

Parameters:	action (`str`) – CephChoices strings=start\|stop\|restart\|redeploy\|reconfig svc_type (`str`) – svc_name (`str`) –

orchestrator_service_instance(action, svc_type, svc_id)¶

Start, stop, restart, redeploy, or reconfig a specific service instance

Example command:

ceph orchestrator service-instance --action=choice --svc_type=string --svc_id=string

module=mgr perm=rw flags=mgr

Parameters:	action (`str`) – CephChoices strings=start\|stop\|restart\|redeploy\|reconfig svc_type (`str`) – svc_id (`str`) –

orchestrator_service_ls(host=None, svc_type=None, svc_id=None, format=None, refresh=None)¶

List services known to orchestrator

Example command:

ceph orchestrator service ls --host=string --svc_type=choice --svc_id=string --format=choice --refresh=true

module=mgr perm=r flags=mgr

Parameters:	host (`Optional`[`str`]) – svc_type (`Optional`[`str`]) – CephChoices strings=mon\|mgr\|osd\|mds\|iscsi\|nfs\|rgw\|rbd-mirror svc_id (`Optional`[`str`]) – format (`Optional`[`str`]) – CephChoices strings=json\|plain refresh (`Optional`[`bool`]) – CephBool

orchestrator_set_backend(module_name)¶

Select orchestrator module backend

Example command:

ceph orchestrator set backend --module_name=string

module=mgr perm=rw flags=mgr

Parameters:	module_name (`str`) –

orchestrator_status()¶

Report configured backend and its status

Example command:

ceph orchestrator status

module=mgr perm=r flags=mgr

osd_add_nodown(ids)¶

mark osd(s) <id> [<id>…] as nodown, or use <all|any> to mark all osds as nodown

Example command:

ceph osd add-nodown --ids=string

module=osd perm=rw flags=deprecated

Parameters:	ids (`List`[`str`]) –

osd_add_noin(ids)¶

mark osd(s) <id> [<id>…] as noin, or use <all|any> to mark all osds as noin

Example command:

ceph osd add-noin --ids=string

module=osd perm=rw flags=deprecated

Parameters:	ids (`List`[`str`]) –

osd_add_noout(ids)¶

mark osd(s) <id> [<id>…] as noout, or use <all|any> to mark all osds as noout

Example command:

ceph osd add-noout --ids=string

module=osd perm=rw flags=deprecated

Parameters:	ids (`List`[`str`]) –

osd_add_noup(ids)¶

mark osd(s) <id> [<id>…] as noup, or use <all|any> to mark all osds as noup

Example command:

ceph osd add-noup --ids=string

module=osd perm=rw flags=deprecated

Parameters:	ids (`List`[`str`]) –

osd_blacklist(blacklistop, addr, expire=None)¶

add (optionally until <expire> seconds from now) or remove <addr> from blacklist

Example command:

ceph osd blacklist --blacklistop=choice --addr=entityaddr --expire=0.0

module=osd perm=rw flags=

Parameters:	blacklistop (`str`) – CephChoices strings=add\|rm addr (`str`) – CephEntityAddr expire (`Optional`[`float`]) – CephFloat range= `0.0`

osd_blacklist_clear()¶

clear all blacklisted clients

Example command:

ceph osd blacklist clear

module=osd perm=rw flags=

osd_blacklist_ls()¶

show blacklisted clients

Example command:

ceph osd blacklist ls

module=osd perm=r flags=

osd_blocked_by()¶

print histogram of which OSDs are blocking their peers

Example command:

ceph osd blocked-by

module=osd perm=r flags=mgr

osd_count_metadata(property_1)¶

count OSDs by metadata field property

Example command:

ceph osd count-metadata --property=string

module=osd perm=r flags=

Parameters:	property_1 (`str`) – Real name is `property`

osd_create(uuid=None, id_1=None)¶

create new osd (with optional UUID and ID)

Example command:

ceph osd create --uuid=uuid --id=osd.0

module=osd perm=rw flags=deprecated

Parameters:	uuid (`Optional`[`str`]) – CephUUID id_1 (`Optional`[`str`]) – CephOsdName Real name is `id`

osd_crush_add(id_1, weight, args)¶

add or update crushmap position and weight for <name> with <weight> and location <args>

Example command:

ceph osd crush add --id=osd.0 --weight=0.0 --args=string

module=osd perm=rw flags=

Parameters:	id_1 (`str`) – CephOsdName Real name is `id` weight (`float`) – CephFloat range= `0.0` args (`List`[`str`]) – goodchars= `[A-Za-z0-9-_.=]`

osd_crush_add_bucket(name, type_1, args=None)¶

add no-parent (probably root) crush bucket <name> of type <type> to location <args>

Example command:

ceph osd crush add-bucket --name=string --type=string --args=string

module=osd perm=rw flags=

Parameters:	name (`str`) – goodchars= `[A-Za-z0-9-_.]` type_1 (`str`) – Real name is `type` args (`Optional`[`List`[`str`]]) – goodchars= `[A-Za-z0-9-_.=]`

osd_crush_class_create(class_1)¶

create crush device class <class>

Example command:

ceph osd crush class create --class=string

module=osd perm=rw flags=

Parameters:	class_1 (`str`) – goodchars= `[A-Za-z0-9-_]` Real name is `class`

osd_crush_class_ls()¶

list all crush device classes

Example command:

ceph osd crush class ls

module=osd perm=r flags=

osd_crush_class_ls_osd(class_1)¶

list all osds belonging to the specific <class>

Example command:

ceph osd crush class ls-osd --class=string

module=osd perm=r flags=

Parameters:	class_1 (`str`) – goodchars= `[A-Za-z0-9-_]` Real name is `class`

osd_crush_class_rename(srcname, dstname)¶

rename crush device class <srcname> to <dstname>

Example command:

ceph osd crush class rename --srcname=string --dstname=string

module=osd perm=rw flags=

Parameters:	srcname (`str`) – goodchars= `[A-Za-z0-9-_]` dstname (`str`) – goodchars= `[A-Za-z0-9-_]`

osd_crush_class_rm(class_1)¶

remove crush device class <class>

Example command:

ceph osd crush class rm --class=string

module=osd perm=rw flags=

Parameters:	class_1 (`str`) – goodchars= `[A-Za-z0-9-_]` Real name is `class`

osd_crush_create_or_move(id_1, weight, args)¶

create entry or move existing entry for <name> <weight> at/to location <args>

Example command:

ceph osd crush create-or-move --id=osd.0 --weight=0.0 --args=string

module=osd perm=rw flags=

Parameters:	id_1 (`str`) – CephOsdName Real name is `id` weight (`float`) – CephFloat range= `0.0` args (`List`[`str`]) – goodchars= `[A-Za-z0-9-_.=]`

osd_crush_dump()¶

dump crush map

Example command:

ceph osd crush dump

module=osd perm=r flags=

osd_crush_get_device_class(ids)¶

get classes of specified osd(s) <id> [<id>…]

Example command:

ceph osd crush get-device-class --ids=string

module=osd perm=r flags=

Parameters:	ids (`List`[`str`]) –

osd_crush_get_tunable(tunable)¶

get crush tunable <tunable>

Example command:

ceph osd crush get-tunable --tunable=choice

module=osd perm=r flags=

Parameters:	tunable (`str`) – CephChoices strings=straw_calc_version

osd_crush_link(name, args)¶

link existing entry for <name> under location <args>

Example command:

ceph osd crush link --name=string --args=string

module=osd perm=rw flags=

Parameters:	name (`str`) – args (`List`[`str`]) – goodchars= `[A-Za-z0-9-_.=]`

osd_crush_ls(node)¶

list items beneath a node in the CRUSH tree

Example command:

ceph osd crush ls --node=string

module=osd perm=r flags=

Parameters:	node (`str`) – goodchars= `[A-Za-z0-9-_.]`

osd_crush_move(name, args)¶

move existing entry for <name> to location <args>

Example command:

ceph osd crush move --name=string --args=string

module=osd perm=rw flags=

Parameters:	name (`str`) – goodchars= `[A-Za-z0-9-_.]` args (`List`[`str`]) – goodchars= `[A-Za-z0-9-_.=]`

osd_crush_remove(name, ancestor=None)¶

remove <name> from crush map (everywhere, or just at <ancestor>)

Example command:

ceph osd crush remove --name=string --ancestor=string

module=osd perm=rw flags=deprecated

Parameters:	name (`str`) – goodchars= `[A-Za-z0-9-_.]` ancestor (`Optional`[`str`]) – goodchars= `[A-Za-z0-9-_.]`

osd_crush_rename_bucket(srcname, dstname)¶

rename bucket <srcname> to <dstname>

Example command:

ceph osd crush rename-bucket --srcname=string --dstname=string

module=osd perm=rw flags=

Parameters:	srcname (`str`) – goodchars= `[A-Za-z0-9-_.]` dstname (`str`) – goodchars= `[A-Za-z0-9-_.]`

osd_crush_reweight(name, weight)¶

change <name>’s weight to <weight> in crush map

Example command:

ceph osd crush reweight --name=string --weight=0.0

module=osd perm=rw flags=

Parameters:	name (`str`) – goodchars= `[A-Za-z0-9-_.]` weight (`float`) – CephFloat range= `0.0`

osd_crush_reweight_all()¶

recalculate the weights for the tree to ensure they sum correctly

Example command:

ceph osd crush reweight-all

module=osd perm=rw flags=

osd_crush_reweight_subtree(name, weight)¶

change all leaf items beneath <name> to <weight> in crush map

Example command:

ceph osd crush reweight-subtree --name=string --weight=0.0

module=osd perm=rw flags=

Parameters:	name (`str`) – goodchars= `[A-Za-z0-9-_.]` weight (`float`) – CephFloat range= `0.0`

osd_crush_rm(name, ancestor=None)¶

remove <name> from crush map (everywhere, or just at <ancestor>)

Example command:

ceph osd crush rm --name=string --ancestor=string

module=osd perm=rw flags=

Parameters:	name (`str`) – goodchars= `[A-Za-z0-9-_.]` ancestor (`Optional`[`str`]) – goodchars= `[A-Za-z0-9-_.]`

osd_crush_rm_device_class(ids)¶

remove class of the osd(s) <id> [<id>…],or use <all|any> to remove all.

Example command:

ceph osd crush rm-device-class --ids=string

module=osd perm=rw flags=

Parameters:	ids (`List`[`str`]) –

osd_crush_rule_create_erasure(name, profile=None)¶

create crush rule <name> for erasure coded pool created with <profile> (default default)

Example command:

ceph osd crush rule create-erasure --name=string --profile=string

module=osd perm=rw flags=

Parameters:	name (`str`) – goodchars= `[A-Za-z0-9-_.]` profile (`Optional`[`str`]) – goodchars= `[A-Za-z0-9-_.=]`

osd_crush_rule_create_replicated(name, root, type_1, class_1=None)¶

create crush rule <name> for replicated pool to start from <root>, replicate across buckets of type <type>, use devices of type <class> (ssd or hdd)

Example command:

ceph osd crush rule create-replicated --name=string --root=string --type=string --class=string

module=osd perm=rw flags=

Parameters:	name (`str`) – goodchars= `[A-Za-z0-9-_.]` root (`str`) – goodchars= `[A-Za-z0-9-_.]` type_1 (`str`) – goodchars= `[A-Za-z0-9-_.]` Real name is `type` class_1 (`Optional`[`str`]) – goodchars= `[A-Za-z0-9-_.]` Real name is `class`

osd_crush_rule_create_simple(name, root, type_1, mode=None)¶

create crush rule <name> to start from <root>, replicate across buckets of type <type>, using a choose mode of <firstn|indep> (default firstn; indep best for erasure pools)

Example command:

ceph osd crush rule create-simple --name=string --root=string --type=string --mode=choice

module=osd perm=rw flags=

Parameters:	name (`str`) – goodchars= `[A-Za-z0-9-_.]` root (`str`) – goodchars= `[A-Za-z0-9-_.]` type_1 (`str`) – goodchars= `[A-Za-z0-9-_.]` Real name is `type` mode (`Optional`[`str`]) – CephChoices strings=firstn\|indep

osd_crush_rule_dump(name=None)¶

dump crush rule <name> (default all)

Example command:

ceph osd crush rule dump --name=string

module=osd perm=r flags=

Parameters:	name (`Optional`[`str`]) – goodchars= `[A-Za-z0-9-_.]`

osd_crush_rule_list()¶

list crush rules

Example command:

ceph osd crush rule list

module=osd perm=r flags=deprecated

osd_crush_rule_ls()¶

list crush rules

Example command:

ceph osd crush rule ls

module=osd perm=r flags=

osd_crush_rule_ls_by_class(class_1)¶

list all crush rules that reference the same <class>

Example command:

ceph osd crush rule ls-by-class --class=string

module=osd perm=r flags=

Parameters:	class_1 (`str`) – goodchars= `[A-Za-z0-9-_.]` Real name is `class`

osd_crush_rule_rename(srcname, dstname)¶

rename crush rule <srcname> to <dstname>

Example command:

ceph osd crush rule rename --srcname=string --dstname=string

module=osd perm=rw flags=

Parameters:	srcname (`str`) – goodchars= `[A-Za-z0-9-_.]` dstname (`str`) – goodchars= `[A-Za-z0-9-_.]`

osd_crush_rule_rm(name)¶

remove crush rule <name>

Example command:

ceph osd crush rule rm --name=string

module=osd perm=rw flags=

Parameters:	name (`str`) – goodchars= `[A-Za-z0-9-_.]`

osd_crush_set_all_straw_buckets_to_straw2()¶

convert all CRUSH current straw buckets to use the straw2 algorithm

Example command:

ceph osd crush set-all-straw-buckets-to-straw2

module=osd perm=rw flags=

osd_crush_set_device_class(class_1, ids)¶

set the <class> of the osd(s) <id> [<id>…],or use <all|any> to set all.

Example command:

ceph osd crush set-device-class --class=string --ids=string

module=osd perm=rw flags=

Parameters:	class_1 (`str`) – Real name is `class` ids (`List`[`str`]) –

osd_crush_set_tunable(tunable, value)¶

set crush tunable <tunable> to <value>

Example command:

ceph osd crush set-tunable --tunable=choice --value=1

module=osd perm=rw flags=

Parameters:	tunable (`str`) – CephChoices strings=straw_calc_version value (`int`) – CephInt

osd_crush_show_tunables()¶

show current crush tunables

Example command:

ceph osd crush show-tunables

module=osd perm=r flags=

osd_crush_swap_bucket(source, dest, yes_i_really_mean_it=None)¶

swap existing bucket contents from (orphan) bucket <source> and <target>

Example command:

ceph osd crush swap-bucket --source=string --dest=string --yes_i_really_mean_it=true

module=osd perm=rw flags=

Parameters:	source (`str`) – goodchars= `[A-Za-z0-9-_.]` dest (`str`) – goodchars= `[A-Za-z0-9-_.]` yes_i_really_mean_it (`Optional`[`bool`]) – CephBool

osd_crush_tree(shadow=None)¶

dump crush buckets and items in a tree view

Example command:

ceph osd crush tree --shadow=choice

module=osd perm=r flags=

Parameters:	shadow (`Optional`[`str`]) – CephChoices strings=–show-shadow

osd_crush_tunables(profile)¶

set crush tunables values to <profile>

Example command:

ceph osd crush tunables --profile=choice

module=osd perm=rw flags=

Parameters:	profile (`str`) – CephChoices strings=legacy\|argonaut\|bobtail\|firefly\|hammer\|jewel\|optimal\|default

osd_crush_unlink(name, ancestor=None)¶

unlink <name> from crush map (everywhere, or just at <ancestor>)

Example command:

ceph osd crush unlink --name=string --ancestor=string

module=osd perm=rw flags=

Parameters:	name (`str`) – goodchars= `[A-Za-z0-9-_.]` ancestor (`Optional`[`str`]) – goodchars= `[A-Za-z0-9-_.]`

osd_crush_weight_set_create(pool, mode)¶

create a weight-set for a given pool

Example command:

ceph osd crush weight-set create --pool=poolname --mode=choice

module=osd perm=rw flags=

Parameters:	pool (`str`) – CephPoolname mode (`str`) – CephChoices strings=flat\|positional

osd_crush_weight_set_create_compat()¶

create a default backward-compatible weight-set

Example command:

ceph osd crush weight-set create-compat

module=osd perm=rw flags=

osd_crush_weight_set_dump()¶

dump crush weight sets

Example command:

ceph osd crush weight-set dump

module=osd perm=r flags=

osd_crush_weight_set_ls()¶

list crush weight sets

Example command:

ceph osd crush weight-set ls

module=osd perm=r flags=

osd_crush_weight_set_reweight(pool, item, weight)¶

set weight for an item (bucket or osd) in a pool’s weight-set

Example command:

ceph osd crush weight-set reweight --pool=poolname --item=string --weight=0.0

module=osd perm=rw flags=

Parameters:	pool (`str`) – CephPoolname item (`str`) – weight (`List`[`float`]) – CephFloat range= `0.0`

osd_crush_weight_set_reweight_compat(item, weight)¶

set weight for an item (bucket or osd) in the backward-compatible weight-set

Example command:

ceph osd crush weight-set reweight-compat --item=string --weight=0.0

module=osd perm=rw flags=

Parameters:	item (`str`) – weight (`List`[`float`]) – CephFloat range= `0.0`

osd_crush_weight_set_rm(pool)¶

remove the weight-set for a given pool

Example command:

ceph osd crush weight-set rm --pool=poolname

module=osd perm=rw flags=

Parameters:	pool (`str`) – CephPoolname

osd_crush_weight_set_rm_compat()¶

remove the backward-compatible weight-set

Example command:

ceph osd crush weight-set rm-compat

module=osd perm=rw flags=

osd_deep_scrub(who)¶

initiate deep scrub on osd <who>, or use <all|any> to deep scrub all

Example command:

ceph osd deep-scrub --who=string

module=osd perm=rw flags=mgr

Parameters:	who (`str`) –

osd_destroy(id_1, force=None, yes_i_really_mean_it=None)¶

mark osd as being destroyed. Keeps the ID intact (allowing reuse), but removes cephx keys, config-key data and lockbox keys, rendering data permanently unreadable.

Example command:

ceph osd destroy --id=osd.0 --force=true --yes_i_really_mean_it=true

module=osd perm=rw flags=mgr

Parameters:	id_1 (`str`) – CephOsdName Real name is `id` force (`Optional`[`bool`]) – CephBool yes_i_really_mean_it (`Optional`[`bool`]) – CephBool

osd_destroy_actual(id_1, yes_i_really_mean_it=None)¶

mark osd as being destroyed. Keeps the ID intact (allowing reuse), but removes cephx keys, config-key data and lockbox keys, rendering data permanently unreadable.

Example command:

ceph osd destroy-actual --id=osd.0 --yes_i_really_mean_it=true

module=osd perm=rw flags=hidden

Parameters:	id_1 (`str`) – CephOsdName Real name is `id` yes_i_really_mean_it (`Optional`[`bool`]) – CephBool

osd_df(output_method=None, filter_by=None, filter=None)¶

show OSD utilization

Example command:

ceph osd df --output_method=choice --filter_by=choice --filter=string

module=osd perm=r flags=mgr

Parameters:	output_method (`Optional`[`str`]) – CephChoices strings=plain\|tree filter_by (`Optional`[`str`]) – CephChoices strings=class\|name filter (`Optional`[`str`]) –

osd_down(ids, definitely_dead=None)¶

set osd(s) <id> [<id>…] down, or use <any|all> to set all osds down

Example command:

ceph osd down --ids=string --definitely_dead=true

module=osd perm=rw flags=

Parameters:	ids (`List`[`str`]) – definitely_dead (`Optional`[`bool`]) – CephBool

osd_dump(epoch=None)¶

print summary of OSD map

Example command:

ceph osd dump --epoch=1

module=osd perm=r flags=

Parameters:	epoch (`Optional`[`int`]) – CephInt range= `0`

osd_erasure_code_profile_get(name)¶

get erasure code profile <name>

Example command:

ceph osd erasure-code-profile get --name=string

module=osd perm=r flags=

Parameters:	name (`str`) – goodchars= `[A-Za-z0-9-_.]`

osd_erasure_code_profile_ls()¶

list all erasure code profiles

Example command:

ceph osd erasure-code-profile ls

module=osd perm=r flags=

osd_erasure_code_profile_rm(name)¶

remove erasure code profile <name>

Example command:

ceph osd erasure-code-profile rm --name=string

module=osd perm=rw flags=

Parameters:	name (`str`) – goodchars= `[A-Za-z0-9-_.]`

osd_erasure_code_profile_set(name, profile=None, force=None)¶

create erasure code profile <name> with [<key[=value]> …] pairs. Add a –force at the end to override an existing profile (VERY DANGEROUS)

Example command:

ceph osd erasure-code-profile set --name=string --profile=string --force=true

module=osd perm=rw flags=

Parameters:	name (`str`) – goodchars= `[A-Za-z0-9-_.]` profile (`Optional`[`List`[`str`]]) – force (`Optional`[`bool`]) – CephBool

osd_find(id_1)¶

find osd <id> in the CRUSH map and show its location

Example command:

ceph osd find --id=osd.0

module=osd perm=r flags=

Parameters:	id_1 (`str`) – CephOsdName Real name is `id`

osd_force_create_pg(pgid, yes_i_really_mean_it=None)¶

force creation of pg <pgid>

Example command:

ceph osd force-create-pg --pgid=0 --yes_i_really_mean_it=true

module=osd perm=rw flags=

Parameters:	pgid (`str`) – CephPgid yes_i_really_mean_it (`Optional`[`bool`]) – CephBool

osd_get_require_min_compat_client()¶

get the minimum client version we will maintain compatibility with

Example command:

ceph osd get-require-min-compat-client

module=osd perm=r flags=

osd_getcrushmap(epoch=None)¶

get CRUSH map

Example command:

ceph osd getcrushmap --epoch=1

module=osd perm=r flags=

Parameters:	epoch (`Optional`[`int`]) – CephInt range= `0`

osd_getmap(epoch=None)¶

get OSD map

Example command:

ceph osd getmap --epoch=1

module=osd perm=r flags=

Parameters:	epoch (`Optional`[`int`]) – CephInt range= `0`

osd_getmaxosd()¶

show largest OSD id

Example command:

ceph osd getmaxosd

module=osd perm=r flags=

osd_in(ids)¶

set osd(s) <id> [<id>…] in, can use <any|all> to automatically set all previously out osds in

Example command:

ceph osd in --ids=string

module=osd perm=rw flags=

Parameters:	ids (`List`[`str`]) –

osd_info(id_1=None)¶

print osd’s {id} information (instead of all osds from map)

Example command:

ceph osd info --id=osd.0

module=osd perm=r flags=

Parameters:	id_1 (`Optional`[`str`]) – CephOsdName Real name is `id`

osd_last_stat_seq(id_1)¶

get the last pg stats sequence number reported for this osd

Example command:

ceph osd last-stat-seq --id=osd.0

module=osd perm=r flags=

Parameters:	id_1 (`str`) – CephOsdName Real name is `id`

osd_lost(id_1, yes_i_really_mean_it=None)¶

mark osd as permanently lost. THIS DESTROYS DATA IF NO MORE REPLICAS EXIST, BE CAREFUL

Example command:

ceph osd lost --id=osd.0 --yes_i_really_mean_it=true

module=osd perm=rw flags=

Parameters:	id_1 (`str`) – CephOsdName Real name is `id` yes_i_really_mean_it (`Optional`[`bool`]) – CephBool

osd_ls(epoch=None)¶

show all OSD ids

Example command:

ceph osd ls --epoch=1

module=osd perm=r flags=

Parameters:	epoch (`Optional`[`int`]) – CephInt range= `0`

osd_ls_tree(name, epoch=None)¶

show OSD ids under bucket <name> in the CRUSH map

Example command:

ceph osd ls-tree --name=string --epoch=1

module=osd perm=r flags=

Parameters:	name (`str`) – epoch (`Optional`[`int`]) – CephInt range= `0`

osd_lspools()¶

list pools

Example command:

ceph osd lspools

module=osd perm=r flags=deprecated

osd_map(pool, object, nspace=None)¶

find pg for <object> in <pool> with [namespace]

Example command:

ceph osd map --pool=poolname --object=objectname --nspace=string

module=osd perm=r flags=

Parameters:	pool (`str`) – CephPoolname object (`str`) – CephObjectname nspace (`Optional`[`str`]) –

osd_metadata(id_1=None)¶

fetch metadata for osd {id} (default all)

Example command:

ceph osd metadata --id=osd.0

module=osd perm=r flags=

Parameters:	id_1 (`Optional`[`str`]) – CephOsdName Real name is `id`

osd_new(uuid, id_1=None)¶

Create a new OSD. If supplied, the id to be replaced needs to exist and have been previously destroyed. Reads secrets from JSON file via -i <file> (see man page).

Example command:

ceph osd new --uuid=uuid --id=osd.0

module=osd perm=rw flags=

Parameters:	uuid (`str`) – CephUUID id_1 (`Optional`[`str`]) – CephOsdName Real name is `id`

osd_numa_status()¶

show NUMA status of OSDs

Example command:

ceph osd numa-status

module=osd perm=r flags=

osd_ok_to_stop(ids)¶

check whether osd(s) can be safely stopped without reducing immediate data availability

Example command:

ceph osd ok-to-stop --ids=string

module=osd perm=r flags=mgr

Parameters:	ids (`List`[`str`]) –

osd_out(ids)¶

set osd(s) <id> [<id>…] out, or use <any|all> to set all osds out

Example command:

ceph osd out --ids=string

module=osd perm=rw flags=

Parameters:	ids (`List`[`str`]) –

osd_pause()¶

pause osd

Example command:

ceph osd pause

module=osd perm=rw flags=

osd_perf()¶

print dump of OSD perf summary stats

Example command:

ceph osd perf

module=osd perm=r flags=mgr

osd_perf_counters_get(query_id)¶

fetch osd perf counters

Example command:

ceph osd perf counters get --query_id=1

module=mgr perm=w flags=mgr

Parameters:	query_id (`int`) – CephInt

osd_perf_query_add(query)¶

add osd perf query

Example command:

ceph osd perf query add --query=choice

module=mgr perm=w flags=mgr

Parameters:	query (`str`) – CephChoices strings=client_id\|rbd_image_id\|all_subkeys

osd_perf_query_remove(query_id)¶

remove osd perf query

Example command:

ceph osd perf query remove --query_id=1

module=mgr perm=w flags=mgr

Parameters:	query_id (`int`) – CephInt

osd_pg_temp(pgid, id_1=None)¶

set pg_temp mapping pgid:[<id> [<id>…]] (developers only)

Example command:

ceph osd pg-temp --pgid=0 --id=osd.0

module=osd perm=rw flags=

Parameters:	pgid (`str`) – CephPgid id_1 (`Optional`[`List`[`str`]]) – CephOsdName Real name is `id`

osd_pg_upmap(pgid, id_1)¶

set pg_upmap mapping <pgid>:[<id> [<id>…]] (developers only)

Example command:

ceph osd pg-upmap --pgid=0 --id=osd.0

module=osd perm=rw flags=

Parameters:	pgid (`str`) – CephPgid id_1 (`List`[`str`]) – CephOsdName Real name is `id`

osd_pg_upmap_items(pgid, id_1)¶

set pg_upmap_items mapping <pgid>:{<id> to <id>, […]} (developers only)

Example command:

ceph osd pg-upmap-items --pgid=0 --id=osd.0

module=osd perm=rw flags=

Parameters:	pgid (`str`) – CephPgid id_1 (`List`[`str`]) – CephOsdName Real name is `id`

osd_pool_application_disable(pool, app, yes_i_really_mean_it=None)¶

disables use of an application <app> on pool <poolname>

Example command:

ceph osd pool application disable --pool=poolname --app=string --yes_i_really_mean_it=true

module=osd perm=rw flags=

Parameters:	pool (`str`) – CephPoolname app (`str`) – yes_i_really_mean_it (`Optional`[`bool`]) – CephBool

osd_pool_application_enable(pool, app, yes_i_really_mean_it=None)¶

enable use of an application <app> [cephfs,rbd,rgw] on pool <poolname>

Example command:

ceph osd pool application enable --pool=poolname --app=string --yes_i_really_mean_it=true

module=osd perm=rw flags=

Parameters:	pool (`str`) – CephPoolname app (`str`) – goodchars= `[A-Za-z0-9-_.]` yes_i_really_mean_it (`Optional`[`bool`]) – CephBool

osd_pool_application_get(pool, app=None, key=None)¶

get value of key <key> of application <app> on pool <poolname>

Example command:

ceph osd pool application get --pool=poolname --app=string --key=string

module=osd perm=r flags=

Parameters:	pool (`str`) – CephPoolname app (`Optional`[`str`]) – key (`Optional`[`str`]) –

osd_pool_application_rm(pool, app, key)¶

removes application <app> metadata key <key> on pool <poolname>

Example command:

ceph osd pool application rm --pool=poolname --app=string --key=string

module=osd perm=rw flags=

Parameters:	pool (`str`) – CephPoolname app (`str`) – key (`str`) –

osd_pool_application_set(pool, app, key, value)¶

sets application <app> metadata key <key> to <value> on pool <poolname>

Example command:

ceph osd pool application set --pool=poolname --app=string --key=string --value=string

module=osd perm=rw flags=

Parameters:	pool (`str`) – CephPoolname app (`str`) – key (`str`) – goodchars= `[A-Za-z0-9-_.]` value (`str`) – goodchars= `[A-Za-z0-9-_.=]`

osd_pool_autoscale_status()¶

report on pool pg_num sizing recommendation and intent

Example command:

ceph osd pool autoscale-status

module=mgr perm=r flags=mgr

osd_pool_cancel_force_backfill(who)¶

restore normal recovery priority of specified pool <who>

Example command:

ceph osd pool cancel-force-backfill --who=poolname

module=osd perm=rw flags=mgr

Parameters:	who (`List`[`str`]) – CephPoolname

osd_pool_cancel_force_recovery(who)¶

restore normal recovery priority of specified pool <who>

Example command:

ceph osd pool cancel-force-recovery --who=poolname

module=osd perm=rw flags=mgr

Parameters:	who (`List`[`str`]) – CephPoolname

osd_pool_create(pool, pg_num=None, pgp_num=None, pool_type=None, erasure_code_profile=None, rule=None, expected_num_objects=None, size=None, pg_num_min=None, target_size_bytes=None, target_size_ratio=None)¶

create pool

Example command:

ceph osd pool create --pool=poolname --pg_num=1 --pgp_num=1 --pool_type=choice --erasure_code_profile=string --rule=string --expected_num_objects=1 --size=1 --pg_num_min=1 --target_size_bytes=1 --target_size_ratio=0.0

module=osd perm=rw flags=

Parameters:

pool (str) – CephPoolname
pg_num (Optional[int]) – CephInt range= 0
pgp_num (Optional[int]) – CephInt range= 0
pool_type (Optional[str]) – CephChoices strings=replicated|erasure
erasure_code_profile (Optional[str]) – goodchars= [A-Za-z0-9-_.]
rule (Optional[str]) –
expected_num_objects (Optional[int]) – CephInt range= 0
size (Optional[int]) – CephInt range= 0
pg_num_min (Optional[int]) – CephInt range= 0
target_size_bytes (Optional[int]) – CephInt range= 0
target_size_ratio (Optional[float]) – CephFloat range= 0..1

osd_pool_deep_scrub(who)¶

initiate deep-scrub on pool <who>

Example command:

ceph osd pool deep-scrub --who=poolname

module=osd perm=rw flags=mgr

Parameters:	who (`List`[`str`]) – CephPoolname

osd_pool_delete(pool, pool2=None, yes_i_really_really_mean_it=None, yes_i_really_really_mean_it_not_faking=None)¶

delete pool

Example command:

ceph osd pool delete --pool=poolname --pool2=poolname --yes_i_really_really_mean_it=true --yes_i_really_really_mean_it_not_faking=true

module=osd perm=rw flags=deprecated

Parameters:	pool (`str`) – CephPoolname pool2 (`Optional`[`str`]) – CephPoolname yes_i_really_really_mean_it (`Optional`[`bool`]) – CephBool yes_i_really_really_mean_it_not_faking (`Optional`[`bool`]) – CephBool

osd_pool_force_backfill(who)¶

force backfill of specified pool <who> first

Example command:

ceph osd pool force-backfill --who=poolname

module=osd perm=rw flags=mgr

Parameters:	who (`List`[`str`]) – CephPoolname

osd_pool_force_recovery(who)¶

force recovery of specified pool <who> first

Example command:

ceph osd pool force-recovery --who=poolname

module=osd perm=rw flags=mgr

Parameters:	who (`List`[`str`]) – CephPoolname

osd_pool_get(pool, var)¶

get pool parameter <var>

Example command:

ceph osd pool get --pool=poolname --var=choice

module=osd perm=r flags=

Parameters:

pool (str) – CephPoolname
var (str) – CephChoices strings=size|min_size|pg_num|pgp_num|crush_rul e|hashpspool|nodelete|nopgchange|nosizechange|write_fadvise_dontneed|n oscrub|nodeep-scrub|hit_set_type|hit_set_period|hit_set_count|hit_set_ fpp|use_gmt_hitset|target_max_objects|target_max_bytes|cache_target_di rty_ratio|cache_target_dirty_high_ratio|cache_target_full_ratio|cache_ min_flush_age|cache_min_evict_age|erasure_code_profile|min_read_recenc y_for_promote|all|min_write_recency_for_promote|fast_read|hit_set_grad e_decay_rate|hit_set_search_last_n|scrub_min_interval|scrub_max_interv al|deep_scrub_interval|recovery_priority|recovery_op_priority|scrub_pr iority|compression_mode|compression_algorithm|compression_required_rat io|compression_max_blob_size|compression_min_blob_size|csum_type|csum_ min_block|csum_max_block|allow_ec_overwrites|fingerprint_algorithm|pg_ autoscale_mode|pg_autoscale_bias|pg_num_min|target_size_bytes|target_s ize_ratio

osd_pool_get_quota(pool)¶

obtain object or byte limits for pool

Example command:

ceph osd pool get-quota --pool=poolname

module=osd perm=r flags=

Parameters:	pool (`str`) – CephPoolname

osd_pool_ls(detail=None)¶

list pools

Example command:

ceph osd pool ls --detail=choice

module=osd perm=r flags=

Parameters:	detail (`Optional`[`str`]) – CephChoices strings=detail

osd_pool_mksnap(pool, snap)¶

make snapshot <snap> in <pool>

Example command:

ceph osd pool mksnap --pool=poolname --snap=string

module=osd perm=rw flags=

Parameters:	pool (`str`) – CephPoolname snap (`str`) –

osd_pool_rename(srcpool, destpool)¶

rename <srcpool> to <destpool>

Example command:

ceph osd pool rename --srcpool=poolname --destpool=poolname

module=osd perm=rw flags=

Parameters:	srcpool (`str`) – CephPoolname destpool (`str`) – CephPoolname

osd_pool_repair(who)¶

initiate repair on pool <who>

Example command:

ceph osd pool repair --who=poolname

module=osd perm=rw flags=mgr

Parameters:	who (`List`[`str`]) – CephPoolname

osd_pool_rm(pool, pool2=None, yes_i_really_really_mean_it=None, yes_i_really_really_mean_it_not_faking=None)¶

remove pool

Example command:

ceph osd pool rm --pool=poolname --pool2=poolname --yes_i_really_really_mean_it=true --yes_i_really_really_mean_it_not_faking=true

module=osd perm=rw flags=

Parameters:	pool (`str`) – CephPoolname pool2 (`Optional`[`str`]) – CephPoolname yes_i_really_really_mean_it (`Optional`[`bool`]) – CephBool yes_i_really_really_mean_it_not_faking (`Optional`[`bool`]) – CephBool

osd_pool_rmsnap(pool, snap)¶

remove snapshot <snap> from <pool>

Example command:

ceph osd pool rmsnap --pool=poolname --snap=string

module=osd perm=rw flags=

Parameters:	pool (`str`) – CephPoolname snap (`str`) –

osd_pool_scrub(who)¶

initiate scrub on pool <who>

Example command:

ceph osd pool scrub --who=poolname

module=osd perm=rw flags=mgr

Parameters:	who (`List`[`str`]) – CephPoolname

osd_pool_set(pool, var, val, yes_i_really_mean_it=None)¶

set pool parameter <var> to <val>

Example command:

ceph osd pool set --pool=poolname --var=choice --val=string --yes_i_really_mean_it=true

module=osd perm=rw flags=

Parameters:

pool (str) – CephPoolname
var (str) – CephChoices strings=size|min_size|pg_num|pgp_num|pgp_num_a ctual|crush_rule|hashpspool|nodelete|nopgchange|nosizechange|write_fad vise_dontneed|noscrub|nodeep-scrub|hit_set_type|hit_set_period|hit_set _count|hit_set_fpp|use_gmt_hitset|target_max_bytes|target_max_objects| cache_target_dirty_ratio|cache_target_dirty_high_ratio|cache_target_fu ll_ratio|cache_min_flush_age|cache_min_evict_age|min_read_recency_for_ promote|min_write_recency_for_promote|fast_read|hit_set_grade_decay_ra te|hit_set_search_last_n|scrub_min_interval|scrub_max_interval|deep_sc rub_interval|recovery_priority|recovery_op_priority|scrub_priority|com pression_mode|compression_algorithm|compression_required_ratio|compres sion_max_blob_size|compression_min_blob_size|csum_type|csum_min_block| csum_max_block|allow_ec_overwrites|fingerprint_algorithm|pg_autoscale_ mode|pg_autoscale_bias|pg_num_min|target_size_bytes|target_size_ratio
val (str) –
yes_i_really_mean_it (Optional[bool]) – CephBool

osd_pool_set_quota(pool, field, val)¶

set object or byte limit on pool

Example command:

ceph osd pool set-quota --pool=poolname --field=choice --val=string

module=osd perm=rw flags=

Parameters:	pool (`str`) – CephPoolname field (`str`) – CephChoices strings=max_objects\|max_bytes val (`str`) –

osd_pool_stats(pool_name=None)¶

obtain stats from all pools, or from specified pool

Example command:

ceph osd pool stats --pool_name=poolname

module=osd perm=r flags=mgr

Parameters:	pool_name (`Optional`[`str`]) – CephPoolname

osd_primary_affinity(id_1, weight)¶

adjust osd primary-affinity from 0.0 <= <weight> <= 1.0

Example command:

ceph osd primary-affinity --id=osd.0 --weight=0.0

module=osd perm=rw flags=

Parameters:	id_1 (`str`) – CephOsdName Real name is `id` weight (`float`) – CephFloat range= `0.0..1.0`

osd_primary_temp(pgid, id_1)¶

set primary_temp mapping pgid:<id>|-1 (developers only)

Example command:

ceph osd primary-temp --pgid=0 --id=osd.0

module=osd perm=rw flags=

Parameters:	pgid (`str`) – CephPgid id_1 (`str`) – CephOsdName Real name is `id`

osd_purge(id_1, force=None, yes_i_really_mean_it=None)¶

purge all osd data from the monitors including the OSD id and CRUSH position

Example command:

ceph osd purge --id=osd.0 --force=true --yes_i_really_mean_it=true

module=osd perm=rw flags=mgr

Parameters:	id_1 (`str`) – CephOsdName Real name is `id` force (`Optional`[`bool`]) – CephBool yes_i_really_mean_it (`Optional`[`bool`]) – CephBool

osd_purge_actual(id_1, yes_i_really_mean_it=None)¶

purge all osd data from the monitors. Combines osd destroy, osd rm, and osd crush rm.

Example command:

ceph osd purge-actual --id=osd.0 --yes_i_really_mean_it=true

module=osd perm=rw flags=hidden

Parameters:	id_1 (`str`) – CephOsdName Real name is `id` yes_i_really_mean_it (`Optional`[`bool`]) – CephBool

osd_purge_new(id_1, yes_i_really_mean_it=None)¶

purge all traces of an OSD that was partially created but never started

Example command:

ceph osd purge-new --id=osd.0 --yes_i_really_mean_it=true

module=osd perm=rw flags=

Parameters:	id_1 (`str`) – CephOsdName Real name is `id` yes_i_really_mean_it (`Optional`[`bool`]) – CephBool

osd_repair(who)¶

initiate repair on osd <who>, or use <all|any> to repair all

Example command:

ceph osd repair --who=string

module=osd perm=rw flags=mgr

Parameters:	who (`str`) –

osd_require_osd_release(release, yes_i_really_mean_it=None)¶

set the minimum allowed OSD release to participate in the cluster

Example command:

ceph osd require-osd-release --release=choice --yes_i_really_mean_it=true

module=osd perm=rw flags=

Parameters:	release (`str`) – CephChoices strings=luminous\|mimic\|nautilus\|octopus yes_i_really_mean_it (`Optional`[`bool`]) – CephBool

osd_reweight(id_1, weight)¶

reweight osd to 0.0 < <weight> < 1.0

Example command:

ceph osd reweight --id=osd.0 --weight=0.0

module=osd perm=rw flags=

Parameters:	id_1 (`str`) – CephOsdName Real name is `id` weight (`float`) – CephFloat range= `0.0..1.0`

osd_reweight_by_pg(oload=None, max_change=None, max_osds=None, pools=None)¶

reweight OSDs by PG distribution [overload-percentage-for- consideration, default 120]

Example command:

ceph osd reweight-by-pg --oload=1 --max_change=0.0 --max_osds=1 --pools=poolname

module=osd perm=rw flags=mgr

Parameters:	oload (`Optional`[`int`]) – CephInt max_change (`Optional`[`float`]) – CephFloat max_osds (`Optional`[`int`]) – CephInt pools (`Optional`[`List`[`str`]]) – CephPoolname

osd_reweight_by_utilization(oload=None, max_change=None, max_osds=None, no_increasing=None)¶

reweight OSDs by utilization [overload-percentage-for-consideration, default 120]

Example command:

ceph osd reweight-by-utilization --oload=1 --max_change=0.0 --max_osds=1 --no_increasing=choice

module=osd perm=rw flags=mgr

Parameters:	oload (`Optional`[`int`]) – CephInt max_change (`Optional`[`float`]) – CephFloat max_osds (`Optional`[`int`]) – CephInt no_increasing (`Optional`[`str`]) – CephChoices strings=–no-increasing

osd_reweightn(weights)¶

reweight osds with {<id>: <weight>,…})

Example command:

ceph osd reweightn --weights=string

module=osd perm=rw flags=

Parameters:	weights (`str`) –

osd_rm(ids)¶

remove osd(s) <id> [<id>…], or use <any|all> to remove all osds

Example command:

ceph osd rm --ids=string

module=osd perm=rw flags=deprecated

Parameters:	ids (`List`[`str`]) –

osd_rm_nodown(ids)¶

allow osd(s) <id> [<id>…] to be marked down (if they are currently marked as nodown), can use <all|any> to automatically filter out all nodown osds

Example command:

ceph osd rm-nodown --ids=string

module=osd perm=rw flags=deprecated

Parameters:	ids (`List`[`str`]) –

osd_rm_noin(ids)¶

allow osd(s) <id> [<id>…] to be marked in (if they are currently marked as noin), can use <all|any> to automatically filter out all noin osds

Example command:

ceph osd rm-noin --ids=string

module=osd perm=rw flags=deprecated

Parameters:	ids (`List`[`str`]) –

osd_rm_noout(ids)¶

allow osd(s) <id> [<id>…] to be marked out (if they are currently marked as noout), can use <all|any> to automatically filter out all noout osds

Example command:

ceph osd rm-noout --ids=string

module=osd perm=rw flags=deprecated

Parameters:	ids (`List`[`str`]) –

osd_rm_noup(ids)¶

allow osd(s) <id> [<id>…] to be marked up (if they are currently marked as noup), can use <all|any> to automatically filter out all noup osds

Example command:

ceph osd rm-noup --ids=string

module=osd perm=rw flags=deprecated

Parameters:	ids (`List`[`str`]) –

osd_rm_pg_upmap(pgid)¶

clear pg_upmap mapping for <pgid> (developers only)

Example command:

ceph osd rm-pg-upmap --pgid=0

module=osd perm=rw flags=

Parameters:	pgid (`str`) – CephPgid

osd_rm_pg_upmap_items(pgid)¶

clear pg_upmap_items mapping for <pgid> (developers only)

Example command:

ceph osd rm-pg-upmap-items --pgid=0

module=osd perm=rw flags=

Parameters:	pgid (`str`) – CephPgid

osd_safe_to_destroy(ids)¶

check whether osd(s) can be safely destroyed without reducing data durability

Example command:

ceph osd safe-to-destroy --ids=string

module=osd perm=r flags=mgr

Parameters:	ids (`List`[`str`]) –

osd_scrub(who)¶

initiate scrub on osd <who>, or use <all|any> to scrub all

Example command:

ceph osd scrub --who=string

module=osd perm=rw flags=mgr

Parameters:	who (`str`) –

osd_set(key, yes_i_really_mean_it=None)¶

set <key>

Example command:

ceph osd set --key=choice --yes_i_really_mean_it=true

module=osd perm=rw flags=

Parameters:	key (`str`) – CephChoices strings=full\|pause\|noup\|nodown\|noout\|noin\|noba ckfill\|norebalance\|norecover\|noscrub\|nodeep- scrub\|notieragent\|nosnaptrim\|pglog_hardlimit yes_i_really_mean_it (`Optional`[`bool`]) – CephBool

osd_set_backfillfull_ratio(ratio)¶

set usage ratio at which OSDs are marked too full to backfill

Example command:

ceph osd set-backfillfull-ratio --ratio=0.0

module=osd perm=rw flags=

Parameters:	ratio (`float`) – CephFloat range= `0.0..1.0`

osd_set_full_ratio(ratio)¶

set usage ratio at which OSDs are marked full

Example command:

ceph osd set-full-ratio --ratio=0.0

module=osd perm=rw flags=

Parameters:	ratio (`float`) – CephFloat range= `0.0..1.0`

osd_set_group(flags, who)¶

set <flags> for batch osds or crush nodes, <flags> must be a comma- separated subset of {noup,nodown,noin,noout}

Example command:

ceph osd set-group --flags=string --who=string

module=osd perm=rw flags=

Parameters:	flags (`str`) – who (`List`[`str`]) –

osd_set_nearfull_ratio(ratio)¶

set usage ratio at which OSDs are marked near-full

Example command:

ceph osd set-nearfull-ratio --ratio=0.0

module=osd perm=rw flags=

Parameters:	ratio (`float`) – CephFloat range= `0.0..1.0`

osd_set_require_min_compat_client(version, yes_i_really_mean_it=None)¶

set the minimum client version we will maintain compatibility with

Example command:

ceph osd set-require-min-compat-client --version=string --yes_i_really_mean_it=true

module=osd perm=rw flags=

Parameters:	version (`str`) – yes_i_really_mean_it (`Optional`[`bool`]) – CephBool

osd_setcrushmap(prior_version=None)¶

set crush map from input file

Example command:

ceph osd setcrushmap --prior_version=1

module=osd perm=rw flags=

Parameters:	prior_version (`Optional`[`int`]) – CephInt

osd_setmaxosd(newmax)¶

set new maximum osd value

Example command:

ceph osd setmaxosd --newmax=1

module=osd perm=rw flags=

Parameters:	newmax (`int`) – CephInt range= `0`

osd_stat()¶

print summary of OSD map

Example command:

ceph osd stat

module=osd perm=r flags=

osd_status(bucket=None)¶

Show the status of OSDs within a bucket, or all

Example command:

ceph osd status --bucket=string

module=mgr perm=r flags=mgr

Parameters:	bucket (`Optional`[`str`]) –

osd_stop(ids)¶

stop the corresponding osd daemons and mark them as down

Example command:

ceph osd stop --ids=string

module=osd perm=rw flags=

Parameters:	ids (`List`[`str`]) –

osd_test_reweight_by_pg(oload=None, max_change=None, max_osds=None, pools=None)¶

dry run of reweight OSDs by PG distribution [overload-percentage-for- consideration, default 120]

Example command:

ceph osd test-reweight-by-pg --oload=1 --max_change=0.0 --max_osds=1 --pools=poolname

module=osd perm=r flags=mgr

Parameters:	oload (`Optional`[`int`]) – CephInt max_change (`Optional`[`float`]) – CephFloat max_osds (`Optional`[`int`]) – CephInt pools (`Optional`[`List`[`str`]]) – CephPoolname

osd_test_reweight_by_utilization(oload=None, max_change=None, max_osds=None, no_increasing=None)¶

dry run of reweight OSDs by utilization [overload-percentage-for- consideration, default 120]

Example command:

ceph osd test-reweight-by-utilization --oload=1 --max_change=0.0 --max_osds=1 --no_increasing=true

module=osd perm=r flags=mgr

Parameters:	oload (`Optional`[`int`]) – CephInt max_change (`Optional`[`float`]) – CephFloat max_osds (`Optional`[`int`]) – CephInt no_increasing (`Optional`[`bool`]) – CephBool

osd_tier_add(pool, tierpool, force_nonempty=None)¶

add the tier <tierpool> (the second one) to base pool <pool> (the first one)

Example command:

ceph osd tier add --pool=poolname --tierpool=poolname --force_nonempty=choice

module=osd perm=rw flags=

Parameters:	pool (`str`) – CephPoolname tierpool (`str`) – CephPoolname force_nonempty (`Optional`[`str`]) – CephChoices strings=–force-nonempty

osd_tier_add_cache(pool, tierpool, size)¶

add a cache <tierpool> (the second one) of size <size> to existing pool <pool> (the first one)

Example command:

ceph osd tier add-cache --pool=poolname --tierpool=poolname --size=1

module=osd perm=rw flags=

Parameters:	pool (`str`) – CephPoolname tierpool (`str`) – CephPoolname size (`int`) – CephInt range= `0`

osd_tier_cache_mode(pool, mode, yes_i_really_mean_it=None)¶

specify the caching mode for cache tier <pool>

Example command:

ceph osd tier cache-mode --pool=poolname --mode=choice --yes_i_really_mean_it=true

module=osd perm=rw flags=

Parameters:	pool (`str`) – CephPoolname mode (`str`) – CephChoices strings=none\|writeback\|forward\|readonly\|readforward\|proxy\|readproxy yes_i_really_mean_it (`Optional`[`bool`]) – CephBool

osd_tier_remove(pool, tierpool)¶

remove the tier <tierpool> (the second one) from base pool <pool> (the first one)

Example command:

ceph osd tier remove --pool=poolname --tierpool=poolname

module=osd perm=rw flags=deprecated

Parameters:	pool (`str`) – CephPoolname tierpool (`str`) – CephPoolname

osd_tier_remove_overlay(pool)¶

remove the overlay pool for base pool <pool>

Example command:

ceph osd tier remove-overlay --pool=poolname

module=osd perm=rw flags=deprecated

Parameters:	pool (`str`) – CephPoolname

osd_tier_rm(pool, tierpool)¶

remove the tier <tierpool> (the second one) from base pool <pool> (the first one)

Example command:

ceph osd tier rm --pool=poolname --tierpool=poolname

module=osd perm=rw flags=

Parameters:	pool (`str`) – CephPoolname tierpool (`str`) – CephPoolname

osd_tier_rm_overlay(pool)¶

remove the overlay pool for base pool <pool>

Example command:

ceph osd tier rm-overlay --pool=poolname

module=osd perm=rw flags=

Parameters:	pool (`str`) – CephPoolname

osd_tier_set_overlay(pool, overlaypool)¶

set the overlay pool for base pool <pool> to be <overlaypool>

Example command:

ceph osd tier set-overlay --pool=poolname --overlaypool=poolname

module=osd perm=rw flags=

Parameters:	pool (`str`) – CephPoolname overlaypool (`str`) – CephPoolname

osd_tree(epoch=None, states=None)¶

print OSD tree

Example command:

ceph osd tree --epoch=1 --states=choice

module=osd perm=r flags=

Parameters:	epoch (`Optional`[`int`]) – CephInt range= `0` states (`Optional`[`List`[`str`]]) – CephChoices strings=up\|down\|in\|out\|destroyed

osd_tree_from(bucket, epoch=None, states=None)¶

print OSD tree in bucket

Example command:

ceph osd tree-from --bucket=string --epoch=1 --states=choice

module=osd perm=r flags=

Parameters:	bucket (`str`) – epoch (`Optional`[`int`]) – CephInt range= `0` states (`Optional`[`List`[`str`]]) – CephChoices strings=up\|down\|in\|out\|destroyed

osd_unpause()¶

unpause osd

Example command:

ceph osd unpause

module=osd perm=rw flags=

osd_unset(key)¶

unset <key>

Example command:

ceph osd unset --key=choice

module=osd perm=rw flags=

Parameters:	key (`str`) – CephChoices strings=full\|pause\|noup\|nodown\|noout\|noin\|noba ckfill\|norebalance\|norecover\|noscrub\|nodeep- scrub\|notieragent\|nosnaptrim

osd_unset_group(flags, who)¶

unset <flags> for batch osds or crush nodes, <flags> must be a comma- separated subset of {noup,nodown,noin,noout}

Example command:

ceph osd unset-group --flags=string --who=string

module=osd perm=rw flags=

Parameters:	flags (`str`) – who (`List`[`str`]) –

osd_utilization()¶

get basic pg distribution stats

Example command:

ceph osd utilization

module=osd perm=r flags=

osd_versions()¶

check running versions of OSDs

Example command:

ceph osd versions

module=osd perm=r flags=

pg_cancel_force_backfill(pgid)¶

restore normal backfill priority of <pgid>

Example command:

ceph pg cancel-force-backfill --pgid=0

module=pg perm=rw flags=mgr

Parameters:	pgid (`List`[`str`]) – CephPgid

pg_cancel_force_recovery(pgid)¶

restore normal recovery priority of <pgid>

Example command:

ceph pg cancel-force-recovery --pgid=0

module=pg perm=rw flags=mgr

Parameters:	pgid (`List`[`str`]) – CephPgid

pg_debug(debugop)¶

show debug info about pgs

Example command:

ceph pg debug --debugop=choice

module=pg perm=r flags=mgr

Parameters:	debugop (`str`) – CephChoices strings=unfound_objects_exist\|degraded_pgs_exist

pg_deep_scrub(pgid)¶

start deep-scrub on <pgid>

Example command:

ceph pg deep-scrub --pgid=0

module=pg perm=rw flags=mgr

Parameters:	pgid (`str`) – CephPgid

pg_dump(dumpcontents=None)¶

show human-readable versions of pg map (only ‘all’ valid with plain)

Example command:

ceph pg dump --dumpcontents=choice

module=pg perm=r flags=mgr

Parameters:	dumpcontents (`Optional`[`List`[`str`]]) – CephChoices strings=all\|summary\|sum\|delta\|pools\|osds\|pgs\|pgs_brief

pg_dump_json(dumpcontents=None)¶

show human-readable version of pg map in json only

Example command:

ceph pg dump_json --dumpcontents=choice

module=pg perm=r flags=mgr

Parameters:	dumpcontents (`Optional`[`List`[`str`]]) – CephChoices strings=all\|summary\|sum\|pools\|osds\|pgs

pg_dump_pools_json()¶

show pg pools info in json only

Example command:

ceph pg dump_pools_json

module=pg perm=r flags=mgr

pg_dump_stuck(stuckops=None, threshold=None)¶

show information about stuck pgs

Example command:

ceph pg dump_stuck --stuckops=choice --threshold=1

module=pg perm=r flags=mgr

Parameters:	stuckops (`Optional`[`List`[`str`]]) – CephChoices strings=inactive\|unclean\|stale\|undersized\|degraded threshold (`Optional`[`int`]) – CephInt

pg_force_backfill(pgid)¶

force backfill of <pgid> first

Example command:

ceph pg force-backfill --pgid=0

module=pg perm=rw flags=mgr

Parameters:	pgid (`List`[`str`]) – CephPgid

pg_force_recovery(pgid)¶

force recovery of <pgid> first

Example command:

ceph pg force-recovery --pgid=0

module=pg perm=rw flags=mgr

Parameters:	pgid (`List`[`str`]) – CephPgid

pg_getmap()¶

get binary pg map to -o/stdout

Example command:

ceph pg getmap

module=pg perm=r flags=mgr

pg_ls(pool=None, states=None)¶

list pg with specific pool, osd, state

Example command:

ceph pg ls --pool=1 --states=string

module=pg perm=r flags=mgr

Parameters:	pool (`Optional`[`int`]) – CephInt states (`Optional`[`List`[`str`]]) –

pg_ls_by_osd(osd, pool=None, states=None)¶

list pg on osd [osd]

Example command:

ceph pg ls-by-osd --osd=osd.0 --pool=1 --states=string

module=pg perm=r flags=mgr

Parameters:	osd (`str`) – CephOsdName pool (`Optional`[`int`]) – CephInt states (`Optional`[`List`[`str`]]) –

pg_ls_by_pool(poolstr, states=None)¶

list pg with pool = [poolname]

Example command:

ceph pg ls-by-pool --poolstr=string --states=string

module=pg perm=r flags=mgr

Parameters:	poolstr (`str`) – states (`Optional`[`List`[`str`]]) –

pg_ls_by_primary(osd, pool=None, states=None)¶

list pg with primary = [osd]

Example command:

ceph pg ls-by-primary --osd=osd.0 --pool=1 --states=string

module=pg perm=r flags=mgr

Parameters:	osd (`str`) – CephOsdName pool (`Optional`[`int`]) – CephInt states (`Optional`[`List`[`str`]]) –

pg_map(pgid)¶

show mapping of pg to osds

Example command:

ceph pg map --pgid=0

module=pg perm=r flags=

Parameters:	pgid (`str`) – CephPgid

pg_repair(pgid)¶

start repair on <pgid>

Example command:

ceph pg repair --pgid=0

module=pg perm=rw flags=mgr

Parameters:	pgid (`str`) – CephPgid

pg_repeer(pgid)¶

force a PG to repeer

Example command:

ceph pg repeer --pgid=0

module=osd perm=rw flags=

Parameters:	pgid (`str`) – CephPgid

pg_scrub(pgid)¶

start scrub on <pgid>

Example command:

ceph pg scrub --pgid=0

module=pg perm=rw flags=mgr

Parameters:	pgid (`str`) – CephPgid

pg_stat()¶

show placement group status.

Example command:

ceph pg stat

module=pg perm=r flags=mgr

progress()¶

Show progress of recovery operations

Example command:

ceph progress

module=mgr perm=r flags=mgr

progress_clear()¶

Reset progress tracking

Example command:

ceph progress clear

module=mgr perm=rw flags=mgr

progress_json()¶

Show machine readable progress information

Example command:

ceph progress json

module=mgr perm=r flags=mgr

prometheus_file_sd_config()¶

Return file_sd compatible prometheus config for mgr cluster

Example command:

ceph prometheus file_sd_config

module=mgr perm=r flags=mgr

quorum_enter()¶

force monitor back into quorum

Example command:

ceph quorum enter

module=mon perm=rw flags=hidden, no_forward

quorum_exit()¶

force monitor out of the quorum

Example command:

ceph quorum exit

module=mon perm=rw flags=hidden, no_forward

quorum_status()¶

report status of monitor quorum

Example command:

ceph quorum_status

module=mon perm=r flags=

rbd_perf_image_counters(pool_spec=None, sort_by=None)¶

Retrieve current RBD IO performance counters

Example command:

ceph rbd perf image counters --pool_spec=string --sort_by=choice

module=mgr perm=r flags=mgr

Parameters:	pool_spec (`Optional`[`str`]) – sort_by (`Optional`[`str`]) – CephChoices strings=write_ops\|write_bytes\|write_latenc y\|read_ops\|read_bytes\|read_latency

rbd_perf_image_stats(pool_spec=None, sort_by=None)¶

Retrieve current RBD IO performance stats

Example command:

ceph rbd perf image stats --pool_spec=string --sort_by=choice

module=mgr perm=r flags=mgr

Parameters:	pool_spec (`Optional`[`str`]) – sort_by (`Optional`[`str`]) – CephChoices strings=write_ops\|write_bytes\|write_latenc y\|read_ops\|read_bytes\|read_latency

rbd_task_add_flatten(image_spec)¶

Flatten a cloned image asynchronously in the background

Example command:

ceph rbd task add flatten --image_spec=string

module=mgr perm=w flags=mgr

Parameters:	image_spec (`str`) –

rbd_task_add_migration_abort(image_spec)¶

Abort a prepared migration asynchronously in the background

Example command:

ceph rbd task add migration abort --image_spec=string

module=mgr perm=w flags=mgr

Parameters:	image_spec (`str`) –

rbd_task_add_migration_commit(image_spec)¶

Commit an executed migration asynchronously in the background

Example command:

ceph rbd task add migration commit --image_spec=string

module=mgr perm=w flags=mgr

Parameters:	image_spec (`str`) –

rbd_task_add_migration_execute(image_spec)¶

Execute an image migration asynchronously in the background

Example command:

ceph rbd task add migration execute --image_spec=string

module=mgr perm=w flags=mgr

Parameters:	image_spec (`str`) –

rbd_task_add_remove(image_spec)¶

Remove an image asynchronously in the background

Example command:

ceph rbd task add remove --image_spec=string

module=mgr perm=w flags=mgr

Parameters:	image_spec (`str`) –

rbd_task_add_trash_remove(image_id_spec)¶

Remove an image from the trash asynchronously in the background

Example command:

ceph rbd task add trash remove --image_id_spec=string

module=mgr perm=w flags=mgr

Parameters:	image_id_spec (`str`) –

rbd_task_cancel(task_id)¶

Cancel a pending or running asynchronous task

Example command:

ceph rbd task cancel --task_id=string

module=mgr perm=r flags=mgr

Parameters:	task_id (`str`) –

rbd_task_list(task_id=None)¶

List pending or running asynchronous tasks

Example command:

ceph rbd task list --task_id=string

module=mgr perm=r flags=mgr

Parameters:	task_id (`Optional`[`str`]) –

report(tags=None)¶

report full status of cluster, optional title tag strings

Example command:

ceph report --tags=string

module=mon perm=r flags=

Parameters:	tags (`Optional`[`List`[`str`]]) –

restful_create_key(key_name)¶

Create an API key with this name

Example command:

ceph restful create-key --key_name=string

module=mgr perm=rw flags=mgr

Parameters:	key_name (`str`) –

restful_create_self_signed_cert()¶

Create localized self signed certificate

Example command:

ceph restful create-self-signed-cert

module=mgr perm=rw flags=mgr

restful_delete_key(key_name)¶

Delete an API key with this name

Example command:

ceph restful delete-key --key_name=string

module=mgr perm=rw flags=mgr

Parameters:	key_name (`str`) –

restful_list_keys()¶

List all API keys

Example command:

ceph restful list-keys

module=mgr perm=r flags=mgr

restful_restart()¶

Restart API server

Example command:

ceph restful restart

module=mgr perm=rw flags=mgr

scrub()¶

scrub the monitor stores

Example command:

ceph scrub

module=mon perm=rw flags=obsolete

service_dump()¶

dump service map

Example command:

ceph service dump

module=service perm=r flags=mgr

service_status()¶

dump service state

Example command:

ceph service status

module=service perm=r flags=mgr

sessions()¶

list existing sessions

Example command:

ceph sessions

module=mon perm=r flags=hidden, no_forward

smart(devid=None)¶

Query health metrics for underlying device

Example command:

ceph smart --devid=string

module=mon perm=rw flags=hidden, no_forward

Parameters:	devid (`Optional`[`str`]) –

status()¶

show cluster status

Example command:

ceph status

module=mon perm=r flags=

sync_force(validate=None)¶

force sync of and clear monitor store

Example command:

ceph sync_force --validate=choice

module=mon perm=rw flags=hidden, no_forward

Parameters:	validate (`Optional`[`str`]) – CephChoices strings=–yes-i-really-mean-it

telegraf_config_set(key, value)¶

Set a configuration value

Example command:

ceph telegraf config-set --key=string --value=string

module=mgr perm=rw flags=mgr

Parameters:	key (`str`) – value (`str`) –

telegraf_config_show()¶

Show current configuration

Example command:

ceph telegraf config-show

module=mgr perm=r flags=mgr

telegraf_send()¶

Force sending data to Telegraf

Example command:

ceph telegraf send

module=mgr perm=rw flags=mgr

telemetry_off()¶

Disable telemetry reports from this cluster

Example command:

ceph telemetry off

module=mgr perm=rw flags=mgr

telemetry_on(license=None)¶

Enable telemetry reports from this cluster

Example command:

ceph telemetry on --license=string

module=mgr perm=rw flags=mgr

Parameters:	license (`Optional`[`str`]) –

telemetry_send(endpoint=None)¶

Force sending data to Ceph telemetry

Example command:

ceph telemetry send --endpoint=choice

module=mgr perm=rw flags=mgr

Parameters:	endpoint (`Optional`[`List`[`str`]]) – CephChoices strings=ceph\|device

telemetry_show(channels)¶

Show last report or report to be sent

Example command:

ceph telemetry show --channels=string

module=mgr perm=r flags=mgr

Parameters:	channels (`List`[`str`]) –

telemetry_status()¶

Show current configuration

Example command:

ceph telemetry status

module=mgr perm=r flags=mgr

tell(target, args)¶

send a command to a specific daemon

Example command:

ceph tell --target=name --args=string

module=mon perm=rw flags=

Parameters:	target (`str`) – CephName args (`List`[`str`]) –

test_orchestrator_load_data()¶

load dummy data into test orchestrator

Example command:

ceph test_orchestrator load_data

module=mgr perm=w flags=mgr

time_sync_status()¶

show time sync status

Example command:

ceph time-sync-status

module=mon perm=r flags=

upgrade_check(image=None, ceph_version=None)¶

Check service versions vs available and target containers

Example command:

ceph upgrade check --image=string --ceph_version=string

module=mgr perm=rw flags=mgr

Parameters:	image (`Optional`[`str`]) – ceph_version (`Optional`[`str`]) –

version()¶

show mon daemon version

Example command:

ceph version

module=mon perm=r flags=hidden, no_forward

versions()¶

check running versions of ceph daemons

Example command:

ceph versions

module=mon perm=r flags=

zabbix_config_set(key, value)¶

Set a configuration value

Example command:

ceph zabbix config-set --key=string --value=string

module=mgr perm=rw flags=mgr

Parameters:	key (`str`) – value (`str`) –

zabbix_config_show()¶

Show current configuration

Example command:

ceph zabbix config-show

module=mgr perm=r flags=mgr

zabbix_discovery()¶

Discovering Zabbix data

Example command:

ceph zabbix discovery

module=mgr perm=r flags=mgr

zabbix_send()¶

Force sending data to Zabbix

Example command:

ceph zabbix send

module=mgr perm=rw flags=mgr

Ceph Command Line API¶

ceph-command-api

Navigation

Related Topics