Skip to content

enumeray connector context cutover

Close a context to new use and choose how accepted queued work drains.

Use when: Authors have moved every live current publication off the source or explicitly withdrawn it.

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 cutover lab-connector lab-cpu --replacement lab-cpu-next --accepted-work drain --generation 3 --dry-run
enumeray connector context cutover lab-connector lab-cpu --replacement lab-cpu-next --accepted-work drain --generation 3

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.
--replacement <REPLACEMENT> Fresh active replacement context ID. Another connector is permitted only when you currently administer both connectors; accepted work keeps its original context and connector.
--accepted-work <ACCEPTED_WORK> Required drain or cancel-queued. drain permits eligible claims for previously accepted queued runs; cancel-queued cancels only work still queued at commit, with the actual connector actor and cutover reason.
--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.

Moves active to draining with an audited receipt. Fresh grants, registration, activation, standard submissions and candidate trials stop. Assigned work and delivery continue under ordinary independent controls.

Inspect the returned context generation and work; explicitly release obsolete configuration before waiting for retirement.

Exact syntax, defaults and accepted values
Close new work and explicitly drain or cancel queued runs
Usage: enumeray connector context cutover [OPTIONS] --accepted-work <ACCEPTED_WORK> --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
--replacement <REPLACEMENT>
Optional replacement context ID; requires administration of its connector. Authors must explicitly publish replacements
--accepted-work <ACCEPTED_WORK>
Policy for queued accepted work: drain it on the source, or cancel it while assigned work continues
Possible values:
- drain: Let already accepted queued work execute on the source context
- cancel-queued: Cancel queued work; already assigned work retains its execution identity
--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
--generation <GENERATION>
Observed source context lifecycle generation from connector context get
--dry-run
Inspect the observed and proposed change without applying it
--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 (see a summary with '-h')

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