plexsphere

Appearance

plexctl state ​

Synopsis ​

plexctl state is the operator surface for a Node's reconciliation-pull node-state projection. The control plane fans a Node's node-state entries into three buckets — metadata, data, and reports — and this family reads them for the addressed Node. The family is read-only.

text
plexctl state get --node <uuid> [flags]

Subcommands ​

plexctl state get ​

GETs /v1/nodes/{id}/state and renders the three node-state buckets for one Node:

  • metadata — operator-visible, platform-owned metadata entries;
  • data — platform-owned operational data entries;
  • reports — upstream, workload-authored report entries.

The wire endpoint is keyed solely on the Node id, so no Domain or Project scope flag is needed. In text mode each bucket renders as a labelled section with a KEY / VALUE / WORKLOAD_TAG table; an empty bucket prints its heading plus an explicit (none) marker. In json / yaml mode the typed node-state snapshot is emitted verbatim. Entries within each bucket are ordered by key ascending, so two consecutive reads of the same ledger snapshot are byte-identical. The --node flag is required and parsed as a UUID locally; a malformed value exits 2.

Flags ​

plexctl state get ​

FlagTypeRequiredDescription
--nodestring (UUID)yesAddressed Node UUID whose node-state buckets to read.

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 node-state buckets were rendered to stdout.
1Transport or API failure, a 5xx, or a malformed response body.
2Malformed --node UUID or a missing required flag.
3Missing or insecure credentials, or a 401 Unauthorized.
4403 Forbidden.
77ReBAC denial (403 Forbidden with code == "rebac_denied").

Examples ​

Read a Node's node-state buckets ​

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

plexctl state get \
  --server "${PLEXSPHERE_URL}" \
  --node   0190a8b8-b1c1-7b1b-8b1b-b1b1b1b1b1b1

Read the typed snapshot as YAML ​

shell
plexctl state get \
  --server "${PLEXSPHERE_URL}" \
  --node   0190a8b8-b1c1-7b1b-8b1b-b1b1b1b1b1b1 \
  --output yaml

Cross-references ​