plexsphere

Appearance

plexctl restore ​

Synopsis ​

plexctl restore is the operator surface for the platform's ordered disaster-recovery restore plan. The family is read-only and platform-scoped: it projects the platform's documented restore runbook — the contiguous ascending sequence of steps an operator follows to recover the platform — and never executes a restore. There is deliberately no restore run / restore apply subcommand. The family ships a single read subcommand, plan.

text
plexctl restore plan [flags]

Subcommands ​

plexctl restore plan ​

Drives the GetBackupRestorePlan operation (GET /v1/platform/backup/restore-plan) and reads the platform-scoped restore plan. In text mode each ordered step projects onto four columns — ORDER, NAME, ACTION, VERIFY — in the ascending order the server returns, where ORDER is the step's 1-based position in the contiguous sequence. In json / yaml mode the typed sequence is emitted verbatim.

Flags ​

The plan subcommand takes no subcommand-specific flags; it reads the platform-scoped restore plan 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 ordered restore plan 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 ordered restore plan ​

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

plexctl restore plan \
  --server "${PLEXSPHERE_URL}"

Emit the typed sequence as YAML ​

shell
plexctl restore plan \
  --server "${PLEXSPHERE_URL}" \
  --output yaml

Cross-references ​