diff --git a/404.html b/404.html index 060bfb12..dd241077 100644 --- a/404.html +++ b/404.html @@ -1144,6 +1144,91 @@ + + + + + + + + + + +
  • + + + + + + + + + + +
  • + + + + diff --git a/changelog/index.html b/changelog/index.html index e5f68031..9bbd3a9a 100644 --- a/changelog/index.html +++ b/changelog/index.html @@ -1153,6 +1153,91 @@ + + + + + + + + + + +
  • + + + + + + + + + + +
  • + + + + @@ -5122,9 +5207,13 @@

    Changelog

    The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.

    Unreleased

    -

    3.14.0 - 2025-01-08

    Added

    +

    3.14.0 - 2025-01-08

    +

    Added

    + @@ -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.
  • 3.13.0 - 2024-12-13

    -

    Added

    +

    Added

    @@ -5154,7 +5243,7 @@

    Fixed

  • 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.
  • 3.11.0 - 2024-07-23

    -

    Added

    +

    Added

    3.9.0 - 2024-07-04

    -

    Added

    +

    Added

    3.8.0 - 2024-04-30

    -

    Added

    +

    Added

    3.7.0 - 2024-04-04

    -

    Added

    +

    Added

    3.6.0 - 2024-03-07

    -

    Added

    +

    Added

    3.5.0 - 2024-02-29

    -

    Added

    +

    Added

    3.4.0 - 2024-02-08

    -

    Added

    +

    Added

    3.3.0 - 2024-01-23

    -

    Added

    +

    Added

    3.2.2 - 2024-01-02

    -

    Added

    +

    Added

    @@ -5248,17 +5337,17 @@

    Fixed

  • Do not return error on valid dhcp-default-route values in network create and network modify commands.
  • 3.2.1 - 2023-11-29

    -

    Added

    +

    Added

    3.2.0 - 2023-11-15

    -

    Added

    +

    Added

    3.1.0 - 2023-11-06

    -

    Added

    +

    Added

    2.9.0 - 2023-06-30

    -

    Added

    +

    Added

    2.8.0 - 2023-06-21

    -

    Added

    +

    Added

    2.7.0 - 2023-05-02

    -

    Added

    +

    Added

    2.6.0 - 2023-03-14

    -

    Added

    +

    Added

    2.5.0 - 2023-02-15

    -

    Added

    +

    Added

    2.4.0 - 2022-12-19

    -

    Added

    +

    Added

    2.3.0 - 2022-11-11

    -

    Added

    +

    Added

    2.2.0 - 2022-10-17

    -

    Added

    +

    Added

    2.1.0 - 2022-09-07

    -

    Added

    +

    Added

    2.0.0 - 2022-08-30

    -

    Added

    +

    Added

    1.5.0 - 2022-07-05

    -

    Added

    +

    Added

    1.4.0 - 2022-06-15

    -

    Added

    +

    Added

    1.3.0 - 2022-05-17

    -

    Added

    +

    Added

    1.2.0 - 2022-04-29

    -

    Added

    +

    Added

    1.1.0 - 2021-06-03

    -

    Added

    +

    Added

    0.5.0 - 2021-04-14

    Initial public beta release :tada:

    -

    Added

    +

    Added

    @@ -5597,7 +5686,7 @@

    Fixed

  • Fix storage import failing on readerCounter not implementing io.Reader
  • 0.1.0 - 2021-03-10

    -

    Added

    +

    Added

    diff --git a/commands_reference/upctl/index.html b/commands_reference/upctl/index.html index 1ff0068d..e432d8c0 100644 --- a/commands_reference/upctl/index.html +++ b/commands_reference/upctl/index.html @@ -1209,6 +1209,91 @@ + + + + + + + + + + +
  • + + + + + + + + + + +
  • + + + + diff --git a/commands_reference/upctl_account/delete/index.html b/commands_reference/upctl_account/delete/index.html index b6af20b8..5574ec81 100644 --- a/commands_reference/upctl_account/delete/index.html +++ b/commands_reference/upctl_account/delete/index.html @@ -1223,6 +1223,91 @@ + + + + + + + + + + +
  • + + + + + + + + + + +
  • + + + + diff --git a/commands_reference/upctl_account/index.html b/commands_reference/upctl_account/index.html index b7e6cbbe..140d98a2 100644 --- a/commands_reference/upctl_account/index.html +++ b/commands_reference/upctl_account/index.html @@ -1217,6 +1217,91 @@ + + + + + + + + + + +
  • + + + + + + + + + + +
  • + + + + diff --git a/commands_reference/upctl_account/list/index.html b/commands_reference/upctl_account/list/index.html index 4861d8ec..5473e864 100644 --- a/commands_reference/upctl_account/list/index.html +++ b/commands_reference/upctl_account/list/index.html @@ -1223,6 +1223,91 @@ + + + + + + + + + + +
  • + + + + + + + + + + +
  • + + + + diff --git a/commands_reference/upctl_account/permissions/index.html b/commands_reference/upctl_account/permissions/index.html index c3dd5626..8deffc70 100644 --- a/commands_reference/upctl_account/permissions/index.html +++ b/commands_reference/upctl_account/permissions/index.html @@ -1219,6 +1219,91 @@ + + + + + + + + + + +
  • + + + + + + + + + + +
  • + + + + diff --git a/commands_reference/upctl_account/permissions/list/index.html b/commands_reference/upctl_account/permissions/list/index.html index 62756a3a..6a3ec674 100644 --- a/commands_reference/upctl_account/permissions/list/index.html +++ b/commands_reference/upctl_account/permissions/list/index.html @@ -1225,6 +1225,91 @@ + + + + + + + + + + +
  • + + + + + + + + + + +
  • + + + + diff --git a/commands_reference/upctl_account/show/index.html b/commands_reference/upctl_account/show/index.html index b64f49eb..ba8eeb5d 100644 --- a/commands_reference/upctl_account/show/index.html +++ b/commands_reference/upctl_account/show/index.html @@ -1223,6 +1223,91 @@ + + + + + + + + + + +
  • + + + + + + + + + + +
  • + + + + diff --git a/commands_reference/upctl_database/delete/index.html b/commands_reference/upctl_database/delete/index.html index b6af22c0..93bcfc49 100644 --- a/commands_reference/upctl_database/delete/index.html +++ b/commands_reference/upctl_database/delete/index.html @@ -1223,6 +1223,91 @@ + + + + + + + + + + +
  • + + + + + + + + + + +
  • + + + + diff --git a/commands_reference/upctl_database/index.html b/commands_reference/upctl_database/index.html index 354358ab..a53daa19 100644 --- a/commands_reference/upctl_database/index.html +++ b/commands_reference/upctl_database/index.html @@ -1223,6 +1223,91 @@ + + + + + + + + + + +
  • + + + + + + + + + + +
  • + + + + diff --git a/commands_reference/upctl_database/index/delete/index.html b/commands_reference/upctl_database/index/delete/index.html index 46e4b318..70654aca 100644 --- a/commands_reference/upctl_database/index/delete/index.html +++ b/commands_reference/upctl_database/index/delete/index.html @@ -1225,6 +1225,91 @@ + + + + + + + + + + +
  • + + + + + + + + + + +
  • + + + + diff --git a/commands_reference/upctl_database/index/index.html b/commands_reference/upctl_database/index/index.html index d3f92cb8..ec91cba6 100644 --- a/commands_reference/upctl_database/index/index.html +++ b/commands_reference/upctl_database/index/index.html @@ -1225,6 +1225,91 @@ + + + + + + + + + + +
  • + + + + + + + + + + +
  • + + + + diff --git a/commands_reference/upctl_database/index/list/index.html b/commands_reference/upctl_database/index/list/index.html index 43dbaae7..b2aec56e 100644 --- a/commands_reference/upctl_database/index/list/index.html +++ b/commands_reference/upctl_database/index/list/index.html @@ -1225,6 +1225,91 @@ + + + + + + + + + + +
  • + + + + + + + + + + +
  • + + + + diff --git a/commands_reference/upctl_database/list/index.html b/commands_reference/upctl_database/list/index.html index cc9a0f6f..92c9fdf0 100644 --- a/commands_reference/upctl_database/list/index.html +++ b/commands_reference/upctl_database/list/index.html @@ -1223,6 +1223,91 @@ + + + + + + + + + + +
  • + + + + + + + + + + +
  • + + + + diff --git a/commands_reference/upctl_database/plans/index.html b/commands_reference/upctl_database/plans/index.html index 9498e72b..6afb6b73 100644 --- a/commands_reference/upctl_database/plans/index.html +++ b/commands_reference/upctl_database/plans/index.html @@ -1223,6 +1223,91 @@ + + + + + + + + + + +
  • + + + + + + + + + + +
  • + + + + diff --git a/commands_reference/upctl_database/properties/index.html b/commands_reference/upctl_database/properties/index.html index 277e3725..94b3ea36 100644 --- a/commands_reference/upctl_database/properties/index.html +++ b/commands_reference/upctl_database/properties/index.html @@ -1225,6 +1225,91 @@ + + + + + + + + + + +
  • + + + + + + + + + + +
  • + + + + @@ -4696,6 +4781,10 @@ upctl database properties redis List available properties for Redis databases + +upctl database properties valkey +List available properties for Valkey databases + diff --git a/commands_reference/upctl_database/properties/mysql/index.html b/commands_reference/upctl_database/properties/mysql/index.html index 07869ea7..55fd5e68 100644 --- a/commands_reference/upctl_database/properties/mysql/index.html +++ b/commands_reference/upctl_database/properties/mysql/index.html @@ -1227,6 +1227,91 @@ + + + + + + + + + + +
  • + + + + + + + + + + +
  • + + + + diff --git a/commands_reference/upctl_database/properties/mysql/show/index.html b/commands_reference/upctl_database/properties/mysql/show/index.html index 85ef9671..64523a8c 100644 --- a/commands_reference/upctl_database/properties/mysql/show/index.html +++ b/commands_reference/upctl_database/properties/mysql/show/index.html @@ -1227,6 +1227,91 @@ + + + + + + + + + + +
  • + + + + + + + + + + +
  • + + + + diff --git a/commands_reference/upctl_database/properties/opensearch/index.html b/commands_reference/upctl_database/properties/opensearch/index.html index 6d82291f..f8461768 100644 --- a/commands_reference/upctl_database/properties/opensearch/index.html +++ b/commands_reference/upctl_database/properties/opensearch/index.html @@ -1227,6 +1227,91 @@ + + + + + + + + + + +
  • + + + + + + + + + + +
  • + + + + diff --git a/commands_reference/upctl_database/properties/opensearch/show/index.html b/commands_reference/upctl_database/properties/opensearch/show/index.html index 8be45c44..edf1d35d 100644 --- a/commands_reference/upctl_database/properties/opensearch/show/index.html +++ b/commands_reference/upctl_database/properties/opensearch/show/index.html @@ -1227,6 +1227,91 @@ + + + + + + + + + + +
  • + + + + + + + + + + +
  • + + + + diff --git a/commands_reference/upctl_database/properties/pg/index.html b/commands_reference/upctl_database/properties/pg/index.html index de30a539..ec5573bb 100644 --- a/commands_reference/upctl_database/properties/pg/index.html +++ b/commands_reference/upctl_database/properties/pg/index.html @@ -1227,6 +1227,91 @@ + + + + + + + + + + +
  • + + + + + + + + + + +
  • + + + + diff --git a/commands_reference/upctl_database/properties/pg/show/index.html b/commands_reference/upctl_database/properties/pg/show/index.html index 01db55de..e0fb9024 100644 --- a/commands_reference/upctl_database/properties/pg/show/index.html +++ b/commands_reference/upctl_database/properties/pg/show/index.html @@ -1227,6 +1227,91 @@ + + + + + + + + + + +
  • + + + + + + + + + + +
  • + + + + diff --git a/commands_reference/upctl_database/properties/redis/index.html b/commands_reference/upctl_database/properties/redis/index.html index fcfd4104..77728b64 100644 --- a/commands_reference/upctl_database/properties/redis/index.html +++ b/commands_reference/upctl_database/properties/redis/index.html @@ -1227,6 +1227,91 @@ + + + + + + + + + + +
  • + + + + + + + + + + +
  • + + + + diff --git a/commands_reference/upctl_database/properties/redis/show/index.html b/commands_reference/upctl_database/properties/redis/show/index.html index 4672fd54..60c87fbe 100644 --- a/commands_reference/upctl_database/properties/redis/show/index.html +++ b/commands_reference/upctl_database/properties/redis/show/index.html @@ -16,7 +16,7 @@ - + @@ -1227,6 +1227,91 @@ + + + + + + + + + + +
  • + + + + + + + + + + +
  • + + + + diff --git a/commands_reference/upctl_database/properties/valkey/index.html b/commands_reference/upctl_database/properties/valkey/index.html new file mode 100644 index 00000000..addc93d9 --- /dev/null +++ b/commands_reference/upctl_database/properties/valkey/index.html @@ -0,0 +1,4839 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + upctl database properties valkey - UpCloud command-line client + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + + + + +
    + + +
    + +
    + + + + + + +
    +
    + + + +
    +
    +
    + + + + + +
    +
    +
    + + + +
    +
    +
    + + + +
    +
    +
    + + + +
    +
    + + + + +

    upctl database properties valkey

    +

    List available properties for Valkey databases

    +
    upctl database properties valkey [flags]
    +
    +

    Examples

    +
    upctl database properties valkey
    +
    +

    Options

    + + + + + + + + + + + + + +
    OptionDescription
    --help, -hhelp for valkey
    Default: false
    +

    Global options

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    OptionDescription
    --client-timeout, -tClient timeout to use in API calls.
    Default: 0s
    --configConfiguration file path.
    --debugPrint out more verbose debug logs.
    Default: false
    --force-coloursForce coloured output despite detected terminal support.
    --no-coloursDisable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable.
    --output, -oOutput format (supported: json, yaml and human)
    Default: human
    + + + + + + + + + + + + + + + + + + +
    CommandDescription
    upctl database propertiesList available properties for given database type
    upctl database properties valkey showShow Valkey database property details
    + + + + + + + + + + + + + + + + +
    +
    + + + +
    + +
    + + + + + +
    +
    +
    +
    + + + + + + + + + + \ No newline at end of file diff --git a/commands_reference/upctl_database/properties/valkey/show/index.html b/commands_reference/upctl_database/properties/valkey/show/index.html new file mode 100644 index 00000000..ed2ba428 --- /dev/null +++ b/commands_reference/upctl_database/properties/valkey/show/index.html @@ -0,0 +1,4835 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + upctl database properties valkey show - UpCloud command-line client + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + + + + +
    + + +
    + +
    + + + + + + +
    +
    + + + +
    +
    +
    + + + + + +
    +
    +
    + + + +
    +
    +
    + + + +
    +
    +
    + + + +
    +
    + + + + +

    upctl database properties valkey show

    +

    Show Valkey database property details

    +
    upctl database properties valkey show [flags]
    +
    +

    Examples

    +
    upctl database properties valkey show version
    +
    +

    Options

    + + + + + + + + + + + + + +
    OptionDescription
    --help, -hhelp for show
    Default: false
    +

    Global options

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    OptionDescription
    --client-timeout, -tClient timeout to use in API calls.
    Default: 0s
    --configConfiguration file path.
    --debugPrint out more verbose debug logs.
    Default: false
    --force-coloursForce coloured output despite detected terminal support.
    --no-coloursDisable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable.
    --output, -oOutput format (supported: json, yaml and human)
    Default: human
    + + + + + + + + + + + + + + +
    CommandDescription
    upctl database properties valkeyList available properties for Valkey databases
    + + + + + + + + + + + + + + + + +
    +
    + + + +
    + +
    + + + + + +
    +
    +
    +
    + + + + + + + + + + \ No newline at end of file diff --git a/commands_reference/upctl_database/session/cancel/index.html b/commands_reference/upctl_database/session/cancel/index.html index c865c9a6..7c4c7e1d 100644 --- a/commands_reference/upctl_database/session/cancel/index.html +++ b/commands_reference/upctl_database/session/cancel/index.html @@ -1159,6 +1159,91 @@ + + + + + + + + + + +
  • + + + + + + + + + + +
  • + + + + diff --git a/commands_reference/upctl_database/session/index.html b/commands_reference/upctl_database/session/index.html index c15c74cd..874e344b 100644 --- a/commands_reference/upctl_database/session/index.html +++ b/commands_reference/upctl_database/session/index.html @@ -13,7 +13,7 @@ - + @@ -1159,6 +1159,91 @@ + + + + + + + + + + +
  • + + + + + + + + + + +
  • + + + + diff --git a/commands_reference/upctl_database/session/list/index.html b/commands_reference/upctl_database/session/list/index.html index 35e84481..a7251a0a 100644 --- a/commands_reference/upctl_database/session/list/index.html +++ b/commands_reference/upctl_database/session/list/index.html @@ -1159,6 +1159,91 @@ + + + + + + + + + + +
  • + + + + + + + + + + +
  • + + + + diff --git a/commands_reference/upctl_database/show/index.html b/commands_reference/upctl_database/show/index.html index fa647261..eb3234f3 100644 --- a/commands_reference/upctl_database/show/index.html +++ b/commands_reference/upctl_database/show/index.html @@ -1159,6 +1159,91 @@ + + + + + + + + + + +
  • + + + + + + + + + + +
  • + + + + diff --git a/commands_reference/upctl_database/start/index.html b/commands_reference/upctl_database/start/index.html index 88851463..02c1e603 100644 --- a/commands_reference/upctl_database/start/index.html +++ b/commands_reference/upctl_database/start/index.html @@ -1159,6 +1159,91 @@ + + + + + + + + + + +
  • + + + + + + + + + + +
  • + + + + diff --git a/commands_reference/upctl_database/stop/index.html b/commands_reference/upctl_database/stop/index.html index 09e0464e..22ba7c89 100644 --- a/commands_reference/upctl_database/stop/index.html +++ b/commands_reference/upctl_database/stop/index.html @@ -1159,6 +1159,91 @@ + + + + + + + + + + +
  • + + + + + + + + + + +
  • + + + + diff --git a/commands_reference/upctl_database/types/index.html b/commands_reference/upctl_database/types/index.html index 4fb39637..d6c273b0 100644 --- a/commands_reference/upctl_database/types/index.html +++ b/commands_reference/upctl_database/types/index.html @@ -1159,6 +1159,91 @@ + + + + + + + + + + +
  • + + + + + + + + + + +
  • + + + + diff --git a/commands_reference/upctl_gateway/delete/index.html b/commands_reference/upctl_gateway/delete/index.html index bb6bfd51..e3c03292 100644 --- a/commands_reference/upctl_gateway/delete/index.html +++ b/commands_reference/upctl_gateway/delete/index.html @@ -1157,6 +1157,91 @@ + + + + + + + + + + +
  • + + + + + + + + + + +
  • + + + + diff --git a/commands_reference/upctl_gateway/index.html b/commands_reference/upctl_gateway/index.html index 3ac5ace3..c8511642 100644 --- a/commands_reference/upctl_gateway/index.html +++ b/commands_reference/upctl_gateway/index.html @@ -1157,6 +1157,91 @@ + + + + + + + + + + +
  • + + + + + + + + + + +
  • + + + + diff --git a/commands_reference/upctl_gateway/list/index.html b/commands_reference/upctl_gateway/list/index.html index ec73ba71..d49967b1 100644 --- a/commands_reference/upctl_gateway/list/index.html +++ b/commands_reference/upctl_gateway/list/index.html @@ -1157,6 +1157,91 @@ + + + + + + + + + + +
  • + + + + + + + + + + +
  • + + + + diff --git a/commands_reference/upctl_gateway/plans/index.html b/commands_reference/upctl_gateway/plans/index.html index 5da3aa6a..8d5e80f2 100644 --- a/commands_reference/upctl_gateway/plans/index.html +++ b/commands_reference/upctl_gateway/plans/index.html @@ -1157,6 +1157,91 @@ + + + + + + + + + + +
  • + + + + + + + + + + +
  • + + + + diff --git a/commands_reference/upctl_host/index.html b/commands_reference/upctl_host/index.html index 3e3bd29f..71134ff8 100644 --- a/commands_reference/upctl_host/index.html +++ b/commands_reference/upctl_host/index.html @@ -1157,6 +1157,91 @@ + + + + + + + + + + +
  • + + + + + + + + + + +
  • + + + + diff --git a/commands_reference/upctl_host/list/index.html b/commands_reference/upctl_host/list/index.html index 499c9583..8f4c9ac9 100644 --- a/commands_reference/upctl_host/list/index.html +++ b/commands_reference/upctl_host/list/index.html @@ -1157,6 +1157,91 @@ + + + + + + + + + + +
  • + + + + + + + + + + +
  • + + + + diff --git a/commands_reference/upctl_ip-address/assign/index.html b/commands_reference/upctl_ip-address/assign/index.html index cd58ace0..2daa781e 100644 --- a/commands_reference/upctl_ip-address/assign/index.html +++ b/commands_reference/upctl_ip-address/assign/index.html @@ -1157,6 +1157,91 @@ + + + + + + + + + + +
  • + + + + + + + + + + +
  • + + + + diff --git a/commands_reference/upctl_ip-address/index.html b/commands_reference/upctl_ip-address/index.html index 1a4d452f..b5c8a5ba 100644 --- a/commands_reference/upctl_ip-address/index.html +++ b/commands_reference/upctl_ip-address/index.html @@ -1157,6 +1157,91 @@ + + + + + + + + + + +
  • + + + + + + + + + + +
  • + + + + diff --git a/commands_reference/upctl_ip-address/list/index.html b/commands_reference/upctl_ip-address/list/index.html index 8931237e..63624ee7 100644 --- a/commands_reference/upctl_ip-address/list/index.html +++ b/commands_reference/upctl_ip-address/list/index.html @@ -1157,6 +1157,91 @@ + + + + + + + + + + +
  • + + + + + + + + + + +
  • + + + + diff --git a/commands_reference/upctl_ip-address/modify/index.html b/commands_reference/upctl_ip-address/modify/index.html index 13bf17c0..c440a08b 100644 --- a/commands_reference/upctl_ip-address/modify/index.html +++ b/commands_reference/upctl_ip-address/modify/index.html @@ -1157,6 +1157,91 @@ + + + + + + + + + + +
  • + + + + + + + + + + +
  • + + + + diff --git a/commands_reference/upctl_ip-address/remove/index.html b/commands_reference/upctl_ip-address/remove/index.html index c866f256..fef19879 100644 --- a/commands_reference/upctl_ip-address/remove/index.html +++ b/commands_reference/upctl_ip-address/remove/index.html @@ -1157,6 +1157,91 @@ + + + + + + + + + + +
  • + + + + + + + + + + +
  • + + + + diff --git a/commands_reference/upctl_ip-address/show/index.html b/commands_reference/upctl_ip-address/show/index.html index 1ebc8d8b..700af1e1 100644 --- a/commands_reference/upctl_ip-address/show/index.html +++ b/commands_reference/upctl_ip-address/show/index.html @@ -1157,6 +1157,91 @@ + + + + + + + + + + +
  • + + + + + + + + + + +
  • + + + + diff --git a/commands_reference/upctl_kubernetes/config/index.html b/commands_reference/upctl_kubernetes/config/index.html index 0f19b956..11ae756b 100644 --- a/commands_reference/upctl_kubernetes/config/index.html +++ b/commands_reference/upctl_kubernetes/config/index.html @@ -1157,6 +1157,91 @@ + + + + + + + + + + +
  • + + + + + + + + + + +
  • + + + + diff --git a/commands_reference/upctl_kubernetes/create/index.html b/commands_reference/upctl_kubernetes/create/index.html index cb797d43..1a81cefb 100644 --- a/commands_reference/upctl_kubernetes/create/index.html +++ b/commands_reference/upctl_kubernetes/create/index.html @@ -1157,6 +1157,91 @@ + + + + + + + + + + +
  • + + + + + + + + + + +
  • + + + + diff --git a/commands_reference/upctl_kubernetes/delete/index.html b/commands_reference/upctl_kubernetes/delete/index.html index 50eca97b..70df76be 100644 --- a/commands_reference/upctl_kubernetes/delete/index.html +++ b/commands_reference/upctl_kubernetes/delete/index.html @@ -1157,6 +1157,91 @@ + + + + + + + + + + +
  • + + + + + + + + + + +
  • + + + + diff --git a/commands_reference/upctl_kubernetes/index.html b/commands_reference/upctl_kubernetes/index.html index 98a70beb..996cb82e 100644 --- a/commands_reference/upctl_kubernetes/index.html +++ b/commands_reference/upctl_kubernetes/index.html @@ -1157,6 +1157,91 @@ + + + + + + + + + + +
  • + + + + + + + + + + +
  • + + + + diff --git a/commands_reference/upctl_kubernetes/list/index.html b/commands_reference/upctl_kubernetes/list/index.html index 581e0c49..2ff57208 100644 --- a/commands_reference/upctl_kubernetes/list/index.html +++ b/commands_reference/upctl_kubernetes/list/index.html @@ -1157,6 +1157,91 @@ + + + + + + + + + + +
  • + + + + + + + + + + +
  • + + + + diff --git a/commands_reference/upctl_kubernetes/modify/index.html b/commands_reference/upctl_kubernetes/modify/index.html index 5d885e4a..bee444e2 100644 --- a/commands_reference/upctl_kubernetes/modify/index.html +++ b/commands_reference/upctl_kubernetes/modify/index.html @@ -1157,6 +1157,91 @@ + + + + + + + + + + +
  • + + + + + + + + + + +
  • + + + + diff --git a/commands_reference/upctl_kubernetes/nodegroup/create/index.html b/commands_reference/upctl_kubernetes/nodegroup/create/index.html index 4fc0ff78..78a8bb9f 100644 --- a/commands_reference/upctl_kubernetes/nodegroup/create/index.html +++ b/commands_reference/upctl_kubernetes/nodegroup/create/index.html @@ -1157,6 +1157,91 @@ + + + + + + + + + + +
  • + + + + + + + + + + +
  • + + + + diff --git a/commands_reference/upctl_kubernetes/nodegroup/delete/index.html b/commands_reference/upctl_kubernetes/nodegroup/delete/index.html index 4d9588ee..cf32c6ce 100644 --- a/commands_reference/upctl_kubernetes/nodegroup/delete/index.html +++ b/commands_reference/upctl_kubernetes/nodegroup/delete/index.html @@ -1157,6 +1157,91 @@ + + + + + + + + + + +
  • + + + + + + + + + + +
  • + + + + diff --git a/commands_reference/upctl_kubernetes/nodegroup/index.html b/commands_reference/upctl_kubernetes/nodegroup/index.html index d7388a38..c0bac7e9 100644 --- a/commands_reference/upctl_kubernetes/nodegroup/index.html +++ b/commands_reference/upctl_kubernetes/nodegroup/index.html @@ -1157,6 +1157,91 @@ + + + + + + + + + + +
  • + + + + + + + + + + +
  • + + + + diff --git a/commands_reference/upctl_kubernetes/nodegroup/scale/index.html b/commands_reference/upctl_kubernetes/nodegroup/scale/index.html index 4f3337c8..efd4a0e1 100644 --- a/commands_reference/upctl_kubernetes/nodegroup/scale/index.html +++ b/commands_reference/upctl_kubernetes/nodegroup/scale/index.html @@ -1157,6 +1157,91 @@ + + + + + + + + + + +
  • + + + + + + + + + + +
  • + + + + diff --git a/commands_reference/upctl_kubernetes/nodegroup/show/index.html b/commands_reference/upctl_kubernetes/nodegroup/show/index.html index 0574454d..331c45bf 100644 --- a/commands_reference/upctl_kubernetes/nodegroup/show/index.html +++ b/commands_reference/upctl_kubernetes/nodegroup/show/index.html @@ -1157,6 +1157,91 @@ + + + + + + + + + + +
  • + + + + + + + + + + +
  • + + + + diff --git a/commands_reference/upctl_kubernetes/plans/index.html b/commands_reference/upctl_kubernetes/plans/index.html index 67aa2841..7f8eea01 100644 --- a/commands_reference/upctl_kubernetes/plans/index.html +++ b/commands_reference/upctl_kubernetes/plans/index.html @@ -1157,6 +1157,91 @@ + + + + + + + + + + +
  • + + + + + + + + + + +
  • + + + + diff --git a/commands_reference/upctl_kubernetes/show/index.html b/commands_reference/upctl_kubernetes/show/index.html index dea60f30..57806758 100644 --- a/commands_reference/upctl_kubernetes/show/index.html +++ b/commands_reference/upctl_kubernetes/show/index.html @@ -1157,6 +1157,91 @@ + + + + + + + + + + +
  • + + + + + + + + + + +
  • + + + + diff --git a/commands_reference/upctl_kubernetes/versions/index.html b/commands_reference/upctl_kubernetes/versions/index.html index 5880c2b3..1b0ed5d2 100644 --- a/commands_reference/upctl_kubernetes/versions/index.html +++ b/commands_reference/upctl_kubernetes/versions/index.html @@ -1157,6 +1157,91 @@ + + + + + + + + + + +
  • + + + + + + + + + + +
  • + + + + diff --git a/commands_reference/upctl_loadbalancer/delete/index.html b/commands_reference/upctl_loadbalancer/delete/index.html index 9baf497e..87b0890a 100644 --- a/commands_reference/upctl_loadbalancer/delete/index.html +++ b/commands_reference/upctl_loadbalancer/delete/index.html @@ -1157,6 +1157,91 @@ + + + + + + + + + + +
  • + + + + + + + + + + +
  • + + + + diff --git a/commands_reference/upctl_loadbalancer/index.html b/commands_reference/upctl_loadbalancer/index.html index 47a4be60..f38b9dd0 100644 --- a/commands_reference/upctl_loadbalancer/index.html +++ b/commands_reference/upctl_loadbalancer/index.html @@ -1157,6 +1157,91 @@ + + + + + + + + + + +
  • + + + + + + + + + + +
  • + + + + diff --git a/commands_reference/upctl_loadbalancer/list/index.html b/commands_reference/upctl_loadbalancer/list/index.html index 238a36a9..75172d53 100644 --- a/commands_reference/upctl_loadbalancer/list/index.html +++ b/commands_reference/upctl_loadbalancer/list/index.html @@ -1157,6 +1157,91 @@ + + + + + + + + + + +
  • + + + + + + + + + + +
  • + + + + diff --git a/commands_reference/upctl_loadbalancer/plans/index.html b/commands_reference/upctl_loadbalancer/plans/index.html index 576796fe..6f9d74d5 100644 --- a/commands_reference/upctl_loadbalancer/plans/index.html +++ b/commands_reference/upctl_loadbalancer/plans/index.html @@ -1157,6 +1157,91 @@ + + + + + + + + + + +
  • + + + + + + + + + + +
  • + + + + diff --git a/commands_reference/upctl_loadbalancer/show/index.html b/commands_reference/upctl_loadbalancer/show/index.html index 6854c66f..c96131ac 100644 --- a/commands_reference/upctl_loadbalancer/show/index.html +++ b/commands_reference/upctl_loadbalancer/show/index.html @@ -1157,6 +1157,91 @@ + + + + + + + + + + +
  • + + + + + + + + + + +
  • + + + + diff --git a/commands_reference/upctl_network/create/index.html b/commands_reference/upctl_network/create/index.html index 5c93786c..982262a8 100644 --- a/commands_reference/upctl_network/create/index.html +++ b/commands_reference/upctl_network/create/index.html @@ -1157,6 +1157,91 @@ + + + + + + + + + + +
  • + + + + + + + + + + +
  • + + + + diff --git a/commands_reference/upctl_network/delete/index.html b/commands_reference/upctl_network/delete/index.html index 9ed63f2c..5baf1a18 100644 --- a/commands_reference/upctl_network/delete/index.html +++ b/commands_reference/upctl_network/delete/index.html @@ -1157,6 +1157,91 @@ + + + + + + + + + + +
  • + + + + + + + + + + +
  • + + + + diff --git a/commands_reference/upctl_network/index.html b/commands_reference/upctl_network/index.html index e90aee37..9fe2b980 100644 --- a/commands_reference/upctl_network/index.html +++ b/commands_reference/upctl_network/index.html @@ -1157,6 +1157,91 @@ + + + + + + + + + + +
  • + + + + + + + + + + +
  • + + + + diff --git a/commands_reference/upctl_network/list/index.html b/commands_reference/upctl_network/list/index.html index 22c5cc87..7428cd1c 100644 --- a/commands_reference/upctl_network/list/index.html +++ b/commands_reference/upctl_network/list/index.html @@ -1157,6 +1157,91 @@ + + + + + + + + + + +
  • + + + + + + + + + + +
  • + + + + diff --git a/commands_reference/upctl_network/modify/index.html b/commands_reference/upctl_network/modify/index.html index a3325c33..5bee8433 100644 --- a/commands_reference/upctl_network/modify/index.html +++ b/commands_reference/upctl_network/modify/index.html @@ -1157,6 +1157,91 @@ + + + + + + + + + + +
  • + + + + + + + + + + +
  • + + + + diff --git a/commands_reference/upctl_network/show/index.html b/commands_reference/upctl_network/show/index.html index 7597e454..63fc48cf 100644 --- a/commands_reference/upctl_network/show/index.html +++ b/commands_reference/upctl_network/show/index.html @@ -1157,6 +1157,91 @@ + + + + + + + + + + +
  • + + + + + + + + + + +
  • + + + + diff --git a/commands_reference/upctl_networkpeering/delete/index.html b/commands_reference/upctl_networkpeering/delete/index.html index bb3670d0..5a67bd13 100644 --- a/commands_reference/upctl_networkpeering/delete/index.html +++ b/commands_reference/upctl_networkpeering/delete/index.html @@ -1157,6 +1157,91 @@ + + + + + + + + + + +
  • + + + + + + + + + + +
  • + + + + diff --git a/commands_reference/upctl_networkpeering/disable/index.html b/commands_reference/upctl_networkpeering/disable/index.html index 02b5fdd1..ec8deae8 100644 --- a/commands_reference/upctl_networkpeering/disable/index.html +++ b/commands_reference/upctl_networkpeering/disable/index.html @@ -1157,6 +1157,91 @@ + + + + + + + + + + +
  • + + + + + + + + + + +
  • + + + + diff --git a/commands_reference/upctl_networkpeering/index.html b/commands_reference/upctl_networkpeering/index.html index f15c2bac..4df4708d 100644 --- a/commands_reference/upctl_networkpeering/index.html +++ b/commands_reference/upctl_networkpeering/index.html @@ -1157,6 +1157,91 @@ + + + + + + + + + + +
  • + + + + + + + + + + +
  • + + + + diff --git a/commands_reference/upctl_networkpeering/list/index.html b/commands_reference/upctl_networkpeering/list/index.html index 39d6bef6..5b086de4 100644 --- a/commands_reference/upctl_networkpeering/list/index.html +++ b/commands_reference/upctl_networkpeering/list/index.html @@ -1157,6 +1157,91 @@ + + + + + + + + + + +
  • + + + + + + + + + + +
  • + + + + diff --git a/commands_reference/upctl_objectstorage/delete/index.html b/commands_reference/upctl_objectstorage/delete/index.html index 966d8db2..34285d02 100644 --- a/commands_reference/upctl_objectstorage/delete/index.html +++ b/commands_reference/upctl_objectstorage/delete/index.html @@ -1157,6 +1157,91 @@ + + + + + + + + + + +
  • + + + + + + + + + + +
  • + + + + diff --git a/commands_reference/upctl_objectstorage/index.html b/commands_reference/upctl_objectstorage/index.html index d0f19450..910a0619 100644 --- a/commands_reference/upctl_objectstorage/index.html +++ b/commands_reference/upctl_objectstorage/index.html @@ -1157,6 +1157,91 @@ + + + + + + + + + + +
  • + + + + + + + + + + +
  • + + + + diff --git a/commands_reference/upctl_objectstorage/list/index.html b/commands_reference/upctl_objectstorage/list/index.html index 101b4913..7b1f8ec0 100644 --- a/commands_reference/upctl_objectstorage/list/index.html +++ b/commands_reference/upctl_objectstorage/list/index.html @@ -1157,6 +1157,91 @@ + + + + + + + + + + +
  • + + + + + + + + + + +
  • + + + + diff --git a/commands_reference/upctl_objectstorage/regions/index.html b/commands_reference/upctl_objectstorage/regions/index.html index ea0b1fcf..84435948 100644 --- a/commands_reference/upctl_objectstorage/regions/index.html +++ b/commands_reference/upctl_objectstorage/regions/index.html @@ -1157,6 +1157,91 @@ + + + + + + + + + + +
  • + + + + + + + + + + +
  • + + + + diff --git a/commands_reference/upctl_objectstorage/show/index.html b/commands_reference/upctl_objectstorage/show/index.html index 76fde7e6..dacf7c22 100644 --- a/commands_reference/upctl_objectstorage/show/index.html +++ b/commands_reference/upctl_objectstorage/show/index.html @@ -1157,6 +1157,91 @@ + + + + + + + + + + +
  • + + + + + + + + + + +
  • + + + + diff --git a/commands_reference/upctl_partner/account/create/index.html b/commands_reference/upctl_partner/account/create/index.html index 605e2ff0..89609f72 100644 --- a/commands_reference/upctl_partner/account/create/index.html +++ b/commands_reference/upctl_partner/account/create/index.html @@ -1157,6 +1157,91 @@ + + + + + + + + + + +
  • + + + + + + + + + + +
  • + + + + diff --git a/commands_reference/upctl_partner/account/index.html b/commands_reference/upctl_partner/account/index.html index fa822a89..2f388c84 100644 --- a/commands_reference/upctl_partner/account/index.html +++ b/commands_reference/upctl_partner/account/index.html @@ -1157,6 +1157,91 @@ + + + + + + + + + + +
  • + + + + + + + + + + +
  • + + + + diff --git a/commands_reference/upctl_partner/account/list/index.html b/commands_reference/upctl_partner/account/list/index.html index 570f60c9..d7d850da 100644 --- a/commands_reference/upctl_partner/account/list/index.html +++ b/commands_reference/upctl_partner/account/list/index.html @@ -1157,6 +1157,91 @@ + + + + + + + + + + +
  • + + + + + + + + + + +
  • + + + + diff --git a/commands_reference/upctl_partner/index.html b/commands_reference/upctl_partner/index.html index 1afbffbb..a4ec245e 100644 --- a/commands_reference/upctl_partner/index.html +++ b/commands_reference/upctl_partner/index.html @@ -1157,6 +1157,91 @@ + + + + + + + + + + +
  • + + + + + + + + + + +
  • + + + + diff --git a/commands_reference/upctl_router/create/index.html b/commands_reference/upctl_router/create/index.html index b041aabd..3035da70 100644 --- a/commands_reference/upctl_router/create/index.html +++ b/commands_reference/upctl_router/create/index.html @@ -1157,6 +1157,91 @@ + + + + + + + + + + +
  • + + + + + + + + + + +
  • + + + + diff --git a/commands_reference/upctl_router/delete/index.html b/commands_reference/upctl_router/delete/index.html index bfda7809..49ea5f22 100644 --- a/commands_reference/upctl_router/delete/index.html +++ b/commands_reference/upctl_router/delete/index.html @@ -1157,6 +1157,91 @@ + + + + + + + + + + +
  • + + + + + + + + + + +
  • + + + + diff --git a/commands_reference/upctl_router/index.html b/commands_reference/upctl_router/index.html index f0e05ff2..2d5b91eb 100644 --- a/commands_reference/upctl_router/index.html +++ b/commands_reference/upctl_router/index.html @@ -1157,6 +1157,91 @@ + + + + + + + + + + +
  • + + + + + + + + + + +
  • + + + + diff --git a/commands_reference/upctl_router/list/index.html b/commands_reference/upctl_router/list/index.html index a9dfbfa1..0f04d627 100644 --- a/commands_reference/upctl_router/list/index.html +++ b/commands_reference/upctl_router/list/index.html @@ -1157,6 +1157,91 @@ + + + + + + + + + + +
  • + + + + + + + + + + +
  • + + + + diff --git a/commands_reference/upctl_router/modify/index.html b/commands_reference/upctl_router/modify/index.html index d2f0ad74..f78474b4 100644 --- a/commands_reference/upctl_router/modify/index.html +++ b/commands_reference/upctl_router/modify/index.html @@ -1157,6 +1157,91 @@ + + + + + + + + + + +
  • + + + + + + + + + + +
  • + + + + diff --git a/commands_reference/upctl_router/show/index.html b/commands_reference/upctl_router/show/index.html index 1f9fa294..07c384c2 100644 --- a/commands_reference/upctl_router/show/index.html +++ b/commands_reference/upctl_router/show/index.html @@ -1157,6 +1157,91 @@ + + + + + + + + + + +
  • + + + + + + + + + + +
  • + + + + diff --git a/commands_reference/upctl_server/create/index.html b/commands_reference/upctl_server/create/index.html index 177c61d3..fc7688b3 100644 --- a/commands_reference/upctl_server/create/index.html +++ b/commands_reference/upctl_server/create/index.html @@ -1157,6 +1157,91 @@ + + + + + + + + + + +
  • + + + + + + + + + + +
  • + + + + diff --git a/commands_reference/upctl_server/delete/index.html b/commands_reference/upctl_server/delete/index.html index 43547294..7cde69bb 100644 --- a/commands_reference/upctl_server/delete/index.html +++ b/commands_reference/upctl_server/delete/index.html @@ -1157,6 +1157,91 @@ + + + + + + + + + + +
  • + + + + + + + + + + +
  • + + + + diff --git a/commands_reference/upctl_server/eject/index.html b/commands_reference/upctl_server/eject/index.html index d58320a0..bb3040c6 100644 --- a/commands_reference/upctl_server/eject/index.html +++ b/commands_reference/upctl_server/eject/index.html @@ -1157,6 +1157,91 @@ + + + + + + + + + + +
  • + + + + + + + + + + +
  • + + + + diff --git a/commands_reference/upctl_server/firewall/create/index.html b/commands_reference/upctl_server/firewall/create/index.html index cfe969be..c182e3c5 100644 --- a/commands_reference/upctl_server/firewall/create/index.html +++ b/commands_reference/upctl_server/firewall/create/index.html @@ -1157,6 +1157,91 @@ + + + + + + + + + + +
  • + + + + + + + + + + +
  • + + + + diff --git a/commands_reference/upctl_server/firewall/delete/index.html b/commands_reference/upctl_server/firewall/delete/index.html index 78919242..64b2dab2 100644 --- a/commands_reference/upctl_server/firewall/delete/index.html +++ b/commands_reference/upctl_server/firewall/delete/index.html @@ -1157,6 +1157,91 @@ + + + + + + + + + + +
  • + + + + + + + + + + +
  • + + + + diff --git a/commands_reference/upctl_server/firewall/index.html b/commands_reference/upctl_server/firewall/index.html index 4053fd1e..d969cd0a 100644 --- a/commands_reference/upctl_server/firewall/index.html +++ b/commands_reference/upctl_server/firewall/index.html @@ -1157,6 +1157,91 @@ + + + + + + + + + + +
  • + + + + + + + + + + +
  • + + + + diff --git a/commands_reference/upctl_server/firewall/show/index.html b/commands_reference/upctl_server/firewall/show/index.html index 5d4040a0..7899683d 100644 --- a/commands_reference/upctl_server/firewall/show/index.html +++ b/commands_reference/upctl_server/firewall/show/index.html @@ -1157,6 +1157,91 @@ + + + + + + + + + + +
  • + + + + + + + + + + +
  • + + + + diff --git a/commands_reference/upctl_server/index.html b/commands_reference/upctl_server/index.html index dc817e3f..2768f86e 100644 --- a/commands_reference/upctl_server/index.html +++ b/commands_reference/upctl_server/index.html @@ -1157,6 +1157,91 @@ + + + + + + + + + + +
  • + + + + + + + + + + +
  • + + + + diff --git a/commands_reference/upctl_server/list/index.html b/commands_reference/upctl_server/list/index.html index 5f55dfe0..be4b6c6c 100644 --- a/commands_reference/upctl_server/list/index.html +++ b/commands_reference/upctl_server/list/index.html @@ -1157,6 +1157,91 @@ + + + + + + + + + + +
  • + + + + + + + + + + +
  • + + + + diff --git a/commands_reference/upctl_server/load/index.html b/commands_reference/upctl_server/load/index.html index 2ed159bc..f0c12d25 100644 --- a/commands_reference/upctl_server/load/index.html +++ b/commands_reference/upctl_server/load/index.html @@ -1157,6 +1157,91 @@ + + + + + + + + + + +
  • + + + + + + + + + + +
  • + + + + diff --git a/commands_reference/upctl_server/modify/index.html b/commands_reference/upctl_server/modify/index.html index 550acc9d..4dd5b168 100644 --- a/commands_reference/upctl_server/modify/index.html +++ b/commands_reference/upctl_server/modify/index.html @@ -1157,6 +1157,91 @@ + + + + + + + + + + +
  • + + + + + + + + + + +
  • + + + + diff --git a/commands_reference/upctl_server/network-interface/create/index.html b/commands_reference/upctl_server/network-interface/create/index.html index 9b7a7e53..74bca068 100644 --- a/commands_reference/upctl_server/network-interface/create/index.html +++ b/commands_reference/upctl_server/network-interface/create/index.html @@ -1157,6 +1157,91 @@ + + + + + + + + + + +
  • + + + + + + + + + + +
  • + + + + diff --git a/commands_reference/upctl_server/network-interface/delete/index.html b/commands_reference/upctl_server/network-interface/delete/index.html index 67c55af3..c68931f8 100644 --- a/commands_reference/upctl_server/network-interface/delete/index.html +++ b/commands_reference/upctl_server/network-interface/delete/index.html @@ -1157,6 +1157,91 @@ + + + + + + + + + + +
  • + + + + + + + + + + +
  • + + + + diff --git a/commands_reference/upctl_server/network-interface/index.html b/commands_reference/upctl_server/network-interface/index.html index 0f0e15f5..50788a47 100644 --- a/commands_reference/upctl_server/network-interface/index.html +++ b/commands_reference/upctl_server/network-interface/index.html @@ -1157,6 +1157,91 @@ + + + + + + + + + + +
  • + + + + + + + + + + +
  • + + + + diff --git a/commands_reference/upctl_server/network-interface/modify/index.html b/commands_reference/upctl_server/network-interface/modify/index.html index 42c029fe..4453f126 100644 --- a/commands_reference/upctl_server/network-interface/modify/index.html +++ b/commands_reference/upctl_server/network-interface/modify/index.html @@ -1157,6 +1157,91 @@ + + + + + + + + + + +
  • + + + + + + + + + + +
  • + + + + diff --git a/commands_reference/upctl_server/plans/index.html b/commands_reference/upctl_server/plans/index.html index 93dfba73..329887a1 100644 --- a/commands_reference/upctl_server/plans/index.html +++ b/commands_reference/upctl_server/plans/index.html @@ -1157,6 +1157,91 @@ + + + + + + + + + + +
  • + + + + + + + + + + +
  • + + + + diff --git a/commands_reference/upctl_server/restart/index.html b/commands_reference/upctl_server/restart/index.html index 7877e97e..c3681b73 100644 --- a/commands_reference/upctl_server/restart/index.html +++ b/commands_reference/upctl_server/restart/index.html @@ -1157,6 +1157,91 @@ + + + + + + + + + + +
  • + + + + + + + + + + +
  • + + + + diff --git a/commands_reference/upctl_server/show/index.html b/commands_reference/upctl_server/show/index.html index 97306831..41005bd2 100644 --- a/commands_reference/upctl_server/show/index.html +++ b/commands_reference/upctl_server/show/index.html @@ -1157,6 +1157,91 @@ + + + + + + + + + + +
  • + + + + + + + + + + +
  • + + + + diff --git a/commands_reference/upctl_server/start/index.html b/commands_reference/upctl_server/start/index.html index 3220391e..445211fc 100644 --- a/commands_reference/upctl_server/start/index.html +++ b/commands_reference/upctl_server/start/index.html @@ -1157,6 +1157,91 @@ + + + + + + + + + + +
  • + + + + + + + + + + +
  • + + + + diff --git a/commands_reference/upctl_server/stop/index.html b/commands_reference/upctl_server/stop/index.html index 7a112e0c..f88a507d 100644 --- a/commands_reference/upctl_server/stop/index.html +++ b/commands_reference/upctl_server/stop/index.html @@ -1157,6 +1157,91 @@ + + + + + + + + + + +
  • + + + + + + + + + + +
  • + + + + diff --git a/commands_reference/upctl_server/storage/attach/index.html b/commands_reference/upctl_server/storage/attach/index.html index 6da4275e..334740bb 100644 --- a/commands_reference/upctl_server/storage/attach/index.html +++ b/commands_reference/upctl_server/storage/attach/index.html @@ -1157,6 +1157,91 @@ + + + + + + + + + + +
  • + + + + + + + + + + +
  • + + + + diff --git a/commands_reference/upctl_server/storage/detach/index.html b/commands_reference/upctl_server/storage/detach/index.html index a69c351a..694e03be 100644 --- a/commands_reference/upctl_server/storage/detach/index.html +++ b/commands_reference/upctl_server/storage/detach/index.html @@ -1157,6 +1157,91 @@ + + + + + + + + + + +
  • + + + + + + + + + + +
  • + + + + diff --git a/commands_reference/upctl_server/storage/index.html b/commands_reference/upctl_server/storage/index.html index 0e38758b..8823a00f 100644 --- a/commands_reference/upctl_server/storage/index.html +++ b/commands_reference/upctl_server/storage/index.html @@ -1157,6 +1157,91 @@ + + + + + + + + + + +
  • + + + + + + + + + + +
  • + + + + diff --git a/commands_reference/upctl_servergroup/create/index.html b/commands_reference/upctl_servergroup/create/index.html index 1cb3f262..03dc84fb 100644 --- a/commands_reference/upctl_servergroup/create/index.html +++ b/commands_reference/upctl_servergroup/create/index.html @@ -1157,6 +1157,91 @@ + + + + + + + + + + +
  • + + + + + + + + + + +
  • + + + + diff --git a/commands_reference/upctl_servergroup/delete/index.html b/commands_reference/upctl_servergroup/delete/index.html index 9d46c7ab..3ab43765 100644 --- a/commands_reference/upctl_servergroup/delete/index.html +++ b/commands_reference/upctl_servergroup/delete/index.html @@ -1157,6 +1157,91 @@ + + + + + + + + + + +
  • + + + + + + + + + + +
  • + + + + diff --git a/commands_reference/upctl_servergroup/index.html b/commands_reference/upctl_servergroup/index.html index 13135808..c0400984 100644 --- a/commands_reference/upctl_servergroup/index.html +++ b/commands_reference/upctl_servergroup/index.html @@ -1157,6 +1157,91 @@ + + + + + + + + + + +
  • + + + + + + + + + + +
  • + + + + diff --git a/commands_reference/upctl_servergroup/list/index.html b/commands_reference/upctl_servergroup/list/index.html index 6103d408..6e140f55 100644 --- a/commands_reference/upctl_servergroup/list/index.html +++ b/commands_reference/upctl_servergroup/list/index.html @@ -1157,6 +1157,91 @@ + + + + + + + + + + +
  • + + + + + + + + + + +
  • + + + + diff --git a/commands_reference/upctl_servergroup/modify/index.html b/commands_reference/upctl_servergroup/modify/index.html index 29f28919..ef7d7881 100644 --- a/commands_reference/upctl_servergroup/modify/index.html +++ b/commands_reference/upctl_servergroup/modify/index.html @@ -1157,6 +1157,91 @@ + + + + + + + + + + +
  • + + + + + + + + + + +
  • + + + + diff --git a/commands_reference/upctl_servergroup/show/index.html b/commands_reference/upctl_servergroup/show/index.html index 1042da34..63e41e8a 100644 --- a/commands_reference/upctl_servergroup/show/index.html +++ b/commands_reference/upctl_servergroup/show/index.html @@ -1157,6 +1157,91 @@ + + + + + + + + + + +
  • + + + + + + + + + + +
  • + + + + diff --git a/commands_reference/upctl_storage/backup/create/index.html b/commands_reference/upctl_storage/backup/create/index.html index a50c4d62..5760963d 100644 --- a/commands_reference/upctl_storage/backup/create/index.html +++ b/commands_reference/upctl_storage/backup/create/index.html @@ -1157,6 +1157,91 @@ + + + + + + + + + + +
  • + + + + + + + + + + +
  • + + + + diff --git a/commands_reference/upctl_storage/backup/index.html b/commands_reference/upctl_storage/backup/index.html index 64630065..ece5d84f 100644 --- a/commands_reference/upctl_storage/backup/index.html +++ b/commands_reference/upctl_storage/backup/index.html @@ -1157,6 +1157,91 @@ + + + + + + + + + + +
  • + + + + + + + + + + +
  • + + + + diff --git a/commands_reference/upctl_storage/backup/restore/index.html b/commands_reference/upctl_storage/backup/restore/index.html index 00209f92..2477af86 100644 --- a/commands_reference/upctl_storage/backup/restore/index.html +++ b/commands_reference/upctl_storage/backup/restore/index.html @@ -1157,6 +1157,91 @@ + + + + + + + + + + +
  • + + + + + + + + + + +
  • + + + + diff --git a/commands_reference/upctl_storage/clone/index.html b/commands_reference/upctl_storage/clone/index.html index a7b55495..722c42d3 100644 --- a/commands_reference/upctl_storage/clone/index.html +++ b/commands_reference/upctl_storage/clone/index.html @@ -1157,6 +1157,91 @@ + + + + + + + + + + +
  • + + + + + + + + + + +
  • + + + + diff --git a/commands_reference/upctl_storage/create/index.html b/commands_reference/upctl_storage/create/index.html index f251a0ea..6023b754 100644 --- a/commands_reference/upctl_storage/create/index.html +++ b/commands_reference/upctl_storage/create/index.html @@ -1157,6 +1157,91 @@ + + + + + + + + + + +
  • + + + + + + + + + + +
  • + + + + diff --git a/commands_reference/upctl_storage/delete/index.html b/commands_reference/upctl_storage/delete/index.html index d7f333cd..d90c7b35 100644 --- a/commands_reference/upctl_storage/delete/index.html +++ b/commands_reference/upctl_storage/delete/index.html @@ -1157,6 +1157,91 @@ + + + + + + + + + + +
  • + + + + + + + + + + +
  • + + + + diff --git a/commands_reference/upctl_storage/import/index.html b/commands_reference/upctl_storage/import/index.html index f27bcdcd..4af37f98 100644 --- a/commands_reference/upctl_storage/import/index.html +++ b/commands_reference/upctl_storage/import/index.html @@ -1157,6 +1157,91 @@ + + + + + + + + + + +
  • + + + + + + + + + + +
  • + + + + diff --git a/commands_reference/upctl_storage/index.html b/commands_reference/upctl_storage/index.html index c68d5146..52a51b86 100644 --- a/commands_reference/upctl_storage/index.html +++ b/commands_reference/upctl_storage/index.html @@ -1157,6 +1157,91 @@ + + + + + + + + + + +
  • + + + + + + + + + + +
  • + + + + diff --git a/commands_reference/upctl_storage/list/index.html b/commands_reference/upctl_storage/list/index.html index 41fa7568..8f679e43 100644 --- a/commands_reference/upctl_storage/list/index.html +++ b/commands_reference/upctl_storage/list/index.html @@ -1157,6 +1157,91 @@ + + + + + + + + + + +
  • + + + + + + + + + + +
  • + + + + diff --git a/commands_reference/upctl_storage/modify/index.html b/commands_reference/upctl_storage/modify/index.html index 86bfcec6..39bd30fe 100644 --- a/commands_reference/upctl_storage/modify/index.html +++ b/commands_reference/upctl_storage/modify/index.html @@ -1157,6 +1157,91 @@ + + + + + + + + + + +
  • + + + + + + + + + + +
  • + + + + diff --git a/commands_reference/upctl_storage/show/index.html b/commands_reference/upctl_storage/show/index.html index 23269f6b..a80b0c9b 100644 --- a/commands_reference/upctl_storage/show/index.html +++ b/commands_reference/upctl_storage/show/index.html @@ -1157,6 +1157,91 @@ + + + + + + + + + + +
  • + + + + + + + + + + +
  • + + + + diff --git a/commands_reference/upctl_storage/templatise/index.html b/commands_reference/upctl_storage/templatise/index.html index ae7fb195..a1ec52b4 100644 --- a/commands_reference/upctl_storage/templatise/index.html +++ b/commands_reference/upctl_storage/templatise/index.html @@ -1157,6 +1157,91 @@ + + + + + + + + + + +
  • + + + + + + + + + + +
  • + + + + diff --git a/commands_reference/upctl_version/index.html b/commands_reference/upctl_version/index.html index baf06162..918dc5d4 100644 --- a/commands_reference/upctl_version/index.html +++ b/commands_reference/upctl_version/index.html @@ -1157,6 +1157,91 @@ + + + + + + + + + + +
  • + + + + + + + + + + +
  • + + + + diff --git a/commands_reference/upctl_zone/index.html b/commands_reference/upctl_zone/index.html index cff2bf45..0261022c 100644 --- a/commands_reference/upctl_zone/index.html +++ b/commands_reference/upctl_zone/index.html @@ -1157,6 +1157,91 @@ + + + + + + + + + + +
  • + + + + + + + + + + +
  • + + + + diff --git a/commands_reference/upctl_zone/list/index.html b/commands_reference/upctl_zone/list/index.html index 6925f6da..08d6526c 100644 --- a/commands_reference/upctl_zone/list/index.html +++ b/commands_reference/upctl_zone/list/index.html @@ -1157,6 +1157,91 @@ + + + + + + + + + + +
  • + + + + + + + + + + +
  • + + + + diff --git a/examples/create_a_custom_template/index.html b/examples/create_a_custom_template/index.html index fcc524fe..5fc3d2b8 100644 --- a/examples/create_a_custom_template/index.html +++ b/examples/create_a_custom_template/index.html @@ -1155,6 +1155,91 @@ + + + + + + + + + + +
  • + + + + + + + + + + +
  • + + + + diff --git a/examples/create_and_restore_backup/index.html b/examples/create_and_restore_backup/index.html index 3b4a291a..2d6487b2 100644 --- a/examples/create_and_restore_backup/index.html +++ b/examples/create_and_restore_backup/index.html @@ -1155,6 +1155,91 @@ + + + + + + + + + + +
  • + + + + + + + + + + +
  • + + + + diff --git a/examples/create_and_ssh_into_a_server/index.html b/examples/create_and_ssh_into_a_server/index.html index 61b3f393..bc99e395 100644 --- a/examples/create_and_ssh_into_a_server/index.html +++ b/examples/create_and_ssh_into_a_server/index.html @@ -1155,6 +1155,91 @@ + + + + + + + + + + +
  • + + + + + + + + + + +
  • + + + + diff --git a/examples/index.html b/examples/index.html index f73d86aa..4e22dfd2 100644 --- a/examples/index.html +++ b/examples/index.html @@ -1151,6 +1151,91 @@ + + + + + + + + + + +
  • + + + + + + + + + + +
  • + + + + diff --git a/examples/possible_exit_codes/index.html b/examples/possible_exit_codes/index.html index edc64565..6f0195df 100644 --- a/examples/possible_exit_codes/index.html +++ b/examples/possible_exit_codes/index.html @@ -1155,6 +1155,91 @@ + + + + + + + + + + +
  • + + + + + + + + + + +
  • + + + + diff --git a/index.html b/index.html index 07c78796..9379de4f 100644 --- a/index.html +++ b/index.html @@ -1211,6 +1211,91 @@ + + + + + + + + + + +
  • + + + + + + + + + + +
  • + + + + diff --git a/search/search_index.json b/search/search_index.json index edf8666a..a9cf2533 100644 --- a/search/search_index.json +++ b/search/search_index.json @@ -1 +1 @@ -{"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.

    "},{"location":"#install-upctl","title":"Install upctl","text":"

    upctl can be installed from a pre-built package in the repositories GitHub releases using a package manager or from sources with go install:

    LinuxmacOSWindowsgo installDocker

    Download pre-built package from GitHub releases and install it with your package manager.

    On Ubuntu or Debian, use the .deb package.

    curl -Lo upcloud-cli_3.14.0_amd64.deb https://github.com/UpCloudLtd/upcloud-cli/releases/download/v3.14.0/upcloud-cli_3.14.0_amd64.deb\nsudo apt install ./upcloud-cli_3.14.0_amd64.deb\n

    On RHEL based distributions, use the .rpm package.

    curl -Lo upcloud-cli-3.14.0-1.x86_64.rpm https://github.com/UpCloudLtd/upcloud-cli/releases/download/v3.14.0/upcloud-cli-3.14.0-1.x86_64.rpm\nsudo dnf install ./upcloud-cli-3.14.0-1.x86_64.rpm\n

    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 version\n
    "},{"location":"#configure-shell-completions","title":"Configure shell completions","text":"

    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.

    "},{"location":"#bash-completions","title":"Bash completions","text":"

    On bash, the completions depend on bash-completion package. Install and configure the package according to your OS:

    LinuxmacOS

    First, install bash-completion package, if it has not been installed already, and add command to source the completions to your .bashrc.

    On Ubuntu or Debian, use apt command to install the package:

    sudo apt install bash-completion\necho \"[ -f /etc/bash_completion ] && . /etc/bash_completion\" >> ~/.bashrc\n

    On RHEL based distributions, use dnf command to install the package.

    sudo dnf install bash-completion\necho \"[ -f /etc/bash_completion ] && . /etc/bash_completion\" >> ~/.bashrc\n

    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.

    brew install bash-completion\necho '[ -f \"$(brew --prefix)/etc/bash_completion\" ] && . \"$(brew --prefix)/etc/bash_completion\"' >> ~/.bash_profile\n

    Then configure the shell completions for upctl by saving the output of upctl completion bash in upctl file under /etc/bash_completion.d/:

    upctl completion bash > $(brew --prefix)/etc/bash_completion.d/upctl\n. $(brew --prefix)/etc/bash_completion\n
    "},{"location":"#configure-credentials","title":"Configure credentials","text":"

    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.

    "},{"location":"#execute-commands","title":"Execute commands","text":"

    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.

    "},{"location":"changelog/","title":"Changelog","text":"

    All notable changes to this project will be documented in this file.

    The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.

    "},{"location":"changelog/#unreleased","title":"Unreleased","text":""},{"location":"changelog/#3140-2025-01-08","title":"3.14.0 - 2025-01-08","text":""},{"location":"changelog/#added","title":"Added","text":""},{"location":"changelog/#fixed","title":"Fixed","text":""},{"location":"changelog/#3130-2024-12-13","title":"3.13.0 - 2024-12-13","text":""},{"location":"changelog/#added_1","title":"Added","text":""},{"location":"changelog/#changed","title":"Changed","text":""},{"location":"changelog/#3120-2024-11-18","title":"3.12.0 - 2024-11-18","text":""},{"location":"changelog/#changed_1","title":"Changed","text":""},{"location":"changelog/#3111-2024-08-12","title":"3.11.1 - 2024-08-12","text":""},{"location":"changelog/#fixed_1","title":"Fixed","text":""},{"location":"changelog/#3110-2024-07-23","title":"3.11.0 - 2024-07-23","text":""},{"location":"changelog/#added_2","title":"Added","text":""},{"location":"changelog/#3100-2024-07-17","title":"3.10.0 - 2024-07-17","text":""},{"location":"changelog/#changed_2","title":"Changed","text":""},{"location":"changelog/#390-2024-07-04","title":"3.9.0 - 2024-07-04","text":""},{"location":"changelog/#added_3","title":"Added","text":""},{"location":"changelog/#changed_3","title":"Changed","text":""},{"location":"changelog/#fixed_2","title":"Fixed","text":""},{"location":"changelog/#381-2024-05-24","title":"3.8.1 - 2024-05-24","text":""},{"location":"changelog/#changed_4","title":"Changed","text":""},{"location":"changelog/#380-2024-04-30","title":"3.8.0 - 2024-04-30","text":""},{"location":"changelog/#added_4","title":"Added","text":""},{"location":"changelog/#changed_5","title":"Changed","text":""},{"location":"changelog/#370-2024-04-04","title":"3.7.0 - 2024-04-04","text":""},{"location":"changelog/#added_5","title":"Added","text":""},{"location":"changelog/#360-2024-03-07","title":"3.6.0 - 2024-03-07","text":""},{"location":"changelog/#added_6","title":"Added","text":""},{"location":"changelog/#350-2024-02-29","title":"3.5.0 - 2024-02-29","text":""},{"location":"changelog/#added_7","title":"Added","text":""},{"location":"changelog/#changed_6","title":"Changed","text":""},{"location":"changelog/#340-2024-02-08","title":"3.4.0 - 2024-02-08","text":""},{"location":"changelog/#added_8","title":"Added","text":""},{"location":"changelog/#330-2024-01-23","title":"3.3.0 - 2024-01-23","text":""},{"location":"changelog/#added_9","title":"Added","text":""},{"location":"changelog/#removed","title":"Removed","text":""},{"location":"changelog/#322-2024-01-02","title":"3.2.2 - 2024-01-02","text":""},{"location":"changelog/#added_10","title":"Added","text":""},{"location":"changelog/#fixed_3","title":"Fixed","text":""},{"location":"changelog/#321-2023-11-29","title":"3.2.1 - 2023-11-29","text":""},{"location":"changelog/#added_11","title":"Added","text":""},{"location":"changelog/#320-2023-11-15","title":"3.2.0 - 2023-11-15","text":""},{"location":"changelog/#added_12","title":"Added","text":""},{"location":"changelog/#310-2023-11-06","title":"3.1.0 - 2023-11-06","text":""},{"location":"changelog/#added_13","title":"Added","text":""},{"location":"changelog/#changed_7","title":"Changed","text":""},{"location":"changelog/#fixed_4","title":"Fixed","text":""},{"location":"changelog/#300-2023-10-18","title":"3.0.0 - 2023-10-18","text":"

    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.

    "},{"location":"changelog/#added_14","title":"Added","text":""},{"location":"changelog/#changed_8","title":"Changed","text":""},{"location":"changelog/#fixed_5","title":"Fixed","text":""},{"location":"changelog/#removed_1","title":"Removed","text":""},{"location":"changelog/#2100-2023-07-17","title":"2.10.0 - 2023-07-17","text":""},{"location":"changelog/#added_15","title":"Added","text":""},{"location":"changelog/#fixed_6","title":"Fixed","text":""},{"location":"changelog/#291-2023-07-06","title":"2.9.1 - 2023-07-06","text":""},{"location":"changelog/#changed_9","title":"Changed","text":""},{"location":"changelog/#290-2023-06-30","title":"2.9.0 - 2023-06-30","text":""},{"location":"changelog/#added_16","title":"Added","text":""},{"location":"changelog/#280-2023-06-21","title":"2.8.0 - 2023-06-21","text":""},{"location":"changelog/#added_17","title":"Added","text":""},{"location":"changelog/#271-2023-05-16","title":"2.7.1 - 2023-05-16","text":""},{"location":"changelog/#fixed_7","title":"Fixed","text":""},{"location":"changelog/#270-2023-05-02","title":"2.7.0 - 2023-05-02","text":""},{"location":"changelog/#added_18","title":"Added","text":""},{"location":"changelog/#260-2023-03-14","title":"2.6.0 - 2023-03-14","text":""},{"location":"changelog/#added_19","title":"Added","text":""},{"location":"changelog/#changed_10","title":"Changed","text":""},{"location":"changelog/#250-2023-02-15","title":"2.5.0 - 2023-02-15","text":""},{"location":"changelog/#added_20","title":"Added","text":""},{"location":"changelog/#changed_11","title":"Changed","text":""},{"location":"changelog/#fixed_8","title":"Fixed","text":""},{"location":"changelog/#240-2022-12-19","title":"2.4.0 - 2022-12-19","text":""},{"location":"changelog/#added_21","title":"Added","text":""},{"location":"changelog/#230-2022-11-11","title":"2.3.0 - 2022-11-11","text":""},{"location":"changelog/#added_22","title":"Added","text":""},{"location":"changelog/#fixed_9","title":"Fixed","text":""},{"location":"changelog/#220-2022-10-17","title":"2.2.0 - 2022-10-17","text":""},{"location":"changelog/#added_23","title":"Added","text":""},{"location":"changelog/#fixed_10","title":"Fixed","text":""},{"location":"changelog/#210-2022-09-07","title":"2.1.0 - 2022-09-07","text":""},{"location":"changelog/#added_24","title":"Added","text":""},{"location":"changelog/#fixed_11","title":"Fixed","text":""},{"location":"changelog/#200-2022-08-30","title":"2.0.0 - 2022-08-30","text":""},{"location":"changelog/#added_25","title":"Added","text":""},{"location":"changelog/#changed_12","title":"Changed","text":""},{"location":"changelog/#fixed_12","title":"Fixed","text":""},{"location":"changelog/#151-2022-07-15","title":"1.5.1 - 2022-07-15","text":""},{"location":"changelog/#fixed_13","title":"Fixed","text":""},{"location":"changelog/#150-2022-07-05","title":"1.5.0 - 2022-07-05","text":""},{"location":"changelog/#added_26","title":"Added","text":""},{"location":"changelog/#changed_13","title":"Changed","text":""},{"location":"changelog/#fixed_14","title":"Fixed","text":""},{"location":"changelog/#140-2022-06-15","title":"1.4.0 - 2022-06-15","text":""},{"location":"changelog/#added_27","title":"Added","text":""},{"location":"changelog/#changed_14","title":"Changed","text":""},{"location":"changelog/#130-2022-05-17","title":"1.3.0 - 2022-05-17","text":""},{"location":"changelog/#added_28","title":"Added","text":""},{"location":"changelog/#changed_15","title":"Changed","text":""},{"location":"changelog/#fixed_15","title":"Fixed","text":""},{"location":"changelog/#120-2022-04-29","title":"1.2.0 - 2022-04-29","text":""},{"location":"changelog/#added_29","title":"Added","text":""},{"location":"changelog/#changed_16","title":"Changed","text":""},{"location":"changelog/#fixed_16","title":"Fixed","text":""},{"location":"changelog/#113-2022-02-24","title":"1.1.3 - 2022-02-24","text":""},{"location":"changelog/#changed_17","title":"Changed","text":""},{"location":"changelog/#fixed_17","title":"Fixed","text":""},{"location":"changelog/#112-2022-01-21","title":"1.1.2 - 2022-01-21","text":""},{"location":"changelog/#fixed_18","title":"Fixed","text":""},{"location":"changelog/#111-2021-09-30","title":"1.1.1 - 2021-09-30","text":""},{"location":"changelog/#changed_18","title":"Changed","text":""},{"location":"changelog/#110-2021-06-03","title":"1.1.0 - 2021-06-03","text":""},{"location":"changelog/#added_30","title":"Added","text":""},{"location":"changelog/#changed_19","title":"Changed","text":""},{"location":"changelog/#fixes","title":"Fixes","text":""},{"location":"changelog/#100-2021-04-16","title":"1.0.0 - 2021-04-16","text":"

    First non-beta release! Includes all previous changes and fixes.

    "},{"location":"changelog/#060-2021-04-16","title":"0.6.0 - 2021-04-16","text":""},{"location":"changelog/#changed_20","title":"Changed","text":""},{"location":"changelog/#fixes_1","title":"Fixes","text":""},{"location":"changelog/#050-2021-04-14","title":"0.5.0 - 2021-04-14","text":"

    Initial public beta release :tada:

    "},{"location":"changelog/#added_31","title":"Added","text":""},{"location":"changelog/#fixed_19","title":"Fixed","text":""},{"location":"changelog/#changed_21","title":"Changed","text":""},{"location":"changelog/#011-2021-03-12","title":"0.1.1 - 2021-03-12","text":""},{"location":"changelog/#fixed_20","title":"Fixed","text":""},{"location":"changelog/#010-2021-03-10","title":"0.1.0 - 2021-03-10","text":""},{"location":"changelog/#added_32","title":"Added","text":""},{"location":"commands_reference/upctl/","title":"upctl","text":"

    UpCloud command-line interface

    upctl provides a command-line interface to UpCloud services. It allows you to control your resources from the command line or any compatible interface.

    To be able to manage your UpCloud resources, you need to configure credentials for upctl 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":"

    Display software information

    upctl version [flags]\n
    "},{"location":"commands_reference/upctl_version/#examples","title":"Examples","text":"
    upctl version\n
    "},{"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":"

    Delete a sub-account

    upctl account delete <Username...> [flags]\n
    "},{"location":"commands_reference/upctl_account/delete/#examples","title":"Examples","text":"
    upctl account delete my-sub-account\n
    "},{"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":"

    List sub-accounts

    upctl account list [flags]\n
    "},{"location":"commands_reference/upctl_account/list/#examples","title":"Examples","text":"
    upctl account list\n
    "},{"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":"

    Show account

    upctl account show [flags]\n
    "},{"location":"commands_reference/upctl_account/show/#examples","title":"Examples","text":"
    upctl account show\n
    "},{"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":"

    List permissions

    upctl account permissions list [flags]\n
    "},{"location":"commands_reference/upctl_account/permissions/list/#examples","title":"Examples","text":"
    upctl account show\n
    "},{"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":"

    Manage databases

    upctl database [flags]\n
    "},{"location":"commands_reference/upctl_database/#aliases","title":"Aliases","text":"

    db

    "},{"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":"

    Delete a database

    upctl database delete <UUID/Title...> [flags]\n
    "},{"location":"commands_reference/upctl_database/delete/#examples","title":"Examples","text":"
    upctl database delete 0497728e-76ef-41d0-997f-fa9449eb71bc\nupctl database delete my_database\n
    "},{"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":"

    List current databases

    upctl database list [flags]\n
    "},{"location":"commands_reference/upctl_database/list/#examples","title":"Examples","text":"
    upctl database list\n
    "},{"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":"

    List available plans for given database type

    upctl database plans [flags]\n
    "},{"location":"commands_reference/upctl_database/plans/#examples","title":"Examples","text":"
    upctl database plans pg\nupctl database plans mysql\n
    "},{"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":"

    Show database details

    upctl database show <UUID/Title...> [flags]\n
    "},{"location":"commands_reference/upctl_database/show/#examples","title":"Examples","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":"

    Start on a managed database

    upctl database start <UUID/Title...> [flags]\n
    "},{"location":"commands_reference/upctl_database/start/#examples","title":"Examples","text":"
    upctl database start b0952286-1193-4a81-a1af-62efc014ae4b\nupctl database start b0952286-1193-4a81-a1af-62efc014ae4b 666bcd3c-5c63-428d-a4fd-07c27469a5a6\nupctl database start pg-1x1xcpu-2gb-25gb-pl-waw1\n
    "},{"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":"

    Stop a managed database

    upctl database stop <UUID/Title...> [flags]\n
    "},{"location":"commands_reference/upctl_database/stop/#aliases","title":"Aliases","text":"

    shutdown

    "},{"location":"commands_reference/upctl_database/stop/#examples","title":"Examples","text":"
    upctl database stop b0952286-1193-4a81-a1af-62efc014ae4b\nupctl database stop b0952286-1193-4a81-a1af-62efc014ae4b 666bcd3c-5c63-428d-a4fd-07c27469a5a6\nupctl database stop pg-1x1xcpu-2gb-25gb-pl-waw1\n
    "},{"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":"

    List available database types

    upctl database types [flags]\n
    "},{"location":"commands_reference/upctl_database/types/#examples","title":"Examples","text":"
    upctl database types\n
    "},{"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":"

    Manage database indices

    upctl database index [flags]\n
    "},{"location":"commands_reference/upctl_database/index/#aliases","title":"Aliases","text":"

    indices

    "},{"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
    "},{"location":"commands_reference/upctl_database/index/delete/#examples","title":"Examples","text":"
    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
    "},{"location":"commands_reference/upctl_database/index/list/#examples","title":"Examples","text":"
    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":"

    List available properties for given database type

    upctl database properties [flags]\n
    "},{"location":"commands_reference/upctl_database/properties/#examples","title":"Examples","text":"
    upctl database properties pg\nupctl database properties mysql\n
    "},{"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":"

    List available properties for MySQL databases

    upctl database properties mysql [flags]\n
    "},{"location":"commands_reference/upctl_database/properties/mysql/#examples","title":"Examples","text":"
    upctl database properties mysql\n
    "},{"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":"

    Show MySQL database property details

    upctl database properties mysql show [flags]\n
    "},{"location":"commands_reference/upctl_database/properties/mysql/show/#examples","title":"Examples","text":"
    upctl database properties mysql show version\n
    "},{"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

    upctl database properties opensearch [flags]\n
    "},{"location":"commands_reference/upctl_database/properties/opensearch/#examples","title":"Examples","text":"
    upctl database properties opensearch\n
    "},{"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
    "},{"location":"commands_reference/upctl_database/properties/opensearch/show/#examples","title":"Examples","text":"
    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

    upctl database properties pg [flags]\n
    "},{"location":"commands_reference/upctl_database/properties/pg/#examples","title":"Examples","text":"
    upctl database properties pg\n
    "},{"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":"

    Show PostgreSQL database property details

    upctl database properties pg show [flags]\n
    "},{"location":"commands_reference/upctl_database/properties/pg/show/#examples","title":"Examples","text":"
    upctl database properties pg show version\n
    "},{"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":"

    List available properties for Redis databases

    upctl database properties redis [flags]\n
    "},{"location":"commands_reference/upctl_database/properties/redis/#examples","title":"Examples","text":"
    upctl database properties redis\n
    "},{"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":"

    Show Redis database property details

    upctl database properties redis show [flags]\n
    "},{"location":"commands_reference/upctl_database/properties/redis/show/#examples","title":"Examples","text":"
    upctl database properties redis show version\n
    "},{"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

    upctl database session cancel <UUID/Title...> [flags]\n
    "},{"location":"commands_reference/upctl_database/session/cancel/#examples","title":"Examples","text":"
    upctl database session cancel 0fa980c4-0e4f-460b-9869-11b7bd62b832 --pid 2345422\nupctl database session cancel mysql-1 --pid 2345422 --terminate\n
    "},{"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
    "},{"location":"commands_reference/upctl_database/session/list/#examples","title":"Examples","text":"
    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":"

    Delete a gateway

    upctl gateway delete <UUID/Title...> [flags]\n
    "},{"location":"commands_reference/upctl_gateway/delete/#examples","title":"Examples","text":"
    upctl gateway delete 8abc8009-4325-4b23-4321-b1232cd81231\nupctl gateway delete my-gateway\n
    "},{"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":"

    List gateways

    upctl gateway list [flags]\n
    "},{"location":"commands_reference/upctl_gateway/list/#examples","title":"Examples","text":"
    upctl gateway list\n
    "},{"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":"

    List gateway plans

    upctl gateway plans [flags]\n
    "},{"location":"commands_reference/upctl_gateway/plans/#examples","title":"Examples","text":"
    upctl gateway plans\n
    "},{"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":"

    List private cloud hosts

    upctl host list [flags]\n
    "},{"location":"commands_reference/upctl_host/list/#examples","title":"Examples","text":"
    upctl host list\n
    "},{"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":"

    Manage IP addresses

    upctl ip-address [flags]\n
    "},{"location":"commands_reference/upctl_ip-address/#aliases","title":"Aliases","text":"

    ip

    "},{"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":"

    Assign or create an IP address

    upctl ip-address assign [flags]\n
    "},{"location":"commands_reference/upctl_ip-address/assign/#examples","title":"Examples","text":"
    upctl ip-address assign --server 00038afc-d526-4148-af0e-d2f1eeaded9b\nupctl ip-address assign --server 00944977-89ce-4d10-89c3-bb5ba482e48d --family IPv6\nupctl ip-address assign --server 00944977-89ce-4d10-89c3-bb5ba482e48d --floating --zone pl-waw1\nupctl ip-address assign --server 00b78f8b-521d-4ffb-8baa-adf96c7b8f45 --floating --mac d6:0e:4a:6f:11:8f\n
    "},{"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":"

    List IP addresses

    upctl ip-address list [flags]\n
    "},{"location":"commands_reference/upctl_ip-address/list/#examples","title":"Examples","text":"
    upctl ip-address list\n
    "},{"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":"

    Modify an IP address

    upctl ip-address modify <Address/PTRRecord...> [flags]\n
    "},{"location":"commands_reference/upctl_ip-address/modify/#examples","title":"Examples","text":"
    upctl ip-address modify 185.70.196.225 --ptr-record myapp.com\nupctl ip-address modify 185.70.197.175 --mac d6:0e:4a:6f:2b:06\n
    "},{"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":"

    Remove an IP address

    upctl ip-address remove <Address/PTRRecord...> [flags]\n
    "},{"location":"commands_reference/upctl_ip-address/remove/#examples","title":"Examples","text":"
    upctl ip-address remove 185.70.197.44\nupctl ip-address remove 2a04:3544:8000:1000:d40e:4aff:fe6f:2c85\n
    "},{"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
    "},{"location":"commands_reference/upctl_ip-address/show/#examples","title":"Examples","text":"
    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":"

    Manage Kubernetes clusters

    upctl kubernetes [flags]\n
    "},{"location":"commands_reference/upctl_kubernetes/#aliases","title":"Aliases","text":"

    k8s, uks

    "},{"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":"

    Output Kubernetes cluster kubeconfig

    upctl kubernetes config <UUID/Name...> [flags]\n
    "},{"location":"commands_reference/upctl_kubernetes/config/#examples","title":"Examples","text":"
    upctl kubernetes config 0fa980c4-0e4f-460b-9869-11b7bd62b831 --output human\nupctl kubernetes config 0fa980c4-0e4f-460b-9869-11b7bd62b831 --output yaml --write $KUBECONFIG\nupctl kubernetes config 0fa980c4-0e4f-460b-9869-11b7bd62b831 --output yaml --write ./my_kubeconfig.yaml\n
    "},{"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":"

    Create a Kubernetes cluster

    upctl kubernetes create [flags]\n
    "},{"location":"commands_reference/upctl_kubernetes/create/#examples","title":"Examples","text":"
    upctl kubernetes create \\\n                --name my-cluster \\\n                --network 03e5ca07-f36c-4957-a676-e001e40441eb \\\n                --node-group count=2,name=my-minimal-node-group,plan=2xCPU-4GB, \\\n                --zone de-fra1\nupctl kubernetes create \\\n                --name my-cluster \\\n                --plan production-small \\\n                --network 03e5ca07-f36c-4957-a676-e001e40441eb \\\n                --node-group count=4,kubelet-arg=\"log-flush-frequency=5s\",label=\"owner=devteam\",label=\"env=dev\",name=my-node-group,plan=4xCPU-8GB,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\" \\\n                --zone de-fra1\n
    "},{"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":"

    Delete a Kubernetes cluster

    upctl kubernetes delete <UUID/Name...> [flags]\n
    "},{"location":"commands_reference/upctl_kubernetes/delete/#examples","title":"Examples","text":"
    upctl kubernetes delete 55199a44-4751-4e27-9394-7c7661910be3\nupctl kubernetes delete my-kubernetes-cluster\n
    "},{"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":"

    List current Kubernetes clusters

    upctl kubernetes list [flags]\n
    "},{"location":"commands_reference/upctl_kubernetes/list/#examples","title":"Examples","text":"
    upctl kubernetes list\n
    "},{"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":"

    Modify an existing cluster

    upctl kubernetes modify <UUID/Name...> [flags]\n
    "},{"location":"commands_reference/upctl_kubernetes/modify/#examples","title":"Examples","text":"
    upctl cluster modify 00bb4617-c592-4b32-b869-35a60b323b18 --plan 1xCPU-1GB\n
    "},{"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":"

    List available cluster plans

    upctl kubernetes plans [flags]\n
    "},{"location":"commands_reference/upctl_kubernetes/plans/#examples","title":"Examples","text":"
    upctl kubernetes plans\n
    "},{"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":"

    Show Kubernetes cluster details

    upctl kubernetes show <UUID/Name...> [flags]\n
    "},{"location":"commands_reference/upctl_kubernetes/show/#examples","title":"Examples","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":"

    List available versions for Kubernetes clusters

    upctl kubernetes versions [flags]\n
    "},{"location":"commands_reference/upctl_kubernetes/versions/#examples","title":"Examples","text":"
    upctl kubernetes versions\n
    "},{"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":"

    Manage cluster node-groups

    upctl kubernetes nodegroup [flags]\n
    "},{"location":"commands_reference/upctl_kubernetes/nodegroup/#aliases","title":"Aliases","text":"

    node-group

    "},{"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.

    upctl kubernetes nodegroup create <UUID/Name...> [flags]\n
    "},{"location":"commands_reference/upctl_kubernetes/nodegroup/create/#examples","title":"Examples","text":"
    upctl kubernetes nodegroup create 55199a44-4751-4e27-9394-7c7661910be3 --name secondary-node-group --count 3 --plan 2xCPU-4GB\n
    "},{"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":"

    Delete the node group from the cluster.

    upctl kubernetes nodegroup delete <UUID/Name...> [flags]\n
    "},{"location":"commands_reference/upctl_kubernetes/nodegroup/delete/#examples","title":"Examples","text":"
    upctl kubernetes nodegroup delete 55199a44-4751-4e27-9394-7c7661910be3 --name secondary-node-group\n
    "},{"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":"

    Scale the number of nodes in the node group.

    upctl kubernetes nodegroup scale <UUID/Name...> [flags]\n
    "},{"location":"commands_reference/upctl_kubernetes/nodegroup/scale/#examples","title":"Examples","text":"
    upctl kubernetes nodegroup scale 55199a44-4751-4e27-9394-7c7661910be3 --name secondary-node-group --count 3\n
    "},{"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
    "},{"location":"commands_reference/upctl_kubernetes/nodegroup/show/#examples","title":"Examples","text":"
    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":"

    Manage load balancers

    upctl loadbalancer [flags]\n
    "},{"location":"commands_reference/upctl_loadbalancer/#aliases","title":"Aliases","text":"

    lb

    "},{"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":"

    Delete a load balancer

    upctl loadbalancer delete <UUID/Name...> [flags]\n
    "},{"location":"commands_reference/upctl_loadbalancer/delete/#examples","title":"Examples","text":"
    upctl loadbalancer delete 55199a44-4751-4e27-9394-7c7661910be3\nupctl loadbalancer delete my-load-balancer\n
    "},{"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":"

    List current load balancers

    upctl loadbalancer list [flags]\n
    "},{"location":"commands_reference/upctl_loadbalancer/list/#examples","title":"Examples","text":"
    upctl loadbalancer list\n
    "},{"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":"

    List available load balancer plans

    upctl loadbalancer plans [flags]\n
    "},{"location":"commands_reference/upctl_loadbalancer/plans/#examples","title":"Examples","text":"
    upctl loadbalancer plans\n
    "},{"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":"

    Show load balancer details

    upctl loadbalancer show <UUID/Name...> [flags]\n
    "},{"location":"commands_reference/upctl_loadbalancer/show/#examples","title":"Examples","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":"

    Manage networks

    upctl network <UUID/Name...> [flags]\n
    "},{"location":"commands_reference/upctl_network/#aliases","title":"Aliases","text":"

    net

    "},{"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":"

    Create a network

    upctl network create [flags]\n
    "},{"location":"commands_reference/upctl_network/create/#examples","title":"Examples","text":"
    upctl network create --name \"My Network\" --zone pl-waw1 --ip-network address=10.0.1.0/24\nupctl network create --name my_net --zone pl-waw1 --ip-network address=10.0.2.0/24,dhcp=true\n
    "},{"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":"

    Delete a network

    upctl network delete <UUID/Name...> [flags]\n
    "},{"location":"commands_reference/upctl_network/delete/#examples","title":"Examples","text":"
    upctl network delete 037f260c-9568-4d9b-97e5-44cf52440ccb\nupctl network delete 03d7b5c2-b80a-4636-88d4-f9911185c975 0312a237-8204-4c1c-9fd1-2314013ec687\nupctl network delete \"My Network 1\"\n
    "},{"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":"

    List networks, by default private networks only

    upctl network list [flags]\n
    "},{"location":"commands_reference/upctl_network/list/#examples","title":"Examples","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":"

    Modify a network

    upctl network modify <UUID/Name...> [flags]\n
    "},{"location":"commands_reference/upctl_network/modify/#examples","title":"Examples","text":"
    upctl network modify 037a530b-533e-4cef-b6ad-6af8094bb2bc --ip-network dhcp=false,family=IPv4\nupctl network modify \"My Network\" --name \"My Super Network\"\n
    "},{"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":"

    Show network details

    upctl network show <UUID/Name...> [flags]\n
    "},{"location":"commands_reference/upctl_network/show/#examples","title":"Examples","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":"

    Delete a network peering

    upctl networkpeering delete <UUID/Title...> [flags]\n
    "},{"location":"commands_reference/upctl_networkpeering/delete/#examples","title":"Examples","text":"
    upctl networkpeering delete 8abc8009-4325-4b23-4321-b1232cd81231\nupctl networkpeering delete my-network-peering\n
    "},{"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":"

    Disable a network peering

    upctl networkpeering disable <UUID/Title...> [flags]\n
    "},{"location":"commands_reference/upctl_networkpeering/disable/#examples","title":"Examples","text":"
    upctl networkpeering disable 8abc8009-4325-4b23-4321-b1232cd81231\nupctl networkpeering disable my-network-peering\n
    "},{"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":"

    List network peerings

    upctl networkpeering list [flags]\n
    "},{"location":"commands_reference/upctl_networkpeering/list/#examples","title":"Examples","text":"
    upctl networkpeering list\n
    "},{"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":"

    Manage managed object storage services

    upctl objectstorage [flags]\n
    "},{"location":"commands_reference/upctl_objectstorage/#aliases","title":"Aliases","text":"

    object-storage, objsto

    "},{"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":"

    Delete a Managed object storage service

    upctl objectstorage delete <UUID/Title...> [flags]\n
    "},{"location":"commands_reference/upctl_objectstorage/delete/#examples","title":"Examples","text":"
    upctl objectstorage delete 55199a44-4751-4e27-9394-7c7661910be8\n
    "},{"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":"

    List current Managed object storage services

    upctl objectstorage list [flags]\n
    "},{"location":"commands_reference/upctl_objectstorage/list/#examples","title":"Examples","text":"
    upctl objectstorage list\n
    "},{"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":"

    List objectstorage regions

    upctl objectstorage regions [flags]\n
    "},{"location":"commands_reference/upctl_objectstorage/regions/#examples","title":"Examples","text":"
    upctl objectstorage regions\n
    "},{"location":"commands_reference/upctl_objectstorage/regions/#options","title":"Options","text":"Option Description --help, -h help for regionsDefault: false"},{"location":"commands_reference/upctl_objectstorage/regions/#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/regions/#related-commands","title":"Related commands","text":"Command Description upctl objectstorage Manage managed object storage services"},{"location":"commands_reference/upctl_objectstorage/show/","title":"upctl objectstorage show","text":"

    Show Managed object storage service details

    upctl objectstorage show <UUID/Title...> [flags]\n
    "},{"location":"commands_reference/upctl_objectstorage/show/#examples","title":"Examples","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 [flags]\n
    "},{"location":"commands_reference/upctl_partner/account/create/#examples","title":"Examples","text":"
    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":"

    List accounts associated with partner

    upctl partner account list [flags]\n
    "},{"location":"commands_reference/upctl_partner/account/list/#examples","title":"Examples","text":"
    upctl partner account list\n
    "},{"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":"

    Create a router

    upctl router create [flags]\n
    "},{"location":"commands_reference/upctl_router/create/#examples","title":"Examples","text":"
    upctl router create --name my_router\nupctl router create --name \"My Router\"\n
    "},{"location":"commands_reference/upctl_router/create/#options","title":"Options","text":"Option Description --name Router name. --help, -h help for createDefault: false"},{"location":"commands_reference/upctl_router/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_router/create/#related-commands","title":"Related commands","text":"Command Description upctl router Manage routers"},{"location":"commands_reference/upctl_router/delete/","title":"upctl router delete","text":"

    Delete a router

    upctl router delete <UUID/Name...> [flags]\n
    "},{"location":"commands_reference/upctl_router/delete/#examples","title":"Examples","text":"
    upctl router delete 0497728e-76ef-41d0-997f-fa9449eb71bc\nupctl router delete my_router\n
    "},{"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":"

    List routers

    upctl router list [flags]\n
    "},{"location":"commands_reference/upctl_router/list/#examples","title":"Examples","text":"
    upctl router list\nupctl router list --all\n
    "},{"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":"

    Modify a router

    upctl router modify <UUID/Name...> [flags]\n
    "},{"location":"commands_reference/upctl_router/modify/#examples","title":"Examples","text":"
    upctl router modify 04d031ab-4b85-4cbc-9f0e-6a2977541327 --name my_super_router\nupctl router modify \"My Router\" --name \"My Turbo Router\"\n
    "},{"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":"

    Show current router

    upctl router show <UUID/Name...> [flags]\n
    "},{"location":"commands_reference/upctl_router/show/#examples","title":"Examples","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.

    upctl server create [flags]\n
    "},{"location":"commands_reference/upctl_server/create/#examples","title":"Examples","text":"
    upctl server create --title myapp --zone fi-hel1 --hostname myapp --ssh-keys ~/.ssh/id_*.pub\nupctl server create --wait --title myapp --zone fi-hel1 --hostname myapp --ssh-keys ~/.ssh/id_*.pub\nupctl server create --title \"My Server\" --zone fi-hel1 --hostname myapp --ssh-keys ~/.ssh/id_*.pub\nupctl server create --zone fi-hel1 --hostname myapp --ssh-keys ~/.ssh/id_*.pub --plan 2xCPU-4GB\nupctl server create --zone fi-hel1 --hostname myapp --ssh-keys ~/.ssh/id_*.pub --plan custom --cores 2 --memory 4096\nupctl server create --zone fi-hel1 --hostname myapp --password-delivery email --os \"Debian GNU/Linux 10 (Buster)\" --server-group a4643646-8342-4324-4134-364138712378\nupctl server create --zone fi-hel1 --hostname myapp --ssh-keys ~/.ssh/id_*.pub --network type=private,network=037a530b-533e-4cef-b6ad-6af8094bb2bc,ip-address=10.0.0.1\n
    "},{"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
    "},{"location":"commands_reference/upctl_server/delete/#examples","title":"Examples","text":"
    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/#examples","title":"Examples","text":"
    upctl server eject my_server\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":"

    List current servers

    upctl server list [flags]\n
    "},{"location":"commands_reference/upctl_server/list/#examples","title":"Examples","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
    "},{"location":"commands_reference/upctl_server/load/#examples","title":"Examples","text":"
    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
    "},{"location":"commands_reference/upctl_server/modify/#examples","title":"Examples","text":"
    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":"

    List server plans

    upctl server plans [flags]\n
    "},{"location":"commands_reference/upctl_server/plans/#examples","title":"Examples","text":"
    upctl server plans\n
    "},{"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
    "},{"location":"commands_reference/upctl_server/restart/#examples","title":"Examples","text":"
    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
    "},{"location":"commands_reference/upctl_server/show/#examples","title":"Examples","text":"
    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
    "},{"location":"commands_reference/upctl_server/start/#examples","title":"Examples","text":"
    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
    "},{"location":"commands_reference/upctl_server/stop/#examples","title":"Examples","text":"
    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
    "},{"location":"commands_reference/upctl_server/firewall/create/#examples","title":"Examples","text":"
    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
    "},{"location":"commands_reference/upctl_server/firewall/delete/#examples","title":"Examples","text":"
    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
    "},{"location":"commands_reference/upctl_server/firewall/show/#examples","title":"Examples","text":"
    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
    "},{"location":"commands_reference/upctl_server/network-interface/create/#examples","title":"Examples","text":"
    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
    "},{"location":"commands_reference/upctl_server/network-interface/delete/#examples","title":"Examples","text":"
    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
    "},{"location":"commands_reference/upctl_server/network-interface/modify/#examples","title":"Examples","text":"
    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
    "},{"location":"commands_reference/upctl_server/storage/attach/#examples","title":"Examples","text":"
    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
    "},{"location":"commands_reference/upctl_server/storage/detach/#examples","title":"Examples","text":"
    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":"

    Create a server group

    upctl servergroup create [flags]\n
    "},{"location":"commands_reference/upctl_servergroup/create/#examples","title":"Examples","text":"
    upctl servergroup create \\\n                --title my-server-group \\\n                --anti-affinity-policy yes \\\n                --server 1fdfda29-ead1-4855-b71f-a432179800ab \\\n                --server my-server\nupctl servergroup create \\\n                --title my-server-group \\\n                --anti-affinity-policy yes \\\n                --label env=dev\nupctl servergroup create \\\n                --title my-server-group \\\n                --anti-affinity-policy strict \\\n                --label env=dev \\\n                --label owner=operations\n
    "},{"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":"

    Delete a server group

    upctl servergroup delete <UUID/Title...> [flags]\n
    "},{"location":"commands_reference/upctl_servergroup/delete/#examples","title":"Examples","text":"
    upctl servergroup delete 8abc8009-4325-4b23-4321-b1232cd81231\nupctl servergroup delete my-server-group\n
    "},{"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":"

    List current server groups

    upctl servergroup list [flags]\n
    "},{"location":"commands_reference/upctl_servergroup/list/#examples","title":"Examples","text":"
    upctl servergroup list\n
    "},{"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":"

    Modify a server group

    upctl servergroup modify <UUID/Title...> [flags]\n
    "},{"location":"commands_reference/upctl_servergroup/modify/#examples","title":"Examples","text":"
    upctl servergroup modify 8abc8009-4325-4b23-4321-b1232cd81231 --title your-server-group\nupctl servergroup modify my-server-group --anti-affinity-policy strict\nupctl servergroup modify my-server-group --server my-server-1 --server my-server-2 --server my-server-3-\nupctl servergroup modify 8abc8009-4325-4b23-4321-b1232cd81231 --server 0bab98e5-b327-4ab8-ba16-738d4af7578b --server my-server-2\nupctl servergroup modify my-server-group --label env=dev\n
    "},{"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":"

    Show server group details

    upctl servergroup show <UUID/Title...> [flags]\n
    "},{"location":"commands_reference/upctl_servergroup/show/#examples","title":"Examples","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":"

    Clone a storage

    upctl storage clone <UUID/Title...> [flags]\n
    "},{"location":"commands_reference/upctl_storage/clone/#examples","title":"Examples","text":"
    upctl storage clone 015899e0-0a68-4949-85bb-261a99de5fdd --title my_storage_clone --zone fi-hel1\nupctl storage clone 015899e0-0a68-4949-85bb-261a99de5fdd --title my_storage_clone2 --zone pl-waw1  --tier maxiops\nupctl storage clone \"My Storage\" --title my_storage_clone3 --zone pl-waw1  --tier maxiops\n
    "},{"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":"

    Create a storage

    upctl storage create [flags]\n
    "},{"location":"commands_reference/upctl_storage/create/#examples","title":"Examples","text":"
    upctl storage create --zone pl-waw1 --title \"Default Size\"\nupctl storage create --zone pl-waw1 --title with_backups --size 20 --backup-interval wed --backup-retention 4\nupctl storage create --zone pl-waw1 --title standard-tier --size 3 --tier standard\n
    "},{"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":"

    Delete a storage

    upctl storage delete <UUID/Title...> [flags]\n
    "},{"location":"commands_reference/upctl_storage/delete/#examples","title":"Examples","text":"
    upctl storage delete 01ac5319-08ac-4e7b-81e5-3140d2bbd7d8\nupctl storage delete 0175bb34-8aed-47ce-9290-10cc45f78601 01fcb78f-e73d-4e4d-af5a-0bd6cdba4306\nupctl storage delete \"My Storage\"\n
    "},{"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":"

    Import a storage from external or local source

    upctl storage import [flags]\n
    "},{"location":"commands_reference/upctl_storage/import/#examples","title":"Examples","text":"
    upctl storage import --source-location https://cdimage.debian.org/debian-cd/current/amd64/iso-cd/debian-10.9.0-amd64-netinst.iso --title my_storage --zone es-mad1\n
    "},{"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":"

    List current storages

    upctl storage list [flags]\n
    "},{"location":"commands_reference/upctl_storage/list/#examples","title":"Examples","text":"
    upctl storage list\nupctl storage list --all\n
    "},{"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":"

    Modify a storage

    upctl storage modify <UUID/Title...> [flags]\n
    "},{"location":"commands_reference/upctl_storage/modify/#examples","title":"Examples","text":"
    upctl storage modify 01271548-2e92-44bb-9774-d282508cc762 --title \"My Storage\" --size 20\nupctl storage modify \"My Storage\" --size 25\n
    "},{"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":"

    Show storage details

    upctl storage show <UUID/Title...> [flags]\n
    "},{"location":"commands_reference/upctl_storage/show/#examples","title":"Examples","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":"

    Templatise a storage

    upctl storage templatise <UUID/Title...> [flags]\n
    "},{"location":"commands_reference/upctl_storage/templatise/#examples","title":"Examples","text":"
    upctl storage templatise 01271548-2e92-44bb-9774-d282508cc762 --title \"My Template\"\nupctl storage templatise 01271548-2e92-44bb-9774-d282508cc762 --title \"My Template\" --wait\nupctl storage templatise \"My Storage\" --title super_template\n
    "},{"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":"

    Create backup of a storage

    upctl storage backup create <UUID/Title...> [flags]\n
    "},{"location":"commands_reference/upctl_storage/backup/create/#examples","title":"Examples","text":"
    upctl storage backup create 01cbea5e-eb5b-4072-b2ac-9b635120e5d8 --title \"first backup\"\nupctl storage backup create \"My Storage\" --title second_backup\n
    "},{"location":"commands_reference/upctl_storage/backup/create/#options","title":"Options","text":"Option Description --title A short, informational description. --help, -h help for createDefault: false"},{"location":"commands_reference/upctl_storage/backup/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/backup/create/#related-commands","title":"Related commands","text":"Command Description upctl storage backup Manage backups"},{"location":"commands_reference/upctl_storage/backup/restore/","title":"upctl storage backup restore","text":"

    Restore backup of a storage

    upctl storage backup restore <UUID/Title...> [flags]\n
    "},{"location":"commands_reference/upctl_storage/backup/restore/#examples","title":"Examples","text":"
    upctl storage backup restore 01177c9e-7f76-4ce4-b128-bcaa3448f7ec\nupctl storage backup restore second_backup\n
    "},{"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":"

    List available zones

    upctl zone list [flags]\n
    "},{"location":"commands_reference/upctl_zone/list/#examples","title":"Examples","text":"
    upctl zone list\n
    "},{"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.

    "},{"location":"examples/#testing","title":"Testing","text":"

    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

    Now we are ready for creating the template.

    upctl storage templatise ${prefix}source-server-OS \\\n    --title ${prefix}template \\\n    --wait\n

    Once the template is created, we can delete the source server

    upctl server delete ${prefix}source-server --delete-storages\n

    To test that the template creation succeeded, create a new server from the just created template.

    upctl server create \\\n    --hostname ${prefix}server \\\n    --zone pl-waw1 \\\n    --network type=public \\\n    --network type=utility \\\n    --os ${prefix}template \\\n    --wait\n

    Finally, we can cleanup the created resources.

    upctl server stop --type hard --wait ${prefix}server\nupctl server delete ${prefix}server --delete-storages\nupctl storage delete ${prefix}template\n
    "},{"location":"examples/create_and_restore_backup/","title":"Backup a server and re-create it using the backup","text":"

    This example demonstrates how to backup a server with upctl and use the created backup to re-create the server.

    To keep track of resources created during this example, we will use common prefix in all resource names.

    prefix=example-upctl-backup-\n

    We will first create a ssh-key into the current working directory for configuring an nginx server via SSH connection.

    ssh-keygen -t ed25519 -q -f \"./id_ed25519\" -N \"\" -C \"upctl example\"\n

    We will then create a server with a single network interface and default template settings.

    upctl server create \\\n    --hostname ${prefix}source-server \\\n    --zone pl-waw1 \\\n    --ssh-keys ./id_ed25519.pub \\\n    --network type=public \\\n    --wait\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.

    upctl storage backup create ${prefix}source-server-OS --title ${prefix}source-server-backup\n

    After creating the backup, we can delete the source server and its storages.

    upctl server stop --type hard --wait ${prefix}source-server\nupctl server delete ${prefix}source-server --delete-storages\n

    We can then create a new server based on the backup of the source servers disk.

    upctl server create \\\n    --hostname ${prefix}restored-server \\\n    --zone pl-waw1 \\\n    --ssh-keys ./id_ed25519.pub \\\n    --network type=public \\\n    --storage action=clone,storage=${prefix}source-server-backup \\\n    --wait\n

    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.

    upctl server create \\\n    --hostname ${prefix}server \\\n    --zone pl-waw1 \\\n    --ssh-keys ./id_ed25519.pub \\\n    --network type=public \\\n    --network type=utility \\\n    --wait\n

    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
    "},{"location":"examples/possible_exit_codes/","title":"Possible exit codes","text":"

    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.

    "},{"location":"#install-upctl","title":"Install upctl","text":"

    upctl can be installed from a pre-built package in the repositories GitHub releases using a package manager or from sources with go install:

    LinuxmacOSWindowsgo installDocker

    Download pre-built package from GitHub releases and install it with your package manager.

    On Ubuntu or Debian, use the .deb package.

    curl -Lo upcloud-cli_3.14.0_amd64.deb https://github.com/UpCloudLtd/upcloud-cli/releases/download/v3.14.0/upcloud-cli_3.14.0_amd64.deb\nsudo apt install ./upcloud-cli_3.14.0_amd64.deb\n

    On RHEL based distributions, use the .rpm package.

    curl -Lo upcloud-cli-3.14.0-1.x86_64.rpm https://github.com/UpCloudLtd/upcloud-cli/releases/download/v3.14.0/upcloud-cli-3.14.0-1.x86_64.rpm\nsudo dnf install ./upcloud-cli-3.14.0-1.x86_64.rpm\n

    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 version\n
    "},{"location":"#configure-shell-completions","title":"Configure shell completions","text":"

    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.

    "},{"location":"#bash-completions","title":"Bash completions","text":"

    On bash, the completions depend on bash-completion package. Install and configure the package according to your OS:

    LinuxmacOS

    First, install bash-completion package, if it has not been installed already, and add command to source the completions to your .bashrc.

    On Ubuntu or Debian, use apt command to install the package:

    sudo apt install bash-completion\necho \"[ -f /etc/bash_completion ] && . /etc/bash_completion\" >> ~/.bashrc\n

    On RHEL based distributions, use dnf command to install the package.

    sudo dnf install bash-completion\necho \"[ -f /etc/bash_completion ] && . /etc/bash_completion\" >> ~/.bashrc\n

    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.

    brew install bash-completion\necho '[ -f \"$(brew --prefix)/etc/bash_completion\" ] && . \"$(brew --prefix)/etc/bash_completion\"' >> ~/.bash_profile\n

    Then configure the shell completions for upctl by saving the output of upctl completion bash in upctl file under /etc/bash_completion.d/:

    upctl completion bash > $(brew --prefix)/etc/bash_completion.d/upctl\n. $(brew --prefix)/etc/bash_completion\n
    "},{"location":"#configure-credentials","title":"Configure credentials","text":"

    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.

    "},{"location":"#execute-commands","title":"Execute commands","text":"

    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.

    "},{"location":"changelog/","title":"Changelog","text":"

    All notable changes to this project will be documented in this file.

    The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.

    "},{"location":"changelog/#unreleased","title":"Unreleased","text":""},{"location":"changelog/#added","title":"Added","text":""},{"location":"changelog/#3140-2025-01-08","title":"3.14.0 - 2025-01-08","text":""},{"location":"changelog/#added_1","title":"Added","text":""},{"location":"changelog/#fixed","title":"Fixed","text":""},{"location":"changelog/#3130-2024-12-13","title":"3.13.0 - 2024-12-13","text":""},{"location":"changelog/#added_2","title":"Added","text":""},{"location":"changelog/#changed","title":"Changed","text":""},{"location":"changelog/#3120-2024-11-18","title":"3.12.0 - 2024-11-18","text":""},{"location":"changelog/#changed_1","title":"Changed","text":""},{"location":"changelog/#3111-2024-08-12","title":"3.11.1 - 2024-08-12","text":""},{"location":"changelog/#fixed_1","title":"Fixed","text":""},{"location":"changelog/#3110-2024-07-23","title":"3.11.0 - 2024-07-23","text":""},{"location":"changelog/#added_3","title":"Added","text":""},{"location":"changelog/#3100-2024-07-17","title":"3.10.0 - 2024-07-17","text":""},{"location":"changelog/#changed_2","title":"Changed","text":""},{"location":"changelog/#390-2024-07-04","title":"3.9.0 - 2024-07-04","text":""},{"location":"changelog/#added_4","title":"Added","text":""},{"location":"changelog/#changed_3","title":"Changed","text":""},{"location":"changelog/#fixed_2","title":"Fixed","text":""},{"location":"changelog/#381-2024-05-24","title":"3.8.1 - 2024-05-24","text":""},{"location":"changelog/#changed_4","title":"Changed","text":""},{"location":"changelog/#380-2024-04-30","title":"3.8.0 - 2024-04-30","text":""},{"location":"changelog/#added_5","title":"Added","text":""},{"location":"changelog/#changed_5","title":"Changed","text":""},{"location":"changelog/#370-2024-04-04","title":"3.7.0 - 2024-04-04","text":""},{"location":"changelog/#added_6","title":"Added","text":""},{"location":"changelog/#360-2024-03-07","title":"3.6.0 - 2024-03-07","text":""},{"location":"changelog/#added_7","title":"Added","text":""},{"location":"changelog/#350-2024-02-29","title":"3.5.0 - 2024-02-29","text":""},{"location":"changelog/#added_8","title":"Added","text":""},{"location":"changelog/#changed_6","title":"Changed","text":""},{"location":"changelog/#340-2024-02-08","title":"3.4.0 - 2024-02-08","text":""},{"location":"changelog/#added_9","title":"Added","text":""},{"location":"changelog/#330-2024-01-23","title":"3.3.0 - 2024-01-23","text":""},{"location":"changelog/#added_10","title":"Added","text":""},{"location":"changelog/#removed","title":"Removed","text":""},{"location":"changelog/#322-2024-01-02","title":"3.2.2 - 2024-01-02","text":""},{"location":"changelog/#added_11","title":"Added","text":""},{"location":"changelog/#fixed_3","title":"Fixed","text":""},{"location":"changelog/#321-2023-11-29","title":"3.2.1 - 2023-11-29","text":""},{"location":"changelog/#added_12","title":"Added","text":""},{"location":"changelog/#320-2023-11-15","title":"3.2.0 - 2023-11-15","text":""},{"location":"changelog/#added_13","title":"Added","text":""},{"location":"changelog/#310-2023-11-06","title":"3.1.0 - 2023-11-06","text":""},{"location":"changelog/#added_14","title":"Added","text":""},{"location":"changelog/#changed_7","title":"Changed","text":""},{"location":"changelog/#fixed_4","title":"Fixed","text":""},{"location":"changelog/#300-2023-10-18","title":"3.0.0 - 2023-10-18","text":"

    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.

    "},{"location":"changelog/#added_15","title":"Added","text":""},{"location":"changelog/#changed_8","title":"Changed","text":""},{"location":"changelog/#fixed_5","title":"Fixed","text":""},{"location":"changelog/#removed_1","title":"Removed","text":""},{"location":"changelog/#2100-2023-07-17","title":"2.10.0 - 2023-07-17","text":""},{"location":"changelog/#added_16","title":"Added","text":""},{"location":"changelog/#fixed_6","title":"Fixed","text":""},{"location":"changelog/#291-2023-07-06","title":"2.9.1 - 2023-07-06","text":""},{"location":"changelog/#changed_9","title":"Changed","text":""},{"location":"changelog/#290-2023-06-30","title":"2.9.0 - 2023-06-30","text":""},{"location":"changelog/#added_17","title":"Added","text":""},{"location":"changelog/#280-2023-06-21","title":"2.8.0 - 2023-06-21","text":""},{"location":"changelog/#added_18","title":"Added","text":""},{"location":"changelog/#271-2023-05-16","title":"2.7.1 - 2023-05-16","text":""},{"location":"changelog/#fixed_7","title":"Fixed","text":""},{"location":"changelog/#270-2023-05-02","title":"2.7.0 - 2023-05-02","text":""},{"location":"changelog/#added_19","title":"Added","text":""},{"location":"changelog/#260-2023-03-14","title":"2.6.0 - 2023-03-14","text":""},{"location":"changelog/#added_20","title":"Added","text":""},{"location":"changelog/#changed_10","title":"Changed","text":""},{"location":"changelog/#250-2023-02-15","title":"2.5.0 - 2023-02-15","text":""},{"location":"changelog/#added_21","title":"Added","text":""},{"location":"changelog/#changed_11","title":"Changed","text":""},{"location":"changelog/#fixed_8","title":"Fixed","text":""},{"location":"changelog/#240-2022-12-19","title":"2.4.0 - 2022-12-19","text":""},{"location":"changelog/#added_22","title":"Added","text":""},{"location":"changelog/#230-2022-11-11","title":"2.3.0 - 2022-11-11","text":""},{"location":"changelog/#added_23","title":"Added","text":""},{"location":"changelog/#fixed_9","title":"Fixed","text":""},{"location":"changelog/#220-2022-10-17","title":"2.2.0 - 2022-10-17","text":""},{"location":"changelog/#added_24","title":"Added","text":""},{"location":"changelog/#fixed_10","title":"Fixed","text":""},{"location":"changelog/#210-2022-09-07","title":"2.1.0 - 2022-09-07","text":""},{"location":"changelog/#added_25","title":"Added","text":""},{"location":"changelog/#fixed_11","title":"Fixed","text":""},{"location":"changelog/#200-2022-08-30","title":"2.0.0 - 2022-08-30","text":""},{"location":"changelog/#added_26","title":"Added","text":""},{"location":"changelog/#changed_12","title":"Changed","text":""},{"location":"changelog/#fixed_12","title":"Fixed","text":""},{"location":"changelog/#151-2022-07-15","title":"1.5.1 - 2022-07-15","text":""},{"location":"changelog/#fixed_13","title":"Fixed","text":""},{"location":"changelog/#150-2022-07-05","title":"1.5.0 - 2022-07-05","text":""},{"location":"changelog/#added_27","title":"Added","text":""},{"location":"changelog/#changed_13","title":"Changed","text":""},{"location":"changelog/#fixed_14","title":"Fixed","text":""},{"location":"changelog/#140-2022-06-15","title":"1.4.0 - 2022-06-15","text":""},{"location":"changelog/#added_28","title":"Added","text":""},{"location":"changelog/#changed_14","title":"Changed","text":""},{"location":"changelog/#130-2022-05-17","title":"1.3.0 - 2022-05-17","text":""},{"location":"changelog/#added_29","title":"Added","text":""},{"location":"changelog/#changed_15","title":"Changed","text":""},{"location":"changelog/#fixed_15","title":"Fixed","text":""},{"location":"changelog/#120-2022-04-29","title":"1.2.0 - 2022-04-29","text":""},{"location":"changelog/#added_30","title":"Added","text":""},{"location":"changelog/#changed_16","title":"Changed","text":""},{"location":"changelog/#fixed_16","title":"Fixed","text":""},{"location":"changelog/#113-2022-02-24","title":"1.1.3 - 2022-02-24","text":""},{"location":"changelog/#changed_17","title":"Changed","text":""},{"location":"changelog/#fixed_17","title":"Fixed","text":""},{"location":"changelog/#112-2022-01-21","title":"1.1.2 - 2022-01-21","text":""},{"location":"changelog/#fixed_18","title":"Fixed","text":""},{"location":"changelog/#111-2021-09-30","title":"1.1.1 - 2021-09-30","text":""},{"location":"changelog/#changed_18","title":"Changed","text":""},{"location":"changelog/#110-2021-06-03","title":"1.1.0 - 2021-06-03","text":""},{"location":"changelog/#added_31","title":"Added","text":""},{"location":"changelog/#changed_19","title":"Changed","text":""},{"location":"changelog/#fixes","title":"Fixes","text":""},{"location":"changelog/#100-2021-04-16","title":"1.0.0 - 2021-04-16","text":"

    First non-beta release! Includes all previous changes and fixes.

    "},{"location":"changelog/#060-2021-04-16","title":"0.6.0 - 2021-04-16","text":""},{"location":"changelog/#changed_20","title":"Changed","text":""},{"location":"changelog/#fixes_1","title":"Fixes","text":""},{"location":"changelog/#050-2021-04-14","title":"0.5.0 - 2021-04-14","text":"

    Initial public beta release :tada:

    "},{"location":"changelog/#added_32","title":"Added","text":""},{"location":"changelog/#fixed_19","title":"Fixed","text":""},{"location":"changelog/#changed_21","title":"Changed","text":""},{"location":"changelog/#011-2021-03-12","title":"0.1.1 - 2021-03-12","text":""},{"location":"changelog/#fixed_20","title":"Fixed","text":""},{"location":"changelog/#010-2021-03-10","title":"0.1.0 - 2021-03-10","text":""},{"location":"changelog/#added_33","title":"Added","text":""},{"location":"commands_reference/upctl/","title":"upctl","text":"

    UpCloud command-line interface

    upctl provides a command-line interface to UpCloud services. It allows you to control your resources from the command line or any compatible interface.

    To be able to manage your UpCloud resources, you need to configure credentials for upctl 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":"

    Display software information

    upctl version [flags]\n
    "},{"location":"commands_reference/upctl_version/#examples","title":"Examples","text":"
    upctl version\n
    "},{"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":"

    Delete a sub-account

    upctl account delete <Username...> [flags]\n
    "},{"location":"commands_reference/upctl_account/delete/#examples","title":"Examples","text":"
    upctl account delete my-sub-account\n
    "},{"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":"

    List sub-accounts

    upctl account list [flags]\n
    "},{"location":"commands_reference/upctl_account/list/#examples","title":"Examples","text":"
    upctl account list\n
    "},{"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":"

    Show account

    upctl account show [flags]\n
    "},{"location":"commands_reference/upctl_account/show/#examples","title":"Examples","text":"
    upctl account show\n
    "},{"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":"

    List permissions

    upctl account permissions list [flags]\n
    "},{"location":"commands_reference/upctl_account/permissions/list/#examples","title":"Examples","text":"
    upctl account show\n
    "},{"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":"

    Manage databases

    upctl database [flags]\n
    "},{"location":"commands_reference/upctl_database/#aliases","title":"Aliases","text":"

    db

    "},{"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":"

    Delete a database

    upctl database delete <UUID/Title...> [flags]\n
    "},{"location":"commands_reference/upctl_database/delete/#examples","title":"Examples","text":"
    upctl database delete 0497728e-76ef-41d0-997f-fa9449eb71bc\nupctl database delete my_database\n
    "},{"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":"

    List current databases

    upctl database list [flags]\n
    "},{"location":"commands_reference/upctl_database/list/#examples","title":"Examples","text":"
    upctl database list\n
    "},{"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":"

    List available plans for given database type

    upctl database plans [flags]\n
    "},{"location":"commands_reference/upctl_database/plans/#examples","title":"Examples","text":"
    upctl database plans pg\nupctl database plans mysql\n
    "},{"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":"

    Show database details

    upctl database show <UUID/Title...> [flags]\n
    "},{"location":"commands_reference/upctl_database/show/#examples","title":"Examples","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":"

    Start on a managed database

    upctl database start <UUID/Title...> [flags]\n
    "},{"location":"commands_reference/upctl_database/start/#examples","title":"Examples","text":"
    upctl database start b0952286-1193-4a81-a1af-62efc014ae4b\nupctl database start b0952286-1193-4a81-a1af-62efc014ae4b 666bcd3c-5c63-428d-a4fd-07c27469a5a6\nupctl database start pg-1x1xcpu-2gb-25gb-pl-waw1\n
    "},{"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":"

    Stop a managed database

    upctl database stop <UUID/Title...> [flags]\n
    "},{"location":"commands_reference/upctl_database/stop/#aliases","title":"Aliases","text":"

    shutdown

    "},{"location":"commands_reference/upctl_database/stop/#examples","title":"Examples","text":"
    upctl database stop b0952286-1193-4a81-a1af-62efc014ae4b\nupctl database stop b0952286-1193-4a81-a1af-62efc014ae4b 666bcd3c-5c63-428d-a4fd-07c27469a5a6\nupctl database stop pg-1x1xcpu-2gb-25gb-pl-waw1\n
    "},{"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":"

    List available database types

    upctl database types [flags]\n
    "},{"location":"commands_reference/upctl_database/types/#examples","title":"Examples","text":"
    upctl database types\n
    "},{"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":"

    Manage database indices

    upctl database index [flags]\n
    "},{"location":"commands_reference/upctl_database/index/#aliases","title":"Aliases","text":"

    indices

    "},{"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
    "},{"location":"commands_reference/upctl_database/index/delete/#examples","title":"Examples","text":"
    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
    "},{"location":"commands_reference/upctl_database/index/list/#examples","title":"Examples","text":"
    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":"

    List available properties for given database type

    upctl database properties [flags]\n
    "},{"location":"commands_reference/upctl_database/properties/#examples","title":"Examples","text":"
    upctl database properties pg\nupctl database properties mysql\n
    "},{"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":"

    List available properties for MySQL databases

    upctl database properties mysql [flags]\n
    "},{"location":"commands_reference/upctl_database/properties/mysql/#examples","title":"Examples","text":"
    upctl database properties mysql\n
    "},{"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":"

    Show MySQL database property details

    upctl database properties mysql show [flags]\n
    "},{"location":"commands_reference/upctl_database/properties/mysql/show/#examples","title":"Examples","text":"
    upctl database properties mysql show version\n
    "},{"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

    upctl database properties opensearch [flags]\n
    "},{"location":"commands_reference/upctl_database/properties/opensearch/#examples","title":"Examples","text":"
    upctl database properties opensearch\n
    "},{"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
    "},{"location":"commands_reference/upctl_database/properties/opensearch/show/#examples","title":"Examples","text":"
    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

    upctl database properties pg [flags]\n
    "},{"location":"commands_reference/upctl_database/properties/pg/#examples","title":"Examples","text":"
    upctl database properties pg\n
    "},{"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":"

    Show PostgreSQL database property details

    upctl database properties pg show [flags]\n
    "},{"location":"commands_reference/upctl_database/properties/pg/show/#examples","title":"Examples","text":"
    upctl database properties pg show version\n
    "},{"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":"

    List available properties for Redis databases

    upctl database properties redis [flags]\n
    "},{"location":"commands_reference/upctl_database/properties/redis/#examples","title":"Examples","text":"
    upctl database properties redis\n
    "},{"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":"

    Show Redis database property details

    upctl database properties redis show [flags]\n
    "},{"location":"commands_reference/upctl_database/properties/redis/show/#examples","title":"Examples","text":"
    upctl database properties redis show version\n
    "},{"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":"

    List available properties for Valkey databases

    upctl database properties valkey [flags]\n
    "},{"location":"commands_reference/upctl_database/properties/valkey/#examples","title":"Examples","text":"
    upctl database properties valkey\n
    "},{"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":"

    Show Valkey database property details

    upctl database properties valkey show [flags]\n
    "},{"location":"commands_reference/upctl_database/properties/valkey/show/#examples","title":"Examples","text":"
    upctl database properties valkey show version\n
    "},{"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

    upctl database session cancel <UUID/Title...> [flags]\n
    "},{"location":"commands_reference/upctl_database/session/cancel/#examples","title":"Examples","text":"
    upctl database session cancel 0fa980c4-0e4f-460b-9869-11b7bd62b832 --pid 2345422\nupctl database session cancel mysql-1 --pid 2345422 --terminate\n
    "},{"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
    "},{"location":"commands_reference/upctl_database/session/list/#examples","title":"Examples","text":"
    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":"

    Delete a gateway

    upctl gateway delete <UUID/Title...> [flags]\n
    "},{"location":"commands_reference/upctl_gateway/delete/#examples","title":"Examples","text":"
    upctl gateway delete 8abc8009-4325-4b23-4321-b1232cd81231\nupctl gateway delete my-gateway\n
    "},{"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":"

    List gateways

    upctl gateway list [flags]\n
    "},{"location":"commands_reference/upctl_gateway/list/#examples","title":"Examples","text":"
    upctl gateway list\n
    "},{"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":"

    List gateway plans

    upctl gateway plans [flags]\n
    "},{"location":"commands_reference/upctl_gateway/plans/#examples","title":"Examples","text":"
    upctl gateway plans\n
    "},{"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":"

    List private cloud hosts

    upctl host list [flags]\n
    "},{"location":"commands_reference/upctl_host/list/#examples","title":"Examples","text":"
    upctl host list\n
    "},{"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":"

    Manage IP addresses

    upctl ip-address [flags]\n
    "},{"location":"commands_reference/upctl_ip-address/#aliases","title":"Aliases","text":"

    ip

    "},{"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":"

    Assign or create an IP address

    upctl ip-address assign [flags]\n
    "},{"location":"commands_reference/upctl_ip-address/assign/#examples","title":"Examples","text":"
    upctl ip-address assign --server 00038afc-d526-4148-af0e-d2f1eeaded9b\nupctl ip-address assign --server 00944977-89ce-4d10-89c3-bb5ba482e48d --family IPv6\nupctl ip-address assign --server 00944977-89ce-4d10-89c3-bb5ba482e48d --floating --zone pl-waw1\nupctl ip-address assign --server 00b78f8b-521d-4ffb-8baa-adf96c7b8f45 --floating --mac d6:0e:4a:6f:11:8f\n
    "},{"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":"

    List IP addresses

    upctl ip-address list [flags]\n
    "},{"location":"commands_reference/upctl_ip-address/list/#examples","title":"Examples","text":"
    upctl ip-address list\n
    "},{"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":"

    Modify an IP address

    upctl ip-address modify <Address/PTRRecord...> [flags]\n
    "},{"location":"commands_reference/upctl_ip-address/modify/#examples","title":"Examples","text":"
    upctl ip-address modify 185.70.196.225 --ptr-record myapp.com\nupctl ip-address modify 185.70.197.175 --mac d6:0e:4a:6f:2b:06\n
    "},{"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":"

    Remove an IP address

    upctl ip-address remove <Address/PTRRecord...> [flags]\n
    "},{"location":"commands_reference/upctl_ip-address/remove/#examples","title":"Examples","text":"
    upctl ip-address remove 185.70.197.44\nupctl ip-address remove 2a04:3544:8000:1000:d40e:4aff:fe6f:2c85\n
    "},{"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
    "},{"location":"commands_reference/upctl_ip-address/show/#examples","title":"Examples","text":"
    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":"

    Manage Kubernetes clusters

    upctl kubernetes [flags]\n
    "},{"location":"commands_reference/upctl_kubernetes/#aliases","title":"Aliases","text":"

    k8s, uks

    "},{"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":"

    Output Kubernetes cluster kubeconfig

    upctl kubernetes config <UUID/Name...> [flags]\n
    "},{"location":"commands_reference/upctl_kubernetes/config/#examples","title":"Examples","text":"
    upctl kubernetes config 0fa980c4-0e4f-460b-9869-11b7bd62b831 --output human\nupctl kubernetes config 0fa980c4-0e4f-460b-9869-11b7bd62b831 --output yaml --write $KUBECONFIG\nupctl kubernetes config 0fa980c4-0e4f-460b-9869-11b7bd62b831 --output yaml --write ./my_kubeconfig.yaml\n
    "},{"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":"

    Create a Kubernetes cluster

    upctl kubernetes create [flags]\n
    "},{"location":"commands_reference/upctl_kubernetes/create/#examples","title":"Examples","text":"
    upctl kubernetes create \\\n                --name my-cluster \\\n                --network 03e5ca07-f36c-4957-a676-e001e40441eb \\\n                --node-group count=2,name=my-minimal-node-group,plan=2xCPU-4GB, \\\n                --zone de-fra1\nupctl kubernetes create \\\n                --name my-cluster \\\n                --plan production-small \\\n                --network 03e5ca07-f36c-4957-a676-e001e40441eb \\\n                --node-group count=4,kubelet-arg=\"log-flush-frequency=5s\",label=\"owner=devteam\",label=\"env=dev\",name=my-node-group,plan=4xCPU-8GB,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\" \\\n                --zone de-fra1\n
    "},{"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":"

    Delete a Kubernetes cluster

    upctl kubernetes delete <UUID/Name...> [flags]\n
    "},{"location":"commands_reference/upctl_kubernetes/delete/#examples","title":"Examples","text":"
    upctl kubernetes delete 55199a44-4751-4e27-9394-7c7661910be3\nupctl kubernetes delete my-kubernetes-cluster\n
    "},{"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":"

    List current Kubernetes clusters

    upctl kubernetes list [flags]\n
    "},{"location":"commands_reference/upctl_kubernetes/list/#examples","title":"Examples","text":"
    upctl kubernetes list\n
    "},{"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":"

    Modify an existing cluster

    upctl kubernetes modify <UUID/Name...> [flags]\n
    "},{"location":"commands_reference/upctl_kubernetes/modify/#examples","title":"Examples","text":"
    upctl cluster modify 00bb4617-c592-4b32-b869-35a60b323b18 --plan 1xCPU-1GB\n
    "},{"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":"

    List available cluster plans

    upctl kubernetes plans [flags]\n
    "},{"location":"commands_reference/upctl_kubernetes/plans/#examples","title":"Examples","text":"
    upctl kubernetes plans\n
    "},{"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":"

    Show Kubernetes cluster details

    upctl kubernetes show <UUID/Name...> [flags]\n
    "},{"location":"commands_reference/upctl_kubernetes/show/#examples","title":"Examples","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":"

    List available versions for Kubernetes clusters

    upctl kubernetes versions [flags]\n
    "},{"location":"commands_reference/upctl_kubernetes/versions/#examples","title":"Examples","text":"
    upctl kubernetes versions\n
    "},{"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":"

    Manage cluster node-groups

    upctl kubernetes nodegroup [flags]\n
    "},{"location":"commands_reference/upctl_kubernetes/nodegroup/#aliases","title":"Aliases","text":"

    node-group

    "},{"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.

    upctl kubernetes nodegroup create <UUID/Name...> [flags]\n
    "},{"location":"commands_reference/upctl_kubernetes/nodegroup/create/#examples","title":"Examples","text":"
    upctl kubernetes nodegroup create 55199a44-4751-4e27-9394-7c7661910be3 --name secondary-node-group --count 3 --plan 2xCPU-4GB\n
    "},{"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":"

    Delete the node group from the cluster.

    upctl kubernetes nodegroup delete <UUID/Name...> [flags]\n
    "},{"location":"commands_reference/upctl_kubernetes/nodegroup/delete/#examples","title":"Examples","text":"
    upctl kubernetes nodegroup delete 55199a44-4751-4e27-9394-7c7661910be3 --name secondary-node-group\n
    "},{"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":"

    Scale the number of nodes in the node group.

    upctl kubernetes nodegroup scale <UUID/Name...> [flags]\n
    "},{"location":"commands_reference/upctl_kubernetes/nodegroup/scale/#examples","title":"Examples","text":"
    upctl kubernetes nodegroup scale 55199a44-4751-4e27-9394-7c7661910be3 --name secondary-node-group --count 3\n
    "},{"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
    "},{"location":"commands_reference/upctl_kubernetes/nodegroup/show/#examples","title":"Examples","text":"
    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":"

    Manage load balancers

    upctl loadbalancer [flags]\n
    "},{"location":"commands_reference/upctl_loadbalancer/#aliases","title":"Aliases","text":"

    lb

    "},{"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":"

    Delete a load balancer

    upctl loadbalancer delete <UUID/Name...> [flags]\n
    "},{"location":"commands_reference/upctl_loadbalancer/delete/#examples","title":"Examples","text":"
    upctl loadbalancer delete 55199a44-4751-4e27-9394-7c7661910be3\nupctl loadbalancer delete my-load-balancer\n
    "},{"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":"

    List current load balancers

    upctl loadbalancer list [flags]\n
    "},{"location":"commands_reference/upctl_loadbalancer/list/#examples","title":"Examples","text":"
    upctl loadbalancer list\n
    "},{"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":"

    List available load balancer plans

    upctl loadbalancer plans [flags]\n
    "},{"location":"commands_reference/upctl_loadbalancer/plans/#examples","title":"Examples","text":"
    upctl loadbalancer plans\n
    "},{"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":"

    Show load balancer details

    upctl loadbalancer show <UUID/Name...> [flags]\n
    "},{"location":"commands_reference/upctl_loadbalancer/show/#examples","title":"Examples","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":"

    Manage networks

    upctl network <UUID/Name...> [flags]\n
    "},{"location":"commands_reference/upctl_network/#aliases","title":"Aliases","text":"

    net

    "},{"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":"

    Create a network

    upctl network create [flags]\n
    "},{"location":"commands_reference/upctl_network/create/#examples","title":"Examples","text":"
    upctl network create --name \"My Network\" --zone pl-waw1 --ip-network address=10.0.1.0/24\nupctl network create --name my_net --zone pl-waw1 --ip-network address=10.0.2.0/24,dhcp=true\n
    "},{"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":"

    Delete a network

    upctl network delete <UUID/Name...> [flags]\n
    "},{"location":"commands_reference/upctl_network/delete/#examples","title":"Examples","text":"
    upctl network delete 037f260c-9568-4d9b-97e5-44cf52440ccb\nupctl network delete 03d7b5c2-b80a-4636-88d4-f9911185c975 0312a237-8204-4c1c-9fd1-2314013ec687\nupctl network delete \"My Network 1\"\n
    "},{"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":"

    List networks, by default private networks only

    upctl network list [flags]\n
    "},{"location":"commands_reference/upctl_network/list/#examples","title":"Examples","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":"

    Modify a network

    upctl network modify <UUID/Name...> [flags]\n
    "},{"location":"commands_reference/upctl_network/modify/#examples","title":"Examples","text":"
    upctl network modify 037a530b-533e-4cef-b6ad-6af8094bb2bc --ip-network dhcp=false,family=IPv4\nupctl network modify \"My Network\" --name \"My Super Network\"\n
    "},{"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":"

    Show network details

    upctl network show <UUID/Name...> [flags]\n
    "},{"location":"commands_reference/upctl_network/show/#examples","title":"Examples","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":"

    Delete a network peering

    upctl networkpeering delete <UUID/Title...> [flags]\n
    "},{"location":"commands_reference/upctl_networkpeering/delete/#examples","title":"Examples","text":"
    upctl networkpeering delete 8abc8009-4325-4b23-4321-b1232cd81231\nupctl networkpeering delete my-network-peering\n
    "},{"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":"

    Disable a network peering

    upctl networkpeering disable <UUID/Title...> [flags]\n
    "},{"location":"commands_reference/upctl_networkpeering/disable/#examples","title":"Examples","text":"
    upctl networkpeering disable 8abc8009-4325-4b23-4321-b1232cd81231\nupctl networkpeering disable my-network-peering\n
    "},{"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":"

    List network peerings

    upctl networkpeering list [flags]\n
    "},{"location":"commands_reference/upctl_networkpeering/list/#examples","title":"Examples","text":"
    upctl networkpeering list\n
    "},{"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":"

    Manage managed object storage services

    upctl objectstorage [flags]\n
    "},{"location":"commands_reference/upctl_objectstorage/#aliases","title":"Aliases","text":"

    object-storage, objsto

    "},{"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":"

    Delete a Managed object storage service

    upctl objectstorage delete <UUID/Title...> [flags]\n
    "},{"location":"commands_reference/upctl_objectstorage/delete/#examples","title":"Examples","text":"
    upctl objectstorage delete 55199a44-4751-4e27-9394-7c7661910be8\n
    "},{"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":"

    List current Managed object storage services

    upctl objectstorage list [flags]\n
    "},{"location":"commands_reference/upctl_objectstorage/list/#examples","title":"Examples","text":"
    upctl objectstorage list\n
    "},{"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":"

    List objectstorage regions

    upctl objectstorage regions [flags]\n
    "},{"location":"commands_reference/upctl_objectstorage/regions/#examples","title":"Examples","text":"
    upctl objectstorage regions\n
    "},{"location":"commands_reference/upctl_objectstorage/regions/#options","title":"Options","text":"Option Description --help, -h help for regionsDefault: false"},{"location":"commands_reference/upctl_objectstorage/regions/#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/regions/#related-commands","title":"Related commands","text":"Command Description upctl objectstorage Manage managed object storage services"},{"location":"commands_reference/upctl_objectstorage/show/","title":"upctl objectstorage show","text":"

    Show Managed object storage service details

    upctl objectstorage show <UUID/Title...> [flags]\n
    "},{"location":"commands_reference/upctl_objectstorage/show/#examples","title":"Examples","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 [flags]\n
    "},{"location":"commands_reference/upctl_partner/account/create/#examples","title":"Examples","text":"
    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":"

    List accounts associated with partner

    upctl partner account list [flags]\n
    "},{"location":"commands_reference/upctl_partner/account/list/#examples","title":"Examples","text":"
    upctl partner account list\n
    "},{"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":"

    Create a router

    upctl router create [flags]\n
    "},{"location":"commands_reference/upctl_router/create/#examples","title":"Examples","text":"
    upctl router create --name my_router\nupctl router create --name \"My Router\"\n
    "},{"location":"commands_reference/upctl_router/create/#options","title":"Options","text":"Option Description --name Router name. --help, -h help for createDefault: false"},{"location":"commands_reference/upctl_router/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_router/create/#related-commands","title":"Related commands","text":"Command Description upctl router Manage routers"},{"location":"commands_reference/upctl_router/delete/","title":"upctl router delete","text":"

    Delete a router

    upctl router delete <UUID/Name...> [flags]\n
    "},{"location":"commands_reference/upctl_router/delete/#examples","title":"Examples","text":"
    upctl router delete 0497728e-76ef-41d0-997f-fa9449eb71bc\nupctl router delete my_router\n
    "},{"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":"

    List routers

    upctl router list [flags]\n
    "},{"location":"commands_reference/upctl_router/list/#examples","title":"Examples","text":"
    upctl router list\nupctl router list --all\n
    "},{"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":"

    Modify a router

    upctl router modify <UUID/Name...> [flags]\n
    "},{"location":"commands_reference/upctl_router/modify/#examples","title":"Examples","text":"
    upctl router modify 04d031ab-4b85-4cbc-9f0e-6a2977541327 --name my_super_router\nupctl router modify \"My Router\" --name \"My Turbo Router\"\n
    "},{"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":"

    Show current router

    upctl router show <UUID/Name...> [flags]\n
    "},{"location":"commands_reference/upctl_router/show/#examples","title":"Examples","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.

    upctl server create [flags]\n
    "},{"location":"commands_reference/upctl_server/create/#examples","title":"Examples","text":"
    upctl server create --title myapp --zone fi-hel1 --hostname myapp --ssh-keys ~/.ssh/id_*.pub\nupctl server create --wait --title myapp --zone fi-hel1 --hostname myapp --ssh-keys ~/.ssh/id_*.pub\nupctl server create --title \"My Server\" --zone fi-hel1 --hostname myapp --ssh-keys ~/.ssh/id_*.pub\nupctl server create --zone fi-hel1 --hostname myapp --ssh-keys ~/.ssh/id_*.pub --plan 2xCPU-4GB\nupctl server create --zone fi-hel1 --hostname myapp --ssh-keys ~/.ssh/id_*.pub --plan custom --cores 2 --memory 4096\nupctl server create --zone fi-hel1 --hostname myapp --password-delivery email --os \"Debian GNU/Linux 10 (Buster)\" --server-group a4643646-8342-4324-4134-364138712378\nupctl server create --zone fi-hel1 --hostname myapp --ssh-keys ~/.ssh/id_*.pub --network type=private,network=037a530b-533e-4cef-b6ad-6af8094bb2bc,ip-address=10.0.0.1\n
    "},{"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
    "},{"location":"commands_reference/upctl_server/delete/#examples","title":"Examples","text":"
    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/#examples","title":"Examples","text":"
    upctl server eject my_server\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":"

    List current servers

    upctl server list [flags]\n
    "},{"location":"commands_reference/upctl_server/list/#examples","title":"Examples","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
    "},{"location":"commands_reference/upctl_server/load/#examples","title":"Examples","text":"
    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
    "},{"location":"commands_reference/upctl_server/modify/#examples","title":"Examples","text":"
    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":"

    List server plans

    upctl server plans [flags]\n
    "},{"location":"commands_reference/upctl_server/plans/#examples","title":"Examples","text":"
    upctl server plans\n
    "},{"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
    "},{"location":"commands_reference/upctl_server/restart/#examples","title":"Examples","text":"
    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
    "},{"location":"commands_reference/upctl_server/show/#examples","title":"Examples","text":"
    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
    "},{"location":"commands_reference/upctl_server/start/#examples","title":"Examples","text":"
    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
    "},{"location":"commands_reference/upctl_server/stop/#examples","title":"Examples","text":"
    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
    "},{"location":"commands_reference/upctl_server/firewall/create/#examples","title":"Examples","text":"
    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
    "},{"location":"commands_reference/upctl_server/firewall/delete/#examples","title":"Examples","text":"
    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
    "},{"location":"commands_reference/upctl_server/firewall/show/#examples","title":"Examples","text":"
    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
    "},{"location":"commands_reference/upctl_server/network-interface/create/#examples","title":"Examples","text":"
    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
    "},{"location":"commands_reference/upctl_server/network-interface/delete/#examples","title":"Examples","text":"
    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
    "},{"location":"commands_reference/upctl_server/network-interface/modify/#examples","title":"Examples","text":"
    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
    "},{"location":"commands_reference/upctl_server/storage/attach/#examples","title":"Examples","text":"
    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
    "},{"location":"commands_reference/upctl_server/storage/detach/#examples","title":"Examples","text":"
    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":"

    Create a server group

    upctl servergroup create [flags]\n
    "},{"location":"commands_reference/upctl_servergroup/create/#examples","title":"Examples","text":"
    upctl servergroup create \\\n                --title my-server-group \\\n                --anti-affinity-policy yes \\\n                --server 1fdfda29-ead1-4855-b71f-a432179800ab \\\n                --server my-server\nupctl servergroup create \\\n                --title my-server-group \\\n                --anti-affinity-policy yes \\\n                --label env=dev\nupctl servergroup create \\\n                --title my-server-group \\\n                --anti-affinity-policy strict \\\n                --label env=dev \\\n                --label owner=operations\n
    "},{"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":"

    Delete a server group

    upctl servergroup delete <UUID/Title...> [flags]\n
    "},{"location":"commands_reference/upctl_servergroup/delete/#examples","title":"Examples","text":"
    upctl servergroup delete 8abc8009-4325-4b23-4321-b1232cd81231\nupctl servergroup delete my-server-group\n
    "},{"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":"

    List current server groups

    upctl servergroup list [flags]\n
    "},{"location":"commands_reference/upctl_servergroup/list/#examples","title":"Examples","text":"
    upctl servergroup list\n
    "},{"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":"

    Modify a server group

    upctl servergroup modify <UUID/Title...> [flags]\n
    "},{"location":"commands_reference/upctl_servergroup/modify/#examples","title":"Examples","text":"
    upctl servergroup modify 8abc8009-4325-4b23-4321-b1232cd81231 --title your-server-group\nupctl servergroup modify my-server-group --anti-affinity-policy strict\nupctl servergroup modify my-server-group --server my-server-1 --server my-server-2 --server my-server-3-\nupctl servergroup modify 8abc8009-4325-4b23-4321-b1232cd81231 --server 0bab98e5-b327-4ab8-ba16-738d4af7578b --server my-server-2\nupctl servergroup modify my-server-group --label env=dev\n
    "},{"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":"

    Show server group details

    upctl servergroup show <UUID/Title...> [flags]\n
    "},{"location":"commands_reference/upctl_servergroup/show/#examples","title":"Examples","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":"

    Clone a storage

    upctl storage clone <UUID/Title...> [flags]\n
    "},{"location":"commands_reference/upctl_storage/clone/#examples","title":"Examples","text":"
    upctl storage clone 015899e0-0a68-4949-85bb-261a99de5fdd --title my_storage_clone --zone fi-hel1\nupctl storage clone 015899e0-0a68-4949-85bb-261a99de5fdd --title my_storage_clone2 --zone pl-waw1  --tier maxiops\nupctl storage clone \"My Storage\" --title my_storage_clone3 --zone pl-waw1  --tier maxiops\n
    "},{"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":"

    Create a storage

    upctl storage create [flags]\n
    "},{"location":"commands_reference/upctl_storage/create/#examples","title":"Examples","text":"
    upctl storage create --zone pl-waw1 --title \"Default Size\"\nupctl storage create --zone pl-waw1 --title with_backups --size 20 --backup-interval wed --backup-retention 4\nupctl storage create --zone pl-waw1 --title standard-tier --size 3 --tier standard\n
    "},{"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":"

    Delete a storage

    upctl storage delete <UUID/Title...> [flags]\n
    "},{"location":"commands_reference/upctl_storage/delete/#examples","title":"Examples","text":"
    upctl storage delete 01ac5319-08ac-4e7b-81e5-3140d2bbd7d8\nupctl storage delete 0175bb34-8aed-47ce-9290-10cc45f78601 01fcb78f-e73d-4e4d-af5a-0bd6cdba4306\nupctl storage delete \"My Storage\"\n
    "},{"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":"

    Import a storage from external or local source

    upctl storage import [flags]\n
    "},{"location":"commands_reference/upctl_storage/import/#examples","title":"Examples","text":"
    upctl storage import --source-location https://cdimage.debian.org/debian-cd/current/amd64/iso-cd/debian-10.9.0-amd64-netinst.iso --title my_storage --zone es-mad1\n
    "},{"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":"

    List current storages

    upctl storage list [flags]\n
    "},{"location":"commands_reference/upctl_storage/list/#examples","title":"Examples","text":"
    upctl storage list\nupctl storage list --all\n
    "},{"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":"

    Modify a storage

    upctl storage modify <UUID/Title...> [flags]\n
    "},{"location":"commands_reference/upctl_storage/modify/#examples","title":"Examples","text":"
    upctl storage modify 01271548-2e92-44bb-9774-d282508cc762 --title \"My Storage\" --size 20\nupctl storage modify \"My Storage\" --size 25\n
    "},{"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":"

    Show storage details

    upctl storage show <UUID/Title...> [flags]\n
    "},{"location":"commands_reference/upctl_storage/show/#examples","title":"Examples","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":"

    Templatise a storage

    upctl storage templatise <UUID/Title...> [flags]\n
    "},{"location":"commands_reference/upctl_storage/templatise/#examples","title":"Examples","text":"
    upctl storage templatise 01271548-2e92-44bb-9774-d282508cc762 --title \"My Template\"\nupctl storage templatise 01271548-2e92-44bb-9774-d282508cc762 --title \"My Template\" --wait\nupctl storage templatise \"My Storage\" --title super_template\n
    "},{"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":"

    Create backup of a storage

    upctl storage backup create <UUID/Title...> [flags]\n
    "},{"location":"commands_reference/upctl_storage/backup/create/#examples","title":"Examples","text":"
    upctl storage backup create 01cbea5e-eb5b-4072-b2ac-9b635120e5d8 --title \"first backup\"\nupctl storage backup create \"My Storage\" --title second_backup\n
    "},{"location":"commands_reference/upctl_storage/backup/create/#options","title":"Options","text":"Option Description --title A short, informational description. --help, -h help for createDefault: false"},{"location":"commands_reference/upctl_storage/backup/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/backup/create/#related-commands","title":"Related commands","text":"Command Description upctl storage backup Manage backups"},{"location":"commands_reference/upctl_storage/backup/restore/","title":"upctl storage backup restore","text":"

    Restore backup of a storage

    upctl storage backup restore <UUID/Title...> [flags]\n
    "},{"location":"commands_reference/upctl_storage/backup/restore/#examples","title":"Examples","text":"
    upctl storage backup restore 01177c9e-7f76-4ce4-b128-bcaa3448f7ec\nupctl storage backup restore second_backup\n
    "},{"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":"

    List available zones

    upctl zone list [flags]\n
    "},{"location":"commands_reference/upctl_zone/list/#examples","title":"Examples","text":"
    upctl zone list\n
    "},{"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.

    "},{"location":"examples/#testing","title":"Testing","text":"

    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

    Now we are ready for creating the template.

    upctl storage templatise ${prefix}source-server-OS \\\n    --title ${prefix}template \\\n    --wait\n

    Once the template is created, we can delete the source server

    upctl server delete ${prefix}source-server --delete-storages\n

    To test that the template creation succeeded, create a new server from the just created template.

    upctl server create \\\n    --hostname ${prefix}server \\\n    --zone pl-waw1 \\\n    --network type=public \\\n    --network type=utility \\\n    --os ${prefix}template \\\n    --wait\n

    Finally, we can cleanup the created resources.

    upctl server stop --type hard --wait ${prefix}server\nupctl server delete ${prefix}server --delete-storages\nupctl storage delete ${prefix}template\n
    "},{"location":"examples/create_and_restore_backup/","title":"Backup a server and re-create it using the backup","text":"

    This example demonstrates how to backup a server with upctl and use the created backup to re-create the server.

    To keep track of resources created during this example, we will use common prefix in all resource names.

    prefix=example-upctl-backup-\n

    We will first create a ssh-key into the current working directory for configuring an nginx server via SSH connection.

    ssh-keygen -t ed25519 -q -f \"./id_ed25519\" -N \"\" -C \"upctl example\"\n

    We will then create a server with a single network interface and default template settings.

    upctl server create \\\n    --hostname ${prefix}source-server \\\n    --zone pl-waw1 \\\n    --ssh-keys ./id_ed25519.pub \\\n    --network type=public \\\n    --wait\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.

    upctl storage backup create ${prefix}source-server-OS --title ${prefix}source-server-backup\n

    After creating the backup, we can delete the source server and its storages.

    upctl server stop --type hard --wait ${prefix}source-server\nupctl server delete ${prefix}source-server --delete-storages\n

    We can then create a new server based on the backup of the source servers disk.

    upctl server create \\\n    --hostname ${prefix}restored-server \\\n    --zone pl-waw1 \\\n    --ssh-keys ./id_ed25519.pub \\\n    --network type=public \\\n    --storage action=clone,storage=${prefix}source-server-backup \\\n    --wait\n

    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.

    upctl server create \\\n    --hostname ${prefix}server \\\n    --zone pl-waw1 \\\n    --ssh-keys ./id_ed25519.pub \\\n    --network type=public \\\n    --network type=utility \\\n    --wait\n

    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
    "},{"location":"examples/possible_exit_codes/","title":"Possible exit codes","text":"

    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 diff --git a/sitemap.xml b/sitemap.xml index 04915c3c..2e9e9e11 100644 --- a/sitemap.xml +++ b/sitemap.xml @@ -2,550 +2,558 @@ https://upcloudltd.github.io/upcloud-cli/ - 2025-01-08 + 2025-01-10 https://upcloudltd.github.io/upcloud-cli/changelog/ - 2025-01-08 + 2025-01-10 https://upcloudltd.github.io/upcloud-cli/commands_reference/upctl/ - 2025-01-08 + 2025-01-10 https://upcloudltd.github.io/upcloud-cli/commands_reference/upctl_version/ - 2025-01-08 + 2025-01-10 https://upcloudltd.github.io/upcloud-cli/commands_reference/upctl_account/ - 2025-01-08 + 2025-01-10 https://upcloudltd.github.io/upcloud-cli/commands_reference/upctl_account/delete/ - 2025-01-08 + 2025-01-10 https://upcloudltd.github.io/upcloud-cli/commands_reference/upctl_account/list/ - 2025-01-08 + 2025-01-10 https://upcloudltd.github.io/upcloud-cli/commands_reference/upctl_account/show/ - 2025-01-08 + 2025-01-10 https://upcloudltd.github.io/upcloud-cli/commands_reference/upctl_account/permissions/ - 2025-01-08 + 2025-01-10 https://upcloudltd.github.io/upcloud-cli/commands_reference/upctl_account/permissions/list/ - 2025-01-08 + 2025-01-10 https://upcloudltd.github.io/upcloud-cli/commands_reference/upctl_database/ - 2025-01-08 + 2025-01-10 https://upcloudltd.github.io/upcloud-cli/commands_reference/upctl_database/delete/ - 2025-01-08 + 2025-01-10 https://upcloudltd.github.io/upcloud-cli/commands_reference/upctl_database/list/ - 2025-01-08 + 2025-01-10 https://upcloudltd.github.io/upcloud-cli/commands_reference/upctl_database/plans/ - 2025-01-08 + 2025-01-10 https://upcloudltd.github.io/upcloud-cli/commands_reference/upctl_database/show/ - 2025-01-08 + 2025-01-10 https://upcloudltd.github.io/upcloud-cli/commands_reference/upctl_database/start/ - 2025-01-08 + 2025-01-10 https://upcloudltd.github.io/upcloud-cli/commands_reference/upctl_database/stop/ - 2025-01-08 + 2025-01-10 https://upcloudltd.github.io/upcloud-cli/commands_reference/upctl_database/types/ - 2025-01-08 + 2025-01-10 https://upcloudltd.github.io/upcloud-cli/commands_reference/upctl_database/index/ - 2025-01-08 + 2025-01-10 https://upcloudltd.github.io/upcloud-cli/commands_reference/upctl_database/index/delete/ - 2025-01-08 + 2025-01-10 https://upcloudltd.github.io/upcloud-cli/commands_reference/upctl_database/index/list/ - 2025-01-08 + 2025-01-10 https://upcloudltd.github.io/upcloud-cli/commands_reference/upctl_database/properties/ - 2025-01-08 + 2025-01-10 https://upcloudltd.github.io/upcloud-cli/commands_reference/upctl_database/properties/mysql/ - 2025-01-08 + 2025-01-10 https://upcloudltd.github.io/upcloud-cli/commands_reference/upctl_database/properties/mysql/show/ - 2025-01-08 + 2025-01-10 https://upcloudltd.github.io/upcloud-cli/commands_reference/upctl_database/properties/opensearch/ - 2025-01-08 + 2025-01-10 https://upcloudltd.github.io/upcloud-cli/commands_reference/upctl_database/properties/opensearch/show/ - 2025-01-08 + 2025-01-10 https://upcloudltd.github.io/upcloud-cli/commands_reference/upctl_database/properties/pg/ - 2025-01-08 + 2025-01-10 https://upcloudltd.github.io/upcloud-cli/commands_reference/upctl_database/properties/pg/show/ - 2025-01-08 + 2025-01-10 https://upcloudltd.github.io/upcloud-cli/commands_reference/upctl_database/properties/redis/ - 2025-01-08 + 2025-01-10 https://upcloudltd.github.io/upcloud-cli/commands_reference/upctl_database/properties/redis/show/ - 2025-01-08 + 2025-01-10 + + + https://upcloudltd.github.io/upcloud-cli/commands_reference/upctl_database/properties/valkey/ + 2025-01-10 + + + https://upcloudltd.github.io/upcloud-cli/commands_reference/upctl_database/properties/valkey/show/ + 2025-01-10 https://upcloudltd.github.io/upcloud-cli/commands_reference/upctl_database/session/ - 2025-01-08 + 2025-01-10 https://upcloudltd.github.io/upcloud-cli/commands_reference/upctl_database/session/cancel/ - 2025-01-08 + 2025-01-10 https://upcloudltd.github.io/upcloud-cli/commands_reference/upctl_database/session/list/ - 2025-01-08 + 2025-01-10 https://upcloudltd.github.io/upcloud-cli/commands_reference/upctl_gateway/ - 2025-01-08 + 2025-01-10 https://upcloudltd.github.io/upcloud-cli/commands_reference/upctl_gateway/delete/ - 2025-01-08 + 2025-01-10 https://upcloudltd.github.io/upcloud-cli/commands_reference/upctl_gateway/list/ - 2025-01-08 + 2025-01-10 https://upcloudltd.github.io/upcloud-cli/commands_reference/upctl_gateway/plans/ - 2025-01-08 + 2025-01-10 https://upcloudltd.github.io/upcloud-cli/commands_reference/upctl_host/ - 2025-01-08 + 2025-01-10 https://upcloudltd.github.io/upcloud-cli/commands_reference/upctl_host/list/ - 2025-01-08 + 2025-01-10 https://upcloudltd.github.io/upcloud-cli/commands_reference/upctl_ip-address/ - 2025-01-08 + 2025-01-10 https://upcloudltd.github.io/upcloud-cli/commands_reference/upctl_ip-address/assign/ - 2025-01-08 + 2025-01-10 https://upcloudltd.github.io/upcloud-cli/commands_reference/upctl_ip-address/list/ - 2025-01-08 + 2025-01-10 https://upcloudltd.github.io/upcloud-cli/commands_reference/upctl_ip-address/modify/ - 2025-01-08 + 2025-01-10 https://upcloudltd.github.io/upcloud-cli/commands_reference/upctl_ip-address/remove/ - 2025-01-08 + 2025-01-10 https://upcloudltd.github.io/upcloud-cli/commands_reference/upctl_ip-address/show/ - 2025-01-08 + 2025-01-10 https://upcloudltd.github.io/upcloud-cli/commands_reference/upctl_kubernetes/ - 2025-01-08 + 2025-01-10 https://upcloudltd.github.io/upcloud-cli/commands_reference/upctl_kubernetes/config/ - 2025-01-08 + 2025-01-10 https://upcloudltd.github.io/upcloud-cli/commands_reference/upctl_kubernetes/create/ - 2025-01-08 + 2025-01-10 https://upcloudltd.github.io/upcloud-cli/commands_reference/upctl_kubernetes/delete/ - 2025-01-08 + 2025-01-10 https://upcloudltd.github.io/upcloud-cli/commands_reference/upctl_kubernetes/list/ - 2025-01-08 + 2025-01-10 https://upcloudltd.github.io/upcloud-cli/commands_reference/upctl_kubernetes/modify/ - 2025-01-08 + 2025-01-10 https://upcloudltd.github.io/upcloud-cli/commands_reference/upctl_kubernetes/plans/ - 2025-01-08 + 2025-01-10 https://upcloudltd.github.io/upcloud-cli/commands_reference/upctl_kubernetes/show/ - 2025-01-08 + 2025-01-10 https://upcloudltd.github.io/upcloud-cli/commands_reference/upctl_kubernetes/versions/ - 2025-01-08 + 2025-01-10 https://upcloudltd.github.io/upcloud-cli/commands_reference/upctl_kubernetes/nodegroup/ - 2025-01-08 + 2025-01-10 https://upcloudltd.github.io/upcloud-cli/commands_reference/upctl_kubernetes/nodegroup/create/ - 2025-01-08 + 2025-01-10 https://upcloudltd.github.io/upcloud-cli/commands_reference/upctl_kubernetes/nodegroup/delete/ - 2025-01-08 + 2025-01-10 https://upcloudltd.github.io/upcloud-cli/commands_reference/upctl_kubernetes/nodegroup/scale/ - 2025-01-08 + 2025-01-10 https://upcloudltd.github.io/upcloud-cli/commands_reference/upctl_kubernetes/nodegroup/show/ - 2025-01-08 + 2025-01-10 https://upcloudltd.github.io/upcloud-cli/commands_reference/upctl_loadbalancer/ - 2025-01-08 + 2025-01-10 https://upcloudltd.github.io/upcloud-cli/commands_reference/upctl_loadbalancer/delete/ - 2025-01-08 + 2025-01-10 https://upcloudltd.github.io/upcloud-cli/commands_reference/upctl_loadbalancer/list/ - 2025-01-08 + 2025-01-10 https://upcloudltd.github.io/upcloud-cli/commands_reference/upctl_loadbalancer/plans/ - 2025-01-08 + 2025-01-10 https://upcloudltd.github.io/upcloud-cli/commands_reference/upctl_loadbalancer/show/ - 2025-01-08 + 2025-01-10 https://upcloudltd.github.io/upcloud-cli/commands_reference/upctl_network/ - 2025-01-08 + 2025-01-10 https://upcloudltd.github.io/upcloud-cli/commands_reference/upctl_network/create/ - 2025-01-08 + 2025-01-10 https://upcloudltd.github.io/upcloud-cli/commands_reference/upctl_network/delete/ - 2025-01-08 + 2025-01-10 https://upcloudltd.github.io/upcloud-cli/commands_reference/upctl_network/list/ - 2025-01-08 + 2025-01-10 https://upcloudltd.github.io/upcloud-cli/commands_reference/upctl_network/modify/ - 2025-01-08 + 2025-01-10 https://upcloudltd.github.io/upcloud-cli/commands_reference/upctl_network/show/ - 2025-01-08 + 2025-01-10 https://upcloudltd.github.io/upcloud-cli/commands_reference/upctl_networkpeering/ - 2025-01-08 + 2025-01-10 https://upcloudltd.github.io/upcloud-cli/commands_reference/upctl_networkpeering/delete/ - 2025-01-08 + 2025-01-10 https://upcloudltd.github.io/upcloud-cli/commands_reference/upctl_networkpeering/disable/ - 2025-01-08 + 2025-01-10 https://upcloudltd.github.io/upcloud-cli/commands_reference/upctl_networkpeering/list/ - 2025-01-08 + 2025-01-10 https://upcloudltd.github.io/upcloud-cli/commands_reference/upctl_objectstorage/ - 2025-01-08 + 2025-01-10 https://upcloudltd.github.io/upcloud-cli/commands_reference/upctl_objectstorage/delete/ - 2025-01-08 + 2025-01-10 https://upcloudltd.github.io/upcloud-cli/commands_reference/upctl_objectstorage/list/ - 2025-01-08 + 2025-01-10 https://upcloudltd.github.io/upcloud-cli/commands_reference/upctl_objectstorage/regions/ - 2025-01-08 + 2025-01-10 https://upcloudltd.github.io/upcloud-cli/commands_reference/upctl_objectstorage/show/ - 2025-01-08 + 2025-01-10 https://upcloudltd.github.io/upcloud-cli/commands_reference/upctl_partner/ - 2025-01-08 + 2025-01-10 https://upcloudltd.github.io/upcloud-cli/commands_reference/upctl_partner/account/ - 2025-01-08 + 2025-01-10 https://upcloudltd.github.io/upcloud-cli/commands_reference/upctl_partner/account/create/ - 2025-01-08 + 2025-01-10 https://upcloudltd.github.io/upcloud-cli/commands_reference/upctl_partner/account/list/ - 2025-01-08 + 2025-01-10 https://upcloudltd.github.io/upcloud-cli/commands_reference/upctl_router/ - 2025-01-08 + 2025-01-10 https://upcloudltd.github.io/upcloud-cli/commands_reference/upctl_router/create/ - 2025-01-08 + 2025-01-10 https://upcloudltd.github.io/upcloud-cli/commands_reference/upctl_router/delete/ - 2025-01-08 + 2025-01-10 https://upcloudltd.github.io/upcloud-cli/commands_reference/upctl_router/list/ - 2025-01-08 + 2025-01-10 https://upcloudltd.github.io/upcloud-cli/commands_reference/upctl_router/modify/ - 2025-01-08 + 2025-01-10 https://upcloudltd.github.io/upcloud-cli/commands_reference/upctl_router/show/ - 2025-01-08 + 2025-01-10 https://upcloudltd.github.io/upcloud-cli/commands_reference/upctl_server/ - 2025-01-08 + 2025-01-10 https://upcloudltd.github.io/upcloud-cli/commands_reference/upctl_server/create/ - 2025-01-08 + 2025-01-10 https://upcloudltd.github.io/upcloud-cli/commands_reference/upctl_server/delete/ - 2025-01-08 + 2025-01-10 https://upcloudltd.github.io/upcloud-cli/commands_reference/upctl_server/eject/ - 2025-01-08 + 2025-01-10 https://upcloudltd.github.io/upcloud-cli/commands_reference/upctl_server/list/ - 2025-01-08 + 2025-01-10 https://upcloudltd.github.io/upcloud-cli/commands_reference/upctl_server/load/ - 2025-01-08 + 2025-01-10 https://upcloudltd.github.io/upcloud-cli/commands_reference/upctl_server/modify/ - 2025-01-08 + 2025-01-10 https://upcloudltd.github.io/upcloud-cli/commands_reference/upctl_server/plans/ - 2025-01-08 + 2025-01-10 https://upcloudltd.github.io/upcloud-cli/commands_reference/upctl_server/restart/ - 2025-01-08 + 2025-01-10 https://upcloudltd.github.io/upcloud-cli/commands_reference/upctl_server/show/ - 2025-01-08 + 2025-01-10 https://upcloudltd.github.io/upcloud-cli/commands_reference/upctl_server/start/ - 2025-01-08 + 2025-01-10 https://upcloudltd.github.io/upcloud-cli/commands_reference/upctl_server/stop/ - 2025-01-08 + 2025-01-10 https://upcloudltd.github.io/upcloud-cli/commands_reference/upctl_server/firewall/ - 2025-01-08 + 2025-01-10 https://upcloudltd.github.io/upcloud-cli/commands_reference/upctl_server/firewall/create/ - 2025-01-08 + 2025-01-10 https://upcloudltd.github.io/upcloud-cli/commands_reference/upctl_server/firewall/delete/ - 2025-01-08 + 2025-01-10 https://upcloudltd.github.io/upcloud-cli/commands_reference/upctl_server/firewall/show/ - 2025-01-08 + 2025-01-10 https://upcloudltd.github.io/upcloud-cli/commands_reference/upctl_server/network-interface/ - 2025-01-08 + 2025-01-10 https://upcloudltd.github.io/upcloud-cli/commands_reference/upctl_server/network-interface/create/ - 2025-01-08 + 2025-01-10 https://upcloudltd.github.io/upcloud-cli/commands_reference/upctl_server/network-interface/delete/ - 2025-01-08 + 2025-01-10 https://upcloudltd.github.io/upcloud-cli/commands_reference/upctl_server/network-interface/modify/ - 2025-01-08 + 2025-01-10 https://upcloudltd.github.io/upcloud-cli/commands_reference/upctl_server/storage/ - 2025-01-08 + 2025-01-10 https://upcloudltd.github.io/upcloud-cli/commands_reference/upctl_server/storage/attach/ - 2025-01-08 + 2025-01-10 https://upcloudltd.github.io/upcloud-cli/commands_reference/upctl_server/storage/detach/ - 2025-01-08 + 2025-01-10 https://upcloudltd.github.io/upcloud-cli/commands_reference/upctl_servergroup/ - 2025-01-08 + 2025-01-10 https://upcloudltd.github.io/upcloud-cli/commands_reference/upctl_servergroup/create/ - 2025-01-08 + 2025-01-10 https://upcloudltd.github.io/upcloud-cli/commands_reference/upctl_servergroup/delete/ - 2025-01-08 + 2025-01-10 https://upcloudltd.github.io/upcloud-cli/commands_reference/upctl_servergroup/list/ - 2025-01-08 + 2025-01-10 https://upcloudltd.github.io/upcloud-cli/commands_reference/upctl_servergroup/modify/ - 2025-01-08 + 2025-01-10 https://upcloudltd.github.io/upcloud-cli/commands_reference/upctl_servergroup/show/ - 2025-01-08 + 2025-01-10 https://upcloudltd.github.io/upcloud-cli/commands_reference/upctl_storage/ - 2025-01-08 + 2025-01-10 https://upcloudltd.github.io/upcloud-cli/commands_reference/upctl_storage/clone/ - 2025-01-08 + 2025-01-10 https://upcloudltd.github.io/upcloud-cli/commands_reference/upctl_storage/create/ - 2025-01-08 + 2025-01-10 https://upcloudltd.github.io/upcloud-cli/commands_reference/upctl_storage/delete/ - 2025-01-08 + 2025-01-10 https://upcloudltd.github.io/upcloud-cli/commands_reference/upctl_storage/import/ - 2025-01-08 + 2025-01-10 https://upcloudltd.github.io/upcloud-cli/commands_reference/upctl_storage/list/ - 2025-01-08 + 2025-01-10 https://upcloudltd.github.io/upcloud-cli/commands_reference/upctl_storage/modify/ - 2025-01-08 + 2025-01-10 https://upcloudltd.github.io/upcloud-cli/commands_reference/upctl_storage/show/ - 2025-01-08 + 2025-01-10 https://upcloudltd.github.io/upcloud-cli/commands_reference/upctl_storage/templatise/ - 2025-01-08 + 2025-01-10 https://upcloudltd.github.io/upcloud-cli/commands_reference/upctl_storage/backup/ - 2025-01-08 + 2025-01-10 https://upcloudltd.github.io/upcloud-cli/commands_reference/upctl_storage/backup/create/ - 2025-01-08 + 2025-01-10 https://upcloudltd.github.io/upcloud-cli/commands_reference/upctl_storage/backup/restore/ - 2025-01-08 + 2025-01-10 https://upcloudltd.github.io/upcloud-cli/commands_reference/upctl_zone/ - 2025-01-08 + 2025-01-10 https://upcloudltd.github.io/upcloud-cli/commands_reference/upctl_zone/list/ - 2025-01-08 + 2025-01-10 https://upcloudltd.github.io/upcloud-cli/examples/ - 2025-01-08 + 2025-01-10 https://upcloudltd.github.io/upcloud-cli/examples/create_a_custom_template/ - 2025-01-08 + 2025-01-10 https://upcloudltd.github.io/upcloud-cli/examples/create_and_restore_backup/ - 2025-01-08 + 2025-01-10 https://upcloudltd.github.io/upcloud-cli/examples/create_and_ssh_into_a_server/ - 2025-01-08 + 2025-01-10 https://upcloudltd.github.io/upcloud-cli/examples/possible_exit_codes/ - 2025-01-08 + 2025-01-10 \ No newline at end of file diff --git a/sitemap.xml.gz b/sitemap.xml.gz index 0f997f61..2d83a222 100644 Binary files a/sitemap.xml.gz and b/sitemap.xml.gz differ