maintenance

Cluster maintenance and recovery APIs.

get /modules

List ceph mgr modules.

Responses

default response
default response
object

Examples

No request body required
post /netping/ping

Ping hosts.

Parameters

body object

Responses

default response
default response
object

Examples

Request Body

{
  "count": 42,
  "toIds": [
    42
  ],
  "fromId": 42,
  "period": 42,
  "network": 42
}
get /modules/crashes

List crashes of Ceph daemons collected by the mgr crash module.

Parameters

show-all boolean query
Include archived and old crashes (older than 2 weeks with default config)
pagination object query
Pagination request. When supplied, the result will be filtered, sorted and limited according to this request object.

Responses

default response
default response
object

Examples

No request body required
get /netping/metrics

Get ping metrics configuration.

Responses

default response
default response
object

Examples

No request body required
put /netping/metrics

Configure ping metrics.

Parameters

body object

Examples

Request Body

{
  "enable": true,
  "network": 42
}
get /modules/services

List live ceph mgr module services.

Responses

default response
default response
object

Examples

No request body required
get /maintenance/flags

Ceph cluster flag overview.

Responses

default response
default response
array
Array of CephFlagReponse objects

Examples

No request body required
get /maintenance/backup

Download an unencrypted configuration backup.

Examples

No request body required
get /maintenance/max-mds

Get the maximum number of active MDS (max_mds).

Responses

default response
default response
object

Examples

No request body required
put /maintenance/max-mds

Set the maximum number of active MDS (max_mds).

Parameters

body object

Examples

Request Body

{
  "maxMds": 42
}
get /maintenance/migrations

Check which Ceph upgrades or container switches can be performed.

Responses

default response
default response
object

Examples

No request body required
post /maintenance/update-now

Check for updates now.

Responses

default response
default response
object
A long-running task that goes on in the background after this task is completed. See tasks endpoints for details

Examples

No request body required
put /modules/balancer/enable

Toggle balancer module on.

Examples

No request body required
get /modules/dashboard/roles

List ceph mgr dashboard roles.

Responses

default response
default response
array
Array of CephDashboardRole objects

Examples

No request body required
get /modules/dashboard/users

List ceph mgr dashboard users.

Responses

default response
default response
array
Array of CephDashboardUser objects

Examples

No request body required
get /netping/metrics/summary

Get ping metrics summary.

Parameters

startTime integer query
endTime integer query

Responses

default response
default response
array
Array of PingMetricsSummary objects

Examples

No request body required
put /modules/balancer/disable

Toggle balancer module off.

Examples

No request body required
put /modules/dashboard/enable

Toggle ceph mgr dashboard module on.

Responses

default response
default response
object
A long-running task that goes on in the background after this task is completed. See tasks endpoints for details

Examples

No request body required
post /maintenance/restart-croit

Restart the croit container. Will only work if the restart policy in docker has been configured correctly.

Responses

default response
default response
object
A long-running task that goes on in the background after this task is completed. See tasks endpoints for details

Examples

No request body required
get /modules/crashes/{crashId}

List crashes of Ceph daemons collected by the mgr crash module.

The return value is the raw json as reported by Ceph and may change with minor Ceph releases.

Parameters

crashId string path Required
Id of the crash as returned by /crashes

Responses

default response
default response
object

Examples

No request body required
put /modules/dashboard/disable

Toggle ceph mgr dashboard module off.

Examples

No request body required
get /maintenance/config-backups

Check if cloud configuration backups are enabled and working.

Responses

default response
default response
object

Examples

No request body required
patch /maintenance/config-backups

Configure cloud configuration backups.

Parameters

body object

Examples

Request Body

{
  "enabled": true
}
get /maintenance/recovery-speed

Get the recovery speed.

Responses

default response
default response
object

Examples

No request body required
put /maintenance/recovery-speed

Set the recovery speed.

This can be used to fine-tune the balance between client IOPS and data rebalancing.

Parameters

body object

Examples

Request Body

{
  "speed": 42
}
post /maintenance/migrations/reef

Perform a cluster upgrade to Ceph Reef.

Responses

default response
default response
object
A long-running task that goes on in the background after this task is completed. See tasks endpoints for details

Examples

No request body required
get /maintenance/osd-full-ratios

Get OSD full ratios.

Responses

default response
default response
object

Examples

No request body required
patch /maintenance/osd-full-ratios

Update OSD full ratios.

Parameters

body object

Examples

Request Body

{
  "full": 42,
  "nearfull": 42,
  "backfillfull": 42
}
post /modules/crashes/archive-all

Archive all recent crash reports, clearing all warnings.

Examples

No request body required
put /maintenance/flags/{flag}/set

Set a Ceph cluster flag.

Parameters

flag string path Required

Examples

No request body required
post /maintenance/migrations/mimic

Perform a cluster upgrade to Ceph Mimic.

Responses

default response
default response
object
A long-running task that goes on in the background after this task is completed. See tasks endpoints for details

Examples

No request body required
get /maintenance/backup/basic-auth

Download an unencrypted configuration backup.

Examples

No request body required
get /maintenance/croit-auto-update

Get croit auto-update parameters.

Responses

default response
default response
object
Schedule the automatic update of the croit docker image.

Examples

No request body required
put /maintenance/croit-auto-update

Change croit auto-update parameters.

Parameters

body object
Schedule the automatic update of the croit docker image.

Examples

Request Body

{
  "cron": "string",
  "custom": true,
  "enabled": true,
  "croitTag": "string",
  "registry": "string",
  "imageName": "string",
  "registryPassword": "string",
  "registryUsername": "string"
}
post /maintenance/migrations/quincy

Perform a cluster upgrade to Ceph Quincy.

Responses

default response
default response
object
A long-running task that goes on in the background after this task is completed. See tasks endpoints for details

Examples

No request body required
get /maintenance/min-compat-client

Get the minimum ceph version clients need to be compatible with the cluster (min-compat-client).

Responses

default response
default response
enum
LuminousMimicNautilusOctopusPacificQuincyReef

Examples

No request body required
put /maintenance/min-compat-client

Set the minimum ceph version clients need to be compatible with the cluster (min-compat-client).

Parameters

body object

Examples

Request Body

{
  "release": "Luminous"
}
post /maintenance/osd/{osdId}/scrub

Instruct an OSD to scrub all its PGs.

Parameters

osdId integer path Required

Examples

No request body required
put /maintenance/flags/{flag}/unset

Unset a Ceph cluster flag.

Parameters

flag string path Required

Examples

No request body required
post /maintenance/migrations/octopus

Perform a cluster upgrade to Ceph Octopus.

Responses

default response
default response
object
A long-running task that goes on in the background after this task is completed. See tasks endpoints for details

Examples

No request body required
post /maintenance/migrations/pacific

Perform a cluster upgrade to Ceph Pacific.

Responses

default response
default response
object
A long-running task that goes on in the background after this task is completed. See tasks endpoints for details

Examples

No request body required
post /maintenance/reboot-all-servers

Reboot all servers not running their configured image.

Responses

default response
default response
object
A long-running task that goes on in the background after this task is completed. See tasks endpoints for details

Examples

No request body required
get /maintenance/schedulingTimezone

Get the timezone applied to the schedule.

Responses

default response
default response
object

Examples

No request body required
patch /maintenance/schedulingTimezone

Update the timezone applied to the schedule.

Parameters

body object

Examples

Request Body

{
  "timezone": "string"
}
post /maintenance/migrations/nautilus

Perform a cluster upgrade to Ceph Nautilus.

Responses

default response
default response
object
A long-running task that goes on in the background after this task is completed. See tasks endpoints for details

Examples

No request body required
get /maintenance/allow-standby-replay

Get the standby-replay setting (false if there is no cephfs)

Responses

default response
default response
object

Examples

No request body required
put /maintenance/allow-standby-replay

Enable or disable standby replay.

Parameters

body object

Examples

Request Body

{
  "cephFsName": "string",
  "allowStandbyReplay": true
}
post /maintenance/config-backups/create

Perform a cloud backup now.

Responses

default response
default response
object
A long-running task that goes on in the background after this task is completed. See tasks endpoints for details

Examples

No request body required
post /modules/crashes/{crashId}/archive

Archive a crash report, clearing the Ceph health warning related to it.

Parameters

crashId string path Required
Id of the crash as returned by /crashes

Examples

No request body required
post /maintenance/osd/{osdId}/deep-scrub

Instruct an OSD to deep-scrub all its PGs.

Parameters

osdId integer path Required

Examples

No request body required
put /modules/dashboard/roles/{rolename}

Add ceph mgr dashboard role.

Parameters

rolename string path Required
body object

Examples

Request Body

{
  "description": "string",
  "permissions": {}
}
patch /modules/dashboard/roles/{rolename}

Update ceph mgr dashboard role.

Parameters

rolename string path Required
body object

Examples

Request Body

{
  "addPerms": {},
  "delPerms": [
    "string"
  ]
}
delete /modules/dashboard/roles/{rolename}

Delete ceph mgr dashboard role.

Parameters

rolename string path Required

Examples

No request body required
put /modules/dashboard/users/{username}

Add ceph mgr dashboard user.

Parameters

username string path Required
body object

Examples

Request Body

{
  "password": "string"
}
patch /modules/dashboard/users/{username}

Update ceph mgr dashboard user.

Parameters

username string path Required
body object

Examples

Request Body

{
  "addRoles": [
    "string"
  ],
  "delRoles": [
    "string"
  ],
  "password": "string",
  "setRoles": [
    "string"
  ],
  "passwordHash": "string"
}
delete /modules/dashboard/users/{username}

Delete ceph mgr dashboard user.

Parameters

username string path Required

Examples

No request body required
get /maintenance/disable-cpu-idle-states

Check if CPU idle states are disabled.

Responses

default response
default response
integer

Examples

No request body required
put /maintenance/disable-cpu-idle-states

Disable CPU idle states above set limit.

Parameters

body integer

Examples

Request Body

42
post /maintenance/migrations/switch-container

Switch to the correct croit container.

Responses

default response
default response
object
A long-running task that goes on in the background after this task is completed. See tasks endpoints for details

Examples

No request body required
post /maintenance/config-backups/generate-new-key

Generates a new crypto key used for all future backups.

Responses

default response
default response
object
A long-running task that goes on in the background after this task is completed. See tasks endpoints for details

Examples

No request body required