Allow using unix style glob pattern as an argument. For example, if there are two servers available with titles server-1 and server-2, these servers can be stopped with upctl server stop server-* command.
--delete-buckets option to objectstorage delete command.
@@ -5133,7 +5222,7 @@
Fixed
In objectstorage delete command, delete only user defined policies when --delete-policies flag is enabled as trying to delete system defined policy will cause an error.
In storage modify, avoid segfault if the target storage does not have backup rule in the storage details. This would have happened, for example, when renaming private templates.
In router show command, list static routes in the human readable output and add static route type field to all outputs.
@@ -5166,7 +5255,7 @@
Changed
In server create command, enable metadata service by default when the selected (or default) template uses cloud-init (template_type is cloud-init) and thus requires it.
Support nested properties in database properties * and database properties * show * outputs. For example upctl max_background_workers sub-property of timescaledb PostgreSQL property is listed as timescaledb.max_background_workers in human output of database properties pg and its details can printed with upctl database properties pg show timescaledb.max_background_workers command.
@@ -5248,17 +5337,17 @@
Fixed
Do not return error on valid dhcp-default-route values in network create and network modify commands.
This release updates output of show and list commands to return the API response as defined in the UpCloud Go SDK. See below for detailed list of changes.
In addition, kubernetes create will now, by default, block all access to the cluster. To be able to connect to the cluster, define list of allowed IP addresses and/or CIDR blocks or allow access from any IP.
-
Added
+
Added
Breaking: Add --kubernetes-api-allow-ip argument to kubernetes create command. This changes default behavior from allow access from any IP to block access from all IPs. To be able to connect to the cluster, define list of allowed IP addresses and/or CIDR blocks or allow access from any IP.
Add Kubernetes API allowed IPs field to kubernetes show output.
@@ -5309,7 +5398,7 @@
Removed
Breaking: In JSON and YAML output of database properties * show: pass-through the API response. This removes key field from the output.
Add --wait flag to storage import and storage templatise commands to wait until storage is in online state.
In JSON and YAML output of storage import: information on target storage is now available under storage key.
@@ -5431,7 +5520,7 @@
Fixed
In human output of storage import: output UUID of created storage, instead of storage import operation. No UUID is outputted if existing storage was used.
Add --wait flag to server create and server stop commands to wait until server is in started and stopped state, respectively.
@@ -5504,7 +5593,7 @@
Fixed
Mark error and warning livelogs finished when they will not be updated anymore: this stops the timer in the end of the row and stops livelog from refreshing these lines.
Include UUID (or address) of created resource in create command output
storage modify command now accepts enable-filesystem-autoresize flag. When that flag is set upctl will attempt to resize partition and filesystem after storage size has been modified.
@@ -5542,7 +5631,7 @@
Changed
Always create a password when password delivery method is chosen
upctl provides a command-line interface to UpCloud services. It allows you to control your resources from the command line or any compatible interface.
Use homebrew to install upctl from UpCloudLtd tap.
brew tap UpCloudLtd/tap\nbrew install upcloud-cli\n
First, download the archived binary from GitHub releases to current folder and extract the binary from the archive.
Invoke-WebRequest -Uri \"https://github.com/UpCloudLtd/upcloud-cli/releases/download/v3.14.0/upcloud-cli_3.14.0_windows_x86_64.zip\" -OutFile \"upcloud-cli_3.14.0_windows_x86_64.zip\"\nExpand-Archive -Path \"upcloud-cli_3.14.0_windows_x86_64.zip\"\n\n# Print current location\nGet-Location\n
Then, close the current PowerShell session and open a new session as an administrator. Move the binary to upcloud-cli folder in Program Files, add the upcloud-cli folder in Program Files to Path.
# Open the PowerShell with Run as Administrator option.\n# Use Set-Location to change into folder that you used in previous step.\n\nNew-Item -ItemType Directory $env:ProgramFiles\\upcloud-cli\\ -Force\nMove-Item -Path upcloud-cli_3.14.0_windows_x86_64\\upctl.exe -Destination $env:ProgramFiles\\upcloud-cli\\ -Force\n\n# Setting the Path is required only on first install.\n# Thus, this step can be skipped when updating to a more recent version.\n[Environment]::SetEnvironmentVariable(\"Path\", [Environment]::GetEnvironmentVariable(\"Path\", [EnvironmentVariableTarget]::Machine) + \";$env:ProgramFiles\\upcloud-cli\\\", [EnvironmentVariableTarget]::Machine)\n
After running the above commands, close the administrator PowerShell session and open a new PowerShell session to verify installation succeeded.
Install the latest version of upctl with go install, by running:
go install github.com/UpCloudLtd/upcloud-cli/v3/...@latest\n
Pull the latest build from GHCR by running:
docker pull ghcr.io/upcloudltd/upctl:latest\n
After installing upctl, you can run upctl version command to verify that the tool was installed successfully.
upctl provides shell completions for multiple shells. Run upctl completion --help to list the supported shells.
upctl completion --help\n
To configure the shell completions, follow the instructions provided in the help output of the command matching the shell you are using. For example, if you are using zsh, run upctl completion zsh --help to print the configuration instructions.
Finally, configure the shell completions for upctl by either sourcing upctl completion bash output in your bash .bashrc or by saving the output of that command in upctl file under /etc/bash_completion.d/:
# First alternative\necho 'source <(upctl completion bash)' >>~/.bashrc\n\n# Second alternative\nupctl completion bash | sudo tee /etc/bash_completion.d/upctl > /dev/null\n\n# Source completions to current shell session\n. /etc/bash_completion\n
First, install bash-completion package, if it has not been installed already, and add command to source the completions to your .bash_profile.
To be able to manage your UpCloud resources, you need to configure credentials for upctl and enable API access for these credentials.
Define the credentials by setting UPCLOUD_USERNAME and UPCLOUD_PASSWORD environment variables.
API access can be configured in the UpCloud Hub on Account page for the main-account and on the Permissions tab of the People page for sub-accounts. We recommend you to set up a sub-account specifically for the API usage with its own username and password, as it allows you to assign specific permissions for increased security.
To verify you are able to access the UpCloud API, you can, for example, run upctl account show command to print your current balance and resource limits.
upctl account show\n
For usage examples, see the Examples section of the documentation.
For reference on how to use each sub-command, see the Commands reference section of the documentation. The same information is also available in --help output of each command.
Allow using unix style glob pattern as an argument. For example, if there are two servers available with titles server-1 and server-2, these servers can be stopped with upctl server stop server-* command.
--delete-buckets option to objectstorage delete command.
In objectstorage delete command, delete only user defined policies when --delete-policies flag is enabled as trying to delete system defined policy will cause an error.
Take server state into account in server completions. For example, do not offer started servers as completions for server start command.
Allow using UUID prefix as an argument. For example, if there is only one network available that has an UUID starting with 0316, details of that network can be listed with upctl network show 0316 command.
Match title and name arguments case-insensitively if the given parameter does not resolve with an exact match.
In storage modify, avoid segfault if the target storage does not have backup rule in the storage details. This would have happened, for example, when renaming private templates.
In server create command, use Ubuntu Server 24.04 LTS (Noble Numbat) as default value for --os. The new default template only supports SSH key based authentication. Use --ssh-keys option to provide the keys when creating a server with the default template.
In server create command, enable metadata service by default when the selected (or default) template uses cloud-init (template_type is cloud-init) and thus requires it.
Omit storage tier from server create payload to use plans default storage tier. This allows creating servers with developer plans that do not allow creating MaxIOPS storages with the server. Other plan types will continue to use MaxIOPS by default.
Support nested properties in database properties * and database properties * show * outputs. For example upctl max_background_workers sub-property of timescaledb PostgreSQL property is listed as timescaledb.max_background_workers in human output of database properties pg and its details can printed with upctl database properties pg show timescaledb.max_background_workers command.
Breaking: Update return type of kubernetes versions from list of strings to list of objects. (No major version bump, because this end-point has not been included in the API docs)
This release updates output of show and list commands to return the API response as defined in the UpCloud Go SDK. See below for detailed list of changes.
In addition, kubernetes create will now, by default, block all access to the cluster. To be able to connect to the cluster, define list of allowed IP addresses and/or CIDR blocks or allow access from any IP.
Breaking: Add --kubernetes-api-allow-ip argument to kubernetes create command. This changes default behavior from allow access from any IP to block access from all IPs. To be able to connect to the cluster, define list of allowed IP addresses and/or CIDR blocks or allow access from any IP.
Add Kubernetes API allowed IPs field to kubernetes show output.
Add kubernetes nodegroup show for displaying node-group details. This also adds Nodes table and Anti-affinity field that were not available in previous kubernetes show output.
Add kubernetes modify command for modifying IP addresses that are allowed to access cluster's Kubernetes API.
Add Kubernetes API allowed IPs field to kubernetes show output.
Add database session list for listing active database sessions.
Add database session cancel for cancelling an active database session.
Breaking: In JSON and YAML output of database list: return the full API response. Value of title is not replaced with value from name, if title is empty.
Breaking: In JSON and YAML output of database types: return the full API response. This changes the top level datatype from list to object, where keys are the available database type, e.g., pg and mysql.
Breaking: In JSON and YAML output of ip-address list: return the full API response. This changes partofplan key to part_of_plan and ptrrecord key to ptr_record. The top level data-type changes from list to object.
Breaking: In JSON and YAML output of loadbalancer list: return the full API response. This changes state field to operational_state.
Breaking: In JSON and YAML output of network list and network show: return the full API response. Servers list will only contain server UUID and name. In network list output, the top level data-type changes from list to object.
Breaking: In JSON and YAML output of server list and server show: return the full API response. This changes field host_id to host. nics is replaced with networking subfield interfaces. storage is replaced with storage_devices. labels contain subfield label which in turn contains the labels. In server list output, the top level data-type changes from list to object.
Breaking: In JSON and YAML output of server firewall show: return the full API response. This removes fields destination and source fields in favor of [destination|source]_address_start, [destination|source]_address_end, [destination|source]_port_start and [destination|source]_port_end.
Breaking: In JSON and YAML output of server plans: return the full API response. The top level data-type changes from list to object.
Breaking: In JSON and YAML output of storage list and storage show: return the full API response. This changes servers field to contain server field, which in turn contains the servers. labels field will not be outputted if empty. In storage list output, the top level data-type changes from list to object.
Breaking: In JSON and YAML output of zone list: return the full API response. The top level data-type changes from list to object.
In JSON and YAML output of kubernetes list: return the full API response.
In human readable output of kubernetes show command, show node-groups as table. Node-group details are available with kubernetes nodegroup show command.
Breaking: In JSON and YAML output of ip-address show: use same JSON keys as in API documentation. This removes credits key that was used in place of floating.
Added support for all shell completions provided by cobra.
Add database properties <DB type> command to list database properties for given database type and database properties <DB type> show command to show database property details.
Remove custom bash completion logic and replace it with completion command provided by cobra. To do this while supporting args with whitespace, whitespace in completions is replaced with non-breaking spaces.
Suppress positional argument filename completion for commands without specific completions.
In database list output: if database has no title, database name is displayed in the title cell instead of leaving the cell empty, similarly than in the hub.
Version information is parsed from BuildInfo when upctl binary was built without specifying -ldflags to define value for .../config.Version.
Use alpine as base image for upcloud/upctl container image. This adds sh and other OS tools to the image and thus makes it more suitable for usage in CI systems.
In human output of storage list: capitalize zone column header and color storage state similarly than in storage show.
In human output of storage import: output UUID of created storage, instead of storage import operation. No UUID is outputted if existing storage was used.
Breaking: Set non-zero exit code if command execution fails.
Breaking: Render servers IP addresses as array of objects, instead of previous pretty-printed string, in JSON and YAML outputs of server show.
Breaking: Use key names from json field tag also in YAML output to have equal key names in JSON and YAML outputs. For example, bootorder key in server details will now be boot_order also in YAML output. As a side-effect data-types are limited to those supported by JSON. For example, timestamps will be presented as (double-quoted) strings. In addition, if command targets multiple resources, YAML output will now be a list, similarly than in JSON output, instead of previous multiple YAML documents.
Breaking: In JSON and YAML output, storage show lists attached servers in servers list instead of server string.
Breaking: In JSON and YAML output, network show lists DHCP DNS values in list instead of string.
On network show, output server details as unknown instead of outputting an error, if fetching server details fails. This allows displaying network details for networks that contain a load balancer.
Progress logging to non TTY output uses now 100 as text width instead of 0.
On server create, mount OS disk by default on virtio bus. Previously default OS storage address was not explicit and varyed depending on template type.
Disable colors if user has set NO_COLOR environment variable to non-empty value.
Do not display usage if execution fails because of missing credentials
Mark error and warning livelogs finished when they will not be updated anymore: this stops the timer in the end of the row and stops livelog from refreshing these lines.
Include UUID (or address) of created resource in create command output
storage modify command now accepts enable-filesystem-autoresize flag. When that flag is set upctl will attempt to resize partition and filesystem after storage size has been modified.
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 and enable API access for these credentials. Define the credentials by setting UPCLOUD_USERNAME and UPCLOUD_PASSWORD environment variables. 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 username and password, as it allows you to assign specific permissions for increased security.
"},{"location":"commands_reference/upctl/#options","title":"Options","text":"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 upctlDefault: 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 (supported: json, yaml and human)Default: human"},{"location":"commands_reference/upctl/#related-commands","title":"Related commands","text":"Command Description upctl account Manage accounts 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 loadbalancer Manage load balancers upctl network Manage networks upctl networkpeering Manage network peerings upctl objectstorage Manage managed object storage services upctl partner Manage partner resources upctl router Manage routers upctl server Manage servers upctl servergroup Manage server groups upctl storage Manage storages upctl version Display software information upctl zone Display zone information"},{"location":"commands_reference/upctl_version/","title":"upctl version","text":"
"},{"location":"commands_reference/upctl_version/#options","title":"Options","text":"Option Description --help, -h help for versionDefault: false"},{"location":"commands_reference/upctl_version/#global-options","title":"Global options","text":"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. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output, -o Output format (supported: json, yaml and human)Default: human"},{"location":"commands_reference/upctl_version/#related-commands","title":"Related commands","text":"Command Description upctl UpCloud command-line interface"},{"location":"commands_reference/upctl_account/","title":"upctl account","text":"
Manage accounts
upctl account [flags]\n
"},{"location":"commands_reference/upctl_account/#options","title":"Options","text":"Option Description --help, -h help for accountDefault: false"},{"location":"commands_reference/upctl_account/#global-options","title":"Global options","text":"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. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output, -o Output format (supported: json, yaml and human)Default: human"},{"location":"commands_reference/upctl_account/#related-commands","title":"Related commands","text":"Command Description upctl UpCloud command-line interface upctl account delete Delete a sub-account upctl account list List sub-accounts upctl account permissions Manage permissions upctl account show Show account"},{"location":"commands_reference/upctl_account/delete/","title":"upctl account delete","text":"
"},{"location":"commands_reference/upctl_account/delete/#options","title":"Options","text":"Option Description --help, -h help for deleteDefault: false"},{"location":"commands_reference/upctl_account/delete/#global-options","title":"Global options","text":"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. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output, -o Output format (supported: json, yaml and human)Default: human"},{"location":"commands_reference/upctl_account/delete/#related-commands","title":"Related commands","text":"Command Description upctl account Manage accounts"},{"location":"commands_reference/upctl_account/list/","title":"upctl account list","text":"
"},{"location":"commands_reference/upctl_account/list/#options","title":"Options","text":"Option Description --help, -h help for listDefault: false"},{"location":"commands_reference/upctl_account/list/#global-options","title":"Global options","text":"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. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output, -o Output format (supported: json, yaml and human)Default: human"},{"location":"commands_reference/upctl_account/list/#related-commands","title":"Related commands","text":"Command Description upctl account Manage accounts"},{"location":"commands_reference/upctl_account/show/","title":"upctl account show","text":"
"},{"location":"commands_reference/upctl_account/show/#options","title":"Options","text":"Option Description --help, -h help for showDefault: false"},{"location":"commands_reference/upctl_account/show/#global-options","title":"Global options","text":"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. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output, -o Output format (supported: json, yaml and human)Default: human"},{"location":"commands_reference/upctl_account/show/#related-commands","title":"Related commands","text":"Command Description upctl account Manage accounts"},{"location":"commands_reference/upctl_account/permissions/","title":"upctl account permissions","text":"
Manage permissions
upctl account permissions [flags]\n
"},{"location":"commands_reference/upctl_account/permissions/#options","title":"Options","text":"Option Description --help, -h help for permissionsDefault: false"},{"location":"commands_reference/upctl_account/permissions/#global-options","title":"Global options","text":"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. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output, -o Output format (supported: json, yaml and human)Default: human"},{"location":"commands_reference/upctl_account/permissions/#related-commands","title":"Related commands","text":"Command Description upctl account Manage accounts upctl account permissions list List permissions"},{"location":"commands_reference/upctl_account/permissions/list/","title":"upctl account permissions list","text":"
"},{"location":"commands_reference/upctl_account/permissions/list/#options","title":"Options","text":"Option Description --username Filter permissions by username. --help, -h help for listDefault: false"},{"location":"commands_reference/upctl_account/permissions/list/#global-options","title":"Global options","text":"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. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output, -o Output format (supported: json, yaml and human)Default: human"},{"location":"commands_reference/upctl_account/permissions/list/#related-commands","title":"Related commands","text":"Command Description upctl account permissions Manage permissions"},{"location":"commands_reference/upctl_database/","title":"upctl database","text":"
"},{"location":"commands_reference/upctl_database/#options","title":"Options","text":"Option Description --help, -h help for databaseDefault: false"},{"location":"commands_reference/upctl_database/#global-options","title":"Global options","text":"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. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output, -o Output format (supported: json, yaml and human)Default: human"},{"location":"commands_reference/upctl_database/#related-commands","title":"Related commands","text":"Command Description upctl UpCloud command-line interface upctl database delete Delete a database upctl database index Manage database indices upctl database list List current databases upctl database plans List available plans for given database type upctl database properties List available properties for given database type upctl database session Manage database sessions upctl database show Show database details upctl database start Start on a managed database upctl database stop Stop a managed database upctl database types List available database types"},{"location":"commands_reference/upctl_database/delete/","title":"upctl database delete","text":"
"},{"location":"commands_reference/upctl_database/delete/#options","title":"Options","text":"Option Description --help, -h help for deleteDefault: false"},{"location":"commands_reference/upctl_database/delete/#global-options","title":"Global options","text":"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. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output, -o Output format (supported: json, yaml and human)Default: human"},{"location":"commands_reference/upctl_database/delete/#related-commands","title":"Related commands","text":"Command Description upctl database Manage databases"},{"location":"commands_reference/upctl_database/list/","title":"upctl database list","text":"
"},{"location":"commands_reference/upctl_database/list/#options","title":"Options","text":"Option Description --limit Number of entries to receive at most.Default: 100--page Page number to calculate first item to receive. Page numbers start from 1.Default: 0--help, -h help for listDefault: false"},{"location":"commands_reference/upctl_database/list/#global-options","title":"Global options","text":"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. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output, -o Output format (supported: json, yaml and human)Default: human"},{"location":"commands_reference/upctl_database/list/#related-commands","title":"Related commands","text":"Command Description upctl database Manage databases"},{"location":"commands_reference/upctl_database/plans/","title":"upctl database plans","text":"
"},{"location":"commands_reference/upctl_database/plans/#options","title":"Options","text":"Option Description --help, -h help for plansDefault: false"},{"location":"commands_reference/upctl_database/plans/#global-options","title":"Global options","text":"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. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output, -o Output format (supported: json, yaml and human)Default: human"},{"location":"commands_reference/upctl_database/plans/#related-commands","title":"Related commands","text":"Command Description upctl database Manage databases"},{"location":"commands_reference/upctl_database/show/","title":"upctl database show","text":"
upctl database show 9a8effcb-80e6-4a63-a7e5-066a6d093c14\nupctl database show my-pg-database\nupctl database show my-mysql-database\n
"},{"location":"commands_reference/upctl_database/show/#options","title":"Options","text":"Option Description --help, -h help for showDefault: false"},{"location":"commands_reference/upctl_database/show/#global-options","title":"Global options","text":"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. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output, -o Output format (supported: json, yaml and human)Default: human"},{"location":"commands_reference/upctl_database/show/#related-commands","title":"Related commands","text":"Command Description upctl database Manage databases"},{"location":"commands_reference/upctl_database/start/","title":"upctl database start","text":"
"},{"location":"commands_reference/upctl_database/start/#options","title":"Options","text":"Option Description --help, -h help for startDefault: false"},{"location":"commands_reference/upctl_database/start/#global-options","title":"Global options","text":"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. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output, -o Output format (supported: json, yaml and human)Default: human"},{"location":"commands_reference/upctl_database/start/#related-commands","title":"Related commands","text":"Command Description upctl database Manage databases"},{"location":"commands_reference/upctl_database/stop/","title":"upctl database stop","text":"
"},{"location":"commands_reference/upctl_database/stop/#options","title":"Options","text":"Option Description --help, -h help for stopDefault: false"},{"location":"commands_reference/upctl_database/stop/#global-options","title":"Global options","text":"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. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output, -o Output format (supported: json, yaml and human)Default: human"},{"location":"commands_reference/upctl_database/stop/#related-commands","title":"Related commands","text":"Command Description upctl database Manage databases"},{"location":"commands_reference/upctl_database/types/","title":"upctl database types","text":"
"},{"location":"commands_reference/upctl_database/types/#options","title":"Options","text":"Option Description --help, -h help for typesDefault: false"},{"location":"commands_reference/upctl_database/types/#global-options","title":"Global options","text":"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. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output, -o Output format (supported: json, yaml and human)Default: human"},{"location":"commands_reference/upctl_database/types/#related-commands","title":"Related commands","text":"Command Description upctl database Manage databases"},{"location":"commands_reference/upctl_database/index/","title":"upctl database index","text":"
"},{"location":"commands_reference/upctl_database/index/#options","title":"Options","text":"Option Description --help, -h help for indexDefault: false"},{"location":"commands_reference/upctl_database/index/#global-options","title":"Global options","text":"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. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output, -o Output format (supported: json, yaml and human)Default: human"},{"location":"commands_reference/upctl_database/index/#related-commands","title":"Related commands","text":"Command Description upctl database Manage databases upctl database index delete Delete an index from the specified database. upctl database index list List current indices of the specified databases"},{"location":"commands_reference/upctl_database/index/delete/","title":"upctl database index delete","text":"
Delete an index from the specified database.
upctl database index delete <UUID/Title...> [flags]\n
upctl database index delete 55199a44-4751-4e27-9394-7c7661910be3 --name .index-to-delete\n
"},{"location":"commands_reference/upctl_database/index/delete/#options","title":"Options","text":"Option Description --name Index name --help, -h help for deleteDefault: false"},{"location":"commands_reference/upctl_database/index/delete/#global-options","title":"Global options","text":"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. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output, -o Output format (supported: json, yaml and human)Default: human"},{"location":"commands_reference/upctl_database/index/delete/#related-commands","title":"Related commands","text":"Command Description upctl database index Manage database indices"},{"location":"commands_reference/upctl_database/index/list/","title":"upctl database index list","text":"
List current indices of the specified databases
upctl database index list <UUID/Title...> [flags]\n
upctl database index list 55199a44-4751-4e27-9394-7c7661910be3\n
"},{"location":"commands_reference/upctl_database/index/list/#options","title":"Options","text":"Option Description --help, -h help for listDefault: false"},{"location":"commands_reference/upctl_database/index/list/#global-options","title":"Global options","text":"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. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output, -o Output format (supported: json, yaml and human)Default: human"},{"location":"commands_reference/upctl_database/index/list/#related-commands","title":"Related commands","text":"Command Description upctl database index Manage database indices"},{"location":"commands_reference/upctl_database/properties/","title":"upctl database properties","text":"
"},{"location":"commands_reference/upctl_database/properties/#options","title":"Options","text":"Option Description --help, -h help for propertiesDefault: false"},{"location":"commands_reference/upctl_database/properties/#global-options","title":"Global options","text":"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. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output, -o Output format (supported: json, yaml and human)Default: human"},{"location":"commands_reference/upctl_database/properties/#related-commands","title":"Related commands","text":"Command Description upctl database Manage databases upctl database properties mysql List available properties for MySQL databases upctl database properties opensearch List available properties for OpenSearch databases upctl database properties pg List available properties for PostgreSQL databases upctl database properties redis List available properties for Redis databases"},{"location":"commands_reference/upctl_database/properties/mysql/","title":"upctl database properties mysql","text":"
"},{"location":"commands_reference/upctl_database/properties/mysql/#options","title":"Options","text":"Option Description --help, -h help for mysqlDefault: false"},{"location":"commands_reference/upctl_database/properties/mysql/#global-options","title":"Global options","text":"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. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output, -o Output format (supported: json, yaml and human)Default: human"},{"location":"commands_reference/upctl_database/properties/mysql/#related-commands","title":"Related commands","text":"Command Description upctl database properties List available properties for given database type upctl database properties mysql show Show MySQL database property details"},{"location":"commands_reference/upctl_database/properties/mysql/show/","title":"upctl database properties mysql show","text":"
"},{"location":"commands_reference/upctl_database/properties/mysql/show/#options","title":"Options","text":"Option Description --help, -h help for showDefault: false"},{"location":"commands_reference/upctl_database/properties/mysql/show/#global-options","title":"Global options","text":"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. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output, -o Output format (supported: json, yaml and human)Default: human"},{"location":"commands_reference/upctl_database/properties/mysql/show/#related-commands","title":"Related commands","text":"Command Description upctl database properties mysql List available properties for MySQL databases"},{"location":"commands_reference/upctl_database/properties/opensearch/","title":"upctl database properties opensearch","text":"
List available properties for OpenSearch databases
"},{"location":"commands_reference/upctl_database/properties/opensearch/#options","title":"Options","text":"Option Description --help, -h help for opensearchDefault: false"},{"location":"commands_reference/upctl_database/properties/opensearch/#global-options","title":"Global options","text":"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. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output, -o Output format (supported: json, yaml and human)Default: human"},{"location":"commands_reference/upctl_database/properties/opensearch/#related-commands","title":"Related commands","text":"Command Description upctl database properties List available properties for given database type upctl database properties opensearch show Show OpenSearch database property details"},{"location":"commands_reference/upctl_database/properties/opensearch/show/","title":"upctl database properties opensearch show","text":"
Show OpenSearch database property details
upctl database properties opensearch show [flags]\n
upctl database properties opensearch show version\n
"},{"location":"commands_reference/upctl_database/properties/opensearch/show/#options","title":"Options","text":"Option Description --help, -h help for showDefault: false"},{"location":"commands_reference/upctl_database/properties/opensearch/show/#global-options","title":"Global options","text":"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. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output, -o Output format (supported: json, yaml and human)Default: human"},{"location":"commands_reference/upctl_database/properties/opensearch/show/#related-commands","title":"Related commands","text":"Command Description upctl database properties opensearch List available properties for OpenSearch databases"},{"location":"commands_reference/upctl_database/properties/pg/","title":"upctl database properties pg","text":"
List available properties for PostgreSQL databases
"},{"location":"commands_reference/upctl_database/properties/pg/#options","title":"Options","text":"Option Description --help, -h help for pgDefault: false"},{"location":"commands_reference/upctl_database/properties/pg/#global-options","title":"Global options","text":"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. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output, -o Output format (supported: json, yaml and human)Default: human"},{"location":"commands_reference/upctl_database/properties/pg/#related-commands","title":"Related commands","text":"Command Description upctl database properties List available properties for given database type upctl database properties pg show Show PostgreSQL database property details"},{"location":"commands_reference/upctl_database/properties/pg/show/","title":"upctl database properties pg show","text":"
"},{"location":"commands_reference/upctl_database/properties/pg/show/#options","title":"Options","text":"Option Description --help, -h help for showDefault: false"},{"location":"commands_reference/upctl_database/properties/pg/show/#global-options","title":"Global options","text":"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. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output, -o Output format (supported: json, yaml and human)Default: human"},{"location":"commands_reference/upctl_database/properties/pg/show/#related-commands","title":"Related commands","text":"Command Description upctl database properties pg List available properties for PostgreSQL databases"},{"location":"commands_reference/upctl_database/properties/redis/","title":"upctl database properties redis","text":"
"},{"location":"commands_reference/upctl_database/properties/redis/#options","title":"Options","text":"Option Description --help, -h help for redisDefault: false"},{"location":"commands_reference/upctl_database/properties/redis/#global-options","title":"Global options","text":"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. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output, -o Output format (supported: json, yaml and human)Default: human"},{"location":"commands_reference/upctl_database/properties/redis/#related-commands","title":"Related commands","text":"Command Description upctl database properties List available properties for given database type upctl database properties redis show Show Redis database property details"},{"location":"commands_reference/upctl_database/properties/redis/show/","title":"upctl database properties redis show","text":"
"},{"location":"commands_reference/upctl_database/properties/redis/show/#options","title":"Options","text":"Option Description --help, -h help for showDefault: false"},{"location":"commands_reference/upctl_database/properties/redis/show/#global-options","title":"Global options","text":"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. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output, -o Output format (supported: json, yaml and human)Default: human"},{"location":"commands_reference/upctl_database/properties/redis/show/#related-commands","title":"Related commands","text":"Command Description upctl database properties redis List available properties for Redis databases"},{"location":"commands_reference/upctl_database/session/","title":"upctl database session","text":"
Manage database sessions
upctl database session [flags]\n
"},{"location":"commands_reference/upctl_database/session/#options","title":"Options","text":"Option Description --help, -h help for sessionDefault: false"},{"location":"commands_reference/upctl_database/session/#global-options","title":"Global options","text":"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. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output, -o Output format (supported: json, yaml and human)Default: human"},{"location":"commands_reference/upctl_database/session/#related-commands","title":"Related commands","text":"Command Description upctl database Manage databases upctl database session cancel Terminate client session or cancel running query for a database upctl database session list List current sessions to specified database"},{"location":"commands_reference/upctl_database/session/cancel/","title":"upctl database session cancel","text":"
Terminate client session or cancel running query for a database
"},{"location":"commands_reference/upctl_database/session/cancel/#options","title":"Options","text":"Option Description --pid Process ID of the session to cancel.Default: 0--terminate Request immediate termination instead of soft cancel. --help, -h help for cancelDefault: false"},{"location":"commands_reference/upctl_database/session/cancel/#global-options","title":"Global options","text":"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. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output, -o Output format (supported: json, yaml and human)Default: human"},{"location":"commands_reference/upctl_database/session/cancel/#related-commands","title":"Related commands","text":"Command Description upctl database session Manage database sessions"},{"location":"commands_reference/upctl_database/session/list/","title":"upctl database session list","text":"
List current sessions to specified database
upctl database session list <UUID/Title...> [flags]\n
upctl database session list 0fa980c4-0e4f-460b-9869-11b7bd62b832\nupctl database session list mysql-1 --limit 16 --offset 32 --order pid:desc\n
"},{"location":"commands_reference/upctl_database/session/list/#options","title":"Options","text":"Option Description --limit Number of entries to receive at most.Default: 10--offset Offset for retrieved results based on sort order.Default: 0--order Key and direction for sorting.Default: query_duration:desc--help, -h help for listDefault: false"},{"location":"commands_reference/upctl_database/session/list/#global-options","title":"Global options","text":"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. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output, -o Output format (supported: json, yaml and human)Default: human"},{"location":"commands_reference/upctl_database/session/list/#related-commands","title":"Related commands","text":"Command Description upctl database session Manage database sessions"},{"location":"commands_reference/upctl_gateway/","title":"upctl gateway","text":"
Manage gateways
upctl gateway [flags]\n
"},{"location":"commands_reference/upctl_gateway/#options","title":"Options","text":"Option Description --help, -h help for gatewayDefault: false"},{"location":"commands_reference/upctl_gateway/#global-options","title":"Global options","text":"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. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output, -o Output format (supported: json, yaml and human)Default: human"},{"location":"commands_reference/upctl_gateway/#related-commands","title":"Related commands","text":"Command Description upctl UpCloud command-line interface upctl gateway delete Delete a gateway upctl gateway list List gateways upctl gateway plans List gateway plans"},{"location":"commands_reference/upctl_gateway/delete/","title":"upctl gateway delete","text":"
"},{"location":"commands_reference/upctl_gateway/delete/#options","title":"Options","text":"Option Description --help, -h help for deleteDefault: false"},{"location":"commands_reference/upctl_gateway/delete/#global-options","title":"Global options","text":"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. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output, -o Output format (supported: json, yaml and human)Default: human"},{"location":"commands_reference/upctl_gateway/delete/#related-commands","title":"Related commands","text":"Command Description upctl gateway Manage gateways"},{"location":"commands_reference/upctl_gateway/list/","title":"upctl gateway list","text":"
"},{"location":"commands_reference/upctl_gateway/list/#options","title":"Options","text":"Option Description --limit Number of entries to receive at most.Default: 100--page Page number to calculate first item to receive. Page numbers start from 1.Default: 0--help, -h help for listDefault: false"},{"location":"commands_reference/upctl_gateway/list/#global-options","title":"Global options","text":"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. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output, -o Output format (supported: json, yaml and human)Default: human"},{"location":"commands_reference/upctl_gateway/list/#related-commands","title":"Related commands","text":"Command Description upctl gateway Manage gateways"},{"location":"commands_reference/upctl_gateway/plans/","title":"upctl gateway plans","text":"
"},{"location":"commands_reference/upctl_gateway/plans/#options","title":"Options","text":"Option Description --help, -h help for plansDefault: false"},{"location":"commands_reference/upctl_gateway/plans/#global-options","title":"Global options","text":"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. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output, -o Output format (supported: json, yaml and human)Default: human"},{"location":"commands_reference/upctl_gateway/plans/#related-commands","title":"Related commands","text":"Command Description upctl gateway Manage gateways"},{"location":"commands_reference/upctl_host/","title":"upctl host","text":"
Manage private cloud hosts
upctl host [flags]\n
"},{"location":"commands_reference/upctl_host/#options","title":"Options","text":"Option Description --help, -h help for hostDefault: false"},{"location":"commands_reference/upctl_host/#global-options","title":"Global options","text":"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. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output, -o Output format (supported: json, yaml and human)Default: human"},{"location":"commands_reference/upctl_host/#related-commands","title":"Related commands","text":"Command Description upctl UpCloud command-line interface upctl host list List private cloud hosts"},{"location":"commands_reference/upctl_host/list/","title":"upctl host list","text":"
"},{"location":"commands_reference/upctl_host/list/#options","title":"Options","text":"Option Description --help, -h help for listDefault: false"},{"location":"commands_reference/upctl_host/list/#global-options","title":"Global options","text":"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. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output, -o Output format (supported: json, yaml and human)Default: human"},{"location":"commands_reference/upctl_host/list/#related-commands","title":"Related commands","text":"Command Description upctl host Manage private cloud hosts"},{"location":"commands_reference/upctl_ip-address/","title":"upctl ip-address","text":"
"},{"location":"commands_reference/upctl_ip-address/#options","title":"Options","text":"Option Description --help, -h help for ip-addressDefault: false"},{"location":"commands_reference/upctl_ip-address/#global-options","title":"Global options","text":"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. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output, -o Output format (supported: json, yaml and human)Default: human"},{"location":"commands_reference/upctl_ip-address/#related-commands","title":"Related commands","text":"Command Description upctl UpCloud command-line interface upctl ip-address assign Assign or create an IP address upctl ip-address list List IP addresses upctl ip-address modify Modify an IP address upctl ip-address remove Remove an IP address upctl ip-address show Show current IP address"},{"location":"commands_reference/upctl_ip-address/assign/","title":"upctl ip-address assign","text":"
"},{"location":"commands_reference/upctl_ip-address/assign/#options","title":"Options","text":"Option Description --access Is address for utility or public network.Default: public--family The address family of new IP address.Default: IPv4--server The server the ip address is assigned to. --mac MAC address of server interface to assign address to. Required for detached floating IP address if zone is not specified. --zone Zone where to create the IP address. Run upctl zone list to list all available zones. Required when creating a detached floating IP address, i.e. when MAC address is not specified. --floating Whether the address to be assigned is a floating one. --help, -h help for assignDefault: false"},{"location":"commands_reference/upctl_ip-address/assign/#global-options","title":"Global options","text":"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. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output, -o Output format (supported: json, yaml and human)Default: human"},{"location":"commands_reference/upctl_ip-address/assign/#related-commands","title":"Related commands","text":"Command Description upctl ip-address Manage IP addresses"},{"location":"commands_reference/upctl_ip-address/list/","title":"upctl ip-address list","text":"
"},{"location":"commands_reference/upctl_ip-address/list/#options","title":"Options","text":"Option Description --help, -h help for listDefault: false"},{"location":"commands_reference/upctl_ip-address/list/#global-options","title":"Global options","text":"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. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output, -o Output format (supported: json, yaml and human)Default: human"},{"location":"commands_reference/upctl_ip-address/list/#related-commands","title":"Related commands","text":"Command Description upctl ip-address Manage IP addresses"},{"location":"commands_reference/upctl_ip-address/modify/","title":"upctl ip-address modify","text":"
"},{"location":"commands_reference/upctl_ip-address/modify/#options","title":"Options","text":"Option Description --mac MAC address of server interface to attach floating IP to. --ptr-record New fully qualified domain name to set as the PTR record for the IP address. --help, -h help for modifyDefault: false"},{"location":"commands_reference/upctl_ip-address/modify/#global-options","title":"Global options","text":"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. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output, -o Output format (supported: json, yaml and human)Default: human"},{"location":"commands_reference/upctl_ip-address/modify/#related-commands","title":"Related commands","text":"Command Description upctl ip-address Manage IP addresses"},{"location":"commands_reference/upctl_ip-address/remove/","title":"upctl ip-address remove","text":"
"},{"location":"commands_reference/upctl_ip-address/remove/#options","title":"Options","text":"Option Description --help, -h help for removeDefault: false"},{"location":"commands_reference/upctl_ip-address/remove/#global-options","title":"Global options","text":"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. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output, -o Output format (supported: json, yaml and human)Default: human"},{"location":"commands_reference/upctl_ip-address/remove/#related-commands","title":"Related commands","text":"Command Description upctl ip-address Manage IP addresses"},{"location":"commands_reference/upctl_ip-address/show/","title":"upctl ip-address show","text":"
Show current IP address
upctl ip-address show <Address/PTRRecord...> [flags]\n
upctl ip-address show 185.70.196.47\nupctl ip-address show 2a04:3544:8000:1000:d40e:4aff:fe6f:5d34\n
"},{"location":"commands_reference/upctl_ip-address/show/#options","title":"Options","text":"Option Description --help, -h help for showDefault: false"},{"location":"commands_reference/upctl_ip-address/show/#global-options","title":"Global options","text":"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. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output, -o Output format (supported: json, yaml and human)Default: human"},{"location":"commands_reference/upctl_ip-address/show/#related-commands","title":"Related commands","text":"Command Description upctl ip-address Manage IP addresses"},{"location":"commands_reference/upctl_kubernetes/","title":"upctl kubernetes","text":"
"},{"location":"commands_reference/upctl_kubernetes/#options","title":"Options","text":"Option Description --help, -h help for kubernetesDefault: false"},{"location":"commands_reference/upctl_kubernetes/#global-options","title":"Global options","text":"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. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output, -o Output format (supported: json, yaml and human)Default: human"},{"location":"commands_reference/upctl_kubernetes/#related-commands","title":"Related commands","text":"Command Description upctl UpCloud command-line interface upctl kubernetes config Output Kubernetes cluster kubeconfig upctl kubernetes create Create a Kubernetes cluster upctl kubernetes delete Delete a Kubernetes cluster upctl kubernetes list List current Kubernetes clusters upctl kubernetes modify Modify an existing cluster upctl kubernetes nodegroup Manage cluster node-groups upctl kubernetes plans List available cluster plans upctl kubernetes show Show Kubernetes cluster details upctl kubernetes versions List available versions for Kubernetes clusters"},{"location":"commands_reference/upctl_kubernetes/config/","title":"upctl kubernetes config","text":"
"},{"location":"commands_reference/upctl_kubernetes/config/#options","title":"Options","text":"Option Description --write Absolute path for writing output. If the file exists, the config will be merged. --help, -h help for configDefault: false"},{"location":"commands_reference/upctl_kubernetes/config/#global-options","title":"Global options","text":"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. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output, -o Output format (supported: json, yaml and human)Default: human"},{"location":"commands_reference/upctl_kubernetes/config/#related-commands","title":"Related commands","text":"Command Description upctl kubernetes Manage Kubernetes clusters"},{"location":"commands_reference/upctl_kubernetes/create/","title":"upctl kubernetes create","text":"
"},{"location":"commands_reference/upctl_kubernetes/create/#options","title":"Options","text":"Option Description --name Kubernetes cluster name. --label Labels to describe the cluster in key=value format, multiple can be declared.Default: []--plan Plan to use for the cluster. Run upctl kubernetes plans to list all available plans.Default: development--version Identifier of the version of Kubernetes to use when creating the cluster. Run upctl kubernetes versions to list all available versions. --network Network to use. The value should be name or UUID of a private network. --node-group Node group(s) for running workloads, multiple can be declared.Usage: --node-group count=8,kubelet-arg=\"log-flush-frequency=5s\",label=\"owner=devteam\",label=\"env=dev\",name=my-node-group,plan=2xCPU-4GB,ssh-key=\"ssh-ed25519 AAAAo admin@user.com\",ssh-key=\"/path/to/your/public/ssh/key.pub\",storage=01000000-0000-4000-8000-000160010100,taint=\"env=dev:NoSchedule\",taint=\"env=dev2:NoSchedule\"Default: []--kubernetes-api-allow-ip Allow cluster's Kubernetes API to be accessed from an IP address or a network CIDR, multiple can be declared.Default: []--private-node-groups Do not assign public IPs to worker nodes. If set, the attached network should have a NAT gateway configured to provide internet access to the worker nodes. --zone Zone where to create the cluster. Run upctl zone list to list all available zones. --wait Wait for cluster to be in running state before returning. --help, -h help for createDefault: false"},{"location":"commands_reference/upctl_kubernetes/create/#global-options","title":"Global options","text":"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. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output, -o Output format (supported: json, yaml and human)Default: human"},{"location":"commands_reference/upctl_kubernetes/create/#related-commands","title":"Related commands","text":"Command Description upctl kubernetes Manage Kubernetes clusters"},{"location":"commands_reference/upctl_kubernetes/delete/","title":"upctl kubernetes delete","text":"
"},{"location":"commands_reference/upctl_kubernetes/delete/#options","title":"Options","text":"Option Description --help, -h help for deleteDefault: false"},{"location":"commands_reference/upctl_kubernetes/delete/#global-options","title":"Global options","text":"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. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output, -o Output format (supported: json, yaml and human)Default: human"},{"location":"commands_reference/upctl_kubernetes/delete/#related-commands","title":"Related commands","text":"Command Description upctl kubernetes Manage Kubernetes clusters"},{"location":"commands_reference/upctl_kubernetes/list/","title":"upctl kubernetes list","text":"
"},{"location":"commands_reference/upctl_kubernetes/list/#options","title":"Options","text":"Option Description --help, -h help for listDefault: false"},{"location":"commands_reference/upctl_kubernetes/list/#global-options","title":"Global options","text":"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. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output, -o Output format (supported: json, yaml and human)Default: human"},{"location":"commands_reference/upctl_kubernetes/list/#related-commands","title":"Related commands","text":"Command Description upctl kubernetes Manage Kubernetes clusters"},{"location":"commands_reference/upctl_kubernetes/modify/","title":"upctl kubernetes modify","text":"
"},{"location":"commands_reference/upctl_kubernetes/modify/#options","title":"Options","text":"Option Description --kubernetes-api-allow-ip Allow cluster's Kubernetes API to be accessed from an IP address or a network CIDR, multiple can be declared.Default: []--label Labels to describe the cluster in key=value format, multiple can be declared.Default: []--clear-labels Clear all labels from to given cluster. --help, -h help for modifyDefault: false"},{"location":"commands_reference/upctl_kubernetes/modify/#global-options","title":"Global options","text":"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. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output, -o Output format (supported: json, yaml and human)Default: human"},{"location":"commands_reference/upctl_kubernetes/modify/#related-commands","title":"Related commands","text":"Command Description upctl kubernetes Manage Kubernetes clusters"},{"location":"commands_reference/upctl_kubernetes/plans/","title":"upctl kubernetes plans","text":"
"},{"location":"commands_reference/upctl_kubernetes/plans/#options","title":"Options","text":"Option Description --help, -h help for plansDefault: false"},{"location":"commands_reference/upctl_kubernetes/plans/#global-options","title":"Global options","text":"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. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output, -o Output format (supported: json, yaml and human)Default: human"},{"location":"commands_reference/upctl_kubernetes/plans/#related-commands","title":"Related commands","text":"Command Description upctl kubernetes Manage Kubernetes clusters"},{"location":"commands_reference/upctl_kubernetes/show/","title":"upctl kubernetes show","text":"
upctl kubernetes show 55199a44-4751-4e27-9394-7c7661910be3\nupctl kubernetes show my-cluster\n
"},{"location":"commands_reference/upctl_kubernetes/show/#options","title":"Options","text":"Option Description --help, -h help for showDefault: false"},{"location":"commands_reference/upctl_kubernetes/show/#global-options","title":"Global options","text":"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. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output, -o Output format (supported: json, yaml and human)Default: human"},{"location":"commands_reference/upctl_kubernetes/show/#related-commands","title":"Related commands","text":"Command Description upctl kubernetes Manage Kubernetes clusters"},{"location":"commands_reference/upctl_kubernetes/versions/","title":"upctl kubernetes versions","text":"
"},{"location":"commands_reference/upctl_kubernetes/versions/#options","title":"Options","text":"Option Description --help, -h help for versionsDefault: false"},{"location":"commands_reference/upctl_kubernetes/versions/#global-options","title":"Global options","text":"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. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output, -o Output format (supported: json, yaml and human)Default: human"},{"location":"commands_reference/upctl_kubernetes/versions/#related-commands","title":"Related commands","text":"Command Description upctl kubernetes Manage Kubernetes clusters"},{"location":"commands_reference/upctl_kubernetes/nodegroup/","title":"upctl kubernetes nodegroup","text":"
"},{"location":"commands_reference/upctl_kubernetes/nodegroup/#options","title":"Options","text":"Option Description --help, -h help for nodegroupDefault: false"},{"location":"commands_reference/upctl_kubernetes/nodegroup/#global-options","title":"Global options","text":"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. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output, -o Output format (supported: json, yaml and human)Default: human"},{"location":"commands_reference/upctl_kubernetes/nodegroup/#related-commands","title":"Related commands","text":"Command Description upctl kubernetes Manage Kubernetes clusters upctl kubernetes nodegroup create Create a new node group into the specified cluster. upctl kubernetes nodegroup delete Delete the node group from the cluster. upctl kubernetes nodegroup scale Scale the number of nodes in the node group. upctl kubernetes nodegroup show Show node group details"},{"location":"commands_reference/upctl_kubernetes/nodegroup/create/","title":"upctl kubernetes nodegroup create","text":"
Create a new node group into the specified cluster.
"},{"location":"commands_reference/upctl_kubernetes/nodegroup/create/#options","title":"Options","text":"Option Description --count Number of nodes in the node groupDefault: 0--kubelet-arg Arguments to use when executing kubelet in argument=value formatDefault: []--label Labels to describe the nodes in key=value format. Use multiple times to define multiple labels. Labels are forwarded to the kubernetes nodes.Default: []--name Node group name --plan Server plan to use for nodes in the node group. Run upctl server plans to list all available plans. --ssh-key SSH keys to be configured as authorized keys to the nodes.Default: []--storage Storage template to use when creating the nodes. Defaults to UpCloud K8s public template. --taint Taints to be configured to the nodes in key=value:effect formatDefault: []--disable-utility-network-access Disable utility network access. If disabled, nodes in this group will not have access to utility network. --help, -h help for createDefault: false"},{"location":"commands_reference/upctl_kubernetes/nodegroup/create/#global-options","title":"Global options","text":"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. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output, -o Output format (supported: json, yaml and human)Default: human"},{"location":"commands_reference/upctl_kubernetes/nodegroup/create/#related-commands","title":"Related commands","text":"Command Description upctl kubernetes nodegroup Manage cluster node-groups"},{"location":"commands_reference/upctl_kubernetes/nodegroup/delete/","title":"upctl kubernetes nodegroup delete","text":"
"},{"location":"commands_reference/upctl_kubernetes/nodegroup/delete/#options","title":"Options","text":"Option Description --name Node group name --help, -h help for deleteDefault: false"},{"location":"commands_reference/upctl_kubernetes/nodegroup/delete/#global-options","title":"Global options","text":"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. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output, -o Output format (supported: json, yaml and human)Default: human"},{"location":"commands_reference/upctl_kubernetes/nodegroup/delete/#related-commands","title":"Related commands","text":"Command Description upctl kubernetes nodegroup Manage cluster node-groups"},{"location":"commands_reference/upctl_kubernetes/nodegroup/scale/","title":"upctl kubernetes nodegroup scale","text":"
"},{"location":"commands_reference/upctl_kubernetes/nodegroup/scale/#options","title":"Options","text":"Option Description --name Node group name --count Node countDefault: 0--help, -h help for scaleDefault: false"},{"location":"commands_reference/upctl_kubernetes/nodegroup/scale/#global-options","title":"Global options","text":"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. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output, -o Output format (supported: json, yaml and human)Default: human"},{"location":"commands_reference/upctl_kubernetes/nodegroup/scale/#related-commands","title":"Related commands","text":"Command Description upctl kubernetes nodegroup Manage cluster node-groups"},{"location":"commands_reference/upctl_kubernetes/nodegroup/show/","title":"upctl kubernetes nodegroup show","text":"
Show node group details
upctl kubernetes nodegroup show <UUID/Name...> [flags]\n
upctl kubernetes nodegroup show 55199a44-4751-4e27-9394-7c7661910be3 --name default\n
"},{"location":"commands_reference/upctl_kubernetes/nodegroup/show/#options","title":"Options","text":"Option Description --name Node group name --help, -h help for showDefault: false"},{"location":"commands_reference/upctl_kubernetes/nodegroup/show/#global-options","title":"Global options","text":"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. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output, -o Output format (supported: json, yaml and human)Default: human"},{"location":"commands_reference/upctl_kubernetes/nodegroup/show/#related-commands","title":"Related commands","text":"Command Description upctl kubernetes nodegroup Manage cluster node-groups"},{"location":"commands_reference/upctl_loadbalancer/","title":"upctl loadbalancer","text":"
"},{"location":"commands_reference/upctl_loadbalancer/#options","title":"Options","text":"Option Description --help, -h help for loadbalancerDefault: false"},{"location":"commands_reference/upctl_loadbalancer/#global-options","title":"Global options","text":"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. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output, -o Output format (supported: json, yaml and human)Default: human"},{"location":"commands_reference/upctl_loadbalancer/#related-commands","title":"Related commands","text":"Command Description upctl UpCloud command-line interface upctl loadbalancer delete Delete a load balancer upctl loadbalancer list List current load balancers upctl loadbalancer plans List available load balancer plans upctl loadbalancer show Show load balancer details"},{"location":"commands_reference/upctl_loadbalancer/delete/","title":"upctl loadbalancer delete","text":"
"},{"location":"commands_reference/upctl_loadbalancer/delete/#options","title":"Options","text":"Option Description --help, -h help for deleteDefault: false"},{"location":"commands_reference/upctl_loadbalancer/delete/#global-options","title":"Global options","text":"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. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output, -o Output format (supported: json, yaml and human)Default: human"},{"location":"commands_reference/upctl_loadbalancer/delete/#related-commands","title":"Related commands","text":"Command Description upctl loadbalancer Manage load balancers"},{"location":"commands_reference/upctl_loadbalancer/list/","title":"upctl loadbalancer list","text":"
"},{"location":"commands_reference/upctl_loadbalancer/list/#options","title":"Options","text":"Option Description --limit Number of entries to receive at most.Default: 100--page Page number to calculate first item to receive. Page numbers start from 1.Default: 0--help, -h help for listDefault: false"},{"location":"commands_reference/upctl_loadbalancer/list/#global-options","title":"Global options","text":"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. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output, -o Output format (supported: json, yaml and human)Default: human"},{"location":"commands_reference/upctl_loadbalancer/list/#related-commands","title":"Related commands","text":"Command Description upctl loadbalancer Manage load balancers"},{"location":"commands_reference/upctl_loadbalancer/plans/","title":"upctl loadbalancer plans","text":"
"},{"location":"commands_reference/upctl_loadbalancer/plans/#options","title":"Options","text":"Option Description --help, -h help for plansDefault: false"},{"location":"commands_reference/upctl_loadbalancer/plans/#global-options","title":"Global options","text":"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. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output, -o Output format (supported: json, yaml and human)Default: human"},{"location":"commands_reference/upctl_loadbalancer/plans/#related-commands","title":"Related commands","text":"Command Description upctl loadbalancer Manage load balancers"},{"location":"commands_reference/upctl_loadbalancer/show/","title":"upctl loadbalancer show","text":"
upctl loadbalancer show 55199a44-4751-4e27-9394-7c7661910be3\nupctl loadbalancer show my-load-balancer\n
"},{"location":"commands_reference/upctl_loadbalancer/show/#options","title":"Options","text":"Option Description --help, -h help for showDefault: false"},{"location":"commands_reference/upctl_loadbalancer/show/#global-options","title":"Global options","text":"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. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output, -o Output format (supported: json, yaml and human)Default: human"},{"location":"commands_reference/upctl_loadbalancer/show/#related-commands","title":"Related commands","text":"Command Description upctl loadbalancer Manage load balancers"},{"location":"commands_reference/upctl_network/","title":"upctl network","text":"
"},{"location":"commands_reference/upctl_network/#options","title":"Options","text":"Option Description --help, -h help for networkDefault: false"},{"location":"commands_reference/upctl_network/#global-options","title":"Global options","text":"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. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output, -o Output format (supported: json, yaml and human)Default: human"},{"location":"commands_reference/upctl_network/#related-commands","title":"Related commands","text":"Command Description upctl UpCloud command-line interface upctl network create Create a network upctl network delete Delete a network upctl network list List networks, by default private networks only upctl network modify Modify a network upctl network show Show network details"},{"location":"commands_reference/upctl_network/create/","title":"upctl network create","text":"
"},{"location":"commands_reference/upctl_network/create/#options","title":"Options","text":"Option Description --name Names the network. --zone Zone where to create the network. Run upctl zone list to list all available zones. --router Add this network to an existing router. --ip-network A network interface for the server, multiple can be declared. Fields: address: string family: string gateway: string dhcp: true/false dhcp-default-route: true/false dhcp-dns: array of stringsDefault: []--help, -h help for createDefault: false"},{"location":"commands_reference/upctl_network/create/#global-options","title":"Global options","text":"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. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output, -o Output format (supported: json, yaml and human)Default: human"},{"location":"commands_reference/upctl_network/create/#related-commands","title":"Related commands","text":"Command Description upctl network Manage networks"},{"location":"commands_reference/upctl_network/delete/","title":"upctl network delete","text":"
"},{"location":"commands_reference/upctl_network/delete/#options","title":"Options","text":"Option Description --help, -h help for deleteDefault: false"},{"location":"commands_reference/upctl_network/delete/#global-options","title":"Global options","text":"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. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output, -o Output format (supported: json, yaml and human)Default: human"},{"location":"commands_reference/upctl_network/delete/#related-commands","title":"Related commands","text":"Command Description upctl network Manage networks"},{"location":"commands_reference/upctl_network/list/","title":"upctl network list","text":"
upctl network list\nupctl network list --zone pl-waw1\nupctl network list --zone pl-waw1 --public\nupctl network list --all\nupctl network list --zone pl-waw1 --all\n
"},{"location":"commands_reference/upctl_network/list/#options","title":"Options","text":"Option Description --zone Show networks from a specific zone. --all Show all networks. --public Show public networks instead of private networks. --utility Show utility networks instead of private networks. --help, -h help for listDefault: false"},{"location":"commands_reference/upctl_network/list/#global-options","title":"Global options","text":"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. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output, -o Output format (supported: json, yaml and human)Default: human"},{"location":"commands_reference/upctl_network/list/#related-commands","title":"Related commands","text":"Command Description upctl network Manage networks"},{"location":"commands_reference/upctl_network/modify/","title":"upctl network modify","text":"
"},{"location":"commands_reference/upctl_network/modify/#options","title":"Options","text":"Option Description --name Set name of the private network. --router Attach a router to this network, specified by router UUID or router name. --detach-router Detach a router from this network. --ip-network The ip network with modified values. Fields family: string gateway: string dhcp: true/false dhcp-default-route: true/false dhcp-dns: array of stringsDefault: []--help, -h help for modifyDefault: false"},{"location":"commands_reference/upctl_network/modify/#global-options","title":"Global options","text":"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. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output, -o Output format (supported: json, yaml and human)Default: human"},{"location":"commands_reference/upctl_network/modify/#related-commands","title":"Related commands","text":"Command Description upctl network Manage networks"},{"location":"commands_reference/upctl_network/show/","title":"upctl network show","text":"
upctl network show 037a530b-533e-4cef-b6ad-6af8094bb2bc\nupctl network show 037a530b-533e-4cef-b6ad-6af8094bb2bc 0311480d-d0c0-4951-ab41-bf12097f5d3c\nupctl network show \"My Network\"\n
"},{"location":"commands_reference/upctl_network/show/#options","title":"Options","text":"Option Description --help, -h help for showDefault: false"},{"location":"commands_reference/upctl_network/show/#global-options","title":"Global options","text":"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. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output, -o Output format (supported: json, yaml and human)Default: human"},{"location":"commands_reference/upctl_network/show/#related-commands","title":"Related commands","text":"Command Description upctl network Manage networks"},{"location":"commands_reference/upctl_networkpeering/","title":"upctl networkpeering","text":"
Manage network peerings
upctl networkpeering [flags]\n
"},{"location":"commands_reference/upctl_networkpeering/#options","title":"Options","text":"Option Description --help, -h help for networkpeeringDefault: false"},{"location":"commands_reference/upctl_networkpeering/#global-options","title":"Global options","text":"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. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output, -o Output format (supported: json, yaml and human)Default: human"},{"location":"commands_reference/upctl_networkpeering/#related-commands","title":"Related commands","text":"Command Description upctl UpCloud command-line interface upctl networkpeering delete Delete a network peering upctl networkpeering disable Disable a network peering upctl networkpeering list List network peerings"},{"location":"commands_reference/upctl_networkpeering/delete/","title":"upctl networkpeering delete","text":"
"},{"location":"commands_reference/upctl_networkpeering/delete/#options","title":"Options","text":"Option Description --help, -h help for deleteDefault: false"},{"location":"commands_reference/upctl_networkpeering/delete/#global-options","title":"Global options","text":"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. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output, -o Output format (supported: json, yaml and human)Default: human"},{"location":"commands_reference/upctl_networkpeering/delete/#related-commands","title":"Related commands","text":"Command Description upctl networkpeering Manage network peerings"},{"location":"commands_reference/upctl_networkpeering/disable/","title":"upctl networkpeering disable","text":"
"},{"location":"commands_reference/upctl_networkpeering/disable/#options","title":"Options","text":"Option Description --wait Wait for network peering to be in disabled state before returning. --help, -h help for disableDefault: false"},{"location":"commands_reference/upctl_networkpeering/disable/#global-options","title":"Global options","text":"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. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output, -o Output format (supported: json, yaml and human)Default: human"},{"location":"commands_reference/upctl_networkpeering/disable/#related-commands","title":"Related commands","text":"Command Description upctl networkpeering Manage network peerings"},{"location":"commands_reference/upctl_networkpeering/list/","title":"upctl networkpeering list","text":"
"},{"location":"commands_reference/upctl_networkpeering/list/#options","title":"Options","text":"Option Description --help, -h help for listDefault: false"},{"location":"commands_reference/upctl_networkpeering/list/#global-options","title":"Global options","text":"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. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output, -o Output format (supported: json, yaml and human)Default: human"},{"location":"commands_reference/upctl_networkpeering/list/#related-commands","title":"Related commands","text":"Command Description upctl networkpeering Manage network peerings"},{"location":"commands_reference/upctl_objectstorage/","title":"upctl objectstorage","text":"
"},{"location":"commands_reference/upctl_objectstorage/#options","title":"Options","text":"Option Description --help, -h help for objectstorageDefault: false"},{"location":"commands_reference/upctl_objectstorage/#global-options","title":"Global options","text":"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. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output, -o Output format (supported: json, yaml and human)Default: human"},{"location":"commands_reference/upctl_objectstorage/#related-commands","title":"Related commands","text":"Command Description upctl UpCloud command-line interface upctl objectstorage delete Delete a Managed object storage service upctl objectstorage list List current Managed object storage services upctl objectstorage regions List objectstorage regions upctl objectstorage show Show Managed object storage service details"},{"location":"commands_reference/upctl_objectstorage/delete/","title":"upctl objectstorage delete","text":"
"},{"location":"commands_reference/upctl_objectstorage/delete/#options","title":"Options","text":"Option Description --delete-users Delete all users from the service before deleting the object storage instance. --delete-policies Delete all policies from the service before deleting the object storage instance. --delete-buckets Delete all buckets from the service before deleting the object storage instance. --help, -h help for deleteDefault: false"},{"location":"commands_reference/upctl_objectstorage/delete/#global-options","title":"Global options","text":"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. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output, -o Output format (supported: json, yaml and human)Default: human"},{"location":"commands_reference/upctl_objectstorage/delete/#related-commands","title":"Related commands","text":"Command Description upctl objectstorage Manage managed object storage services"},{"location":"commands_reference/upctl_objectstorage/list/","title":"upctl objectstorage list","text":"
"},{"location":"commands_reference/upctl_objectstorage/list/#options","title":"Options","text":"Option Description --limit Number of entries to receive at most.Default: 100--page Page number to calculate first item to receive. Page numbers start from 1.Default: 0--help, -h help for listDefault: false"},{"location":"commands_reference/upctl_objectstorage/list/#global-options","title":"Global options","text":"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. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output, -o Output format (supported: json, yaml and human)Default: human"},{"location":"commands_reference/upctl_objectstorage/list/#related-commands","title":"Related commands","text":"Command Description upctl objectstorage Manage managed object storage services"},{"location":"commands_reference/upctl_objectstorage/regions/","title":"upctl objectstorage regions","text":"
upctl objectstorage show 55199a44-4751-4e27-9394-7c7661910be8\n
"},{"location":"commands_reference/upctl_objectstorage/show/#options","title":"Options","text":"Option Description --help, -h help for showDefault: false"},{"location":"commands_reference/upctl_objectstorage/show/#global-options","title":"Global options","text":"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. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output, -o Output format (supported: json, yaml and human)Default: human"},{"location":"commands_reference/upctl_objectstorage/show/#related-commands","title":"Related commands","text":"Command Description upctl objectstorage Manage managed object storage services"},{"location":"commands_reference/upctl_partner/","title":"upctl partner","text":"
Manage partner resources
upctl partner [flags]\n
"},{"location":"commands_reference/upctl_partner/#options","title":"Options","text":"Option Description --help, -h help for partnerDefault: false"},{"location":"commands_reference/upctl_partner/#global-options","title":"Global options","text":"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. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output, -o Output format (supported: json, yaml and human)Default: human"},{"location":"commands_reference/upctl_partner/#related-commands","title":"Related commands","text":"Command Description upctl UpCloud command-line interface upctl partner account Manage accounts associated with partner"},{"location":"commands_reference/upctl_partner/account/","title":"upctl partner account","text":"
Manage accounts associated with partner
upctl partner account [flags]\n
"},{"location":"commands_reference/upctl_partner/account/#options","title":"Options","text":"Option Description --help, -h help for accountDefault: false"},{"location":"commands_reference/upctl_partner/account/#global-options","title":"Global options","text":"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. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output, -o Output format (supported: json, yaml and human)Default: human"},{"location":"commands_reference/upctl_partner/account/#related-commands","title":"Related commands","text":"Command Description upctl partner Manage partner resources upctl partner account create Create a new account that will be linked to partner's existing invoicing upctl partner account list List accounts associated with partner"},{"location":"commands_reference/upctl_partner/account/create/","title":"upctl partner account create","text":"
Create a new account that will be linked to partner's existing invoicing
upctl partner account create --username newuser --password superSecret123\nupctl partner account create --username newuser --password superSecret123 --first-name New --last-name User --company \"Example Ltd\" --country FIN --phone +358.91111111 --email new.user@gmail.com\n
"},{"location":"commands_reference/upctl_partner/account/create/#options","title":"Options","text":"Option Description --username Account username. --password Account pasword. --first-name Contact first name. Required when other contact details are given. --last-name Contact last name. Required when other contact details are given. --company Contact company name. --address Contact street address. --postal-code Contact postal/zip code. --city Contact city. --state Contact state. Required when other contact details are given and country is 'USA'. --country Contact ISO 3166-1 three character country code. Required when other contact details are given. --phone Contact phone number in international format, country code and national part separated by a period. Required when other contact details are given. --email Contact email address. Required when other contact details are given. --vat-number Contact VAT number. --help, -h help for createDefault: false"},{"location":"commands_reference/upctl_partner/account/create/#global-options","title":"Global options","text":"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. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output, -o Output format (supported: json, yaml and human)Default: human"},{"location":"commands_reference/upctl_partner/account/create/#related-commands","title":"Related commands","text":"Command Description upctl partner account Manage accounts associated with partner"},{"location":"commands_reference/upctl_partner/account/list/","title":"upctl partner account list","text":"
"},{"location":"commands_reference/upctl_partner/account/list/#options","title":"Options","text":"Option Description --help, -h help for listDefault: false"},{"location":"commands_reference/upctl_partner/account/list/#global-options","title":"Global options","text":"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. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output, -o Output format (supported: json, yaml and human)Default: human"},{"location":"commands_reference/upctl_partner/account/list/#related-commands","title":"Related commands","text":"Command Description upctl partner account Manage accounts associated with partner"},{"location":"commands_reference/upctl_router/","title":"upctl router","text":"
Manage routers
upctl router [flags]\n
"},{"location":"commands_reference/upctl_router/#options","title":"Options","text":"Option Description --help, -h help for routerDefault: false"},{"location":"commands_reference/upctl_router/#global-options","title":"Global options","text":"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. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output, -o Output format (supported: json, yaml and human)Default: human"},{"location":"commands_reference/upctl_router/#related-commands","title":"Related commands","text":"Command Description upctl UpCloud command-line interface upctl router create Create a router upctl router delete Delete a router upctl router list List routers upctl router modify Modify a router upctl router show Show current router"},{"location":"commands_reference/upctl_router/create/","title":"upctl router create","text":"
"},{"location":"commands_reference/upctl_router/delete/#options","title":"Options","text":"Option Description --help, -h help for deleteDefault: false"},{"location":"commands_reference/upctl_router/delete/#global-options","title":"Global options","text":"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. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output, -o Output format (supported: json, yaml and human)Default: human"},{"location":"commands_reference/upctl_router/delete/#related-commands","title":"Related commands","text":"Command Description upctl router Manage routers"},{"location":"commands_reference/upctl_router/list/","title":"upctl router list","text":"
"},{"location":"commands_reference/upctl_router/list/#options","title":"Options","text":"Option Description --all Show all routers. --normal Show normal routers. --service Show service routers. --help, -h help for listDefault: false"},{"location":"commands_reference/upctl_router/list/#global-options","title":"Global options","text":"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. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output, -o Output format (supported: json, yaml and human)Default: human"},{"location":"commands_reference/upctl_router/list/#related-commands","title":"Related commands","text":"Command Description upctl router Manage routers"},{"location":"commands_reference/upctl_router/modify/","title":"upctl router modify","text":"
"},{"location":"commands_reference/upctl_router/modify/#options","title":"Options","text":"Option Description --name New router name. --help, -h help for modifyDefault: false"},{"location":"commands_reference/upctl_router/modify/#global-options","title":"Global options","text":"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. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output, -o Output format (supported: json, yaml and human)Default: human"},{"location":"commands_reference/upctl_router/modify/#related-commands","title":"Related commands","text":"Command Description upctl router Manage routers"},{"location":"commands_reference/upctl_router/show/","title":"upctl router show","text":"
upctl router show 04d0a7f6-ee78-42b5-8077-6947f9e67c5a\nupctl router show 04d0a7f6-ee78-42b5-8077-6947f9e67c5a 04d031ab-4b85-4cbc-9f0e-6a2977541327\nupctl router show \"My Turbo Router\" my_super_router\n
"},{"location":"commands_reference/upctl_router/show/#options","title":"Options","text":"Option Description --help, -h help for showDefault: false"},{"location":"commands_reference/upctl_router/show/#global-options","title":"Global options","text":"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. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output, -o Output format (supported: json, yaml and human)Default: human"},{"location":"commands_reference/upctl_router/show/#related-commands","title":"Related commands","text":"Command Description upctl router Manage routers"},{"location":"commands_reference/upctl_server/","title":"upctl server","text":"
Manage servers
upctl server [flags]\n
"},{"location":"commands_reference/upctl_server/#options","title":"Options","text":"Option Description --help, -h help for serverDefault: false"},{"location":"commands_reference/upctl_server/#global-options","title":"Global options","text":"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. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output, -o Output format (supported: json, yaml and human)Default: human"},{"location":"commands_reference/upctl_server/#related-commands","title":"Related commands","text":"Command Description upctl UpCloud command-line interface upctl server create Create a new server upctl server delete Delete a server upctl server eject Eject a CD-ROM from the server upctl server firewall Manage server firewall rules. Enabling or disabling the firewall is done in server modify. upctl server list List current servers upctl server load Load a CD-ROM into the server upctl server modify Modifies the configuration of an existing server upctl server network-interface Manage network interface upctl server plans List server plans upctl server restart Restart a server upctl server show Show server details upctl server start Start a server upctl server stop Stop a server upctl server storage Manage server storages"},{"location":"commands_reference/upctl_server/create/","title":"upctl server create","text":"
Create a new server
Note that the default template, Ubuntu Server 24.04 LTS (Noble Numbat), only supports SSH key based authentication. Use --ssh-keys option to provide the keys when creating a server with the default template. The examples below use public key from the ~/.ssh directory. If you want to use different authentication method, use --os parameter to specify a different template.
"},{"location":"commands_reference/upctl_server/create/#options","title":"Options","text":"Option Description --avoid-host Host to avoid when scheduling the server. Use this to make sure VMs do not reside on specific host. Refers to value from host attribute. Useful when building HA-environments.Default: 0--boot-order The boot device order, disk / cdrom / network or comma separated combination. --cores Number of cores. Only allowed if plan option is set to \"custom\".Default: 0--create-password Create an admin password. --enable-firewall Enable firewall. --enable-metadata Enable metadata service. The metadata service will be enabled by default, if the selected OS template uses cloud-init and thus requires metadata service. --enable-remote-access Enable remote access. --host Schedule the server on a specific host. Refers to value from host attribute. Only available in private clouds.Default: 0--hostname Server hostname. --label Labels to describe the server in key=value format, multiple can be declared.Usage: --label env=dev--label owner=operationsDefault: []--memory Memory amount in MiB. Only allowed if plan option is set to \"custom\".Default: 0--network A network interface for the server, multiple can be declared.Usage: --network family=IPv4,type=public--network type=private,network=037a530b-533e-4cef-b6ad-6af8094bb2bc,ip-address=10.0.0.1Default: []--os Server OS to use (will be the first storage device). The value should be title or UUID of an either public or private template. Set to empty to fully customise the storages.Default: Ubuntu Server 24.04 LTS (Noble Numbat)--os-storage-size OS storage size in GiB. This is only applicable if os is also set. Zero value makes the disk equal to the minimum size of the template.Default: 0--os-storage-encrypt Encrypt the OS storage. This is only applicable if os is also set. --password-delivery Defines how password is delivered. Available: email, smsDefault: none--plan Server plan name. See \"server plans\" command for valid plans. Set to \"custom\" and use cores and memory options for flexible plan.Default: 1xCPU-2GB--remote-access-password Defines the remote access password. --remote-access-type Set a remote access type. Available: vnc, spice --server-group UUID of a server group for the server. To remove the server from the group, see `servergroup modify --simple-backup Simple backup rule. Format (HHMM,{dailies,weeklies,monthlies}). Example: 2300,dailies --ssh-keys Add one or more SSH keys to the admin account. Accepted values are SSH public keys or filenames from where to read the keys.Default: []--storage A storage connected to the server, multiple can be declared.Usage: --storage action=attach,storage=01000000-0000-4000-8000-000020010301,type=cdromDefault: []--time-zone Time zone to set the RTC to.Default: UTC--title A short, informational description. --user-data Defines URL for a server setup script, or the script body itself. --username Admin account username. --video-model Video interface model of the server. Available: vga, cirrusDefault: vga--wait Wait for server to be in started state before returning. --zone Zone where to create the server. Run upctl zone list to list all available zones. --help, -h help for createDefault: false"},{"location":"commands_reference/upctl_server/create/#global-options","title":"Global options","text":"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. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output, -o Output format (supported: json, yaml and human)Default: human"},{"location":"commands_reference/upctl_server/create/#related-commands","title":"Related commands","text":"Command Description upctl server Manage servers"},{"location":"commands_reference/upctl_server/delete/","title":"upctl server delete","text":"
Delete a server
upctl server delete <UUID/Title/Hostname...> [flags]\n
upctl server delete 00cbe2f3-4cf9-408b-afee-bd340e13cdd8\nupctl server delete 00cbe2f3-4cf9-408b-afee-bd340e13cdd8 0053a6f5-e6d1-4b0b-b9dc-b90d0894e8d0\nupctl server delete my_server\n
"},{"location":"commands_reference/upctl_server/delete/#options","title":"Options","text":"Option Description --delete-storages Delete storages that are attached to the server. --help, -h help for deleteDefault: false"},{"location":"commands_reference/upctl_server/delete/#global-options","title":"Global options","text":"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. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output, -o Output format (supported: json, yaml and human)Default: human"},{"location":"commands_reference/upctl_server/delete/#related-commands","title":"Related commands","text":"Command Description upctl server Manage servers"},{"location":"commands_reference/upctl_server/eject/","title":"upctl server eject","text":"
Eject a CD-ROM from the server
upctl server eject <UUID/Title/Hostname...> [flags]\n
"},{"location":"commands_reference/upctl_server/eject/#options","title":"Options","text":"Option Description --help, -h help for ejectDefault: false"},{"location":"commands_reference/upctl_server/eject/#global-options","title":"Global options","text":"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. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output, -o Output format (supported: json, yaml and human)Default: human"},{"location":"commands_reference/upctl_server/eject/#related-commands","title":"Related commands","text":"Command Description upctl server Manage servers"},{"location":"commands_reference/upctl_server/list/","title":"upctl server list","text":"
upctl server list\nupctl server list --show-ip-addresses\nupctl server list --show-ip-addresses=public\n
"},{"location":"commands_reference/upctl_server/list/#options","title":"Options","text":"Option Description --show-ip-addresses Show servers IP addresses of specified access type in the output or all ip addresses if argument value is \"all\" or no argument is specified.Default: none--help, -h help for listDefault: false"},{"location":"commands_reference/upctl_server/list/#global-options","title":"Global options","text":"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. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output, -o Output format (supported: json, yaml and human)Default: human"},{"location":"commands_reference/upctl_server/list/#related-commands","title":"Related commands","text":"Command Description upctl server Manage servers"},{"location":"commands_reference/upctl_server/load/","title":"upctl server load","text":"
Load a CD-ROM into the server
upctl server load <UUID/Title/Hostname...> [flags]\n
upctl server load my_server4 --storage 01000000-0000-4000-8000-000080030101\n
"},{"location":"commands_reference/upctl_server/load/#options","title":"Options","text":"Option Description --storage The UUID of the storage to be loaded in the CD-ROM device. --help, -h help for loadDefault: false"},{"location":"commands_reference/upctl_server/load/#global-options","title":"Global options","text":"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. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output, -o Output format (supported: json, yaml and human)Default: human"},{"location":"commands_reference/upctl_server/load/#related-commands","title":"Related commands","text":"Command Description upctl server Manage servers"},{"location":"commands_reference/upctl_server/modify/","title":"upctl server modify","text":"
Modifies the configuration of an existing server
upctl server modify <UUID/Title/Hostname...> [flags]\n
upctl server modify 00bb4617-c592-4b32-b869-35a60b323b18 --plan 1xCPU-1GB\nupctl server modify 00bb4617-c592-4b32-b869-35a60b323b18 0053a6f5-e6d1-4b0b-b9dc-b90d0894e8d0 --plan 1xCPU-1GB\nupctl server modify my_server1 --plan 1xCPU-2GB\nupctl server modify myapp --hostname superapp\n
"},{"location":"commands_reference/upctl_server/modify/#options","title":"Options","text":"Option Description --boot-order The boot device order, disk / cdrom / network or comma separated combination. --cores Number of cores. Sets server plan to custom.Default: 0--hostname Hostname. --enable-firewall Enable firewall. --disable-firewall Disable firewall. --label Labels to describe the server in key=value format, multiple can be declared. If set, all the existing labels will be replaced with provided ones.Usage: --label env=dev--label owner=operationsDefault: []--memory Memory amount in MiB. Sets server plan to custom.Default: 0--enable-metadata Enable metadata service. --disable-metadata Disable metadata service. --plan Server plan to use. --simple-backup Simple backup rule. Format (HHMM,{dailies,weeklies,monthlies}).Example: 2300,dailies --title A short, informational description. --time-zone Time zone to set the RTC to. --video-model Video interface model of the server.Available: vga,cirrus --enable-remote-access Enable remote access. --disable-remote-access Disable remote access. --remote-access-type The remote access type. --remote-access-password The remote access password. --help, -h help for modifyDefault: false"},{"location":"commands_reference/upctl_server/modify/#global-options","title":"Global options","text":"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. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output, -o Output format (supported: json, yaml and human)Default: human"},{"location":"commands_reference/upctl_server/modify/#related-commands","title":"Related commands","text":"Command Description upctl server Manage servers"},{"location":"commands_reference/upctl_server/plans/","title":"upctl server plans","text":"
"},{"location":"commands_reference/upctl_server/plans/#options","title":"Options","text":"Option Description --help, -h help for plansDefault: false"},{"location":"commands_reference/upctl_server/plans/#global-options","title":"Global options","text":"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. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output, -o Output format (supported: json, yaml and human)Default: human"},{"location":"commands_reference/upctl_server/plans/#related-commands","title":"Related commands","text":"Command Description upctl server Manage servers"},{"location":"commands_reference/upctl_server/restart/","title":"upctl server restart","text":"
Restart a server
upctl server restart <UUID/Title/Hostname...> [flags]\n
upctl server restart 00038afc-d526-4148-af0e-d2f1eeaded9b\nupctl server restart 00038afc-d526-4148-af0e-d2f1eeaded9b --stop-type hard\nupctl server restart my_server1 my_server2\n
"},{"location":"commands_reference/upctl_server/restart/#options","title":"Options","text":"Option Description --stop-type The type of stop operation. Available: soft, hardDefault: soft--host Schedule the server on a specific host. Refers to value from host attribute. Only available in private clouds.Default: 0--help, -h help for restartDefault: false"},{"location":"commands_reference/upctl_server/restart/#global-options","title":"Global options","text":"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. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output, -o Output format (supported: json, yaml and human)Default: human"},{"location":"commands_reference/upctl_server/restart/#related-commands","title":"Related commands","text":"Command Description upctl server Manage servers"},{"location":"commands_reference/upctl_server/show/","title":"upctl server show","text":"
Show server details
upctl server show <UUID/Title/Hostname...> [flags]\n
upctl server show 21aeb3b7-cd89-4123-a376-559b0e75be8b\nupctl server show 21aeb3b7-cd89-4123-a376-559b0e75be8b 0053a6f5-e6d1-4b0b-b9dc-b90d0894e8d0\nupctl server show myhostname\nupctl server show my_server1 my_server2\n
"},{"location":"commands_reference/upctl_server/show/#options","title":"Options","text":"Option Description --help, -h help for showDefault: false"},{"location":"commands_reference/upctl_server/show/#global-options","title":"Global options","text":"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. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output, -o Output format (supported: json, yaml and human)Default: human"},{"location":"commands_reference/upctl_server/show/#related-commands","title":"Related commands","text":"Command Description upctl server Manage servers"},{"location":"commands_reference/upctl_server/start/","title":"upctl server start","text":"
Start a server
upctl server start <UUID/Title/Hostname...> [flags]\n
upctl server start 00038afc-d526-4148-af0e-d2f1eeaded9b\nupctl server start 00038afc-d526-4148-af0e-d2f1eeaded9b 0053a6f5-e6d1-4b0b-b9dc-b90d0894e8d0\nupctl server start my_server1\n
"},{"location":"commands_reference/upctl_server/start/#options","title":"Options","text":"Option Description --avoid-host Host to avoid when scheduling the server. Use this to make sure VMs do not reside on specific host. Refers to value from host attribute. Useful when building HA-environments.Default: 0--host Schedule the server on a specific host. Refers to value from host attribute. Only available in private clouds.Default: 0--help, -h help for startDefault: false"},{"location":"commands_reference/upctl_server/start/#global-options","title":"Global options","text":"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. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output, -o Output format (supported: json, yaml and human)Default: human"},{"location":"commands_reference/upctl_server/start/#related-commands","title":"Related commands","text":"Command Description upctl server Manage servers"},{"location":"commands_reference/upctl_server/stop/","title":"upctl server stop","text":"
Stop a server
upctl server stop <UUID/Title/Hostname...> [flags]\n
upctl server stop 00cbe2f3-4cf9-408b-afee-bd340e13cdd8\nupctl server stop 00cbe2f3-4cf9-408b-afee-bd340e13cdd8 0053a6f5-e6d1-4b0b-b9dc-b90d0894e8d0\nupctl server stop my_server\nupctl server stop --wait my_server\n
"},{"location":"commands_reference/upctl_server/stop/#options","title":"Options","text":"Option Description --type The type of stop operation. Available: soft, hardDefault: soft--wait Wait for server to be in stopped state before returning. --help, -h help for stopDefault: false"},{"location":"commands_reference/upctl_server/stop/#global-options","title":"Global options","text":"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. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output, -o Output format (supported: json, yaml and human)Default: human"},{"location":"commands_reference/upctl_server/stop/#related-commands","title":"Related commands","text":"Command Description upctl server Manage servers"},{"location":"commands_reference/upctl_server/firewall/","title":"upctl server firewall","text":"
Manage server firewall rules. Enabling or disabling the firewall is done in server modify.
upctl server firewall [flags]\n
"},{"location":"commands_reference/upctl_server/firewall/#options","title":"Options","text":"Option Description --help, -h help for firewallDefault: false"},{"location":"commands_reference/upctl_server/firewall/#global-options","title":"Global options","text":"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. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output, -o Output format (supported: json, yaml and human)Default: human"},{"location":"commands_reference/upctl_server/firewall/#related-commands","title":"Related commands","text":"Command Description upctl server Manage servers upctl server firewall create Create a new firewall rule upctl server firewall delete Removes a firewall rule from a server. Firewall rules must be removed individually. The positions of remaining firewall rules will be adjusted after a rule is removed. upctl server firewall show Show server firewall details."},{"location":"commands_reference/upctl_server/firewall/create/","title":"upctl server firewall create","text":"
Create a new firewall rule
To edit the default rule of the firewall, set only --direction and --action parameters. This creates catch-all rule that will take effect when no other rule matches. Note that the default rule must be positioned after all other rules. Use --position parameter or create default rule after other rules.
upctl server firewall create <UUID/Title/Hostname...> [flags]\n
upctl server firewall create 00038afc-d526-4148-af0e-d2f1eeaded9b --direction in --action drop\nupctl server firewall create 00038afc-d526-4148-af0e-d2f1eeaded9b --direction in --action accept --family IPv4\nupctl server firewall create 00038afc-d526-4148-af0e-d2f1eeaded9b --direction in --action drop --family IPv4 --src-ipaddress-block 10.11.0.88/24\n
"},{"location":"commands_reference/upctl_server/firewall/create/#options","title":"Options","text":"Option Description --direction Rule direction. Available: in, out --action Rule action. Available: accept, drop --family IP family. Available: IPv4, IPv6 --position Position in relation to other rules. Available: 1-1000Default: 0--protocol Protocol. Available: tcp, udp, icmp --icmp-type ICMP type. Available: 0-255 --dest-ipaddress-block Destination IP address block. --destination-port-start Destination port range start. Available: 1-65535 --destination-port-end Destination port range end. --src-ipaddress-block Source IP address block. --source-port-start Source port range start. --source-port-end Destination port range end. --comment Freeform comment that can include 0-250 characters. --help, -h help for createDefault: false"},{"location":"commands_reference/upctl_server/firewall/create/#global-options","title":"Global options","text":"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. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output, -o Output format (supported: json, yaml and human)Default: human"},{"location":"commands_reference/upctl_server/firewall/create/#related-commands","title":"Related commands","text":"Command Description upctl server firewall Manage server firewall rules. Enabling or disabling the firewall is done in server modify."},{"location":"commands_reference/upctl_server/firewall/delete/","title":"upctl server firewall delete","text":"
Removes a firewall rule from a server. Firewall rules must be removed individually. The positions of remaining firewall rules will be adjusted after a rule is removed.
upctl server firewall delete <UUID/Title/Hostname...> [flags]\n
upctl server firewall delete 00038afc-d526-4148-af0e-d2f1eeaded9b --position 1\n
"},{"location":"commands_reference/upctl_server/firewall/delete/#options","title":"Options","text":"Option Description --position Rule position. Available: 1-1000Default: 0--help, -h help for deleteDefault: false"},{"location":"commands_reference/upctl_server/firewall/delete/#global-options","title":"Global options","text":"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. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output, -o Output format (supported: json, yaml and human)Default: human"},{"location":"commands_reference/upctl_server/firewall/delete/#related-commands","title":"Related commands","text":"Command Description upctl server firewall Manage server firewall rules. Enabling or disabling the firewall is done in server modify."},{"location":"commands_reference/upctl_server/firewall/show/","title":"upctl server firewall show","text":"
Show server firewall details.
upctl server firewall show <UUID/Title/Hostname...> [flags]\n
upctl server firewall show 00038afc-d526-4148-af0e-d2f1eeaded9b\nupctl server firewall show 00038afc-d526-4148-af0e-d2f1eeaded9b 009d7f4e-99ce-4c78-88f1-e695d4c37743\nupctl server firewall show my_server\n
"},{"location":"commands_reference/upctl_server/firewall/show/#options","title":"Options","text":"Option Description --help, -h help for showDefault: false"},{"location":"commands_reference/upctl_server/firewall/show/#global-options","title":"Global options","text":"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. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output, -o Output format (supported: json, yaml and human)Default: human"},{"location":"commands_reference/upctl_server/firewall/show/#related-commands","title":"Related commands","text":"Command Description upctl server firewall Manage server firewall rules. Enabling or disabling the firewall is done in server modify."},{"location":"commands_reference/upctl_server/network-interface/","title":"upctl server network-interface","text":"
Manage network interface
upctl server network-interface [flags]\n
"},{"location":"commands_reference/upctl_server/network-interface/#options","title":"Options","text":"Option Description --help, -h help for network-interfaceDefault: false"},{"location":"commands_reference/upctl_server/network-interface/#global-options","title":"Global options","text":"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. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output, -o Output format (supported: json, yaml and human)Default: human"},{"location":"commands_reference/upctl_server/network-interface/#related-commands","title":"Related commands","text":"Command Description upctl server Manage servers upctl server network-interface create Create a network interface upctl server network-interface delete Delete a network interface upctl server network-interface modify Modify a network interface"},{"location":"commands_reference/upctl_server/network-interface/create/","title":"upctl server network-interface create","text":"
Create a network interface
upctl server network-interface create <UUID/Title/Hostname...> [flags]\n
upctl server network-interface create 009d7f4e-99ce-4c78-88f1-e695d4c37743 --type private --network 037a530b-533e-4cef-b6ad-6af8094bb2bc --disable-source-ip-filtering --ip-addresses 10.0.0.1\nupctl server network-interface create my_server2 --type public --family IPv6\nupctl server network-interface create my_server2 --type public --family IPv4\nupctl server network-interface create my_server2 --network 037a530b-533e-4cef-b6ad-6af8094bb2bc\n
"},{"location":"commands_reference/upctl_server/network-interface/create/#options","title":"Options","text":"Option Description --network Private network name or UUID to join. --type Set the type of the network. Available: public, utility, privateDefault: private--family The address family of new IP address.Default: IPv4--index Interface index.Default: 0--enable-bootable Enable Whether to try booting through the interface.. --disable-bootable Disable Whether to try booting through the interface.. --enable-source-ip-filtering Enable Whether source IP filtering is enabled on the interface. Disabling it is allowed only for SDN private interfaces.. --disable-source-ip-filtering Disable Whether source IP filtering is enabled on the interface. Disabling it is allowed only for SDN private interfaces.. --ip-addresses A comma-separated list of IP addressesDefault: []--help, -h help for createDefault: false"},{"location":"commands_reference/upctl_server/network-interface/create/#global-options","title":"Global options","text":"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. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output, -o Output format (supported: json, yaml and human)Default: human"},{"location":"commands_reference/upctl_server/network-interface/create/#related-commands","title":"Related commands","text":"Command Description upctl server network-interface Manage network interface"},{"location":"commands_reference/upctl_server/network-interface/delete/","title":"upctl server network-interface delete","text":"
Delete a network interface
upctl server network-interface delete <UUID/Title/Hostname...> [flags]\n
upctl server network-interface delete 009d7f4e-99ce-4c78-88f1-e695d4c37743 --index 1\nupctl server network-interface delete my_server --index 7\n
"},{"location":"commands_reference/upctl_server/network-interface/delete/#options","title":"Options","text":"Option Description --index Interface index.Default: 0--help, -h help for deleteDefault: false"},{"location":"commands_reference/upctl_server/network-interface/delete/#global-options","title":"Global options","text":"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. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output, -o Output format (supported: json, yaml and human)Default: human"},{"location":"commands_reference/upctl_server/network-interface/delete/#related-commands","title":"Related commands","text":"Command Description upctl server network-interface Manage network interface"},{"location":"commands_reference/upctl_server/network-interface/modify/","title":"upctl server network-interface modify","text":"
Modify a network interface
upctl server network-interface modify <UUID/Title/Hostname...> [flags]\n
upctl server network-interface modify 009d7f4e-99ce-4c78-88f1-e695d4c37743 --index 2 --new-index 1\n
"},{"location":"commands_reference/upctl_server/network-interface/modify/#options","title":"Options","text":"Option Description --index Index of the interface to modify.Default: 0--new-index New index to move the interface to.Default: 0--bootable Whether to try booting through the interface. --source-ip-filtering Whether source IP filtering is enabled on the interface. Disabling it is allowed only for SDN private interfaces. --ip-addresses A comma-separated list of IP addresses, multiple can be declaredUsage: --ip-address address=94.237.112.143,family=IPv4Default: []--help, -h help for modifyDefault: false"},{"location":"commands_reference/upctl_server/network-interface/modify/#global-options","title":"Global options","text":"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. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output, -o Output format (supported: json, yaml and human)Default: human"},{"location":"commands_reference/upctl_server/network-interface/modify/#related-commands","title":"Related commands","text":"Command Description upctl server network-interface Manage network interface"},{"location":"commands_reference/upctl_server/storage/","title":"upctl server storage","text":"
Manage server storages
upctl server storage [flags]\n
"},{"location":"commands_reference/upctl_server/storage/#options","title":"Options","text":"Option Description --help, -h help for storageDefault: false"},{"location":"commands_reference/upctl_server/storage/#global-options","title":"Global options","text":"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. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output, -o Output format (supported: json, yaml and human)Default: human"},{"location":"commands_reference/upctl_server/storage/#related-commands","title":"Related commands","text":"Command Description upctl server Manage servers upctl server storage attach Attach a storage as a device to a server upctl server storage detach Detaches a storage resource from a server"},{"location":"commands_reference/upctl_server/storage/attach/","title":"upctl server storage attach","text":"
Attach a storage as a device to a server
upctl server storage attach <UUID/Title/Hostname...> [flags]\n
upctl server storage attach 00038afc-d526-4148-af0e-d2f1eeaded9b --storage 015899e0-0a68-4949-85bb-261a99de5fdd\nupctl server storage attach 00038afc-d526-4148-af0e-d2f1eeaded9b --storage 01a5568f-4766-4ce7-abf5-7d257903a735 --address virtio:2\nupctl server storage attach my_server1 --storage \"My Storage\"\n
"},{"location":"commands_reference/upctl_server/storage/attach/#options","title":"Options","text":"Option Description --type Type of the attached storage. Available: disk, cdromDefault: disk--address Address where the storage device is attached on the server. Address is of the form busname:deviceindex where busname can be ide/scsi/virtio. (example: 'virtio:1')Specify only the bus name to auto-select next available device index from that bus. (example: 'virtio')Default: virtio--storage UUID of the storage to attach. --boot-disk Set attached device as the server's boot disk. --help, -h help for attachDefault: false"},{"location":"commands_reference/upctl_server/storage/attach/#global-options","title":"Global options","text":"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. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output, -o Output format (supported: json, yaml and human)Default: human"},{"location":"commands_reference/upctl_server/storage/attach/#related-commands","title":"Related commands","text":"Command Description upctl server storage Manage server storages"},{"location":"commands_reference/upctl_server/storage/detach/","title":"upctl server storage detach","text":"
Detaches a storage resource from a server
upctl server storage detach <UUID/Title/Hostname...> [flags]\n
upctl server storage detach 00038afc-d526-4148-af0e-d2f1eeaded9b --address virtio:1\nupctl server storage detach my_server1 --address virtio:2\n
"},{"location":"commands_reference/upctl_server/storage/detach/#options","title":"Options","text":"Option Description --address Detach the storage attached to this address. --help, -h help for detachDefault: false"},{"location":"commands_reference/upctl_server/storage/detach/#global-options","title":"Global options","text":"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. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output, -o Output format (supported: json, yaml and human)Default: human"},{"location":"commands_reference/upctl_server/storage/detach/#related-commands","title":"Related commands","text":"Command Description upctl server storage Manage server storages"},{"location":"commands_reference/upctl_servergroup/","title":"upctl servergroup","text":"
Manage server groups
upctl servergroup [flags]\n
"},{"location":"commands_reference/upctl_servergroup/#options","title":"Options","text":"Option Description --help, -h help for servergroupDefault: false"},{"location":"commands_reference/upctl_servergroup/#global-options","title":"Global options","text":"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. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output, -o Output format (supported: json, yaml and human)Default: human"},{"location":"commands_reference/upctl_servergroup/#related-commands","title":"Related commands","text":"Command Description upctl UpCloud command-line interface upctl servergroup create Create a server group upctl servergroup delete Delete a server group upctl servergroup list List current server groups upctl servergroup modify Modify a server group upctl servergroup show Show server group details"},{"location":"commands_reference/upctl_servergroup/create/","title":"upctl servergroup create","text":"
"},{"location":"commands_reference/upctl_servergroup/create/#options","title":"Options","text":"Option Description --title Server group title. --anti-affinity-policy Anti-affinity policy. Valid values are yes (best effort), strict and no. Will take effect upon server start.Default: yes--label Labels to describe the server group in key=value format, multiple can be declared.Usage: --label env=dev--label owner=operationsDefault: []--server Servers to be added to the server group, multiple can be declared.Usage: --server my-server--server 00333d1b-3a4a-4b75-820a-4a56d70395ddDefault: []--help, -h help for createDefault: false"},{"location":"commands_reference/upctl_servergroup/create/#global-options","title":"Global options","text":"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. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output, -o Output format (supported: json, yaml and human)Default: human"},{"location":"commands_reference/upctl_servergroup/create/#related-commands","title":"Related commands","text":"Command Description upctl servergroup Manage server groups"},{"location":"commands_reference/upctl_servergroup/delete/","title":"upctl servergroup delete","text":"
"},{"location":"commands_reference/upctl_servergroup/delete/#options","title":"Options","text":"Option Description --help, -h help for deleteDefault: false"},{"location":"commands_reference/upctl_servergroup/delete/#global-options","title":"Global options","text":"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. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output, -o Output format (supported: json, yaml and human)Default: human"},{"location":"commands_reference/upctl_servergroup/delete/#related-commands","title":"Related commands","text":"Command Description upctl servergroup Manage server groups"},{"location":"commands_reference/upctl_servergroup/list/","title":"upctl servergroup list","text":"
"},{"location":"commands_reference/upctl_servergroup/list/#options","title":"Options","text":"Option Description --help, -h help for listDefault: false"},{"location":"commands_reference/upctl_servergroup/list/#global-options","title":"Global options","text":"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. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output, -o Output format (supported: json, yaml and human)Default: human"},{"location":"commands_reference/upctl_servergroup/list/#related-commands","title":"Related commands","text":"Command Description upctl servergroup Manage server groups"},{"location":"commands_reference/upctl_servergroup/modify/","title":"upctl servergroup modify","text":"
"},{"location":"commands_reference/upctl_servergroup/modify/#options","title":"Options","text":"Option Description --anti-affinity-policy Anti-affinity policy. Valid values are yes (best effort), strict and no. Will take effect upon server start. --label Labels to describe the server in key=value format, multiple can be declared. If set, all the existing labels will be replaced with provided ones.Usage: --label env=dev--label owner=operationsDefault: []--title New server group title. --server Servers that belong to the server group, multiple can be declared. If set, all the existing server entries will be replaced with provided ones.Usage: --server my-server--server 00333d1b-3a4a-4b75-820a-4a56d70395ddDefault: []--help, -h help for modifyDefault: false"},{"location":"commands_reference/upctl_servergroup/modify/#global-options","title":"Global options","text":"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. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output, -o Output format (supported: json, yaml and human)Default: human"},{"location":"commands_reference/upctl_servergroup/modify/#related-commands","title":"Related commands","text":"Command Description upctl servergroup Manage server groups"},{"location":"commands_reference/upctl_servergroup/show/","title":"upctl servergroup show","text":"
upctl servergroup show 8abc8009-4325-4b23-4321-b1232cd81231\nupctl servergroup show my-server-group\n
"},{"location":"commands_reference/upctl_servergroup/show/#options","title":"Options","text":"Option Description --help, -h help for showDefault: false"},{"location":"commands_reference/upctl_servergroup/show/#global-options","title":"Global options","text":"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. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output, -o Output format (supported: json, yaml and human)Default: human"},{"location":"commands_reference/upctl_servergroup/show/#related-commands","title":"Related commands","text":"Command Description upctl servergroup Manage server groups"},{"location":"commands_reference/upctl_storage/","title":"upctl storage","text":"
Manage storages
upctl storage [flags]\n
"},{"location":"commands_reference/upctl_storage/#options","title":"Options","text":"Option Description --help, -h help for storageDefault: false"},{"location":"commands_reference/upctl_storage/#global-options","title":"Global options","text":"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. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output, -o Output format (supported: json, yaml and human)Default: human"},{"location":"commands_reference/upctl_storage/#related-commands","title":"Related commands","text":"Command Description upctl UpCloud command-line interface upctl storage backup Manage backups upctl storage clone Clone a storage upctl storage create Create a storage upctl storage delete Delete a storage upctl storage import Import a storage from external or local source upctl storage list List current storages upctl storage modify Modify a storage upctl storage show Show storage details upctl storage templatise Templatise a storage"},{"location":"commands_reference/upctl_storage/clone/","title":"upctl storage clone","text":"
"},{"location":"commands_reference/upctl_storage/clone/#options","title":"Options","text":"Option Description --tier The storage tier to use.Default: hdd--title A short, informational description. --zone Zone where to create the storage. Run upctl zone list to list all available zones. --encrypt Encrypt the new storage. --help, -h help for cloneDefault: false"},{"location":"commands_reference/upctl_storage/clone/#global-options","title":"Global options","text":"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. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output, -o Output format (supported: json, yaml and human)Default: human"},{"location":"commands_reference/upctl_storage/clone/#related-commands","title":"Related commands","text":"Command Description upctl storage Manage storages"},{"location":"commands_reference/upctl_storage/create/","title":"upctl storage create","text":"
"},{"location":"commands_reference/upctl_storage/create/#options","title":"Options","text":"Option Description --title A short, informational description. --size Size of the storage in GiB.Default: 10--zone Zone where to create the storage. Run upctl zone list to list all available zones. --tier Storage tier.Default: maxiops--encrypt Encrypt the storage. --backup-time The time when to create a backup in HH:MM. Empty value means no backups. --backup-interval The interval of the backup.Available: daily, mon, tue, wed, thu, fri, sat, sunDefault: daily--backup-retention How long to store the backups in days. The accepted range is 1-1095Default: 7--help, -h help for createDefault: false"},{"location":"commands_reference/upctl_storage/create/#global-options","title":"Global options","text":"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. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output, -o Output format (supported: json, yaml and human)Default: human"},{"location":"commands_reference/upctl_storage/create/#related-commands","title":"Related commands","text":"Command Description upctl storage Manage storages"},{"location":"commands_reference/upctl_storage/delete/","title":"upctl storage delete","text":"
"},{"location":"commands_reference/upctl_storage/delete/#options","title":"Options","text":"Option Description --help, -h help for deleteDefault: false"},{"location":"commands_reference/upctl_storage/delete/#global-options","title":"Global options","text":"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. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output, -o Output format (supported: json, yaml and human)Default: human"},{"location":"commands_reference/upctl_storage/delete/#related-commands","title":"Related commands","text":"Command Description upctl storage Manage storages"},{"location":"commands_reference/upctl_storage/import/","title":"upctl storage import","text":"
"},{"location":"commands_reference/upctl_storage/import/#options","title":"Options","text":"Option Description --source-location Location of the source of the import. Can be a file or a URL. --storage Import to an existing storage. Storage must be large enough and must be undetached or the server where the storage is attached must be in shutdown state. --no-wait When importing from remote url, do not wait until the import finishes or storage is in online state. If set, command will exit after import process has been initialized. --wait Wait for storage to be in online state before returning. --title A short, informational description. --size Size of the storage in GiB.Default: 10--zone Zone where to create the storage. Run upctl zone list to list all available zones. --tier Storage tier.Default: maxiops--encrypt Encrypt the storage. --backup-time The time when to create a backup in HH:MM. Empty value means no backups. --backup-interval The interval of the backup.Available: daily, mon, tue, wed, thu, fri, sat, sunDefault: daily--backup-retention How long to store the backups in days. The accepted range is 1-1095Default: 7--help, -h help for importDefault: false"},{"location":"commands_reference/upctl_storage/import/#global-options","title":"Global options","text":"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. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output, -o Output format (supported: json, yaml and human)Default: human"},{"location":"commands_reference/upctl_storage/import/#related-commands","title":"Related commands","text":"Command Description upctl storage Manage storages"},{"location":"commands_reference/upctl_storage/list/","title":"upctl storage list","text":"
"},{"location":"commands_reference/upctl_storage/list/#options","title":"Options","text":"Option Description --all Show all storages. --private Show private storages (default). --public Show public storages. --normal Show only normal storages. --backup Show only backup storages. --cdrom Show only cdrom storages. --template Show only template storages. --help, -h help for listDefault: false"},{"location":"commands_reference/upctl_storage/list/#global-options","title":"Global options","text":"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. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output, -o Output format (supported: json, yaml and human)Default: human"},{"location":"commands_reference/upctl_storage/list/#related-commands","title":"Related commands","text":"Command Description upctl storage Manage storages"},{"location":"commands_reference/upctl_storage/modify/","title":"upctl storage modify","text":"
"},{"location":"commands_reference/upctl_storage/modify/#options","title":"Options","text":"Option Description --title A short, informational description. --size Size of the storage (GiB).Default: 0--backup-time The time when to create a backup in HH:MM. Empty value means no backups. --backup-interval The interval of the backup.Available: daily, mon, tue, wed, thu, fri, sat, sun --backup-retention How long to store the backups in days. The accepted range is 1-1095.Default: 0--enable-filesystem-autoresize Enable automatic resize of partition and filesystem when modifying storage size. Note that before the resize attempt is made, backup of the storage will be taken. If the resize attempt fails, the backup will be used to restore the storage and then deleted. If the resize attempt succeeds, backup will be kept. Taking and keeping backups incur costs.. --help, -h help for modifyDefault: false"},{"location":"commands_reference/upctl_storage/modify/#global-options","title":"Global options","text":"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. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output, -o Output format (supported: json, yaml and human)Default: human"},{"location":"commands_reference/upctl_storage/modify/#related-commands","title":"Related commands","text":"Command Description upctl storage Manage storages"},{"location":"commands_reference/upctl_storage/show/","title":"upctl storage show","text":"
upctl storage show 01271548-2e92-44bb-9774-d282508cc762\nupctl storage show 01271548-2e92-44bb-9774-d282508cc762 01c60190-3a01-4108-b1c3-2e828855ccc0\nupctl storage show \"My Storage\"\n
"},{"location":"commands_reference/upctl_storage/show/#options","title":"Options","text":"Option Description --help, -h help for showDefault: false"},{"location":"commands_reference/upctl_storage/show/#global-options","title":"Global options","text":"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. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output, -o Output format (supported: json, yaml and human)Default: human"},{"location":"commands_reference/upctl_storage/show/#related-commands","title":"Related commands","text":"Command Description upctl storage Manage storages"},{"location":"commands_reference/upctl_storage/templatise/","title":"upctl storage templatise","text":"
"},{"location":"commands_reference/upctl_storage/templatise/#options","title":"Options","text":"Option Description --title A short, informational description. --wait Wait for storage to be in online state before returning. --help, -h help for templatiseDefault: false"},{"location":"commands_reference/upctl_storage/templatise/#global-options","title":"Global options","text":"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. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output, -o Output format (supported: json, yaml and human)Default: human"},{"location":"commands_reference/upctl_storage/templatise/#related-commands","title":"Related commands","text":"Command Description upctl storage Manage storages"},{"location":"commands_reference/upctl_storage/backup/","title":"upctl storage backup","text":"
Manage backups
upctl storage backup [flags]\n
"},{"location":"commands_reference/upctl_storage/backup/#options","title":"Options","text":"Option Description --help, -h help for backupDefault: false"},{"location":"commands_reference/upctl_storage/backup/#global-options","title":"Global options","text":"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. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output, -o Output format (supported: json, yaml and human)Default: human"},{"location":"commands_reference/upctl_storage/backup/#related-commands","title":"Related commands","text":"Command Description upctl storage Manage storages upctl storage backup create Create backup of a storage upctl storage backup restore Restore backup of a storage"},{"location":"commands_reference/upctl_storage/backup/create/","title":"upctl storage backup create","text":"
"},{"location":"commands_reference/upctl_storage/backup/restore/#options","title":"Options","text":"Option Description --help, -h help for restoreDefault: false"},{"location":"commands_reference/upctl_storage/backup/restore/#global-options","title":"Global options","text":"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. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output, -o Output format (supported: json, yaml and human)Default: human"},{"location":"commands_reference/upctl_storage/backup/restore/#related-commands","title":"Related commands","text":"Command Description upctl storage backup Manage backups"},{"location":"commands_reference/upctl_zone/","title":"upctl zone","text":"
Display zone information
upctl zone [flags]\n
"},{"location":"commands_reference/upctl_zone/#options","title":"Options","text":"Option Description --help, -h help for zoneDefault: false"},{"location":"commands_reference/upctl_zone/#global-options","title":"Global options","text":"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. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output, -o Output format (supported: json, yaml and human)Default: human"},{"location":"commands_reference/upctl_zone/#related-commands","title":"Related commands","text":"Command Description upctl UpCloud command-line interface upctl zone list List available zones"},{"location":"commands_reference/upctl_zone/list/","title":"upctl zone list","text":"
"},{"location":"commands_reference/upctl_zone/list/#options","title":"Options","text":"Option Description --help, -h help for listDefault: false"},{"location":"commands_reference/upctl_zone/list/#global-options","title":"Global options","text":"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. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output, -o Output format (supported: json, yaml and human)Default: human"},{"location":"commands_reference/upctl_zone/list/#related-commands","title":"Related commands","text":"Command Description upctl zone Display zone information"},{"location":"examples/","title":"Examples","text":"
This directory contains examples on more complex upctl use-cases. As upctl is often used in scripts the examples also aim to parse values from machine readable outputs. This allows using the examples also as end-to-end test cases and makes them more copy-pasteable.
The examples in this directory are validated with mdtest. It parses env and sh code-blocks from the markdown files and executes those as scripts.
The tool can be installed with go install.
go install github.com/UpCloudLtd/mdtest@latest\n
To test the examples, run mdtest ..
mdtest .\n
"},{"location":"examples/create_a_custom_template/","title":"Create a custom template","text":"
This example demonstrates how to create a custom template with upctl.
To keep track of resources created during this example, we will use common prefix in all resource names.
prefix=example-upctl-custom-template-\n
First, we will create server which disk will be used as a source for the custom template.
# Create ssh-key into current working directory\nssh-keygen -t ed25519 -q -f \"./id_ed25519\" -N \"\"\n\nupctl server create \\\n --hostname ${prefix}source-server \\\n --zone pl-waw1 \\\n --ssh-keys ./id_ed25519.pub \\\n --network type=public \\\n --network type=utility \\\n --wait\n
After the server has started, you can connect to it and prepare the disk to be templatized. Then, to be able to templatize the storage disk, we will stop the server.
upctl server stop --type hard --wait ${prefix}source-server\n
The default name for the OS storage of servers created with upctl is ${server-title}-OS, in this case ${prefix}source-server-OS. We can use either that or the UUID of the storage, when creating the template. UUID of the storage can be printed, for example, by processing json output with jq.
upctl server show ${prefix}source-server -o json \\\n | jq -r \".storage[0].uuid\"\n
To have something to backup, we will install a nginx server and configure a non-default HTML content to serve.
configure-nginx.sh
#!/bin/sh -xe\n\napt install nginx -y\necho \"Hello from $(hostname)\"'!' > /var/www/html/index.html\n
To configure the server, we will parse the public IP of the server and run the above script using SSH connection. We can then use curl to ensure that the HTTP server serves the content we defined.
# Parse public IP of the server with jq\nip=$(upctl server show ${prefix}source-server -o json | jq -r '.networking.interfaces[] | select(.type == \"public\") | .ip_addresses[0].address')\n\n# Wait for a moment for the ssh server to become available\nsleep 30\n\n# Run the script defined above\nssh -i id_ed25519 -o StrictHostKeyChecking=accept-new root@$ip \"sh\" < configure-nginx.sh\n\n# Validate HTTP server response\ntest \"$(curl -s $ip)\" = 'Hello from example-upctl-backup-source-server!'\n
We will then backup the OS disk of the created server.
To validate that the server was re-created successfully, we will parse the public IP of the server and use curl to see that the HTTP server is running.
# Parse public IP of the server with jq\nip=$(upctl server show ${prefix}restored-server -o json | jq -r '.networking.interfaces[] | select(.type == \"public\") | .ip_addresses[0].address')\n\n# Wait until server returns expected response\nfor i in $(seq 1 9); do\n test \"$(curl -s $ip)\" = 'Hello from example-upctl-backup-source-server!' && break || true;\n sleep 15;\ndone;\n
Finally, we can cleanup the created resources.
# Delete the restored server and its storages\nupctl server stop --type hard --wait ${prefix}restored-server\nupctl server delete ${prefix}restored-server --delete-storages\n\n# Delete the backup\nupctl storage delete ${prefix}source-server-backup\n
"},{"location":"examples/create_and_ssh_into_a_server/","title":"Create and ssh into a server","text":"
This example demonstrates how to create a server with upctl and connect to the created server via ssh connection.
To keep track of resources created during this example, we will use common prefix in all resource names.
prefix=example-upctl-ssh-server-\n
In order to be able to connect to the server we are going to create, we will need an ssh-key. If you already have a ssh-key available, you can skip this step. The example creates the ssh-key into the current working directory, if you want to use this key for other authentication purposes as well, create the key into ~/.ssh directory instead.
# Create ssh-key into current working directory\nssh-keygen -t ed25519 -q -f \"./id_ed25519\" -N \"\" -C \"upctl example\"\n
Create a server using the above created ssh-key as login method.
Find the IP address of the created server from the JSON output of upctl server show and execute hostname command via ssh connection on the created server.
# Parse public IP of the server with jq\nip=$(upctl server show ${prefix}server -o json | jq -r '.networking.interfaces[] | select(.type == \"public\") | .ip_addresses[0].address')\n\n# Wait for a moment for the ssh server to become available\nsleep 30\n\nssh -i id_ed25519 -o StrictHostKeyChecking=accept-new root@$ip \"hostname\"\n
Finally, we can cleanup the created resources.
upctl server stop --type hard --wait ${prefix}server\nupctl server delete ${prefix}server --delete-storages\n
upctl sets exit code based on number of failed tasks up to exit code 99. This example demonstrates executions with few different exit codes.
To keep track of resources created during this example, we will use common prefix in all resource names.
prefix=example-upctl-exit-codes-\n
Exit code 100 is set, for example, when command argument validation fails.
upctl server create\n# Error: required flag(s) \"hostname\", \"zone\" not set\n
Let's create two servers and stop one of those to later see other failing exit codes. This example uses --type hard when stopping the servers as the OS might not be completely up and running when the server reaches running state. These command should succeed, and thus return zero exit code.
# Create ssh-key into current working directory\nssh-keygen -t ed25519 -q -f \"./id_ed25519\" -N \"\"\n\nupctl server create --hostname ${prefix}vm-1 --zone pl-waw1 --ssh-keys ./id_ed25519.pub --wait\nupctl server create --hostname ${prefix}vm-2 --zone pl-waw1 --ssh-keys ./id_ed25519.pub --wait\n\nupctl server stop --type hard ${prefix}vm-1 --wait\n
Now let's try to stop both both of the created servers. Exit code will be one, as ${prefix}vm-1 is already stopped and thus cannot be stopped again. ${prefix}vm-2, though, will be stopped as it was online. Thus one of the two operations failed.
upctl server stop --type hard ${prefix}vm-1 ${prefix}vm-2 --wait\n
If we now try to run above command again, exit code will be two as both of the servers are already stopped. Thus both stop operations failed.
upctl server stop --type hard ${prefix}vm-1 ${prefix}vm-2 --wait\n
Finally, we can cleanup the created resources.
upctl server delete ${prefix}vm-1 ${prefix}vm-2 --delete-storages\n
"}]}
\ No newline at end of file
+{"config":{"lang":["en"],"separator":"[\\s\\-]+","pipeline":["stopWordFilter"]},"docs":[{"location":"","title":"Getting started","text":"
upctl provides a command-line interface to UpCloud services. It allows you to control your resources from the command line or any compatible interface.
Use homebrew to install upctl from UpCloudLtd tap.
brew tap UpCloudLtd/tap\nbrew install upcloud-cli\n
First, download the archived binary from GitHub releases to current folder and extract the binary from the archive.
Invoke-WebRequest -Uri \"https://github.com/UpCloudLtd/upcloud-cli/releases/download/v3.14.0/upcloud-cli_3.14.0_windows_x86_64.zip\" -OutFile \"upcloud-cli_3.14.0_windows_x86_64.zip\"\nExpand-Archive -Path \"upcloud-cli_3.14.0_windows_x86_64.zip\"\n\n# Print current location\nGet-Location\n
Then, close the current PowerShell session and open a new session as an administrator. Move the binary to upcloud-cli folder in Program Files, add the upcloud-cli folder in Program Files to Path.
# Open the PowerShell with Run as Administrator option.\n# Use Set-Location to change into folder that you used in previous step.\n\nNew-Item -ItemType Directory $env:ProgramFiles\\upcloud-cli\\ -Force\nMove-Item -Path upcloud-cli_3.14.0_windows_x86_64\\upctl.exe -Destination $env:ProgramFiles\\upcloud-cli\\ -Force\n\n# Setting the Path is required only on first install.\n# Thus, this step can be skipped when updating to a more recent version.\n[Environment]::SetEnvironmentVariable(\"Path\", [Environment]::GetEnvironmentVariable(\"Path\", [EnvironmentVariableTarget]::Machine) + \";$env:ProgramFiles\\upcloud-cli\\\", [EnvironmentVariableTarget]::Machine)\n
After running the above commands, close the administrator PowerShell session and open a new PowerShell session to verify installation succeeded.
Install the latest version of upctl with go install, by running:
go install github.com/UpCloudLtd/upcloud-cli/v3/...@latest\n
Pull the latest build from GHCR by running:
docker pull ghcr.io/upcloudltd/upctl:latest\n
After installing upctl, you can run upctl version command to verify that the tool was installed successfully.
upctl provides shell completions for multiple shells. Run upctl completion --help to list the supported shells.
upctl completion --help\n
To configure the shell completions, follow the instructions provided in the help output of the command matching the shell you are using. For example, if you are using zsh, run upctl completion zsh --help to print the configuration instructions.
Finally, configure the shell completions for upctl by either sourcing upctl completion bash output in your bash .bashrc or by saving the output of that command in upctl file under /etc/bash_completion.d/:
# First alternative\necho 'source <(upctl completion bash)' >>~/.bashrc\n\n# Second alternative\nupctl completion bash | sudo tee /etc/bash_completion.d/upctl > /dev/null\n\n# Source completions to current shell session\n. /etc/bash_completion\n
First, install bash-completion package, if it has not been installed already, and add command to source the completions to your .bash_profile.
To be able to manage your UpCloud resources, you need to configure credentials for upctl and enable API access for these credentials.
Define the credentials by setting UPCLOUD_USERNAME and UPCLOUD_PASSWORD environment variables.
API access can be configured in the UpCloud Hub on Account page for the main-account and on the Permissions tab of the People page for sub-accounts. We recommend you to set up a sub-account specifically for the API usage with its own username and password, as it allows you to assign specific permissions for increased security.
To verify you are able to access the UpCloud API, you can, for example, run upctl account show command to print your current balance and resource limits.
upctl account show\n
For usage examples, see the Examples section of the documentation.
For reference on how to use each sub-command, see the Commands reference section of the documentation. The same information is also available in --help output of each command.
Allow using unix style glob pattern as an argument. For example, if there are two servers available with titles server-1 and server-2, these servers can be stopped with upctl server stop server-* command.
--delete-buckets option to objectstorage delete command.
In objectstorage delete command, delete only user defined policies when --delete-policies flag is enabled as trying to delete system defined policy will cause an error.
Take server state into account in server completions. For example, do not offer started servers as completions for server start command.
Allow using UUID prefix as an argument. For example, if there is only one network available that has an UUID starting with 0316, details of that network can be listed with upctl network show 0316 command.
Match title and name arguments case-insensitively if the given parameter does not resolve with an exact match.
In storage modify, avoid segfault if the target storage does not have backup rule in the storage details. This would have happened, for example, when renaming private templates.
In server create command, use Ubuntu Server 24.04 LTS (Noble Numbat) as default value for --os. The new default template only supports SSH key based authentication. Use --ssh-keys option to provide the keys when creating a server with the default template.
In server create command, enable metadata service by default when the selected (or default) template uses cloud-init (template_type is cloud-init) and thus requires it.
Omit storage tier from server create payload to use plans default storage tier. This allows creating servers with developer plans that do not allow creating MaxIOPS storages with the server. Other plan types will continue to use MaxIOPS by default.
Support nested properties in database properties * and database properties * show * outputs. For example upctl max_background_workers sub-property of timescaledb PostgreSQL property is listed as timescaledb.max_background_workers in human output of database properties pg and its details can printed with upctl database properties pg show timescaledb.max_background_workers command.
Breaking: Update return type of kubernetes versions from list of strings to list of objects. (No major version bump, because this end-point has not been included in the API docs)
This release updates output of show and list commands to return the API response as defined in the UpCloud Go SDK. See below for detailed list of changes.
In addition, kubernetes create will now, by default, block all access to the cluster. To be able to connect to the cluster, define list of allowed IP addresses and/or CIDR blocks or allow access from any IP.
Breaking: Add --kubernetes-api-allow-ip argument to kubernetes create command. This changes default behavior from allow access from any IP to block access from all IPs. To be able to connect to the cluster, define list of allowed IP addresses and/or CIDR blocks or allow access from any IP.
Add Kubernetes API allowed IPs field to kubernetes show output.
Add kubernetes nodegroup show for displaying node-group details. This also adds Nodes table and Anti-affinity field that were not available in previous kubernetes show output.
Add kubernetes modify command for modifying IP addresses that are allowed to access cluster's Kubernetes API.
Add Kubernetes API allowed IPs field to kubernetes show output.
Add database session list for listing active database sessions.
Add database session cancel for cancelling an active database session.
Breaking: In JSON and YAML output of database list: return the full API response. Value of title is not replaced with value from name, if title is empty.
Breaking: In JSON and YAML output of database types: return the full API response. This changes the top level datatype from list to object, where keys are the available database type, e.g., pg and mysql.
Breaking: In JSON and YAML output of ip-address list: return the full API response. This changes partofplan key to part_of_plan and ptrrecord key to ptr_record. The top level data-type changes from list to object.
Breaking: In JSON and YAML output of loadbalancer list: return the full API response. This changes state field to operational_state.
Breaking: In JSON and YAML output of network list and network show: return the full API response. Servers list will only contain server UUID and name. In network list output, the top level data-type changes from list to object.
Breaking: In JSON and YAML output of server list and server show: return the full API response. This changes field host_id to host. nics is replaced with networking subfield interfaces. storage is replaced with storage_devices. labels contain subfield label which in turn contains the labels. In server list output, the top level data-type changes from list to object.
Breaking: In JSON and YAML output of server firewall show: return the full API response. This removes fields destination and source fields in favor of [destination|source]_address_start, [destination|source]_address_end, [destination|source]_port_start and [destination|source]_port_end.
Breaking: In JSON and YAML output of server plans: return the full API response. The top level data-type changes from list to object.
Breaking: In JSON and YAML output of storage list and storage show: return the full API response. This changes servers field to contain server field, which in turn contains the servers. labels field will not be outputted if empty. In storage list output, the top level data-type changes from list to object.
Breaking: In JSON and YAML output of zone list: return the full API response. The top level data-type changes from list to object.
In JSON and YAML output of kubernetes list: return the full API response.
In human readable output of kubernetes show command, show node-groups as table. Node-group details are available with kubernetes nodegroup show command.
Breaking: In JSON and YAML output of ip-address show: use same JSON keys as in API documentation. This removes credits key that was used in place of floating.
Added support for all shell completions provided by cobra.
Add database properties <DB type> command to list database properties for given database type and database properties <DB type> show command to show database property details.
Remove custom bash completion logic and replace it with completion command provided by cobra. To do this while supporting args with whitespace, whitespace in completions is replaced with non-breaking spaces.
Suppress positional argument filename completion for commands without specific completions.
In database list output: if database has no title, database name is displayed in the title cell instead of leaving the cell empty, similarly than in the hub.
Version information is parsed from BuildInfo when upctl binary was built without specifying -ldflags to define value for .../config.Version.
Use alpine as base image for upcloud/upctl container image. This adds sh and other OS tools to the image and thus makes it more suitable for usage in CI systems.
In human output of storage list: capitalize zone column header and color storage state similarly than in storage show.
In human output of storage import: output UUID of created storage, instead of storage import operation. No UUID is outputted if existing storage was used.
Breaking: Set non-zero exit code if command execution fails.
Breaking: Render servers IP addresses as array of objects, instead of previous pretty-printed string, in JSON and YAML outputs of server show.
Breaking: Use key names from json field tag also in YAML output to have equal key names in JSON and YAML outputs. For example, bootorder key in server details will now be boot_order also in YAML output. As a side-effect data-types are limited to those supported by JSON. For example, timestamps will be presented as (double-quoted) strings. In addition, if command targets multiple resources, YAML output will now be a list, similarly than in JSON output, instead of previous multiple YAML documents.
Breaking: In JSON and YAML output, storage show lists attached servers in servers list instead of server string.
Breaking: In JSON and YAML output, network show lists DHCP DNS values in list instead of string.
On network show, output server details as unknown instead of outputting an error, if fetching server details fails. This allows displaying network details for networks that contain a load balancer.
Progress logging to non TTY output uses now 100 as text width instead of 0.
On server create, mount OS disk by default on virtio bus. Previously default OS storage address was not explicit and varyed depending on template type.
Disable colors if user has set NO_COLOR environment variable to non-empty value.
Do not display usage if execution fails because of missing credentials
Mark error and warning livelogs finished when they will not be updated anymore: this stops the timer in the end of the row and stops livelog from refreshing these lines.
Include UUID (or address) of created resource in create command output
storage modify command now accepts enable-filesystem-autoresize flag. When that flag is set upctl will attempt to resize partition and filesystem after storage size has been modified.
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 and enable API access for these credentials. Define the credentials by setting UPCLOUD_USERNAME and UPCLOUD_PASSWORD environment variables. 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 username and password, as it allows you to assign specific permissions for increased security.
"},{"location":"commands_reference/upctl/#options","title":"Options","text":"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 upctlDefault: 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 (supported: json, yaml and human)Default: human"},{"location":"commands_reference/upctl/#related-commands","title":"Related commands","text":"Command Description upctl account Manage accounts 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 loadbalancer Manage load balancers upctl network Manage networks upctl networkpeering Manage network peerings upctl objectstorage Manage managed object storage services upctl partner Manage partner resources upctl router Manage routers upctl server Manage servers upctl servergroup Manage server groups upctl storage Manage storages upctl version Display software information upctl zone Display zone information"},{"location":"commands_reference/upctl_version/","title":"upctl version","text":"
"},{"location":"commands_reference/upctl_version/#options","title":"Options","text":"Option Description --help, -h help for versionDefault: false"},{"location":"commands_reference/upctl_version/#global-options","title":"Global options","text":"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. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output, -o Output format (supported: json, yaml and human)Default: human"},{"location":"commands_reference/upctl_version/#related-commands","title":"Related commands","text":"Command Description upctl UpCloud command-line interface"},{"location":"commands_reference/upctl_account/","title":"upctl account","text":"
Manage accounts
upctl account [flags]\n
"},{"location":"commands_reference/upctl_account/#options","title":"Options","text":"Option Description --help, -h help for accountDefault: false"},{"location":"commands_reference/upctl_account/#global-options","title":"Global options","text":"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. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output, -o Output format (supported: json, yaml and human)Default: human"},{"location":"commands_reference/upctl_account/#related-commands","title":"Related commands","text":"Command Description upctl UpCloud command-line interface upctl account delete Delete a sub-account upctl account list List sub-accounts upctl account permissions Manage permissions upctl account show Show account"},{"location":"commands_reference/upctl_account/delete/","title":"upctl account delete","text":"
"},{"location":"commands_reference/upctl_account/delete/#options","title":"Options","text":"Option Description --help, -h help for deleteDefault: false"},{"location":"commands_reference/upctl_account/delete/#global-options","title":"Global options","text":"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. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output, -o Output format (supported: json, yaml and human)Default: human"},{"location":"commands_reference/upctl_account/delete/#related-commands","title":"Related commands","text":"Command Description upctl account Manage accounts"},{"location":"commands_reference/upctl_account/list/","title":"upctl account list","text":"
"},{"location":"commands_reference/upctl_account/list/#options","title":"Options","text":"Option Description --help, -h help for listDefault: false"},{"location":"commands_reference/upctl_account/list/#global-options","title":"Global options","text":"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. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output, -o Output format (supported: json, yaml and human)Default: human"},{"location":"commands_reference/upctl_account/list/#related-commands","title":"Related commands","text":"Command Description upctl account Manage accounts"},{"location":"commands_reference/upctl_account/show/","title":"upctl account show","text":"
"},{"location":"commands_reference/upctl_account/show/#options","title":"Options","text":"Option Description --help, -h help for showDefault: false"},{"location":"commands_reference/upctl_account/show/#global-options","title":"Global options","text":"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. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output, -o Output format (supported: json, yaml and human)Default: human"},{"location":"commands_reference/upctl_account/show/#related-commands","title":"Related commands","text":"Command Description upctl account Manage accounts"},{"location":"commands_reference/upctl_account/permissions/","title":"upctl account permissions","text":"
Manage permissions
upctl account permissions [flags]\n
"},{"location":"commands_reference/upctl_account/permissions/#options","title":"Options","text":"Option Description --help, -h help for permissionsDefault: false"},{"location":"commands_reference/upctl_account/permissions/#global-options","title":"Global options","text":"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. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output, -o Output format (supported: json, yaml and human)Default: human"},{"location":"commands_reference/upctl_account/permissions/#related-commands","title":"Related commands","text":"Command Description upctl account Manage accounts upctl account permissions list List permissions"},{"location":"commands_reference/upctl_account/permissions/list/","title":"upctl account permissions list","text":"
"},{"location":"commands_reference/upctl_account/permissions/list/#options","title":"Options","text":"Option Description --username Filter permissions by username. --help, -h help for listDefault: false"},{"location":"commands_reference/upctl_account/permissions/list/#global-options","title":"Global options","text":"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. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output, -o Output format (supported: json, yaml and human)Default: human"},{"location":"commands_reference/upctl_account/permissions/list/#related-commands","title":"Related commands","text":"Command Description upctl account permissions Manage permissions"},{"location":"commands_reference/upctl_database/","title":"upctl database","text":"
"},{"location":"commands_reference/upctl_database/#options","title":"Options","text":"Option Description --help, -h help for databaseDefault: false"},{"location":"commands_reference/upctl_database/#global-options","title":"Global options","text":"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. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output, -o Output format (supported: json, yaml and human)Default: human"},{"location":"commands_reference/upctl_database/#related-commands","title":"Related commands","text":"Command Description upctl UpCloud command-line interface upctl database delete Delete a database upctl database index Manage database indices upctl database list List current databases upctl database plans List available plans for given database type upctl database properties List available properties for given database type upctl database session Manage database sessions upctl database show Show database details upctl database start Start on a managed database upctl database stop Stop a managed database upctl database types List available database types"},{"location":"commands_reference/upctl_database/delete/","title":"upctl database delete","text":"
"},{"location":"commands_reference/upctl_database/delete/#options","title":"Options","text":"Option Description --help, -h help for deleteDefault: false"},{"location":"commands_reference/upctl_database/delete/#global-options","title":"Global options","text":"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. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output, -o Output format (supported: json, yaml and human)Default: human"},{"location":"commands_reference/upctl_database/delete/#related-commands","title":"Related commands","text":"Command Description upctl database Manage databases"},{"location":"commands_reference/upctl_database/list/","title":"upctl database list","text":"
"},{"location":"commands_reference/upctl_database/list/#options","title":"Options","text":"Option Description --limit Number of entries to receive at most.Default: 100--page Page number to calculate first item to receive. Page numbers start from 1.Default: 0--help, -h help for listDefault: false"},{"location":"commands_reference/upctl_database/list/#global-options","title":"Global options","text":"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. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output, -o Output format (supported: json, yaml and human)Default: human"},{"location":"commands_reference/upctl_database/list/#related-commands","title":"Related commands","text":"Command Description upctl database Manage databases"},{"location":"commands_reference/upctl_database/plans/","title":"upctl database plans","text":"
"},{"location":"commands_reference/upctl_database/plans/#options","title":"Options","text":"Option Description --help, -h help for plansDefault: false"},{"location":"commands_reference/upctl_database/plans/#global-options","title":"Global options","text":"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. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output, -o Output format (supported: json, yaml and human)Default: human"},{"location":"commands_reference/upctl_database/plans/#related-commands","title":"Related commands","text":"Command Description upctl database Manage databases"},{"location":"commands_reference/upctl_database/show/","title":"upctl database show","text":"
upctl database show 9a8effcb-80e6-4a63-a7e5-066a6d093c14\nupctl database show my-pg-database\nupctl database show my-mysql-database\n
"},{"location":"commands_reference/upctl_database/show/#options","title":"Options","text":"Option Description --help, -h help for showDefault: false"},{"location":"commands_reference/upctl_database/show/#global-options","title":"Global options","text":"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. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output, -o Output format (supported: json, yaml and human)Default: human"},{"location":"commands_reference/upctl_database/show/#related-commands","title":"Related commands","text":"Command Description upctl database Manage databases"},{"location":"commands_reference/upctl_database/start/","title":"upctl database start","text":"
"},{"location":"commands_reference/upctl_database/start/#options","title":"Options","text":"Option Description --help, -h help for startDefault: false"},{"location":"commands_reference/upctl_database/start/#global-options","title":"Global options","text":"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. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output, -o Output format (supported: json, yaml and human)Default: human"},{"location":"commands_reference/upctl_database/start/#related-commands","title":"Related commands","text":"Command Description upctl database Manage databases"},{"location":"commands_reference/upctl_database/stop/","title":"upctl database stop","text":"
"},{"location":"commands_reference/upctl_database/stop/#options","title":"Options","text":"Option Description --help, -h help for stopDefault: false"},{"location":"commands_reference/upctl_database/stop/#global-options","title":"Global options","text":"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. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output, -o Output format (supported: json, yaml and human)Default: human"},{"location":"commands_reference/upctl_database/stop/#related-commands","title":"Related commands","text":"Command Description upctl database Manage databases"},{"location":"commands_reference/upctl_database/types/","title":"upctl database types","text":"
"},{"location":"commands_reference/upctl_database/types/#options","title":"Options","text":"Option Description --help, -h help for typesDefault: false"},{"location":"commands_reference/upctl_database/types/#global-options","title":"Global options","text":"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. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output, -o Output format (supported: json, yaml and human)Default: human"},{"location":"commands_reference/upctl_database/types/#related-commands","title":"Related commands","text":"Command Description upctl database Manage databases"},{"location":"commands_reference/upctl_database/index/","title":"upctl database index","text":"
"},{"location":"commands_reference/upctl_database/index/#options","title":"Options","text":"Option Description --help, -h help for indexDefault: false"},{"location":"commands_reference/upctl_database/index/#global-options","title":"Global options","text":"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. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output, -o Output format (supported: json, yaml and human)Default: human"},{"location":"commands_reference/upctl_database/index/#related-commands","title":"Related commands","text":"Command Description upctl database Manage databases upctl database index delete Delete an index from the specified database. upctl database index list List current indices of the specified databases"},{"location":"commands_reference/upctl_database/index/delete/","title":"upctl database index delete","text":"
Delete an index from the specified database.
upctl database index delete <UUID/Title...> [flags]\n
upctl database index delete 55199a44-4751-4e27-9394-7c7661910be3 --name .index-to-delete\n
"},{"location":"commands_reference/upctl_database/index/delete/#options","title":"Options","text":"Option Description --name Index name --help, -h help for deleteDefault: false"},{"location":"commands_reference/upctl_database/index/delete/#global-options","title":"Global options","text":"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. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output, -o Output format (supported: json, yaml and human)Default: human"},{"location":"commands_reference/upctl_database/index/delete/#related-commands","title":"Related commands","text":"Command Description upctl database index Manage database indices"},{"location":"commands_reference/upctl_database/index/list/","title":"upctl database index list","text":"
List current indices of the specified databases
upctl database index list <UUID/Title...> [flags]\n
upctl database index list 55199a44-4751-4e27-9394-7c7661910be3\n
"},{"location":"commands_reference/upctl_database/index/list/#options","title":"Options","text":"Option Description --help, -h help for listDefault: false"},{"location":"commands_reference/upctl_database/index/list/#global-options","title":"Global options","text":"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. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output, -o Output format (supported: json, yaml and human)Default: human"},{"location":"commands_reference/upctl_database/index/list/#related-commands","title":"Related commands","text":"Command Description upctl database index Manage database indices"},{"location":"commands_reference/upctl_database/properties/","title":"upctl database properties","text":"
"},{"location":"commands_reference/upctl_database/properties/#options","title":"Options","text":"Option Description --help, -h help for propertiesDefault: false"},{"location":"commands_reference/upctl_database/properties/#global-options","title":"Global options","text":"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. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output, -o Output format (supported: json, yaml and human)Default: human"},{"location":"commands_reference/upctl_database/properties/#related-commands","title":"Related commands","text":"Command Description upctl database Manage databases upctl database properties mysql List available properties for MySQL databases upctl database properties opensearch List available properties for OpenSearch databases upctl database properties pg List available properties for PostgreSQL databases upctl database properties redis List available properties for Redis databases upctl database properties valkey List available properties for Valkey databases"},{"location":"commands_reference/upctl_database/properties/mysql/","title":"upctl database properties mysql","text":"
"},{"location":"commands_reference/upctl_database/properties/mysql/#options","title":"Options","text":"Option Description --help, -h help for mysqlDefault: false"},{"location":"commands_reference/upctl_database/properties/mysql/#global-options","title":"Global options","text":"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. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output, -o Output format (supported: json, yaml and human)Default: human"},{"location":"commands_reference/upctl_database/properties/mysql/#related-commands","title":"Related commands","text":"Command Description upctl database properties List available properties for given database type upctl database properties mysql show Show MySQL database property details"},{"location":"commands_reference/upctl_database/properties/mysql/show/","title":"upctl database properties mysql show","text":"
"},{"location":"commands_reference/upctl_database/properties/mysql/show/#options","title":"Options","text":"Option Description --help, -h help for showDefault: false"},{"location":"commands_reference/upctl_database/properties/mysql/show/#global-options","title":"Global options","text":"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. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output, -o Output format (supported: json, yaml and human)Default: human"},{"location":"commands_reference/upctl_database/properties/mysql/show/#related-commands","title":"Related commands","text":"Command Description upctl database properties mysql List available properties for MySQL databases"},{"location":"commands_reference/upctl_database/properties/opensearch/","title":"upctl database properties opensearch","text":"
List available properties for OpenSearch databases
"},{"location":"commands_reference/upctl_database/properties/opensearch/#options","title":"Options","text":"Option Description --help, -h help for opensearchDefault: false"},{"location":"commands_reference/upctl_database/properties/opensearch/#global-options","title":"Global options","text":"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. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output, -o Output format (supported: json, yaml and human)Default: human"},{"location":"commands_reference/upctl_database/properties/opensearch/#related-commands","title":"Related commands","text":"Command Description upctl database properties List available properties for given database type upctl database properties opensearch show Show OpenSearch database property details"},{"location":"commands_reference/upctl_database/properties/opensearch/show/","title":"upctl database properties opensearch show","text":"
Show OpenSearch database property details
upctl database properties opensearch show [flags]\n
upctl database properties opensearch show version\n
"},{"location":"commands_reference/upctl_database/properties/opensearch/show/#options","title":"Options","text":"Option Description --help, -h help for showDefault: false"},{"location":"commands_reference/upctl_database/properties/opensearch/show/#global-options","title":"Global options","text":"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. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output, -o Output format (supported: json, yaml and human)Default: human"},{"location":"commands_reference/upctl_database/properties/opensearch/show/#related-commands","title":"Related commands","text":"Command Description upctl database properties opensearch List available properties for OpenSearch databases"},{"location":"commands_reference/upctl_database/properties/pg/","title":"upctl database properties pg","text":"
List available properties for PostgreSQL databases
"},{"location":"commands_reference/upctl_database/properties/pg/#options","title":"Options","text":"Option Description --help, -h help for pgDefault: false"},{"location":"commands_reference/upctl_database/properties/pg/#global-options","title":"Global options","text":"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. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output, -o Output format (supported: json, yaml and human)Default: human"},{"location":"commands_reference/upctl_database/properties/pg/#related-commands","title":"Related commands","text":"Command Description upctl database properties List available properties for given database type upctl database properties pg show Show PostgreSQL database property details"},{"location":"commands_reference/upctl_database/properties/pg/show/","title":"upctl database properties pg show","text":"
"},{"location":"commands_reference/upctl_database/properties/pg/show/#options","title":"Options","text":"Option Description --help, -h help for showDefault: false"},{"location":"commands_reference/upctl_database/properties/pg/show/#global-options","title":"Global options","text":"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. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output, -o Output format (supported: json, yaml and human)Default: human"},{"location":"commands_reference/upctl_database/properties/pg/show/#related-commands","title":"Related commands","text":"Command Description upctl database properties pg List available properties for PostgreSQL databases"},{"location":"commands_reference/upctl_database/properties/redis/","title":"upctl database properties redis","text":"
"},{"location":"commands_reference/upctl_database/properties/redis/#options","title":"Options","text":"Option Description --help, -h help for redisDefault: false"},{"location":"commands_reference/upctl_database/properties/redis/#global-options","title":"Global options","text":"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. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output, -o Output format (supported: json, yaml and human)Default: human"},{"location":"commands_reference/upctl_database/properties/redis/#related-commands","title":"Related commands","text":"Command Description upctl database properties List available properties for given database type upctl database properties redis show Show Redis database property details"},{"location":"commands_reference/upctl_database/properties/redis/show/","title":"upctl database properties redis show","text":"
"},{"location":"commands_reference/upctl_database/properties/redis/show/#options","title":"Options","text":"Option Description --help, -h help for showDefault: false"},{"location":"commands_reference/upctl_database/properties/redis/show/#global-options","title":"Global options","text":"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. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output, -o Output format (supported: json, yaml and human)Default: human"},{"location":"commands_reference/upctl_database/properties/redis/show/#related-commands","title":"Related commands","text":"Command Description upctl database properties redis List available properties for Redis databases"},{"location":"commands_reference/upctl_database/properties/valkey/","title":"upctl database properties valkey","text":"
"},{"location":"commands_reference/upctl_database/properties/valkey/#options","title":"Options","text":"Option Description --help, -h help for valkeyDefault: false"},{"location":"commands_reference/upctl_database/properties/valkey/#global-options","title":"Global options","text":"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. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output, -o Output format (supported: json, yaml and human)Default: human"},{"location":"commands_reference/upctl_database/properties/valkey/#related-commands","title":"Related commands","text":"Command Description upctl database properties List available properties for given database type upctl database properties valkey show Show Valkey database property details"},{"location":"commands_reference/upctl_database/properties/valkey/show/","title":"upctl database properties valkey show","text":"
"},{"location":"commands_reference/upctl_database/properties/valkey/show/#options","title":"Options","text":"Option Description --help, -h help for showDefault: false"},{"location":"commands_reference/upctl_database/properties/valkey/show/#global-options","title":"Global options","text":"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. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output, -o Output format (supported: json, yaml and human)Default: human"},{"location":"commands_reference/upctl_database/properties/valkey/show/#related-commands","title":"Related commands","text":"Command Description upctl database properties valkey List available properties for Valkey databases"},{"location":"commands_reference/upctl_database/session/","title":"upctl database session","text":"
Manage database sessions
upctl database session [flags]\n
"},{"location":"commands_reference/upctl_database/session/#options","title":"Options","text":"Option Description --help, -h help for sessionDefault: false"},{"location":"commands_reference/upctl_database/session/#global-options","title":"Global options","text":"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. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output, -o Output format (supported: json, yaml and human)Default: human"},{"location":"commands_reference/upctl_database/session/#related-commands","title":"Related commands","text":"Command Description upctl database Manage databases upctl database session cancel Terminate client session or cancel running query for a database upctl database session list List current sessions to specified database"},{"location":"commands_reference/upctl_database/session/cancel/","title":"upctl database session cancel","text":"
Terminate client session or cancel running query for a database
"},{"location":"commands_reference/upctl_database/session/cancel/#options","title":"Options","text":"Option Description --pid Process ID of the session to cancel.Default: 0--terminate Request immediate termination instead of soft cancel. --help, -h help for cancelDefault: false"},{"location":"commands_reference/upctl_database/session/cancel/#global-options","title":"Global options","text":"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. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output, -o Output format (supported: json, yaml and human)Default: human"},{"location":"commands_reference/upctl_database/session/cancel/#related-commands","title":"Related commands","text":"Command Description upctl database session Manage database sessions"},{"location":"commands_reference/upctl_database/session/list/","title":"upctl database session list","text":"
List current sessions to specified database
upctl database session list <UUID/Title...> [flags]\n
upctl database session list 0fa980c4-0e4f-460b-9869-11b7bd62b832\nupctl database session list mysql-1 --limit 16 --offset 32 --order pid:desc\n
"},{"location":"commands_reference/upctl_database/session/list/#options","title":"Options","text":"Option Description --limit Number of entries to receive at most.Default: 10--offset Offset for retrieved results based on sort order.Default: 0--order Key and direction for sorting.Default: query_duration:desc--help, -h help for listDefault: false"},{"location":"commands_reference/upctl_database/session/list/#global-options","title":"Global options","text":"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. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output, -o Output format (supported: json, yaml and human)Default: human"},{"location":"commands_reference/upctl_database/session/list/#related-commands","title":"Related commands","text":"Command Description upctl database session Manage database sessions"},{"location":"commands_reference/upctl_gateway/","title":"upctl gateway","text":"
Manage gateways
upctl gateway [flags]\n
"},{"location":"commands_reference/upctl_gateway/#options","title":"Options","text":"Option Description --help, -h help for gatewayDefault: false"},{"location":"commands_reference/upctl_gateway/#global-options","title":"Global options","text":"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. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output, -o Output format (supported: json, yaml and human)Default: human"},{"location":"commands_reference/upctl_gateway/#related-commands","title":"Related commands","text":"Command Description upctl UpCloud command-line interface upctl gateway delete Delete a gateway upctl gateway list List gateways upctl gateway plans List gateway plans"},{"location":"commands_reference/upctl_gateway/delete/","title":"upctl gateway delete","text":"
"},{"location":"commands_reference/upctl_gateway/delete/#options","title":"Options","text":"Option Description --help, -h help for deleteDefault: false"},{"location":"commands_reference/upctl_gateway/delete/#global-options","title":"Global options","text":"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. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output, -o Output format (supported: json, yaml and human)Default: human"},{"location":"commands_reference/upctl_gateway/delete/#related-commands","title":"Related commands","text":"Command Description upctl gateway Manage gateways"},{"location":"commands_reference/upctl_gateway/list/","title":"upctl gateway list","text":"
"},{"location":"commands_reference/upctl_gateway/list/#options","title":"Options","text":"Option Description --limit Number of entries to receive at most.Default: 100--page Page number to calculate first item to receive. Page numbers start from 1.Default: 0--help, -h help for listDefault: false"},{"location":"commands_reference/upctl_gateway/list/#global-options","title":"Global options","text":"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. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output, -o Output format (supported: json, yaml and human)Default: human"},{"location":"commands_reference/upctl_gateway/list/#related-commands","title":"Related commands","text":"Command Description upctl gateway Manage gateways"},{"location":"commands_reference/upctl_gateway/plans/","title":"upctl gateway plans","text":"
"},{"location":"commands_reference/upctl_gateway/plans/#options","title":"Options","text":"Option Description --help, -h help for plansDefault: false"},{"location":"commands_reference/upctl_gateway/plans/#global-options","title":"Global options","text":"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. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output, -o Output format (supported: json, yaml and human)Default: human"},{"location":"commands_reference/upctl_gateway/plans/#related-commands","title":"Related commands","text":"Command Description upctl gateway Manage gateways"},{"location":"commands_reference/upctl_host/","title":"upctl host","text":"
Manage private cloud hosts
upctl host [flags]\n
"},{"location":"commands_reference/upctl_host/#options","title":"Options","text":"Option Description --help, -h help for hostDefault: false"},{"location":"commands_reference/upctl_host/#global-options","title":"Global options","text":"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. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output, -o Output format (supported: json, yaml and human)Default: human"},{"location":"commands_reference/upctl_host/#related-commands","title":"Related commands","text":"Command Description upctl UpCloud command-line interface upctl host list List private cloud hosts"},{"location":"commands_reference/upctl_host/list/","title":"upctl host list","text":"
"},{"location":"commands_reference/upctl_host/list/#options","title":"Options","text":"Option Description --help, -h help for listDefault: false"},{"location":"commands_reference/upctl_host/list/#global-options","title":"Global options","text":"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. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output, -o Output format (supported: json, yaml and human)Default: human"},{"location":"commands_reference/upctl_host/list/#related-commands","title":"Related commands","text":"Command Description upctl host Manage private cloud hosts"},{"location":"commands_reference/upctl_ip-address/","title":"upctl ip-address","text":"
"},{"location":"commands_reference/upctl_ip-address/#options","title":"Options","text":"Option Description --help, -h help for ip-addressDefault: false"},{"location":"commands_reference/upctl_ip-address/#global-options","title":"Global options","text":"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. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output, -o Output format (supported: json, yaml and human)Default: human"},{"location":"commands_reference/upctl_ip-address/#related-commands","title":"Related commands","text":"Command Description upctl UpCloud command-line interface upctl ip-address assign Assign or create an IP address upctl ip-address list List IP addresses upctl ip-address modify Modify an IP address upctl ip-address remove Remove an IP address upctl ip-address show Show current IP address"},{"location":"commands_reference/upctl_ip-address/assign/","title":"upctl ip-address assign","text":"
"},{"location":"commands_reference/upctl_ip-address/assign/#options","title":"Options","text":"Option Description --access Is address for utility or public network.Default: public--family The address family of new IP address.Default: IPv4--server The server the ip address is assigned to. --mac MAC address of server interface to assign address to. Required for detached floating IP address if zone is not specified. --zone Zone where to create the IP address. Run upctl zone list to list all available zones. Required when creating a detached floating IP address, i.e. when MAC address is not specified. --floating Whether the address to be assigned is a floating one. --help, -h help for assignDefault: false"},{"location":"commands_reference/upctl_ip-address/assign/#global-options","title":"Global options","text":"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. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output, -o Output format (supported: json, yaml and human)Default: human"},{"location":"commands_reference/upctl_ip-address/assign/#related-commands","title":"Related commands","text":"Command Description upctl ip-address Manage IP addresses"},{"location":"commands_reference/upctl_ip-address/list/","title":"upctl ip-address list","text":"
"},{"location":"commands_reference/upctl_ip-address/list/#options","title":"Options","text":"Option Description --help, -h help for listDefault: false"},{"location":"commands_reference/upctl_ip-address/list/#global-options","title":"Global options","text":"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. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output, -o Output format (supported: json, yaml and human)Default: human"},{"location":"commands_reference/upctl_ip-address/list/#related-commands","title":"Related commands","text":"Command Description upctl ip-address Manage IP addresses"},{"location":"commands_reference/upctl_ip-address/modify/","title":"upctl ip-address modify","text":"
"},{"location":"commands_reference/upctl_ip-address/modify/#options","title":"Options","text":"Option Description --mac MAC address of server interface to attach floating IP to. --ptr-record New fully qualified domain name to set as the PTR record for the IP address. --help, -h help for modifyDefault: false"},{"location":"commands_reference/upctl_ip-address/modify/#global-options","title":"Global options","text":"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. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output, -o Output format (supported: json, yaml and human)Default: human"},{"location":"commands_reference/upctl_ip-address/modify/#related-commands","title":"Related commands","text":"Command Description upctl ip-address Manage IP addresses"},{"location":"commands_reference/upctl_ip-address/remove/","title":"upctl ip-address remove","text":"
"},{"location":"commands_reference/upctl_ip-address/remove/#options","title":"Options","text":"Option Description --help, -h help for removeDefault: false"},{"location":"commands_reference/upctl_ip-address/remove/#global-options","title":"Global options","text":"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. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output, -o Output format (supported: json, yaml and human)Default: human"},{"location":"commands_reference/upctl_ip-address/remove/#related-commands","title":"Related commands","text":"Command Description upctl ip-address Manage IP addresses"},{"location":"commands_reference/upctl_ip-address/show/","title":"upctl ip-address show","text":"
Show current IP address
upctl ip-address show <Address/PTRRecord...> [flags]\n
upctl ip-address show 185.70.196.47\nupctl ip-address show 2a04:3544:8000:1000:d40e:4aff:fe6f:5d34\n
"},{"location":"commands_reference/upctl_ip-address/show/#options","title":"Options","text":"Option Description --help, -h help for showDefault: false"},{"location":"commands_reference/upctl_ip-address/show/#global-options","title":"Global options","text":"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. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output, -o Output format (supported: json, yaml and human)Default: human"},{"location":"commands_reference/upctl_ip-address/show/#related-commands","title":"Related commands","text":"Command Description upctl ip-address Manage IP addresses"},{"location":"commands_reference/upctl_kubernetes/","title":"upctl kubernetes","text":"
"},{"location":"commands_reference/upctl_kubernetes/#options","title":"Options","text":"Option Description --help, -h help for kubernetesDefault: false"},{"location":"commands_reference/upctl_kubernetes/#global-options","title":"Global options","text":"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. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output, -o Output format (supported: json, yaml and human)Default: human"},{"location":"commands_reference/upctl_kubernetes/#related-commands","title":"Related commands","text":"Command Description upctl UpCloud command-line interface upctl kubernetes config Output Kubernetes cluster kubeconfig upctl kubernetes create Create a Kubernetes cluster upctl kubernetes delete Delete a Kubernetes cluster upctl kubernetes list List current Kubernetes clusters upctl kubernetes modify Modify an existing cluster upctl kubernetes nodegroup Manage cluster node-groups upctl kubernetes plans List available cluster plans upctl kubernetes show Show Kubernetes cluster details upctl kubernetes versions List available versions for Kubernetes clusters"},{"location":"commands_reference/upctl_kubernetes/config/","title":"upctl kubernetes config","text":"
"},{"location":"commands_reference/upctl_kubernetes/config/#options","title":"Options","text":"Option Description --write Absolute path for writing output. If the file exists, the config will be merged. --help, -h help for configDefault: false"},{"location":"commands_reference/upctl_kubernetes/config/#global-options","title":"Global options","text":"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. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output, -o Output format (supported: json, yaml and human)Default: human"},{"location":"commands_reference/upctl_kubernetes/config/#related-commands","title":"Related commands","text":"Command Description upctl kubernetes Manage Kubernetes clusters"},{"location":"commands_reference/upctl_kubernetes/create/","title":"upctl kubernetes create","text":"
"},{"location":"commands_reference/upctl_kubernetes/create/#options","title":"Options","text":"Option Description --name Kubernetes cluster name. --label Labels to describe the cluster in key=value format, multiple can be declared.Default: []--plan Plan to use for the cluster. Run upctl kubernetes plans to list all available plans.Default: development--version Identifier of the version of Kubernetes to use when creating the cluster. Run upctl kubernetes versions to list all available versions. --network Network to use. The value should be name or UUID of a private network. --node-group Node group(s) for running workloads, multiple can be declared.Usage: --node-group count=8,kubelet-arg=\"log-flush-frequency=5s\",label=\"owner=devteam\",label=\"env=dev\",name=my-node-group,plan=2xCPU-4GB,ssh-key=\"ssh-ed25519 AAAAo admin@user.com\",ssh-key=\"/path/to/your/public/ssh/key.pub\",storage=01000000-0000-4000-8000-000160010100,taint=\"env=dev:NoSchedule\",taint=\"env=dev2:NoSchedule\"Default: []--kubernetes-api-allow-ip Allow cluster's Kubernetes API to be accessed from an IP address or a network CIDR, multiple can be declared.Default: []--private-node-groups Do not assign public IPs to worker nodes. If set, the attached network should have a NAT gateway configured to provide internet access to the worker nodes. --zone Zone where to create the cluster. Run upctl zone list to list all available zones. --wait Wait for cluster to be in running state before returning. --help, -h help for createDefault: false"},{"location":"commands_reference/upctl_kubernetes/create/#global-options","title":"Global options","text":"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. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output, -o Output format (supported: json, yaml and human)Default: human"},{"location":"commands_reference/upctl_kubernetes/create/#related-commands","title":"Related commands","text":"Command Description upctl kubernetes Manage Kubernetes clusters"},{"location":"commands_reference/upctl_kubernetes/delete/","title":"upctl kubernetes delete","text":"
"},{"location":"commands_reference/upctl_kubernetes/delete/#options","title":"Options","text":"Option Description --help, -h help for deleteDefault: false"},{"location":"commands_reference/upctl_kubernetes/delete/#global-options","title":"Global options","text":"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. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output, -o Output format (supported: json, yaml and human)Default: human"},{"location":"commands_reference/upctl_kubernetes/delete/#related-commands","title":"Related commands","text":"Command Description upctl kubernetes Manage Kubernetes clusters"},{"location":"commands_reference/upctl_kubernetes/list/","title":"upctl kubernetes list","text":"
"},{"location":"commands_reference/upctl_kubernetes/list/#options","title":"Options","text":"Option Description --help, -h help for listDefault: false"},{"location":"commands_reference/upctl_kubernetes/list/#global-options","title":"Global options","text":"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. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output, -o Output format (supported: json, yaml and human)Default: human"},{"location":"commands_reference/upctl_kubernetes/list/#related-commands","title":"Related commands","text":"Command Description upctl kubernetes Manage Kubernetes clusters"},{"location":"commands_reference/upctl_kubernetes/modify/","title":"upctl kubernetes modify","text":"
"},{"location":"commands_reference/upctl_kubernetes/modify/#options","title":"Options","text":"Option Description --kubernetes-api-allow-ip Allow cluster's Kubernetes API to be accessed from an IP address or a network CIDR, multiple can be declared.Default: []--label Labels to describe the cluster in key=value format, multiple can be declared.Default: []--clear-labels Clear all labels from to given cluster. --help, -h help for modifyDefault: false"},{"location":"commands_reference/upctl_kubernetes/modify/#global-options","title":"Global options","text":"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. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output, -o Output format (supported: json, yaml and human)Default: human"},{"location":"commands_reference/upctl_kubernetes/modify/#related-commands","title":"Related commands","text":"Command Description upctl kubernetes Manage Kubernetes clusters"},{"location":"commands_reference/upctl_kubernetes/plans/","title":"upctl kubernetes plans","text":"
"},{"location":"commands_reference/upctl_kubernetes/plans/#options","title":"Options","text":"Option Description --help, -h help for plansDefault: false"},{"location":"commands_reference/upctl_kubernetes/plans/#global-options","title":"Global options","text":"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. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output, -o Output format (supported: json, yaml and human)Default: human"},{"location":"commands_reference/upctl_kubernetes/plans/#related-commands","title":"Related commands","text":"Command Description upctl kubernetes Manage Kubernetes clusters"},{"location":"commands_reference/upctl_kubernetes/show/","title":"upctl kubernetes show","text":"
upctl kubernetes show 55199a44-4751-4e27-9394-7c7661910be3\nupctl kubernetes show my-cluster\n
"},{"location":"commands_reference/upctl_kubernetes/show/#options","title":"Options","text":"Option Description --help, -h help for showDefault: false"},{"location":"commands_reference/upctl_kubernetes/show/#global-options","title":"Global options","text":"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. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output, -o Output format (supported: json, yaml and human)Default: human"},{"location":"commands_reference/upctl_kubernetes/show/#related-commands","title":"Related commands","text":"Command Description upctl kubernetes Manage Kubernetes clusters"},{"location":"commands_reference/upctl_kubernetes/versions/","title":"upctl kubernetes versions","text":"
"},{"location":"commands_reference/upctl_kubernetes/versions/#options","title":"Options","text":"Option Description --help, -h help for versionsDefault: false"},{"location":"commands_reference/upctl_kubernetes/versions/#global-options","title":"Global options","text":"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. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output, -o Output format (supported: json, yaml and human)Default: human"},{"location":"commands_reference/upctl_kubernetes/versions/#related-commands","title":"Related commands","text":"Command Description upctl kubernetes Manage Kubernetes clusters"},{"location":"commands_reference/upctl_kubernetes/nodegroup/","title":"upctl kubernetes nodegroup","text":"
"},{"location":"commands_reference/upctl_kubernetes/nodegroup/#options","title":"Options","text":"Option Description --help, -h help for nodegroupDefault: false"},{"location":"commands_reference/upctl_kubernetes/nodegroup/#global-options","title":"Global options","text":"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. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output, -o Output format (supported: json, yaml and human)Default: human"},{"location":"commands_reference/upctl_kubernetes/nodegroup/#related-commands","title":"Related commands","text":"Command Description upctl kubernetes Manage Kubernetes clusters upctl kubernetes nodegroup create Create a new node group into the specified cluster. upctl kubernetes nodegroup delete Delete the node group from the cluster. upctl kubernetes nodegroup scale Scale the number of nodes in the node group. upctl kubernetes nodegroup show Show node group details"},{"location":"commands_reference/upctl_kubernetes/nodegroup/create/","title":"upctl kubernetes nodegroup create","text":"
Create a new node group into the specified cluster.
"},{"location":"commands_reference/upctl_kubernetes/nodegroup/create/#options","title":"Options","text":"Option Description --count Number of nodes in the node groupDefault: 0--kubelet-arg Arguments to use when executing kubelet in argument=value formatDefault: []--label Labels to describe the nodes in key=value format. Use multiple times to define multiple labels. Labels are forwarded to the kubernetes nodes.Default: []--name Node group name --plan Server plan to use for nodes in the node group. Run upctl server plans to list all available plans. --ssh-key SSH keys to be configured as authorized keys to the nodes.Default: []--storage Storage template to use when creating the nodes. Defaults to UpCloud K8s public template. --taint Taints to be configured to the nodes in key=value:effect formatDefault: []--disable-utility-network-access Disable utility network access. If disabled, nodes in this group will not have access to utility network. --help, -h help for createDefault: false"},{"location":"commands_reference/upctl_kubernetes/nodegroup/create/#global-options","title":"Global options","text":"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. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output, -o Output format (supported: json, yaml and human)Default: human"},{"location":"commands_reference/upctl_kubernetes/nodegroup/create/#related-commands","title":"Related commands","text":"Command Description upctl kubernetes nodegroup Manage cluster node-groups"},{"location":"commands_reference/upctl_kubernetes/nodegroup/delete/","title":"upctl kubernetes nodegroup delete","text":"
"},{"location":"commands_reference/upctl_kubernetes/nodegroup/delete/#options","title":"Options","text":"Option Description --name Node group name --help, -h help for deleteDefault: false"},{"location":"commands_reference/upctl_kubernetes/nodegroup/delete/#global-options","title":"Global options","text":"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. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output, -o Output format (supported: json, yaml and human)Default: human"},{"location":"commands_reference/upctl_kubernetes/nodegroup/delete/#related-commands","title":"Related commands","text":"Command Description upctl kubernetes nodegroup Manage cluster node-groups"},{"location":"commands_reference/upctl_kubernetes/nodegroup/scale/","title":"upctl kubernetes nodegroup scale","text":"
"},{"location":"commands_reference/upctl_kubernetes/nodegroup/scale/#options","title":"Options","text":"Option Description --name Node group name --count Node countDefault: 0--help, -h help for scaleDefault: false"},{"location":"commands_reference/upctl_kubernetes/nodegroup/scale/#global-options","title":"Global options","text":"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. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output, -o Output format (supported: json, yaml and human)Default: human"},{"location":"commands_reference/upctl_kubernetes/nodegroup/scale/#related-commands","title":"Related commands","text":"Command Description upctl kubernetes nodegroup Manage cluster node-groups"},{"location":"commands_reference/upctl_kubernetes/nodegroup/show/","title":"upctl kubernetes nodegroup show","text":"
Show node group details
upctl kubernetes nodegroup show <UUID/Name...> [flags]\n
upctl kubernetes nodegroup show 55199a44-4751-4e27-9394-7c7661910be3 --name default\n
"},{"location":"commands_reference/upctl_kubernetes/nodegroup/show/#options","title":"Options","text":"Option Description --name Node group name --help, -h help for showDefault: false"},{"location":"commands_reference/upctl_kubernetes/nodegroup/show/#global-options","title":"Global options","text":"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. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output, -o Output format (supported: json, yaml and human)Default: human"},{"location":"commands_reference/upctl_kubernetes/nodegroup/show/#related-commands","title":"Related commands","text":"Command Description upctl kubernetes nodegroup Manage cluster node-groups"},{"location":"commands_reference/upctl_loadbalancer/","title":"upctl loadbalancer","text":"
"},{"location":"commands_reference/upctl_loadbalancer/#options","title":"Options","text":"Option Description --help, -h help for loadbalancerDefault: false"},{"location":"commands_reference/upctl_loadbalancer/#global-options","title":"Global options","text":"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. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output, -o Output format (supported: json, yaml and human)Default: human"},{"location":"commands_reference/upctl_loadbalancer/#related-commands","title":"Related commands","text":"Command Description upctl UpCloud command-line interface upctl loadbalancer delete Delete a load balancer upctl loadbalancer list List current load balancers upctl loadbalancer plans List available load balancer plans upctl loadbalancer show Show load balancer details"},{"location":"commands_reference/upctl_loadbalancer/delete/","title":"upctl loadbalancer delete","text":"
"},{"location":"commands_reference/upctl_loadbalancer/delete/#options","title":"Options","text":"Option Description --help, -h help for deleteDefault: false"},{"location":"commands_reference/upctl_loadbalancer/delete/#global-options","title":"Global options","text":"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. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output, -o Output format (supported: json, yaml and human)Default: human"},{"location":"commands_reference/upctl_loadbalancer/delete/#related-commands","title":"Related commands","text":"Command Description upctl loadbalancer Manage load balancers"},{"location":"commands_reference/upctl_loadbalancer/list/","title":"upctl loadbalancer list","text":"
"},{"location":"commands_reference/upctl_loadbalancer/list/#options","title":"Options","text":"Option Description --limit Number of entries to receive at most.Default: 100--page Page number to calculate first item to receive. Page numbers start from 1.Default: 0--help, -h help for listDefault: false"},{"location":"commands_reference/upctl_loadbalancer/list/#global-options","title":"Global options","text":"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. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output, -o Output format (supported: json, yaml and human)Default: human"},{"location":"commands_reference/upctl_loadbalancer/list/#related-commands","title":"Related commands","text":"Command Description upctl loadbalancer Manage load balancers"},{"location":"commands_reference/upctl_loadbalancer/plans/","title":"upctl loadbalancer plans","text":"
"},{"location":"commands_reference/upctl_loadbalancer/plans/#options","title":"Options","text":"Option Description --help, -h help for plansDefault: false"},{"location":"commands_reference/upctl_loadbalancer/plans/#global-options","title":"Global options","text":"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. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output, -o Output format (supported: json, yaml and human)Default: human"},{"location":"commands_reference/upctl_loadbalancer/plans/#related-commands","title":"Related commands","text":"Command Description upctl loadbalancer Manage load balancers"},{"location":"commands_reference/upctl_loadbalancer/show/","title":"upctl loadbalancer show","text":"
upctl loadbalancer show 55199a44-4751-4e27-9394-7c7661910be3\nupctl loadbalancer show my-load-balancer\n
"},{"location":"commands_reference/upctl_loadbalancer/show/#options","title":"Options","text":"Option Description --help, -h help for showDefault: false"},{"location":"commands_reference/upctl_loadbalancer/show/#global-options","title":"Global options","text":"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. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output, -o Output format (supported: json, yaml and human)Default: human"},{"location":"commands_reference/upctl_loadbalancer/show/#related-commands","title":"Related commands","text":"Command Description upctl loadbalancer Manage load balancers"},{"location":"commands_reference/upctl_network/","title":"upctl network","text":"
"},{"location":"commands_reference/upctl_network/#options","title":"Options","text":"Option Description --help, -h help for networkDefault: false"},{"location":"commands_reference/upctl_network/#global-options","title":"Global options","text":"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. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output, -o Output format (supported: json, yaml and human)Default: human"},{"location":"commands_reference/upctl_network/#related-commands","title":"Related commands","text":"Command Description upctl UpCloud command-line interface upctl network create Create a network upctl network delete Delete a network upctl network list List networks, by default private networks only upctl network modify Modify a network upctl network show Show network details"},{"location":"commands_reference/upctl_network/create/","title":"upctl network create","text":"
"},{"location":"commands_reference/upctl_network/create/#options","title":"Options","text":"Option Description --name Names the network. --zone Zone where to create the network. Run upctl zone list to list all available zones. --router Add this network to an existing router. --ip-network A network interface for the server, multiple can be declared. Fields: address: string family: string gateway: string dhcp: true/false dhcp-default-route: true/false dhcp-dns: array of stringsDefault: []--help, -h help for createDefault: false"},{"location":"commands_reference/upctl_network/create/#global-options","title":"Global options","text":"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. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output, -o Output format (supported: json, yaml and human)Default: human"},{"location":"commands_reference/upctl_network/create/#related-commands","title":"Related commands","text":"Command Description upctl network Manage networks"},{"location":"commands_reference/upctl_network/delete/","title":"upctl network delete","text":"
"},{"location":"commands_reference/upctl_network/delete/#options","title":"Options","text":"Option Description --help, -h help for deleteDefault: false"},{"location":"commands_reference/upctl_network/delete/#global-options","title":"Global options","text":"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. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output, -o Output format (supported: json, yaml and human)Default: human"},{"location":"commands_reference/upctl_network/delete/#related-commands","title":"Related commands","text":"Command Description upctl network Manage networks"},{"location":"commands_reference/upctl_network/list/","title":"upctl network list","text":"
upctl network list\nupctl network list --zone pl-waw1\nupctl network list --zone pl-waw1 --public\nupctl network list --all\nupctl network list --zone pl-waw1 --all\n
"},{"location":"commands_reference/upctl_network/list/#options","title":"Options","text":"Option Description --zone Show networks from a specific zone. --all Show all networks. --public Show public networks instead of private networks. --utility Show utility networks instead of private networks. --help, -h help for listDefault: false"},{"location":"commands_reference/upctl_network/list/#global-options","title":"Global options","text":"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. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output, -o Output format (supported: json, yaml and human)Default: human"},{"location":"commands_reference/upctl_network/list/#related-commands","title":"Related commands","text":"Command Description upctl network Manage networks"},{"location":"commands_reference/upctl_network/modify/","title":"upctl network modify","text":"
"},{"location":"commands_reference/upctl_network/modify/#options","title":"Options","text":"Option Description --name Set name of the private network. --router Attach a router to this network, specified by router UUID or router name. --detach-router Detach a router from this network. --ip-network The ip network with modified values. Fields family: string gateway: string dhcp: true/false dhcp-default-route: true/false dhcp-dns: array of stringsDefault: []--help, -h help for modifyDefault: false"},{"location":"commands_reference/upctl_network/modify/#global-options","title":"Global options","text":"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. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output, -o Output format (supported: json, yaml and human)Default: human"},{"location":"commands_reference/upctl_network/modify/#related-commands","title":"Related commands","text":"Command Description upctl network Manage networks"},{"location":"commands_reference/upctl_network/show/","title":"upctl network show","text":"
upctl network show 037a530b-533e-4cef-b6ad-6af8094bb2bc\nupctl network show 037a530b-533e-4cef-b6ad-6af8094bb2bc 0311480d-d0c0-4951-ab41-bf12097f5d3c\nupctl network show \"My Network\"\n
"},{"location":"commands_reference/upctl_network/show/#options","title":"Options","text":"Option Description --help, -h help for showDefault: false"},{"location":"commands_reference/upctl_network/show/#global-options","title":"Global options","text":"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. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output, -o Output format (supported: json, yaml and human)Default: human"},{"location":"commands_reference/upctl_network/show/#related-commands","title":"Related commands","text":"Command Description upctl network Manage networks"},{"location":"commands_reference/upctl_networkpeering/","title":"upctl networkpeering","text":"
Manage network peerings
upctl networkpeering [flags]\n
"},{"location":"commands_reference/upctl_networkpeering/#options","title":"Options","text":"Option Description --help, -h help for networkpeeringDefault: false"},{"location":"commands_reference/upctl_networkpeering/#global-options","title":"Global options","text":"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. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output, -o Output format (supported: json, yaml and human)Default: human"},{"location":"commands_reference/upctl_networkpeering/#related-commands","title":"Related commands","text":"Command Description upctl UpCloud command-line interface upctl networkpeering delete Delete a network peering upctl networkpeering disable Disable a network peering upctl networkpeering list List network peerings"},{"location":"commands_reference/upctl_networkpeering/delete/","title":"upctl networkpeering delete","text":"
"},{"location":"commands_reference/upctl_networkpeering/delete/#options","title":"Options","text":"Option Description --help, -h help for deleteDefault: false"},{"location":"commands_reference/upctl_networkpeering/delete/#global-options","title":"Global options","text":"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. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output, -o Output format (supported: json, yaml and human)Default: human"},{"location":"commands_reference/upctl_networkpeering/delete/#related-commands","title":"Related commands","text":"Command Description upctl networkpeering Manage network peerings"},{"location":"commands_reference/upctl_networkpeering/disable/","title":"upctl networkpeering disable","text":"
"},{"location":"commands_reference/upctl_networkpeering/disable/#options","title":"Options","text":"Option Description --wait Wait for network peering to be in disabled state before returning. --help, -h help for disableDefault: false"},{"location":"commands_reference/upctl_networkpeering/disable/#global-options","title":"Global options","text":"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. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output, -o Output format (supported: json, yaml and human)Default: human"},{"location":"commands_reference/upctl_networkpeering/disable/#related-commands","title":"Related commands","text":"Command Description upctl networkpeering Manage network peerings"},{"location":"commands_reference/upctl_networkpeering/list/","title":"upctl networkpeering list","text":"
"},{"location":"commands_reference/upctl_networkpeering/list/#options","title":"Options","text":"Option Description --help, -h help for listDefault: false"},{"location":"commands_reference/upctl_networkpeering/list/#global-options","title":"Global options","text":"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. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output, -o Output format (supported: json, yaml and human)Default: human"},{"location":"commands_reference/upctl_networkpeering/list/#related-commands","title":"Related commands","text":"Command Description upctl networkpeering Manage network peerings"},{"location":"commands_reference/upctl_objectstorage/","title":"upctl objectstorage","text":"
"},{"location":"commands_reference/upctl_objectstorage/#options","title":"Options","text":"Option Description --help, -h help for objectstorageDefault: false"},{"location":"commands_reference/upctl_objectstorage/#global-options","title":"Global options","text":"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. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output, -o Output format (supported: json, yaml and human)Default: human"},{"location":"commands_reference/upctl_objectstorage/#related-commands","title":"Related commands","text":"Command Description upctl UpCloud command-line interface upctl objectstorage delete Delete a Managed object storage service upctl objectstorage list List current Managed object storage services upctl objectstorage regions List objectstorage regions upctl objectstorage show Show Managed object storage service details"},{"location":"commands_reference/upctl_objectstorage/delete/","title":"upctl objectstorage delete","text":"
"},{"location":"commands_reference/upctl_objectstorage/delete/#options","title":"Options","text":"Option Description --delete-users Delete all users from the service before deleting the object storage instance. --delete-policies Delete all policies from the service before deleting the object storage instance. --delete-buckets Delete all buckets from the service before deleting the object storage instance. --help, -h help for deleteDefault: false"},{"location":"commands_reference/upctl_objectstorage/delete/#global-options","title":"Global options","text":"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. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output, -o Output format (supported: json, yaml and human)Default: human"},{"location":"commands_reference/upctl_objectstorage/delete/#related-commands","title":"Related commands","text":"Command Description upctl objectstorage Manage managed object storage services"},{"location":"commands_reference/upctl_objectstorage/list/","title":"upctl objectstorage list","text":"
"},{"location":"commands_reference/upctl_objectstorage/list/#options","title":"Options","text":"Option Description --limit Number of entries to receive at most.Default: 100--page Page number to calculate first item to receive. Page numbers start from 1.Default: 0--help, -h help for listDefault: false"},{"location":"commands_reference/upctl_objectstorage/list/#global-options","title":"Global options","text":"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. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output, -o Output format (supported: json, yaml and human)Default: human"},{"location":"commands_reference/upctl_objectstorage/list/#related-commands","title":"Related commands","text":"Command Description upctl objectstorage Manage managed object storage services"},{"location":"commands_reference/upctl_objectstorage/regions/","title":"upctl objectstorage regions","text":"
upctl objectstorage show 55199a44-4751-4e27-9394-7c7661910be8\n
"},{"location":"commands_reference/upctl_objectstorage/show/#options","title":"Options","text":"Option Description --help, -h help for showDefault: false"},{"location":"commands_reference/upctl_objectstorage/show/#global-options","title":"Global options","text":"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. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output, -o Output format (supported: json, yaml and human)Default: human"},{"location":"commands_reference/upctl_objectstorage/show/#related-commands","title":"Related commands","text":"Command Description upctl objectstorage Manage managed object storage services"},{"location":"commands_reference/upctl_partner/","title":"upctl partner","text":"
Manage partner resources
upctl partner [flags]\n
"},{"location":"commands_reference/upctl_partner/#options","title":"Options","text":"Option Description --help, -h help for partnerDefault: false"},{"location":"commands_reference/upctl_partner/#global-options","title":"Global options","text":"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. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output, -o Output format (supported: json, yaml and human)Default: human"},{"location":"commands_reference/upctl_partner/#related-commands","title":"Related commands","text":"Command Description upctl UpCloud command-line interface upctl partner account Manage accounts associated with partner"},{"location":"commands_reference/upctl_partner/account/","title":"upctl partner account","text":"
Manage accounts associated with partner
upctl partner account [flags]\n
"},{"location":"commands_reference/upctl_partner/account/#options","title":"Options","text":"Option Description --help, -h help for accountDefault: false"},{"location":"commands_reference/upctl_partner/account/#global-options","title":"Global options","text":"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. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output, -o Output format (supported: json, yaml and human)Default: human"},{"location":"commands_reference/upctl_partner/account/#related-commands","title":"Related commands","text":"Command Description upctl partner Manage partner resources upctl partner account create Create a new account that will be linked to partner's existing invoicing upctl partner account list List accounts associated with partner"},{"location":"commands_reference/upctl_partner/account/create/","title":"upctl partner account create","text":"
Create a new account that will be linked to partner's existing invoicing
upctl partner account create --username newuser --password superSecret123\nupctl partner account create --username newuser --password superSecret123 --first-name New --last-name User --company \"Example Ltd\" --country FIN --phone +358.91111111 --email new.user@gmail.com\n
"},{"location":"commands_reference/upctl_partner/account/create/#options","title":"Options","text":"Option Description --username Account username. --password Account pasword. --first-name Contact first name. Required when other contact details are given. --last-name Contact last name. Required when other contact details are given. --company Contact company name. --address Contact street address. --postal-code Contact postal/zip code. --city Contact city. --state Contact state. Required when other contact details are given and country is 'USA'. --country Contact ISO 3166-1 three character country code. Required when other contact details are given. --phone Contact phone number in international format, country code and national part separated by a period. Required when other contact details are given. --email Contact email address. Required when other contact details are given. --vat-number Contact VAT number. --help, -h help for createDefault: false"},{"location":"commands_reference/upctl_partner/account/create/#global-options","title":"Global options","text":"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. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output, -o Output format (supported: json, yaml and human)Default: human"},{"location":"commands_reference/upctl_partner/account/create/#related-commands","title":"Related commands","text":"Command Description upctl partner account Manage accounts associated with partner"},{"location":"commands_reference/upctl_partner/account/list/","title":"upctl partner account list","text":"
"},{"location":"commands_reference/upctl_partner/account/list/#options","title":"Options","text":"Option Description --help, -h help for listDefault: false"},{"location":"commands_reference/upctl_partner/account/list/#global-options","title":"Global options","text":"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. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output, -o Output format (supported: json, yaml and human)Default: human"},{"location":"commands_reference/upctl_partner/account/list/#related-commands","title":"Related commands","text":"Command Description upctl partner account Manage accounts associated with partner"},{"location":"commands_reference/upctl_router/","title":"upctl router","text":"
Manage routers
upctl router [flags]\n
"},{"location":"commands_reference/upctl_router/#options","title":"Options","text":"Option Description --help, -h help for routerDefault: false"},{"location":"commands_reference/upctl_router/#global-options","title":"Global options","text":"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. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output, -o Output format (supported: json, yaml and human)Default: human"},{"location":"commands_reference/upctl_router/#related-commands","title":"Related commands","text":"Command Description upctl UpCloud command-line interface upctl router create Create a router upctl router delete Delete a router upctl router list List routers upctl router modify Modify a router upctl router show Show current router"},{"location":"commands_reference/upctl_router/create/","title":"upctl router create","text":"
"},{"location":"commands_reference/upctl_router/delete/#options","title":"Options","text":"Option Description --help, -h help for deleteDefault: false"},{"location":"commands_reference/upctl_router/delete/#global-options","title":"Global options","text":"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. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output, -o Output format (supported: json, yaml and human)Default: human"},{"location":"commands_reference/upctl_router/delete/#related-commands","title":"Related commands","text":"Command Description upctl router Manage routers"},{"location":"commands_reference/upctl_router/list/","title":"upctl router list","text":"
"},{"location":"commands_reference/upctl_router/list/#options","title":"Options","text":"Option Description --all Show all routers. --normal Show normal routers. --service Show service routers. --help, -h help for listDefault: false"},{"location":"commands_reference/upctl_router/list/#global-options","title":"Global options","text":"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. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output, -o Output format (supported: json, yaml and human)Default: human"},{"location":"commands_reference/upctl_router/list/#related-commands","title":"Related commands","text":"Command Description upctl router Manage routers"},{"location":"commands_reference/upctl_router/modify/","title":"upctl router modify","text":"
"},{"location":"commands_reference/upctl_router/modify/#options","title":"Options","text":"Option Description --name New router name. --help, -h help for modifyDefault: false"},{"location":"commands_reference/upctl_router/modify/#global-options","title":"Global options","text":"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. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output, -o Output format (supported: json, yaml and human)Default: human"},{"location":"commands_reference/upctl_router/modify/#related-commands","title":"Related commands","text":"Command Description upctl router Manage routers"},{"location":"commands_reference/upctl_router/show/","title":"upctl router show","text":"
upctl router show 04d0a7f6-ee78-42b5-8077-6947f9e67c5a\nupctl router show 04d0a7f6-ee78-42b5-8077-6947f9e67c5a 04d031ab-4b85-4cbc-9f0e-6a2977541327\nupctl router show \"My Turbo Router\" my_super_router\n
"},{"location":"commands_reference/upctl_router/show/#options","title":"Options","text":"Option Description --help, -h help for showDefault: false"},{"location":"commands_reference/upctl_router/show/#global-options","title":"Global options","text":"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. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output, -o Output format (supported: json, yaml and human)Default: human"},{"location":"commands_reference/upctl_router/show/#related-commands","title":"Related commands","text":"Command Description upctl router Manage routers"},{"location":"commands_reference/upctl_server/","title":"upctl server","text":"
Manage servers
upctl server [flags]\n
"},{"location":"commands_reference/upctl_server/#options","title":"Options","text":"Option Description --help, -h help for serverDefault: false"},{"location":"commands_reference/upctl_server/#global-options","title":"Global options","text":"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. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output, -o Output format (supported: json, yaml and human)Default: human"},{"location":"commands_reference/upctl_server/#related-commands","title":"Related commands","text":"Command Description upctl UpCloud command-line interface upctl server create Create a new server upctl server delete Delete a server upctl server eject Eject a CD-ROM from the server upctl server firewall Manage server firewall rules. Enabling or disabling the firewall is done in server modify. upctl server list List current servers upctl server load Load a CD-ROM into the server upctl server modify Modifies the configuration of an existing server upctl server network-interface Manage network interface upctl server plans List server plans upctl server restart Restart a server upctl server show Show server details upctl server start Start a server upctl server stop Stop a server upctl server storage Manage server storages"},{"location":"commands_reference/upctl_server/create/","title":"upctl server create","text":"
Create a new server
Note that the default template, Ubuntu Server 24.04 LTS (Noble Numbat), only supports SSH key based authentication. Use --ssh-keys option to provide the keys when creating a server with the default template. The examples below use public key from the ~/.ssh directory. If you want to use different authentication method, use --os parameter to specify a different template.
"},{"location":"commands_reference/upctl_server/create/#options","title":"Options","text":"Option Description --avoid-host Host to avoid when scheduling the server. Use this to make sure VMs do not reside on specific host. Refers to value from host attribute. Useful when building HA-environments.Default: 0--boot-order The boot device order, disk / cdrom / network or comma separated combination. --cores Number of cores. Only allowed if plan option is set to \"custom\".Default: 0--create-password Create an admin password. --enable-firewall Enable firewall. --enable-metadata Enable metadata service. The metadata service will be enabled by default, if the selected OS template uses cloud-init and thus requires metadata service. --enable-remote-access Enable remote access. --host Schedule the server on a specific host. Refers to value from host attribute. Only available in private clouds.Default: 0--hostname Server hostname. --label Labels to describe the server in key=value format, multiple can be declared.Usage: --label env=dev--label owner=operationsDefault: []--memory Memory amount in MiB. Only allowed if plan option is set to \"custom\".Default: 0--network A network interface for the server, multiple can be declared.Usage: --network family=IPv4,type=public--network type=private,network=037a530b-533e-4cef-b6ad-6af8094bb2bc,ip-address=10.0.0.1Default: []--os Server OS to use (will be the first storage device). The value should be title or UUID of an either public or private template. Set to empty to fully customise the storages.Default: Ubuntu Server 24.04 LTS (Noble Numbat)--os-storage-size OS storage size in GiB. This is only applicable if os is also set. Zero value makes the disk equal to the minimum size of the template.Default: 0--os-storage-encrypt Encrypt the OS storage. This is only applicable if os is also set. --password-delivery Defines how password is delivered. Available: email, smsDefault: none--plan Server plan name. See \"server plans\" command for valid plans. Set to \"custom\" and use cores and memory options for flexible plan.Default: 1xCPU-2GB--remote-access-password Defines the remote access password. --remote-access-type Set a remote access type. Available: vnc, spice --server-group UUID of a server group for the server. To remove the server from the group, see `servergroup modify --simple-backup Simple backup rule. Format (HHMM,{dailies,weeklies,monthlies}). Example: 2300,dailies --ssh-keys Add one or more SSH keys to the admin account. Accepted values are SSH public keys or filenames from where to read the keys.Default: []--storage A storage connected to the server, multiple can be declared.Usage: --storage action=attach,storage=01000000-0000-4000-8000-000020010301,type=cdromDefault: []--time-zone Time zone to set the RTC to.Default: UTC--title A short, informational description. --user-data Defines URL for a server setup script, or the script body itself. --username Admin account username. --video-model Video interface model of the server. Available: vga, cirrusDefault: vga--wait Wait for server to be in started state before returning. --zone Zone where to create the server. Run upctl zone list to list all available zones. --help, -h help for createDefault: false"},{"location":"commands_reference/upctl_server/create/#global-options","title":"Global options","text":"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. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output, -o Output format (supported: json, yaml and human)Default: human"},{"location":"commands_reference/upctl_server/create/#related-commands","title":"Related commands","text":"Command Description upctl server Manage servers"},{"location":"commands_reference/upctl_server/delete/","title":"upctl server delete","text":"
Delete a server
upctl server delete <UUID/Title/Hostname...> [flags]\n
upctl server delete 00cbe2f3-4cf9-408b-afee-bd340e13cdd8\nupctl server delete 00cbe2f3-4cf9-408b-afee-bd340e13cdd8 0053a6f5-e6d1-4b0b-b9dc-b90d0894e8d0\nupctl server delete my_server\n
"},{"location":"commands_reference/upctl_server/delete/#options","title":"Options","text":"Option Description --delete-storages Delete storages that are attached to the server. --help, -h help for deleteDefault: false"},{"location":"commands_reference/upctl_server/delete/#global-options","title":"Global options","text":"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. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output, -o Output format (supported: json, yaml and human)Default: human"},{"location":"commands_reference/upctl_server/delete/#related-commands","title":"Related commands","text":"Command Description upctl server Manage servers"},{"location":"commands_reference/upctl_server/eject/","title":"upctl server eject","text":"
Eject a CD-ROM from the server
upctl server eject <UUID/Title/Hostname...> [flags]\n
"},{"location":"commands_reference/upctl_server/eject/#options","title":"Options","text":"Option Description --help, -h help for ejectDefault: false"},{"location":"commands_reference/upctl_server/eject/#global-options","title":"Global options","text":"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. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output, -o Output format (supported: json, yaml and human)Default: human"},{"location":"commands_reference/upctl_server/eject/#related-commands","title":"Related commands","text":"Command Description upctl server Manage servers"},{"location":"commands_reference/upctl_server/list/","title":"upctl server list","text":"
upctl server list\nupctl server list --show-ip-addresses\nupctl server list --show-ip-addresses=public\n
"},{"location":"commands_reference/upctl_server/list/#options","title":"Options","text":"Option Description --show-ip-addresses Show servers IP addresses of specified access type in the output or all ip addresses if argument value is \"all\" or no argument is specified.Default: none--help, -h help for listDefault: false"},{"location":"commands_reference/upctl_server/list/#global-options","title":"Global options","text":"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. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output, -o Output format (supported: json, yaml and human)Default: human"},{"location":"commands_reference/upctl_server/list/#related-commands","title":"Related commands","text":"Command Description upctl server Manage servers"},{"location":"commands_reference/upctl_server/load/","title":"upctl server load","text":"
Load a CD-ROM into the server
upctl server load <UUID/Title/Hostname...> [flags]\n
upctl server load my_server4 --storage 01000000-0000-4000-8000-000080030101\n
"},{"location":"commands_reference/upctl_server/load/#options","title":"Options","text":"Option Description --storage The UUID of the storage to be loaded in the CD-ROM device. --help, -h help for loadDefault: false"},{"location":"commands_reference/upctl_server/load/#global-options","title":"Global options","text":"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. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output, -o Output format (supported: json, yaml and human)Default: human"},{"location":"commands_reference/upctl_server/load/#related-commands","title":"Related commands","text":"Command Description upctl server Manage servers"},{"location":"commands_reference/upctl_server/modify/","title":"upctl server modify","text":"
Modifies the configuration of an existing server
upctl server modify <UUID/Title/Hostname...> [flags]\n
upctl server modify 00bb4617-c592-4b32-b869-35a60b323b18 --plan 1xCPU-1GB\nupctl server modify 00bb4617-c592-4b32-b869-35a60b323b18 0053a6f5-e6d1-4b0b-b9dc-b90d0894e8d0 --plan 1xCPU-1GB\nupctl server modify my_server1 --plan 1xCPU-2GB\nupctl server modify myapp --hostname superapp\n
"},{"location":"commands_reference/upctl_server/modify/#options","title":"Options","text":"Option Description --boot-order The boot device order, disk / cdrom / network or comma separated combination. --cores Number of cores. Sets server plan to custom.Default: 0--hostname Hostname. --enable-firewall Enable firewall. --disable-firewall Disable firewall. --label Labels to describe the server in key=value format, multiple can be declared. If set, all the existing labels will be replaced with provided ones.Usage: --label env=dev--label owner=operationsDefault: []--memory Memory amount in MiB. Sets server plan to custom.Default: 0--enable-metadata Enable metadata service. --disable-metadata Disable metadata service. --plan Server plan to use. --simple-backup Simple backup rule. Format (HHMM,{dailies,weeklies,monthlies}).Example: 2300,dailies --title A short, informational description. --time-zone Time zone to set the RTC to. --video-model Video interface model of the server.Available: vga,cirrus --enable-remote-access Enable remote access. --disable-remote-access Disable remote access. --remote-access-type The remote access type. --remote-access-password The remote access password. --help, -h help for modifyDefault: false"},{"location":"commands_reference/upctl_server/modify/#global-options","title":"Global options","text":"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. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output, -o Output format (supported: json, yaml and human)Default: human"},{"location":"commands_reference/upctl_server/modify/#related-commands","title":"Related commands","text":"Command Description upctl server Manage servers"},{"location":"commands_reference/upctl_server/plans/","title":"upctl server plans","text":"
"},{"location":"commands_reference/upctl_server/plans/#options","title":"Options","text":"Option Description --help, -h help for plansDefault: false"},{"location":"commands_reference/upctl_server/plans/#global-options","title":"Global options","text":"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. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output, -o Output format (supported: json, yaml and human)Default: human"},{"location":"commands_reference/upctl_server/plans/#related-commands","title":"Related commands","text":"Command Description upctl server Manage servers"},{"location":"commands_reference/upctl_server/restart/","title":"upctl server restart","text":"
Restart a server
upctl server restart <UUID/Title/Hostname...> [flags]\n
upctl server restart 00038afc-d526-4148-af0e-d2f1eeaded9b\nupctl server restart 00038afc-d526-4148-af0e-d2f1eeaded9b --stop-type hard\nupctl server restart my_server1 my_server2\n
"},{"location":"commands_reference/upctl_server/restart/#options","title":"Options","text":"Option Description --stop-type The type of stop operation. Available: soft, hardDefault: soft--host Schedule the server on a specific host. Refers to value from host attribute. Only available in private clouds.Default: 0--help, -h help for restartDefault: false"},{"location":"commands_reference/upctl_server/restart/#global-options","title":"Global options","text":"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. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output, -o Output format (supported: json, yaml and human)Default: human"},{"location":"commands_reference/upctl_server/restart/#related-commands","title":"Related commands","text":"Command Description upctl server Manage servers"},{"location":"commands_reference/upctl_server/show/","title":"upctl server show","text":"
Show server details
upctl server show <UUID/Title/Hostname...> [flags]\n
upctl server show 21aeb3b7-cd89-4123-a376-559b0e75be8b\nupctl server show 21aeb3b7-cd89-4123-a376-559b0e75be8b 0053a6f5-e6d1-4b0b-b9dc-b90d0894e8d0\nupctl server show myhostname\nupctl server show my_server1 my_server2\n
"},{"location":"commands_reference/upctl_server/show/#options","title":"Options","text":"Option Description --help, -h help for showDefault: false"},{"location":"commands_reference/upctl_server/show/#global-options","title":"Global options","text":"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. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output, -o Output format (supported: json, yaml and human)Default: human"},{"location":"commands_reference/upctl_server/show/#related-commands","title":"Related commands","text":"Command Description upctl server Manage servers"},{"location":"commands_reference/upctl_server/start/","title":"upctl server start","text":"
Start a server
upctl server start <UUID/Title/Hostname...> [flags]\n
upctl server start 00038afc-d526-4148-af0e-d2f1eeaded9b\nupctl server start 00038afc-d526-4148-af0e-d2f1eeaded9b 0053a6f5-e6d1-4b0b-b9dc-b90d0894e8d0\nupctl server start my_server1\n
"},{"location":"commands_reference/upctl_server/start/#options","title":"Options","text":"Option Description --avoid-host Host to avoid when scheduling the server. Use this to make sure VMs do not reside on specific host. Refers to value from host attribute. Useful when building HA-environments.Default: 0--host Schedule the server on a specific host. Refers to value from host attribute. Only available in private clouds.Default: 0--help, -h help for startDefault: false"},{"location":"commands_reference/upctl_server/start/#global-options","title":"Global options","text":"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. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output, -o Output format (supported: json, yaml and human)Default: human"},{"location":"commands_reference/upctl_server/start/#related-commands","title":"Related commands","text":"Command Description upctl server Manage servers"},{"location":"commands_reference/upctl_server/stop/","title":"upctl server stop","text":"
Stop a server
upctl server stop <UUID/Title/Hostname...> [flags]\n
upctl server stop 00cbe2f3-4cf9-408b-afee-bd340e13cdd8\nupctl server stop 00cbe2f3-4cf9-408b-afee-bd340e13cdd8 0053a6f5-e6d1-4b0b-b9dc-b90d0894e8d0\nupctl server stop my_server\nupctl server stop --wait my_server\n
"},{"location":"commands_reference/upctl_server/stop/#options","title":"Options","text":"Option Description --type The type of stop operation. Available: soft, hardDefault: soft--wait Wait for server to be in stopped state before returning. --help, -h help for stopDefault: false"},{"location":"commands_reference/upctl_server/stop/#global-options","title":"Global options","text":"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. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output, -o Output format (supported: json, yaml and human)Default: human"},{"location":"commands_reference/upctl_server/stop/#related-commands","title":"Related commands","text":"Command Description upctl server Manage servers"},{"location":"commands_reference/upctl_server/firewall/","title":"upctl server firewall","text":"
Manage server firewall rules. Enabling or disabling the firewall is done in server modify.
upctl server firewall [flags]\n
"},{"location":"commands_reference/upctl_server/firewall/#options","title":"Options","text":"Option Description --help, -h help for firewallDefault: false"},{"location":"commands_reference/upctl_server/firewall/#global-options","title":"Global options","text":"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. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output, -o Output format (supported: json, yaml and human)Default: human"},{"location":"commands_reference/upctl_server/firewall/#related-commands","title":"Related commands","text":"Command Description upctl server Manage servers upctl server firewall create Create a new firewall rule upctl server firewall delete Removes a firewall rule from a server. Firewall rules must be removed individually. The positions of remaining firewall rules will be adjusted after a rule is removed. upctl server firewall show Show server firewall details."},{"location":"commands_reference/upctl_server/firewall/create/","title":"upctl server firewall create","text":"
Create a new firewall rule
To edit the default rule of the firewall, set only --direction and --action parameters. This creates catch-all rule that will take effect when no other rule matches. Note that the default rule must be positioned after all other rules. Use --position parameter or create default rule after other rules.
upctl server firewall create <UUID/Title/Hostname...> [flags]\n
upctl server firewall create 00038afc-d526-4148-af0e-d2f1eeaded9b --direction in --action drop\nupctl server firewall create 00038afc-d526-4148-af0e-d2f1eeaded9b --direction in --action accept --family IPv4\nupctl server firewall create 00038afc-d526-4148-af0e-d2f1eeaded9b --direction in --action drop --family IPv4 --src-ipaddress-block 10.11.0.88/24\n
"},{"location":"commands_reference/upctl_server/firewall/create/#options","title":"Options","text":"Option Description --direction Rule direction. Available: in, out --action Rule action. Available: accept, drop --family IP family. Available: IPv4, IPv6 --position Position in relation to other rules. Available: 1-1000Default: 0--protocol Protocol. Available: tcp, udp, icmp --icmp-type ICMP type. Available: 0-255 --dest-ipaddress-block Destination IP address block. --destination-port-start Destination port range start. Available: 1-65535 --destination-port-end Destination port range end. --src-ipaddress-block Source IP address block. --source-port-start Source port range start. --source-port-end Destination port range end. --comment Freeform comment that can include 0-250 characters. --help, -h help for createDefault: false"},{"location":"commands_reference/upctl_server/firewall/create/#global-options","title":"Global options","text":"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. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output, -o Output format (supported: json, yaml and human)Default: human"},{"location":"commands_reference/upctl_server/firewall/create/#related-commands","title":"Related commands","text":"Command Description upctl server firewall Manage server firewall rules. Enabling or disabling the firewall is done in server modify."},{"location":"commands_reference/upctl_server/firewall/delete/","title":"upctl server firewall delete","text":"
Removes a firewall rule from a server. Firewall rules must be removed individually. The positions of remaining firewall rules will be adjusted after a rule is removed.
upctl server firewall delete <UUID/Title/Hostname...> [flags]\n
upctl server firewall delete 00038afc-d526-4148-af0e-d2f1eeaded9b --position 1\n
"},{"location":"commands_reference/upctl_server/firewall/delete/#options","title":"Options","text":"Option Description --position Rule position. Available: 1-1000Default: 0--help, -h help for deleteDefault: false"},{"location":"commands_reference/upctl_server/firewall/delete/#global-options","title":"Global options","text":"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. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output, -o Output format (supported: json, yaml and human)Default: human"},{"location":"commands_reference/upctl_server/firewall/delete/#related-commands","title":"Related commands","text":"Command Description upctl server firewall Manage server firewall rules. Enabling or disabling the firewall is done in server modify."},{"location":"commands_reference/upctl_server/firewall/show/","title":"upctl server firewall show","text":"
Show server firewall details.
upctl server firewall show <UUID/Title/Hostname...> [flags]\n
upctl server firewall show 00038afc-d526-4148-af0e-d2f1eeaded9b\nupctl server firewall show 00038afc-d526-4148-af0e-d2f1eeaded9b 009d7f4e-99ce-4c78-88f1-e695d4c37743\nupctl server firewall show my_server\n
"},{"location":"commands_reference/upctl_server/firewall/show/#options","title":"Options","text":"Option Description --help, -h help for showDefault: false"},{"location":"commands_reference/upctl_server/firewall/show/#global-options","title":"Global options","text":"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. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output, -o Output format (supported: json, yaml and human)Default: human"},{"location":"commands_reference/upctl_server/firewall/show/#related-commands","title":"Related commands","text":"Command Description upctl server firewall Manage server firewall rules. Enabling or disabling the firewall is done in server modify."},{"location":"commands_reference/upctl_server/network-interface/","title":"upctl server network-interface","text":"
Manage network interface
upctl server network-interface [flags]\n
"},{"location":"commands_reference/upctl_server/network-interface/#options","title":"Options","text":"Option Description --help, -h help for network-interfaceDefault: false"},{"location":"commands_reference/upctl_server/network-interface/#global-options","title":"Global options","text":"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. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output, -o Output format (supported: json, yaml and human)Default: human"},{"location":"commands_reference/upctl_server/network-interface/#related-commands","title":"Related commands","text":"Command Description upctl server Manage servers upctl server network-interface create Create a network interface upctl server network-interface delete Delete a network interface upctl server network-interface modify Modify a network interface"},{"location":"commands_reference/upctl_server/network-interface/create/","title":"upctl server network-interface create","text":"
Create a network interface
upctl server network-interface create <UUID/Title/Hostname...> [flags]\n
upctl server network-interface create 009d7f4e-99ce-4c78-88f1-e695d4c37743 --type private --network 037a530b-533e-4cef-b6ad-6af8094bb2bc --disable-source-ip-filtering --ip-addresses 10.0.0.1\nupctl server network-interface create my_server2 --type public --family IPv6\nupctl server network-interface create my_server2 --type public --family IPv4\nupctl server network-interface create my_server2 --network 037a530b-533e-4cef-b6ad-6af8094bb2bc\n
"},{"location":"commands_reference/upctl_server/network-interface/create/#options","title":"Options","text":"Option Description --network Private network name or UUID to join. --type Set the type of the network. Available: public, utility, privateDefault: private--family The address family of new IP address.Default: IPv4--index Interface index.Default: 0--enable-bootable Enable Whether to try booting through the interface.. --disable-bootable Disable Whether to try booting through the interface.. --enable-source-ip-filtering Enable Whether source IP filtering is enabled on the interface. Disabling it is allowed only for SDN private interfaces.. --disable-source-ip-filtering Disable Whether source IP filtering is enabled on the interface. Disabling it is allowed only for SDN private interfaces.. --ip-addresses A comma-separated list of IP addressesDefault: []--help, -h help for createDefault: false"},{"location":"commands_reference/upctl_server/network-interface/create/#global-options","title":"Global options","text":"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. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output, -o Output format (supported: json, yaml and human)Default: human"},{"location":"commands_reference/upctl_server/network-interface/create/#related-commands","title":"Related commands","text":"Command Description upctl server network-interface Manage network interface"},{"location":"commands_reference/upctl_server/network-interface/delete/","title":"upctl server network-interface delete","text":"
Delete a network interface
upctl server network-interface delete <UUID/Title/Hostname...> [flags]\n
upctl server network-interface delete 009d7f4e-99ce-4c78-88f1-e695d4c37743 --index 1\nupctl server network-interface delete my_server --index 7\n
"},{"location":"commands_reference/upctl_server/network-interface/delete/#options","title":"Options","text":"Option Description --index Interface index.Default: 0--help, -h help for deleteDefault: false"},{"location":"commands_reference/upctl_server/network-interface/delete/#global-options","title":"Global options","text":"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. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output, -o Output format (supported: json, yaml and human)Default: human"},{"location":"commands_reference/upctl_server/network-interface/delete/#related-commands","title":"Related commands","text":"Command Description upctl server network-interface Manage network interface"},{"location":"commands_reference/upctl_server/network-interface/modify/","title":"upctl server network-interface modify","text":"
Modify a network interface
upctl server network-interface modify <UUID/Title/Hostname...> [flags]\n
upctl server network-interface modify 009d7f4e-99ce-4c78-88f1-e695d4c37743 --index 2 --new-index 1\n
"},{"location":"commands_reference/upctl_server/network-interface/modify/#options","title":"Options","text":"Option Description --index Index of the interface to modify.Default: 0--new-index New index to move the interface to.Default: 0--bootable Whether to try booting through the interface. --source-ip-filtering Whether source IP filtering is enabled on the interface. Disabling it is allowed only for SDN private interfaces. --ip-addresses A comma-separated list of IP addresses, multiple can be declaredUsage: --ip-address address=94.237.112.143,family=IPv4Default: []--help, -h help for modifyDefault: false"},{"location":"commands_reference/upctl_server/network-interface/modify/#global-options","title":"Global options","text":"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. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output, -o Output format (supported: json, yaml and human)Default: human"},{"location":"commands_reference/upctl_server/network-interface/modify/#related-commands","title":"Related commands","text":"Command Description upctl server network-interface Manage network interface"},{"location":"commands_reference/upctl_server/storage/","title":"upctl server storage","text":"
Manage server storages
upctl server storage [flags]\n
"},{"location":"commands_reference/upctl_server/storage/#options","title":"Options","text":"Option Description --help, -h help for storageDefault: false"},{"location":"commands_reference/upctl_server/storage/#global-options","title":"Global options","text":"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. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output, -o Output format (supported: json, yaml and human)Default: human"},{"location":"commands_reference/upctl_server/storage/#related-commands","title":"Related commands","text":"Command Description upctl server Manage servers upctl server storage attach Attach a storage as a device to a server upctl server storage detach Detaches a storage resource from a server"},{"location":"commands_reference/upctl_server/storage/attach/","title":"upctl server storage attach","text":"
Attach a storage as a device to a server
upctl server storage attach <UUID/Title/Hostname...> [flags]\n
upctl server storage attach 00038afc-d526-4148-af0e-d2f1eeaded9b --storage 015899e0-0a68-4949-85bb-261a99de5fdd\nupctl server storage attach 00038afc-d526-4148-af0e-d2f1eeaded9b --storage 01a5568f-4766-4ce7-abf5-7d257903a735 --address virtio:2\nupctl server storage attach my_server1 --storage \"My Storage\"\n
"},{"location":"commands_reference/upctl_server/storage/attach/#options","title":"Options","text":"Option Description --type Type of the attached storage. Available: disk, cdromDefault: disk--address Address where the storage device is attached on the server. Address is of the form busname:deviceindex where busname can be ide/scsi/virtio. (example: 'virtio:1')Specify only the bus name to auto-select next available device index from that bus. (example: 'virtio')Default: virtio--storage UUID of the storage to attach. --boot-disk Set attached device as the server's boot disk. --help, -h help for attachDefault: false"},{"location":"commands_reference/upctl_server/storage/attach/#global-options","title":"Global options","text":"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. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output, -o Output format (supported: json, yaml and human)Default: human"},{"location":"commands_reference/upctl_server/storage/attach/#related-commands","title":"Related commands","text":"Command Description upctl server storage Manage server storages"},{"location":"commands_reference/upctl_server/storage/detach/","title":"upctl server storage detach","text":"
Detaches a storage resource from a server
upctl server storage detach <UUID/Title/Hostname...> [flags]\n
upctl server storage detach 00038afc-d526-4148-af0e-d2f1eeaded9b --address virtio:1\nupctl server storage detach my_server1 --address virtio:2\n
"},{"location":"commands_reference/upctl_server/storage/detach/#options","title":"Options","text":"Option Description --address Detach the storage attached to this address. --help, -h help for detachDefault: false"},{"location":"commands_reference/upctl_server/storage/detach/#global-options","title":"Global options","text":"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. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output, -o Output format (supported: json, yaml and human)Default: human"},{"location":"commands_reference/upctl_server/storage/detach/#related-commands","title":"Related commands","text":"Command Description upctl server storage Manage server storages"},{"location":"commands_reference/upctl_servergroup/","title":"upctl servergroup","text":"
Manage server groups
upctl servergroup [flags]\n
"},{"location":"commands_reference/upctl_servergroup/#options","title":"Options","text":"Option Description --help, -h help for servergroupDefault: false"},{"location":"commands_reference/upctl_servergroup/#global-options","title":"Global options","text":"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. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output, -o Output format (supported: json, yaml and human)Default: human"},{"location":"commands_reference/upctl_servergroup/#related-commands","title":"Related commands","text":"Command Description upctl UpCloud command-line interface upctl servergroup create Create a server group upctl servergroup delete Delete a server group upctl servergroup list List current server groups upctl servergroup modify Modify a server group upctl servergroup show Show server group details"},{"location":"commands_reference/upctl_servergroup/create/","title":"upctl servergroup create","text":"
"},{"location":"commands_reference/upctl_servergroup/create/#options","title":"Options","text":"Option Description --title Server group title. --anti-affinity-policy Anti-affinity policy. Valid values are yes (best effort), strict and no. Will take effect upon server start.Default: yes--label Labels to describe the server group in key=value format, multiple can be declared.Usage: --label env=dev--label owner=operationsDefault: []--server Servers to be added to the server group, multiple can be declared.Usage: --server my-server--server 00333d1b-3a4a-4b75-820a-4a56d70395ddDefault: []--help, -h help for createDefault: false"},{"location":"commands_reference/upctl_servergroup/create/#global-options","title":"Global options","text":"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. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output, -o Output format (supported: json, yaml and human)Default: human"},{"location":"commands_reference/upctl_servergroup/create/#related-commands","title":"Related commands","text":"Command Description upctl servergroup Manage server groups"},{"location":"commands_reference/upctl_servergroup/delete/","title":"upctl servergroup delete","text":"
"},{"location":"commands_reference/upctl_servergroup/delete/#options","title":"Options","text":"Option Description --help, -h help for deleteDefault: false"},{"location":"commands_reference/upctl_servergroup/delete/#global-options","title":"Global options","text":"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. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output, -o Output format (supported: json, yaml and human)Default: human"},{"location":"commands_reference/upctl_servergroup/delete/#related-commands","title":"Related commands","text":"Command Description upctl servergroup Manage server groups"},{"location":"commands_reference/upctl_servergroup/list/","title":"upctl servergroup list","text":"
"},{"location":"commands_reference/upctl_servergroup/list/#options","title":"Options","text":"Option Description --help, -h help for listDefault: false"},{"location":"commands_reference/upctl_servergroup/list/#global-options","title":"Global options","text":"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. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output, -o Output format (supported: json, yaml and human)Default: human"},{"location":"commands_reference/upctl_servergroup/list/#related-commands","title":"Related commands","text":"Command Description upctl servergroup Manage server groups"},{"location":"commands_reference/upctl_servergroup/modify/","title":"upctl servergroup modify","text":"
"},{"location":"commands_reference/upctl_servergroup/modify/#options","title":"Options","text":"Option Description --anti-affinity-policy Anti-affinity policy. Valid values are yes (best effort), strict and no. Will take effect upon server start. --label Labels to describe the server in key=value format, multiple can be declared. If set, all the existing labels will be replaced with provided ones.Usage: --label env=dev--label owner=operationsDefault: []--title New server group title. --server Servers that belong to the server group, multiple can be declared. If set, all the existing server entries will be replaced with provided ones.Usage: --server my-server--server 00333d1b-3a4a-4b75-820a-4a56d70395ddDefault: []--help, -h help for modifyDefault: false"},{"location":"commands_reference/upctl_servergroup/modify/#global-options","title":"Global options","text":"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. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output, -o Output format (supported: json, yaml and human)Default: human"},{"location":"commands_reference/upctl_servergroup/modify/#related-commands","title":"Related commands","text":"Command Description upctl servergroup Manage server groups"},{"location":"commands_reference/upctl_servergroup/show/","title":"upctl servergroup show","text":"
upctl servergroup show 8abc8009-4325-4b23-4321-b1232cd81231\nupctl servergroup show my-server-group\n
"},{"location":"commands_reference/upctl_servergroup/show/#options","title":"Options","text":"Option Description --help, -h help for showDefault: false"},{"location":"commands_reference/upctl_servergroup/show/#global-options","title":"Global options","text":"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. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output, -o Output format (supported: json, yaml and human)Default: human"},{"location":"commands_reference/upctl_servergroup/show/#related-commands","title":"Related commands","text":"Command Description upctl servergroup Manage server groups"},{"location":"commands_reference/upctl_storage/","title":"upctl storage","text":"
Manage storages
upctl storage [flags]\n
"},{"location":"commands_reference/upctl_storage/#options","title":"Options","text":"Option Description --help, -h help for storageDefault: false"},{"location":"commands_reference/upctl_storage/#global-options","title":"Global options","text":"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. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output, -o Output format (supported: json, yaml and human)Default: human"},{"location":"commands_reference/upctl_storage/#related-commands","title":"Related commands","text":"Command Description upctl UpCloud command-line interface upctl storage backup Manage backups upctl storage clone Clone a storage upctl storage create Create a storage upctl storage delete Delete a storage upctl storage import Import a storage from external or local source upctl storage list List current storages upctl storage modify Modify a storage upctl storage show Show storage details upctl storage templatise Templatise a storage"},{"location":"commands_reference/upctl_storage/clone/","title":"upctl storage clone","text":"
"},{"location":"commands_reference/upctl_storage/clone/#options","title":"Options","text":"Option Description --tier The storage tier to use.Default: hdd--title A short, informational description. --zone Zone where to create the storage. Run upctl zone list to list all available zones. --encrypt Encrypt the new storage. --help, -h help for cloneDefault: false"},{"location":"commands_reference/upctl_storage/clone/#global-options","title":"Global options","text":"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. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output, -o Output format (supported: json, yaml and human)Default: human"},{"location":"commands_reference/upctl_storage/clone/#related-commands","title":"Related commands","text":"Command Description upctl storage Manage storages"},{"location":"commands_reference/upctl_storage/create/","title":"upctl storage create","text":"
"},{"location":"commands_reference/upctl_storage/create/#options","title":"Options","text":"Option Description --title A short, informational description. --size Size of the storage in GiB.Default: 10--zone Zone where to create the storage. Run upctl zone list to list all available zones. --tier Storage tier.Default: maxiops--encrypt Encrypt the storage. --backup-time The time when to create a backup in HH:MM. Empty value means no backups. --backup-interval The interval of the backup.Available: daily, mon, tue, wed, thu, fri, sat, sunDefault: daily--backup-retention How long to store the backups in days. The accepted range is 1-1095Default: 7--help, -h help for createDefault: false"},{"location":"commands_reference/upctl_storage/create/#global-options","title":"Global options","text":"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. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output, -o Output format (supported: json, yaml and human)Default: human"},{"location":"commands_reference/upctl_storage/create/#related-commands","title":"Related commands","text":"Command Description upctl storage Manage storages"},{"location":"commands_reference/upctl_storage/delete/","title":"upctl storage delete","text":"
"},{"location":"commands_reference/upctl_storage/delete/#options","title":"Options","text":"Option Description --help, -h help for deleteDefault: false"},{"location":"commands_reference/upctl_storage/delete/#global-options","title":"Global options","text":"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. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output, -o Output format (supported: json, yaml and human)Default: human"},{"location":"commands_reference/upctl_storage/delete/#related-commands","title":"Related commands","text":"Command Description upctl storage Manage storages"},{"location":"commands_reference/upctl_storage/import/","title":"upctl storage import","text":"
"},{"location":"commands_reference/upctl_storage/import/#options","title":"Options","text":"Option Description --source-location Location of the source of the import. Can be a file or a URL. --storage Import to an existing storage. Storage must be large enough and must be undetached or the server where the storage is attached must be in shutdown state. --no-wait When importing from remote url, do not wait until the import finishes or storage is in online state. If set, command will exit after import process has been initialized. --wait Wait for storage to be in online state before returning. --title A short, informational description. --size Size of the storage in GiB.Default: 10--zone Zone where to create the storage. Run upctl zone list to list all available zones. --tier Storage tier.Default: maxiops--encrypt Encrypt the storage. --backup-time The time when to create a backup in HH:MM. Empty value means no backups. --backup-interval The interval of the backup.Available: daily, mon, tue, wed, thu, fri, sat, sunDefault: daily--backup-retention How long to store the backups in days. The accepted range is 1-1095Default: 7--help, -h help for importDefault: false"},{"location":"commands_reference/upctl_storage/import/#global-options","title":"Global options","text":"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. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output, -o Output format (supported: json, yaml and human)Default: human"},{"location":"commands_reference/upctl_storage/import/#related-commands","title":"Related commands","text":"Command Description upctl storage Manage storages"},{"location":"commands_reference/upctl_storage/list/","title":"upctl storage list","text":"
"},{"location":"commands_reference/upctl_storage/list/#options","title":"Options","text":"Option Description --all Show all storages. --private Show private storages (default). --public Show public storages. --normal Show only normal storages. --backup Show only backup storages. --cdrom Show only cdrom storages. --template Show only template storages. --help, -h help for listDefault: false"},{"location":"commands_reference/upctl_storage/list/#global-options","title":"Global options","text":"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. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output, -o Output format (supported: json, yaml and human)Default: human"},{"location":"commands_reference/upctl_storage/list/#related-commands","title":"Related commands","text":"Command Description upctl storage Manage storages"},{"location":"commands_reference/upctl_storage/modify/","title":"upctl storage modify","text":"
"},{"location":"commands_reference/upctl_storage/modify/#options","title":"Options","text":"Option Description --title A short, informational description. --size Size of the storage (GiB).Default: 0--backup-time The time when to create a backup in HH:MM. Empty value means no backups. --backup-interval The interval of the backup.Available: daily, mon, tue, wed, thu, fri, sat, sun --backup-retention How long to store the backups in days. The accepted range is 1-1095.Default: 0--enable-filesystem-autoresize Enable automatic resize of partition and filesystem when modifying storage size. Note that before the resize attempt is made, backup of the storage will be taken. If the resize attempt fails, the backup will be used to restore the storage and then deleted. If the resize attempt succeeds, backup will be kept. Taking and keeping backups incur costs.. --help, -h help for modifyDefault: false"},{"location":"commands_reference/upctl_storage/modify/#global-options","title":"Global options","text":"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. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output, -o Output format (supported: json, yaml and human)Default: human"},{"location":"commands_reference/upctl_storage/modify/#related-commands","title":"Related commands","text":"Command Description upctl storage Manage storages"},{"location":"commands_reference/upctl_storage/show/","title":"upctl storage show","text":"
upctl storage show 01271548-2e92-44bb-9774-d282508cc762\nupctl storage show 01271548-2e92-44bb-9774-d282508cc762 01c60190-3a01-4108-b1c3-2e828855ccc0\nupctl storage show \"My Storage\"\n
"},{"location":"commands_reference/upctl_storage/show/#options","title":"Options","text":"Option Description --help, -h help for showDefault: false"},{"location":"commands_reference/upctl_storage/show/#global-options","title":"Global options","text":"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. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output, -o Output format (supported: json, yaml and human)Default: human"},{"location":"commands_reference/upctl_storage/show/#related-commands","title":"Related commands","text":"Command Description upctl storage Manage storages"},{"location":"commands_reference/upctl_storage/templatise/","title":"upctl storage templatise","text":"
"},{"location":"commands_reference/upctl_storage/templatise/#options","title":"Options","text":"Option Description --title A short, informational description. --wait Wait for storage to be in online state before returning. --help, -h help for templatiseDefault: false"},{"location":"commands_reference/upctl_storage/templatise/#global-options","title":"Global options","text":"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. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output, -o Output format (supported: json, yaml and human)Default: human"},{"location":"commands_reference/upctl_storage/templatise/#related-commands","title":"Related commands","text":"Command Description upctl storage Manage storages"},{"location":"commands_reference/upctl_storage/backup/","title":"upctl storage backup","text":"
Manage backups
upctl storage backup [flags]\n
"},{"location":"commands_reference/upctl_storage/backup/#options","title":"Options","text":"Option Description --help, -h help for backupDefault: false"},{"location":"commands_reference/upctl_storage/backup/#global-options","title":"Global options","text":"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. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output, -o Output format (supported: json, yaml and human)Default: human"},{"location":"commands_reference/upctl_storage/backup/#related-commands","title":"Related commands","text":"Command Description upctl storage Manage storages upctl storage backup create Create backup of a storage upctl storage backup restore Restore backup of a storage"},{"location":"commands_reference/upctl_storage/backup/create/","title":"upctl storage backup create","text":"
"},{"location":"commands_reference/upctl_storage/backup/restore/#options","title":"Options","text":"Option Description --help, -h help for restoreDefault: false"},{"location":"commands_reference/upctl_storage/backup/restore/#global-options","title":"Global options","text":"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. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output, -o Output format (supported: json, yaml and human)Default: human"},{"location":"commands_reference/upctl_storage/backup/restore/#related-commands","title":"Related commands","text":"Command Description upctl storage backup Manage backups"},{"location":"commands_reference/upctl_zone/","title":"upctl zone","text":"
Display zone information
upctl zone [flags]\n
"},{"location":"commands_reference/upctl_zone/#options","title":"Options","text":"Option Description --help, -h help for zoneDefault: false"},{"location":"commands_reference/upctl_zone/#global-options","title":"Global options","text":"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. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output, -o Output format (supported: json, yaml and human)Default: human"},{"location":"commands_reference/upctl_zone/#related-commands","title":"Related commands","text":"Command Description upctl UpCloud command-line interface upctl zone list List available zones"},{"location":"commands_reference/upctl_zone/list/","title":"upctl zone list","text":"
"},{"location":"commands_reference/upctl_zone/list/#options","title":"Options","text":"Option Description --help, -h help for listDefault: false"},{"location":"commands_reference/upctl_zone/list/#global-options","title":"Global options","text":"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. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output, -o Output format (supported: json, yaml and human)Default: human"},{"location":"commands_reference/upctl_zone/list/#related-commands","title":"Related commands","text":"Command Description upctl zone Display zone information"},{"location":"examples/","title":"Examples","text":"
This directory contains examples on more complex upctl use-cases. As upctl is often used in scripts the examples also aim to parse values from machine readable outputs. This allows using the examples also as end-to-end test cases and makes them more copy-pasteable.
The examples in this directory are validated with mdtest. It parses env and sh code-blocks from the markdown files and executes those as scripts.
The tool can be installed with go install.
go install github.com/UpCloudLtd/mdtest@latest\n
To test the examples, run mdtest ..
mdtest .\n
"},{"location":"examples/create_a_custom_template/","title":"Create a custom template","text":"
This example demonstrates how to create a custom template with upctl.
To keep track of resources created during this example, we will use common prefix in all resource names.
prefix=example-upctl-custom-template-\n
First, we will create server which disk will be used as a source for the custom template.
# Create ssh-key into current working directory\nssh-keygen -t ed25519 -q -f \"./id_ed25519\" -N \"\"\n\nupctl server create \\\n --hostname ${prefix}source-server \\\n --zone pl-waw1 \\\n --ssh-keys ./id_ed25519.pub \\\n --network type=public \\\n --network type=utility \\\n --wait\n
After the server has started, you can connect to it and prepare the disk to be templatized. Then, to be able to templatize the storage disk, we will stop the server.
upctl server stop --type hard --wait ${prefix}source-server\n
The default name for the OS storage of servers created with upctl is ${server-title}-OS, in this case ${prefix}source-server-OS. We can use either that or the UUID of the storage, when creating the template. UUID of the storage can be printed, for example, by processing json output with jq.
upctl server show ${prefix}source-server -o json \\\n | jq -r \".storage[0].uuid\"\n
To have something to backup, we will install a nginx server and configure a non-default HTML content to serve.
configure-nginx.sh
#!/bin/sh -xe\n\napt install nginx -y\necho \"Hello from $(hostname)\"'!' > /var/www/html/index.html\n
To configure the server, we will parse the public IP of the server and run the above script using SSH connection. We can then use curl to ensure that the HTTP server serves the content we defined.
# Parse public IP of the server with jq\nip=$(upctl server show ${prefix}source-server -o json | jq -r '.networking.interfaces[] | select(.type == \"public\") | .ip_addresses[0].address')\n\n# Wait for a moment for the ssh server to become available\nsleep 30\n\n# Run the script defined above\nssh -i id_ed25519 -o StrictHostKeyChecking=accept-new root@$ip \"sh\" < configure-nginx.sh\n\n# Validate HTTP server response\ntest \"$(curl -s $ip)\" = 'Hello from example-upctl-backup-source-server!'\n
We will then backup the OS disk of the created server.
To validate that the server was re-created successfully, we will parse the public IP of the server and use curl to see that the HTTP server is running.
# Parse public IP of the server with jq\nip=$(upctl server show ${prefix}restored-server -o json | jq -r '.networking.interfaces[] | select(.type == \"public\") | .ip_addresses[0].address')\n\n# Wait until server returns expected response\nfor i in $(seq 1 9); do\n test \"$(curl -s $ip)\" = 'Hello from example-upctl-backup-source-server!' && break || true;\n sleep 15;\ndone;\n
Finally, we can cleanup the created resources.
# Delete the restored server and its storages\nupctl server stop --type hard --wait ${prefix}restored-server\nupctl server delete ${prefix}restored-server --delete-storages\n\n# Delete the backup\nupctl storage delete ${prefix}source-server-backup\n
"},{"location":"examples/create_and_ssh_into_a_server/","title":"Create and ssh into a server","text":"
This example demonstrates how to create a server with upctl and connect to the created server via ssh connection.
To keep track of resources created during this example, we will use common prefix in all resource names.
prefix=example-upctl-ssh-server-\n
In order to be able to connect to the server we are going to create, we will need an ssh-key. If you already have a ssh-key available, you can skip this step. The example creates the ssh-key into the current working directory, if you want to use this key for other authentication purposes as well, create the key into ~/.ssh directory instead.
# Create ssh-key into current working directory\nssh-keygen -t ed25519 -q -f \"./id_ed25519\" -N \"\" -C \"upctl example\"\n
Create a server using the above created ssh-key as login method.
Find the IP address of the created server from the JSON output of upctl server show and execute hostname command via ssh connection on the created server.
# Parse public IP of the server with jq\nip=$(upctl server show ${prefix}server -o json | jq -r '.networking.interfaces[] | select(.type == \"public\") | .ip_addresses[0].address')\n\n# Wait for a moment for the ssh server to become available\nsleep 30\n\nssh -i id_ed25519 -o StrictHostKeyChecking=accept-new root@$ip \"hostname\"\n
Finally, we can cleanup the created resources.
upctl server stop --type hard --wait ${prefix}server\nupctl server delete ${prefix}server --delete-storages\n
upctl sets exit code based on number of failed tasks up to exit code 99. This example demonstrates executions with few different exit codes.
To keep track of resources created during this example, we will use common prefix in all resource names.
prefix=example-upctl-exit-codes-\n
Exit code 100 is set, for example, when command argument validation fails.
upctl server create\n# Error: required flag(s) \"hostname\", \"zone\" not set\n
Let's create two servers and stop one of those to later see other failing exit codes. This example uses --type hard when stopping the servers as the OS might not be completely up and running when the server reaches running state. These command should succeed, and thus return zero exit code.
# Create ssh-key into current working directory\nssh-keygen -t ed25519 -q -f \"./id_ed25519\" -N \"\"\n\nupctl server create --hostname ${prefix}vm-1 --zone pl-waw1 --ssh-keys ./id_ed25519.pub --wait\nupctl server create --hostname ${prefix}vm-2 --zone pl-waw1 --ssh-keys ./id_ed25519.pub --wait\n\nupctl server stop --type hard ${prefix}vm-1 --wait\n
Now let's try to stop both both of the created servers. Exit code will be one, as ${prefix}vm-1 is already stopped and thus cannot be stopped again. ${prefix}vm-2, though, will be stopped as it was online. Thus one of the two operations failed.
upctl server stop --type hard ${prefix}vm-1 ${prefix}vm-2 --wait\n
If we now try to run above command again, exit code will be two as both of the servers are already stopped. Thus both stop operations failed.
upctl server stop --type hard ${prefix}vm-1 ${prefix}vm-2 --wait\n
Finally, we can cleanup the created resources.
upctl server delete ${prefix}vm-1 ${prefix}vm-2 --delete-storages\n