Get started

Operations

Discover and invoke bulk operations on nodes and disks. Operations are context-sensitive — a node’s available operations depend on its current state.


Node Operations

GET /nodes/{nodeId}/operations

List operations available for a specific node based on its current state.

Response
["ceph.create-mon", "ceph.create-mgr", "ceph.create-mds", "node.restart"]

Disk Operations

GET /disks/{diskId}/operations

List operations available for a specific disk.

Response
["ceph.create-osd", "disk.wipe"]

Invoke Node Operation

POST /invoke/node

Execute an operation on one or more nodes. Max 100 nodes per request.

Request body

operation string required
Operation name (e.g. ceph.create-mgr)
nodeIds UUID[] required
Node IDs (max 100)
diskId UUID
Disk ID (required for ceph.create-mon)
Response
{
  "results": [
    { "id": "550e8400-e29b-41d4-a716-446655440000", "status": "scheduled" },
    { "id": "6ba7b810-9dad-11d1-80b4-00c04fd430c8", "status": "scheduled" }
  ]
}

Invoke Disk Operation

POST /invoke/disk

Execute an operation on one or more disks. Max 100 disks per request.

Request body

operation string required
Operation name (e.g. ceph.create-osd)
diskIds UUID[] required
Disk IDs (max 100)
Response
{
  "results": [
    { "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "status": "scheduled" },
    { "id": "b2c3d4e5-f6a7-8901-bcde-f12345678901", "status": "scheduled" }
  ]
}

Available Operations

OperationTargetDescription
ceph.create-monNodeCreate a Ceph Monitor (requires disk selection)
ceph.create-mgrNodeCreate a Ceph Manager
ceph.create-mdsNodeCreate a Ceph Metadata Server
ceph.create-rgwNodeDeploy a RADOS Gateway
node.restartNodeRestart a node
node.shutdownNodeShut down a node
ceph.create-osdDiskCreate a Ceph OSD
disk.wipeDiskWipe a disk