BBramaDocs
Browse documentation

Brama CLI command reference

brama subscription reinstate

Put one retired pool member back in the rotation, because this deployment uses that account after all.

The mirror of disown, and the reason it exists: a retirement was permanent. is_retired answered yes to any retirement record ever written, and the retirement also recorded the member’s credential as disabled, so every later command skipped that member for good: the gateway answered no active credential for agent for it, its own sign-in report said retired, and nothing in the product could take that back.

A reinstatement is membership, not a credential. The member is offered to dispatch again and still holds no grant of this gateway’s own, which is what its recorded state then says: needs_reauthorization, repaired by login (--by weles or --by hand).

Invocation

brama subscription reinstate --subscription-id <ID> --reason <REASON> [--gateway <ORIGIN> | --gateway-consumer <NAME>] [--bearer-role <ROLE>] [--json]
InputRequired/defaultMeaning
--subscription-id <ID>requiredThe retired pool member to use again.
--reason <REASON>requiredNonempty audit reason, recorded beside the gateway’s own ledger entry.
--gateway <ORIGIN>optionalThe gateway holding the member; its console bearer is read from stdin. Named neither this nor --gateway-consumer, the command acts on this host’s own pool through the same code the gateway’s route runs.
--gateway-consumer <NAME>optionalResolve that gateway through Stado’s service directory as this consumer.
--bearer-role <ROLE>optionalRead the console bearer from the token field of the vault item that plays this role instead of stdin.
--jsonoptional; offPrint {"subscription_id", "detail"} instead of the line.

Output and state

One line names the member and what it now needs, or with --json one document with the member and that sentence as detail. The journal gains a reinstate record beside the retirement — it stays append-only, and the newest of the two decides — and the ledger records the member as needing a re-authorization with the reason given, so no later command reads it as disabled.

$ brama subscription reinstate --subscription-id brama-sub-held-codex-<account slug> --reason "this deployment uses that account"
brama-sub-held-codex-<account slug>: the member is in the rotation again; it holds no grant of this gateway's own until a sign-in obtains one

Refusals

An empty id is refused with name the subscription to reinstate, an empty reason with --reason must say why this member is used again, a member this pool does not hold with this deployment’s pool holds no member <id>, and a member that is in the rotation already with is not retired, so there is nothing to reinstate. Over HTTP those are 404 and 409; the route requires the brama-desktop console identity.

See the command group or the CLI tree.