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
| Argument | Description |
|---|
VM_ID required | VM ID (vm-...). |
| Option | Value | Description |
|---|
--limit | int range | Show at most this many. Default: 50. |
--project, -p | str | Project ID (default: from the profile). |
--output, -o | table | json | yaml | Output 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
| Argument | Description |
|---|
VM_ID required | VM ID (vm-...). |
| Option | Value | Description |
|---|
--vnc | flag | Print a one-time VNC websocket URL instead. |
--project, -p | str | Project ID (default: from the profile). |
tebib vm create
Create a VM from an image.
tebib vm create [OPTIONS] NAME
| Argument | Description |
|---|
NAME required | VM name, unique in the project. |
| Option | Value | Description |
|---|
--image required | str | Image name (see tebib image list). |
--type required | str | Instance type (see tebib instance-type list). |
--ssh-key | KEY_ID (repeatable) | SSH key ID to install (repeatable). |
--subnet | str | Subnet ID (default: the project's default subnet). |
--security-group | SG_ID (repeatable) | Security group ID (repeatable; default: the VPC's default group). |
--root-disk | int range | Boot volume size in GiB. |
--user-data | file | cloud-init user data file (#cloud-config ...). |
--hostname | str | Hostname (default: the name). |
--stopped | flag | Create it without starting it. |
--description | str | Description. |
--tag | KEY=VALUE (repeatable) | Tag as KEY=VALUE; repeat for more tags. |
--project, -p | str | Project ID (default: from the profile). |
--wait | flag | Wait until the resource is ready (or gone, for deletes). |
--timeout | float range | Seconds to wait with --wait. Default: 900. |
--output, -o | table | json | yaml | Output format. |
tebib vm delete
Delete a VM.
tebib vm delete [OPTIONS] ID
| Argument | Description |
|---|
ID required | VM ID (vm-...). |
| Option | Value | Description |
|---|
--yes, -y | flag | Don't ask for confirmation. |
--wait | flag | Wait until the resource is ready (or gone, for deletes). |
--timeout | float range | Seconds to wait with --wait. Default: 600. |
--project, -p | str | Project ID (default: from the profile). |
tebib vm list
List the project's vms.
| Option | Value | Description |
|---|
--project, -p | str | Project ID (default: from the profile). |
--limit | int range | Show at most this many items. |
--output, -o | table | json | yaml | Output format. |
tebib vm metrics
Show a VM's CPU, memory, network and disk use: latest, average and peak.
tebib vm metrics [OPTIONS] VM_ID
| Argument | Description |
|---|
VM_ID required | VM ID (vm-...). |
| Option | Value | Description |
|---|
--window, -w | str | Time range: 1h, 6h, 24h or 7d. Default: 1h. |
--project, -p | str | Project ID (default: from the profile). |
--output, -o | table | json | yaml | Output 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
| Argument | Description |
|---|
VM_ID required | VM ID (vm-...). |
| Option | Value | Description |
|---|
--hard | flag | Reset at once instead of asking the guest. |
--project, -p | str | Project ID (default: from the profile). |
--wait | flag | Wait until the resource is ready (or gone, for deletes). |
--timeout | float range | Seconds to wait with --wait. Default: 600. |
--output, -o | table | json | yaml | Output 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
| Argument | Description |
|---|
VM_ID required | VM ID (vm-...). |
TYPE required | New instance type. |
| Option | Value | Description |
|---|
--project, -p | str | Project ID (default: from the profile). |
--wait | flag | Wait until the resource is ready (or gone, for deletes). |
--timeout | float range | Seconds to wait with --wait. Default: 900. |
--output, -o | table | json | yaml | Output format. |
tebib vm restore
Restore a stopped VM's disks from one of its snapshots.
tebib vm restore [OPTIONS] VM_ID SNAPSHOT_ID
| Argument | Description |
|---|
VM_ID required | VM ID (vm-...). |
SNAPSHOT_ID required | Snapshot ID. |
| Option | Value | Description |
|---|
--project, -p | str | Project ID (default: from the profile). |
--wait | flag | Wait until the resource is ready (or gone, for deletes). |
--timeout | float range | Seconds to wait with --wait. Default: 1800. |
--output, -o | table | json | yaml | Output 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...
| Argument | Description |
|---|
VM_ID required | VM ID (vm-...). |
SG_ID... required | The VM's security groups (all of them). |
| Option | Value | Description |
|---|
--project, -p | str | Project ID (default: from the profile). |
--wait | flag | Wait until the resource is ready (or gone, for deletes). |
--timeout | float range | Seconds to wait with --wait. Default: 300. |
--output, -o | table | json | yaml | Output format. |
tebib vm show
Show one VM.
tebib vm show [OPTIONS] ID
| Argument | Description |
|---|
ID required | VM ID (vm-...). |
| Option | Value | Description |
|---|
--project, -p | str | Project ID (default: from the profile). |
--output, -o | table | json | yaml | Output format. |
tebib vm start
Start a stopped VM.
tebib vm start [OPTIONS] VM_ID
| Argument | Description |
|---|
VM_ID required | VM ID (vm-...). |
| Option | Value | Description |
|---|
--project, -p | str | Project ID (default: from the profile). |
--wait | flag | Wait until the resource is ready (or gone, for deletes). |
--timeout | float range | Seconds to wait with --wait. Default: 600. |
--output, -o | table | json | yaml | Output format. |
tebib vm stop
Shut a VM down (it keeps its disks and addresses).
tebib vm stop [OPTIONS] VM_ID
| Argument | Description |
|---|
VM_ID required | VM ID (vm-...). |
| Option | Value | Description |
|---|
--project, -p | str | Project ID (default: from the profile). |
--wait | flag | Wait until the resource is ready (or gone, for deletes). |
--timeout | float range | Seconds to wait with --wait. Default: 600. |
--output, -o | table | json | yaml | Output format. |
tebib vm update
Change a VM's description or tags.
tebib vm update [OPTIONS] ID
| Argument | Description |
|---|
ID required | VM ID (vm-...). |
| Option | Value | Description |
|---|
--description | str | New description. |
--tag | KEY=VALUE (repeatable) | Replace ALL tags (KEY=VALUE, repeatable). |
--clear-tags | flag | Remove all tags. |
--project, -p | str | Project ID (default: from the profile). |
--output, -o | table | json | yaml | Output format. |