Skip to content

enumeray connector claim-once

Register a session, heartbeat and prepare at most one approved assignment.

Use when: You need one-step local qualification or want to observe claim/configuration behavior.

Role and prerequisites: Connector host operator with a matching initialized journal and credential. Install enumeray on the execution control host. Retain its private journal on durable storage; keep one process owner and the matching connector credential. See recovery rules before taking over retained state.

Terminal window
enumeray connector claim-once --journal ./local-journal --token-file ./connector-state/token
Input Meaning and use
--journal <JOURNAL> Private durable journal directory. Reuse the same path after restart and never copy it to create another active connector. It contains ownership and backend execution evidence.
--token-file <TOKEN_FILE> Private regular file containing only the connector bearer token, typically the token file written by enroll. One-shot commands read a token from stdin if omitted.
--credentials-file <CREDENTIALS_FILE> Private JSON map from SSH credential references in contexts to private key files on the connector host. OpenSSH runs as the connector OS account: provision the verified remote host key in that account’s ~/.ssh/known_hosts. Install the matching public key in the remote execution account’s authorized_keys. The private map stays on the connector host; see SSH context examples.
--allow-development-execution Explicit host consent for trusted same-user process/direct development contexts. Required on every launch-capable invocation. Managed identity separation remains enforced; model code can access this OS user’s connector credentials and files.

Host commands use explicit connector credentials or the private journal and emit JSON results; compute-runner uses only its stdin protocol and directory. User profile and API override options do not apply.

Claims/prepares at most one assignment and records its durable identity/configuration. It does not itself launch scientific execution.

Inspect the journal and execute the prepared assignment with execute-once.

Exact syntax, defaults and accepted values
Register a process session, send a heartbeat, and prepare at most one assignment. Read the bearer token from stdin unless --token-file is supplied
Usage: enumeray connector claim-once [OPTIONS] --journal <JOURNAL>
Options:
--api <API>
User API origin override; credentials never cross origins. Host/runner commands use explicit configuration
--journal <JOURNAL>
Existing private durable journal directory; reuse the same path after interruption
--profile <PROFILE>
Named local user API/login profile; host/runner commands use explicit configuration [default: default]
--token-file <TOKEN_FILE>
Private regular file containing the connector bearer token; omit to read token text from stdin
--config <CONFIG>
Private user profiles file; defaults to $XDG_CONFIG_HOME/enumeray/profiles.json or ~/.config/enumeray/profiles.json
--credentials-file <CREDENTIALS_FILE>
Private credential-reference map used while compiling API configuration
--allow-development-execution
Permit trusted process/direct development contexts under this regular OS user
--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.