compute:connection
Read SSH connection material for an active managed compute lease once compute:status indicates the lease is usable. Returns `compute` with `lease_id`, `lease_status`, `provider`, `offer_id`, `region`, `host`, `port`, `user`, `private_key` (the SSH private key: keep it secret), `known_hosts` and `next_retry_after_seconds`; host, port and key are empty until the lease is ready. Scoped to --lease_control_token, and only leases you own are connectable. Pass --lease_id or --node_id to pick one when several match.
Reference for flywheel compute:connection.
Command Group
Compute & Executions Commands
Summary
Read SSH connection material for an active managed compute lease once compute:status indicates the lease is usable. Returns compute with lease_id, lease_status, provider, offer_id, region, host, port, user, private_key (the SSH private key: keep it secret), known_hosts and next_retry_after_seconds; host, port and key are empty until the lease is ready. Scoped to --lease_control_token, and only leases you own are connectable. Pass --lease_id or --node_id to pick one when several match.
Effect
read-only
Usage
flywheel compute:connection <FLAGS>Required flags
| Flag | Value | Default | Choices | Description |
|---|---|---|---|---|
--lease_control_token | string | From compute.lease_control_token in compute:acquire; scopes the leases you control (not an SSH credential). No matching lease: empty status, no_active_lease from release-all, 403 on connect or single release. |
Optional flags
| Flag | Value | Default | Choices | Description |
|---|---|---|---|---|
--lease_id | string | Lease UUID (Flywheel's, not the provider's instance ID) from compute.lease_id in compute:acquire or compute.leases[].lease_id in compute:status. | ||
--node_id | string | Node UUID (not a slug) from node_id in hosted:node:list or graph:get. Missing or hidden: 404 where the command loads it. | ||
--format | FORMAT | json, tsv, csv, table | Output format for command results. | |
--env | PROFILE | Select a CLI profile; unconfigured default requires FLYWHEEL_BASE_URL. | ||
--out | PATH | Write output to a file path, or use - for stdout. | ||
--open | Open browser-bound URLs when supported. | |||
--no-retry | Disable transient-error retries. | |||
--retry-max | N | Maximum transient-error retry attempts. | ||
--wait | Block on async operations until a terminal state is reached. | |||
--wait-timeout | SECONDS | 600 | Seconds to wait for --wait before timing out. Defaults to 600. | |
--allow-self | Allow mutating the currently active credential. | |||
--timeout | SECONDS | Set the per-request timeout budget in seconds. | ||
--idempotency-key | KEY | Reuse an Idempotency-Key so ambiguous write failures can be retried with the same key. | ||
--force | Force safety-gated operations where supported. | |||
--yes | Confirm forced compute:release-all --force. Other runtime commands do not read --yes. | |||
--debug | Print structured request debugging with secrets masked. | |||
--verbose | Print verbose progress for long-running operations. | |||
-h, --help | Show this help. |
Examples
Get connection.
flywheel compute:connection --lease_control_token tok --lease_id l1Output
Default format: json.
| Field | Type |
|---|---|
compute | object |
compute:budgets
List budget grants visible for a node context.
compute:funding
Read what a compute grant allows and has used. Returns `compute` with `compute_grant_id`, `budget_source`, `root_compute_budget_id`, `grant_cents` (what the grant allows), `spent_cents` and `remaining_cents`. `hard_cap_cents`, `cumulative_spend_cents` and `budget_remaining_cents` repeat `grant_cents`, `spent_cents` and `remaining_cents` under older names: they are the grant's values, not the backing campaign budget's (for those use campaign-budgets:list). Read it before compute:acquire.