Skip to content

tebib vm

Generated from the CLI's own command tree. Run tebib vm --help for the same text in your terminal.

Virtual machines.

Commands

tebib vm activity

Show who did what to a VM, and when (its audit trail), newest first.

tebib vm activity [OPTIONS] VM_ID
ArgumentDescription
VM_ID requiredVM ID (vm-...).
OptionValueDescription
--limitint rangeShow at most this many. Default: 50.
--project, -pstrProject ID (default: from the profile).
--output, -otable | json | yamlOutput format.

Examples

tebib vm activity vm-... --limit 20 # who did what to it, newest first

tebib vm console

Open the VM's serial console in this terminal (Ctrl-] to leave).

tebib vm console [OPTIONS] VM_ID
ArgumentDescription
VM_ID requiredVM ID (vm-...).
OptionValueDescription
--vncflagPrint a one-time VNC websocket URL instead.
--project, -pstrProject ID (default: from the profile).

tebib vm create

Create a VM from an image.

tebib vm create [OPTIONS] NAME
ArgumentDescription
NAME requiredVM name, unique in the project.
OptionValueDescription
--image requiredstrImage name (see tebib image list).
--type requiredstrInstance type (see tebib instance-type list).
--ssh-keyKEY_ID (repeatable)SSH key ID to install (repeatable).
--subnetstrSubnet ID (default: the project's default subnet).
--security-groupSG_ID (repeatable)Security group ID (repeatable; default: the VPC's default group).
--root-diskint rangeBoot volume size in GiB.
--user-datafilecloud-init user data file (#cloud-config ...).
--hostnamestrHostname (default: the name).
--stoppedflagCreate it without starting it.
--descriptionstrDescription.
--tagKEY=VALUE (repeatable)Tag as KEY=VALUE; repeat for more tags.
--project, -pstrProject ID (default: from the profile).
--waitflagWait until the resource is ready (or gone, for deletes).
--timeoutfloat rangeSeconds to wait with --wait. Default: 900.
--output, -otable | json | yamlOutput format.

tebib vm delete

Delete a VM.

tebib vm delete [OPTIONS] ID
ArgumentDescription
ID requiredVM ID (vm-...).
OptionValueDescription
--yes, -yflagDon't ask for confirmation.
--waitflagWait until the resource is ready (or gone, for deletes).
--timeoutfloat rangeSeconds to wait with --wait. Default: 600.
--project, -pstrProject ID (default: from the profile).

tebib vm list

List the project's vms.

tebib vm list [OPTIONS]
OptionValueDescription
--project, -pstrProject ID (default: from the profile).
--limitint rangeShow at most this many items.
--output, -otable | json | yamlOutput format.

tebib vm metrics

Show a VM's CPU, memory, network and disk use: latest, average and peak.

tebib vm metrics [OPTIONS] VM_ID
ArgumentDescription
VM_ID requiredVM ID (vm-...).
OptionValueDescription
--window, -wstrTime range: 1h, 6h, 24h or 7d. Default: 1h.
--project, -pstrProject ID (default: from the profile).
--output, -otable | json | yamlOutput format.

Examples

tebib vm metrics vm-... --window 24h # CPU, memory, network, disk: latest, average, peak
tebib -o json vm metrics vm-... # the raw series (one shared time axis)

tebib vm reboot

Reboot a running VM.

tebib vm reboot [OPTIONS] VM_ID
ArgumentDescription
VM_ID requiredVM ID (vm-...).
OptionValueDescription
--hardflagReset at once instead of asking the guest.
--project, -pstrProject ID (default: from the profile).
--waitflagWait until the resource is ready (or gone, for deletes).
--timeoutfloat rangeSeconds to wait with --wait. Default: 600.
--output, -otable | json | yamlOutput format.

tebib vm resize

Change a VM's instance type (it may need a restart; see "Restart required").

tebib vm resize [OPTIONS] VM_ID TYPE
ArgumentDescription
VM_ID requiredVM ID (vm-...).
TYPE requiredNew instance type.
OptionValueDescription
--project, -pstrProject ID (default: from the profile).
--waitflagWait until the resource is ready (or gone, for deletes).
--timeoutfloat rangeSeconds to wait with --wait. Default: 900.
--output, -otable | json | yamlOutput format.

tebib vm restore

Restore a stopped VM's disks from one of its snapshots.

tebib vm restore [OPTIONS] VM_ID SNAPSHOT_ID
ArgumentDescription
VM_ID requiredVM ID (vm-...).
SNAPSHOT_ID requiredSnapshot ID.
OptionValueDescription
--project, -pstrProject ID (default: from the profile).
--waitflagWait until the resource is ready (or gone, for deletes).
--timeoutfloat rangeSeconds to wait with --wait. Default: 1800.
--output, -otable | json | yamlOutput format.

tebib vm set-security-groups

Replace the security groups on a VM's network interface.

tebib vm set-security-groups [OPTIONS] VM_ID SG_ID...
ArgumentDescription
VM_ID requiredVM ID (vm-...).
SG_ID... requiredThe VM's security groups (all of them).
OptionValueDescription
--project, -pstrProject ID (default: from the profile).
--waitflagWait until the resource is ready (or gone, for deletes).
--timeoutfloat rangeSeconds to wait with --wait. Default: 300.
--output, -otable | json | yamlOutput format.

tebib vm show

Show one VM.

tebib vm show [OPTIONS] ID
ArgumentDescription
ID requiredVM ID (vm-...).
OptionValueDescription
--project, -pstrProject ID (default: from the profile).
--output, -otable | json | yamlOutput format.

tebib vm start

Start a stopped VM.

tebib vm start [OPTIONS] VM_ID
ArgumentDescription
VM_ID requiredVM ID (vm-...).
OptionValueDescription
--project, -pstrProject ID (default: from the profile).
--waitflagWait until the resource is ready (or gone, for deletes).
--timeoutfloat rangeSeconds to wait with --wait. Default: 600.
--output, -otable | json | yamlOutput format.

tebib vm stop

Shut a VM down (it keeps its disks and addresses).

tebib vm stop [OPTIONS] VM_ID
ArgumentDescription
VM_ID requiredVM ID (vm-...).
OptionValueDescription
--project, -pstrProject ID (default: from the profile).
--waitflagWait until the resource is ready (or gone, for deletes).
--timeoutfloat rangeSeconds to wait with --wait. Default: 600.
--output, -otable | json | yamlOutput format.

tebib vm update

Change a VM's description or tags.

tebib vm update [OPTIONS] ID
ArgumentDescription
ID requiredVM ID (vm-...).
OptionValueDescription
--descriptionstrNew description.
--tagKEY=VALUE (repeatable)Replace ALL tags (KEY=VALUE, repeatable).
--clear-tagsflagRemove all tags.
--project, -pstrProject ID (default: from the profile).
--output, -otable | json | yamlOutput format.