Ceph List
CertifiedList RBD snapshots
Ceph List
List RBD snapshots
The Ceph Dashboard API has no dedicated snapshot-listing endpoint: this task calls GET /api/block/image/{image_spec} and returns the snapshots array embedded in the image detail.
type: io.kestra.plugin.ceph.rbd.snapshots.ListExamples
List snapshots of an RBD image
id: list_rbd_snapshots
namespace: company.team
tasks:
- id: snapshots
type: io.kestra.plugin.ceph.rbd.snapshots.List
host: "ceph-mgr.internal"
username: "admin"
password: "{{ secret('CEPH_DASHBOARD_PASSWORD') }}"
poolName: "rbd"
imageName: "data-volume"
Properties
host *Requiredstring
Ceph Dashboard host
Hostname or IP address of the Ceph Manager Dashboard. Must be reachable from the Kestra worker.
imageName *Requiredstring
Image name
Name of the RBD image whose snapshots are listed.
poolName *Requiredstring
Pool name
Pool the image belongs to.
fetchType string
FETCHSTOREFETCHFETCH_ONENONEHow results are returned
FETCH (default) returns the snapshots inline under snapshots, STORE writes them to Kestra internal storage as Ion and returns a uri, FETCH_ONE returns only the first snapshot, NONE returns just the count. Use STORE on images with a large number of snapshots.
password string
Password
Password for the Ceph Dashboard account. Never logged. Required unless token is set; ignored otherwise.
pluginDefaultsRef Non-dynamicstring
Reference (ref) of the pluginDefaults to apply to this task.
port integerstring
8443Ceph Dashboard port
TCP port of the Ceph Manager Dashboard REST API. Defaults to 8443.
skipSsl booleanstring
falseSkip TLS certificate verification
When true, disables TLS certificate verification. Useful when the Ceph Manager Dashboard uses a self-signed certificate, which is the default on most Ceph deployments. Defaults to false (secure): enable it explicitly and only for trusted networks.
token string
Pre-obtained JWT
A JWT obtained from POST /api/auth, used directly instead of username/password. Reused as-is for every request in the execution. It expires (Ceph default 8h TTL) and is NOT auto-renewed, so do not use it in triggers or scheduled flows; use username/password there instead. Mutually exclusive with password: when set, username/password are ignored.
username string
Username
Ceph Dashboard account used to obtain a session token from POST /api/auth. Required unless token is set.
Outputs
snapshots array
Snapshots
Summary of each snapshot on the image. Empty when fetchType is STORE or NONE.
io.kestra.plugin.ceph.rbd.snapshots.SnapshotInfo
Snapshot ID
Numeric identifier Ceph assigned to the snapshot.
Protected
Whether the snapshot is protected from deletion.
Snapshot name
Name of the snapshot.
Size
Size of the image at the time the snapshot was taken, in bytes.
Timestamp
When the snapshot was created, kept as the raw string the Ceph Dashboard API returns (e.g. Wed Jan 10 12: 00: 00 2026). The exact format is Ceph-version dependent, so it is not parsed into a typed instant here.
total integer
Total
Number of snapshots returned.
uri string
uriURI
Storage URI of the Ion-serialized snapshots. Set only when fetchType is STORE.
