stratumctl reference
stratumctl is the command line for Stratum. It is installed on every node.
See Administration overview
to sign in and set a default project.
Generated from Stratum v0.7.0 (7d9b80cd).
Global flags
Section titled “Global flags”Every command takes these.
| Flag | Type | Default | Description |
|---|---|---|---|
--ca-bundle |
string | Path to a PEM CA bundle for the control-plane TLS chain (default: env STRATUM_CA_BUNDLE or profile) | |
--config |
string | Path to config file (default: ~/.stratum/config.yaml) | |
--endpoint |
string | Stratum control-plane URL (default: env STRATUM_ENDPOINT or ~/.stratum/config.yaml profile) | |
--insecure |
bool | false |
Skip TLS verification (env STRATUM_INSECURE=1; profile insecure: true) |
-o, --output |
string | text |
Output format: text | json | yaml | template |
--profile |
string | Profile name in ~/.stratum/config.yaml (default: env STRATUM_PROFILE or the file’s current_profile or “default”) | |
--project |
string | Project ID for project-scoped calls (default: env STRATUM_PROJECT or profile) | |
--region |
string | Region for region-scoped calls (default: env STRATUM_REGION or profile) | |
--template |
string | Go text/template string when –output=template (e.g. ‘{{range.items}}{{.id}}\t{{.name}}\n{{end}}’). Field names match the JSON shape, not Go struct names. | |
--token |
string | Session token (default: env STRATUM_TOKEN or ~/.stratum/config.yaml profile) |
Commands
Section titled “Commands”| Command | Does |
|---|---|
stratumctl actions |
List the Cedar action catalog (for policy authoring) |
stratumctl admin |
Operator-only commands (install-scope; bootstrap-admin only) |
stratumctl admin cluster |
Cluster-level administration (bootstrap-admin only) |
stratumctl admin custom-shape-policy |
Read / write custom-shape policy rows (bootstrap-admin for install + region) |
stratumctl admin dns |
Per-VPC DNS recursors: the replica setting, where each replica runs, and the upstream servers |
stratumctl admin images |
Base images: the pinned cloud images the installer offers, added after the install |
stratumctl admin nodes |
Per-node administration (bootstrap-admin only) |
stratumctl admin observability |
Install-scope observability settings |
stratumctl admin ovn |
OVN substrate inspection (bootstrap-admin only) |
stratumctl admin quotas |
Manage install-wide quota defaults and per-project overrides (bootstrap-admin) |
stratumctl admin reconcilers |
Inspect the reconciler fleet (bootstrap-admin only) |
stratumctl admin services |
Switch managed services (db, k8s, client-vpn, backup, s3, secrets, security) on or off |
stratumctl admin upgrade |
Release upgrades: plan, start and follow them, and what each node runs |
stratumctl advisor |
Resources that cannot do their job (findings) and the checks that find them |
stratumctl asg |
Auto Scaling Groups + Launch Templates |
stratumctl audit |
Query + verify the audit log |
stratumctl auth |
Inspect authentication state |
stratumctl azs |
List availability zones in –region |
stratumctl backup |
Managed backup: plans, vaults, recovery points, restore |
stratumctl configure |
Create or update a profile in ~/.stratum/config.yaml |
stratumctl custom-policies |
Manage custom Cedar policies |
stratumctl custom-roles |
Manage custom Cedar roles |
stratumctl custom-shape-policy |
Resolve the effective custom-shape policy for a (project, region) |
stratumctl db |
Stratum Database: managed PostgreSQL |
stratumctl dhcp-option-sets |
Manage DHCP option sets |
stratumctl dns |
Manage DNS zones, health checks, latency targets |
stratumctl floating-ips |
Manage floating IPs |
stratumctl flow-logs |
Manage flow logs |
stratumctl groups |
Manage IAM groups |
stratumctl image-builds |
Inspect and cancel image builds |
stratumctl image-recipes |
Manage image build recipes |
stratumctl images |
Manage VM images |
stratumctl instance-types |
Manage the instance-type catalog |
stratumctl instances |
Manage compute instances |
stratumctl inventory |
Software inventory + coverage for a project’s instances |
stratumctl key-pairs |
Manage SSH key pairs |
stratumctl lb |
Manage load balancers, target groups |
stratumctl login |
Authenticate against a Stratum control plane + persist the token |
stratumctl logout |
Revoke the active session token + clear it from the profile |
stratumctl meta-fip-pools |
Manage FIP meta-pools (operator;) |
stratumctl metrics |
Custom metrics (PutMetricData) |
stratumctl nat-gateways |
Manage NAT gateways |
stratumctl network-interfaces |
Manage network interfaces |
stratumctl nodes |
Inspect + manage hypervisor nodes (operator-only,) |
stratumctl objectstorage |
Manage S3 object storage — buckets, access keys, objects |
stratumctl oidc-providers |
Manage OIDC federation providers |
stratumctl orgs |
Manage organizations |
stratumctl projects |
Manage projects |
stratumctl quotas |
Read per-project quotas (all services) |
stratumctl reachability |
Ask whether a source can reach a destination, and if not, which hop drops it |
stratumctl regions |
List regions |
stratumctl resource-policies |
Manage resource-attached Cedar policies |
stratumctl role-bindings |
Manage IAM role bindings |
stratumctl route-tables |
Manage route tables |
stratumctl secrets |
Customer Secrets Manager |
stratumctl security-groups |
Manage security groups |
stratumctl service-accounts |
Manage IAM service accounts |
stratumctl snapshots |
Manage volume snapshots |
stratumctl ssh-ca |
Sign SSH user certificates + describe the project SSH CA |
stratumctl storage-classes |
Manage storage classes |
stratumctl storage-pools |
Manage storage pools (operator node storage) |
stratumctl subnets |
Manage subnets |
stratumctl users |
Manage IAM users |
stratumctl version |
Print version and exit |
stratumctl volumes |
Manage block volumes |
stratumctl vpc-peerings |
Manage VPC peering connections |
stratumctl vpcs |
Manage VPCs |
stratumctl vpn |
Connect this machine to a VPC over Client VPN |
stratumctl whoami |
Show the currently-authenticated user |