Skip to content

enumeray connector

Manage connectors and operate their host runtimes.

Use when: You administer a connector or enroll, operate and recover its host runtime.

Role and prerequisites: Connector owner/co-admin or host operator. Management commands require a user login and connector-specific authority. Host commands use explicit connector credentials or the private journal; they do not load a user profile.

Terminal window
enumeray connector list
enumeray connector diagnostics lab-connector

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

Command Purpose
start Start the connector using its saved runtime configuration.
status Inspect local journal and native service observations without mutation.
configuration Generate reviewable native host configuration.
preflight Check host prerequisites locally without a model publication.
enroll Enroll a host identity using a one-time connector enrollment credential.
run Continuously claim and execute assignments while retaining recovery evidence.
init Initialize a one-shot journal bound to a connector and API origin.
claim-once Register a session, heartbeat and prepare at most one approved assignment.
reconcile Retrieve existing assignment evidence and reconcile process ownership without new claims.
execute-once Execute or resume one prepared assignment using durable backend evidence.
publish-log-archives Publish retained terminal diagnostic archives without scientific execution.
cleanup Inspect or reclaim eligible completed data on connector and compute hosts.
inspect Inspect journal identity and retained assignment IDs without inputs or secrets.
list List connectors you currently own or co-administer.
create Create a connector record and save its one-time enrollment credential.
enrollment Issue a replacement one-time enrollment credential for a registered connector.
get Inspect connector identity, maintenance, execution authority, capacity and generation.
configure Update connector label and dispatch capacity together at an observed generation.
maintenance Preview or enter maintenance while preserving assigned work and result delivery.
resume Preview or leave maintenance without restoring withdrawn execution authority.
withdraw-authority Preview or withdraw connector execution authority independently of maintenance.
restore-authority Preview or restore the reversible connector authority control.
wait-maintenance Wait for assigned work and delivery to finish at one maintenance generation.
update Apply a guarded maintenance state from a JSON management request.
diagnostics Inspect connector readiness, maintenance, authority and retained work.
context Manage execution contexts for one connector.
grant Manage context-scoped compute grants.
member Inspect and manage connector co-admin membership.
ownership Transfer connector ownership with explicit acceptance.
runs Inspect runs using a connector you manage.
audit Read audit events for one managed connector.
archive Archive a connector at an observed generation.

Choose a subcommand below. The group itself performs no operation.

Follow connector enrollment before starting the host service.

Exact syntax, defaults and accepted values
Register and administer connectors or operate their local host runtime
Usage: enumeray connector [OPTIONS] <COMMAND>
Commands:
start Start the connector using its saved host configuration, without a user profile
status Inspect local journal and native service evidence; performs no probes or repairs
configuration Generate private, reviewable host configuration without applying it
preflight Check host prerequisites locally, without profiles or model publications
enroll Enroll using a single-use credential, retaining identity across retries
run Continuously claim and execute assignments over HTTP
init Create a one-shot journal bound to one connector and an HTTPS or loopback HTTP API
claim-once Register a process session, send a heartbeat, and prepare at most one assignment. Read the bearer token from stdin unless --token-file is supplied
reconcile Retrieve existing work and reconcile ownership without claiming or launching work
execute-once Execute or resume one prepared assignment, retaining durable backend evidence
publish-log-archives Publish retained terminal log archives without executing scientific work
cleanup Reclaim confirmed, delivered run payloads; preserve evidence and launch fences
inspect Show journal identities and prepared assignment IDs, without inputs or secrets
list List connectors you may administer, one page at a time
create Create a connector enrollment and save its one-time secret privately
enrollment Issue a replacement one-time enrollment credential and save it privately
get Inspect connector registration, capacity and current configuration
configure Change connector label and dispatch capacity at the observed generation
maintenance Stop new acceptance and claims while assigned work and delivery finish
resume Permit acceptance and claims without restoring withdrawn authority
withdraw-authority Withdraw connector execution authority independently of maintenance
restore-authority Restore connector authority without clearing maintenance or other revocations
wait-maintenance Wait for assigned work and delivery to finish at one maintenance generation
update Apply a guarded maintenance state from a JSON request; prefer maintenance/resume
diagnostics Inspect connector readiness, retained work and delivery blockers
context Register and manage this connector's execution contexts
grant Grant explicit compute access to one context or discover your available grants
member Inspect co-administrators; owner changes use the ownership generation
ownership Propose or accept an explicit transfer of this connector's ownership
runs List operational run records for this connector
audit Read one page of this connector's audit history
archive Permanently archive this connector using its ownership generation
help Print this message or the help of the given subcommand(s)
Options:
--api <API> User API origin override; credentials never cross origins. Host/runner commands use explicit configuration
--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 help

Documentation 205dcb3116ea · public sources 8c70356d340f · built .Download documentation identity.