Skip to content

enumeray connector context retire

Permanently archive a draining context after its retirement blockers clear.

Use when: connector context get or connector context wait-retirement reports retirement_ready for the supplied generation.

Role and prerequisites: Connector owner or current co-admin. Inspection and dry-run require connectors:read; applying additionally requires connectors:manage. Install enumeray, configure the API and log in. Use an account or delegated token with the required permissions. Example IDs must be replaced with IDs from your service.

Terminal window
enumeray connector context retire lab-connector lab-cpu --generation 5 --dry-run
enumeray connector context retire lab-connector lab-cpu --generation 5

Resource names and UUIDs below are examples. Replace them with IDs returned by your service; --generation 1 is valid only if the latest response reports generation 1. Use the source context generation. Keep the same account, exact request arguments and original generation after a lost reply to recover its retained receipt. Changed stale requests conflict; the CLI never refreshes a guard or retries a mutation automatically. See context replacement and retirement.

Input Meaning and use
<CONNECTOR> Owning connector ID from connector list/get.
<CONTEXT> Source context ID from connector context list. Its generation is separate from ownership and connector configuration generations.
--generation <GENERATION> Observed resource generation from the relevant get, members, policy or limits response. This is an optimistic concurrency check, not a release number. Read again after a conflict; do not blindly increment it.
--dry-run Return observed context state, the exact proposed request and effects without applying the lifecycle change or writing an audit event.

Every command also accepts the profile, API, JSON and timeout options.

Rechecks readiness and archives the context permanently. Identity, immutable definition, grants, publication/run history, provenance, revocations and transition receipts remain inspectable.

Inspect connector context get and connector audit. Use connector diagnostics, journal inspect and cleanup --dry-run to assess any separate host or shared-connector work.

Exact syntax, defaults and accepted values
Permanently archive a context after work, delivery and configuration finish
Usage: enumeray connector context retire [OPTIONS] --generation <GENERATION> <CONNECTOR> <CONTEXT>
Arguments:
<CONNECTOR> Owning connector ID from connector list/get
<CONTEXT> Execution-context ID registered under the selected connector
Options:
--api <API> User API origin override; credentials never cross origins. Host/runner commands use explicit configuration
--generation <GENERATION> Observed source context lifecycle generation from connector context get
--dry-run Inspect the observed and proposed change without applying it
--profile <PROFILE> Named local user API/login profile; host/runner commands use explicit configuration [default: default]
--config <CONFIG> Private user profiles file; defaults to $XDG_CONFIG_HOME/enumeray/profiles.json or ~/.config/enumeray/profiles.json
--json Emit user API results as JSON (NDJSON for following logs) and runtime errors on stderr; host/runner output follows its own protocol
--timeout <TIMEOUT> User API HTTP timeout in seconds; live logs use it for read inactivity. Does not limit execution time [default: 60]
-h, --help Print help

Documentation 205dcb3116ea · public sources 8c70356d340f · built .Download documentation identity.