maintenance

Cluster maintenance and recovery APIs.
get /modules

List ceph mgr modules.

Responses
200 successful operation
CephModuleStatus object 
{
  "enabledModules": [
    "string"
  ],
  "disabledModules": [
    {
      "name": "string",
      "canRun": true,
      "errorString": "string",
      "moduleOptions": {
        "additionalProp1": {
          "max": "string",
          "min": "string",
          "desc": "string",
          "name": "string",
          "tags": [
            "string"
          ],
          "type": "string",
          "flags": 0,
          "level": "string",
          "seeAlso": [
            "string"
          ],
          "longDesc": "string",
          "enumAllowed": [
            "string"
          ],
          "defaultValue": "string"
        },
        "additionalProp2": {
          "max": "string",
          "min": "string",
          "desc": "string",
          "name": "string",
          "tags": [
            "string"
          ],
          "type": "string",
          "flags": 0,
          "level": "string",
          "seeAlso": [
            "string"
          ],
          "longDesc": "string",
          "enumAllowed": [
            "string"
          ],
          "defaultValue": "string"
        },
        "additionalProp3": {
          "max": "string",
          "min": "string",
          "desc": "string",
          "name": "string",
          "tags": [
            "string"
          ],
          "type": "string",
          "flags": 0,
          "level": "string",
          "seeAlso": [
            "string"
          ],
          "longDesc": "string",
          "enumAllowed": [
            "string"
          ],
          "defaultValue": "string"
        }
      }
    }
  ]
}
post /netping/ping

Ping hosts.

Parameters
body object 
{
  "count": 0,
  "toIds": [
    0
  ],
  "fromId": 0,
  "period": 0,
  "network": 0
}
Responses
200 successful operation
object 
{
  "additionalProp1": {
    "avg": 0,
    "max": 0,
    "min": 0,
    "rcv": 0,
    "xmt": 0,
    "results": [
      0
    ],
    "lossPercent": 0
  },
  "additionalProp2": {
    "avg": 0,
    "max": 0,
    "min": 0,
    "rcv": 0,
    "xmt": 0,
    "results": [
      0
    ],
    "lossPercent": 0
  },
  "additionalProp3": {
    "avg": 0,
    "max": 0,
    "min": 0,
    "rcv": 0,
    "xmt": 0,
    "results": [
      0
    ],
    "lossPercent": 0
  }
}
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 string query
Responses
200 successful operation
MgrCrashReport object
List of Ceph daemon crashes
{
  "crashes": [
    {
      "id": "string",
      "process": "string",
      "archived": true,
      "hostname": "string",
      "timestamp": 0
    }
  ]
}
get /netping/metrics

Get ping metrics configuration.

Responses
200 successful operation
PingMetricsConfiguration object 
{
  "enable": true,
  "network": 0
}
put /netping/metrics

Configure ping metrics.

Parameters
body object 
{
  "enable": true,
  "network": 0
}
Responses
default successful operation
get /modules/services

List live ceph mgr module services.

Responses
200 successful operation
object 
{
  "additionalProp1": "string",
  "additionalProp2": "string",
  "additionalProp3": "string"
}
get /maintenance/flags

Ceph cluster flag overview.

Responses
200 successful operation
CephFlagReponse array
CephFlagReponse object 
[
  {
    "name": "string",
    "description": "string",
    "currentState": true,
    "recommendedState": true
  }
]
get /maintenance/backup

Download an unencrypted configuration backup.

Responses
default successful operation
get /maintenance/max-mds

Get the maximum number of active MDS (max_mds).

Responses
200 successful operation
MaxMdsSetting object 
{
  "maxMds": 0
}
put /maintenance/max-mds

Set the maximum number of active MDS (max_mds).

Parameters
body object 
{
  "maxMds": 0
}
Responses
default successful operation
get /maintenance/migrations

Check which Ceph upgrades or container switches can be performed.

Responses
200 successful operation
AvailableMigrationTasks object 
{
  "reef": true,
  "mimic": true,
  "quincy": true,
  "octopus": true,
  "pacific": true,
  "nautilus": true,
  "switchTarget": "string"
}
post /maintenance/update-now

Check for updates now.

Responses
200 successful operation
ManagedTask object
A long-running task that goes on in the background after this task is completed. See tasks endpoints for details
{
  "id": 0,
  "done": true,
  "name": "string",
  "state": "WAITING",
  "object": "string",
  "output": "string",
  "result": {},
  "progress": {
    "total": 0,
    "complete": 0
  },
  "startedAt": 0,
  "startedBy": "string",
  "statusCode": 0
}
put /modules/balancer/enable

Toggle balancer module on.

Responses
default successful operation
get /modules/dashboard/roles

List ceph mgr dashboard roles.

Responses
200 successful operation
CephDashboardRole array
CephDashboardRole object 
[
  {
    "name": "string",
    "description": "string",
    "scopesPermissions": {
      "additionalProp1": [
        "read"
      ],
      "additionalProp2": [
        "read"
      ],
      "additionalProp3": [
        "read"
      ]
    }
  }
]
get /modules/dashboard/users

List ceph mgr dashboard users.

Responses
200 successful operation
CephDashboardUser array
CephDashboardUser object 
[
  {
    "name": "string",
    "email": "string",
    "roles": [
      "string"
    ],
    "password": "string",
    "username": "string",
    "lastUpdate": 0,
    "croitImport": true
  }
]
get /netping/metrics/summary

Get ping metrics summary.

Parameters
startTime integer query
endTime integer query
Responses
200 successful operation
PingMetricsSummary array
PingMetricsSummary object 
[
  {
    "toId": 0,
    "fromId": 0,
    "median": 0,
    "dropPercent": 0
  }
]
put /modules/balancer/disable

Toggle balancer module off.

Responses
default successful operation
put /modules/dashboard/enable

Toggle ceph mgr dashboard module on.

Responses
200 successful operation
ManagedTask object
A long-running task that goes on in the background after this task is completed. See tasks endpoints for details
{
  "id": 0,
  "done": true,
  "name": "string",
  "state": "WAITING",
  "object": "string",
  "output": "string",
  "result": {},
  "progress": {
    "total": 0,
    "complete": 0
  },
  "startedAt": 0,
  "startedBy": "string",
  "statusCode": 0
}
post /maintenance/restart-croit

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

Responses
200 successful operation
ManagedTask object
A long-running task that goes on in the background after this task is completed. See tasks endpoints for details
{
  "id": 0,
  "done": true,
  "name": "string",
  "state": "WAITING",
  "object": "string",
  "output": "string",
  "result": {},
  "progress": {
    "total": 0,
    "complete": 0
  },
  "startedAt": 0,
  "startedBy": "string",
  "statusCode": 0
}
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
200 successful operation
object
Arbitrary JSON data.
{}
put /modules/dashboard/disable

Toggle ceph mgr dashboard module off.

Responses
default successful operation
get /maintenance/config-backups

Check if cloud configuration backups are enabled and working.

Responses
200 successful operation
CloudConfigBackupStatus object 
{
  "enabled": true,
  "cephFsid": "string",
  "clusterId": "string",
  "lastBackupSize": 0,
  "lastBackupChecksum": "string",
  "backupEncryptionKey": "string",
  "lastBackupTimestamp": 0
}
patch /maintenance/config-backups

Configure cloud configuration backups.

Parameters
body object 
{
  "enabled": true
}
Responses
default successful operation
get /maintenance/recovery-speed

Get the recovery speed.

Responses
200 successful operation
RecoverySpeed object 
{
  "speed": 0
}
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 
{
  "speed": 0
}
Responses
default successful operation
post /maintenance/migrations/reef

Perform a cluster upgrade to Ceph Reef.

Responses
200 successful operation
ManagedTask object
A long-running task that goes on in the background after this task is completed. See tasks endpoints for details
{
  "id": 0,
  "done": true,
  "name": "string",
  "state": "WAITING",
  "object": "string",
  "output": "string",
  "result": {},
  "progress": {
    "total": 0,
    "complete": 0
  },
  "startedAt": 0,
  "startedBy": "string",
  "statusCode": 0
}
get /maintenance/osd-full-ratios

Get OSD full ratios.

Responses
200 successful operation
OsdFullRatios object 
{
  "full": 0,
  "nearfull": 0,
  "backfillfull": 0
}
patch /maintenance/osd-full-ratios

Update OSD full ratios.

Parameters
body object 
{
  "full": 0,
  "nearfull": 0,
  "backfillfull": 0
}
Responses
default successful operation
post /modules/crashes/archive-all

Archive all recent crash reports, clearing all warnings.

Responses
default successful operation
put /maintenance/flags/{flag}/set

Set a Ceph cluster flag.

Parameters
flag enum path Required
noscrub, nodeep-scrub, noout, noup, nodown, noin, nobackfill, norebalance, norecover, nosnaptrim, pause
Responses
default successful operation
post /maintenance/migrations/mimic

Perform a cluster upgrade to Ceph Mimic.

Responses
200 successful operation
ManagedTask object
A long-running task that goes on in the background after this task is completed. See tasks endpoints for details
{
  "id": 0,
  "done": true,
  "name": "string",
  "state": "WAITING",
  "object": "string",
  "output": "string",
  "result": {},
  "progress": {
    "total": 0,
    "complete": 0
  },
  "startedAt": 0,
  "startedBy": "string",
  "statusCode": 0
}
get /maintenance/backup/basic-auth

Download an unencrypted configuration backup.

Responses
default successful operation
get /maintenance/croit-auto-update

Get croit auto-update parameters.

Responses
200 successful operation
CroitAutoUpdateConfigRequest object
Schedule the automatic update of the croit docker image.
{
  "cron": "string",
  "custom": true,
  "enabled": true,
  "croitTag": "string",
  "registry": "string",
  "imageName": "string",
  "registryPassword": "string",
  "registryUsername": "string"
}
put /maintenance/croit-auto-update

Change croit auto-update parameters.

Parameters
body object
Schedule the automatic update of the croit docker image.
{
  "cron": "string",
  "custom": true,
  "enabled": true,
  "croitTag": "string",
  "registry": "string",
  "imageName": "string",
  "registryPassword": "string",
  "registryUsername": "string"
}
Responses
default successful operation
post /maintenance/migrations/quincy

Perform a cluster upgrade to Ceph Quincy.

Responses
200 successful operation
ManagedTask object
A long-running task that goes on in the background after this task is completed. See tasks endpoints for details
{
  "id": 0,
  "done": true,
  "name": "string",
  "state": "WAITING",
  "object": "string",
  "output": "string",
  "result": {},
  "progress": {
    "total": 0,
    "complete": 0
  },
  "startedAt": 0,
  "startedBy": "string",
  "statusCode": 0
}
get /maintenance/min-compat-client

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

Responses
200 successful operation
enum
LUMINOUS, MIMIC, NAUTILUS, OCTOPUS, PACIFIC, QUINCY, REEF
"LUMINOUS"
put /maintenance/min-compat-client

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

Parameters
body object 
{
  "release": "LUMINOUS"
}
Responses
default successful operation
post /maintenance/osd/{osdId}/scrub

Instruct an OSD to scrub all its PGs.

Parameters
osdId integer path Required
Responses
default successful operation
put /maintenance/flags/{flag}/unset

Unset a Ceph cluster flag.

Parameters
flag enum path Required
noscrub, nodeep-scrub, noout, noup, nodown, noin, nobackfill, norebalance, norecover, nosnaptrim, pause
Responses
default successful operation
post /maintenance/migrations/octopus

Perform a cluster upgrade to Ceph Octopus.

Responses
200 successful operation
ManagedTask object
A long-running task that goes on in the background after this task is completed. See tasks endpoints for details
{
  "id": 0,
  "done": true,
  "name": "string",
  "state": "WAITING",
  "object": "string",
  "output": "string",
  "result": {},
  "progress": {
    "total": 0,
    "complete": 0
  },
  "startedAt": 0,
  "startedBy": "string",
  "statusCode": 0
}
post /maintenance/migrations/pacific

Perform a cluster upgrade to Ceph Pacific.

Responses
200 successful operation
ManagedTask object
A long-running task that goes on in the background after this task is completed. See tasks endpoints for details
{
  "id": 0,
  "done": true,
  "name": "string",
  "state": "WAITING",
  "object": "string",
  "output": "string",
  "result": {},
  "progress": {
    "total": 0,
    "complete": 0
  },
  "startedAt": 0,
  "startedBy": "string",
  "statusCode": 0
}
post /maintenance/reboot-all-servers

Reboot all servers not running their configured image.

Responses
200 successful operation
ManagedTask object
A long-running task that goes on in the background after this task is completed. See tasks endpoints for details
{
  "id": 0,
  "done": true,
  "name": "string",
  "state": "WAITING",
  "object": "string",
  "output": "string",
  "result": {},
  "progress": {
    "total": 0,
    "complete": 0
  },
  "startedAt": 0,
  "startedBy": "string",
  "statusCode": 0
}
get /maintenance/schedulingTimezone

Get the timezone applied to the schedule.

Responses
200 successful operation
TimezoneSettings object 
{
  "options": [
    "string"
  ],
  "timezone": "string"
}
patch /maintenance/schedulingTimezone

Update the timezone applied to the schedule.

Parameters
body object 
{
  "timezone": "string"
}
Responses
default successful operation
post /maintenance/migrations/nautilus

Perform a cluster upgrade to Ceph Nautilus.

Responses
200 successful operation
ManagedTask object
A long-running task that goes on in the background after this task is completed. See tasks endpoints for details
{
  "id": 0,
  "done": true,
  "name": "string",
  "state": "WAITING",
  "object": "string",
  "output": "string",
  "result": {},
  "progress": {
    "total": 0,
    "complete": 0
  },
  "startedAt": 0,
  "startedBy": "string",
  "statusCode": 0
}
get /maintenance/allow-standby-replay

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

Responses
200 successful operation
StandbyReplaySetting object 
{
  "cephFsName": "string",
  "allowStandbyReplay": true
}
put /maintenance/allow-standby-replay

Enable or disable standby replay.

Parameters
body object 
{
  "cephFsName": "string",
  "allowStandbyReplay": true
}
Responses
default successful operation
post /maintenance/config-backups/create

Perform a cloud backup now.

Responses
200 successful operation
ManagedTask object
A long-running task that goes on in the background after this task is completed. See tasks endpoints for details
{
  "id": 0,
  "done": true,
  "name": "string",
  "state": "WAITING",
  "object": "string",
  "output": "string",
  "result": {},
  "progress": {
    "total": 0,
    "complete": 0
  },
  "startedAt": 0,
  "startedBy": "string",
  "statusCode": 0
}
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
Responses
default successful operation
post /maintenance/osd/{osdId}/deep-scrub

Instruct an OSD to deep-scrub all its PGs.

Parameters
osdId integer path Required
Responses
default successful operation
put /modules/dashboard/roles/{rolename}

Add ceph mgr dashboard role.

Parameters
rolename string path Required
body object 
{
  "description": "string",
  "permissions": {
    "additionalProp1": [
      "read"
    ],
    "additionalProp2": [
      "read"
    ],
    "additionalProp3": [
      "read"
    ]
  }
}
Responses
default successful operation
patch /modules/dashboard/roles/{rolename}

Update ceph mgr dashboard role.

Parameters
rolename string path Required
body object 
{
  "addPerms": {
    "additionalProp1": [
      "read"
    ],
    "additionalProp2": [
      "read"
    ],
    "additionalProp3": [
      "read"
    ]
  },
  "delPerms": [
    "string"
  ]
}
Responses
default successful operation
delete /modules/dashboard/roles/{rolename}

Delete ceph mgr dashboard role.

Parameters
rolename string path Required
Responses
default successful operation
put /modules/dashboard/users/{username}

Add ceph mgr dashboard user.

Parameters
username string path Required
body object 
{
  "password": "string"
}
Responses
default successful operation
patch /modules/dashboard/users/{username}

Update ceph mgr dashboard user.

Parameters
username string path Required
body object 
{
  "addRoles": [
    "string"
  ],
  "delRoles": [
    "string"
  ],
  "password": "string",
  "setRoles": [
    "string"
  ],
  "passwordHash": "string"
}
Responses
default successful operation
delete /modules/dashboard/users/{username}

Delete ceph mgr dashboard user.

Parameters
username string path Required
Responses
default successful operation
get /maintenance/disable-cpu-idle-states

Check if CPU idle states are disabled.

Responses
200 successful operation
integer 
0
put /maintenance/disable-cpu-idle-states

Disable CPU idle states above set limit.

Parameters
body integer 
0
Responses
default successful operation
post /maintenance/migrations/switch-container

Switch to the correct croit container.

Responses
200 successful operation
ManagedTask object
A long-running task that goes on in the background after this task is completed. See tasks endpoints for details
{
  "id": 0,
  "done": true,
  "name": "string",
  "state": "WAITING",
  "object": "string",
  "output": "string",
  "result": {},
  "progress": {
    "total": 0,
    "complete": 0
  },
  "startedAt": 0,
  "startedBy": "string",
  "statusCode": 0
}
post /maintenance/config-backups/generate-new-key

Generates a new crypto key used for all future backups.

Responses
200 successful operation
ManagedTask object
A long-running task that goes on in the background after this task is completed. See tasks endpoints for details
{
  "id": 0,
  "done": true,
  "name": "string",
  "state": "WAITING",
  "object": "string",
  "output": "string",
  "result": {},
  "progress": {
    "total": 0,
    "complete": 0
  },
  "startedAt": 0,
  "startedBy": "string",
  "statusCode": 0
}