Keyboard shortcuts

Press or to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

twc-rs server

Manage cloud servers

SubcommandDescription
listList all cloud servers
infoShow detailed info for a server
deleteDelete a server by ID
rebootReboot a server by ID
startPower a server on
shutdownGracefully shut a server down
cloneClone a server by ID
reset-passwordReset a server’s root password
list-presetsList available server presets
list-osList installable OS images
list-softwareList available pre-installable software
list-configuratorsList server configurators (custom builds)
diskList the disks attached to a server
ipList the IP addresses of a server
historyShow the recent action history (logs) of a server
set-nat-modeSet the NAT mode of a server’s local network
set-boot-modeSet the OS boot mode of a server (restarts the server)
resizeResize a server to a different preset
reinstallReinstall the OS of a server (wipes data)
createCreate a new cloud server from a preset and OS image
setUpdate a server’s name and/or comment
backup-listList disk backups of a server
backup-createCreate a disk backup of a server’s system disk

twc-rs server list

List all cloud servers

ArgumentDescriptionRequiredEnvDefault
--limitMaximum number of servers to return
--offsetNumber of servers to skip
-f, --formatOutput format: table (default), json, yaml, or quietTWC_OUTPUTtable
-t, --tokenAPI token override (overrides config file and TWC_TOKEN env)TWC_TOKEN
--profileUse a named profile’s token from the config fileTWC_PROFILE

twc-rs server info

Show detailed info for a server

ArgumentDescriptionRequiredEnvDefault
--idServer IDyes
-f, --formatOutput format: table (default), json, yaml, or quietTWC_OUTPUTtable
-t, --tokenAPI token override (overrides config file and TWC_TOKEN env)TWC_TOKEN
--profileUse a named profile’s token from the config fileTWC_PROFILE

twc-rs server delete

Delete a server by ID

ArgumentDescriptionRequiredEnvDefault
--idServer IDyes
-f, --formatOutput format: table (default), json, yaml, or quietTWC_OUTPUTtable
-t, --tokenAPI token override (overrides config file and TWC_TOKEN env)TWC_TOKEN
--profileUse a named profile’s token from the config fileTWC_PROFILE

twc-rs server reboot

Reboot a server by ID

ArgumentDescriptionRequiredEnvDefault
--idServer IDyes
-f, --formatOutput format: table (default), json, yaml, or quietTWC_OUTPUTtable
-t, --tokenAPI token override (overrides config file and TWC_TOKEN env)TWC_TOKEN
--profileUse a named profile’s token from the config fileTWC_PROFILE

twc-rs server start

Power a server on

ArgumentDescriptionRequiredEnvDefault
--idServer IDyes
-f, --formatOutput format: table (default), json, yaml, or quietTWC_OUTPUTtable
-t, --tokenAPI token override (overrides config file and TWC_TOKEN env)TWC_TOKEN
--profileUse a named profile’s token from the config fileTWC_PROFILE

twc-rs server shutdown

Gracefully shut a server down

ArgumentDescriptionRequiredEnvDefault
--idServer IDyes
-f, --formatOutput format: table (default), json, yaml, or quietTWC_OUTPUTtable
-t, --tokenAPI token override (overrides config file and TWC_TOKEN env)TWC_TOKEN
--profileUse a named profile’s token from the config fileTWC_PROFILE

twc-rs server clone

Clone a server by ID

ArgumentDescriptionRequiredEnvDefault
--idServer IDyes
-f, --formatOutput format: table (default), json, yaml, or quietTWC_OUTPUTtable
-t, --tokenAPI token override (overrides config file and TWC_TOKEN env)TWC_TOKEN
--profileUse a named profile’s token from the config fileTWC_PROFILE

twc-rs server reset-password

Reset a server’s root password

ArgumentDescriptionRequiredEnvDefault
--idServer IDyes
-f, --formatOutput format: table (default), json, yaml, or quietTWC_OUTPUTtable
-t, --tokenAPI token override (overrides config file and TWC_TOKEN env)TWC_TOKEN
--profileUse a named profile’s token from the config fileTWC_PROFILE

twc-rs server list-presets

List available server presets

ArgumentDescriptionRequiredEnvDefault
-f, --formatOutput format: table (default), json, yaml, or quietTWC_OUTPUTtable
-t, --tokenAPI token override (overrides config file and TWC_TOKEN env)TWC_TOKEN
--profileUse a named profile’s token from the config fileTWC_PROFILE

twc-rs server list-os

List installable OS images

ArgumentDescriptionRequiredEnvDefault
-f, --formatOutput format: table (default), json, yaml, or quietTWC_OUTPUTtable
-t, --tokenAPI token override (overrides config file and TWC_TOKEN env)TWC_TOKEN
--profileUse a named profile’s token from the config fileTWC_PROFILE

twc-rs server list-software

List available pre-installable software

ArgumentDescriptionRequiredEnvDefault
-f, --formatOutput format: table (default), json, yaml, or quietTWC_OUTPUTtable
-t, --tokenAPI token override (overrides config file and TWC_TOKEN env)TWC_TOKEN
--profileUse a named profile’s token from the config fileTWC_PROFILE

twc-rs server list-configurators

List server configurators (custom builds)

ArgumentDescriptionRequiredEnvDefault
-f, --formatOutput format: table (default), json, yaml, or quietTWC_OUTPUTtable
-t, --tokenAPI token override (overrides config file and TWC_TOKEN env)TWC_TOKEN
--profileUse a named profile’s token from the config fileTWC_PROFILE

twc-rs server disk

List the disks attached to a server

ArgumentDescriptionRequiredEnvDefault
--idServer IDyes
-f, --formatOutput format: table (default), json, yaml, or quietTWC_OUTPUTtable
-t, --tokenAPI token override (overrides config file and TWC_TOKEN env)TWC_TOKEN
--profileUse a named profile’s token from the config fileTWC_PROFILE

twc-rs server ip

List the IP addresses of a server

ArgumentDescriptionRequiredEnvDefault
--idServer IDyes
-f, --formatOutput format: table (default), json, yaml, or quietTWC_OUTPUTtable
-t, --tokenAPI token override (overrides config file and TWC_TOKEN env)TWC_TOKEN
--profileUse a named profile’s token from the config fileTWC_PROFILE

twc-rs server history

Show the recent action history (logs) of a server

ArgumentDescriptionRequiredEnvDefault
--idServer IDyes
-f, --formatOutput format: table (default), json, yaml, or quietTWC_OUTPUTtable
-t, --tokenAPI token override (overrides config file and TWC_TOKEN env)TWC_TOKEN
--profileUse a named profile’s token from the config fileTWC_PROFILE

twc-rs server set-nat-mode

Set the NAT mode of a server’s local network

ArgumentDescriptionRequiredEnvDefault
--idServer IDyes
--nat-modeOne of: dnat_and_snat, snat, no_natyes
-f, --formatOutput format: table (default), json, yaml, or quietTWC_OUTPUTtable
-t, --tokenAPI token override (overrides config file and TWC_TOKEN env)TWC_TOKEN
--profileUse a named profile’s token from the config fileTWC_PROFILE

twc-rs server set-boot-mode

Set the OS boot mode of a server (restarts the server)

ArgumentDescriptionRequiredEnvDefault
--idServer IDyes
--boot-modeOne of: default, single, recovery_diskyes
-f, --formatOutput format: table (default), json, yaml, or quietTWC_OUTPUTtable
-t, --tokenAPI token override (overrides config file and TWC_TOKEN env)TWC_TOKEN
--profileUse a named profile’s token from the config fileTWC_PROFILE

twc-rs server resize

Resize a server to a different preset

ArgumentDescriptionRequiredEnvDefault
--idServer IDyes
--preset-idTarget preset IDyes
-f, --formatOutput format: table (default), json, yaml, or quietTWC_OUTPUTtable
-t, --tokenAPI token override (overrides config file and TWC_TOKEN env)TWC_TOKEN
--profileUse a named profile’s token from the config fileTWC_PROFILE

twc-rs server reinstall

Reinstall the OS of a server (wipes data)

ArgumentDescriptionRequiredEnvDefault
--idServer IDyes
--os-idOS image ID to installyes
-f, --formatOutput format: table (default), json, yaml, or quietTWC_OUTPUTtable
-t, --tokenAPI token override (overrides config file and TWC_TOKEN env)TWC_TOKEN
--profileUse a named profile’s token from the config fileTWC_PROFILE

twc-rs server create

Create a new cloud server from a preset and OS image

ArgumentDescriptionRequiredEnvDefault
--nameServer name (max 255 chars)yes
--preset-idPreset (tariff) ID. Use server list-presets to listyes
--os-idOS image ID. Use server list-os to listyes
--commentOptional comment (max 255 chars)
--ssh-keySSH key IDs to attach (repeatable)
--project-idProject ID to place the server in
--availability-zoneAvailability zone (e.g. spb-1, msk-1, ams-1)
-f, --formatOutput format: table (default), json, yaml, or quietTWC_OUTPUTtable
-t, --tokenAPI token override (overrides config file and TWC_TOKEN env)TWC_TOKEN
--profileUse a named profile’s token from the config fileTWC_PROFILE

twc-rs server set

Update a server’s name and/or comment

ArgumentDescriptionRequiredEnvDefault
--idServer IDyes
--nameNew name
--commentNew comment
-f, --formatOutput format: table (default), json, yaml, or quietTWC_OUTPUTtable
-t, --tokenAPI token override (overrides config file and TWC_TOKEN env)TWC_TOKEN
--profileUse a named profile’s token from the config fileTWC_PROFILE

twc-rs server backup-list

List disk backups of a server

ArgumentDescriptionRequiredEnvDefault
--idServer IDyes
-f, --formatOutput format: table (default), json, yaml, or quietTWC_OUTPUTtable
-t, --tokenAPI token override (overrides config file and TWC_TOKEN env)TWC_TOKEN
--profileUse a named profile’s token from the config fileTWC_PROFILE

twc-rs server backup-create

Create a disk backup of a server’s system disk

ArgumentDescriptionRequiredEnvDefault
--idServer IDyes
--commentOptional backup comment
-f, --formatOutput format: table (default), json, yaml, or quietTWC_OUTPUTtable
-t, --tokenAPI token override (overrides config file and TWC_TOKEN env)TWC_TOKEN
--profileUse a named profile’s token from the config fileTWC_PROFILE