Skip to content

enumeray connector wait-maintenance

Wait for assigned work and delivery to finish at one maintenance generation.

Use when: Maintenance is enabled and you need evidence before stopping the original connector service.

Role and prerequisites: Connector owner or current co-admin. Requires connectors:read. 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 diagnostics lab-connector
enumeray connector wait-maintenance lab-connector --generation 1 --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.

Input Meaning and use
<ID> Existing connector ID.
--generation <GENERATION> Exact generation returned after entering maintenance. Any later connector change stops this wait; inspect it before starting another wait.
--interval <INTERVAL> Positive polling interval in seconds; default 2.
--deadline <DEADLINE> Positive total wait duration in seconds; default 3600. Expiry stops this command and leaves maintenance enabled.

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

Polls diagnostics without mutation. Retained queued work is shown separately and does not block completion. Unfinished assignments, missing durable delivery receipts, active uploads and pending archives do block it; stale contact is not completion. Generation changes or maintenance being disabled stop the wait. With --json only the final status reaches stdout.

Stop the same service after successful completion. On timeout, maintenance remains enabled; investigate delivery and retained host evidence through operations.

Exact syntax, defaults and accepted values
Wait for assigned work and delivery to finish at one maintenance generation
Usage: enumeray connector wait-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> Exact connector generation after entering maintenance; any later change stops this 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.