upctl
UpCloud command-line interface
upctl provides a command-line interface to UpCloud services. It allows you to
control your resources from the command line or any compatible interface.
To be able to manage your UpCloud resources, you need to configure credentials
for upctl. We recommend using API tokens. Configure credentials by using
upctl account login --with-token command to save a token to system keyring, in
~/.config/upctl.yaml or set the UPCLOUD_TOKEN environment variable.
Alternatively, use UPCLOUD_USERNAME and UPCLOUD_PASSWORD environment
variables. When using username and password, API access can be configured on the
Account page of the UpCloud Hub. We recommend you to set up a sub-account
specifically for the API usage with its own credentials, as it allows you to
assign specific permissions for increased security.
Options
| Option | Description |
|---|---|
--client-timeout, -t |
Client timeout to use in API calls. Default: 0s |
--config |
Configuration file path. |
--debug |
Print out more verbose debug logs. Default: false |
--force-colours |
Force coloured output despite detected terminal support. |
--help, -h |
help for upctl Default: false |
--no-colours |
Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. |
--output, -o |
Output format. Valid values are human, json and yaml.Default: human |
Related commands
| Command | Description |
|---|---|
| upctl account | Manage accounts |
| upctl audit-log | Manage audit logs |
| upctl database | Manage databases |
| upctl gateway | Manage gateways |
| upctl host | Manage private cloud hosts |
| upctl ip-address | Manage IP addresses |
| upctl kubernetes | Manage Kubernetes clusters |
| upctl load-balancer | Manage load balancers |
| upctl network | Manage networks |
| upctl network-peering | Manage network peerings |
| upctl object-storage | Manage managed object storage services |
| upctl partner | Manage partner resources |
| upctl router | Manage routers |
| upctl server | Manage servers |
| upctl server-group | Manage server groups |
| upctl stack | Manage stacks (EXPERIMENTAL) |
| upctl storage | Manage storages |
| upctl version | Display software information |
| upctl zone | Display zone information |