plexsphere

Appearance

plexctl backup ​

Synopsis ​

plexctl backup is the operator surface for the platform's backup coverage catalogue. The family is read-only and platform-scoped: it projects the platform's documented backup coverage — which stores are backed up, how, how often, how long they are retained, and their restore priority — and never triggers or runs a backup. There is deliberately no backup run / backup now subcommand. The family ships a single read subcommand, catalog.

text
plexctl backup catalog [flags]

Subcommands ​

plexctl backup catalog ​

Drives the GetBackupCatalog operation (GET /v1/platform/backup/catalog) and reads the platform-scoped backup coverage catalogue. In text mode each catalogued store projects onto seven columns — STORE, METHOD, CADENCE, RETENTION, PRIORITY, RESTORE_STEP, NOTES. The PRIORITY column carries the per-store restore-priority classification, and RESTORE_STEP is the store's integer position in the linear restore sequence, with 0 meaning the store is not part of that sequence. In json / yaml mode the typed catalogue is emitted verbatim, including the deliberate exclusions and the per-plane recovery targets that have no place in the single text table; an operator who needs those pipes --output json.

Flags ​

The catalog subcommand takes no subcommand-specific flags; it reads the platform-scoped catalogue addressed by the operator's credentials.

Persistent flags inherited from root ​

--server, --profile, --token-file, --output. See ../plexctl.md for the canonical list.

Exit codes ​

See ../plexctl.md#exit-code-taxonomy for the inherited base table. The cases that apply to this family:

CodeTrigger
0The coverage catalogue was rendered to stdout.
1Transport or API failure, a server-side 5xx, or a malformed response body.
2An unknown --output value.
3Missing or insecure credentials, or a 401 Unauthorized.
4403 Forbidden, or a 404 Not Found.
77ReBAC denial (403 Forbidden with reason == "rebac_denied").

Examples ​

Read the per-store backup coverage table ​

shell
export PLEXSPHERE_URL="${PLEXSPHERE_URL:-https://localhost:8080}"

plexctl backup catalog \
  --server "${PLEXSPHERE_URL}"

Emit the full catalogue with exclusions and recovery targets ​

shell
plexctl backup catalog \
  --server "${PLEXSPHERE_URL}" \
  --output json

Cross-references ​