enumeray connector create

Create a connector record and save its one-time enrollment credential.

Use when: A new host installation will execute approved assignments under your connector ownership.

Role and prerequisites: Authenticated account with connectors:manage; creation makes that account the connector owner. 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

enumeray connector create lab-connector --label 'Lab process worker' --max-outstanding-assignments 4 --output enrollment.json

Inputs and options

Input	Meaning and use
<ID>	New stable connector ID unique to this installation, for example lab-connector.
--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.
--output <OUTPUT>	New private enrollment response JSON file containing enrollment_token. Move it securely to the host and keep it out of source control.

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

Result and next step

Reports success only after validating and saving a new private enrollment JSON file; stdout reports only its path and connector identity. Existing output paths are preserved and refused before a request. Creation replay returns no secret and exits unsuccessfully without saving an enrollment file. This does not start a host process.

On uncertainty or failed saving, the CLI makes one read-only connector inspection; failed inspection leaves the outcome unknown. A failed save may still have published a file: preserve and inspect it privately. If no usable enrollment was retained, inspect with connector get and explicitly request connector enrollment lab-connector --output replacement-enrollment.json using a new path. Replacement invalidates earlier unused enrollments and is never automatic. On the host, retry enrollment with the same durable identity directory and file; retain the original execution journal.

Exact syntax, defaults and accepted values

Create a connector enrollment and save its one-time secret privately

Usage: enumeray connector create [OPTIONS] --label <LABEL> --output <OUTPUT> <ID>

Arguments:
  <ID>  New stable connector ID; independent of its display label

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 [default: 4]
      --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
      --output <OUTPUT>
          New private JSON file containing the one-time enrollment secret; existing paths are refused
      --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