Command reference
Every command under deployport machinery, grouped the way the CLI groups them. The machine verbs sit directly under the group, and the account’s objects are groups of their own.
Machine commands
Section titled “Machine commands”| Command | What it does |
|---|---|
deployport machinery create | Create a machine, on Deployport Compute or on UCE |
deployport machinery list | List the machines in your account |
deployport machinery start <machine-id> | Power on a machine’s cloud instance |
deployport machinery stop <machine-id> | Power off a machine’s cloud instance |
deployport machinery terminate <machine-id> --yes | Destroy a machine’s cloud instance and everything on its disks |
deployport machinery deregister <machine-id> | Deregister a machine and destroy its identity |
deployport machinery move <machine-id> | Move a Compute machine into a worker pool with --worker-pool, or out of one with --size |
deployport machinery resize <machine-id> <instance-type> | Change a machine’s size |
deployport machinery resize-runs <machine-id> | List a machine’s resize runs, newest first |
deployport machinery ssh [user@]<machine-id> [ssh arguments] | Open an ssh session on a machine, wherever it is |
deployport machinery set-name <machine-id> <name> | Name a machine |
deployport machinery set-desired <machine-id> <online|offline> | Set a machine’s desired connection state, without powering the instance |
deployport machinery set-login-user <machine-id> [os-user] | Set the OS user a session lands as |
deployport machinery settings <machine-id> | Show every setting in effect on a machine, and where each one came from |
deployport machinery set-power-settings <machine-id> | Write the power settings this machine carries itself |
deployport machinery metrics <machine-id> | Show a machine’s activity metrics: the latest snapshot, or one metric over time |
deployport machinery screenshot <machine-id> | Photograph a machine’s display and write it to a file |
deployport machinery vnc <machine-id> | Drive a machine’s screen in a VNC client on this computer |
deployport machinery assign-tunnel <machine-id> <tunnel-id> | Give a machine a tunnel, so the Deployport edge can carry requests to it |
deployport machinery unassign-tunnel <machine-id> | Release a machine’s tunnel |
Regions
Section titled “Regions”| Command | What it does |
|---|---|
deployport machinery regions list | List the regions a platform can place a machine in |
deployport machinery regions zones <region> | List the availability zones of one region |
deployport machinery regions sizes <region> | List the sizes one region can place |
Each one takes --hosting-platform, for deployport-compute or uce. Choose where a machine runs covers what they answer.
Commands on a machine
Section titled “Commands on a machine”| Command | What it does |
|---|---|
deployport machinery commands run <machine-id> | Run a command on a machine and wait for its result |
deployport machinery commands list <machine-id> | List a machine’s commands, newest first |
deployport machinery commands get <command-id> | Show one command including its output |
deployport machinery commands cancel <command-id> | Cancel a command that has not started yet |
deployport machinery autostop suppress <machine-id> <duration> | Keep a machine running past auto-stop for a set time |
deployport machinery autostop clear <machine-id> | Clear a machine’s auto-stop suppression so auto-stop resumes |
deployport machinery setup-steps list <machine-id> | List a machine’s setup steps in run order |
deployport machinery setup-steps set <machine-id> | Set a machine’s setup steps, as the whole list |
deployport machinery setup-steps reapply <machine-id> <step-id> | Move a step tracking latest to the script’s newest revision and run it again |
deployport machinery volume attachments <machine-id> | Show the machine’s mounted volumes as the agent last reported them |
deployport machinery volume grow <machine-id> <mountpoint> | Grow a volume to an absolute target size |
deployport machinery volume list <machine-id> | List the machine’s volume growths, in flight and recently finished |
deployport machinery volume get <machine-id> <growth-id> | Show one volume growth |
deployport machinery ssh
Section titled “deployport machinery ssh”| Command | What it does |
|---|---|
deployport machinery ssh config | Teach ssh how to reach your machines, by writing one block into your SSH config |
Account commands
Section titled “Account commands”deployport machinery activity
Section titled “deployport machinery activity”| Command | What it does |
|---|---|
deployport machinery activity [machine-id] | Show what happened in the account, or to one machine, newest first |
deployport machinery account-settings
Section titled “deployport machinery account-settings”| Command | What it does |
|---|---|
deployport machinery account-settings get | Show the settings every machine in the account inherits |
deployport machinery account-settings set-power | Replace the account’s power settings |
deployport machinery account-settings set-storage | Replace the account’s storage settings |
deployport machinery account-settings set-memory | Replace the account’s memory settings |
deployport machinery account-settings set-reachability | Replace the account’s reachability settings |
deployport machinery account-settings set-snapshots | Replace the account’s snapshot settings |
deployport machinery account-settings set-setup | Replace the account’s setup settings, and the steps every new machine runs |
Each setter replaces its whole domain, and --clear unsets it. Set what every machine inherits covers the six domains.
deployport machinery worker-pools
Section titled “deployport machinery worker-pools”| Command | What it does |
|---|---|
deployport machinery worker-pools create --title <text> --tier <tier> | Create a worker pool |
deployport machinery worker-pools list | List the account’s worker pools, newest first |
deployport machinery worker-pools get <worker-pool-id> | Show one worker pool |
deployport machinery worker-pools tiers | List the tiers a worker pool can have, smallest first |
deployport machinery worker-pools change-tier <worker-pool-id> <tier> | Move a worker pool to another tier |
deployport machinery worker-pools set-is-default <worker-pool-id> --value true|false | Set whether this is the pool a create comes into when it names none |
deployport machinery worker-pools suggest-name --title <text> | Suggest a name for a title, without creating anything |
deployport machinery worker-pools destroy <worker-pool-id> | Destroy a worker pool and give its vCPU, memory and disk back |
deployport machinery github
Section titled “deployport machinery github”| Command | What it does |
|---|---|
deployport machinery github connect | Print the address that connects your GitHub to this account |
deployport machinery github list | List the GitHub accounts and the people connected to this account |
deployport machinery github show <machine-id> | Show how one machine reaches GitHub |
deployport machinery github enable <machine-id> | Attach your GitHub connection to a machine |
deployport machinery github disable <machine-id> | Stop a machine from using GitHub |
deployport machinery github disconnect [github-user-id] | Disconnect a person’s GitHub from this account, or your own with no argument |
deployport machinery github remove <installation-id> | Remove a GitHub installation from this account |
deployport machinery scripts
Section titled “deployport machinery scripts”| Command | What it does |
|---|---|
deployport machinery scripts create --description <text> --body <script> | Create a script from --body or --body-file |
deployport machinery scripts list | List the account’s scripts |
deployport machinery scripts get <name> | Show a script, including the body it runs |
deployport machinery scripts update <name> | Change a script, which mints a new revision |
deployport machinery scripts delete <name> | Delete a script |
deployport machinery scripts revisions <name> | List a script’s revisions, newest first |
deployport machinery scripts get-revision <name> <revision> | Show one revision of a script, including the body it ran |
Global flags
Section titled “Global flags”Every command accepts these:
| Flag | What it does |
|---|---|
--json | Return the raw records as JSON |
--yaml | Return the raw records as YAML |
--profile <name> | Load and persist credentials under this profile |
--credentials-file <path> | Read credentials from this file |
--settings-file <path> | Read settings from this file |
--json and --yaml return the raw records, and anything scripted reads those. The default output is a table written for a person, and it changes between releases.
Next steps
Section titled “Next steps”- API and SDKs covers the HTTP API these commands call.
- Machine and ssh failures names the refusal each command can answer.