enumeray connector maintenance
Preview or enter maintenance while preserving assigned work and result delivery.
Use when: You need to stop new acceptance and claims before maintaining the original connector host.
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.
Example
Section titled “Example”enumeray connector get lab-connectorenumeray connector maintenance lab-connector --generation 1 --dry-runenumeray connector maintenance lab-connector --generation 1Resource 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. The CLI inspects before applying and never refreshes a stale generation or retries an uncertain mutation. Re-read diagnostics and audit after a conflict or lost reply. Counts describe the inspection snapshot and can change as work progresses.
Inputs and options
Section titled “Inputs and options”| Input | Meaning and use |
|---|---|
<ID> |
Existing connector ID from connector get/list. |
--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 |
Read diagnostics and show the observed/proposed controls, affected work counts and effects without changing the connector or writing an audit event. |
Every command also accepts the profile, API, JSON and timeout options.
Result and next step
Section titled “Result and next step”Inspects the supplied generation and affected work. Apply sets only draining; queued runs stay for resume, while assigned prelaunch work, pending allocations, execution and delivery continue subject to independent authority. The human apply summary goes to stderr; --json keeps stdout to the receipt.
Use the returned generation with wait-maintenance; stop the original service after assigned work and delivery finish.
Exact syntax, defaults and accepted values
Stop new acceptance and claims while assigned work and delivery finish
Usage: enumeray connector maintenance [OPTIONS] --generation <GENERATION> <ID>
Arguments: <ID> Stable connector ID from connector list/get
Options: --api <API> User API origin override; credentials never cross origins. Host/runner commands use explicit configuration --generation <GENERATION> Observed connector configuration generation from connector diagnostics/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 helpDocumentation 205dcb3116ea · public sources 8c70356d340f · built .Download documentation identity.