# ceph dashboard --help
General usage:
==============
usage: ceph [-h] [-c CEPHCONF] [-i INPUT_FILE] [-o OUTPUT_FILE]
[--setuser SETUSER] [--setgroup SETGROUP] [--id CLIENT_ID]
[--name CLIENT_NAME] [--cluster CLUSTER]
[--admin-daemon ADMIN_SOCKET] [-s] [-w] [--watch-debug]
[--watch-info] [--watch-sec] [--watch-warn] [--watch-error]
[--watch-channel {cluster,audit,*}] [--version] [--verbose]
[--concise] [-f {json,json-pretty,xml,xml-pretty,plain}]
[--connect-timeout CLUSTER_TIMEOUT] [--block] [--period PERIOD]
Ceph administration tool
optional arguments:
-h, --help request mon help
-c CEPHCONF, --conf CEPHCONF
ceph configuration file
-i INPUT_FILE, --in-file INPUT_FILE
input file, or "-" for stdin
-o OUTPUT_FILE, --out-file OUTPUT_FILE
output file, or "-" for stdout
--setuser SETUSER set user file permission
--setgroup SETGROUP set group file permission
--id CLIENT_ID, --user CLIENT_ID
client id for authentication
--name CLIENT_NAME, -n CLIENT_NAME
client name for authentication
--cluster CLUSTER cluster name
--admin-daemon ADMIN_SOCKET
submit admin-socket commands ("help" for help
-s, --status show cluster status
-w, --watch watch live cluster changes
--watch-debug watch debug events
--watch-info watch info events
--watch-sec watch security events
--watch-warn watch warn events
--watch-error watch error events
--watch-channel {cluster,audit,*}
which log channel to follow when using -w/--watch. One
of ['cluster', 'audit', '*']
--version, -v display version
--verbose make verbose
--concise make less verbose
-f {json,json-pretty,xml,xml-pretty,plain}, --format {json,json-pretty,xml,xml-pretty,plain}
--connect-timeout CLUSTER_TIMEOUT
set a timeout for connecting to the cluster
--block block until completion (scrub and deep-scrub only)
--period PERIOD, -p PERIOD
polling period, default 1.0 second (for polling
commands only)
Local commands:
===============
ping <mon.id> Send simple presence/life test to a mon
<mon.id> may be 'mon.*' for all mons
daemon {type.id|path} <cmd>
Same as --admin-daemon, but auto-find admin socket
daemonperf {type.id | path} [stat-pats] [priority] [<interval>] [<count>]
daemonperf {type.id | path} list|ls [stat-pats] [priority]
Get selected perf stats from daemon/admin socket
Optional shell-glob comma-delim match string stat-pats
Optional selection priority (can abbreviate name):
critical, interesting, useful, noninteresting, debug
List shows a table of all available stats
Run <count> times (default forever),
once per <interval> seconds (default 1)
Monitor commands:
=================
dashboard ac-role-add-scope-perms <rolename> <scopename> <permissions> [<permissions>...] Add the scope permissions for a role
dashboard ac-role-create <rolename> {<description>} Create a new access control role
dashboard ac-role-del-scope-perms <rolename> <scopename> Delete the scope permissions for a role
dashboard ac-role-delete <rolename> Delete an access control role
dashboard ac-role-show {<rolename>} Show role info
dashboard ac-user-add-roles <username> <roles> [<roles>...] Add roles to user
dashboard ac-user-create <username> {<password>} {<rolename>} {<name>} {<email>} Create a user
dashboard ac-user-del-roles <username> <roles> [<roles>...] Delete roles from user
dashboard ac-user-delete <username> Delete user
dashboard ac-user-set-info <username> <name> <email> Set user info
dashboard ac-user-set-password <username> <password> Set user password
dashboard ac-user-set-roles <username> <roles> [<roles>...] Set user roles
dashboard ac-user-show {<username>} Show user info
dashboard create-self-signed-cert Create self signed certificate
dashboard debug disable|enable|status Control and report debug status in Ceph-Dashboard
dashboard feature disable|enable|status {cephfs|iscsi|mirroring|rbd|rgw [cephfs|iscsi|mirroring|rbd| Enable or disable features in Ceph-Mgr Dashboard
rgw...]}
dashboard get-alertmanager-api-host Get the ALERTMANAGER_API_HOST option value
dashboard get-audit-api-enabled Get the AUDIT_API_ENABLED option value
dashboard get-audit-api-log-payload Get the AUDIT_API_LOG_PAYLOAD option value
dashboard get-enable-browsable-api Get the ENABLE_BROWSABLE_API option value
dashboard get-ganesha-clusters-rados-pool-namespace Get the GANESHA_CLUSTERS_RADOS_POOL_NAMESPACE option value
dashboard get-grafana-api-password Get the GRAFANA_API_PASSWORD option value
dashboard get-grafana-api-ssl-verify Get the GRAFANA_API_SSL_VERIFY option value
dashboard get-grafana-api-url Get the GRAFANA_API_URL option value
dashboard get-grafana-api-username Get the GRAFANA_API_USERNAME option value
dashboard get-grafana-update-dashboards Get the GRAFANA_UPDATE_DASHBOARDS option value
dashboard get-iscsi-api-ssl-verification Get the ISCSI_API_SSL_VERIFICATION option value
dashboard get-jwt-token-ttl Get the JWT token TTL in seconds
dashboard get-prometheus-api-host Get the PROMETHEUS_API_HOST option value
dashboard get-rest-requests-timeout Get the REST_REQUESTS_TIMEOUT option value
dashboard get-rgw-api-access-key Get the RGW_API_ACCESS_KEY option value
dashboard get-rgw-api-admin-resource Get the RGW_API_ADMIN_RESOURCE option value
dashboard get-rgw-api-host Get the RGW_API_HOST option value
dashboard get-rgw-api-port Get the RGW_API_PORT option value
dashboard get-rgw-api-scheme Get the RGW_API_SCHEME option value
dashboard get-rgw-api-secret-key Get the RGW_API_SECRET_KEY option value
dashboard get-rgw-api-ssl-verify Get the RGW_API_SSL_VERIFY option value
dashboard get-rgw-api-user-id Get the RGW_API_USER_ID option value
dashboard grafana dashboards update Push dashboards to Grafana
dashboard iscsi-gateway-add <service_url> Add iSCSI gateway configuration
dashboard iscsi-gateway-list List iSCSI gateways
dashboard iscsi-gateway-rm <name> Remove iSCSI gateway configuration
dashboard reset-alertmanager-api-host Reset the ALERTMANAGER_API_HOST option to its default value
dashboard reset-audit-api-enabled Reset the AUDIT_API_ENABLED option to its default value
dashboard reset-audit-api-log-payload Reset the AUDIT_API_LOG_PAYLOAD option to its default value
dashboard reset-enable-browsable-api Reset the ENABLE_BROWSABLE_API option to its default value
dashboard reset-ganesha-clusters-rados-pool-namespace Reset the GANESHA_CLUSTERS_RADOS_POOL_NAMESPACE option to its default value
dashboard reset-grafana-api-password Reset the GRAFANA_API_PASSWORD option to its default value
dashboard reset-grafana-api-ssl-verify Reset the GRAFANA_API_SSL_VERIFY option to its default value
dashboard reset-grafana-api-url Reset the GRAFANA_API_URL option to its default value
dashboard reset-grafana-api-username Reset the GRAFANA_API_USERNAME option to its default value
dashboard reset-grafana-update-dashboards Reset the GRAFANA_UPDATE_DASHBOARDS option to its default value
dashboard reset-iscsi-api-ssl-verification Reset the ISCSI_API_SSL_VERIFICATION option to its default value
dashboard reset-prometheus-api-host Reset the PROMETHEUS_API_HOST option to its default value
dashboard reset-rest-requests-timeout Reset the REST_REQUESTS_TIMEOUT option to its default value
dashboard reset-rgw-api-access-key Reset the RGW_API_ACCESS_KEY option to its default value
dashboard reset-rgw-api-admin-resource Reset the RGW_API_ADMIN_RESOURCE option to its default value
dashboard reset-rgw-api-host Reset the RGW_API_HOST option to its default value
dashboard reset-rgw-api-port Reset the RGW_API_PORT option to its default value
dashboard reset-rgw-api-scheme Reset the RGW_API_SCHEME option to its default value
dashboard reset-rgw-api-secret-key Reset the RGW_API_SECRET_KEY option to its default value
dashboard reset-rgw-api-ssl-verify Reset the RGW_API_SSL_VERIFY option to its default value
dashboard reset-rgw-api-user-id Reset the RGW_API_USER_ID option to its default value
dashboard set-alertmanager-api-host <value> Set the ALERTMANAGER_API_HOST option value
dashboard set-audit-api-enabled <value> Set the AUDIT_API_ENABLED option value
dashboard set-audit-api-log-payload <value> Set the AUDIT_API_LOG_PAYLOAD option value
dashboard set-enable-browsable-api <value> Set the ENABLE_BROWSABLE_API option value
dashboard set-ganesha-clusters-rados-pool-namespace <value> Set the GANESHA_CLUSTERS_RADOS_POOL_NAMESPACE option value
dashboard set-grafana-api-password <value> Set the GRAFANA_API_PASSWORD option value
dashboard set-grafana-api-ssl-verify <value> Set the GRAFANA_API_SSL_VERIFY option value
dashboard set-grafana-api-url <value> Set the GRAFANA_API_URL option value
dashboard set-grafana-api-username <value> Set the GRAFANA_API_USERNAME option value
dashboard set-grafana-update-dashboards <value> Set the GRAFANA_UPDATE_DASHBOARDS option value
dashboard set-iscsi-api-ssl-verification <value> Set the ISCSI_API_SSL_VERIFICATION option value
dashboard set-jwt-token-ttl <int> Set the JWT token TTL in seconds
dashboard set-login-credentials <username> <password> Set the login credentials
dashboard set-prometheus-api-host <value> Set the PROMETHEUS_API_HOST option value
dashboard set-rest-requests-timeout <int> Set the REST_REQUESTS_TIMEOUT option value
dashboard set-rgw-api-access-key <value> Set the RGW_API_ACCESS_KEY option value
dashboard set-rgw-api-admin-resource <value> Set the RGW_API_ADMIN_RESOURCE option value
dashboard set-rgw-api-host <value> Set the RGW_API_HOST option value
dashboard set-rgw-api-port <int> Set the RGW_API_PORT option value
dashboard set-rgw-api-scheme <value> Set the RGW_API_SCHEME option value
dashboard set-rgw-api-secret-key <value> Set the RGW_API_SECRET_KEY option value
dashboard set-rgw-api-ssl-verify <value> Set the RGW_API_SSL_VERIFY option value
dashboard set-rgw-api-user-id <value> Set the RGW_API_USER_ID option value
dashboard sso disable Disable Single Sign-On
dashboard sso enable saml2 Enable SAML2 Single Sign-On
dashboard sso setup saml2 <ceph_dashboard_base_url> <idp_metadata> {<idp_username_attribute>} {<idp_ Setup SAML2 Single Sign-On
entity_id>} {<sp_x_509_cert>} {<sp_private_key>}
dashboard sso show saml2 Show SAML2 configuration
dashboard sso status Get Single Sign-On status
