Skip to content

enumeray connector configure

Update connector label and dispatch capacity together at an observed generation.

Use when: Presentation metadata or approved assignment capacity has changed.

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 get lab-connector
enumeray connector configure lab-connector --label 'Lab worker' --max-outstanding-assignments 2 --generation 1

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 from connector list/get.
--label <LABEL> Human-readable label for the resource. This is presentation metadata; commands continue to address the stable ID.
--max-outstanding-assignments <MAX_OUTSTANDING_ASSIGNMENTS> Dispatch capacity for assignments already given to the connector or using the compute grant. Slurm queue entries and unfinished assignments occupy capacity too; this is not a count of completed runs.
--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.

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

Updates both fields if the generation matches; service-side dispatch capacity is distinct from the host’s max-workers setting.

Check connector get/diagnostics and align host bounds deliberately.

Exact syntax, defaults and accepted values
Change connector label and dispatch capacity at the observed generation
Usage: enumeray connector configure [OPTIONS] --label <LABEL> --max-outstanding-assignments <MAX_OUTSTANDING_ASSIGNMENTS> --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
--label <LABEL>
Human-readable connector label; commands continue to use its stable ID
--max-outstanding-assignments <MAX_OUTSTANDING_ASSIGNMENTS>
Dispatch capacity for unfinished assignments, including queued Slurm allocations
--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 connector configuration generation from connector diagnostics/get
--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.