enumeray connector archive
Archive a connector at an observed generation.
Use when: The owner is retiring the resource from active self-service use.
Role and prerequisites: Resource owner; co-admin status alone does not grant ownership changes. 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 archive 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. Use ownership_generation from connector get or generation from connector member list for owner-only changes; it is independent of connector configuration generation.
Inputs and options
Section titled “Inputs and options”| Input | Meaning and use |
|---|---|
<ID> |
Connector ID you own. |
--generation <GENERATION> |
Observed ownership_generation from connector get or generation from connector member list. Configuration or context generations cannot guard ownership changes. |
Every command also accepts the profile, API, JSON and timeout options.
Result and next step
Section titled “Result and next step”Permanently archives the connector without deleting identities, grants, publications, journals or audit history. Fresh work and prelaunch execution are blocked; already executing work and result/log delivery can finish. This does not stop the host process or erase files.
Review retained runs and stop/recover host processes through connector operations.
Exact syntax, defaults and accepted values
Permanently archive this connector using its ownership generation
Usage: enumeray connector archive [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 ownership generation; archive is permanent --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.