Ceph List

Ceph List

Certified

List Ceph pools

Calls GET /api/pool and returns a summary of every pool in the cluster.

yaml
type: io.kestra.plugin.ceph.pools.List

List all Ceph pools

yaml
id: list_ceph_pools
namespace: company.team

tasks:
  - id: pools
    type: io.kestra.plugin.ceph.pools.List
    host: "ceph-mgr.internal"
    username: "admin"
    password: "{{ secret('CEPH_DASHBOARD_PASSWORD') }}"
Properties

Ceph Dashboard host

Hostname or IP address of the Ceph Manager Dashboard. Must be reachable from the Kestra worker.

DefaultFETCH
Possible Values
STOREFETCHFETCH_ONENONE

How results are returned

FETCH (default) returns the pools inline under pools, STORE writes them to Kestra internal storage as Ion and returns a uri, FETCH_ONE returns only the first pool, NONE returns just the count. Use STORE on clusters with a large number of pools.

Password

Password for the Ceph Dashboard account. Never logged. Required unless token is set; ignored otherwise.

Reference (ref) of the pluginDefaults to apply to this task.

Default8443

Ceph Dashboard port

TCP port of the Ceph Manager Dashboard REST API. Defaults to 8443.

Defaultfalse

Skip 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.

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

Ceph Dashboard account used to obtain a session token from POST /api/auth. Required unless token is set.

Pools

Summary of each pool in the cluster. Empty when fetchType is STORE or NONE.

Definitions
application_metadataarray
SubTypestring

Application metadata

Application tags enabled on the pool, e.g. rbd or rgw.

pg_numinteger

Placement group count

Number of placement groups.

pg_placement_numinteger

Placement group placement count

Number of placement groups used for placement.

poolinteger

Pool ID

Numeric identifier Ceph assigned to the pool.

pool_namestring

Pool name

Name of the pool.

sizeinteger

Replica size

Number of data replicas for a replicated pool.

typestring

Pool type

Replication strategy: replicated or erasure.

Total

Number of pools returned.

Formaturi

URI

Storage URI of the Ion-serialized pools. Set only when fetchType is STORE.