Files
ubicloud/spec/routes/api/cli/golden-files/help -r vm.txt
Jeremy Evans affcc39a51 Use spaces around | in destroy usage banners in the CLI
This was missed when they were added to the other commands.
2025-03-14 09:20:20 -07:00

99 lines
2.8 KiB
Plaintext

Manage virtual machines
Usage:
ubi vm command [...]
ubi vm (location/vm-name | vm-id) [post-options] post-command [...]
Commands:
list List virtual machines
Post Commands:
create Create a virtual machine
destroy Destroy a virtual machine
restart Restart a virtual machine
scp Copy files to or from virtual machine using `scp`
sftp Copy files to or from virtual machine using `sftp`
show Show details for a virtual machine
ssh Connect to a virtual machine using `ssh`
Post Options:
-4, --ip4 use IPv4 address
-6, --ip6 use IPv6 address
-u, --user user override username
List virtual machines
Usage:
ubi vm list [options]
Options:
-f, --fields=fields show specific fields (comma separated)
-l, --location=location only show virtual machines in given location
-N, --no-headers do not show headers
Fields: location name id ip4 ip6
Create a virtual machine
Usage:
ubi vm location/vm-name create [options] public_key
Options:
-6, --ipv6-only do not enable IPv4
-b, --boot-image=image_name boot image (ubuntu-noble,ubuntu-jammy,debian-12,almalinux-9)
-p, --private-subnet-id=id place VM into specific private subnet
-s, --size=size server size (standard-{2,4,8,16,30,60})
-S, --storage-size=size storage size (40, 80)
-u, --unix-user=username username (default: ubi)
Destroy a virtual machine
Usage:
ubi vm (location/vm-name | vm-id) destroy [options]
Options:
-f, --force do not require confirmation
Restart a virtual machine
Usage:
ubi vm (location/vm-name | vm-id) restart
Copy files to or from virtual machine using `scp`
Usage:
ubi vm (location/vm-name | vm-id) [options] scp [scp-options] (local-path :remote-path | :remote-path local-path)
Copy files to or from virtual machine using `sftp`
Usage:
ubi vm (location/vm-name | vm-id) [options] sftp [sftp-options]
Show details for a virtual machine
Usage:
ubi vm (location/vm-name | vm-id) show [options]
Options:
-f, --fields=fields show specific fields (comma separated)
-r, --rule-fields=fields show specific firewall rule fields (comma separated)
-w, --firewall-fields=fields show specific firewall fields (comma separated)
Fields: id name state location size unix-user storage-size-gib ip6 ip4-enabled
ip4 private-ipv4 private-ipv6 subnet firewalls
Firewall Rule Fields: id cidr port-range
Firewall Fields: id name description location path firewall-rules
Connect to a virtual machine using `ssh`
Usage:
ubi vm (location/vm-name | vm-id) [options] ssh [ssh-options --] [remote-cmd [remote-cmd-arg ...]]