Skip to content

enumeray connector context wait-retirement

Observe a draining context until work, delivery and configuration retirement settle.

Use when: Configuration release has been requested and the original connector remains available to reconcile and acknowledge removal.

Role and prerequisites: Connector owner or current co-admin. 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 wait-retirement lab-connector lab-cpu --generation 5 --interval 2 --deadline 3600

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. A generation change or a context no longer draining stops the wait. Disconnection, stale contact or elapsed time cannot prove delivery completion. This command does not request retirement, stop a connector or delete local files.

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.
--interval <INTERVAL> Positive polling interval in seconds; default 2.
--deadline <DEADLINE> Positive overall observation deadline in seconds; default 3600. Expiry leaves lifecycle state and work unchanged.

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

Polls context inspection until retirement_ready. Requires all source publication configuration retired, final-reference removal acknowledged and no live current publication, queued/unfinished/uncertain work or pending delivery, uploads or archives.

Preview and apply connector context retire with the unchanged observed context generation. Check connector-wide work and local cleanup separately.

Exact syntax, defaults and accepted values
Wait for context retirement readiness without shutting down the connector
Usage: enumeray connector context wait-retirement [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> Exact source lifecycle generation from context get/cutover; any later change stops the wait
--interval <INTERVAL> Positive polling interval in seconds [default: 2]
--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
--deadline <DEADLINE> Positive local wait budget in seconds; expiry stops observation without cancelling work [default: 3600]
--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.