diff --git a/404.html b/404.html index 711123bd2..62ea50f85 100644 --- a/404.html +++ b/404.html @@ -2626,6 +2626,82 @@ + +
  • + + + + + + + + + + +
    • + + + + + + + + + +
  • Changelog diff --git a/changelog/index.html b/changelog/index.html index 88c4c50c4..cb2a5e94e 100644 --- a/changelog/index.html +++ b/changelog/index.html @@ -2632,6 +2632,82 @@ + + +
  • + + + + + + + + + + +
    • + + + + + + + + + @@ -3165,17 +3241,16 @@

    Fixed

    2.9.1 - 2023-07-06

    Changed

    2.9.0 - 2023-06-30

    Added

    diff --git a/commands_reference/upctl/index.html b/commands_reference/upctl/index.html index 12ae11368..88aff8808 100644 --- a/commands_reference/upctl/index.html +++ b/commands_reference/upctl/index.html @@ -2681,6 +2681,82 @@ + +
  • + + + + + + + + + + +
    • + + + + + + + + + +
  • Changelog diff --git a/commands_reference/upctl_account/index.html b/commands_reference/upctl_account/index.html index cde0210fc..db2f5d12b 100644 --- a/commands_reference/upctl_account/index.html +++ b/commands_reference/upctl_account/index.html @@ -2689,6 +2689,82 @@ + +
  • + + + + + + + + + + +
    • + + + + + + + + + +
  • Changelog @@ -2758,8 +2834,8 @@

    upctl account

    Manage accounts

    -
    upctl account [flags]
-
    +
    upctl account [flags]
+

    Options

    diff --git a/commands_reference/upctl_account/show/index.html b/commands_reference/upctl_account/show/index.html index bfa7a71ea..d9f5d1043 100644 --- a/commands_reference/upctl_account/show/index.html +++ b/commands_reference/upctl_account/show/index.html @@ -2695,6 +2695,82 @@ + +
  • + + + + + + + + + + +
    • + + + + + + + + + +
  • Changelog @@ -2770,11 +2846,11 @@

    upctl account show

    Show account

    -
    upctl account show [flags]
-
    +
    upctl account show [flags]
+

    Examples

    -
    upctl account show
-
    +
    upctl account show
+

    Options

    • diff --git a/commands_reference/upctl_database/delete/index.html b/commands_reference/upctl_database/delete/index.html index c6dbba683..d33d4843c 100644 --- a/commands_reference/upctl_database/delete/index.html +++ b/commands_reference/upctl_database/delete/index.html @@ -2695,6 +2695,82 @@ + +
  • + + + + + + + + + + +
    • + + + + + + + + + +
  • Changelog @@ -2770,12 +2846,12 @@

    upctl database delete

    Delete a database

    -
    upctl database delete <UUID/Title...> [flags]
-
    +
    upctl database delete <UUID/Title...> [flags]
+

    Examples

    -
    upctl database delete 0497728e-76ef-41d0-997f-fa9449eb71bc
-upctl database delete my_database
-
    +
    upctl database delete 0497728e-76ef-41d0-997f-fa9449eb71bc
+upctl database delete my_database
+

    Options

    • diff --git a/commands_reference/upctl_database/index.html b/commands_reference/upctl_database/index.html index d624a1928..51ab285e1 100644 --- a/commands_reference/upctl_database/index.html +++ b/commands_reference/upctl_database/index.html @@ -2695,6 +2695,82 @@ + +
  • + + + + + + + + + + +
    • + + + + + + + + + +
  • Changelog @@ -2770,8 +2846,8 @@

    upctl database

    Manage databases

    -
    upctl database [flags]
-
    +
    upctl database [flags]
+

    Aliases

    db

    Options

    diff --git a/commands_reference/upctl_database/index/delete/index.html b/commands_reference/upctl_database/index/delete/index.html index 34839d8e6..9eaffd744 100644 --- a/commands_reference/upctl_database/index/delete/index.html +++ b/commands_reference/upctl_database/index/delete/index.html @@ -2697,6 +2697,82 @@ + +
  • + + + + + + + + + + +
    • + + + + + + + + + +
  • Changelog @@ -2772,11 +2848,11 @@

    upctl database index delete

    Delete an index from the specified database.

    -
    upctl database index delete <UUID/Title...> [flags]
-
    +
    upctl database index delete <UUID/Title...> [flags]
+

    Examples

    -
    upctl database index delete 55199a44-4751-4e27-9394-7c7661910be3 --name .index-to-delete
-
    +
    upctl database index delete 55199a44-4751-4e27-9394-7c7661910be3 --name .index-to-delete
+

    Options

    • diff --git a/commands_reference/upctl_database/index/index.html b/commands_reference/upctl_database/index/index.html index 7603e6b19..3cf6d8874 100644 --- a/commands_reference/upctl_database/index/index.html +++ b/commands_reference/upctl_database/index/index.html @@ -2697,6 +2697,82 @@ + +
  • + + + + + + + + + + +
    • + + + + + + + + + +
  • Changelog @@ -2772,8 +2848,8 @@

    upctl database index

    Manage database indices

    -
    upctl database index [flags]
-
    +
    upctl database index [flags]
+

    Aliases

    indices

    Options

    diff --git a/commands_reference/upctl_database/index/list/index.html b/commands_reference/upctl_database/index/list/index.html index 2559e5fb4..f51d19147 100644 --- a/commands_reference/upctl_database/index/list/index.html +++ b/commands_reference/upctl_database/index/list/index.html @@ -2697,6 +2697,82 @@ + +
  • + + + + + + + + + + +
    • + + + + + + + + + +
  • Changelog @@ -2772,11 +2848,11 @@

    upctl database index list

    List current indices of the specified databases

    -
    upctl database index list <UUID/Title...> [flags]
-
    +
    upctl database index list <UUID/Title...> [flags]
+

    Examples

    -
    upctl database index list 55199a44-4751-4e27-9394-7c7661910be3
-
    +
    upctl database index list 55199a44-4751-4e27-9394-7c7661910be3
+

    Options

    • diff --git a/commands_reference/upctl_database/list/index.html b/commands_reference/upctl_database/list/index.html index 17fecb94b..a0516b148 100644 --- a/commands_reference/upctl_database/list/index.html +++ b/commands_reference/upctl_database/list/index.html @@ -2695,6 +2695,82 @@ + +
  • + + + + + + + + + + +
    • + + + + + + + + + +
  • Changelog @@ -2770,11 +2846,11 @@

    upctl database list

    List current databases

    -
    upctl database list [flags]
-
    +
    upctl database list [flags]
+

    Examples

    -
    upctl database list
-
    +
    upctl database list
+

    Options

    • diff --git a/commands_reference/upctl_database/plans/index.html b/commands_reference/upctl_database/plans/index.html index b929e766f..97bf54ab2 100644 --- a/commands_reference/upctl_database/plans/index.html +++ b/commands_reference/upctl_database/plans/index.html @@ -2695,6 +2695,82 @@ + +
  • + + + + + + + + + + +
    • + + + + + + + + + +
  • Changelog @@ -2770,12 +2846,12 @@

    upctl database plans

    List available plans for given database type

    -
    upctl database plans [flags]
-
    +
    upctl database plans [flags]
+

    Examples

    -
    upctl database plans pg
-upctl database plans mysql
-
    +
    upctl database plans pg
+upctl database plans mysql
+

    Options

    • diff --git a/commands_reference/upctl_database/properties/index.html b/commands_reference/upctl_database/properties/index.html index e54987b35..e3541fc71 100644 --- a/commands_reference/upctl_database/properties/index.html +++ b/commands_reference/upctl_database/properties/index.html @@ -2697,6 +2697,82 @@ + +
  • + + + + + + + + + + +
    • + + + + + + + + + +
  • Changelog @@ -2772,12 +2848,12 @@

    upctl database properties

    List available properties for given database type

    -
    upctl database properties [flags]
-
    +
    upctl database properties [flags]
+

    Examples

    -
    upctl database properties pg
-upctl database properties mysql
-
    +
    upctl database properties pg
+upctl database properties mysql
+

    Options

    • diff --git a/commands_reference/upctl_database/properties/mysql/index.html b/commands_reference/upctl_database/properties/mysql/index.html index 21b8e785c..ead851d12 100644 --- a/commands_reference/upctl_database/properties/mysql/index.html +++ b/commands_reference/upctl_database/properties/mysql/index.html @@ -2699,6 +2699,82 @@ + +
  • + + + + + + + + + + +
    • + + + + + + + + + +
  • Changelog @@ -2774,11 +2850,11 @@

    upctl database properties mysql

    List available properties for MySQL databases

    -
    upctl database properties mysql [flags]
-
    +
    upctl database properties mysql [flags]
+

    Examples

    -
    upctl database properties mysql
-
    +
    upctl database properties mysql
+

    Options

    • diff --git a/commands_reference/upctl_database/properties/mysql/show/index.html b/commands_reference/upctl_database/properties/mysql/show/index.html index 8036b31a6..2320d5e19 100644 --- a/commands_reference/upctl_database/properties/mysql/show/index.html +++ b/commands_reference/upctl_database/properties/mysql/show/index.html @@ -2699,6 +2699,82 @@ + +
  • + + + + + + + + + + +
    • + + + + + + + + + +
  • Changelog @@ -2774,11 +2850,11 @@

    upctl database properties mysql show

    Show MySQL database property details

    -
    upctl database properties mysql show [flags]
-
    +
    upctl database properties mysql show [flags]
+

    Examples

    -
    upctl database properties mysql show version
-
    +
    upctl database properties mysql show version
+

    Options

    • diff --git a/commands_reference/upctl_database/properties/opensearch/index.html b/commands_reference/upctl_database/properties/opensearch/index.html index 83a1a9e96..6ea36efc3 100644 --- a/commands_reference/upctl_database/properties/opensearch/index.html +++ b/commands_reference/upctl_database/properties/opensearch/index.html @@ -2699,6 +2699,82 @@ + +
  • + + + + + + + + + + +
    • + + + + + + + + + +
  • Changelog @@ -2774,11 +2850,11 @@

    upctl database properties opensearch

    List available properties for OpenSearch databases

    -
    upctl database properties opensearch [flags]
-
    +
    upctl database properties opensearch [flags]
+

    Examples

    -
    upctl database properties opensearch
-
    +
    upctl database properties opensearch
+

    Options

    • diff --git a/commands_reference/upctl_database/properties/opensearch/show/index.html b/commands_reference/upctl_database/properties/opensearch/show/index.html index 65cd41d71..1e3863a20 100644 --- a/commands_reference/upctl_database/properties/opensearch/show/index.html +++ b/commands_reference/upctl_database/properties/opensearch/show/index.html @@ -2699,6 +2699,82 @@ + +
  • + + + + + + + + + + +
    • + + + + + + + + + +
  • Changelog @@ -2774,11 +2850,11 @@

    upctl database properties opensearch show

    Show OpenSearch database property details

    -
    upctl database properties opensearch show [flags]
-
    +
    upctl database properties opensearch show [flags]
+

    Examples

    -
    upctl database properties opensearch show version
-
    +
    upctl database properties opensearch show version
+

    Options

    • diff --git a/commands_reference/upctl_database/properties/pg/index.html b/commands_reference/upctl_database/properties/pg/index.html index b01a1d1f7..5d1e626ca 100644 --- a/commands_reference/upctl_database/properties/pg/index.html +++ b/commands_reference/upctl_database/properties/pg/index.html @@ -2699,6 +2699,82 @@ + +
  • + + + + + + + + + + +
    • + + + + + + + + + +
  • Changelog @@ -2774,11 +2850,11 @@

    upctl database properties pg

    List available properties for PostgreSQL databases

    -
    upctl database properties pg [flags]
-
    +
    upctl database properties pg [flags]
+

    Examples

    -
    upctl database properties pg
-
    +
    upctl database properties pg
+

    Options

    • diff --git a/commands_reference/upctl_database/properties/pg/show/index.html b/commands_reference/upctl_database/properties/pg/show/index.html index fc772a865..ebd281cda 100644 --- a/commands_reference/upctl_database/properties/pg/show/index.html +++ b/commands_reference/upctl_database/properties/pg/show/index.html @@ -2699,6 +2699,82 @@ + +
  • + + + + + + + + + + +
    • + + + + + + + + + +
  • Changelog @@ -2774,11 +2850,11 @@

    upctl database properties pg show

    Show PostgreSQL database property details

    -
    upctl database properties pg show [flags]
-
    +
    upctl database properties pg show [flags]
+

    Examples

    -
    upctl database properties pg show version
-
    +
    upctl database properties pg show version
+

    Options

    • diff --git a/commands_reference/upctl_database/properties/redis/index.html b/commands_reference/upctl_database/properties/redis/index.html index ecca69fb5..a3e863dd4 100644 --- a/commands_reference/upctl_database/properties/redis/index.html +++ b/commands_reference/upctl_database/properties/redis/index.html @@ -2699,6 +2699,82 @@ + +
  • + + + + + + + + + + +
    • + + + + + + + + + +
  • Changelog @@ -2774,11 +2850,11 @@

    upctl database properties redis

    List available properties for Redis databases

    -
    upctl database properties redis [flags]
-
    +
    upctl database properties redis [flags]
+

    Examples

    -
    upctl database properties redis
-
    +
    upctl database properties redis
+

    Options

    • diff --git a/commands_reference/upctl_database/properties/redis/show/index.html b/commands_reference/upctl_database/properties/redis/show/index.html index 08afe982b..28c55a0f0 100644 --- a/commands_reference/upctl_database/properties/redis/show/index.html +++ b/commands_reference/upctl_database/properties/redis/show/index.html @@ -2699,6 +2699,82 @@ + +
  • + + + + + + + + + + +
    • + + + + + + + + + +
  • Changelog @@ -2774,11 +2850,11 @@

    upctl database properties redis show

    Show Redis database property details

    -
    upctl database properties redis show [flags]
-
    +
    upctl database properties redis show [flags]
+

    Examples

    -
    upctl database properties redis show version
-
    +
    upctl database properties redis show version
+

    Options

    • diff --git a/commands_reference/upctl_database/session/cancel/index.html b/commands_reference/upctl_database/session/cancel/index.html index 9ef9a485d..99b5c0ec4 100644 --- a/commands_reference/upctl_database/session/cancel/index.html +++ b/commands_reference/upctl_database/session/cancel/index.html @@ -2697,6 +2697,82 @@ + +
  • + + + + + + + + + + +
    • + + + + + + + + + +
  • Changelog @@ -2772,12 +2848,12 @@

    upctl database session cancel

    Terminate client session or cancel running query for a database

    -
    upctl database session cancel <UUID/Title...> [flags]
-
    +
    upctl database session cancel <UUID/Title...> [flags]
+

    Examples

    -
    upctl database session cancel 0fa980c4-0e4f-460b-9869-11b7bd62b832 --pid 2345422
-upctl database session cancel mysql-1 --pid 2345422 --terminate
-
    +
    upctl database session cancel 0fa980c4-0e4f-460b-9869-11b7bd62b832 --pid 2345422
+upctl database session cancel mysql-1 --pid 2345422 --terminate
+

    Options

    • diff --git a/commands_reference/upctl_database/session/index.html b/commands_reference/upctl_database/session/index.html index 8871fbb7d..eccc71112 100644 --- a/commands_reference/upctl_database/session/index.html +++ b/commands_reference/upctl_database/session/index.html @@ -2691,6 +2691,82 @@ + +
  • + + + + + + + + + + +
    • + + + + + + + + + +
  • Changelog @@ -2760,8 +2836,8 @@

    upctl database session

    Manage database sessions

    -
    upctl database session [flags]
-
    +
    upctl database session [flags]
+

    Options

    • diff --git a/commands_reference/upctl_database/session/list/index.html b/commands_reference/upctl_database/session/list/index.html index b51b2d762..fc38210f9 100644 --- a/commands_reference/upctl_database/session/list/index.html +++ b/commands_reference/upctl_database/session/list/index.html @@ -2697,6 +2697,82 @@ + +
  • + + + + + + + + + + +
    • + + + + + + + + + +
  • Changelog @@ -2772,12 +2848,12 @@

    upctl database session list

    List current sessions to specified database

    -
    upctl database session list <UUID/Title...> [flags]
-
    +
    upctl database session list <UUID/Title...> [flags]
+

    Examples

    -
    upctl database session list 0fa980c4-0e4f-460b-9869-11b7bd62b832
-upctl database session list mysql-1 --limit 16 --offset 32 --order pid:desc
-
    +
    upctl database session list 0fa980c4-0e4f-460b-9869-11b7bd62b832
+upctl database session list mysql-1 --limit 16 --offset 32 --order pid:desc
+

    Options

    • diff --git a/commands_reference/upctl_database/show/index.html b/commands_reference/upctl_database/show/index.html index f24233aff..11ccab63a 100644 --- a/commands_reference/upctl_database/show/index.html +++ b/commands_reference/upctl_database/show/index.html @@ -2695,6 +2695,82 @@ + +
  • + + + + + + + + + + +
    • + + + + + + + + + +
  • Changelog @@ -2770,13 +2846,13 @@

    upctl database show

    Show database details

    -
    upctl database show <UUID/Title...> [flags]
-
    +
    upctl database show <UUID/Title...> [flags]
+

    Examples

    -
    upctl database show 9a8effcb-80e6-4a63-a7e5-066a6d093c14
-upctl database show my-pg-database
-upctl database show my-mysql-database
-
    +
    upctl database show 9a8effcb-80e6-4a63-a7e5-066a6d093c14
+upctl database show my-pg-database
+upctl database show my-mysql-database
+

    Options

    • diff --git a/commands_reference/upctl_database/start/index.html b/commands_reference/upctl_database/start/index.html index 20afd88f6..834acbeaa 100644 --- a/commands_reference/upctl_database/start/index.html +++ b/commands_reference/upctl_database/start/index.html @@ -2695,6 +2695,82 @@ + +
  • + + + + + + + + + + +
    • + + + + + + + + + +
  • Changelog @@ -2770,13 +2846,13 @@

    upctl database start

    Start on a managed database

    -
    upctl database start <UUID/Title...> [flags]
-
    +
    upctl database start <UUID/Title...> [flags]
+

    Examples

    -
    upctl database start b0952286-1193-4a81-a1af-62efc014ae4b
-upctl database start b0952286-1193-4a81-a1af-62efc014ae4b 666bcd3c-5c63-428d-a4fd-07c27469a5a6
-upctl database start pg-1x1xcpu-2gb-25gb-pl-waw1
-
    +
    upctl database start b0952286-1193-4a81-a1af-62efc014ae4b
+upctl database start b0952286-1193-4a81-a1af-62efc014ae4b 666bcd3c-5c63-428d-a4fd-07c27469a5a6
+upctl database start pg-1x1xcpu-2gb-25gb-pl-waw1
+

    Options

    • diff --git a/commands_reference/upctl_database/stop/index.html b/commands_reference/upctl_database/stop/index.html index 1ea716f52..65b4de715 100644 --- a/commands_reference/upctl_database/stop/index.html +++ b/commands_reference/upctl_database/stop/index.html @@ -2701,6 +2701,82 @@ + +
  • + + + + + + + + + + +
    • + + + + + + + + + +
  • Changelog @@ -2782,15 +2858,15 @@

    upctl database stop

    Stop a managed database

    -
    upctl database stop <UUID/Title...> [flags]
-
    +
    upctl database stop <UUID/Title...> [flags]
+

    Aliases

    shutdown

    Examples

    -
    upctl database stop b0952286-1193-4a81-a1af-62efc014ae4b
-upctl database stop b0952286-1193-4a81-a1af-62efc014ae4b 666bcd3c-5c63-428d-a4fd-07c27469a5a6
-upctl database stop pg-1x1xcpu-2gb-25gb-pl-waw1
-
    +
    upctl database stop b0952286-1193-4a81-a1af-62efc014ae4b
+upctl database stop b0952286-1193-4a81-a1af-62efc014ae4b 666bcd3c-5c63-428d-a4fd-07c27469a5a6
+upctl database stop pg-1x1xcpu-2gb-25gb-pl-waw1
+

    Options

    • diff --git a/commands_reference/upctl_database/types/index.html b/commands_reference/upctl_database/types/index.html index fc91e0df4..3390011ae 100644 --- a/commands_reference/upctl_database/types/index.html +++ b/commands_reference/upctl_database/types/index.html @@ -2695,6 +2695,82 @@ + +
  • + + + + + + + + + + +
    • + + + + + + + + + +
  • Changelog @@ -2770,11 +2846,11 @@

    upctl database types

    List available database types

    -
    upctl database types [flags]
-
    +
    upctl database types [flags]
+

    Examples

    -
    upctl database types
-
    +
    upctl database types
+

    Options

    • diff --git a/commands_reference/upctl_ip-address/assign/index.html b/commands_reference/upctl_ip-address/assign/index.html index be7aeaef9..2cd66d6d3 100644 --- a/commands_reference/upctl_ip-address/assign/index.html +++ b/commands_reference/upctl_ip-address/assign/index.html @@ -2695,6 +2695,82 @@ + +
  • + + + + + + + + + + +
    • + + + + + + + + + +
  • Changelog @@ -2770,14 +2846,14 @@

    upctl ip-address assign

    Assign or create an IP address

    -
    upctl ip-address assign [flags]
-
    +
    upctl ip-address assign [flags]
+

    Examples

    -
    upctl ip-address assign --server 00038afc-d526-4148-af0e-d2f1eeaded9b
-upctl ip-address assign --server 00944977-89ce-4d10-89c3-bb5ba482e48d --family IPv6
-upctl ip-address assign --server 00944977-89ce-4d10-89c3-bb5ba482e48d --floating --zone pl-waw1
-upctl ip-address assign --server 00b78f8b-521d-4ffb-8baa-adf96c7b8f45 --floating --mac d6:0e:4a:6f:11:8f
-
    +
    upctl ip-address assign --server 00038afc-d526-4148-af0e-d2f1eeaded9b
+upctl ip-address assign --server 00944977-89ce-4d10-89c3-bb5ba482e48d --family IPv6
+upctl ip-address assign --server 00944977-89ce-4d10-89c3-bb5ba482e48d --floating --zone pl-waw1
+upctl ip-address assign --server 00b78f8b-521d-4ffb-8baa-adf96c7b8f45 --floating --mac d6:0e:4a:6f:11:8f
+

    Options

    • diff --git a/commands_reference/upctl_ip-address/index.html b/commands_reference/upctl_ip-address/index.html index fbe79e5fb..b7217bbd6 100644 --- a/commands_reference/upctl_ip-address/index.html +++ b/commands_reference/upctl_ip-address/index.html @@ -2695,6 +2695,82 @@ + +
  • + + + + + + + + + + +
    • + + + + + + + + + +
  • Changelog @@ -2770,8 +2846,8 @@

    upctl ip-address

    Manage IP addresses

    -
    upctl ip-address [flags]
-
    +
    upctl ip-address [flags]
+

    Aliases

    ip

    Options

    diff --git a/commands_reference/upctl_ip-address/list/index.html b/commands_reference/upctl_ip-address/list/index.html index ba6a9ba98..91d9ae376 100644 --- a/commands_reference/upctl_ip-address/list/index.html +++ b/commands_reference/upctl_ip-address/list/index.html @@ -2695,6 +2695,82 @@ + +
  • + + + + + + + + + + +
    • + + + + + + + + + +
  • Changelog @@ -2770,11 +2846,11 @@

    upctl ip-address list

    List IP addresses

    -
    upctl ip-address list [flags]
-
    +
    upctl ip-address list [flags]
+

    Examples

    -
    upctl ip-address list
-
    +
    upctl ip-address list
+

    Options

    • diff --git a/commands_reference/upctl_ip-address/modify/index.html b/commands_reference/upctl_ip-address/modify/index.html index 8116a82dd..5269b934f 100644 --- a/commands_reference/upctl_ip-address/modify/index.html +++ b/commands_reference/upctl_ip-address/modify/index.html @@ -2695,6 +2695,82 @@ + +
  • + + + + + + + + + + +
    • + + + + + + + + + +
  • Changelog @@ -2770,12 +2846,12 @@

    upctl ip-address modify

    Modify an IP address

    -
    upctl ip-address modify <Address/PTRRecord...> [flags]
-
    +
    upctl ip-address modify <Address/PTRRecord...> [flags]
+

    Examples

    -
    upctl ip-address modify 185.70.196.225 --ptr-record myapp.com
-upctl ip-address modify 185.70.197.175 --mac d6:0e:4a:6f:2b:06
-
    +
    upctl ip-address modify 185.70.196.225 --ptr-record myapp.com
+upctl ip-address modify 185.70.197.175 --mac d6:0e:4a:6f:2b:06
+

    Options

    • diff --git a/commands_reference/upctl_ip-address/remove/index.html b/commands_reference/upctl_ip-address/remove/index.html index f9f4eb27a..6c8616319 100644 --- a/commands_reference/upctl_ip-address/remove/index.html +++ b/commands_reference/upctl_ip-address/remove/index.html @@ -2695,6 +2695,82 @@ + +
  • + + + + + + + + + + +
    • + + + + + + + + + +
  • Changelog @@ -2770,12 +2846,12 @@

    upctl ip-address remove

    Remove an IP address

    -
    upctl ip-address remove <Address/PTRRecord...> [flags]
-
    +
    upctl ip-address remove <Address/PTRRecord...> [flags]
+

    Examples

    -
    upctl ip-address remove 185.70.197.44
-upctl ip-address remove 2a04:3544:8000:1000:d40e:4aff:fe6f:2c85
-
    +
    upctl ip-address remove 185.70.197.44
+upctl ip-address remove 2a04:3544:8000:1000:d40e:4aff:fe6f:2c85
+

    Options

    • diff --git a/commands_reference/upctl_ip-address/show/index.html b/commands_reference/upctl_ip-address/show/index.html index a20bf6f3b..0bbcdf0a9 100644 --- a/commands_reference/upctl_ip-address/show/index.html +++ b/commands_reference/upctl_ip-address/show/index.html @@ -2695,6 +2695,82 @@ + +
  • + + + + + + + + + + +
    • + + + + + + + + + +
  • Changelog @@ -2770,12 +2846,12 @@

    upctl ip-address show

    Show current IP address

    -
    upctl ip-address show <Address/PTRRecord...> [flags]
-
    +
    upctl ip-address show <Address/PTRRecord...> [flags]
+

    Examples

    -
    upctl ip-address show 185.70.196.47
-upctl ip-address show 2a04:3544:8000:1000:d40e:4aff:fe6f:5d34
-
    +
    upctl ip-address show 185.70.196.47
+upctl ip-address show 2a04:3544:8000:1000:d40e:4aff:fe6f:5d34
+

    Options

    • diff --git a/commands_reference/upctl_kubernetes/config/index.html b/commands_reference/upctl_kubernetes/config/index.html index 79a5f5fa6..a0733e351 100644 --- a/commands_reference/upctl_kubernetes/config/index.html +++ b/commands_reference/upctl_kubernetes/config/index.html @@ -2695,6 +2695,82 @@ + +
  • + + + + + + + + + + +
    • + + + + + + + + + +
  • Changelog @@ -2770,13 +2846,13 @@

    upctl kubernetes config

    Output Kubernetes cluster kubeconfig

    -
    upctl kubernetes config <UUID/Name...> [flags]
-
    +
    upctl kubernetes config <UUID/Name...> [flags]
+

    Examples

    -
    upctl kubernetes config 0fa980c4-0e4f-460b-9869-11b7bd62b831 --output human
-upctl kubernetes config 0fa980c4-0e4f-460b-9869-11b7bd62b831 --output yaml --write $KUBECONFIG
-upctl kubernetes config 0fa980c4-0e4f-460b-9869-11b7bd62b831 --output yaml --write ./my_kubeconfig.yaml
-
    +
    upctl kubernetes config 0fa980c4-0e4f-460b-9869-11b7bd62b831 --output human
+upctl kubernetes config 0fa980c4-0e4f-460b-9869-11b7bd62b831 --output yaml --write $KUBECONFIG
+upctl kubernetes config 0fa980c4-0e4f-460b-9869-11b7bd62b831 --output yaml --write ./my_kubeconfig.yaml
+

    Options

    • diff --git a/commands_reference/upctl_kubernetes/create/index.html b/commands_reference/upctl_kubernetes/create/index.html index c4a9ac02b..de39bf5eb 100644 --- a/commands_reference/upctl_kubernetes/create/index.html +++ b/commands_reference/upctl_kubernetes/create/index.html @@ -2695,6 +2695,82 @@ + +
  • + + + + + + + + + + +
    • + + + + + + + + + +
  • Changelog @@ -2770,21 +2846,21 @@

    upctl kubernetes create

    Create a Kubernetes cluster

    -
    upctl kubernetes create [flags]
-
    +
    upctl kubernetes create [flags]
+

    Examples

    -
    upctl kubernetes create \
-                --name my-cluster \
-                --network 03e5ca07-f36c-4957-a676-e001e40441eb \
-                --node-group count=2,name=my-minimal-node-group,plan=2xCPU-4GB, \
-                --zone de-fra1
-upctl kubernetes create \
-                --name my-cluster \
-                --plan production-small \
-                --network 03e5ca07-f36c-4957-a676-e001e40441eb \
-                --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" \
-                --zone de-fra1
-
    +
    upctl kubernetes create \
+                --name my-cluster \
+                --network 03e5ca07-f36c-4957-a676-e001e40441eb \
+                --node-group count=2,name=my-minimal-node-group,plan=2xCPU-4GB, \
+                --zone de-fra1
+upctl kubernetes create \
+                --name my-cluster \
+                --plan production-small \
+                --network 03e5ca07-f36c-4957-a676-e001e40441eb \
+                --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" \
+                --zone de-fra1
+

    Options

    • diff --git a/commands_reference/upctl_kubernetes/delete/index.html b/commands_reference/upctl_kubernetes/delete/index.html index 18a3d310a..0bf8c6366 100644 --- a/commands_reference/upctl_kubernetes/delete/index.html +++ b/commands_reference/upctl_kubernetes/delete/index.html @@ -2695,6 +2695,82 @@ + +
  • + + + + + + + + + + +
    • + + + + + + + + + +
  • Changelog @@ -2770,12 +2846,12 @@

    upctl kubernetes delete

    Delete a Kubernetes cluster

    -
    upctl kubernetes delete <UUID/Name...> [flags]
-
    +
    upctl kubernetes delete <UUID/Name...> [flags]
+

    Examples

    -
    upctl kubernetes delete 55199a44-4751-4e27-9394-7c7661910be3
-upctl kubernetes delete my-kubernetes-cluster
-
    +
    upctl kubernetes delete 55199a44-4751-4e27-9394-7c7661910be3
+upctl kubernetes delete my-kubernetes-cluster
+

    Options

    • diff --git a/commands_reference/upctl_kubernetes/index.html b/commands_reference/upctl_kubernetes/index.html index 4eae81ac3..15e8c8d05 100644 --- a/commands_reference/upctl_kubernetes/index.html +++ b/commands_reference/upctl_kubernetes/index.html @@ -2695,6 +2695,82 @@ + +
  • + + + + + + + + + + +
    • + + + + + + + + + +
  • Changelog @@ -2770,8 +2846,8 @@

    upctl kubernetes

    Manage Kubernetes clusters

    -
    upctl kubernetes [flags]
-
    +
    upctl kubernetes [flags]
+

    Aliases

    k8s, uks

    Options

    diff --git a/commands_reference/upctl_kubernetes/list/index.html b/commands_reference/upctl_kubernetes/list/index.html index 5cdfeb376..7823ca90d 100644 --- a/commands_reference/upctl_kubernetes/list/index.html +++ b/commands_reference/upctl_kubernetes/list/index.html @@ -2695,6 +2695,82 @@ + +
  • + + + + + + + + + + +
    • + + + + + + + + + +
  • Changelog @@ -2770,11 +2846,11 @@

    upctl kubernetes list

    List current Kubernetes clusters

    -
    upctl kubernetes list [flags]
-
    +
    upctl kubernetes list [flags]
+

    Examples

    -
    upctl kubernetes list
-
    +
    upctl kubernetes list
+

    Options

    • diff --git a/commands_reference/upctl_kubernetes/modify/index.html b/commands_reference/upctl_kubernetes/modify/index.html index a5e153c47..12f8aa844 100644 --- a/commands_reference/upctl_kubernetes/modify/index.html +++ b/commands_reference/upctl_kubernetes/modify/index.html @@ -2695,6 +2695,82 @@ + +
  • + + + + + + + + + + +
    • + + + + + + + + + +
  • Changelog @@ -2770,11 +2846,11 @@

    upctl kubernetes modify

    Modifiy an existing cluster

    -
    upctl kubernetes modify <UUID/Name...> [flags]
-
    +
    upctl kubernetes modify <UUID/Name...> [flags]
+

    Examples

    -
    upctl cluster modify 00bb4617-c592-4b32-b869-35a60b323b18 --plan 1xCPU-1GB
-
    +
    upctl cluster modify 00bb4617-c592-4b32-b869-35a60b323b18 --plan 1xCPU-1GB
+

    Options

    • diff --git a/commands_reference/upctl_kubernetes/nodegroup/create/index.html b/commands_reference/upctl_kubernetes/nodegroup/create/index.html index 083f620ab..36568b002 100644 --- a/commands_reference/upctl_kubernetes/nodegroup/create/index.html +++ b/commands_reference/upctl_kubernetes/nodegroup/create/index.html @@ -2697,6 +2697,82 @@ + +
  • + + + + + + + + + + +
    • + + + + + + + + + +
  • Changelog @@ -2772,11 +2848,11 @@

    upctl kubernetes nodegroup create

    Create a new node group into the specified cluster.

    -
    upctl kubernetes nodegroup create <UUID/Name...> [flags]
-
    +
    upctl kubernetes nodegroup create <UUID/Name...> [flags]
+

    Examples

    -
    upctl kubernetes nodegroup create 55199a44-4751-4e27-9394-7c7661910be3 --name secondary-node-group --count 3 --plan 2xCPU-4GB
-
    +
    upctl kubernetes nodegroup create 55199a44-4751-4e27-9394-7c7661910be3 --name secondary-node-group --count 3 --plan 2xCPU-4GB
+

    Options

    • diff --git a/commands_reference/upctl_kubernetes/nodegroup/delete/index.html b/commands_reference/upctl_kubernetes/nodegroup/delete/index.html index 95a9e6011..b8e7bf513 100644 --- a/commands_reference/upctl_kubernetes/nodegroup/delete/index.html +++ b/commands_reference/upctl_kubernetes/nodegroup/delete/index.html @@ -2697,6 +2697,82 @@ + +
  • + + + + + + + + + + +
    • + + + + + + + + + +
  • Changelog @@ -2772,11 +2848,11 @@

    upctl kubernetes nodegroup delete

    Delete the node group from the cluster.

    -
    upctl kubernetes nodegroup delete <UUID/Name...> [flags]
-
    +
    upctl kubernetes nodegroup delete <UUID/Name...> [flags]
+

    Examples

    -
    upctl kubernetes nodegroup delete 55199a44-4751-4e27-9394-7c7661910be3 --name secondary-node-group
-
    +
    upctl kubernetes nodegroup delete 55199a44-4751-4e27-9394-7c7661910be3 --name secondary-node-group
+

    Options

    • diff --git a/commands_reference/upctl_kubernetes/nodegroup/index.html b/commands_reference/upctl_kubernetes/nodegroup/index.html index 984b584f9..37055447b 100644 --- a/commands_reference/upctl_kubernetes/nodegroup/index.html +++ b/commands_reference/upctl_kubernetes/nodegroup/index.html @@ -2697,6 +2697,82 @@ + +
  • + + + + + + + + + + +
    • + + + + + + + + + +
  • Changelog @@ -2772,8 +2848,8 @@

    upctl kubernetes nodegroup

    Manage cluster node-groups

    -
    upctl kubernetes nodegroup [flags]
-
    +
    upctl kubernetes nodegroup [flags]
+

    Aliases

    node-group

    Options

    diff --git a/commands_reference/upctl_kubernetes/nodegroup/scale/index.html b/commands_reference/upctl_kubernetes/nodegroup/scale/index.html index 3bf61e4a2..38b0894a2 100644 --- a/commands_reference/upctl_kubernetes/nodegroup/scale/index.html +++ b/commands_reference/upctl_kubernetes/nodegroup/scale/index.html @@ -2697,6 +2697,82 @@ + +
  • + + + + + + + + + + +
    • + + + + + + + + + +
  • Changelog @@ -2772,11 +2848,11 @@

    upctl kubernetes nodegroup scale

    Scale the number of nodes in the node group.

    -
    upctl kubernetes nodegroup scale <UUID/Name...> [flags]
-
    +
    upctl kubernetes nodegroup scale <UUID/Name...> [flags]
+

    Examples

    -
    upctl kubernetes nodegroup scale 55199a44-4751-4e27-9394-7c7661910be3 --name secondary-node-group --count 3
-
    +
    upctl kubernetes nodegroup scale 55199a44-4751-4e27-9394-7c7661910be3 --name secondary-node-group --count 3
+

    Options

    • diff --git a/commands_reference/upctl_kubernetes/nodegroup/show/index.html b/commands_reference/upctl_kubernetes/nodegroup/show/index.html index ba5fd811c..679b432d9 100644 --- a/commands_reference/upctl_kubernetes/nodegroup/show/index.html +++ b/commands_reference/upctl_kubernetes/nodegroup/show/index.html @@ -2697,6 +2697,82 @@ + +
  • + + + + + + + + + + +
    • + + + + + + + + + +
  • Changelog @@ -2772,11 +2848,11 @@

    upctl kubernetes nodegroup show

    Show node group details

    -
    upctl kubernetes nodegroup show <UUID/Name...> [flags]
-
    +
    upctl kubernetes nodegroup show <UUID/Name...> [flags]
+

    Examples

    -
    upctl kubernetes nodegroup show 55199a44-4751-4e27-9394-7c7661910be3 --name default
-
    +
    upctl kubernetes nodegroup show 55199a44-4751-4e27-9394-7c7661910be3 --name default
+

    Options

    • diff --git a/commands_reference/upctl_kubernetes/plans/index.html b/commands_reference/upctl_kubernetes/plans/index.html index 959404b9f..d60f5ead4 100644 --- a/commands_reference/upctl_kubernetes/plans/index.html +++ b/commands_reference/upctl_kubernetes/plans/index.html @@ -2695,6 +2695,82 @@ + +
  • + + + + + + + + + + +
    • + + + + + + + + + +
  • Changelog @@ -2770,11 +2846,11 @@

    upctl kubernetes plans

    List available cluster plans

    -
    upctl kubernetes plans [flags]
-
    +
    upctl kubernetes plans [flags]
+

    Examples

    -
    upctl kubernetes plans
-
    +
    upctl kubernetes plans
+

    Options

    • diff --git a/commands_reference/upctl_kubernetes/show/index.html b/commands_reference/upctl_kubernetes/show/index.html index ada867e42..a39e58d8e 100644 --- a/commands_reference/upctl_kubernetes/show/index.html +++ b/commands_reference/upctl_kubernetes/show/index.html @@ -2695,6 +2695,82 @@ + +
  • + + + + + + + + + + +
    • + + + + + + + + + +
  • Changelog @@ -2770,12 +2846,12 @@

    upctl kubernetes show

    Show Kubernetes cluster details

    -
    upctl kubernetes show <UUID/Name...> [flags]
-
    +
    upctl kubernetes show <UUID/Name...> [flags]
+

    Examples

    -
    upctl kubernetes show 55199a44-4751-4e27-9394-7c7661910be3
-upctl kubernetes show my-cluster
-
    +
    upctl kubernetes show 55199a44-4751-4e27-9394-7c7661910be3
+upctl kubernetes show my-cluster
+

    Options

    • diff --git a/commands_reference/upctl_kubernetes/versions/index.html b/commands_reference/upctl_kubernetes/versions/index.html index 273b35c05..5fc4f7a1c 100644 --- a/commands_reference/upctl_kubernetes/versions/index.html +++ b/commands_reference/upctl_kubernetes/versions/index.html @@ -2695,6 +2695,82 @@ + +
  • + + + + + + + + + + +
    • + + + + + + + + + +
  • Changelog @@ -2770,11 +2846,11 @@

    upctl kubernetes versions

    List available versions for Kubernetes clusters

    -
    upctl kubernetes versions [flags]
-
    +
    upctl kubernetes versions [flags]
+

    Examples

    -
    upctl kubernetes versions
-
    +
    upctl kubernetes versions
+

    Options

    • diff --git a/commands_reference/upctl_loadbalancer/delete/index.html b/commands_reference/upctl_loadbalancer/delete/index.html index 388f4f53d..554938f9b 100644 --- a/commands_reference/upctl_loadbalancer/delete/index.html +++ b/commands_reference/upctl_loadbalancer/delete/index.html @@ -2695,6 +2695,82 @@ + +
  • + + + + + + + + + + +
    • + + + + + + + + + +
  • Changelog @@ -2770,12 +2846,12 @@

    upctl loadbalancer delete

    Delete a load balancer

    -
    upctl loadbalancer delete <UUID/Name...> [flags]
-
    +
    upctl loadbalancer delete <UUID/Name...> [flags]
+

    Examples

    -
    upctl loadbalancer delete 55199a44-4751-4e27-9394-7c7661910be3
-upctl loadbalancer delete my-load-balancer
-
    +
    upctl loadbalancer delete 55199a44-4751-4e27-9394-7c7661910be3
+upctl loadbalancer delete my-load-balancer
+

    Options

    • diff --git a/commands_reference/upctl_loadbalancer/index.html b/commands_reference/upctl_loadbalancer/index.html index 0a3c445ba..9a55ec5e1 100644 --- a/commands_reference/upctl_loadbalancer/index.html +++ b/commands_reference/upctl_loadbalancer/index.html @@ -2695,6 +2695,82 @@ + +
  • + + + + + + + + + + +
    • + + + + + + + + + +
  • Changelog @@ -2770,8 +2846,8 @@

    upctl loadbalancer

    Manage load balancers

    -
    upctl loadbalancer [flags]
-
    +
    upctl loadbalancer [flags]
+

    Aliases

    lb

    Options

    diff --git a/commands_reference/upctl_loadbalancer/list/index.html b/commands_reference/upctl_loadbalancer/list/index.html index a52dad1c5..e4a54315b 100644 --- a/commands_reference/upctl_loadbalancer/list/index.html +++ b/commands_reference/upctl_loadbalancer/list/index.html @@ -2695,6 +2695,82 @@ + +
  • + + + + + + + + + + +
    • + + + + + + + + + +
  • Changelog @@ -2770,11 +2846,11 @@

    upctl loadbalancer list

    List current load balancers

    -
    upctl loadbalancer list [flags]
-
    +
    upctl loadbalancer list [flags]
+

    Examples

    -
    upctl loadbalancer list
-
    +
    upctl loadbalancer list
+

    Options

    • diff --git a/commands_reference/upctl_loadbalancer/plans/index.html b/commands_reference/upctl_loadbalancer/plans/index.html index e85c387d5..310cd5f2c 100644 --- a/commands_reference/upctl_loadbalancer/plans/index.html +++ b/commands_reference/upctl_loadbalancer/plans/index.html @@ -2695,6 +2695,82 @@ + +
  • + + + + + + + + + + +
    • + + + + + + + + + +
  • Changelog @@ -2770,11 +2846,11 @@

    upctl loadbalancer plans

    List available load balancer plans

    -
    upctl loadbalancer plans [flags]
-
    +
    upctl loadbalancer plans [flags]
+

    Examples

    -
    upctl loadbalancer plans
-
    +
    upctl loadbalancer plans
+

    Options

    • diff --git a/commands_reference/upctl_loadbalancer/show/index.html b/commands_reference/upctl_loadbalancer/show/index.html index fe1cd631b..1eb62c53a 100644 --- a/commands_reference/upctl_loadbalancer/show/index.html +++ b/commands_reference/upctl_loadbalancer/show/index.html @@ -2695,6 +2695,82 @@ + +
  • + + + + + + + + + + +
    • + + + + + + + + + +
  • Changelog @@ -2770,12 +2846,12 @@

    upctl loadbalancer show

    Show load balancer details

    -
    upctl loadbalancer show <UUID/Name...> [flags]
-
    +
    upctl loadbalancer show <UUID/Name...> [flags]
+

    Examples

    -
    upctl loadbalancer show 55199a44-4751-4e27-9394-7c7661910be3
-upctl loadbalancer show my-load-balancer
-
    +
    upctl loadbalancer show 55199a44-4751-4e27-9394-7c7661910be3
+upctl loadbalancer show my-load-balancer
+

    Options

    • diff --git a/commands_reference/upctl_network/create/index.html b/commands_reference/upctl_network/create/index.html index 262d6e1e1..11b430831 100644 --- a/commands_reference/upctl_network/create/index.html +++ b/commands_reference/upctl_network/create/index.html @@ -2695,6 +2695,82 @@ + +
  • + + + + + + + + + + +
    • + + + + + + + + + +
  • Changelog @@ -2770,12 +2846,12 @@

    upctl network create

    Create a network

    -
    upctl network create [flags]
-
    +
    upctl network create [flags]
+

    Examples

    -
    upctl network create --name "My Network" --zone pl-waw1 --ip-network address=10.0.1.0/24
-upctl network create --name my_net --zone pl-waw1 --ip-network address=10.0.2.0/24,dhcp=true
-
    +
    upctl network create --name "My Network" --zone pl-waw1 --ip-network address=10.0.1.0/24
+upctl network create --name my_net --zone pl-waw1 --ip-network address=10.0.2.0/24,dhcp=true
+

    Options

    • diff --git a/commands_reference/upctl_network/delete/index.html b/commands_reference/upctl_network/delete/index.html index 1f13f3a56..ef4f425ef 100644 --- a/commands_reference/upctl_network/delete/index.html +++ b/commands_reference/upctl_network/delete/index.html @@ -2695,6 +2695,82 @@ + +
  • + + + + + + + + + + +
    • + + + + + + + + + +
  • Changelog @@ -2770,13 +2846,13 @@

    upctl network delete

    Delete a network

    -
    upctl network delete <UUID/Name...> [flags]
-
    +
    upctl network delete <UUID/Name...> [flags]
+

    Examples

    -
    upctl network delete 037f260c-9568-4d9b-97e5-44cf52440ccb
-upctl network delete 03d7b5c2-b80a-4636-88d4-f9911185c975 0312a237-8204-4c1c-9fd1-2314013ec687
-upctl network delete "My Network 1"
-
    +
    upctl network delete 037f260c-9568-4d9b-97e5-44cf52440ccb
+upctl network delete 03d7b5c2-b80a-4636-88d4-f9911185c975 0312a237-8204-4c1c-9fd1-2314013ec687
+upctl network delete "My Network 1"
+

    Options

    • diff --git a/commands_reference/upctl_network/index.html b/commands_reference/upctl_network/index.html index 16c734e1f..d71fb1591 100644 --- a/commands_reference/upctl_network/index.html +++ b/commands_reference/upctl_network/index.html @@ -2695,6 +2695,82 @@ + +
  • + + + + + + + + + + +
    • + + + + + + + + + +
  • Changelog @@ -2770,8 +2846,8 @@

    upctl network

    Manage networks

    -
    upctl network <UUID/Name...> [flags]
-
    +
    upctl network <UUID/Name...> [flags]
+

    Aliases

    net

    Options

    diff --git a/commands_reference/upctl_network/list/index.html b/commands_reference/upctl_network/list/index.html index 27688fbad..62e5fd065 100644 --- a/commands_reference/upctl_network/list/index.html +++ b/commands_reference/upctl_network/list/index.html @@ -2695,6 +2695,82 @@ + +
  • + + + + + + + + + + +
    • + + + + + + + + + +
  • Changelog @@ -2770,15 +2846,15 @@

    upctl network list

    List networks, by default private networks only

    -
    upctl network list [flags]
-
    +
    upctl network list [flags]
+

    Examples

    -
    upctl network list
-upctl network list --zone pl-waw1
-upctl network list --zone pl-waw1 --public
-upctl network list --all
-upctl network list --zone pl-waw1 --all
-
    +
    upctl network list
+upctl network list --zone pl-waw1
+upctl network list --zone pl-waw1 --public
+upctl network list --all
+upctl network list --zone pl-waw1 --all
+

    Options

    • diff --git a/commands_reference/upctl_network/modify/index.html b/commands_reference/upctl_network/modify/index.html index 49312247e..d804b3aee 100644 --- a/commands_reference/upctl_network/modify/index.html +++ b/commands_reference/upctl_network/modify/index.html @@ -2695,6 +2695,82 @@ + +
  • + + + + + + + + + + +
    • + + + + + + + + + +
  • Changelog @@ -2770,12 +2846,12 @@

    upctl network modify

    Modify a network

    -
    upctl network modify <UUID/Name...> [flags]
-
    +
    upctl network modify <UUID/Name...> [flags]
+

    Examples

    -
    upctl network modify 037a530b-533e-4cef-b6ad-6af8094bb2bc --ip-network dhcp=false,family=IPv4
-upctl network modify "My Network" --name "My Super Network"
-
    +
    upctl network modify 037a530b-533e-4cef-b6ad-6af8094bb2bc --ip-network dhcp=false,family=IPv4
+upctl network modify "My Network" --name "My Super Network"
+

    Options

    • diff --git a/commands_reference/upctl_network/show/index.html b/commands_reference/upctl_network/show/index.html index fa21c3d1f..08d3137ef 100644 --- a/commands_reference/upctl_network/show/index.html +++ b/commands_reference/upctl_network/show/index.html @@ -2695,6 +2695,82 @@ + +
  • + + + + + + + + + + +
    • + + + + + + + + + +
  • Changelog @@ -2770,13 +2846,13 @@

    upctl network show

    Show network details

    -
    upctl network show <UUID/Name...> [flags]
-
    +
    upctl network show <UUID/Name...> [flags]
+

    Examples

    -
    upctl network show 037a530b-533e-4cef-b6ad-6af8094bb2bc
-upctl network show 037a530b-533e-4cef-b6ad-6af8094bb2bc 0311480d-d0c0-4951-ab41-bf12097f5d3c
-upctl network show "My Network"
-
    +
    upctl network show 037a530b-533e-4cef-b6ad-6af8094bb2bc
+upctl network show 037a530b-533e-4cef-b6ad-6af8094bb2bc 0311480d-d0c0-4951-ab41-bf12097f5d3c
+upctl network show "My Network"
+

    Options

    • diff --git a/commands_reference/upctl_objectstorage/delete/index.html b/commands_reference/upctl_objectstorage/delete/index.html index 49fc53bf8..e2f6fb203 100644 --- a/commands_reference/upctl_objectstorage/delete/index.html +++ b/commands_reference/upctl_objectstorage/delete/index.html @@ -2695,6 +2695,82 @@ + +
  • + + + + + + + + + + +
    • + + + + + + + + + +
  • Changelog @@ -2770,11 +2846,11 @@

    upctl objectstorage delete

    Delete a Managed object storage service

    -
    upctl objectstorage delete [flags]
-
    +
    upctl objectstorage delete [flags]
+

    Examples

    -
    upctl objectstorage delete 55199a44-4751-4e27-9394-7c7661910be8
-
    +
    upctl objectstorage delete 55199a44-4751-4e27-9394-7c7661910be8
+

    Options

    • diff --git a/commands_reference/upctl_objectstorage/index.html b/commands_reference/upctl_objectstorage/index.html index 9144bcc03..65221f369 100644 --- a/commands_reference/upctl_objectstorage/index.html +++ b/commands_reference/upctl_objectstorage/index.html @@ -2695,6 +2695,82 @@ + +
  • + + + + + + + + + + +
    • + + + + + + + + + +
  • Changelog @@ -2770,8 +2846,8 @@

    upctl objectstorage

    Manage Managed object storage services

    -
    upctl objectstorage [flags]
-
    +
    upctl objectstorage [flags]
+

    Aliases

    object-storage, objsto

    Options

    diff --git a/commands_reference/upctl_objectstorage/list/index.html b/commands_reference/upctl_objectstorage/list/index.html index 32a07364d..399625bf3 100644 --- a/commands_reference/upctl_objectstorage/list/index.html +++ b/commands_reference/upctl_objectstorage/list/index.html @@ -2695,6 +2695,82 @@ + +
  • + + + + + + + + + + +
    • + + + + + + + + + +
  • Changelog @@ -2770,11 +2846,11 @@

    upctl objectstorage list

    List current Managed object storage services

    -
    upctl objectstorage list [flags]
-
    +
    upctl objectstorage list [flags]
+

    Examples

    -
    upctl objectstorage list
-
    +
    upctl objectstorage list
+

    Options

    • diff --git a/commands_reference/upctl_objectstorage/show/index.html b/commands_reference/upctl_objectstorage/show/index.html index 495b2dc46..8957074da 100644 --- a/commands_reference/upctl_objectstorage/show/index.html +++ b/commands_reference/upctl_objectstorage/show/index.html @@ -2695,6 +2695,82 @@ + +
  • + + + + + + + + + + +
    • + + + + + + + + + +
  • Changelog @@ -2770,11 +2846,11 @@

    upctl objectstorage show

    Show Managed object storage service details

    -
    upctl objectstorage show [flags]
-
    +
    upctl objectstorage show [flags]
+

    Examples

    -
    upctl objectstorage show 55199a44-4751-4e27-9394-7c7661910be8
-
    +
    upctl objectstorage show 55199a44-4751-4e27-9394-7c7661910be8
+

    Options

    • diff --git a/commands_reference/upctl_router/create/index.html b/commands_reference/upctl_router/create/index.html index 170fe3689..56c746c91 100644 --- a/commands_reference/upctl_router/create/index.html +++ b/commands_reference/upctl_router/create/index.html @@ -2695,6 +2695,82 @@ + +
  • + + + + + + + + + + +
    • + + + + + + + + + +
  • Changelog @@ -2770,12 +2846,12 @@

    upctl router create

    Create a router

    -
    upctl router create [flags]
-
    +
    upctl router create [flags]
+

    Examples

    -
    upctl router create --name my_router
-upctl router create --name "My Router"
-
    +
    upctl router create --name my_router
+upctl router create --name "My Router"
+

    Options

    • diff --git a/commands_reference/upctl_router/delete/index.html b/commands_reference/upctl_router/delete/index.html index 7bf729408..d50bd2f34 100644 --- a/commands_reference/upctl_router/delete/index.html +++ b/commands_reference/upctl_router/delete/index.html @@ -2695,6 +2695,82 @@ + +
  • + + + + + + + + + + +
    • + + + + + + + + + +
  • Changelog @@ -2770,12 +2846,12 @@

    upctl router delete

    Delete a router

    -
    upctl router delete <UUID/Name...> [flags]
-
    +
    upctl router delete <UUID/Name...> [flags]
+

    Examples

    -
    upctl router delete 0497728e-76ef-41d0-997f-fa9449eb71bc
-upctl router delete my_router
-
    +
    upctl router delete 0497728e-76ef-41d0-997f-fa9449eb71bc
+upctl router delete my_router
+

    Options

    • diff --git a/commands_reference/upctl_router/index.html b/commands_reference/upctl_router/index.html index 9e655e937..c49bf5d05 100644 --- a/commands_reference/upctl_router/index.html +++ b/commands_reference/upctl_router/index.html @@ -2689,6 +2689,82 @@ + +
  • + + + + + + + + + + +
    • + + + + + + + + + +
  • Changelog @@ -2758,8 +2834,8 @@

    upctl router

    Manage routers

    -
    upctl router [flags]
-
    +
    upctl router [flags]
+

    Options

    • diff --git a/commands_reference/upctl_router/list/index.html b/commands_reference/upctl_router/list/index.html index eee71b1df..759f6645b 100644 --- a/commands_reference/upctl_router/list/index.html +++ b/commands_reference/upctl_router/list/index.html @@ -2695,6 +2695,82 @@ + +
  • + + + + + + + + + + +
    • + + + + + + + + + +
  • Changelog @@ -2770,12 +2846,12 @@

    upctl router list

    List routers

    -
    upctl router list [flags]
-
    +
    upctl router list [flags]
+

    Examples

    -
    upctl router list
-upctl router list --all
-
    +
    upctl router list
+upctl router list --all
+

    Options

    • diff --git a/commands_reference/upctl_router/modify/index.html b/commands_reference/upctl_router/modify/index.html index cedb107c7..8c69f936c 100644 --- a/commands_reference/upctl_router/modify/index.html +++ b/commands_reference/upctl_router/modify/index.html @@ -2695,6 +2695,82 @@ + +
  • + + + + + + + + + + +
    • + + + + + + + + + +
  • Changelog @@ -2770,12 +2846,12 @@

    upctl router modify

    Modify a router

    -
    upctl router modify <UUID/Name...> [flags]
-
    +
    upctl router modify <UUID/Name...> [flags]
+

    Examples

    -
    upctl router modify 04d031ab-4b85-4cbc-9f0e-6a2977541327 --name my_super_router
-upctl router modify "My Router" --name "My Turbo Router"
-
    +
    upctl router modify 04d031ab-4b85-4cbc-9f0e-6a2977541327 --name my_super_router
+upctl router modify "My Router" --name "My Turbo Router"
+

    Options

    • diff --git a/commands_reference/upctl_router/show/index.html b/commands_reference/upctl_router/show/index.html index 2e1259305..3e7eb28cc 100644 --- a/commands_reference/upctl_router/show/index.html +++ b/commands_reference/upctl_router/show/index.html @@ -2695,6 +2695,82 @@ + +
  • + + + + + + + + + + +
    • + + + + + + + + + +
  • Changelog @@ -2770,13 +2846,13 @@

    upctl router show

    Show current router

    -
    upctl router show <UUID/Name...> [flags]
-
    +
    upctl router show <UUID/Name...> [flags]
+

    Examples

    -
    upctl router show 04d0a7f6-ee78-42b5-8077-6947f9e67c5a
-upctl router show 04d0a7f6-ee78-42b5-8077-6947f9e67c5a 04d031ab-4b85-4cbc-9f0e-6a2977541327
-upctl router show "My Turbo Router" my_super_router
-
    +
    upctl router show 04d0a7f6-ee78-42b5-8077-6947f9e67c5a
+upctl router show 04d0a7f6-ee78-42b5-8077-6947f9e67c5a 04d031ab-4b85-4cbc-9f0e-6a2977541327
+upctl router show "My Turbo Router" my_super_router
+

    Options

    • diff --git a/commands_reference/upctl_server/create/index.html b/commands_reference/upctl_server/create/index.html index ca2143c88..1fde0a5d1 100644 --- a/commands_reference/upctl_server/create/index.html +++ b/commands_reference/upctl_server/create/index.html @@ -2695,6 +2695,82 @@ + +
  • + + + + + + + + + + +
    • + + + + + + + + + +
  • Changelog @@ -2770,17 +2846,17 @@

    upctl server create

    Create a server

    -
    upctl server create [flags]
-
    +
    upctl server create [flags]
+

    Examples

    -
    upctl server create --title myapp --zone fi-hel1 --hostname myapp --password-delivery email
-upctl server create --wait --title myapp --zone fi-hel1 --hostname myapp --password-delivery email
-upctl server create --title "My Server" --zone fi-hel1 --hostname myapp --password-delivery email
-upctl server create --zone fi-hel1 --hostname myapp --password-delivery email --plan 2xCPU-4GB
-upctl server create --zone fi-hel1 --hostname myapp --password-delivery email --plan custom --cores 2 --memory 4096
-upctl server create --zone fi-hel1 --hostname myapp --password-delivery email --os "Debian GNU/Linux 10 (Buster)" --server-group a4643646-8342-4324-4134-364138712378
-upctl server create --zone fi-hel1 --hostname myapp --ssh-keys /path/to/publickey --network type=private,network=037a530b-533e-4cef-b6ad-6af8094bb2bc,ip-address=10.0.0.1
-
    +
    upctl server create --title myapp --zone fi-hel1 --hostname myapp --password-delivery email
+upctl server create --wait --title myapp --zone fi-hel1 --hostname myapp --password-delivery email
+upctl server create --title "My Server" --zone fi-hel1 --hostname myapp --password-delivery email
+upctl server create --zone fi-hel1 --hostname myapp --password-delivery email --plan 2xCPU-4GB
+upctl server create --zone fi-hel1 --hostname myapp --password-delivery email --plan custom --cores 2 --memory 4096
+upctl server create --zone fi-hel1 --hostname myapp --password-delivery email --os "Debian GNU/Linux 10 (Buster)" --server-group a4643646-8342-4324-4134-364138712378
+upctl server create --zone fi-hel1 --hostname myapp --ssh-keys /path/to/publickey --network type=private,network=037a530b-533e-4cef-b6ad-6af8094bb2bc,ip-address=10.0.0.1
+

    Options

    • diff --git a/commands_reference/upctl_server/delete/index.html b/commands_reference/upctl_server/delete/index.html index 55bfe0d3b..3b1e32d83 100644 --- a/commands_reference/upctl_server/delete/index.html +++ b/commands_reference/upctl_server/delete/index.html @@ -2695,6 +2695,82 @@ + +
  • + + + + + + + + + + +
    • + + + + + + + + + +
  • Changelog @@ -2770,13 +2846,13 @@

    upctl server delete

    Delete a server

    -
    upctl server delete <UUID/Title/Hostname...> [flags]
-
    +
    upctl server delete <UUID/Title/Hostname...> [flags]
+

    Examples

    -
    upctl server delete 00cbe2f3-4cf9-408b-afee-bd340e13cdd8
-upctl server delete 00cbe2f3-4cf9-408b-afee-bd340e13cdd8 0053a6f5-e6d1-4b0b-b9dc-b90d0894e8d0
-upctl server delete my_server
-
    +
    upctl server delete 00cbe2f3-4cf9-408b-afee-bd340e13cdd8
+upctl server delete 00cbe2f3-4cf9-408b-afee-bd340e13cdd8 0053a6f5-e6d1-4b0b-b9dc-b90d0894e8d0
+upctl server delete my_server
+

    Options

    • diff --git a/commands_reference/upctl_server/eject/index.html b/commands_reference/upctl_server/eject/index.html index c3ad1b92c..0759eb8b2 100644 --- a/commands_reference/upctl_server/eject/index.html +++ b/commands_reference/upctl_server/eject/index.html @@ -2695,6 +2695,82 @@ + +
  • + + + + + + + + + + +
    • + + + + + + + + + +
  • Changelog @@ -2770,11 +2846,11 @@

    upctl server eject

    Eject a CD-ROM from the server

    -
    upctl server eject <UUID/Title/Hostname...> [flags]
-
    +
    upctl server eject <UUID/Title/Hostname...> [flags]
+

    Examples

    -
    upctl server eject my_server
-
    +
    upctl server eject my_server
+

    Options

    • diff --git a/commands_reference/upctl_server/firewall/create/index.html b/commands_reference/upctl_server/firewall/create/index.html index 48e43304d..197833f8e 100644 --- a/commands_reference/upctl_server/firewall/create/index.html +++ b/commands_reference/upctl_server/firewall/create/index.html @@ -2697,6 +2697,82 @@ + +
  • + + + + + + + + + + +
    • + + + + + + + + + +
  • Changelog @@ -2776,13 +2852,13 @@

    upctl server firewall create

    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]
-
    +
    upctl server firewall create <UUID/Title/Hostname...> [flags]
+

    Examples

    -
    upctl server firewall create 00038afc-d526-4148-af0e-d2f1eeaded9b --direction in --action drop
-upctl server firewall create 00038afc-d526-4148-af0e-d2f1eeaded9b --direction in --action accept --family IPv4
-upctl server firewall create 00038afc-d526-4148-af0e-d2f1eeaded9b --direction in --action drop --family IPv4 --src-ipaddress-block 10.11.0.88/24
-
    +
    upctl server firewall create 00038afc-d526-4148-af0e-d2f1eeaded9b --direction in --action drop
+upctl server firewall create 00038afc-d526-4148-af0e-d2f1eeaded9b --direction in --action accept --family IPv4
+upctl server firewall create 00038afc-d526-4148-af0e-d2f1eeaded9b --direction in --action drop --family IPv4 --src-ipaddress-block 10.11.0.88/24
+

    Options

    • diff --git a/commands_reference/upctl_server/firewall/delete/index.html b/commands_reference/upctl_server/firewall/delete/index.html index 8184c3350..56eb2f837 100644 --- a/commands_reference/upctl_server/firewall/delete/index.html +++ b/commands_reference/upctl_server/firewall/delete/index.html @@ -2697,6 +2697,82 @@ + +
  • + + + + + + + + + + +
    • + + + + + + + + + +
  • Changelog @@ -2772,11 +2848,11 @@

    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 delete <UUID/Title/Hostname...> [flags]
-
    +
    upctl server firewall delete <UUID/Title/Hostname...> [flags]
+

    Examples

    -
    upctl server firewall delete 00038afc-d526-4148-af0e-d2f1eeaded9b --position 1
-
    +
    upctl server firewall delete 00038afc-d526-4148-af0e-d2f1eeaded9b --position 1
+

    Options

    • diff --git a/commands_reference/upctl_server/firewall/index.html b/commands_reference/upctl_server/firewall/index.html index 3e9b79756..1b3c0ce6f 100644 --- a/commands_reference/upctl_server/firewall/index.html +++ b/commands_reference/upctl_server/firewall/index.html @@ -2691,6 +2691,82 @@ + +
  • + + + + + + + + + + +
    • + + + + + + + + + +
  • Changelog @@ -2760,8 +2836,8 @@

    upctl server firewall

    Manage server firewall rules. Enabling or disabling the firewall is done in server modify.

    -
    upctl server firewall [flags]
-
    +
    upctl server firewall [flags]
+

    Options

    • diff --git a/commands_reference/upctl_server/firewall/show/index.html b/commands_reference/upctl_server/firewall/show/index.html index f96906759..8bfcdcd29 100644 --- a/commands_reference/upctl_server/firewall/show/index.html +++ b/commands_reference/upctl_server/firewall/show/index.html @@ -2697,6 +2697,82 @@ + +
  • + + + + + + + + + + +
    • + + + + + + + + + +
  • Changelog @@ -2772,13 +2848,13 @@

    upctl server firewall show

    Show server firewall details.

    -
    upctl server firewall show <UUID/Title/Hostname...> [flags]
-
    +
    upctl server firewall show <UUID/Title/Hostname...> [flags]
+

    Examples

    -
    upctl server firewall show 00038afc-d526-4148-af0e-d2f1eeaded9b
-upctl server firewall show 00038afc-d526-4148-af0e-d2f1eeaded9b 009d7f4e-99ce-4c78-88f1-e695d4c37743
-upctl server firewall show my_server
-
    +
    upctl server firewall show 00038afc-d526-4148-af0e-d2f1eeaded9b
+upctl server firewall show 00038afc-d526-4148-af0e-d2f1eeaded9b 009d7f4e-99ce-4c78-88f1-e695d4c37743
+upctl server firewall show my_server
+

    Options

    • diff --git a/commands_reference/upctl_server/index.html b/commands_reference/upctl_server/index.html index f116d6abe..69c1d035e 100644 --- a/commands_reference/upctl_server/index.html +++ b/commands_reference/upctl_server/index.html @@ -2689,6 +2689,82 @@ + +
  • + + + + + + + + + + +
    • + + + + + + + + + +
  • Changelog @@ -2758,8 +2834,8 @@

    upctl server

    Manage servers

    -
    upctl server [flags]
-
    +
    upctl server [flags]
+

    Options

    • diff --git a/commands_reference/upctl_server/list/index.html b/commands_reference/upctl_server/list/index.html index 95cfa0007..acc6a547a 100644 --- a/commands_reference/upctl_server/list/index.html +++ b/commands_reference/upctl_server/list/index.html @@ -2695,6 +2695,82 @@ + +
  • + + + + + + + + + + +
    • + + + + + + + + + +
  • Changelog @@ -2770,13 +2846,13 @@

    upctl server list

    List current servers

    -
    upctl server list [flags]
-
    +
    upctl server list [flags]
+

    Examples

    -
    upctl server list
-upctl server list --show-ip-addresses
-upctl server list --show-ip-addresses=public
-
    +
    upctl server list
+upctl server list --show-ip-addresses
+upctl server list --show-ip-addresses=public
+

    Options

    • diff --git a/commands_reference/upctl_server/load/index.html b/commands_reference/upctl_server/load/index.html index 68821fc7e..bf6516aaf 100644 --- a/commands_reference/upctl_server/load/index.html +++ b/commands_reference/upctl_server/load/index.html @@ -2695,6 +2695,82 @@ + +
  • + + + + + + + + + + +
    • + + + + + + + + + +
  • Changelog @@ -2770,11 +2846,11 @@

    upctl server load

    Load a CD-ROM into the server

    -
    upctl server load <UUID/Title/Hostname...> [flags]
-
    +
    upctl server load <UUID/Title/Hostname...> [flags]
+

    Examples

    -
    upctl server load my_server4 --storage 01000000-0000-4000-8000-000080030101
-
    +
    upctl server load my_server4 --storage 01000000-0000-4000-8000-000080030101
+

    Options

    • diff --git a/commands_reference/upctl_server/modify/index.html b/commands_reference/upctl_server/modify/index.html index 017ce9d57..1b40af8fd 100644 --- a/commands_reference/upctl_server/modify/index.html +++ b/commands_reference/upctl_server/modify/index.html @@ -2695,6 +2695,82 @@ + +
  • + + + + + + + + + + +
    • + + + + + + + + + +
  • Changelog @@ -2770,14 +2846,14 @@

    upctl server modify

    Modifies the configuration of an existing server

    -
    upctl server modify <UUID/Title/Hostname...> [flags]
-
    +
    upctl server modify <UUID/Title/Hostname...> [flags]
+

    Examples

    -
    upctl server modify 00bb4617-c592-4b32-b869-35a60b323b18 --plan 1xCPU-1GB
-upctl server modify 00bb4617-c592-4b32-b869-35a60b323b18 0053a6f5-e6d1-4b0b-b9dc-b90d0894e8d0 --plan 1xCPU-1GB
-upctl server modify my_server1 --plan 1xCPU-2GB
-upctl server modify myapp --hostname superapp
-
    +
    upctl server modify 00bb4617-c592-4b32-b869-35a60b323b18 --plan 1xCPU-1GB
+upctl server modify 00bb4617-c592-4b32-b869-35a60b323b18 0053a6f5-e6d1-4b0b-b9dc-b90d0894e8d0 --plan 1xCPU-1GB
+upctl server modify my_server1 --plan 1xCPU-2GB
+upctl server modify myapp --hostname superapp
+

    Options

    • diff --git a/commands_reference/upctl_server/network-interface/create/index.html b/commands_reference/upctl_server/network-interface/create/index.html index 13cbcd523..fad9f129a 100644 --- a/commands_reference/upctl_server/network-interface/create/index.html +++ b/commands_reference/upctl_server/network-interface/create/index.html @@ -2697,6 +2697,82 @@ + +
  • + + + + + + + + + + +
    • + + + + + + + + + +
  • Changelog @@ -2772,14 +2848,14 @@

    upctl server network-interface create

    Create a network interface

    -
    upctl server network-interface create <UUID/Title/Hostname...> [flags]
-
    +
    upctl server network-interface create <UUID/Title/Hostname...> [flags]
+

    Examples

    -
    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
-upctl server network-interface create my_server2 --type public --family IPv6
-upctl server network-interface create my_server2 --type public --family IPv4
-upctl server network-interface create my_server2 --network 037a530b-533e-4cef-b6ad-6af8094bb2bc
-
    +
    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
+upctl server network-interface create my_server2 --type public --family IPv6
+upctl server network-interface create my_server2 --type public --family IPv4
+upctl server network-interface create my_server2 --network 037a530b-533e-4cef-b6ad-6af8094bb2bc
+

    Options

    • diff --git a/commands_reference/upctl_server/network-interface/delete/index.html b/commands_reference/upctl_server/network-interface/delete/index.html index d23322d87..1d7814952 100644 --- a/commands_reference/upctl_server/network-interface/delete/index.html +++ b/commands_reference/upctl_server/network-interface/delete/index.html @@ -2697,6 +2697,82 @@ + +
  • + + + + + + + + + + +
    • + + + + + + + + + +
  • Changelog @@ -2772,12 +2848,12 @@

    upctl server network-interface delete

    Delete a network interface

    -
    upctl server network-interface delete <UUID/Title/Hostname...> [flags]
-
    +
    upctl server network-interface delete <UUID/Title/Hostname...> [flags]
+

    Examples

    -
    upctl server network-interface delete 009d7f4e-99ce-4c78-88f1-e695d4c37743 --index 1
-upctl server network-interface delete my_server --index 7
-
    +
    upctl server network-interface delete 009d7f4e-99ce-4c78-88f1-e695d4c37743 --index 1
+upctl server network-interface delete my_server --index 7
+

    Options

    • diff --git a/commands_reference/upctl_server/network-interface/index.html b/commands_reference/upctl_server/network-interface/index.html index f1237bf40..2cf0eff3f 100644 --- a/commands_reference/upctl_server/network-interface/index.html +++ b/commands_reference/upctl_server/network-interface/index.html @@ -2691,6 +2691,82 @@ + +
  • + + + + + + + + + + +
    • + + + + + + + + + +
  • Changelog @@ -2760,8 +2836,8 @@

    upctl server network-interface

    Manage network interface

    -
    upctl server network-interface [flags]
-
    +
    upctl server network-interface [flags]
+

    Options

    • diff --git a/commands_reference/upctl_server/network-interface/modify/index.html b/commands_reference/upctl_server/network-interface/modify/index.html index 620093b8f..ce807bd97 100644 --- a/commands_reference/upctl_server/network-interface/modify/index.html +++ b/commands_reference/upctl_server/network-interface/modify/index.html @@ -2697,6 +2697,82 @@ + +
  • + + + + + + + + + + +
    • + + + + + + + + + +
  • Changelog @@ -2772,11 +2848,11 @@

    upctl server network-interface modify

    Modify a network interface

    -
    upctl server network-interface modify <UUID/Title/Hostname...> [flags]
-
    +
    upctl server network-interface modify <UUID/Title/Hostname...> [flags]
+

    Examples

    -
    upctl server network-interface modify 009d7f4e-99ce-4c78-88f1-e695d4c37743 --index 2 --new-index 1
-
    +
    upctl server network-interface modify 009d7f4e-99ce-4c78-88f1-e695d4c37743 --index 2 --new-index 1
+

    Options

    • diff --git a/commands_reference/upctl_server/plans/index.html b/commands_reference/upctl_server/plans/index.html index 2272dc8c4..75d8f1c6e 100644 --- a/commands_reference/upctl_server/plans/index.html +++ b/commands_reference/upctl_server/plans/index.html @@ -2695,6 +2695,82 @@ + +
  • + + + + + + + + + + +
    • + + + + + + + + + +
  • Changelog @@ -2770,11 +2846,11 @@

    upctl server plans

    List server plans

    -
    upctl server plans [flags]
-
    +
    upctl server plans [flags]
+

    Examples

    -
    upctl server plans
-
    +
    upctl server plans
+

    Options

    • diff --git a/commands_reference/upctl_server/restart/index.html b/commands_reference/upctl_server/restart/index.html index 988bd920b..67fa06d8b 100644 --- a/commands_reference/upctl_server/restart/index.html +++ b/commands_reference/upctl_server/restart/index.html @@ -2695,6 +2695,82 @@ + +
  • + + + + + + + + + + +
    • + + + + + + + + + +
  • Changelog @@ -2770,13 +2846,13 @@

    upctl server restart

    Restart a server

    -
    upctl server restart <UUID/Title/Hostname...> [flags]
-
    +
    upctl server restart <UUID/Title/Hostname...> [flags]
+

    Examples

    -
    upctl server restart 00038afc-d526-4148-af0e-d2f1eeaded9b
-upctl server restart 00038afc-d526-4148-af0e-d2f1eeaded9b --stop-type hard
-upctl server restart my_server1 my_server2
-
    +
    upctl server restart 00038afc-d526-4148-af0e-d2f1eeaded9b
+upctl server restart 00038afc-d526-4148-af0e-d2f1eeaded9b --stop-type hard
+upctl server restart my_server1 my_server2
+

    Options

    • diff --git a/commands_reference/upctl_server/show/index.html b/commands_reference/upctl_server/show/index.html index 134be085e..db8abf3f8 100644 --- a/commands_reference/upctl_server/show/index.html +++ b/commands_reference/upctl_server/show/index.html @@ -2695,6 +2695,82 @@ + +
  • + + + + + + + + + + +
    • + + + + + + + + + +
  • Changelog @@ -2770,14 +2846,14 @@

    upctl server show

    Show server details

    -
    upctl server show <UUID/Title/Hostname...> [flags]
-
    +
    upctl server show <UUID/Title/Hostname...> [flags]
+

    Examples

    -
    upctl server show 21aeb3b7-cd89-4123-a376-559b0e75be8b
-upctl server show 21aeb3b7-cd89-4123-a376-559b0e75be8b 0053a6f5-e6d1-4b0b-b9dc-b90d0894e8d0
-upctl server show myhostname
-upctl server show my_server1 my_server2
-
    +
    upctl server show 21aeb3b7-cd89-4123-a376-559b0e75be8b
+upctl server show 21aeb3b7-cd89-4123-a376-559b0e75be8b 0053a6f5-e6d1-4b0b-b9dc-b90d0894e8d0
+upctl server show myhostname
+upctl server show my_server1 my_server2
+

    Options

    • diff --git a/commands_reference/upctl_server/start/index.html b/commands_reference/upctl_server/start/index.html index a6a1d6c12..40be2aaef 100644 --- a/commands_reference/upctl_server/start/index.html +++ b/commands_reference/upctl_server/start/index.html @@ -2695,6 +2695,82 @@ + +
  • + + + + + + + + + + +
    • + + + + + + + + + +
  • Changelog @@ -2770,13 +2846,13 @@

    upctl server start

    Start a server

    -
    upctl server start <UUID/Title/Hostname...> [flags]
-
    +
    upctl server start <UUID/Title/Hostname...> [flags]
+

    Examples

    -
    upctl server start 00038afc-d526-4148-af0e-d2f1eeaded9b
-upctl server start 00038afc-d526-4148-af0e-d2f1eeaded9b 0053a6f5-e6d1-4b0b-b9dc-b90d0894e8d0
-upctl server start my_server1
-
    +
    upctl server start 00038afc-d526-4148-af0e-d2f1eeaded9b
+upctl server start 00038afc-d526-4148-af0e-d2f1eeaded9b 0053a6f5-e6d1-4b0b-b9dc-b90d0894e8d0
+upctl server start my_server1
+

    Options

    • diff --git a/commands_reference/upctl_server/stop/index.html b/commands_reference/upctl_server/stop/index.html index 732b6991b..770abf970 100644 --- a/commands_reference/upctl_server/stop/index.html +++ b/commands_reference/upctl_server/stop/index.html @@ -2695,6 +2695,82 @@ + +
  • + + + + + + + + + + +
    • + + + + + + + + + +
  • Changelog @@ -2770,14 +2846,14 @@

    upctl server stop

    Stop a server

    -
    upctl server stop <UUID/Title/Hostname...> [flags]
-
    +
    upctl server stop <UUID/Title/Hostname...> [flags]
+

    Examples

    -
    upctl server stop 00cbe2f3-4cf9-408b-afee-bd340e13cdd8
-upctl server stop 00cbe2f3-4cf9-408b-afee-bd340e13cdd8 0053a6f5-e6d1-4b0b-b9dc-b90d0894e8d0
-upctl server stop my_server
-upctl server stop --wait my_server
-
    +
    upctl server stop 00cbe2f3-4cf9-408b-afee-bd340e13cdd8
+upctl server stop 00cbe2f3-4cf9-408b-afee-bd340e13cdd8 0053a6f5-e6d1-4b0b-b9dc-b90d0894e8d0
+upctl server stop my_server
+upctl server stop --wait my_server
+

    Options

    • diff --git a/commands_reference/upctl_server/storage/attach/index.html b/commands_reference/upctl_server/storage/attach/index.html index 04dbbea73..2c731a8b1 100644 --- a/commands_reference/upctl_server/storage/attach/index.html +++ b/commands_reference/upctl_server/storage/attach/index.html @@ -2697,6 +2697,82 @@ + +
  • + + + + + + + + + + +
    • + + + + + + + + + +
  • Changelog @@ -2772,13 +2848,13 @@

    upctl server storage attach

    Attach a storage as a device to a server

    -
    upctl server storage attach <UUID/Title/Hostname...> [flags]
-
    +
    upctl server storage attach <UUID/Title/Hostname...> [flags]
+

    Examples

    -
    upctl server storage attach 00038afc-d526-4148-af0e-d2f1eeaded9b --storage 015899e0-0a68-4949-85bb-261a99de5fdd
-upctl server storage attach 00038afc-d526-4148-af0e-d2f1eeaded9b --storage 01a5568f-4766-4ce7-abf5-7d257903a735 --address virtio:2
-upctl server storage attach my_server1 --storage "My Storage"
-
    +
    upctl server storage attach 00038afc-d526-4148-af0e-d2f1eeaded9b --storage 015899e0-0a68-4949-85bb-261a99de5fdd
+upctl server storage attach 00038afc-d526-4148-af0e-d2f1eeaded9b --storage 01a5568f-4766-4ce7-abf5-7d257903a735 --address virtio:2
+upctl server storage attach my_server1 --storage "My Storage"
+

    Options

    • diff --git a/commands_reference/upctl_server/storage/detach/index.html b/commands_reference/upctl_server/storage/detach/index.html index 7aca27866..a9087dc35 100644 --- a/commands_reference/upctl_server/storage/detach/index.html +++ b/commands_reference/upctl_server/storage/detach/index.html @@ -2697,6 +2697,82 @@ + +
  • + + + + + + + + + + +
    • + + + + + + + + + +
  • Changelog @@ -2772,12 +2848,12 @@

    upctl server storage detach

    Detaches a storage resource from a server

    -
    upctl server storage detach <UUID/Title/Hostname...> [flags]
-
    +
    upctl server storage detach <UUID/Title/Hostname...> [flags]
+

    Examples

    -
    upctl server storage detach 00038afc-d526-4148-af0e-d2f1eeaded9b --address virtio:1
-upctl server storage detach my_server1 --address virtio:2
-
    +
    upctl server storage detach 00038afc-d526-4148-af0e-d2f1eeaded9b --address virtio:1
+upctl server storage detach my_server1 --address virtio:2
+

    Options

    • diff --git a/commands_reference/upctl_server/storage/index.html b/commands_reference/upctl_server/storage/index.html index ce4443642..89f285c71 100644 --- a/commands_reference/upctl_server/storage/index.html +++ b/commands_reference/upctl_server/storage/index.html @@ -2691,6 +2691,82 @@ + +
  • + + + + + + + + + + +
    • + + + + + + + + + +
  • Changelog @@ -2760,8 +2836,8 @@

    upctl server storage

    Manage server storages

    -
    upctl server storage [flags]
-
    +
    upctl server storage [flags]
+

    Options

    • diff --git a/commands_reference/upctl_servergroup/create/index.html b/commands_reference/upctl_servergroup/create/index.html index 313e0ed67..88d02909d 100644 --- a/commands_reference/upctl_servergroup/create/index.html +++ b/commands_reference/upctl_servergroup/create/index.html @@ -2695,6 +2695,82 @@ + +
  • + + + + + + + + + + +
    • + + + + + + + + + +
  • Changelog @@ -2770,24 +2846,24 @@

    upctl servergroup create

    Create a server group

    -
    upctl servergroup create [flags]
-
    +
    upctl servergroup create [flags]
+

    Examples

    -
    upctl servergroup create \
-                --title my-server-group \
-                --anti-affinity-policy yes \
-                --server 1fdfda29-ead1-4855-b71f-a432179800ab \
-                --server my-server
-upctl servergroup create \
-                --title my-server-group \
-                --anti-affinity-policy yes \
-                --label env=dev
-upctl servergroup create \
-                --title my-server-group \
-                --anti-affinity-policy strict \
-                --label env=dev \
-                --label owner=operations
-
    +
    upctl servergroup create \
+                --title my-server-group \
+                --anti-affinity-policy yes \
+                --server 1fdfda29-ead1-4855-b71f-a432179800ab \
+                --server my-server
+upctl servergroup create \
+                --title my-server-group \
+                --anti-affinity-policy yes \
+                --label env=dev
+upctl servergroup create \
+                --title my-server-group \
+                --anti-affinity-policy strict \
+                --label env=dev \
+                --label owner=operations
+

    Options

    • diff --git a/commands_reference/upctl_servergroup/delete/index.html b/commands_reference/upctl_servergroup/delete/index.html index 022c12562..486876bda 100644 --- a/commands_reference/upctl_servergroup/delete/index.html +++ b/commands_reference/upctl_servergroup/delete/index.html @@ -2695,6 +2695,82 @@ + +
  • + + + + + + + + + + +
    • + + + + + + + + + +
  • Changelog @@ -2770,12 +2846,12 @@

    upctl servergroup delete

    Delete a server group

    -
    upctl servergroup delete <UUID/Title...> [flags]
-
    +
    upctl servergroup delete <UUID/Title...> [flags]
+

    Examples

    -
    upctl servergroup delete 8abc8009-4325-4b23-4321-b1232cd81231
-upctl servergroup delete my-server-group
-
    +
    upctl servergroup delete 8abc8009-4325-4b23-4321-b1232cd81231
+upctl servergroup delete my-server-group
+

    Options

    • diff --git a/commands_reference/upctl_servergroup/index.html b/commands_reference/upctl_servergroup/index.html index 772d435c1..90ecc4338 100644 --- a/commands_reference/upctl_servergroup/index.html +++ b/commands_reference/upctl_servergroup/index.html @@ -2689,6 +2689,82 @@ + +
  • + + + + + + + + + + +
    • + + + + + + + + + +
  • Changelog @@ -2758,8 +2834,8 @@

    upctl servergroup

    Manage server groups

    -
    upctl servergroup [flags]
-
    +
    upctl servergroup [flags]
+

    Options

    • diff --git a/commands_reference/upctl_servergroup/list/index.html b/commands_reference/upctl_servergroup/list/index.html index 8558cb696..db1e7b771 100644 --- a/commands_reference/upctl_servergroup/list/index.html +++ b/commands_reference/upctl_servergroup/list/index.html @@ -2695,6 +2695,82 @@ + +
  • + + + + + + + + + + +
    • + + + + + + + + + +
  • Changelog @@ -2770,11 +2846,11 @@

    upctl servergroup list

    List current server groups

    -
    upctl servergroup list [flags]
-
    +
    upctl servergroup list [flags]
+

    Examples

    -
    upctl servergroup list
-
    +
    upctl servergroup list
+

    Options

    • diff --git a/commands_reference/upctl_servergroup/modify/index.html b/commands_reference/upctl_servergroup/modify/index.html index 05098a19c..13fb36001 100644 --- a/commands_reference/upctl_servergroup/modify/index.html +++ b/commands_reference/upctl_servergroup/modify/index.html @@ -2695,6 +2695,82 @@ + +
  • + + + + + + + + + + +
    • + + + + + + + + + +
  • Changelog @@ -2770,15 +2846,15 @@

    upctl servergroup modify

    Modify a server group

    -
    upctl servergroup modify <UUID/Title...> [flags]
-
    +
    upctl servergroup modify <UUID/Title...> [flags]
+

    Examples

    -
    upctl servergroup modify 8abc8009-4325-4b23-4321-b1232cd81231 --title your-server-group
-upctl servergroup modify my-server-group --anti-affinity-policy strict
-upctl servergroup modify my-server-group --server my-server-1 --server my-server-2 --server my-server-3-
-upctl servergroup modify 8abc8009-4325-4b23-4321-b1232cd81231 --server 0bab98e5-b327-4ab8-ba16-738d4af7578b --server my-server-2
-upctl servergroup modify my-server-group --label env=dev
-
    +
    upctl servergroup modify 8abc8009-4325-4b23-4321-b1232cd81231 --title your-server-group
+upctl servergroup modify my-server-group --anti-affinity-policy strict
+upctl servergroup modify my-server-group --server my-server-1 --server my-server-2 --server my-server-3-
+upctl servergroup modify 8abc8009-4325-4b23-4321-b1232cd81231 --server 0bab98e5-b327-4ab8-ba16-738d4af7578b --server my-server-2
+upctl servergroup modify my-server-group --label env=dev
+

    Options

    • diff --git a/commands_reference/upctl_servergroup/show/index.html b/commands_reference/upctl_servergroup/show/index.html index 02ce20302..cc52c5bef 100644 --- a/commands_reference/upctl_servergroup/show/index.html +++ b/commands_reference/upctl_servergroup/show/index.html @@ -2695,6 +2695,82 @@ + +
  • + + + + + + + + + + +
    • + + + + + + + + + +
  • Changelog @@ -2770,12 +2846,12 @@

    upctl servergroup show

    Show server group details

    -
    upctl servergroup show <UUID/Title...> [flags]
-
    +
    upctl servergroup show <UUID/Title...> [flags]
+

    Examples

    -
    upctl servergroup show 8abc8009-4325-4b23-4321-b1232cd81231
-upctl servergroup show my-server-group
-
    +
    upctl servergroup show 8abc8009-4325-4b23-4321-b1232cd81231
+upctl servergroup show my-server-group
+

    Options

    • diff --git a/commands_reference/upctl_storage/backup/create/index.html b/commands_reference/upctl_storage/backup/create/index.html index cb80ec307..98d9e627c 100644 --- a/commands_reference/upctl_storage/backup/create/index.html +++ b/commands_reference/upctl_storage/backup/create/index.html @@ -2697,6 +2697,82 @@ + +
  • + + + + + + + + + + +
    • + + + + + + + + + +
  • Changelog @@ -2772,12 +2848,12 @@

    upctl storage backup create

    Create backup of a storage

    -
    upctl storage backup create <UUID/Title...> [flags]
-
    +
    upctl storage backup create <UUID/Title...> [flags]
+

    Examples

    -
    upctl storage backup create 01cbea5e-eb5b-4072-b2ac-9b635120e5d8 --title "first backup"
-upctl storage backup create "My Storage" --title second_backup
-
    +
    upctl storage backup create 01cbea5e-eb5b-4072-b2ac-9b635120e5d8 --title "first backup"
+upctl storage backup create "My Storage" --title second_backup
+

    Options

    • diff --git a/commands_reference/upctl_storage/backup/index.html b/commands_reference/upctl_storage/backup/index.html index b28017b85..6dfbf40ae 100644 --- a/commands_reference/upctl_storage/backup/index.html +++ b/commands_reference/upctl_storage/backup/index.html @@ -2691,6 +2691,82 @@ + +
  • + + + + + + + + + + +
    • + + + + + + + + + +
  • Changelog @@ -2760,8 +2836,8 @@

    upctl storage backup

    Manage backups

    -
    upctl storage backup [flags]
-
    +
    upctl storage backup [flags]
+

    Options

    • diff --git a/commands_reference/upctl_storage/backup/restore/index.html b/commands_reference/upctl_storage/backup/restore/index.html index 1d61b25d0..89873db03 100644 --- a/commands_reference/upctl_storage/backup/restore/index.html +++ b/commands_reference/upctl_storage/backup/restore/index.html @@ -2697,6 +2697,82 @@ + +
  • + + + + + + + + + + +
    • + + + + + + + + + +
  • Changelog @@ -2772,12 +2848,12 @@

    upctl storage backup restore

    Restore backup of a storage

    -
    upctl storage backup restore <UUID/Title...> [flags]
-
    +
    upctl storage backup restore <UUID/Title...> [flags]
+

    Examples

    -
    upctl storage backup restore 01177c9e-7f76-4ce4-b128-bcaa3448f7ec
-upctl storage backup restore second_backup
-
    +
    upctl storage backup restore 01177c9e-7f76-4ce4-b128-bcaa3448f7ec
+upctl storage backup restore second_backup
+

    Options

    • diff --git a/commands_reference/upctl_storage/clone/index.html b/commands_reference/upctl_storage/clone/index.html index 6a94bbaf8..691934f78 100644 --- a/commands_reference/upctl_storage/clone/index.html +++ b/commands_reference/upctl_storage/clone/index.html @@ -2695,6 +2695,82 @@ + +
  • + + + + + + + + + + +
    • + + + + + + + + + +
  • Changelog @@ -2770,13 +2846,13 @@

    upctl storage clone

    Clone a storage

    -
    upctl storage clone <UUID/Title...> [flags]
-
    +
    upctl storage clone <UUID/Title...> [flags]
+

    Examples

    -
    upctl storage clone 015899e0-0a68-4949-85bb-261a99de5fdd --title my_storage_clone --zone fi-hel1
-upctl storage clone 015899e0-0a68-4949-85bb-261a99de5fdd --title my_storage_clone2 --zone pl-waw1  --tier maxiops
-upctl storage clone "My Storage" --title my_storage_clone3 --zone pl-waw1  --tier maxiops
-
    +
    upctl storage clone 015899e0-0a68-4949-85bb-261a99de5fdd --title my_storage_clone --zone fi-hel1
+upctl storage clone 015899e0-0a68-4949-85bb-261a99de5fdd --title my_storage_clone2 --zone pl-waw1  --tier maxiops
+upctl storage clone "My Storage" --title my_storage_clone3 --zone pl-waw1  --tier maxiops
+

    Options

    • diff --git a/commands_reference/upctl_storage/create/index.html b/commands_reference/upctl_storage/create/index.html index b51f882a1..d7e8eabf6 100644 --- a/commands_reference/upctl_storage/create/index.html +++ b/commands_reference/upctl_storage/create/index.html @@ -2695,6 +2695,82 @@ + +
  • + + + + + + + + + + +
    • + + + + + + + + + +
  • Changelog @@ -2770,12 +2846,12 @@

    upctl storage create

    Create a storage

    -
    upctl storage create [flags]
-
    +
    upctl storage create [flags]
+

    Examples

    -
    upctl storage create --zone pl-waw1 --title "My Storage"
-upctl storage create --zone pl-waw1 --title my_storage --size 20 --backup-interval wed --backup-retention 4
-
    +
    upctl storage create --zone pl-waw1 --title "My Storage"
+upctl storage create --zone pl-waw1 --title my_storage --size 20 --backup-interval wed --backup-retention 4
+

    Options

    • diff --git a/commands_reference/upctl_storage/delete/index.html b/commands_reference/upctl_storage/delete/index.html index 0f1e57886..1b0673b6c 100644 --- a/commands_reference/upctl_storage/delete/index.html +++ b/commands_reference/upctl_storage/delete/index.html @@ -2695,6 +2695,82 @@ + +
  • + + + + + + + + + + +
    • + + + + + + + + + +
  • Changelog @@ -2770,13 +2846,13 @@

    upctl storage delete

    Delete a storage

    -
    upctl storage delete <UUID/Title...> [flags]
-
    +
    upctl storage delete <UUID/Title...> [flags]
+

    Examples

    -
    upctl storage delete 01ac5319-08ac-4e7b-81e5-3140d2bbd7d8
-upctl storage delete 0175bb34-8aed-47ce-9290-10cc45f78601 01fcb78f-e73d-4e4d-af5a-0bd6cdba4306
-upctl storage delete "My Storage"
-
    +
    upctl storage delete 01ac5319-08ac-4e7b-81e5-3140d2bbd7d8
+upctl storage delete 0175bb34-8aed-47ce-9290-10cc45f78601 01fcb78f-e73d-4e4d-af5a-0bd6cdba4306
+upctl storage delete "My Storage"
+

    Options

    • diff --git a/commands_reference/upctl_storage/import/index.html b/commands_reference/upctl_storage/import/index.html index 0cfc298e0..f3f5a6f46 100644 --- a/commands_reference/upctl_storage/import/index.html +++ b/commands_reference/upctl_storage/import/index.html @@ -2695,6 +2695,82 @@ + +
  • + + + + + + + + + + +
    • + + + + + + + + + +
  • Changelog @@ -2770,11 +2846,11 @@

    upctl storage import

    Import a storage from external or local source

    -
    upctl storage import [flags]
-
    +
    upctl storage import [flags]
+

    Examples

    -
    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
-
    +
    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
+

    Options

    • diff --git a/commands_reference/upctl_storage/index.html b/commands_reference/upctl_storage/index.html index 0edfc249a..40da836ff 100644 --- a/commands_reference/upctl_storage/index.html +++ b/commands_reference/upctl_storage/index.html @@ -2689,6 +2689,82 @@ + +
  • + + + + + + + + + + +
    • + + + + + + + + + +
  • Changelog @@ -2758,8 +2834,8 @@

    upctl storage

    Manage storages

    -
    upctl storage [flags]
-
    +
    upctl storage [flags]
+

    Options

    • diff --git a/commands_reference/upctl_storage/list/index.html b/commands_reference/upctl_storage/list/index.html index 8e676453a..ba200d9c8 100644 --- a/commands_reference/upctl_storage/list/index.html +++ b/commands_reference/upctl_storage/list/index.html @@ -2695,6 +2695,82 @@ + +
  • + + + + + + + + + + +
    • + + + + + + + + + +
  • Changelog @@ -2770,12 +2846,12 @@

    upctl storage list

    List current storages

    -
    upctl storage list [flags]
-
    +
    upctl storage list [flags]
+

    Examples

    -
    upctl storage list
-upctl storage list --all
-
    +
    upctl storage list
+upctl storage list --all
+

    Options

    • diff --git a/commands_reference/upctl_storage/modify/index.html b/commands_reference/upctl_storage/modify/index.html index c692e6aec..163ee9e5d 100644 --- a/commands_reference/upctl_storage/modify/index.html +++ b/commands_reference/upctl_storage/modify/index.html @@ -2695,6 +2695,82 @@ + +
  • + + + + + + + + + + +
    • + + + + + + + + + +
  • Changelog @@ -2770,12 +2846,12 @@

    upctl storage modify

    Modify a storage

    -
    upctl storage modify <UUID/Title...> [flags]
-
    +
    upctl storage modify <UUID/Title...> [flags]
+

    Examples

    -
    upctl storage modify 01271548-2e92-44bb-9774-d282508cc762 --title "My Storage" --size 20
-upctl storage modify "My Storage" --size 25
-
    +
    upctl storage modify 01271548-2e92-44bb-9774-d282508cc762 --title "My Storage" --size 20
+upctl storage modify "My Storage" --size 25
+

    Options

    • diff --git a/commands_reference/upctl_storage/show/index.html b/commands_reference/upctl_storage/show/index.html index 8e1b36a64..853b6fd83 100644 --- a/commands_reference/upctl_storage/show/index.html +++ b/commands_reference/upctl_storage/show/index.html @@ -2695,6 +2695,82 @@ + +
  • + + + + + + + + + + +
    • + + + + + + + + + +
  • Changelog @@ -2770,13 +2846,13 @@

    upctl storage show

    Show storage details

    -
    upctl storage show <UUID/Title...> [flags]
-
    +
    upctl storage show <UUID/Title...> [flags]
+

    Examples

    -
    upctl storage show 01271548-2e92-44bb-9774-d282508cc762
-upctl storage show 01271548-2e92-44bb-9774-d282508cc762 01c60190-3a01-4108-b1c3-2e828855ccc0
-upctl storage show "My Storage"
-
    +
    upctl storage show 01271548-2e92-44bb-9774-d282508cc762
+upctl storage show 01271548-2e92-44bb-9774-d282508cc762 01c60190-3a01-4108-b1c3-2e828855ccc0
+upctl storage show "My Storage"
+

    Options

    • diff --git a/commands_reference/upctl_storage/templatise/index.html b/commands_reference/upctl_storage/templatise/index.html index 35bb80830..44bc49ca5 100644 --- a/commands_reference/upctl_storage/templatise/index.html +++ b/commands_reference/upctl_storage/templatise/index.html @@ -2695,6 +2695,82 @@ + +
  • + + + + + + + + + + +
    • + + + + + + + + + +
  • Changelog @@ -2770,13 +2846,13 @@

    upctl storage templatise

    Templatise a storage

    -
    upctl storage templatise <UUID/Title...> [flags]
-
    +
    upctl storage templatise <UUID/Title...> [flags]
+

    Examples

    -
    upctl storage templatise 01271548-2e92-44bb-9774-d282508cc762 --title "My Template"
-upctl storage templatise 01271548-2e92-44bb-9774-d282508cc762 --title "My Template" --wait
-upctl storage templatise "My Storage" --title super_template
-
    +
    upctl storage templatise 01271548-2e92-44bb-9774-d282508cc762 --title "My Template"
+upctl storage templatise 01271548-2e92-44bb-9774-d282508cc762 --title "My Template" --wait
+upctl storage templatise "My Storage" --title super_template
+

    Options

    • diff --git a/commands_reference/upctl_version/index.html b/commands_reference/upctl_version/index.html index 818150501..05c70e5ed 100644 --- a/commands_reference/upctl_version/index.html +++ b/commands_reference/upctl_version/index.html @@ -2693,6 +2693,82 @@ + +
  • + + + + + + + + + + +
    • + + + + + + + + + +
  • Changelog @@ -2768,11 +2844,11 @@

    upctl version

    Display software information

    -
    upctl version [flags]
-
    +
    upctl version [flags]
+

    Examples

    -
    upctl version
-
    +
    upctl version
+

    Options

    • diff --git a/commands_reference/upctl_zone/index.html b/commands_reference/upctl_zone/index.html index 204ba75df..fd94be5cd 100644 --- a/commands_reference/upctl_zone/index.html +++ b/commands_reference/upctl_zone/index.html @@ -2689,6 +2689,82 @@ + +
  • + + + + + + + + + + +
    • + + + + + + + + + +
  • Changelog @@ -2758,8 +2834,8 @@

    upctl zone

    Display zone information

    -
    upctl zone [flags]
-
    +
    upctl zone [flags]
+

    Options

    • diff --git a/commands_reference/upctl_zone/list/index.html b/commands_reference/upctl_zone/list/index.html index ba33f92bd..0624bdb87 100644 --- a/commands_reference/upctl_zone/list/index.html +++ b/commands_reference/upctl_zone/list/index.html @@ -2695,6 +2695,82 @@ + +
  • + + + + + + + + + + +
    • + + + + + + + + + +
  • Changelog @@ -2770,11 +2846,11 @@

    upctl zone list

    List available zones

    -
    upctl zone list [flags]
-
    +
    upctl zone list [flags]
+

    Examples

    -
    upctl zone list
-
    +
    upctl zone list
+

    Options

    • diff --git a/examples/create_a_custom_template/index.html b/examples/create_a_custom_template/index.html new file mode 100644 index 000000000..44e8038a3 --- /dev/null +++ b/examples/create_a_custom_template/index.html @@ -0,0 +1,2864 @@ + + + + + + + + + + + + + + + + + + + + Create a custom template - UpCloud command-line client + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + + +
    + + +
    + +
    + + + + + + +
    +
    + + + +
    +
    +
    + + + + +
    +
    +
    + + + +
    +
    +
    + + + +
    +
    +
    + + + +
    +
    + + + + +

    Create a custom template

    +

    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-
+
    +

    First, we will create server which disk will be used as a source for the custom template.

    +
    # Create ssh-key into current working directory
+ssh-keygen -t ed25519 -q -f "./id_ed25519" -N ""
+
+upctl server create \
+    --hostname ${prefix}source-server \
+    --zone pl-waw1 \
+    --ssh-keys ./id_ed25519.pub \
+    --network type=public \
+    --network type=utility \
+    --wait
+
    +

    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
+
    +

    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 \
+    | jq -r ".storage[0].uuid"
+
    +

    Now we are ready for creating the template.

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

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

    +
    upctl server delete ${prefix}source-server --delete-storages
+
    +

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

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

    Finally, we can cleanup the created resources.

    +
    upctl server stop --type hard --wait ${prefix}server
+upctl server delete ${prefix}server --delete-storages
+upctl storage delete ${prefix}template
+
    + + + + + + +
    +
    + + +
    + +
    + + + + + +
    +
    +
    +
    + + + + + + + + + + \ No newline at end of file diff --git a/examples/create_and_ssh_into_a_server/index.html b/examples/create_and_ssh_into_a_server/index.html new file mode 100644 index 000000000..5a242ea19 --- /dev/null +++ b/examples/create_and_ssh_into_a_server/index.html @@ -0,0 +1,2849 @@ + + + + + + + + + + + + + + + + + + + + Create and ssh into a server - UpCloud command-line client + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + + +
    + + +
    + +
    + + + + + + +
    +
    + + + +
    +
    +
    + + + + +
    +
    +
    + + + +
    +
    +
    + + + +
    +
    +
    + + + +
    +
    + + + + +

    Create and ssh into a server

    +

    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-
+
    +

    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
+ssh-keygen -t ed25519 -q -f "./id_ed25519" -N ""
+
    +

    Create a server using the above created ssh-key as login method.

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

    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
+ip=$(upctl server show ${prefix}server -o json | jq -r '.networking.interfaces[] | select(.type == "public") | .ip_addresses[0].address')
+
+# Wait for a moment for the ssh server to become available
+sleep 15
+
+ssh -i id_ed25519 -o StrictHostKeyChecking=accept-new root@$ip "hostname"
+
    +

    Finally, we can cleanup the created resources.

    +
    upctl server stop --type hard --wait ${prefix}server
+upctl server delete ${prefix}server --delete-storages
+
    + + + + + + +
    +
    + + +
    + +
    + + + + + +
    +
    +
    +
    + + + + + + + + + + \ No newline at end of file diff --git a/examples/index.html b/examples/index.html new file mode 100644 index 000000000..6a7f71eb7 --- /dev/null +++ b/examples/index.html @@ -0,0 +1,2808 @@ + + + + + + + + + + + + + + + + + + + + Examples - UpCloud command-line client + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + + +
    + + +
    + +
    + + + + + + +
    +
    + + + +
    +
    +
    + + + + +
    +
    +
    + + + +
    +
    +
    + + + +
    +
    +
    + + + +
    +
    + + + + +

    Examples

    +

    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.

    + + + + + + +
    +
    + + +
    + +
    + + + + + +
    +
    +
    +
    + + + + + + + + + + \ No newline at end of file diff --git a/examples/possible_exit_codes/index.html b/examples/possible_exit_codes/index.html new file mode 100644 index 000000000..e7da545ee --- /dev/null +++ b/examples/possible_exit_codes/index.html @@ -0,0 +1,2845 @@ + + + + + + + + + + + + + + + + + + + + Possible exit codes - UpCloud command-line client + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + + +
    + + +
    + +
    + + + + + + +
    +
    + + + +
    +
    +
    + + + + +
    +
    +
    + + + +
    +
    +
    + + + +
    +
    +
    + + + +
    +
    + + + + +

    Possible exit codes

    +

    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-
+
    +

    Exit code 100 is set, for example, when command argument validation fails.

    +
    upctl server create
+# Error: required flag(s) "hostname", "zone" not set
+
    +

    Let's create two server and stop one of those to later see other failing exit codes. These command should succceed, and thus return zero exit code.

    +
    # Create ssh-key into current working directory
+ssh-keygen -t ed25519 -q -f "./id_ed25519" -N ""
+
+upctl server create --hostname ${prefix}vm-1 --zone pl-waw1 --ssh-keys ./id_ed25519.pub --wait
+upctl server create --hostname ${prefix}vm-2 --zone pl-waw1 --ssh-keys ./id_ed25519.pub --wait
+
+upctl server stop ${prefix}vm-1 --wait
+
    +

    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 ${prefix}vm-1 ${prefix}vm-2 --wait
+
    +

    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 ${prefix}vm-1 ${prefix}vm-2 --wait
+
    +

    Finally, we can cleanup the created resources.

    +
    upctl server delete ${prefix}vm-1 ${prefix}vm-2 --delete-storages
+
    + + + + + + +
    +
    + + +
    + +
    + + + + + +
    +
    +
    +
    + + + + + + + + + + \ No newline at end of file diff --git a/index.html b/index.html index 48ac87760..5767d3501 100644 --- a/index.html +++ b/index.html @@ -2643,6 +2643,82 @@ + +
  • + + + + + + + + + + +
    • + + + + + + + + + +
  • Changelog diff --git a/search/search_index.json b/search/search_index.json index 7a3460b32..4d325e9bb 100644 --- a/search/search_index.json +++ b/search/search_index.json @@ -1 +1 @@ -{"config":{"indexing":"full","lang":["en"],"min_search_length":3,"prebuild_index":false,"separator":"[\\s\\-]+"},"docs":[{"location":"","text":"Getting started upctl provides a command-line interface to UpCloud services. It allows you to control your resources from the command line or any compatible interface.","title":"Getting started"},{"location":"#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.","title":"Getting started"},{"location":"changelog/","text":"Changelog 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 . Unreleased Added Add backend TLS configs field to loadbalancer show command 3.2.0 - 2023-11-15 Added Add objectstorage commands ( delete , list , show ) for Managed object storage management 3.1.0 - 2023-11-06 Added Add network_peerings , ntp_excess_gib , storage_maxiops and load_balancers fields to account show outputs. Add --version parameter to kubernetes create and version field to kubernetes show output. Changed Breaking : Update return type of kubernetes versions from list of strings to list of objects. (No major version bump, because this end-point has not been included in the API docs) Fixed Use correct currency symbol, \u20ac instead of $ , in human output of account show . 3.0.0 - 2023-10-18 This release updates output of show and list commands to return the API response as defined in the UpCloud Go SDK. See below for detailed list of changes. In addition, kubernetes create will now, by default, block all access to the cluster. To be able to connect to the cluster, define list of allowed IP addresses and/or CIDR blocks or allow access from any IP. Added Breaking : Add --kubernetes-api-allow-ip argument to kubernetes create command. This changes default behavior from allow access from any IP to block access from all IPs . To be able to connect to the cluster, define list of allowed IP addresses and/or CIDR blocks or allow access from any IP. Add Kubernetes API allowed IPs field to kubernetes show output. Add kubernetes nodegroup show for displaying node-group details. This also adds Nodes table and Anti-affinity field that were not available in previous kubernetes show output. Add kubernetes modify command for modifying IP addresses that are allowed to access cluster's Kubernetes API. Add Kubernetes API allowed IPs field to kubernetes show output. Add database session list for listing active database sessions. Add database session cancel for cancelling an active database session. Changed Breaking : In JSON and YAML output of database list : return the full API response. Value of title is not replaced with value from name , if title is empty. Breaking : In JSON and YAML output of database types : return the full API response. This changes the top level datatype from list to object, where keys are the available database type, e.g., pg and mysql . Breaking : In JSON and YAML output of ip-address list : return the full API response. This changes partofplan key to part_of_plan and ptrrecord key to ptr_record . The top level data-type changes from list to object. Breaking : In JSON and YAML output of loadbalancer list : return the full API response. This changes state field to operational_state . Breaking : In JSON and YAML output of network list and network show : return the full API response. Servers list will only contain server UUID and name. In network list output, the top level data-type changes from list to object. Breaking : In JSON and YAML output of server list and server show : return the full API response. This changes field host_id to host . nics is replaced with networking subfield interfaces . storage is replaced with storage_devices . labels contain subfield label which in turn contains the labels. In server list output, the top level data-type changes from list to object. Breaking : In JSON and YAML output of server firewall show : return the full API response. This removes fields destination and source fields in favor of [destination|source]_address_start , [destination|source]_address_end , [destination|source]_port_start and [destination|source]_port_end . Breaking : In JSON and YAML output of server plans : return the full API response. The top level data-type changes from list to object. Breaking : In JSON and YAML output of storage list and storage show : return the full API response. This changes servers field to contain server field, which in turn contains the servers. labels field will not be outputted if empty. In storage list output, the top level data-type changes from list to object. Breaking : In JSON and YAML output of zone list : return the full API response. The top level data-type changes from list to object. In JSON and YAML output of kubernetes list : return the full API response. In human readable output of kubernetes show command, show node-groups as table. Node-group details are available with kubernetes nodegroup show command. Fixed Breaking : In JSON and YAML output of ip-address show : use same JSON keys as in API documentation. This removes credits key that was used in place of floating . Removed Breaking : Remove database connection list and database connection cancel commands in favor of database session counterparts Breaking : In JSON and YAML output of database properties * show : pass-through the API response. This removes key field from the output. 2.10.0 - 2023-07-17 Added Add --disable-utility-network-access for kubernetes nodegroup create command Fixed Use pending color (yellow) for kubernetes node group scaling-down and scaling-up states 2.9.1 - 2023-07-06 Changed Release artifacts to follow package naming conventions provided by nFPM . `` upcloud-cli-2.9.0_x86_64.rpm vs upcloud-cli-2.9.1.x86_64.rpm # no convention changes upcloud-cli-2.9.0_arm64.rpm vs upcloud-cli-2.9.1.aarch64.rpm # arm64 -> aarch64` upcloud-cli-2.9.0_amd64.apk vs upcloud-cli_2.9.1_x86_64.apk # cli- -> cli_ & amd64 -> x86_64 upcloud-cli-2.9.0_arm64.apk vs upcloud-cli_2.9.1_aarch64.apk # cli- -> cli_ & arm64 -> aarch64 upcloud-cli-2.9.0_amd64.deb vs upcloud-cli_2.9.1_amd64.deb # cli- -> cli_ upcloud-cli-2.9.0_arm64.deb vs upcloud-cli_2.9.1_arm64.deb # cli- -> cli_ ``` 2.9.0 - 2023-06-30 Added Add servergroup commands ( create , delete , list , modify , show ) for server group management 2.8.0 - 2023-06-21 Added Add support for OpenSearch database type Add database index list and database index commands for managing OpenSearch database indices Add completions for --zone arguments. Add --private-node-groups argument to kubernetes create command. Add Private node groups field to kubernetes show output. Add --label flag to server create and server modify commands 2.7.1 - 2023-05-16 Fixed Updated examples of kubernetes create command to use valid plans. 2.7.0 - 2023-05-02 Added Add ip and net as aliases to ip-address and network commands, respectively. Add Labels table to loadbalancer show , network show , router show , server show , and storage show outputs. Add kubernetes plans command for listing available plans. Add --plan argument to kubernetes create command for selecting cluster plan. Add --wait flag to kubernetes create command for waiting created cluster to reach running state. 2.6.0 - 2023-03-14 Added The upctl container image now includes jq tool for parsing values from JSON output. Add node-group states to kubernetes show output. Add completions for --network argument of kubernetes create and server network-interface create . Support also network name as input for --network argument of kubernetes create and server network-interface create Changed Completions will now only suggest private networks as arguments because names or UUIDs of public or utility networks are often not valid arguments. 2.5.0 - 2023-02-15 Added Print warning about unknown resource state before exiting when execution is interrupted with SIGINT. Add kubernetes nodegroup create , kubernetes nodegroup scale , and kubernetes nodegroup delete commands (EXPERIMENTAL) Added support for all shell completions provided by cobra . Add database properties command to list database properties for given database type and database properties show command to show database property details. Changed Remove custom bash completion logic and replace it with completion command provided by cobra . To do this while supporting args with whitespace, whitespace in completions is replaced with non-breaking spaces. Fixed In database show : parse database version from metadata instead of properties. This enables displaying redis version instead of . 2.4.0 - 2022-12-19 Added Add kubernetes create , kubernetes config , kubernetes delete , kubernetes list , kubernetes show , kubernetes versions commands (EXPERIMENTAL) Add loadbalancer plans command for listing available LB plans 2.3.0 - 2022-11-11 Added Complete available types for database plans . Suppress positional argument filename completion for commands without specific completions. In database list output: if database has no title, database name is displayed in the title cell instead of leaving the cell empty, similarly than in the hub. Version information is parsed from BuildInfo when upctl binary was built without specifying -ldflags to define value for .../config.Version . Use alpine as base image for upcloud/upctl container image. This adds sh and other OS tools to the image and thus makes it more suitable for usage in CI systems. Fixed Remove debug leftover print from IP address completions. Added /v2 postfix to module name in go.mod , this enables installing v2 versions of CLI with go install . 2.2.0 - 2022-10-17 Added Include runtime operating system and architecture in version command output. Include instructions for defining credentials and API access in upctl --help output. Fixed Fix commands in server delete usage examples. Tune human output so that normal output is directed to stdout . Progess and error messages are still outputted to stderr . 2.1.0 - 2022-09-07 Added Add --wait flag to storage import and storage templatise commands to wait until storage is in online state. In JSON and YAML output of storage import : information on target storage is now available under storage key. Fixed In human output of storage list : capitalize zone column header and color storage state similarly than in storage show . In human output of storage import : output UUID of created storage, instead of storage import operation. No UUID is outputted if existing storage was used. 2.0.0 - 2022-08-30 Added Add database delete command. Add loadbalancer delete command. Add Access field to storage show output. Add fields argument and resource to JSON and YAML error outputs. Changed Breaking : Human output, including errors, is written to stderr instead of stdout. Refactor progress logging. This changes the appearance of progress logs. See UpCloudLtd / progress for the new implementation. Fixed Breaking : Set non-zero exit code if command execution fails. Breaking : Render servers IP addresses as array of objects, instead of previous pretty-printed string, in JSON and YAML outputs of server show . Breaking : Use key names from json field tag also in YAML output to have equal key names in JSON and YAML outputs. For example, bootorder key in server details will now be boot_order also in YAML output. As a side-effect data-types are limited to those supported by JSON. For example, timestamps will be presented as (double-quoted) strings. In addition, if command targets multiple resources, YAML output will now be a list, similarly than in JSON output, instead of previous multiple YAML documents. Breaking : In JSON and YAML output, storage show lists attached servers in servers list instead of server string. Breaking : In JSON and YAML output, network show lists DHCP DNS values in list instead of string. On network show , output server details as unknown instead of outputting an error, if fetching server details fails. This allows displaying network details for networks that contain a load balancer. Progress logging to non TTY output uses now 100 as text width instead of 0. 1.5.1 - 2022-07-15 Fixed On server create , mount OS disk by default on virtio bus. Previously default OS storage address was not explicit and varyed depending on template type. Disable colors if user has set NO_COLOR environment variable to non-empty value. 1.5.0 - 2022-07-05 Added Add --show-ip-addresses flag to server list command to optionally include IP addresses in command output. Add database connection list , database connection cancel , database start , and database stop commands. Changed Make --family parameter of server firewall create command optional to allow editing the default rules. Update cobra to v1.5.0 and refactor required flag validation code. This affects validation error messages. Fixed Complete shell input with uppercase letters (e.g., Cap to CapitalizedName will now work) Display UUID of created template in storage templatise output. 1.4.0 - 2022-06-15 Added Add database list , database show , database plans , and database types commands. Add loadbalancer list and loadbalancer show commands. Add db and lb aliases to database and loadbalancer , respectively. Changed Color server state in server list output similarly than in server show output. Update Go version to 1.18 Update upcloud-go-api to v4.8.0 1.3.0 - 2022-05-17 Added Add zone list command that lists available zones. Add --wait flag to server create and server stop commands to wait until server is in started and stopped state, respectively. Changed Update upcloud-go-api to v4.5.2 Fixed Do not display usage if execution fails because of missing credentials Mark error and warning livelogs finished when they will not be updated anymore: this stops the timer in the end of the row and stops livelog from refreshing these lines. 1.2.0 - 2022-04-29 Added Include UUID (or address) of created resource in create command output storage modify command now accepts enable-filesystem-autoresize flag. When that flag is set upctl will attempt to resize partition and filesystem after storage size has been modified. Changed New go-api version v4.5.0 Fixed Improved errors relating to argument resolver failures Print version info, instead of missing credentials error, when runnning upctl version without credentials Disable colors when outputting in JSON or YAML format Display both public and private addresses in server create output Render livelog messages of commands which execution takes less than render tick interval 1.1.3 - 2022-02-24 Changed Update documentation Fixed Fix storage command attached-to-server key overrides zone 1.1.2 - 2022-01-21 Fixed New release with no changes to fix the Homebrew deprecation notice 1.1.1 - 2021-09-30 Changed Change password creation to be disabled by default in server creation Always create a password when password delivery method is chosen 1.1.0 - 2021-06-03 Added Debug mode for finding root causes to problems Docker image and upload to Docker Hub Autogenerated documentation under /docs Terminal width handling Changed Global flags for colors refactored to --force-colour and --no-colour New go-api version Improved error messages Fixes No coloring of texts if stdout is not a terminal Detaching routers works now with the new --detach-router parameter in network modify 1.0.0 - 2021-04-16 First non-beta release! Includes all previous changes and fixes. 0.6.0 - 2021-04-16 Changed Use goreleaser for releasing packages Move creation of service outside runcommand to facilitate testing Fixes fix(pre-commit): add missing golangci config file fix(root): use default cobra behavious when called 0.5.0 - 2021-04-14 Initial public beta release :tada: Added Added commands for managing server firewall rules Fixed Shell auto-completion fixed Changed Input & output handling rewritten Several help text fixes & changes Default OS changed to Ubuntu 20.04 Defaults for networks / routers in line with storages, so we'll show users' own resources by default 0.1.1 - 2021-03-12 Fixed Load config files from the correct place on Windows Fix storage import failing on readerCounter not implementing io.Reader 0.1.0 - 2021-03-10 Added Current feature set added! First internal release","title":"Changelog"},{"location":"changelog/#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 .","title":"Changelog"},{"location":"changelog/#unreleased","text":"","title":"Unreleased"},{"location":"changelog/#added","text":"Add backend TLS configs field to loadbalancer show command","title":"Added"},{"location":"changelog/#320-2023-11-15","text":"","title":"3.2.0 - 2023-11-15"},{"location":"changelog/#added_1","text":"Add objectstorage commands ( delete , list , show ) for Managed object storage management","title":"Added"},{"location":"changelog/#310-2023-11-06","text":"","title":"3.1.0 - 2023-11-06"},{"location":"changelog/#added_2","text":"Add network_peerings , ntp_excess_gib , storage_maxiops and load_balancers fields to account show outputs. Add --version parameter to kubernetes create and version field to kubernetes show output.","title":"Added"},{"location":"changelog/#changed","text":"Breaking : Update return type of kubernetes versions from list of strings to list of objects. (No major version bump, because this end-point has not been included in the API docs)","title":"Changed"},{"location":"changelog/#fixed","text":"Use correct currency symbol, \u20ac instead of $ , in human output of account show .","title":"Fixed"},{"location":"changelog/#300-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.","title":"3.0.0 - 2023-10-18"},{"location":"changelog/#added_3","text":"Breaking : Add --kubernetes-api-allow-ip argument to kubernetes create command. This changes default behavior from allow access from any IP to block access from all IPs . To be able to connect to the cluster, define list of allowed IP addresses and/or CIDR blocks or allow access from any IP. Add Kubernetes API allowed IPs field to kubernetes show output. Add kubernetes nodegroup show for displaying node-group details. This also adds Nodes table and Anti-affinity field that were not available in previous kubernetes show output. Add kubernetes modify command for modifying IP addresses that are allowed to access cluster's Kubernetes API. Add Kubernetes API allowed IPs field to kubernetes show output. Add database session list for listing active database sessions. Add database session cancel for cancelling an active database session.","title":"Added"},{"location":"changelog/#changed_1","text":"Breaking : In JSON and YAML output of database list : return the full API response. Value of title is not replaced with value from name , if title is empty. Breaking : In JSON and YAML output of database types : return the full API response. This changes the top level datatype from list to object, where keys are the available database type, e.g., pg and mysql . Breaking : In JSON and YAML output of ip-address list : return the full API response. This changes partofplan key to part_of_plan and ptrrecord key to ptr_record . The top level data-type changes from list to object. Breaking : In JSON and YAML output of loadbalancer list : return the full API response. This changes state field to operational_state . Breaking : In JSON and YAML output of network list and network show : return the full API response. Servers list will only contain server UUID and name. In network list output, the top level data-type changes from list to object. Breaking : In JSON and YAML output of server list and server show : return the full API response. This changes field host_id to host . nics is replaced with networking subfield interfaces . storage is replaced with storage_devices . labels contain subfield label which in turn contains the labels. In server list output, the top level data-type changes from list to object. Breaking : In JSON and YAML output of server firewall show : return the full API response. This removes fields destination and source fields in favor of [destination|source]_address_start , [destination|source]_address_end , [destination|source]_port_start and [destination|source]_port_end . Breaking : In JSON and YAML output of server plans : return the full API response. The top level data-type changes from list to object. Breaking : In JSON and YAML output of storage list and storage show : return the full API response. This changes servers field to contain server field, which in turn contains the servers. labels field will not be outputted if empty. In storage list output, the top level data-type changes from list to object. Breaking : In JSON and YAML output of zone list : return the full API response. The top level data-type changes from list to object. In JSON and YAML output of kubernetes list : return the full API response. In human readable output of kubernetes show command, show node-groups as table. Node-group details are available with kubernetes nodegroup show command.","title":"Changed"},{"location":"changelog/#fixed_1","text":"Breaking : In JSON and YAML output of ip-address show : use same JSON keys as in API documentation. This removes credits key that was used in place of floating .","title":"Fixed"},{"location":"changelog/#removed","text":"Breaking : Remove database connection list and database connection cancel commands in favor of database session counterparts Breaking : In JSON and YAML output of database properties * show : pass-through the API response. This removes key field from the output.","title":"Removed"},{"location":"changelog/#2100-2023-07-17","text":"","title":"2.10.0 - 2023-07-17"},{"location":"changelog/#added_4","text":"Add --disable-utility-network-access for kubernetes nodegroup create command","title":"Added"},{"location":"changelog/#fixed_2","text":"Use pending color (yellow) for kubernetes node group scaling-down and scaling-up states","title":"Fixed"},{"location":"changelog/#291-2023-07-06","text":"","title":"2.9.1 - 2023-07-06"},{"location":"changelog/#changed_2","text":"Release artifacts to follow package naming conventions provided by nFPM . `` upcloud-cli-2.9.0_x86_64.rpm vs upcloud-cli-2.9.1.x86_64.rpm # no convention changes upcloud-cli-2.9.0_arm64.rpm vs upcloud-cli-2.9.1.aarch64.rpm # arm64 -> aarch64` upcloud-cli-2.9.0_amd64.apk vs upcloud-cli_2.9.1_x86_64.apk # cli- -> cli_ & amd64 -> x86_64 upcloud-cli-2.9.0_arm64.apk vs upcloud-cli_2.9.1_aarch64.apk # cli- -> cli_ & arm64 -> aarch64 upcloud-cli-2.9.0_amd64.deb vs upcloud-cli_2.9.1_amd64.deb # cli- -> cli_ upcloud-cli-2.9.0_arm64.deb vs upcloud-cli_2.9.1_arm64.deb # cli- -> cli_ ```","title":"Changed"},{"location":"changelog/#290-2023-06-30","text":"","title":"2.9.0 - 2023-06-30"},{"location":"changelog/#added_5","text":"Add servergroup commands ( create , delete , list , modify , show ) for server group management","title":"Added"},{"location":"changelog/#280-2023-06-21","text":"","title":"2.8.0 - 2023-06-21"},{"location":"changelog/#added_6","text":"Add support for OpenSearch database type Add database index list and database index commands for managing OpenSearch database indices Add completions for --zone arguments. Add --private-node-groups argument to kubernetes create command. Add Private node groups field to kubernetes show output. Add --label flag to server create and server modify commands","title":"Added"},{"location":"changelog/#271-2023-05-16","text":"","title":"2.7.1 - 2023-05-16"},{"location":"changelog/#fixed_3","text":"Updated examples of kubernetes create command to use valid plans.","title":"Fixed"},{"location":"changelog/#270-2023-05-02","text":"","title":"2.7.0 - 2023-05-02"},{"location":"changelog/#added_7","text":"Add ip and net as aliases to ip-address and network commands, respectively. Add Labels table to loadbalancer show , network show , router show , server show , and storage show outputs. Add kubernetes plans command for listing available plans. Add --plan argument to kubernetes create command for selecting cluster plan. Add --wait flag to kubernetes create command for waiting created cluster to reach running state.","title":"Added"},{"location":"changelog/#260-2023-03-14","text":"","title":"2.6.0 - 2023-03-14"},{"location":"changelog/#added_8","text":"The upctl container image now includes jq tool for parsing values from JSON output. Add node-group states to kubernetes show output. Add completions for --network argument of kubernetes create and server network-interface create . Support also network name as input for --network argument of kubernetes create and server network-interface create","title":"Added"},{"location":"changelog/#changed_3","text":"Completions will now only suggest private networks as arguments because names or UUIDs of public or utility networks are often not valid arguments.","title":"Changed"},{"location":"changelog/#250-2023-02-15","text":"","title":"2.5.0 - 2023-02-15"},{"location":"changelog/#added_9","text":"Print warning about unknown resource state before exiting when execution is interrupted with SIGINT. Add kubernetes nodegroup create , kubernetes nodegroup scale , and kubernetes nodegroup delete commands (EXPERIMENTAL) Added support for all shell completions provided by cobra . Add database properties command to list database properties for given database type and database properties show command to show database property details.","title":"Added"},{"location":"changelog/#changed_4","text":"Remove custom bash completion logic and replace it with completion command provided by cobra . To do this while supporting args with whitespace, whitespace in completions is replaced with non-breaking spaces.","title":"Changed"},{"location":"changelog/#fixed_4","text":"In database show : parse database version from metadata instead of properties. This enables displaying redis version instead of .","title":"Fixed"},{"location":"changelog/#240-2022-12-19","text":"","title":"2.4.0 - 2022-12-19"},{"location":"changelog/#added_10","text":"Add kubernetes create , kubernetes config , kubernetes delete , kubernetes list , kubernetes show , kubernetes versions commands (EXPERIMENTAL) Add loadbalancer plans command for listing available LB plans","title":"Added"},{"location":"changelog/#230-2022-11-11","text":"","title":"2.3.0 - 2022-11-11"},{"location":"changelog/#added_11","text":"Complete available types for database plans . Suppress positional argument filename completion for commands without specific completions. In database list output: if database has no title, database name is displayed in the title cell instead of leaving the cell empty, similarly than in the hub. Version information is parsed from BuildInfo when upctl binary was built without specifying -ldflags to define value for .../config.Version . Use alpine as base image for upcloud/upctl container image. This adds sh and other OS tools to the image and thus makes it more suitable for usage in CI systems.","title":"Added"},{"location":"changelog/#fixed_5","text":"Remove debug leftover print from IP address completions. Added /v2 postfix to module name in go.mod , this enables installing v2 versions of CLI with go install .","title":"Fixed"},{"location":"changelog/#220-2022-10-17","text":"","title":"2.2.0 - 2022-10-17"},{"location":"changelog/#added_12","text":"Include runtime operating system and architecture in version command output. Include instructions for defining credentials and API access in upctl --help output.","title":"Added"},{"location":"changelog/#fixed_6","text":"Fix commands in server delete usage examples. Tune human output so that normal output is directed to stdout . Progess and error messages are still outputted to stderr .","title":"Fixed"},{"location":"changelog/#210-2022-09-07","text":"","title":"2.1.0 - 2022-09-07"},{"location":"changelog/#added_13","text":"Add --wait flag to storage import and storage templatise commands to wait until storage is in online state. In JSON and YAML output of storage import : information on target storage is now available under storage key.","title":"Added"},{"location":"changelog/#fixed_7","text":"In human output of storage list : capitalize zone column header and color storage state similarly than in storage show . In human output of storage import : output UUID of created storage, instead of storage import operation. No UUID is outputted if existing storage was used.","title":"Fixed"},{"location":"changelog/#200-2022-08-30","text":"","title":"2.0.0 - 2022-08-30"},{"location":"changelog/#added_14","text":"Add database delete command. Add loadbalancer delete command. Add Access field to storage show output. Add fields argument and resource to JSON and YAML error outputs.","title":"Added"},{"location":"changelog/#changed_5","text":"Breaking : Human output, including errors, is written to stderr instead of stdout. Refactor progress logging. This changes the appearance of progress logs. See UpCloudLtd / progress for the new implementation.","title":"Changed"},{"location":"changelog/#fixed_8","text":"Breaking : Set non-zero exit code if command execution fails. Breaking : Render servers IP addresses as array of objects, instead of previous pretty-printed string, in JSON and YAML outputs of server show . Breaking : Use key names from json field tag also in YAML output to have equal key names in JSON and YAML outputs. For example, bootorder key in server details will now be boot_order also in YAML output. As a side-effect data-types are limited to those supported by JSON. For example, timestamps will be presented as (double-quoted) strings. In addition, if command targets multiple resources, YAML output will now be a list, similarly than in JSON output, instead of previous multiple YAML documents. Breaking : In JSON and YAML output, storage show lists attached servers in servers list instead of server string. Breaking : In JSON and YAML output, network show lists DHCP DNS values in list instead of string. On network show , output server details as unknown instead of outputting an error, if fetching server details fails. This allows displaying network details for networks that contain a load balancer. Progress logging to non TTY output uses now 100 as text width instead of 0.","title":"Fixed"},{"location":"changelog/#151-2022-07-15","text":"","title":"1.5.1 - 2022-07-15"},{"location":"changelog/#fixed_9","text":"On server create , mount OS disk by default on virtio bus. Previously default OS storage address was not explicit and varyed depending on template type. Disable colors if user has set NO_COLOR environment variable to non-empty value.","title":"Fixed"},{"location":"changelog/#150-2022-07-05","text":"","title":"1.5.0 - 2022-07-05"},{"location":"changelog/#added_15","text":"Add --show-ip-addresses flag to server list command to optionally include IP addresses in command output. Add database connection list , database connection cancel , database start , and database stop commands.","title":"Added"},{"location":"changelog/#changed_6","text":"Make --family parameter of server firewall create command optional to allow editing the default rules. Update cobra to v1.5.0 and refactor required flag validation code. This affects validation error messages.","title":"Changed"},{"location":"changelog/#fixed_10","text":"Complete shell input with uppercase letters (e.g., Cap to CapitalizedName will now work) Display UUID of created template in storage templatise output.","title":"Fixed"},{"location":"changelog/#140-2022-06-15","text":"","title":"1.4.0 - 2022-06-15"},{"location":"changelog/#added_16","text":"Add database list , database show , database plans , and database types commands. Add loadbalancer list and loadbalancer show commands. Add db and lb aliases to database and loadbalancer , respectively.","title":"Added"},{"location":"changelog/#changed_7","text":"Color server state in server list output similarly than in server show output. Update Go version to 1.18 Update upcloud-go-api to v4.8.0","title":"Changed"},{"location":"changelog/#130-2022-05-17","text":"","title":"1.3.0 - 2022-05-17"},{"location":"changelog/#added_17","text":"Add zone list command that lists available zones. Add --wait flag to server create and server stop commands to wait until server is in started and stopped state, respectively.","title":"Added"},{"location":"changelog/#changed_8","text":"Update upcloud-go-api to v4.5.2","title":"Changed"},{"location":"changelog/#fixed_11","text":"Do not display usage if execution fails because of missing credentials Mark error and warning livelogs finished when they will not be updated anymore: this stops the timer in the end of the row and stops livelog from refreshing these lines.","title":"Fixed"},{"location":"changelog/#120-2022-04-29","text":"","title":"1.2.0 - 2022-04-29"},{"location":"changelog/#added_18","text":"Include UUID (or address) of created resource in create command output storage modify command now accepts enable-filesystem-autoresize flag. When that flag is set upctl will attempt to resize partition and filesystem after storage size has been modified.","title":"Added"},{"location":"changelog/#changed_9","text":"New go-api version v4.5.0","title":"Changed"},{"location":"changelog/#fixed_12","text":"Improved errors relating to argument resolver failures Print version info, instead of missing credentials error, when runnning upctl version without credentials Disable colors when outputting in JSON or YAML format Display both public and private addresses in server create output Render livelog messages of commands which execution takes less than render tick interval","title":"Fixed"},{"location":"changelog/#113-2022-02-24","text":"","title":"1.1.3 - 2022-02-24"},{"location":"changelog/#changed_10","text":"Update documentation","title":"Changed"},{"location":"changelog/#fixed_13","text":"Fix storage command attached-to-server key overrides zone","title":"Fixed"},{"location":"changelog/#112-2022-01-21","text":"","title":"1.1.2 - 2022-01-21"},{"location":"changelog/#fixed_14","text":"New release with no changes to fix the Homebrew deprecation notice","title":"Fixed"},{"location":"changelog/#111-2021-09-30","text":"","title":"1.1.1 - 2021-09-30"},{"location":"changelog/#changed_11","text":"Change password creation to be disabled by default in server creation Always create a password when password delivery method is chosen","title":"Changed"},{"location":"changelog/#110-2021-06-03","text":"","title":"1.1.0 - 2021-06-03"},{"location":"changelog/#added_19","text":"Debug mode for finding root causes to problems Docker image and upload to Docker Hub Autogenerated documentation under /docs Terminal width handling","title":"Added"},{"location":"changelog/#changed_12","text":"Global flags for colors refactored to --force-colour and --no-colour New go-api version Improved error messages","title":"Changed"},{"location":"changelog/#fixes","text":"No coloring of texts if stdout is not a terminal Detaching routers works now with the new --detach-router parameter in network modify","title":"Fixes"},{"location":"changelog/#100-2021-04-16","text":"First non-beta release! Includes all previous changes and fixes.","title":"1.0.0 - 2021-04-16"},{"location":"changelog/#060-2021-04-16","text":"","title":"0.6.0 - 2021-04-16"},{"location":"changelog/#changed_13","text":"Use goreleaser for releasing packages Move creation of service outside runcommand to facilitate testing","title":"Changed"},{"location":"changelog/#fixes_1","text":"fix(pre-commit): add missing golangci config file fix(root): use default cobra behavious when called","title":"Fixes"},{"location":"changelog/#050-2021-04-14","text":"Initial public beta release :tada:","title":"0.5.0 - 2021-04-14"},{"location":"changelog/#added_20","text":"Added commands for managing server firewall rules","title":"Added"},{"location":"changelog/#fixed_15","text":"Shell auto-completion fixed","title":"Fixed"},{"location":"changelog/#changed_14","text":"Input & output handling rewritten Several help text fixes & changes Default OS changed to Ubuntu 20.04 Defaults for networks / routers in line with storages, so we'll show users' own resources by default","title":"Changed"},{"location":"changelog/#011-2021-03-12","text":"","title":"0.1.1 - 2021-03-12"},{"location":"changelog/#fixed_16","text":"Load config files from the correct place on Windows Fix storage import failing on readerCounter not implementing io.Reader","title":"Fixed"},{"location":"changelog/#010-2021-03-10","text":"","title":"0.1.0 - 2021-03-10"},{"location":"changelog/#added_21","text":"Current feature set added! First internal release","title":"Added"},{"location":"commands_reference/upctl/","text":"upctl UpCloud command-line interface upctl provides a command-line interface to UpCloud services. It allows you to control your resources from the command line or any compatible interface. To be able to manage your UpCLoud resources, you need to configure credentials for upctl 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. Options Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --help , -h help for upctl Default: false --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human Related commands Command Description upctl account Manage accounts upctl database Manage databases upctl ip-address Manage IP addresses upctl kubernetes Manage Kubernetes clusters upctl loadbalancer Manage load balancers upctl network Manage networks upctl objectstorage Manage Managed object storage services 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","title":"upctl"},{"location":"commands_reference/upctl/#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.","title":"upctl"},{"location":"commands_reference/upctl/#options","text":"Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --help , -h help for upctl Default: false --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human","title":"Options"},{"location":"commands_reference/upctl/#related-commands","text":"Command Description upctl account Manage accounts upctl database Manage databases upctl ip-address Manage IP addresses upctl kubernetes Manage Kubernetes clusters upctl loadbalancer Manage load balancers upctl network Manage networks upctl objectstorage Manage Managed object storage services 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","title":"Related commands"},{"location":"commands_reference/upctl_version/","text":"upctl version Display software information upctl version [flags] Examples upctl version Options Option Description --help , -h help for version Default: false Global options Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human Related commands Command Description upctl UpCloud command-line interface","title":"upctl version"},{"location":"commands_reference/upctl_version/#upctl-version","text":"Display software information upctl version [flags]","title":"upctl version"},{"location":"commands_reference/upctl_version/#examples","text":"upctl version","title":"Examples"},{"location":"commands_reference/upctl_version/#options","text":"Option Description --help , -h help for version Default: false","title":"Options"},{"location":"commands_reference/upctl_version/#global-options","text":"Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human","title":"Global options"},{"location":"commands_reference/upctl_version/#related-commands","text":"Command Description upctl UpCloud command-line interface","title":"Related commands"},{"location":"commands_reference/upctl_account/","text":"upctl account Manage accounts upctl account [flags] Options Option Description --help , -h help for account Default: false Global options Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human Related commands Command Description upctl UpCloud command-line interface upctl account show Show account","title":"account "},{"location":"commands_reference/upctl_account/#upctl-account","text":"Manage accounts upctl account [flags]","title":"upctl account"},{"location":"commands_reference/upctl_account/#options","text":"Option Description --help , -h help for account Default: false","title":"Options"},{"location":"commands_reference/upctl_account/#global-options","text":"Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human","title":"Global options"},{"location":"commands_reference/upctl_account/#related-commands","text":"Command Description upctl UpCloud command-line interface upctl account show Show account","title":"Related commands"},{"location":"commands_reference/upctl_account/show/","text":"upctl account show Show account upctl account show [flags] Examples upctl account show Options Option Description --help , -h help for show Default: false Global options Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human Related commands Command Description upctl account Manage accounts","title":"account show"},{"location":"commands_reference/upctl_account/show/#upctl-account-show","text":"Show account upctl account show [flags]","title":"upctl account show"},{"location":"commands_reference/upctl_account/show/#examples","text":"upctl account show","title":"Examples"},{"location":"commands_reference/upctl_account/show/#options","text":"Option Description --help , -h help for show Default: false","title":"Options"},{"location":"commands_reference/upctl_account/show/#global-options","text":"Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human","title":"Global options"},{"location":"commands_reference/upctl_account/show/#related-commands","text":"Command Description upctl account Manage accounts","title":"Related commands"},{"location":"commands_reference/upctl_database/","text":"upctl database Manage databases upctl database [flags] Aliases db Options Option Description --help , -h help for database Default: false Global options Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human Related commands 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","title":"database "},{"location":"commands_reference/upctl_database/#upctl-database","text":"Manage databases upctl database [flags]","title":"upctl database"},{"location":"commands_reference/upctl_database/#aliases","text":"db","title":"Aliases"},{"location":"commands_reference/upctl_database/#options","text":"Option Description --help , -h help for database Default: false","title":"Options"},{"location":"commands_reference/upctl_database/#global-options","text":"Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human","title":"Global options"},{"location":"commands_reference/upctl_database/#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","title":"Related commands"},{"location":"commands_reference/upctl_database/delete/","text":"upctl database delete Delete a database upctl database delete [flags] Examples upctl database delete 0497728e-76ef-41d0-997f-fa9449eb71bc upctl database delete my_database Options Option Description --help , -h help for delete Default: false Global options Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human Related commands Command Description upctl database Manage databases","title":"database delete"},{"location":"commands_reference/upctl_database/delete/#upctl-database-delete","text":"Delete a database upctl database delete [flags]","title":"upctl database delete"},{"location":"commands_reference/upctl_database/delete/#examples","text":"upctl database delete 0497728e-76ef-41d0-997f-fa9449eb71bc upctl database delete my_database","title":"Examples"},{"location":"commands_reference/upctl_database/delete/#options","text":"Option Description --help , -h help for delete Default: false","title":"Options"},{"location":"commands_reference/upctl_database/delete/#global-options","text":"Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human","title":"Global options"},{"location":"commands_reference/upctl_database/delete/#related-commands","text":"Command Description upctl database Manage databases","title":"Related commands"},{"location":"commands_reference/upctl_database/list/","text":"upctl database list List current databases upctl database list [flags] Examples upctl database list Options Option Description --help , -h help for list Default: false Global options Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human Related commands Command Description upctl database Manage databases","title":"database list"},{"location":"commands_reference/upctl_database/list/#upctl-database-list","text":"List current databases upctl database list [flags]","title":"upctl database list"},{"location":"commands_reference/upctl_database/list/#examples","text":"upctl database list","title":"Examples"},{"location":"commands_reference/upctl_database/list/#options","text":"Option Description --help , -h help for list Default: false","title":"Options"},{"location":"commands_reference/upctl_database/list/#global-options","text":"Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human","title":"Global options"},{"location":"commands_reference/upctl_database/list/#related-commands","text":"Command Description upctl database Manage databases","title":"Related commands"},{"location":"commands_reference/upctl_database/plans/","text":"upctl database plans List available plans for given database type upctl database plans [flags] Examples upctl database plans pg upctl database plans mysql Options Option Description --help , -h help for plans Default: false Global options Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human Related commands Command Description upctl database Manage databases","title":"database plans"},{"location":"commands_reference/upctl_database/plans/#upctl-database-plans","text":"List available plans for given database type upctl database plans [flags]","title":"upctl database plans"},{"location":"commands_reference/upctl_database/plans/#examples","text":"upctl database plans pg upctl database plans mysql","title":"Examples"},{"location":"commands_reference/upctl_database/plans/#options","text":"Option Description --help , -h help for plans Default: false","title":"Options"},{"location":"commands_reference/upctl_database/plans/#global-options","text":"Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human","title":"Global options"},{"location":"commands_reference/upctl_database/plans/#related-commands","text":"Command Description upctl database Manage databases","title":"Related commands"},{"location":"commands_reference/upctl_database/show/","text":"upctl database show Show database details upctl database show [flags] Examples upctl database show 9a8effcb-80e6-4a63-a7e5-066a6d093c14 upctl database show my-pg-database upctl database show my-mysql-database Options Option Description --help , -h help for show Default: false Global options Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human Related commands Command Description upctl database Manage databases","title":"database show"},{"location":"commands_reference/upctl_database/show/#upctl-database-show","text":"Show database details upctl database show [flags]","title":"upctl database show"},{"location":"commands_reference/upctl_database/show/#examples","text":"upctl database show 9a8effcb-80e6-4a63-a7e5-066a6d093c14 upctl database show my-pg-database upctl database show my-mysql-database","title":"Examples"},{"location":"commands_reference/upctl_database/show/#options","text":"Option Description --help , -h help for show Default: false","title":"Options"},{"location":"commands_reference/upctl_database/show/#global-options","text":"Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human","title":"Global options"},{"location":"commands_reference/upctl_database/show/#related-commands","text":"Command Description upctl database Manage databases","title":"Related commands"},{"location":"commands_reference/upctl_database/start/","text":"upctl database start Start on a managed database upctl database start [flags] Examples upctl database start b0952286-1193-4a81-a1af-62efc014ae4b upctl database start b0952286-1193-4a81-a1af-62efc014ae4b 666bcd3c-5c63-428d-a4fd-07c27469a5a6 upctl database start pg-1x1xcpu-2gb-25gb-pl-waw1 Options Option Description --help , -h help for start Default: false Global options Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human Related commands Command Description upctl database Manage databases","title":"database start"},{"location":"commands_reference/upctl_database/start/#upctl-database-start","text":"Start on a managed database upctl database start [flags]","title":"upctl database start"},{"location":"commands_reference/upctl_database/start/#examples","text":"upctl database start b0952286-1193-4a81-a1af-62efc014ae4b upctl database start b0952286-1193-4a81-a1af-62efc014ae4b 666bcd3c-5c63-428d-a4fd-07c27469a5a6 upctl database start pg-1x1xcpu-2gb-25gb-pl-waw1","title":"Examples"},{"location":"commands_reference/upctl_database/start/#options","text":"Option Description --help , -h help for start Default: false","title":"Options"},{"location":"commands_reference/upctl_database/start/#global-options","text":"Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human","title":"Global options"},{"location":"commands_reference/upctl_database/start/#related-commands","text":"Command Description upctl database Manage databases","title":"Related commands"},{"location":"commands_reference/upctl_database/stop/","text":"upctl database stop Stop a managed database upctl database stop [flags] Aliases shutdown Examples upctl database stop b0952286-1193-4a81-a1af-62efc014ae4b upctl database stop b0952286-1193-4a81-a1af-62efc014ae4b 666bcd3c-5c63-428d-a4fd-07c27469a5a6 upctl database stop pg-1x1xcpu-2gb-25gb-pl-waw1 Options Option Description --help , -h help for stop Default: false Global options Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human Related commands Command Description upctl database Manage databases","title":"database stop"},{"location":"commands_reference/upctl_database/stop/#upctl-database-stop","text":"Stop a managed database upctl database stop [flags]","title":"upctl database stop"},{"location":"commands_reference/upctl_database/stop/#aliases","text":"shutdown","title":"Aliases"},{"location":"commands_reference/upctl_database/stop/#examples","text":"upctl database stop b0952286-1193-4a81-a1af-62efc014ae4b upctl database stop b0952286-1193-4a81-a1af-62efc014ae4b 666bcd3c-5c63-428d-a4fd-07c27469a5a6 upctl database stop pg-1x1xcpu-2gb-25gb-pl-waw1","title":"Examples"},{"location":"commands_reference/upctl_database/stop/#options","text":"Option Description --help , -h help for stop Default: false","title":"Options"},{"location":"commands_reference/upctl_database/stop/#global-options","text":"Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human","title":"Global options"},{"location":"commands_reference/upctl_database/stop/#related-commands","text":"Command Description upctl database Manage databases","title":"Related commands"},{"location":"commands_reference/upctl_database/types/","text":"upctl database types List available database types upctl database types [flags] Examples upctl database types Options Option Description --help , -h help for types Default: false Global options Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human Related commands Command Description upctl database Manage databases","title":"database types"},{"location":"commands_reference/upctl_database/types/#upctl-database-types","text":"List available database types upctl database types [flags]","title":"upctl database types"},{"location":"commands_reference/upctl_database/types/#examples","text":"upctl database types","title":"Examples"},{"location":"commands_reference/upctl_database/types/#options","text":"Option Description --help , -h help for types Default: false","title":"Options"},{"location":"commands_reference/upctl_database/types/#global-options","text":"Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human","title":"Global options"},{"location":"commands_reference/upctl_database/types/#related-commands","text":"Command Description upctl database Manage databases","title":"Related commands"},{"location":"commands_reference/upctl_database/index/","text":"upctl database index Manage database indices upctl database index [flags] Aliases indices Options Option Description --help , -h help for index Default: false Global options Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human Related commands 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","title":"index "},{"location":"commands_reference/upctl_database/index/#upctl-database-index","text":"Manage database indices upctl database index [flags]","title":"upctl database index"},{"location":"commands_reference/upctl_database/index/#aliases","text":"indices","title":"Aliases"},{"location":"commands_reference/upctl_database/index/#options","text":"Option Description --help , -h help for index Default: false","title":"Options"},{"location":"commands_reference/upctl_database/index/#global-options","text":"Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human","title":"Global options"},{"location":"commands_reference/upctl_database/index/#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","title":"Related commands"},{"location":"commands_reference/upctl_database/index/delete/","text":"upctl database index delete Delete an index from the specified database. upctl database index delete [flags] Examples upctl database index delete 55199a44-4751-4e27-9394-7c7661910be3 --name .index-to-delete Options Option Description --name Index name --help , -h help for delete Default: false Global options Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human Related commands Command Description upctl database index Manage database indices","title":"index delete"},{"location":"commands_reference/upctl_database/index/delete/#upctl-database-index-delete","text":"Delete an index from the specified database. upctl database index delete [flags]","title":"upctl database index delete"},{"location":"commands_reference/upctl_database/index/delete/#examples","text":"upctl database index delete 55199a44-4751-4e27-9394-7c7661910be3 --name .index-to-delete","title":"Examples"},{"location":"commands_reference/upctl_database/index/delete/#options","text":"Option Description --name Index name --help , -h help for delete Default: false","title":"Options"},{"location":"commands_reference/upctl_database/index/delete/#global-options","text":"Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human","title":"Global options"},{"location":"commands_reference/upctl_database/index/delete/#related-commands","text":"Command Description upctl database index Manage database indices","title":"Related commands"},{"location":"commands_reference/upctl_database/index/list/","text":"upctl database index list List current indices of the specified databases upctl database index list [flags] Examples upctl database index list 55199a44-4751-4e27-9394-7c7661910be3 Options Option Description --help , -h help for list Default: false Global options Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human Related commands Command Description upctl database index Manage database indices","title":"index list"},{"location":"commands_reference/upctl_database/index/list/#upctl-database-index-list","text":"List current indices of the specified databases upctl database index list [flags]","title":"upctl database index list"},{"location":"commands_reference/upctl_database/index/list/#examples","text":"upctl database index list 55199a44-4751-4e27-9394-7c7661910be3","title":"Examples"},{"location":"commands_reference/upctl_database/index/list/#options","text":"Option Description --help , -h help for list Default: false","title":"Options"},{"location":"commands_reference/upctl_database/index/list/#global-options","text":"Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human","title":"Global options"},{"location":"commands_reference/upctl_database/index/list/#related-commands","text":"Command Description upctl database index Manage database indices","title":"Related commands"},{"location":"commands_reference/upctl_database/properties/","text":"upctl database properties List available properties for given database type upctl database properties [flags] Examples upctl database properties pg upctl database properties mysql Options Option Description --help , -h help for properties Default: false Global options Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human Related commands 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","title":"properties "},{"location":"commands_reference/upctl_database/properties/#upctl-database-properties","text":"List available properties for given database type upctl database properties [flags]","title":"upctl database properties"},{"location":"commands_reference/upctl_database/properties/#examples","text":"upctl database properties pg upctl database properties mysql","title":"Examples"},{"location":"commands_reference/upctl_database/properties/#options","text":"Option Description --help , -h help for properties Default: false","title":"Options"},{"location":"commands_reference/upctl_database/properties/#global-options","text":"Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human","title":"Global options"},{"location":"commands_reference/upctl_database/properties/#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","title":"Related commands"},{"location":"commands_reference/upctl_database/properties/mysql/","text":"upctl database properties mysql List available properties for MySQL databases upctl database properties mysql [flags] Examples upctl database properties mysql Options Option Description --help , -h help for mysql Default: false Global options Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human Related commands Command Description upctl database properties List available properties for given database type upctl database properties mysql show Show MySQL database property details","title":"mysql "},{"location":"commands_reference/upctl_database/properties/mysql/#upctl-database-properties-mysql","text":"List available properties for MySQL databases upctl database properties mysql [flags]","title":"upctl database properties mysql"},{"location":"commands_reference/upctl_database/properties/mysql/#examples","text":"upctl database properties mysql","title":"Examples"},{"location":"commands_reference/upctl_database/properties/mysql/#options","text":"Option Description --help , -h help for mysql Default: false","title":"Options"},{"location":"commands_reference/upctl_database/properties/mysql/#global-options","text":"Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human","title":"Global options"},{"location":"commands_reference/upctl_database/properties/mysql/#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","title":"Related commands"},{"location":"commands_reference/upctl_database/properties/mysql/show/","text":"upctl database properties mysql show Show MySQL database property details upctl database properties mysql show [flags] Examples upctl database properties mysql show version Options Option Description --help , -h help for show Default: false Global options Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human Related commands Command Description upctl database properties mysql List available properties for MySQL databases","title":"mysql show"},{"location":"commands_reference/upctl_database/properties/mysql/show/#upctl-database-properties-mysql-show","text":"Show MySQL database property details upctl database properties mysql show [flags]","title":"upctl database properties mysql show"},{"location":"commands_reference/upctl_database/properties/mysql/show/#examples","text":"upctl database properties mysql show version","title":"Examples"},{"location":"commands_reference/upctl_database/properties/mysql/show/#options","text":"Option Description --help , -h help for show Default: false","title":"Options"},{"location":"commands_reference/upctl_database/properties/mysql/show/#global-options","text":"Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human","title":"Global options"},{"location":"commands_reference/upctl_database/properties/mysql/show/#related-commands","text":"Command Description upctl database properties mysql List available properties for MySQL databases","title":"Related commands"},{"location":"commands_reference/upctl_database/properties/opensearch/","text":"upctl database properties opensearch List available properties for OpenSearch databases upctl database properties opensearch [flags] Examples upctl database properties opensearch Options Option Description --help , -h help for opensearch Default: false Global options Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human Related commands Command Description upctl database properties List available properties for given database type upctl database properties opensearch show Show OpenSearch database property details","title":"opensearch "},{"location":"commands_reference/upctl_database/properties/opensearch/#upctl-database-properties-opensearch","text":"List available properties for OpenSearch databases upctl database properties opensearch [flags]","title":"upctl database properties opensearch"},{"location":"commands_reference/upctl_database/properties/opensearch/#examples","text":"upctl database properties opensearch","title":"Examples"},{"location":"commands_reference/upctl_database/properties/opensearch/#options","text":"Option Description --help , -h help for opensearch Default: false","title":"Options"},{"location":"commands_reference/upctl_database/properties/opensearch/#global-options","text":"Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human","title":"Global options"},{"location":"commands_reference/upctl_database/properties/opensearch/#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","title":"Related commands"},{"location":"commands_reference/upctl_database/properties/opensearch/show/","text":"upctl database properties opensearch show Show OpenSearch database property details upctl database properties opensearch show [flags] Examples upctl database properties opensearch show version Options Option Description --help , -h help for show Default: false Global options Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human Related commands Command Description upctl database properties opensearch List available properties for OpenSearch databases","title":"opensearch show"},{"location":"commands_reference/upctl_database/properties/opensearch/show/#upctl-database-properties-opensearch-show","text":"Show OpenSearch database property details upctl database properties opensearch show [flags]","title":"upctl database properties opensearch show"},{"location":"commands_reference/upctl_database/properties/opensearch/show/#examples","text":"upctl database properties opensearch show version","title":"Examples"},{"location":"commands_reference/upctl_database/properties/opensearch/show/#options","text":"Option Description --help , -h help for show Default: false","title":"Options"},{"location":"commands_reference/upctl_database/properties/opensearch/show/#global-options","text":"Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human","title":"Global options"},{"location":"commands_reference/upctl_database/properties/opensearch/show/#related-commands","text":"Command Description upctl database properties opensearch List available properties for OpenSearch databases","title":"Related commands"},{"location":"commands_reference/upctl_database/properties/pg/","text":"upctl database properties pg List available properties for PostgreSQL databases upctl database properties pg [flags] Examples upctl database properties pg Options Option Description --help , -h help for pg Default: false Global options Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human Related commands Command Description upctl database properties List available properties for given database type upctl database properties pg show Show PostgreSQL database property details","title":"pg "},{"location":"commands_reference/upctl_database/properties/pg/#upctl-database-properties-pg","text":"List available properties for PostgreSQL databases upctl database properties pg [flags]","title":"upctl database properties pg"},{"location":"commands_reference/upctl_database/properties/pg/#examples","text":"upctl database properties pg","title":"Examples"},{"location":"commands_reference/upctl_database/properties/pg/#options","text":"Option Description --help , -h help for pg Default: false","title":"Options"},{"location":"commands_reference/upctl_database/properties/pg/#global-options","text":"Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human","title":"Global options"},{"location":"commands_reference/upctl_database/properties/pg/#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","title":"Related commands"},{"location":"commands_reference/upctl_database/properties/pg/show/","text":"upctl database properties pg show Show PostgreSQL database property details upctl database properties pg show [flags] Examples upctl database properties pg show version Options Option Description --help , -h help for show Default: false Global options Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human Related commands Command Description upctl database properties pg List available properties for PostgreSQL databases","title":"pg show"},{"location":"commands_reference/upctl_database/properties/pg/show/#upctl-database-properties-pg-show","text":"Show PostgreSQL database property details upctl database properties pg show [flags]","title":"upctl database properties pg show"},{"location":"commands_reference/upctl_database/properties/pg/show/#examples","text":"upctl database properties pg show version","title":"Examples"},{"location":"commands_reference/upctl_database/properties/pg/show/#options","text":"Option Description --help , -h help for show Default: false","title":"Options"},{"location":"commands_reference/upctl_database/properties/pg/show/#global-options","text":"Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human","title":"Global options"},{"location":"commands_reference/upctl_database/properties/pg/show/#related-commands","text":"Command Description upctl database properties pg List available properties for PostgreSQL databases","title":"Related commands"},{"location":"commands_reference/upctl_database/properties/redis/","text":"upctl database properties redis List available properties for Redis databases upctl database properties redis [flags] Examples upctl database properties redis Options Option Description --help , -h help for redis Default: false Global options Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human Related commands Command Description upctl database properties List available properties for given database type upctl database properties redis show Show Redis database property details","title":"redis "},{"location":"commands_reference/upctl_database/properties/redis/#upctl-database-properties-redis","text":"List available properties for Redis databases upctl database properties redis [flags]","title":"upctl database properties redis"},{"location":"commands_reference/upctl_database/properties/redis/#examples","text":"upctl database properties redis","title":"Examples"},{"location":"commands_reference/upctl_database/properties/redis/#options","text":"Option Description --help , -h help for redis Default: false","title":"Options"},{"location":"commands_reference/upctl_database/properties/redis/#global-options","text":"Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human","title":"Global options"},{"location":"commands_reference/upctl_database/properties/redis/#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","title":"Related commands"},{"location":"commands_reference/upctl_database/properties/redis/show/","text":"upctl database properties redis show Show Redis database property details upctl database properties redis show [flags] Examples upctl database properties redis show version Options Option Description --help , -h help for show Default: false Global options Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human Related commands Command Description upctl database properties redis List available properties for Redis databases","title":"redis show"},{"location":"commands_reference/upctl_database/properties/redis/show/#upctl-database-properties-redis-show","text":"Show Redis database property details upctl database properties redis show [flags]","title":"upctl database properties redis show"},{"location":"commands_reference/upctl_database/properties/redis/show/#examples","text":"upctl database properties redis show version","title":"Examples"},{"location":"commands_reference/upctl_database/properties/redis/show/#options","text":"Option Description --help , -h help for show Default: false","title":"Options"},{"location":"commands_reference/upctl_database/properties/redis/show/#global-options","text":"Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human","title":"Global options"},{"location":"commands_reference/upctl_database/properties/redis/show/#related-commands","text":"Command Description upctl database properties redis List available properties for Redis databases","title":"Related commands"},{"location":"commands_reference/upctl_database/session/","text":"upctl database session Manage database sessions upctl database session [flags] Options Option Description --help , -h help for session Default: false Global options Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human Related commands 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","title":"session "},{"location":"commands_reference/upctl_database/session/#upctl-database-session","text":"Manage database sessions upctl database session [flags]","title":"upctl database session"},{"location":"commands_reference/upctl_database/session/#options","text":"Option Description --help , -h help for session Default: false","title":"Options"},{"location":"commands_reference/upctl_database/session/#global-options","text":"Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human","title":"Global options"},{"location":"commands_reference/upctl_database/session/#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","title":"Related commands"},{"location":"commands_reference/upctl_database/session/cancel/","text":"upctl database session cancel Terminate client session or cancel running query for a database upctl database session cancel [flags] Examples upctl database session cancel 0fa980c4-0e4f-460b-9869-11b7bd62b832 --pid 2345422 upctl database session cancel mysql-1 --pid 2345422 --terminate Options Option Description --pid Process ID of the session to cancel. Default: 0 --terminate Request immediate termination instead of soft cancel. --help , -h help for cancel Default: false Global options Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human Related commands Command Description upctl database session Manage database sessions","title":"session cancel"},{"location":"commands_reference/upctl_database/session/cancel/#upctl-database-session-cancel","text":"Terminate client session or cancel running query for a database upctl database session cancel [flags]","title":"upctl database session cancel"},{"location":"commands_reference/upctl_database/session/cancel/#examples","text":"upctl database session cancel 0fa980c4-0e4f-460b-9869-11b7bd62b832 --pid 2345422 upctl database session cancel mysql-1 --pid 2345422 --terminate","title":"Examples"},{"location":"commands_reference/upctl_database/session/cancel/#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 cancel Default: false","title":"Options"},{"location":"commands_reference/upctl_database/session/cancel/#global-options","text":"Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human","title":"Global options"},{"location":"commands_reference/upctl_database/session/cancel/#related-commands","text":"Command Description upctl database session Manage database sessions","title":"Related commands"},{"location":"commands_reference/upctl_database/session/list/","text":"upctl database session list List current sessions to specified database upctl database session list [flags] Examples upctl database session list 0fa980c4-0e4f-460b-9869-11b7bd62b832 upctl database session list mysql-1 --limit 16 --offset 32 --order pid:desc Options 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 list Default: false Global options Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human Related commands Command Description upctl database session Manage database sessions","title":"session list"},{"location":"commands_reference/upctl_database/session/list/#upctl-database-session-list","text":"List current sessions to specified database upctl database session list [flags]","title":"upctl database session list"},{"location":"commands_reference/upctl_database/session/list/#examples","text":"upctl database session list 0fa980c4-0e4f-460b-9869-11b7bd62b832 upctl database session list mysql-1 --limit 16 --offset 32 --order pid:desc","title":"Examples"},{"location":"commands_reference/upctl_database/session/list/#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 list Default: false","title":"Options"},{"location":"commands_reference/upctl_database/session/list/#global-options","text":"Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human","title":"Global options"},{"location":"commands_reference/upctl_database/session/list/#related-commands","text":"Command Description upctl database session Manage database sessions","title":"Related commands"},{"location":"commands_reference/upctl_ip-address/","text":"upctl ip-address Manage IP addresses upctl ip-address [flags] Aliases ip Options Option Description --help , -h help for ip-address Default: false Global options Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human Related commands 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","title":"ip-address "},{"location":"commands_reference/upctl_ip-address/#upctl-ip-address","text":"Manage IP addresses upctl ip-address [flags]","title":"upctl ip-address"},{"location":"commands_reference/upctl_ip-address/#aliases","text":"ip","title":"Aliases"},{"location":"commands_reference/upctl_ip-address/#options","text":"Option Description --help , -h help for ip-address Default: false","title":"Options"},{"location":"commands_reference/upctl_ip-address/#global-options","text":"Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human","title":"Global options"},{"location":"commands_reference/upctl_ip-address/#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","title":"Related commands"},{"location":"commands_reference/upctl_ip-address/assign/","text":"upctl ip-address assign Assign or create an IP address upctl ip-address assign [flags] Examples upctl ip-address assign --server 00038afc-d526-4148-af0e-d2f1eeaded9b upctl ip-address assign --server 00944977-89ce-4d10-89c3-bb5ba482e48d --family IPv6 upctl ip-address assign --server 00944977-89ce-4d10-89c3-bb5ba482e48d --floating --zone pl-waw1 upctl ip-address assign --server 00b78f8b-521d-4ffb-8baa-adf96c7b8f45 --floating --mac d6:0e:4a:6f:11:8f Options 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 speficied. --floating Whether the address to be assigned is a floating one. --help , -h help for assign Default: false Global options Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human Related commands Command Description upctl ip-address Manage IP addresses","title":"ip-address assign"},{"location":"commands_reference/upctl_ip-address/assign/#upctl-ip-address-assign","text":"Assign or create an IP address upctl ip-address assign [flags]","title":"upctl ip-address assign"},{"location":"commands_reference/upctl_ip-address/assign/#examples","text":"upctl ip-address assign --server 00038afc-d526-4148-af0e-d2f1eeaded9b upctl ip-address assign --server 00944977-89ce-4d10-89c3-bb5ba482e48d --family IPv6 upctl ip-address assign --server 00944977-89ce-4d10-89c3-bb5ba482e48d --floating --zone pl-waw1 upctl ip-address assign --server 00b78f8b-521d-4ffb-8baa-adf96c7b8f45 --floating --mac d6:0e:4a:6f:11:8f","title":"Examples"},{"location":"commands_reference/upctl_ip-address/assign/#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 speficied. --floating Whether the address to be assigned is a floating one. --help , -h help for assign Default: false","title":"Options"},{"location":"commands_reference/upctl_ip-address/assign/#global-options","text":"Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human","title":"Global options"},{"location":"commands_reference/upctl_ip-address/assign/#related-commands","text":"Command Description upctl ip-address Manage IP addresses","title":"Related commands"},{"location":"commands_reference/upctl_ip-address/list/","text":"upctl ip-address list List IP addresses upctl ip-address list [flags] Examples upctl ip-address list Options Option Description --help , -h help for list Default: false Global options Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human Related commands Command Description upctl ip-address Manage IP addresses","title":"ip-address list"},{"location":"commands_reference/upctl_ip-address/list/#upctl-ip-address-list","text":"List IP addresses upctl ip-address list [flags]","title":"upctl ip-address list"},{"location":"commands_reference/upctl_ip-address/list/#examples","text":"upctl ip-address list","title":"Examples"},{"location":"commands_reference/upctl_ip-address/list/#options","text":"Option Description --help , -h help for list Default: false","title":"Options"},{"location":"commands_reference/upctl_ip-address/list/#global-options","text":"Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human","title":"Global options"},{"location":"commands_reference/upctl_ip-address/list/#related-commands","text":"Command Description upctl ip-address Manage IP addresses","title":"Related commands"},{"location":"commands_reference/upctl_ip-address/modify/","text":"upctl ip-address modify Modify an IP address upctl ip-address modify
    [flags] Examples upctl ip-address modify 185.70.196.225 --ptr-record myapp.com upctl ip-address modify 185.70.197.175 --mac d6:0e:4a:6f:2b:06 Options 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 modify Default: false Global options Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human Related commands Command Description upctl ip-address Manage IP addresses","title":"ip-address modify"},{"location":"commands_reference/upctl_ip-address/modify/#upctl-ip-address-modify","text":"Modify an IP address upctl ip-address modify
    [flags]","title":"upctl ip-address modify"},{"location":"commands_reference/upctl_ip-address/modify/#examples","text":"upctl ip-address modify 185.70.196.225 --ptr-record myapp.com upctl ip-address modify 185.70.197.175 --mac d6:0e:4a:6f:2b:06","title":"Examples"},{"location":"commands_reference/upctl_ip-address/modify/#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 modify Default: false","title":"Options"},{"location":"commands_reference/upctl_ip-address/modify/#global-options","text":"Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human","title":"Global options"},{"location":"commands_reference/upctl_ip-address/modify/#related-commands","text":"Command Description upctl ip-address Manage IP addresses","title":"Related commands"},{"location":"commands_reference/upctl_ip-address/remove/","text":"upctl ip-address remove Remove an IP address upctl ip-address remove
    [flags] Examples upctl ip-address remove 185.70.197.44 upctl ip-address remove 2a04:3544:8000:1000:d40e:4aff:fe6f:2c85 Options Option Description --help , -h help for remove Default: false Global options Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human Related commands Command Description upctl ip-address Manage IP addresses","title":"ip-address remove"},{"location":"commands_reference/upctl_ip-address/remove/#upctl-ip-address-remove","text":"Remove an IP address upctl ip-address remove
    [flags]","title":"upctl ip-address remove"},{"location":"commands_reference/upctl_ip-address/remove/#examples","text":"upctl ip-address remove 185.70.197.44 upctl ip-address remove 2a04:3544:8000:1000:d40e:4aff:fe6f:2c85","title":"Examples"},{"location":"commands_reference/upctl_ip-address/remove/#options","text":"Option Description --help , -h help for remove Default: false","title":"Options"},{"location":"commands_reference/upctl_ip-address/remove/#global-options","text":"Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human","title":"Global options"},{"location":"commands_reference/upctl_ip-address/remove/#related-commands","text":"Command Description upctl ip-address Manage IP addresses","title":"Related commands"},{"location":"commands_reference/upctl_ip-address/show/","text":"upctl ip-address show Show current IP address upctl ip-address show
    [flags] Examples upctl ip-address show 185.70.196.47 upctl ip-address show 2a04:3544:8000:1000:d40e:4aff:fe6f:5d34 Options Option Description --help , -h help for show Default: false Global options Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human Related commands Command Description upctl ip-address Manage IP addresses","title":"ip-address show"},{"location":"commands_reference/upctl_ip-address/show/#upctl-ip-address-show","text":"Show current IP address upctl ip-address show
    [flags]","title":"upctl ip-address show"},{"location":"commands_reference/upctl_ip-address/show/#examples","text":"upctl ip-address show 185.70.196.47 upctl ip-address show 2a04:3544:8000:1000:d40e:4aff:fe6f:5d34","title":"Examples"},{"location":"commands_reference/upctl_ip-address/show/#options","text":"Option Description --help , -h help for show Default: false","title":"Options"},{"location":"commands_reference/upctl_ip-address/show/#global-options","text":"Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human","title":"Global options"},{"location":"commands_reference/upctl_ip-address/show/#related-commands","text":"Command Description upctl ip-address Manage IP addresses","title":"Related commands"},{"location":"commands_reference/upctl_kubernetes/","text":"upctl kubernetes Manage Kubernetes clusters upctl kubernetes [flags] Aliases k8s , uks Options Option Description --help , -h help for kubernetes Default: false Global options Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human Related commands 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 Modifiy 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","title":"kubernetes "},{"location":"commands_reference/upctl_kubernetes/#upctl-kubernetes","text":"Manage Kubernetes clusters upctl kubernetes [flags]","title":"upctl kubernetes"},{"location":"commands_reference/upctl_kubernetes/#aliases","text":"k8s , uks","title":"Aliases"},{"location":"commands_reference/upctl_kubernetes/#options","text":"Option Description --help , -h help for kubernetes Default: false","title":"Options"},{"location":"commands_reference/upctl_kubernetes/#global-options","text":"Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human","title":"Global options"},{"location":"commands_reference/upctl_kubernetes/#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 Modifiy 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","title":"Related commands"},{"location":"commands_reference/upctl_kubernetes/config/","text":"upctl kubernetes config Output Kubernetes cluster kubeconfig upctl kubernetes config [flags] Examples upctl kubernetes config 0fa980c4-0e4f-460b-9869-11b7bd62b831 --output human upctl kubernetes config 0fa980c4-0e4f-460b-9869-11b7bd62b831 --output yaml --write $KUBECONFIG upctl kubernetes config 0fa980c4-0e4f-460b-9869-11b7bd62b831 --output yaml --write ./my_kubeconfig.yaml Options Option Description --write Absolute path for writing output. If the file exists, the config will be merged. --help , -h help for config Default: false Global options Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human Related commands Command Description upctl kubernetes Manage Kubernetes clusters","title":"kubernetes config"},{"location":"commands_reference/upctl_kubernetes/config/#upctl-kubernetes-config","text":"Output Kubernetes cluster kubeconfig upctl kubernetes config [flags]","title":"upctl kubernetes config"},{"location":"commands_reference/upctl_kubernetes/config/#examples","text":"upctl kubernetes config 0fa980c4-0e4f-460b-9869-11b7bd62b831 --output human upctl kubernetes config 0fa980c4-0e4f-460b-9869-11b7bd62b831 --output yaml --write $KUBECONFIG upctl kubernetes config 0fa980c4-0e4f-460b-9869-11b7bd62b831 --output yaml --write ./my_kubeconfig.yaml","title":"Examples"},{"location":"commands_reference/upctl_kubernetes/config/#options","text":"Option Description --write Absolute path for writing output. If the file exists, the config will be merged. --help , -h help for config Default: false","title":"Options"},{"location":"commands_reference/upctl_kubernetes/config/#global-options","text":"Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human","title":"Global options"},{"location":"commands_reference/upctl_kubernetes/config/#related-commands","text":"Command Description upctl kubernetes Manage Kubernetes clusters","title":"Related commands"},{"location":"commands_reference/upctl_kubernetes/create/","text":"upctl kubernetes create Create a Kubernetes cluster upctl kubernetes create [flags] Examples upctl kubernetes create \\ --name my-cluster \\ --network 03e5ca07-f36c-4957-a676-e001e40441eb \\ --node-group count=2,name=my-minimal-node-group,plan=2xCPU-4GB, \\ --zone de-fra1 upctl kubernetes create \\ --name my-cluster \\ --plan production-small \\ --network 03e5ca07-f36c-4957-a676-e001e40441eb \\ --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\" \\ --zone de-fra1 Options Option Description --name Kubernetes cluster name. --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 create Default: false Global options Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human Related commands Command Description upctl kubernetes Manage Kubernetes clusters","title":"kubernetes create"},{"location":"commands_reference/upctl_kubernetes/create/#upctl-kubernetes-create","text":"Create a Kubernetes cluster upctl kubernetes create [flags]","title":"upctl kubernetes create"},{"location":"commands_reference/upctl_kubernetes/create/#examples","text":"upctl kubernetes create \\ --name my-cluster \\ --network 03e5ca07-f36c-4957-a676-e001e40441eb \\ --node-group count=2,name=my-minimal-node-group,plan=2xCPU-4GB, \\ --zone de-fra1 upctl kubernetes create \\ --name my-cluster \\ --plan production-small \\ --network 03e5ca07-f36c-4957-a676-e001e40441eb \\ --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\" \\ --zone de-fra1","title":"Examples"},{"location":"commands_reference/upctl_kubernetes/create/#options","text":"Option Description --name Kubernetes cluster name. --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 create Default: false","title":"Options"},{"location":"commands_reference/upctl_kubernetes/create/#global-options","text":"Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human","title":"Global options"},{"location":"commands_reference/upctl_kubernetes/create/#related-commands","text":"Command Description upctl kubernetes Manage Kubernetes clusters","title":"Related commands"},{"location":"commands_reference/upctl_kubernetes/delete/","text":"upctl kubernetes delete Delete a Kubernetes cluster upctl kubernetes delete [flags] Examples upctl kubernetes delete 55199a44-4751-4e27-9394-7c7661910be3 upctl kubernetes delete my-kubernetes-cluster Options Option Description --help , -h help for delete Default: false Global options Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human Related commands Command Description upctl kubernetes Manage Kubernetes clusters","title":"kubernetes delete"},{"location":"commands_reference/upctl_kubernetes/delete/#upctl-kubernetes-delete","text":"Delete a Kubernetes cluster upctl kubernetes delete [flags]","title":"upctl kubernetes delete"},{"location":"commands_reference/upctl_kubernetes/delete/#examples","text":"upctl kubernetes delete 55199a44-4751-4e27-9394-7c7661910be3 upctl kubernetes delete my-kubernetes-cluster","title":"Examples"},{"location":"commands_reference/upctl_kubernetes/delete/#options","text":"Option Description --help , -h help for delete Default: false","title":"Options"},{"location":"commands_reference/upctl_kubernetes/delete/#global-options","text":"Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human","title":"Global options"},{"location":"commands_reference/upctl_kubernetes/delete/#related-commands","text":"Command Description upctl kubernetes Manage Kubernetes clusters","title":"Related commands"},{"location":"commands_reference/upctl_kubernetes/list/","text":"upctl kubernetes list List current Kubernetes clusters upctl kubernetes list [flags] Examples upctl kubernetes list Options Option Description --help , -h help for list Default: false Global options Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human Related commands Command Description upctl kubernetes Manage Kubernetes clusters","title":"kubernetes list"},{"location":"commands_reference/upctl_kubernetes/list/#upctl-kubernetes-list","text":"List current Kubernetes clusters upctl kubernetes list [flags]","title":"upctl kubernetes list"},{"location":"commands_reference/upctl_kubernetes/list/#examples","text":"upctl kubernetes list","title":"Examples"},{"location":"commands_reference/upctl_kubernetes/list/#options","text":"Option Description --help , -h help for list Default: false","title":"Options"},{"location":"commands_reference/upctl_kubernetes/list/#global-options","text":"Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human","title":"Global options"},{"location":"commands_reference/upctl_kubernetes/list/#related-commands","text":"Command Description upctl kubernetes Manage Kubernetes clusters","title":"Related commands"},{"location":"commands_reference/upctl_kubernetes/modify/","text":"upctl kubernetes modify Modifiy an existing cluster upctl kubernetes modify [flags] Examples upctl cluster modify 00bb4617-c592-4b32-b869-35a60b323b18 --plan 1xCPU-1GB Options 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: [] --help , -h help for modify Default: false Global options Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human Related commands Command Description upctl kubernetes Manage Kubernetes clusters","title":"kubernetes modify"},{"location":"commands_reference/upctl_kubernetes/modify/#upctl-kubernetes-modify","text":"Modifiy an existing cluster upctl kubernetes modify [flags]","title":"upctl kubernetes modify"},{"location":"commands_reference/upctl_kubernetes/modify/#examples","text":"upctl cluster modify 00bb4617-c592-4b32-b869-35a60b323b18 --plan 1xCPU-1GB","title":"Examples"},{"location":"commands_reference/upctl_kubernetes/modify/#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: [] --help , -h help for modify Default: false","title":"Options"},{"location":"commands_reference/upctl_kubernetes/modify/#global-options","text":"Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human","title":"Global options"},{"location":"commands_reference/upctl_kubernetes/modify/#related-commands","text":"Command Description upctl kubernetes Manage Kubernetes clusters","title":"Related commands"},{"location":"commands_reference/upctl_kubernetes/plans/","text":"upctl kubernetes plans List available cluster plans upctl kubernetes plans [flags] Examples upctl kubernetes plans Options Option Description --help , -h help for plans Default: false Global options Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human Related commands Command Description upctl kubernetes Manage Kubernetes clusters","title":"kubernetes plans"},{"location":"commands_reference/upctl_kubernetes/plans/#upctl-kubernetes-plans","text":"List available cluster plans upctl kubernetes plans [flags]","title":"upctl kubernetes plans"},{"location":"commands_reference/upctl_kubernetes/plans/#examples","text":"upctl kubernetes plans","title":"Examples"},{"location":"commands_reference/upctl_kubernetes/plans/#options","text":"Option Description --help , -h help for plans Default: false","title":"Options"},{"location":"commands_reference/upctl_kubernetes/plans/#global-options","text":"Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human","title":"Global options"},{"location":"commands_reference/upctl_kubernetes/plans/#related-commands","text":"Command Description upctl kubernetes Manage Kubernetes clusters","title":"Related commands"},{"location":"commands_reference/upctl_kubernetes/show/","text":"upctl kubernetes show Show Kubernetes cluster details upctl kubernetes show [flags] Examples upctl kubernetes show 55199a44-4751-4e27-9394-7c7661910be3 upctl kubernetes show my-cluster Options Option Description --help , -h help for show Default: false Global options Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human Related commands Command Description upctl kubernetes Manage Kubernetes clusters","title":"kubernetes show"},{"location":"commands_reference/upctl_kubernetes/show/#upctl-kubernetes-show","text":"Show Kubernetes cluster details upctl kubernetes show [flags]","title":"upctl kubernetes show"},{"location":"commands_reference/upctl_kubernetes/show/#examples","text":"upctl kubernetes show 55199a44-4751-4e27-9394-7c7661910be3 upctl kubernetes show my-cluster","title":"Examples"},{"location":"commands_reference/upctl_kubernetes/show/#options","text":"Option Description --help , -h help for show Default: false","title":"Options"},{"location":"commands_reference/upctl_kubernetes/show/#global-options","text":"Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human","title":"Global options"},{"location":"commands_reference/upctl_kubernetes/show/#related-commands","text":"Command Description upctl kubernetes Manage Kubernetes clusters","title":"Related commands"},{"location":"commands_reference/upctl_kubernetes/versions/","text":"upctl kubernetes versions List available versions for Kubernetes clusters upctl kubernetes versions [flags] Examples upctl kubernetes versions Options Option Description --help , -h help for versions Default: false Global options Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human Related commands Command Description upctl kubernetes Manage Kubernetes clusters","title":"kubernetes versions"},{"location":"commands_reference/upctl_kubernetes/versions/#upctl-kubernetes-versions","text":"List available versions for Kubernetes clusters upctl kubernetes versions [flags]","title":"upctl kubernetes versions"},{"location":"commands_reference/upctl_kubernetes/versions/#examples","text":"upctl kubernetes versions","title":"Examples"},{"location":"commands_reference/upctl_kubernetes/versions/#options","text":"Option Description --help , -h help for versions Default: false","title":"Options"},{"location":"commands_reference/upctl_kubernetes/versions/#global-options","text":"Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human","title":"Global options"},{"location":"commands_reference/upctl_kubernetes/versions/#related-commands","text":"Command Description upctl kubernetes Manage Kubernetes clusters","title":"Related commands"},{"location":"commands_reference/upctl_kubernetes/nodegroup/","text":"upctl kubernetes nodegroup Manage cluster node-groups upctl kubernetes nodegroup [flags] Aliases node-group Options Option Description --help , -h help for nodegroup Default: false Global options Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human Related commands 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","title":"nodegroup "},{"location":"commands_reference/upctl_kubernetes/nodegroup/#upctl-kubernetes-nodegroup","text":"Manage cluster node-groups upctl kubernetes nodegroup [flags]","title":"upctl kubernetes nodegroup"},{"location":"commands_reference/upctl_kubernetes/nodegroup/#aliases","text":"node-group","title":"Aliases"},{"location":"commands_reference/upctl_kubernetes/nodegroup/#options","text":"Option Description --help , -h help for nodegroup Default: false","title":"Options"},{"location":"commands_reference/upctl_kubernetes/nodegroup/#global-options","text":"Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human","title":"Global options"},{"location":"commands_reference/upctl_kubernetes/nodegroup/#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","title":"Related commands"},{"location":"commands_reference/upctl_kubernetes/nodegroup/create/","text":"upctl kubernetes nodegroup create Create a new node group into the specified cluster. upctl kubernetes nodegroup create [flags] Examples upctl kubernetes nodegroup create 55199a44-4751-4e27-9394-7c7661910be3 --name secondary-node-group --count 3 --plan 2xCPU-4GB Options Option Description --count Number of nodes in the node group Default: 0 --kubelet-arg Arguments to use when executing kubelet in argument=value format Default: [] --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 format Default: [] --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 create Default: false Global options Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human Related commands Command Description upctl kubernetes nodegroup Manage cluster node-groups","title":"nodegroup create"},{"location":"commands_reference/upctl_kubernetes/nodegroup/create/#upctl-kubernetes-nodegroup-create","text":"Create a new node group into the specified cluster. upctl kubernetes nodegroup create [flags]","title":"upctl kubernetes nodegroup create"},{"location":"commands_reference/upctl_kubernetes/nodegroup/create/#examples","text":"upctl kubernetes nodegroup create 55199a44-4751-4e27-9394-7c7661910be3 --name secondary-node-group --count 3 --plan 2xCPU-4GB","title":"Examples"},{"location":"commands_reference/upctl_kubernetes/nodegroup/create/#options","text":"Option Description --count Number of nodes in the node group Default: 0 --kubelet-arg Arguments to use when executing kubelet in argument=value format Default: [] --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 format Default: [] --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 create Default: false","title":"Options"},{"location":"commands_reference/upctl_kubernetes/nodegroup/create/#global-options","text":"Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human","title":"Global options"},{"location":"commands_reference/upctl_kubernetes/nodegroup/create/#related-commands","text":"Command Description upctl kubernetes nodegroup Manage cluster node-groups","title":"Related commands"},{"location":"commands_reference/upctl_kubernetes/nodegroup/delete/","text":"upctl kubernetes nodegroup delete Delete the node group from the cluster. upctl kubernetes nodegroup delete [flags] Examples upctl kubernetes nodegroup delete 55199a44-4751-4e27-9394-7c7661910be3 --name secondary-node-group Options Option Description --name Node group name --help , -h help for delete Default: false Global options Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human Related commands Command Description upctl kubernetes nodegroup Manage cluster node-groups","title":"nodegroup delete"},{"location":"commands_reference/upctl_kubernetes/nodegroup/delete/#upctl-kubernetes-nodegroup-delete","text":"Delete the node group from the cluster. upctl kubernetes nodegroup delete [flags]","title":"upctl kubernetes nodegroup delete"},{"location":"commands_reference/upctl_kubernetes/nodegroup/delete/#examples","text":"upctl kubernetes nodegroup delete 55199a44-4751-4e27-9394-7c7661910be3 --name secondary-node-group","title":"Examples"},{"location":"commands_reference/upctl_kubernetes/nodegroup/delete/#options","text":"Option Description --name Node group name --help , -h help for delete Default: false","title":"Options"},{"location":"commands_reference/upctl_kubernetes/nodegroup/delete/#global-options","text":"Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human","title":"Global options"},{"location":"commands_reference/upctl_kubernetes/nodegroup/delete/#related-commands","text":"Command Description upctl kubernetes nodegroup Manage cluster node-groups","title":"Related commands"},{"location":"commands_reference/upctl_kubernetes/nodegroup/scale/","text":"upctl kubernetes nodegroup scale Scale the number of nodes in the node group. upctl kubernetes nodegroup scale [flags] Examples upctl kubernetes nodegroup scale 55199a44-4751-4e27-9394-7c7661910be3 --name secondary-node-group --count 3 Options Option Description --name Node group name --count Node count Default: 0 --help , -h help for scale Default: false Global options Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human Related commands Command Description upctl kubernetes nodegroup Manage cluster node-groups","title":"nodegroup scale"},{"location":"commands_reference/upctl_kubernetes/nodegroup/scale/#upctl-kubernetes-nodegroup-scale","text":"Scale the number of nodes in the node group. upctl kubernetes nodegroup scale [flags]","title":"upctl kubernetes nodegroup scale"},{"location":"commands_reference/upctl_kubernetes/nodegroup/scale/#examples","text":"upctl kubernetes nodegroup scale 55199a44-4751-4e27-9394-7c7661910be3 --name secondary-node-group --count 3","title":"Examples"},{"location":"commands_reference/upctl_kubernetes/nodegroup/scale/#options","text":"Option Description --name Node group name --count Node count Default: 0 --help , -h help for scale Default: false","title":"Options"},{"location":"commands_reference/upctl_kubernetes/nodegroup/scale/#global-options","text":"Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human","title":"Global options"},{"location":"commands_reference/upctl_kubernetes/nodegroup/scale/#related-commands","text":"Command Description upctl kubernetes nodegroup Manage cluster node-groups","title":"Related commands"},{"location":"commands_reference/upctl_kubernetes/nodegroup/show/","text":"upctl kubernetes nodegroup show Show node group details upctl kubernetes nodegroup show [flags] Examples upctl kubernetes nodegroup show 55199a44-4751-4e27-9394-7c7661910be3 --name default Options Option Description --name Node group name --help , -h help for show Default: false Global options Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human Related commands Command Description upctl kubernetes nodegroup Manage cluster node-groups","title":"nodegroup show"},{"location":"commands_reference/upctl_kubernetes/nodegroup/show/#upctl-kubernetes-nodegroup-show","text":"Show node group details upctl kubernetes nodegroup show [flags]","title":"upctl kubernetes nodegroup show"},{"location":"commands_reference/upctl_kubernetes/nodegroup/show/#examples","text":"upctl kubernetes nodegroup show 55199a44-4751-4e27-9394-7c7661910be3 --name default","title":"Examples"},{"location":"commands_reference/upctl_kubernetes/nodegroup/show/#options","text":"Option Description --name Node group name --help , -h help for show Default: false","title":"Options"},{"location":"commands_reference/upctl_kubernetes/nodegroup/show/#global-options","text":"Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human","title":"Global options"},{"location":"commands_reference/upctl_kubernetes/nodegroup/show/#related-commands","text":"Command Description upctl kubernetes nodegroup Manage cluster node-groups","title":"Related commands"},{"location":"commands_reference/upctl_loadbalancer/","text":"upctl loadbalancer Manage load balancers upctl loadbalancer [flags] Aliases lb Options Option Description --help , -h help for loadbalancer Default: false Global options Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human Related commands 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","title":"loadbalancer "},{"location":"commands_reference/upctl_loadbalancer/#upctl-loadbalancer","text":"Manage load balancers upctl loadbalancer [flags]","title":"upctl loadbalancer"},{"location":"commands_reference/upctl_loadbalancer/#aliases","text":"lb","title":"Aliases"},{"location":"commands_reference/upctl_loadbalancer/#options","text":"Option Description --help , -h help for loadbalancer Default: false","title":"Options"},{"location":"commands_reference/upctl_loadbalancer/#global-options","text":"Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human","title":"Global options"},{"location":"commands_reference/upctl_loadbalancer/#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","title":"Related commands"},{"location":"commands_reference/upctl_loadbalancer/delete/","text":"upctl loadbalancer delete Delete a load balancer upctl loadbalancer delete [flags] Examples upctl loadbalancer delete 55199a44-4751-4e27-9394-7c7661910be3 upctl loadbalancer delete my-load-balancer Options Option Description --help , -h help for delete Default: false Global options Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human Related commands Command Description upctl loadbalancer Manage load balancers","title":"loadbalancer delete"},{"location":"commands_reference/upctl_loadbalancer/delete/#upctl-loadbalancer-delete","text":"Delete a load balancer upctl loadbalancer delete [flags]","title":"upctl loadbalancer delete"},{"location":"commands_reference/upctl_loadbalancer/delete/#examples","text":"upctl loadbalancer delete 55199a44-4751-4e27-9394-7c7661910be3 upctl loadbalancer delete my-load-balancer","title":"Examples"},{"location":"commands_reference/upctl_loadbalancer/delete/#options","text":"Option Description --help , -h help for delete Default: false","title":"Options"},{"location":"commands_reference/upctl_loadbalancer/delete/#global-options","text":"Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human","title":"Global options"},{"location":"commands_reference/upctl_loadbalancer/delete/#related-commands","text":"Command Description upctl loadbalancer Manage load balancers","title":"Related commands"},{"location":"commands_reference/upctl_loadbalancer/list/","text":"upctl loadbalancer list List current load balancers upctl loadbalancer list [flags] Examples upctl loadbalancer list Options Option Description --help , -h help for list Default: false Global options Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human Related commands Command Description upctl loadbalancer Manage load balancers","title":"loadbalancer list"},{"location":"commands_reference/upctl_loadbalancer/list/#upctl-loadbalancer-list","text":"List current load balancers upctl loadbalancer list [flags]","title":"upctl loadbalancer list"},{"location":"commands_reference/upctl_loadbalancer/list/#examples","text":"upctl loadbalancer list","title":"Examples"},{"location":"commands_reference/upctl_loadbalancer/list/#options","text":"Option Description --help , -h help for list Default: false","title":"Options"},{"location":"commands_reference/upctl_loadbalancer/list/#global-options","text":"Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human","title":"Global options"},{"location":"commands_reference/upctl_loadbalancer/list/#related-commands","text":"Command Description upctl loadbalancer Manage load balancers","title":"Related commands"},{"location":"commands_reference/upctl_loadbalancer/plans/","text":"upctl loadbalancer plans List available load balancer plans upctl loadbalancer plans [flags] Examples upctl loadbalancer plans Options Option Description --help , -h help for plans Default: false Global options Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human Related commands Command Description upctl loadbalancer Manage load balancers","title":"loadbalancer plans"},{"location":"commands_reference/upctl_loadbalancer/plans/#upctl-loadbalancer-plans","text":"List available load balancer plans upctl loadbalancer plans [flags]","title":"upctl loadbalancer plans"},{"location":"commands_reference/upctl_loadbalancer/plans/#examples","text":"upctl loadbalancer plans","title":"Examples"},{"location":"commands_reference/upctl_loadbalancer/plans/#options","text":"Option Description --help , -h help for plans Default: false","title":"Options"},{"location":"commands_reference/upctl_loadbalancer/plans/#global-options","text":"Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human","title":"Global options"},{"location":"commands_reference/upctl_loadbalancer/plans/#related-commands","text":"Command Description upctl loadbalancer Manage load balancers","title":"Related commands"},{"location":"commands_reference/upctl_loadbalancer/show/","text":"upctl loadbalancer show Show load balancer details upctl loadbalancer show [flags] Examples upctl loadbalancer show 55199a44-4751-4e27-9394-7c7661910be3 upctl loadbalancer show my-load-balancer Options Option Description --help , -h help for show Default: false Global options Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human Related commands Command Description upctl loadbalancer Manage load balancers","title":"loadbalancer show"},{"location":"commands_reference/upctl_loadbalancer/show/#upctl-loadbalancer-show","text":"Show load balancer details upctl loadbalancer show [flags]","title":"upctl loadbalancer show"},{"location":"commands_reference/upctl_loadbalancer/show/#examples","text":"upctl loadbalancer show 55199a44-4751-4e27-9394-7c7661910be3 upctl loadbalancer show my-load-balancer","title":"Examples"},{"location":"commands_reference/upctl_loadbalancer/show/#options","text":"Option Description --help , -h help for show Default: false","title":"Options"},{"location":"commands_reference/upctl_loadbalancer/show/#global-options","text":"Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human","title":"Global options"},{"location":"commands_reference/upctl_loadbalancer/show/#related-commands","text":"Command Description upctl loadbalancer Manage load balancers","title":"Related commands"},{"location":"commands_reference/upctl_network/","text":"upctl network Manage networks upctl network [flags] Aliases net Options Option Description --help , -h help for network Default: false Global options Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human Related commands 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","title":"network "},{"location":"commands_reference/upctl_network/#upctl-network","text":"Manage networks upctl network [flags]","title":"upctl network"},{"location":"commands_reference/upctl_network/#aliases","text":"net","title":"Aliases"},{"location":"commands_reference/upctl_network/#options","text":"Option Description --help , -h help for network Default: false","title":"Options"},{"location":"commands_reference/upctl_network/#global-options","text":"Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human","title":"Global options"},{"location":"commands_reference/upctl_network/#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","title":"Related commands"},{"location":"commands_reference/upctl_network/create/","text":"upctl network create Create a network upctl network create [flags] Examples upctl network create --name \"My Network\" --zone pl-waw1 --ip-network address=10.0.1.0/24 upctl network create --name my_net --zone pl-waw1 --ip-network address=10.0.2.0/24,dhcp=true Options 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 strings Default: [] --help , -h help for create Default: false Global options Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human Related commands Command Description upctl network Manage networks","title":"network create"},{"location":"commands_reference/upctl_network/create/#upctl-network-create","text":"Create a network upctl network create [flags]","title":"upctl network create"},{"location":"commands_reference/upctl_network/create/#examples","text":"upctl network create --name \"My Network\" --zone pl-waw1 --ip-network address=10.0.1.0/24 upctl network create --name my_net --zone pl-waw1 --ip-network address=10.0.2.0/24,dhcp=true","title":"Examples"},{"location":"commands_reference/upctl_network/create/#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 strings Default: [] --help , -h help for create Default: false","title":"Options"},{"location":"commands_reference/upctl_network/create/#global-options","text":"Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human","title":"Global options"},{"location":"commands_reference/upctl_network/create/#related-commands","text":"Command Description upctl network Manage networks","title":"Related commands"},{"location":"commands_reference/upctl_network/delete/","text":"upctl network delete Delete a network upctl network delete [flags] Examples upctl network delete 037f260c-9568-4d9b-97e5-44cf52440ccb upctl network delete 03d7b5c2-b80a-4636-88d4-f9911185c975 0312a237-8204-4c1c-9fd1-2314013ec687 upctl network delete \"My Network 1\" Options Option Description --help , -h help for delete Default: false Global options Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human Related commands Command Description upctl network Manage networks","title":"network delete"},{"location":"commands_reference/upctl_network/delete/#upctl-network-delete","text":"Delete a network upctl network delete [flags]","title":"upctl network delete"},{"location":"commands_reference/upctl_network/delete/#examples","text":"upctl network delete 037f260c-9568-4d9b-97e5-44cf52440ccb upctl network delete 03d7b5c2-b80a-4636-88d4-f9911185c975 0312a237-8204-4c1c-9fd1-2314013ec687 upctl network delete \"My Network 1\"","title":"Examples"},{"location":"commands_reference/upctl_network/delete/#options","text":"Option Description --help , -h help for delete Default: false","title":"Options"},{"location":"commands_reference/upctl_network/delete/#global-options","text":"Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human","title":"Global options"},{"location":"commands_reference/upctl_network/delete/#related-commands","text":"Command Description upctl network Manage networks","title":"Related commands"},{"location":"commands_reference/upctl_network/list/","text":"upctl network list List networks, by default private networks only upctl network list [flags] Examples upctl network list upctl network list --zone pl-waw1 upctl network list --zone pl-waw1 --public upctl network list --all upctl network list --zone pl-waw1 --all Options 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 list Default: false Global options Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human Related commands Command Description upctl network Manage networks","title":"network list"},{"location":"commands_reference/upctl_network/list/#upctl-network-list","text":"List networks, by default private networks only upctl network list [flags]","title":"upctl network list"},{"location":"commands_reference/upctl_network/list/#examples","text":"upctl network list upctl network list --zone pl-waw1 upctl network list --zone pl-waw1 --public upctl network list --all upctl network list --zone pl-waw1 --all","title":"Examples"},{"location":"commands_reference/upctl_network/list/#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 list Default: false","title":"Options"},{"location":"commands_reference/upctl_network/list/#global-options","text":"Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human","title":"Global options"},{"location":"commands_reference/upctl_network/list/#related-commands","text":"Command Description upctl network Manage networks","title":"Related commands"},{"location":"commands_reference/upctl_network/modify/","text":"upctl network modify Modify a network upctl network modify [flags] Examples upctl network modify 037a530b-533e-4cef-b6ad-6af8094bb2bc --ip-network dhcp=false,family=IPv4 upctl network modify \"My Network\" --name \"My Super Network\" Options 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 strings Default: [] --help , -h help for modify Default: false Global options Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human Related commands Command Description upctl network Manage networks","title":"network modify"},{"location":"commands_reference/upctl_network/modify/#upctl-network-modify","text":"Modify a network upctl network modify [flags]","title":"upctl network modify"},{"location":"commands_reference/upctl_network/modify/#examples","text":"upctl network modify 037a530b-533e-4cef-b6ad-6af8094bb2bc --ip-network dhcp=false,family=IPv4 upctl network modify \"My Network\" --name \"My Super Network\"","title":"Examples"},{"location":"commands_reference/upctl_network/modify/#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 strings Default: [] --help , -h help for modify Default: false","title":"Options"},{"location":"commands_reference/upctl_network/modify/#global-options","text":"Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human","title":"Global options"},{"location":"commands_reference/upctl_network/modify/#related-commands","text":"Command Description upctl network Manage networks","title":"Related commands"},{"location":"commands_reference/upctl_network/show/","text":"upctl network show Show network details upctl network show [flags] Examples upctl network show 037a530b-533e-4cef-b6ad-6af8094bb2bc upctl network show 037a530b-533e-4cef-b6ad-6af8094bb2bc 0311480d-d0c0-4951-ab41-bf12097f5d3c upctl network show \"My Network\" Options Option Description --help , -h help for show Default: false Global options Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human Related commands Command Description upctl network Manage networks","title":"network show"},{"location":"commands_reference/upctl_network/show/#upctl-network-show","text":"Show network details upctl network show [flags]","title":"upctl network show"},{"location":"commands_reference/upctl_network/show/#examples","text":"upctl network show 037a530b-533e-4cef-b6ad-6af8094bb2bc upctl network show 037a530b-533e-4cef-b6ad-6af8094bb2bc 0311480d-d0c0-4951-ab41-bf12097f5d3c upctl network show \"My Network\"","title":"Examples"},{"location":"commands_reference/upctl_network/show/#options","text":"Option Description --help , -h help for show Default: false","title":"Options"},{"location":"commands_reference/upctl_network/show/#global-options","text":"Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human","title":"Global options"},{"location":"commands_reference/upctl_network/show/#related-commands","text":"Command Description upctl network Manage networks","title":"Related commands"},{"location":"commands_reference/upctl_objectstorage/","text":"upctl objectstorage Manage Managed object storage services upctl objectstorage [flags] Aliases object-storage , objsto Options Option Description --help , -h help for objectstorage Default: false Global options Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human Related commands 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 show Show Managed object storage service details","title":"objectstorage "},{"location":"commands_reference/upctl_objectstorage/#upctl-objectstorage","text":"Manage Managed object storage services upctl objectstorage [flags]","title":"upctl objectstorage"},{"location":"commands_reference/upctl_objectstorage/#aliases","text":"object-storage , objsto","title":"Aliases"},{"location":"commands_reference/upctl_objectstorage/#options","text":"Option Description --help , -h help for objectstorage Default: false","title":"Options"},{"location":"commands_reference/upctl_objectstorage/#global-options","text":"Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human","title":"Global options"},{"location":"commands_reference/upctl_objectstorage/#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 show Show Managed object storage service details","title":"Related commands"},{"location":"commands_reference/upctl_objectstorage/delete/","text":"upctl objectstorage delete Delete a Managed object storage service upctl objectstorage delete [flags] Examples upctl objectstorage delete 55199a44-4751-4e27-9394-7c7661910be8 Options Option Description --help , -h help for delete Default: false Global options Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human Related commands Command Description upctl objectstorage Manage Managed object storage services","title":"objectstorage delete"},{"location":"commands_reference/upctl_objectstorage/delete/#upctl-objectstorage-delete","text":"Delete a Managed object storage service upctl objectstorage delete [flags]","title":"upctl objectstorage delete"},{"location":"commands_reference/upctl_objectstorage/delete/#examples","text":"upctl objectstorage delete 55199a44-4751-4e27-9394-7c7661910be8","title":"Examples"},{"location":"commands_reference/upctl_objectstorage/delete/#options","text":"Option Description --help , -h help for delete Default: false","title":"Options"},{"location":"commands_reference/upctl_objectstorage/delete/#global-options","text":"Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human","title":"Global options"},{"location":"commands_reference/upctl_objectstorage/delete/#related-commands","text":"Command Description upctl objectstorage Manage Managed object storage services","title":"Related commands"},{"location":"commands_reference/upctl_objectstorage/list/","text":"upctl objectstorage list List current Managed object storage services upctl objectstorage list [flags] Examples upctl objectstorage list Options Option Description --help , -h help for list Default: false Global options Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human Related commands Command Description upctl objectstorage Manage Managed object storage services","title":"objectstorage list"},{"location":"commands_reference/upctl_objectstorage/list/#upctl-objectstorage-list","text":"List current Managed object storage services upctl objectstorage list [flags]","title":"upctl objectstorage list"},{"location":"commands_reference/upctl_objectstorage/list/#examples","text":"upctl objectstorage list","title":"Examples"},{"location":"commands_reference/upctl_objectstorage/list/#options","text":"Option Description --help , -h help for list Default: false","title":"Options"},{"location":"commands_reference/upctl_objectstorage/list/#global-options","text":"Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human","title":"Global options"},{"location":"commands_reference/upctl_objectstorage/list/#related-commands","text":"Command Description upctl objectstorage Manage Managed object storage services","title":"Related commands"},{"location":"commands_reference/upctl_objectstorage/show/","text":"upctl objectstorage show Show Managed object storage service details upctl objectstorage show [flags] Examples upctl objectstorage show 55199a44-4751-4e27-9394-7c7661910be8 Options Option Description --help , -h help for show Default: false Global options Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human Related commands Command Description upctl objectstorage Manage Managed object storage services","title":"objectstorage show"},{"location":"commands_reference/upctl_objectstorage/show/#upctl-objectstorage-show","text":"Show Managed object storage service details upctl objectstorage show [flags]","title":"upctl objectstorage show"},{"location":"commands_reference/upctl_objectstorage/show/#examples","text":"upctl objectstorage show 55199a44-4751-4e27-9394-7c7661910be8","title":"Examples"},{"location":"commands_reference/upctl_objectstorage/show/#options","text":"Option Description --help , -h help for show Default: false","title":"Options"},{"location":"commands_reference/upctl_objectstorage/show/#global-options","text":"Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human","title":"Global options"},{"location":"commands_reference/upctl_objectstorage/show/#related-commands","text":"Command Description upctl objectstorage Manage Managed object storage services","title":"Related commands"},{"location":"commands_reference/upctl_router/","text":"upctl router Manage routers upctl router [flags] Options Option Description --help , -h help for router Default: false Global options Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human Related commands 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","title":"router "},{"location":"commands_reference/upctl_router/#upctl-router","text":"Manage routers upctl router [flags]","title":"upctl router"},{"location":"commands_reference/upctl_router/#options","text":"Option Description --help , -h help for router Default: false","title":"Options"},{"location":"commands_reference/upctl_router/#global-options","text":"Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human","title":"Global options"},{"location":"commands_reference/upctl_router/#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","title":"Related commands"},{"location":"commands_reference/upctl_router/create/","text":"upctl router create Create a router upctl router create [flags] Examples upctl router create --name my_router upctl router create --name \"My Router\" Options Option Description --name Router name. --help , -h help for create Default: false Global options Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human Related commands Command Description upctl router Manage routers","title":"router create"},{"location":"commands_reference/upctl_router/create/#upctl-router-create","text":"Create a router upctl router create [flags]","title":"upctl router create"},{"location":"commands_reference/upctl_router/create/#examples","text":"upctl router create --name my_router upctl router create --name \"My Router\"","title":"Examples"},{"location":"commands_reference/upctl_router/create/#options","text":"Option Description --name Router name. --help , -h help for create Default: false","title":"Options"},{"location":"commands_reference/upctl_router/create/#global-options","text":"Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human","title":"Global options"},{"location":"commands_reference/upctl_router/create/#related-commands","text":"Command Description upctl router Manage routers","title":"Related commands"},{"location":"commands_reference/upctl_router/delete/","text":"upctl router delete Delete a router upctl router delete [flags] Examples upctl router delete 0497728e-76ef-41d0-997f-fa9449eb71bc upctl router delete my_router Options Option Description --help , -h help for delete Default: false Global options Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human Related commands Command Description upctl router Manage routers","title":"router delete"},{"location":"commands_reference/upctl_router/delete/#upctl-router-delete","text":"Delete a router upctl router delete [flags]","title":"upctl router delete"},{"location":"commands_reference/upctl_router/delete/#examples","text":"upctl router delete 0497728e-76ef-41d0-997f-fa9449eb71bc upctl router delete my_router","title":"Examples"},{"location":"commands_reference/upctl_router/delete/#options","text":"Option Description --help , -h help for delete Default: false","title":"Options"},{"location":"commands_reference/upctl_router/delete/#global-options","text":"Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human","title":"Global options"},{"location":"commands_reference/upctl_router/delete/#related-commands","text":"Command Description upctl router Manage routers","title":"Related commands"},{"location":"commands_reference/upctl_router/list/","text":"upctl router list List routers upctl router list [flags] Examples upctl router list upctl router list --all Options Option Description --all Show all routers. --normal Show normal routers. --service Show service routers. --help , -h help for list Default: false Global options Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human Related commands Command Description upctl router Manage routers","title":"router list"},{"location":"commands_reference/upctl_router/list/#upctl-router-list","text":"List routers upctl router list [flags]","title":"upctl router list"},{"location":"commands_reference/upctl_router/list/#examples","text":"upctl router list upctl router list --all","title":"Examples"},{"location":"commands_reference/upctl_router/list/#options","text":"Option Description --all Show all routers. --normal Show normal routers. --service Show service routers. --help , -h help for list Default: false","title":"Options"},{"location":"commands_reference/upctl_router/list/#global-options","text":"Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human","title":"Global options"},{"location":"commands_reference/upctl_router/list/#related-commands","text":"Command Description upctl router Manage routers","title":"Related commands"},{"location":"commands_reference/upctl_router/modify/","text":"upctl router modify Modify a router upctl router modify [flags] Examples upctl router modify 04d031ab-4b85-4cbc-9f0e-6a2977541327 --name my_super_router upctl router modify \"My Router\" --name \"My Turbo Router\" Options Option Description --name New router name. --help , -h help for modify Default: false Global options Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human Related commands Command Description upctl router Manage routers","title":"router modify"},{"location":"commands_reference/upctl_router/modify/#upctl-router-modify","text":"Modify a router upctl router modify [flags]","title":"upctl router modify"},{"location":"commands_reference/upctl_router/modify/#examples","text":"upctl router modify 04d031ab-4b85-4cbc-9f0e-6a2977541327 --name my_super_router upctl router modify \"My Router\" --name \"My Turbo Router\"","title":"Examples"},{"location":"commands_reference/upctl_router/modify/#options","text":"Option Description --name New router name. --help , -h help for modify Default: false","title":"Options"},{"location":"commands_reference/upctl_router/modify/#global-options","text":"Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human","title":"Global options"},{"location":"commands_reference/upctl_router/modify/#related-commands","text":"Command Description upctl router Manage routers","title":"Related commands"},{"location":"commands_reference/upctl_router/show/","text":"upctl router show Show current router upctl router show [flags] Examples upctl router show 04d0a7f6-ee78-42b5-8077-6947f9e67c5a upctl router show 04d0a7f6-ee78-42b5-8077-6947f9e67c5a 04d031ab-4b85-4cbc-9f0e-6a2977541327 upctl router show \"My Turbo Router\" my_super_router Options Option Description --help , -h help for show Default: false Global options Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human Related commands Command Description upctl router Manage routers","title":"router show"},{"location":"commands_reference/upctl_router/show/#upctl-router-show","text":"Show current router upctl router show [flags]","title":"upctl router show"},{"location":"commands_reference/upctl_router/show/#examples","text":"upctl router show 04d0a7f6-ee78-42b5-8077-6947f9e67c5a upctl router show 04d0a7f6-ee78-42b5-8077-6947f9e67c5a 04d031ab-4b85-4cbc-9f0e-6a2977541327 upctl router show \"My Turbo Router\" my_super_router","title":"Examples"},{"location":"commands_reference/upctl_router/show/#options","text":"Option Description --help , -h help for show Default: false","title":"Options"},{"location":"commands_reference/upctl_router/show/#global-options","text":"Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human","title":"Global options"},{"location":"commands_reference/upctl_router/show/#related-commands","text":"Command Description upctl router Manage routers","title":"Related commands"},{"location":"commands_reference/upctl_server/","text":"upctl server Manage servers upctl server [flags] Options Option Description --help , -h help for server Default: false Global options Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human Related commands Command Description upctl UpCloud command-line interface upctl server create Create a 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","title":"server "},{"location":"commands_reference/upctl_server/#upctl-server","text":"Manage servers upctl server [flags]","title":"upctl server"},{"location":"commands_reference/upctl_server/#options","text":"Option Description --help , -h help for server Default: false","title":"Options"},{"location":"commands_reference/upctl_server/#global-options","text":"Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human","title":"Global options"},{"location":"commands_reference/upctl_server/#related-commands","text":"Command Description upctl UpCloud command-line interface upctl server create Create a 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","title":"Related commands"},{"location":"commands_reference/upctl_server/create/","text":"upctl server create Create a server upctl server create [flags] Examples upctl server create --title myapp --zone fi-hel1 --hostname myapp --password-delivery email upctl server create --wait --title myapp --zone fi-hel1 --hostname myapp --password-delivery email upctl server create --title \"My Server\" --zone fi-hel1 --hostname myapp --password-delivery email upctl server create --zone fi-hel1 --hostname myapp --password-delivery email --plan 2xCPU-4GB upctl server create --zone fi-hel1 --hostname myapp --password-delivery email --plan custom --cores 2 --memory 4096 upctl server create --zone fi-hel1 --hostname myapp --password-delivery email --os \"Debian GNU/Linux 10 (Buster)\" --server-group a4643646-8342-4324-4134-364138712378 upctl server create --zone fi-hel1 --hostname myapp --ssh-keys /path/to/publickey --network type=private,network=037a530b-533e-4cef-b6ad-6af8094bb2bc,ip-address=10.0.0.1 Options Option Description --avoid-host 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. --enable-remote-access Enable remote access. --host Use this to start a VM on a specific private cloud 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=operations Default: [] --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.1 Default: [] --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 20.04 LTS (Focal Fossa) --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 --password-delivery Defines how password is delivered. Available: email, sms Default: 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=cdrom Default: [] --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, cirrus Default: 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 create Default: false Global options Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human Related commands Command Description upctl server Manage servers","title":"server create"},{"location":"commands_reference/upctl_server/create/#upctl-server-create","text":"Create a server upctl server create [flags]","title":"upctl server create"},{"location":"commands_reference/upctl_server/create/#examples","text":"upctl server create --title myapp --zone fi-hel1 --hostname myapp --password-delivery email upctl server create --wait --title myapp --zone fi-hel1 --hostname myapp --password-delivery email upctl server create --title \"My Server\" --zone fi-hel1 --hostname myapp --password-delivery email upctl server create --zone fi-hel1 --hostname myapp --password-delivery email --plan 2xCPU-4GB upctl server create --zone fi-hel1 --hostname myapp --password-delivery email --plan custom --cores 2 --memory 4096 upctl server create --zone fi-hel1 --hostname myapp --password-delivery email --os \"Debian GNU/Linux 10 (Buster)\" --server-group a4643646-8342-4324-4134-364138712378 upctl server create --zone fi-hel1 --hostname myapp --ssh-keys /path/to/publickey --network type=private,network=037a530b-533e-4cef-b6ad-6af8094bb2bc,ip-address=10.0.0.1","title":"Examples"},{"location":"commands_reference/upctl_server/create/#options","text":"Option Description --avoid-host 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. --enable-remote-access Enable remote access. --host Use this to start a VM on a specific private cloud 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=operations Default: [] --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.1 Default: [] --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 20.04 LTS (Focal Fossa) --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 --password-delivery Defines how password is delivered. Available: email, sms Default: 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=cdrom Default: [] --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, cirrus Default: 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 create Default: false","title":"Options"},{"location":"commands_reference/upctl_server/create/#global-options","text":"Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human","title":"Global options"},{"location":"commands_reference/upctl_server/create/#related-commands","text":"Command Description upctl server Manage servers","title":"Related commands"},{"location":"commands_reference/upctl_server/delete/","text":"upctl server delete Delete a server upctl server delete [flags] Examples upctl server delete 00cbe2f3-4cf9-408b-afee-bd340e13cdd8 upctl server delete 00cbe2f3-4cf9-408b-afee-bd340e13cdd8 0053a6f5-e6d1-4b0b-b9dc-b90d0894e8d0 upctl server delete my_server Options Option Description --delete-storages Delete storages that are attached to the server. --help , -h help for delete Default: false Global options Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human Related commands Command Description upctl server Manage servers","title":"server delete"},{"location":"commands_reference/upctl_server/delete/#upctl-server-delete","text":"Delete a server upctl server delete [flags]","title":"upctl server delete"},{"location":"commands_reference/upctl_server/delete/#examples","text":"upctl server delete 00cbe2f3-4cf9-408b-afee-bd340e13cdd8 upctl server delete 00cbe2f3-4cf9-408b-afee-bd340e13cdd8 0053a6f5-e6d1-4b0b-b9dc-b90d0894e8d0 upctl server delete my_server","title":"Examples"},{"location":"commands_reference/upctl_server/delete/#options","text":"Option Description --delete-storages Delete storages that are attached to the server. --help , -h help for delete Default: false","title":"Options"},{"location":"commands_reference/upctl_server/delete/#global-options","text":"Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human","title":"Global options"},{"location":"commands_reference/upctl_server/delete/#related-commands","text":"Command Description upctl server Manage servers","title":"Related commands"},{"location":"commands_reference/upctl_server/eject/","text":"upctl server eject Eject a CD-ROM from the server upctl server eject [flags] Examples upctl server eject my_server Options Option Description --help , -h help for eject Default: false Global options Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human Related commands Command Description upctl server Manage servers","title":"server eject"},{"location":"commands_reference/upctl_server/eject/#upctl-server-eject","text":"Eject a CD-ROM from the server upctl server eject [flags]","title":"upctl server eject"},{"location":"commands_reference/upctl_server/eject/#examples","text":"upctl server eject my_server","title":"Examples"},{"location":"commands_reference/upctl_server/eject/#options","text":"Option Description --help , -h help for eject Default: false","title":"Options"},{"location":"commands_reference/upctl_server/eject/#global-options","text":"Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human","title":"Global options"},{"location":"commands_reference/upctl_server/eject/#related-commands","text":"Command Description upctl server Manage servers","title":"Related commands"},{"location":"commands_reference/upctl_server/list/","text":"upctl server list List current servers upctl server list [flags] Examples upctl server list upctl server list --show-ip-addresses upctl server list --show-ip-addresses=public Options 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 list Default: false Global options Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human Related commands Command Description upctl server Manage servers","title":"server list"},{"location":"commands_reference/upctl_server/list/#upctl-server-list","text":"List current servers upctl server list [flags]","title":"upctl server list"},{"location":"commands_reference/upctl_server/list/#examples","text":"upctl server list upctl server list --show-ip-addresses upctl server list --show-ip-addresses=public","title":"Examples"},{"location":"commands_reference/upctl_server/list/#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 list Default: false","title":"Options"},{"location":"commands_reference/upctl_server/list/#global-options","text":"Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human","title":"Global options"},{"location":"commands_reference/upctl_server/list/#related-commands","text":"Command Description upctl server Manage servers","title":"Related commands"},{"location":"commands_reference/upctl_server/load/","text":"upctl server load Load a CD-ROM into the server upctl server load [flags] Examples upctl server load my_server4 --storage 01000000-0000-4000-8000-000080030101 Options Option Description --storage The UUID of the storage to be loaded in the CD-ROM device. --help , -h help for load Default: false Global options Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human Related commands Command Description upctl server Manage servers","title":"server load"},{"location":"commands_reference/upctl_server/load/#upctl-server-load","text":"Load a CD-ROM into the server upctl server load [flags]","title":"upctl server load"},{"location":"commands_reference/upctl_server/load/#examples","text":"upctl server load my_server4 --storage 01000000-0000-4000-8000-000080030101","title":"Examples"},{"location":"commands_reference/upctl_server/load/#options","text":"Option Description --storage The UUID of the storage to be loaded in the CD-ROM device. --help , -h help for load Default: false","title":"Options"},{"location":"commands_reference/upctl_server/load/#global-options","text":"Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human","title":"Global options"},{"location":"commands_reference/upctl_server/load/#related-commands","text":"Command Description upctl server Manage servers","title":"Related commands"},{"location":"commands_reference/upctl_server/modify/","text":"upctl server modify Modifies the configuration of an existing server upctl server modify [flags] Examples upctl server modify 00bb4617-c592-4b32-b869-35a60b323b18 --plan 1xCPU-1GB upctl server modify 00bb4617-c592-4b32-b869-35a60b323b18 0053a6f5-e6d1-4b0b-b9dc-b90d0894e8d0 --plan 1xCPU-1GB upctl server modify my_server1 --plan 1xCPU-2GB upctl server modify myapp --hostname superapp Options 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=operations Default: [] --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 modify Default: false Global options Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human Related commands Command Description upctl server Manage servers","title":"server modify"},{"location":"commands_reference/upctl_server/modify/#upctl-server-modify","text":"Modifies the configuration of an existing server upctl server modify [flags]","title":"upctl server modify"},{"location":"commands_reference/upctl_server/modify/#examples","text":"upctl server modify 00bb4617-c592-4b32-b869-35a60b323b18 --plan 1xCPU-1GB upctl server modify 00bb4617-c592-4b32-b869-35a60b323b18 0053a6f5-e6d1-4b0b-b9dc-b90d0894e8d0 --plan 1xCPU-1GB upctl server modify my_server1 --plan 1xCPU-2GB upctl server modify myapp --hostname superapp","title":"Examples"},{"location":"commands_reference/upctl_server/modify/#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=operations Default: [] --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 modify Default: false","title":"Options"},{"location":"commands_reference/upctl_server/modify/#global-options","text":"Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human","title":"Global options"},{"location":"commands_reference/upctl_server/modify/#related-commands","text":"Command Description upctl server Manage servers","title":"Related commands"},{"location":"commands_reference/upctl_server/plans/","text":"upctl server plans List server plans upctl server plans [flags] Examples upctl server plans Options Option Description --help , -h help for plans Default: false Global options Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human Related commands Command Description upctl server Manage servers","title":"server plans"},{"location":"commands_reference/upctl_server/plans/#upctl-server-plans","text":"List server plans upctl server plans [flags]","title":"upctl server plans"},{"location":"commands_reference/upctl_server/plans/#examples","text":"upctl server plans","title":"Examples"},{"location":"commands_reference/upctl_server/plans/#options","text":"Option Description --help , -h help for plans Default: false","title":"Options"},{"location":"commands_reference/upctl_server/plans/#global-options","text":"Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human","title":"Global options"},{"location":"commands_reference/upctl_server/plans/#related-commands","text":"Command Description upctl server Manage servers","title":"Related commands"},{"location":"commands_reference/upctl_server/restart/","text":"upctl server restart Restart a server upctl server restart [flags] Examples upctl server restart 00038afc-d526-4148-af0e-d2f1eeaded9b upctl server restart 00038afc-d526-4148-af0e-d2f1eeaded9b --stop-type hard upctl server restart my_server1 my_server2 Options Option Description --stop-type The type of stop operation. Available: soft, hard Default: soft --help , -h help for restart Default: false Global options Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human Related commands Command Description upctl server Manage servers","title":"server restart"},{"location":"commands_reference/upctl_server/restart/#upctl-server-restart","text":"Restart a server upctl server restart [flags]","title":"upctl server restart"},{"location":"commands_reference/upctl_server/restart/#examples","text":"upctl server restart 00038afc-d526-4148-af0e-d2f1eeaded9b upctl server restart 00038afc-d526-4148-af0e-d2f1eeaded9b --stop-type hard upctl server restart my_server1 my_server2","title":"Examples"},{"location":"commands_reference/upctl_server/restart/#options","text":"Option Description --stop-type The type of stop operation. Available: soft, hard Default: soft --help , -h help for restart Default: false","title":"Options"},{"location":"commands_reference/upctl_server/restart/#global-options","text":"Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human","title":"Global options"},{"location":"commands_reference/upctl_server/restart/#related-commands","text":"Command Description upctl server Manage servers","title":"Related commands"},{"location":"commands_reference/upctl_server/show/","text":"upctl server show Show server details upctl server show [flags] Examples upctl server show 21aeb3b7-cd89-4123-a376-559b0e75be8b upctl server show 21aeb3b7-cd89-4123-a376-559b0e75be8b 0053a6f5-e6d1-4b0b-b9dc-b90d0894e8d0 upctl server show myhostname upctl server show my_server1 my_server2 Options Option Description --help , -h help for show Default: false Global options Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human Related commands Command Description upctl server Manage servers","title":"server show"},{"location":"commands_reference/upctl_server/show/#upctl-server-show","text":"Show server details upctl server show [flags]","title":"upctl server show"},{"location":"commands_reference/upctl_server/show/#examples","text":"upctl server show 21aeb3b7-cd89-4123-a376-559b0e75be8b upctl server show 21aeb3b7-cd89-4123-a376-559b0e75be8b 0053a6f5-e6d1-4b0b-b9dc-b90d0894e8d0 upctl server show myhostname upctl server show my_server1 my_server2","title":"Examples"},{"location":"commands_reference/upctl_server/show/#options","text":"Option Description --help , -h help for show Default: false","title":"Options"},{"location":"commands_reference/upctl_server/show/#global-options","text":"Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human","title":"Global options"},{"location":"commands_reference/upctl_server/show/#related-commands","text":"Command Description upctl server Manage servers","title":"Related commands"},{"location":"commands_reference/upctl_server/start/","text":"upctl server start Start a server upctl server start [flags] Examples upctl server start 00038afc-d526-4148-af0e-d2f1eeaded9b upctl server start 00038afc-d526-4148-af0e-d2f1eeaded9b 0053a6f5-e6d1-4b0b-b9dc-b90d0894e8d0 upctl server start my_server1 Options Option Description --help , -h help for start Default: false Global options Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human Related commands Command Description upctl server Manage servers","title":"server start"},{"location":"commands_reference/upctl_server/start/#upctl-server-start","text":"Start a server upctl server start [flags]","title":"upctl server start"},{"location":"commands_reference/upctl_server/start/#examples","text":"upctl server start 00038afc-d526-4148-af0e-d2f1eeaded9b upctl server start 00038afc-d526-4148-af0e-d2f1eeaded9b 0053a6f5-e6d1-4b0b-b9dc-b90d0894e8d0 upctl server start my_server1","title":"Examples"},{"location":"commands_reference/upctl_server/start/#options","text":"Option Description --help , -h help for start Default: false","title":"Options"},{"location":"commands_reference/upctl_server/start/#global-options","text":"Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human","title":"Global options"},{"location":"commands_reference/upctl_server/start/#related-commands","text":"Command Description upctl server Manage servers","title":"Related commands"},{"location":"commands_reference/upctl_server/stop/","text":"upctl server stop Stop a server upctl server stop [flags] Examples upctl server stop 00cbe2f3-4cf9-408b-afee-bd340e13cdd8 upctl server stop 00cbe2f3-4cf9-408b-afee-bd340e13cdd8 0053a6f5-e6d1-4b0b-b9dc-b90d0894e8d0 upctl server stop my_server upctl server stop --wait my_server Options Option Description --type The type of stop operation. Available: soft, hard Default: soft --wait Wait for server to be in stopped state before returning. --help , -h help for stop Default: false Global options Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human Related commands Command Description upctl server Manage servers","title":"server stop"},{"location":"commands_reference/upctl_server/stop/#upctl-server-stop","text":"Stop a server upctl server stop [flags]","title":"upctl server stop"},{"location":"commands_reference/upctl_server/stop/#examples","text":"upctl server stop 00cbe2f3-4cf9-408b-afee-bd340e13cdd8 upctl server stop 00cbe2f3-4cf9-408b-afee-bd340e13cdd8 0053a6f5-e6d1-4b0b-b9dc-b90d0894e8d0 upctl server stop my_server upctl server stop --wait my_server","title":"Examples"},{"location":"commands_reference/upctl_server/stop/#options","text":"Option Description --type The type of stop operation. Available: soft, hard Default: soft --wait Wait for server to be in stopped state before returning. --help , -h help for stop Default: false","title":"Options"},{"location":"commands_reference/upctl_server/stop/#global-options","text":"Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human","title":"Global options"},{"location":"commands_reference/upctl_server/stop/#related-commands","text":"Command Description upctl server Manage servers","title":"Related commands"},{"location":"commands_reference/upctl_server/firewall/","text":"upctl server firewall Manage server firewall rules. Enabling or disabling the firewall is done in server modify. upctl server firewall [flags] Options Option Description --help , -h help for firewall Default: false Global options Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human Related commands 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.","title":"firewall "},{"location":"commands_reference/upctl_server/firewall/#upctl-server-firewall","text":"Manage server firewall rules. Enabling or disabling the firewall is done in server modify. upctl server firewall [flags]","title":"upctl server firewall"},{"location":"commands_reference/upctl_server/firewall/#options","text":"Option Description --help , -h help for firewall Default: false","title":"Options"},{"location":"commands_reference/upctl_server/firewall/#global-options","text":"Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human","title":"Global options"},{"location":"commands_reference/upctl_server/firewall/#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.","title":"Related commands"},{"location":"commands_reference/upctl_server/firewall/create/","text":"upctl server firewall create 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 [flags] Examples upctl server firewall create 00038afc-d526-4148-af0e-d2f1eeaded9b --direction in --action drop upctl server firewall create 00038afc-d526-4148-af0e-d2f1eeaded9b --direction in --action accept --family IPv4 upctl server firewall create 00038afc-d526-4148-af0e-d2f1eeaded9b --direction in --action drop --family IPv4 --src-ipaddress-block 10.11.0.88/24 Options 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-1000 Default: 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 create Default: false Global options Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human Related commands Command Description upctl server firewall Manage server firewall rules. Enabling or disabling the firewall is done in server modify.","title":"firewall create"},{"location":"commands_reference/upctl_server/firewall/create/#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 [flags]","title":"upctl server firewall create"},{"location":"commands_reference/upctl_server/firewall/create/#examples","text":"upctl server firewall create 00038afc-d526-4148-af0e-d2f1eeaded9b --direction in --action drop upctl server firewall create 00038afc-d526-4148-af0e-d2f1eeaded9b --direction in --action accept --family IPv4 upctl server firewall create 00038afc-d526-4148-af0e-d2f1eeaded9b --direction in --action drop --family IPv4 --src-ipaddress-block 10.11.0.88/24","title":"Examples"},{"location":"commands_reference/upctl_server/firewall/create/#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-1000 Default: 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 create Default: false","title":"Options"},{"location":"commands_reference/upctl_server/firewall/create/#global-options","text":"Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human","title":"Global options"},{"location":"commands_reference/upctl_server/firewall/create/#related-commands","text":"Command Description upctl server firewall Manage server firewall rules. Enabling or disabling the firewall is done in server modify.","title":"Related commands"},{"location":"commands_reference/upctl_server/firewall/delete/","text":"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 delete [flags] Examples upctl server firewall delete 00038afc-d526-4148-af0e-d2f1eeaded9b --position 1 Options Option Description --position Rule position. Available: 1-1000 Default: 0 --help , -h help for delete Default: false Global options Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human Related commands Command Description upctl server firewall Manage server firewall rules. Enabling or disabling the firewall is done in server modify.","title":"firewall delete"},{"location":"commands_reference/upctl_server/firewall/delete/#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 [flags]","title":"upctl server firewall delete"},{"location":"commands_reference/upctl_server/firewall/delete/#examples","text":"upctl server firewall delete 00038afc-d526-4148-af0e-d2f1eeaded9b --position 1","title":"Examples"},{"location":"commands_reference/upctl_server/firewall/delete/#options","text":"Option Description --position Rule position. Available: 1-1000 Default: 0 --help , -h help for delete Default: false","title":"Options"},{"location":"commands_reference/upctl_server/firewall/delete/#global-options","text":"Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human","title":"Global options"},{"location":"commands_reference/upctl_server/firewall/delete/#related-commands","text":"Command Description upctl server firewall Manage server firewall rules. Enabling or disabling the firewall is done in server modify.","title":"Related commands"},{"location":"commands_reference/upctl_server/firewall/show/","text":"upctl server firewall show Show server firewall details. upctl server firewall show [flags] Examples upctl server firewall show 00038afc-d526-4148-af0e-d2f1eeaded9b upctl server firewall show 00038afc-d526-4148-af0e-d2f1eeaded9b 009d7f4e-99ce-4c78-88f1-e695d4c37743 upctl server firewall show my_server Options Option Description --help , -h help for show Default: false Global options Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human Related commands Command Description upctl server firewall Manage server firewall rules. Enabling or disabling the firewall is done in server modify.","title":"firewall show"},{"location":"commands_reference/upctl_server/firewall/show/#upctl-server-firewall-show","text":"Show server firewall details. upctl server firewall show [flags]","title":"upctl server firewall show"},{"location":"commands_reference/upctl_server/firewall/show/#examples","text":"upctl server firewall show 00038afc-d526-4148-af0e-d2f1eeaded9b upctl server firewall show 00038afc-d526-4148-af0e-d2f1eeaded9b 009d7f4e-99ce-4c78-88f1-e695d4c37743 upctl server firewall show my_server","title":"Examples"},{"location":"commands_reference/upctl_server/firewall/show/#options","text":"Option Description --help , -h help for show Default: false","title":"Options"},{"location":"commands_reference/upctl_server/firewall/show/#global-options","text":"Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human","title":"Global options"},{"location":"commands_reference/upctl_server/firewall/show/#related-commands","text":"Command Description upctl server firewall Manage server firewall rules. Enabling or disabling the firewall is done in server modify.","title":"Related commands"},{"location":"commands_reference/upctl_server/network-interface/","text":"upctl server network-interface Manage network interface upctl server network-interface [flags] Options Option Description --help , -h help for network-interface Default: false Global options Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human Related commands 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","title":"network-interface "},{"location":"commands_reference/upctl_server/network-interface/#upctl-server-network-interface","text":"Manage network interface upctl server network-interface [flags]","title":"upctl server network-interface"},{"location":"commands_reference/upctl_server/network-interface/#options","text":"Option Description --help , -h help for network-interface Default: false","title":"Options"},{"location":"commands_reference/upctl_server/network-interface/#global-options","text":"Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human","title":"Global options"},{"location":"commands_reference/upctl_server/network-interface/#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","title":"Related commands"},{"location":"commands_reference/upctl_server/network-interface/create/","text":"upctl server network-interface create Create a network interface upctl server network-interface create [flags] Examples 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 upctl server network-interface create my_server2 --type public --family IPv6 upctl server network-interface create my_server2 --type public --family IPv4 upctl server network-interface create my_server2 --network 037a530b-533e-4cef-b6ad-6af8094bb2bc Options Option Description --network Private network name or UUID to join. --type Set the type of the network. Available: public, utility, private Default: 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 addresses Default: [] --help , -h help for create Default: false Global options Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human Related commands Command Description upctl server network-interface Manage network interface","title":"network-interface create"},{"location":"commands_reference/upctl_server/network-interface/create/#upctl-server-network-interface-create","text":"Create a network interface upctl server network-interface create [flags]","title":"upctl server network-interface create"},{"location":"commands_reference/upctl_server/network-interface/create/#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 upctl server network-interface create my_server2 --type public --family IPv6 upctl server network-interface create my_server2 --type public --family IPv4 upctl server network-interface create my_server2 --network 037a530b-533e-4cef-b6ad-6af8094bb2bc","title":"Examples"},{"location":"commands_reference/upctl_server/network-interface/create/#options","text":"Option Description --network Private network name or UUID to join. --type Set the type of the network. Available: public, utility, private Default: 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 addresses Default: [] --help , -h help for create Default: false","title":"Options"},{"location":"commands_reference/upctl_server/network-interface/create/#global-options","text":"Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human","title":"Global options"},{"location":"commands_reference/upctl_server/network-interface/create/#related-commands","text":"Command Description upctl server network-interface Manage network interface","title":"Related commands"},{"location":"commands_reference/upctl_server/network-interface/delete/","text":"upctl server network-interface delete Delete a network interface upctl server network-interface delete [flags] Examples upctl server network-interface delete 009d7f4e-99ce-4c78-88f1-e695d4c37743 --index 1 upctl server network-interface delete my_server --index 7 Options Option Description --index Interface index. Default: 0 --help , -h help for delete Default: false Global options Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human Related commands Command Description upctl server network-interface Manage network interface","title":"network-interface delete"},{"location":"commands_reference/upctl_server/network-interface/delete/#upctl-server-network-interface-delete","text":"Delete a network interface upctl server network-interface delete [flags]","title":"upctl server network-interface delete"},{"location":"commands_reference/upctl_server/network-interface/delete/#examples","text":"upctl server network-interface delete 009d7f4e-99ce-4c78-88f1-e695d4c37743 --index 1 upctl server network-interface delete my_server --index 7","title":"Examples"},{"location":"commands_reference/upctl_server/network-interface/delete/#options","text":"Option Description --index Interface index. Default: 0 --help , -h help for delete Default: false","title":"Options"},{"location":"commands_reference/upctl_server/network-interface/delete/#global-options","text":"Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human","title":"Global options"},{"location":"commands_reference/upctl_server/network-interface/delete/#related-commands","text":"Command Description upctl server network-interface Manage network interface","title":"Related commands"},{"location":"commands_reference/upctl_server/network-interface/modify/","text":"upctl server network-interface modify Modify a network interface upctl server network-interface modify [flags] Examples upctl server network-interface modify 009d7f4e-99ce-4c78-88f1-e695d4c37743 --index 2 --new-index 1 Options 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 declared Usage: --ip-address address=94.237.112.143,family=IPv4 Default: [] --help , -h help for modify Default: false Global options Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human Related commands Command Description upctl server network-interface Manage network interface","title":"network-interface modify"},{"location":"commands_reference/upctl_server/network-interface/modify/#upctl-server-network-interface-modify","text":"Modify a network interface upctl server network-interface modify [flags]","title":"upctl server network-interface modify"},{"location":"commands_reference/upctl_server/network-interface/modify/#examples","text":"upctl server network-interface modify 009d7f4e-99ce-4c78-88f1-e695d4c37743 --index 2 --new-index 1","title":"Examples"},{"location":"commands_reference/upctl_server/network-interface/modify/#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 declared Usage: --ip-address address=94.237.112.143,family=IPv4 Default: [] --help , -h help for modify Default: false","title":"Options"},{"location":"commands_reference/upctl_server/network-interface/modify/#global-options","text":"Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human","title":"Global options"},{"location":"commands_reference/upctl_server/network-interface/modify/#related-commands","text":"Command Description upctl server network-interface Manage network interface","title":"Related commands"},{"location":"commands_reference/upctl_server/storage/","text":"upctl server storage Manage server storages upctl server storage [flags] Options Option Description --help , -h help for storage Default: false Global options Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human Related commands 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","title":"storage "},{"location":"commands_reference/upctl_server/storage/#upctl-server-storage","text":"Manage server storages upctl server storage [flags]","title":"upctl server storage"},{"location":"commands_reference/upctl_server/storage/#options","text":"Option Description --help , -h help for storage Default: false","title":"Options"},{"location":"commands_reference/upctl_server/storage/#global-options","text":"Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human","title":"Global options"},{"location":"commands_reference/upctl_server/storage/#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","title":"Related commands"},{"location":"commands_reference/upctl_server/storage/attach/","text":"upctl server storage attach Attach a storage as a device to a server upctl server storage attach [flags] Examples upctl server storage attach 00038afc-d526-4148-af0e-d2f1eeaded9b --storage 015899e0-0a68-4949-85bb-261a99de5fdd upctl server storage attach 00038afc-d526-4148-af0e-d2f1eeaded9b --storage 01a5568f-4766-4ce7-abf5-7d257903a735 --address virtio:2 upctl server storage attach my_server1 --storage \"My Storage\" Options Option Description --type Type of the attached storage. Available: disk, cdrom Default: 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 attach Default: false Global options Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human Related commands Command Description upctl server storage Manage server storages","title":"storage attach"},{"location":"commands_reference/upctl_server/storage/attach/#upctl-server-storage-attach","text":"Attach a storage as a device to a server upctl server storage attach [flags]","title":"upctl server storage attach"},{"location":"commands_reference/upctl_server/storage/attach/#examples","text":"upctl server storage attach 00038afc-d526-4148-af0e-d2f1eeaded9b --storage 015899e0-0a68-4949-85bb-261a99de5fdd upctl server storage attach 00038afc-d526-4148-af0e-d2f1eeaded9b --storage 01a5568f-4766-4ce7-abf5-7d257903a735 --address virtio:2 upctl server storage attach my_server1 --storage \"My Storage\"","title":"Examples"},{"location":"commands_reference/upctl_server/storage/attach/#options","text":"Option Description --type Type of the attached storage. Available: disk, cdrom Default: 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 attach Default: false","title":"Options"},{"location":"commands_reference/upctl_server/storage/attach/#global-options","text":"Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human","title":"Global options"},{"location":"commands_reference/upctl_server/storage/attach/#related-commands","text":"Command Description upctl server storage Manage server storages","title":"Related commands"},{"location":"commands_reference/upctl_server/storage/detach/","text":"upctl server storage detach Detaches a storage resource from a server upctl server storage detach [flags] Examples upctl server storage detach 00038afc-d526-4148-af0e-d2f1eeaded9b --address virtio:1 upctl server storage detach my_server1 --address virtio:2 Options Option Description --address Detach the storage attached to this address. --help , -h help for detach Default: false Global options Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human Related commands Command Description upctl server storage Manage server storages","title":"storage detach"},{"location":"commands_reference/upctl_server/storage/detach/#upctl-server-storage-detach","text":"Detaches a storage resource from a server upctl server storage detach [flags]","title":"upctl server storage detach"},{"location":"commands_reference/upctl_server/storage/detach/#examples","text":"upctl server storage detach 00038afc-d526-4148-af0e-d2f1eeaded9b --address virtio:1 upctl server storage detach my_server1 --address virtio:2","title":"Examples"},{"location":"commands_reference/upctl_server/storage/detach/#options","text":"Option Description --address Detach the storage attached to this address. --help , -h help for detach Default: false","title":"Options"},{"location":"commands_reference/upctl_server/storage/detach/#global-options","text":"Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human","title":"Global options"},{"location":"commands_reference/upctl_server/storage/detach/#related-commands","text":"Command Description upctl server storage Manage server storages","title":"Related commands"},{"location":"commands_reference/upctl_servergroup/","text":"upctl servergroup Manage server groups upctl servergroup [flags] Options Option Description --help , -h help for servergroup Default: false Global options Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human Related commands 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","title":"servergroup "},{"location":"commands_reference/upctl_servergroup/#upctl-servergroup","text":"Manage server groups upctl servergroup [flags]","title":"upctl servergroup"},{"location":"commands_reference/upctl_servergroup/#options","text":"Option Description --help , -h help for servergroup Default: false","title":"Options"},{"location":"commands_reference/upctl_servergroup/#global-options","text":"Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human","title":"Global options"},{"location":"commands_reference/upctl_servergroup/#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","title":"Related commands"},{"location":"commands_reference/upctl_servergroup/create/","text":"upctl servergroup create Create a server group upctl servergroup create [flags] Examples upctl servergroup create \\ --title my-server-group \\ --anti-affinity-policy yes \\ --server 1fdfda29-ead1-4855-b71f-a432179800ab \\ --server my-server upctl servergroup create \\ --title my-server-group \\ --anti-affinity-policy yes \\ --label env=dev upctl servergroup create \\ --title my-server-group \\ --anti-affinity-policy strict \\ --label env=dev \\ --label owner=operations Options 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=operations Default: [] --server Servers to be added to the server group, multiple can be declared. Usage: --server my-server --server 00333d1b-3a4a-4b75-820a-4a56d70395dd Default: [] --help , -h help for create Default: false Global options Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human Related commands Command Description upctl servergroup Manage server groups","title":"servergroup create"},{"location":"commands_reference/upctl_servergroup/create/#upctl-servergroup-create","text":"Create a server group upctl servergroup create [flags]","title":"upctl servergroup create"},{"location":"commands_reference/upctl_servergroup/create/#examples","text":"upctl servergroup create \\ --title my-server-group \\ --anti-affinity-policy yes \\ --server 1fdfda29-ead1-4855-b71f-a432179800ab \\ --server my-server upctl servergroup create \\ --title my-server-group \\ --anti-affinity-policy yes \\ --label env=dev upctl servergroup create \\ --title my-server-group \\ --anti-affinity-policy strict \\ --label env=dev \\ --label owner=operations","title":"Examples"},{"location":"commands_reference/upctl_servergroup/create/#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=operations Default: [] --server Servers to be added to the server group, multiple can be declared. Usage: --server my-server --server 00333d1b-3a4a-4b75-820a-4a56d70395dd Default: [] --help , -h help for create Default: false","title":"Options"},{"location":"commands_reference/upctl_servergroup/create/#global-options","text":"Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human","title":"Global options"},{"location":"commands_reference/upctl_servergroup/create/#related-commands","text":"Command Description upctl servergroup Manage server groups","title":"Related commands"},{"location":"commands_reference/upctl_servergroup/delete/","text":"upctl servergroup delete Delete a server group upctl servergroup delete [flags] Examples upctl servergroup delete 8abc8009-4325-4b23-4321-b1232cd81231 upctl servergroup delete my-server-group Options Option Description --help , -h help for delete Default: false Global options Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human Related commands Command Description upctl servergroup Manage server groups","title":"servergroup delete"},{"location":"commands_reference/upctl_servergroup/delete/#upctl-servergroup-delete","text":"Delete a server group upctl servergroup delete [flags]","title":"upctl servergroup delete"},{"location":"commands_reference/upctl_servergroup/delete/#examples","text":"upctl servergroup delete 8abc8009-4325-4b23-4321-b1232cd81231 upctl servergroup delete my-server-group","title":"Examples"},{"location":"commands_reference/upctl_servergroup/delete/#options","text":"Option Description --help , -h help for delete Default: false","title":"Options"},{"location":"commands_reference/upctl_servergroup/delete/#global-options","text":"Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human","title":"Global options"},{"location":"commands_reference/upctl_servergroup/delete/#related-commands","text":"Command Description upctl servergroup Manage server groups","title":"Related commands"},{"location":"commands_reference/upctl_servergroup/list/","text":"upctl servergroup list List current server groups upctl servergroup list [flags] Examples upctl servergroup list Options Option Description --help , -h help for list Default: false Global options Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human Related commands Command Description upctl servergroup Manage server groups","title":"servergroup list"},{"location":"commands_reference/upctl_servergroup/list/#upctl-servergroup-list","text":"List current server groups upctl servergroup list [flags]","title":"upctl servergroup list"},{"location":"commands_reference/upctl_servergroup/list/#examples","text":"upctl servergroup list","title":"Examples"},{"location":"commands_reference/upctl_servergroup/list/#options","text":"Option Description --help , -h help for list Default: false","title":"Options"},{"location":"commands_reference/upctl_servergroup/list/#global-options","text":"Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human","title":"Global options"},{"location":"commands_reference/upctl_servergroup/list/#related-commands","text":"Command Description upctl servergroup Manage server groups","title":"Related commands"},{"location":"commands_reference/upctl_servergroup/modify/","text":"upctl servergroup modify Modify a server group upctl servergroup modify [flags] Examples upctl servergroup modify 8abc8009-4325-4b23-4321-b1232cd81231 --title your-server-group upctl servergroup modify my-server-group --anti-affinity-policy strict upctl servergroup modify my-server-group --server my-server-1 --server my-server-2 --server my-server-3- upctl servergroup modify 8abc8009-4325-4b23-4321-b1232cd81231 --server 0bab98e5-b327-4ab8-ba16-738d4af7578b --server my-server-2 upctl servergroup modify my-server-group --label env=dev Options 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=operations Default: [] --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-4a56d70395dd Default: [] --help , -h help for modify Default: false Global options Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human Related commands Command Description upctl servergroup Manage server groups","title":"servergroup modify"},{"location":"commands_reference/upctl_servergroup/modify/#upctl-servergroup-modify","text":"Modify a server group upctl servergroup modify [flags]","title":"upctl servergroup modify"},{"location":"commands_reference/upctl_servergroup/modify/#examples","text":"upctl servergroup modify 8abc8009-4325-4b23-4321-b1232cd81231 --title your-server-group upctl servergroup modify my-server-group --anti-affinity-policy strict upctl servergroup modify my-server-group --server my-server-1 --server my-server-2 --server my-server-3- upctl servergroup modify 8abc8009-4325-4b23-4321-b1232cd81231 --server 0bab98e5-b327-4ab8-ba16-738d4af7578b --server my-server-2 upctl servergroup modify my-server-group --label env=dev","title":"Examples"},{"location":"commands_reference/upctl_servergroup/modify/#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=operations Default: [] --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-4a56d70395dd Default: [] --help , -h help for modify Default: false","title":"Options"},{"location":"commands_reference/upctl_servergroup/modify/#global-options","text":"Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human","title":"Global options"},{"location":"commands_reference/upctl_servergroup/modify/#related-commands","text":"Command Description upctl servergroup Manage server groups","title":"Related commands"},{"location":"commands_reference/upctl_servergroup/show/","text":"upctl servergroup show Show server group details upctl servergroup show [flags] Examples upctl servergroup show 8abc8009-4325-4b23-4321-b1232cd81231 upctl servergroup show my-server-group Options Option Description --help , -h help for show Default: false Global options Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human Related commands Command Description upctl servergroup Manage server groups","title":"servergroup show"},{"location":"commands_reference/upctl_servergroup/show/#upctl-servergroup-show","text":"Show server group details upctl servergroup show [flags]","title":"upctl servergroup show"},{"location":"commands_reference/upctl_servergroup/show/#examples","text":"upctl servergroup show 8abc8009-4325-4b23-4321-b1232cd81231 upctl servergroup show my-server-group","title":"Examples"},{"location":"commands_reference/upctl_servergroup/show/#options","text":"Option Description --help , -h help for show Default: false","title":"Options"},{"location":"commands_reference/upctl_servergroup/show/#global-options","text":"Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human","title":"Global options"},{"location":"commands_reference/upctl_servergroup/show/#related-commands","text":"Command Description upctl servergroup Manage server groups","title":"Related commands"},{"location":"commands_reference/upctl_storage/","text":"upctl storage Manage storages upctl storage [flags] Options Option Description --help , -h help for storage Default: false Global options Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human Related commands 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","title":"storage "},{"location":"commands_reference/upctl_storage/#upctl-storage","text":"Manage storages upctl storage [flags]","title":"upctl storage"},{"location":"commands_reference/upctl_storage/#options","text":"Option Description --help , -h help for storage Default: false","title":"Options"},{"location":"commands_reference/upctl_storage/#global-options","text":"Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human","title":"Global options"},{"location":"commands_reference/upctl_storage/#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","title":"Related commands"},{"location":"commands_reference/upctl_storage/clone/","text":"upctl storage clone Clone a storage upctl storage clone [flags] Examples upctl storage clone 015899e0-0a68-4949-85bb-261a99de5fdd --title my_storage_clone --zone fi-hel1 upctl storage clone 015899e0-0a68-4949-85bb-261a99de5fdd --title my_storage_clone2 --zone pl-waw1 --tier maxiops upctl storage clone \"My Storage\" --title my_storage_clone3 --zone pl-waw1 --tier maxiops Options 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. --help , -h help for clone Default: false Global options Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human Related commands Command Description upctl storage Manage storages","title":"storage clone"},{"location":"commands_reference/upctl_storage/clone/#upctl-storage-clone","text":"Clone a storage upctl storage clone [flags]","title":"upctl storage clone"},{"location":"commands_reference/upctl_storage/clone/#examples","text":"upctl storage clone 015899e0-0a68-4949-85bb-261a99de5fdd --title my_storage_clone --zone fi-hel1 upctl storage clone 015899e0-0a68-4949-85bb-261a99de5fdd --title my_storage_clone2 --zone pl-waw1 --tier maxiops upctl storage clone \"My Storage\" --title my_storage_clone3 --zone pl-waw1 --tier maxiops","title":"Examples"},{"location":"commands_reference/upctl_storage/clone/#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. --help , -h help for clone Default: false","title":"Options"},{"location":"commands_reference/upctl_storage/clone/#global-options","text":"Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human","title":"Global options"},{"location":"commands_reference/upctl_storage/clone/#related-commands","text":"Command Description upctl storage Manage storages","title":"Related commands"},{"location":"commands_reference/upctl_storage/create/","text":"upctl storage create Create a storage upctl storage create [flags] Examples upctl storage create --zone pl-waw1 --title \"My Storage\" upctl storage create --zone pl-waw1 --title my_storage --size 20 --backup-interval wed --backup-retention 4 Options 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 --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 Default: daily --backup-retention How long to store the backups in days. The accepted range is 1-1095 Default: 7 --help , -h help for create Default: false Global options Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human Related commands Command Description upctl storage Manage storages","title":"storage create"},{"location":"commands_reference/upctl_storage/create/#upctl-storage-create","text":"Create a storage upctl storage create [flags]","title":"upctl storage create"},{"location":"commands_reference/upctl_storage/create/#examples","text":"upctl storage create --zone pl-waw1 --title \"My Storage\" upctl storage create --zone pl-waw1 --title my_storage --size 20 --backup-interval wed --backup-retention 4","title":"Examples"},{"location":"commands_reference/upctl_storage/create/#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 --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 Default: daily --backup-retention How long to store the backups in days. The accepted range is 1-1095 Default: 7 --help , -h help for create Default: false","title":"Options"},{"location":"commands_reference/upctl_storage/create/#global-options","text":"Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human","title":"Global options"},{"location":"commands_reference/upctl_storage/create/#related-commands","text":"Command Description upctl storage Manage storages","title":"Related commands"},{"location":"commands_reference/upctl_storage/delete/","text":"upctl storage delete Delete a storage upctl storage delete [flags] Examples upctl storage delete 01ac5319-08ac-4e7b-81e5-3140d2bbd7d8 upctl storage delete 0175bb34-8aed-47ce-9290-10cc45f78601 01fcb78f-e73d-4e4d-af5a-0bd6cdba4306 upctl storage delete \"My Storage\" Options Option Description --help , -h help for delete Default: false Global options Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human Related commands Command Description upctl storage Manage storages","title":"storage delete"},{"location":"commands_reference/upctl_storage/delete/#upctl-storage-delete","text":"Delete a storage upctl storage delete [flags]","title":"upctl storage delete"},{"location":"commands_reference/upctl_storage/delete/#examples","text":"upctl storage delete 01ac5319-08ac-4e7b-81e5-3140d2bbd7d8 upctl storage delete 0175bb34-8aed-47ce-9290-10cc45f78601 01fcb78f-e73d-4e4d-af5a-0bd6cdba4306 upctl storage delete \"My Storage\"","title":"Examples"},{"location":"commands_reference/upctl_storage/delete/#options","text":"Option Description --help , -h help for delete Default: false","title":"Options"},{"location":"commands_reference/upctl_storage/delete/#global-options","text":"Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human","title":"Global options"},{"location":"commands_reference/upctl_storage/delete/#related-commands","text":"Command Description upctl storage Manage storages","title":"Related commands"},{"location":"commands_reference/upctl_storage/import/","text":"upctl storage import Import a storage from external or local source upctl storage import [flags] Examples 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 Options 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 --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 Default: daily --backup-retention How long to store the backups in days. The accepted range is 1-1095 Default: 7 --help , -h help for import Default: false Global options Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human Related commands Command Description upctl storage Manage storages","title":"storage import"},{"location":"commands_reference/upctl_storage/import/#upctl-storage-import","text":"Import a storage from external or local source upctl storage import [flags]","title":"upctl storage import"},{"location":"commands_reference/upctl_storage/import/#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","title":"Examples"},{"location":"commands_reference/upctl_storage/import/#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 --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 Default: daily --backup-retention How long to store the backups in days. The accepted range is 1-1095 Default: 7 --help , -h help for import Default: false","title":"Options"},{"location":"commands_reference/upctl_storage/import/#global-options","text":"Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human","title":"Global options"},{"location":"commands_reference/upctl_storage/import/#related-commands","text":"Command Description upctl storage Manage storages","title":"Related commands"},{"location":"commands_reference/upctl_storage/list/","text":"upctl storage list List current storages upctl storage list [flags] Examples upctl storage list upctl storage list --all Options 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 list Default: false Global options Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human Related commands Command Description upctl storage Manage storages","title":"storage list"},{"location":"commands_reference/upctl_storage/list/#upctl-storage-list","text":"List current storages upctl storage list [flags]","title":"upctl storage list"},{"location":"commands_reference/upctl_storage/list/#examples","text":"upctl storage list upctl storage list --all","title":"Examples"},{"location":"commands_reference/upctl_storage/list/#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 list Default: false","title":"Options"},{"location":"commands_reference/upctl_storage/list/#global-options","text":"Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human","title":"Global options"},{"location":"commands_reference/upctl_storage/list/#related-commands","text":"Command Description upctl storage Manage storages","title":"Related commands"},{"location":"commands_reference/upctl_storage/modify/","text":"upctl storage modify Modify a storage upctl storage modify [flags] Examples upctl storage modify 01271548-2e92-44bb-9774-d282508cc762 --title \"My Storage\" --size 20 upctl storage modify \"My Storage\" --size 25 Options 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 incure costs.. --help , -h help for modify Default: false Global options Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human Related commands Command Description upctl storage Manage storages","title":"storage modify"},{"location":"commands_reference/upctl_storage/modify/#upctl-storage-modify","text":"Modify a storage upctl storage modify [flags]","title":"upctl storage modify"},{"location":"commands_reference/upctl_storage/modify/#examples","text":"upctl storage modify 01271548-2e92-44bb-9774-d282508cc762 --title \"My Storage\" --size 20 upctl storage modify \"My Storage\" --size 25","title":"Examples"},{"location":"commands_reference/upctl_storage/modify/#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 incure costs.. --help , -h help for modify Default: false","title":"Options"},{"location":"commands_reference/upctl_storage/modify/#global-options","text":"Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human","title":"Global options"},{"location":"commands_reference/upctl_storage/modify/#related-commands","text":"Command Description upctl storage Manage storages","title":"Related commands"},{"location":"commands_reference/upctl_storage/show/","text":"upctl storage show Show storage details upctl storage show [flags] Examples upctl storage show 01271548-2e92-44bb-9774-d282508cc762 upctl storage show 01271548-2e92-44bb-9774-d282508cc762 01c60190-3a01-4108-b1c3-2e828855ccc0 upctl storage show \"My Storage\" Options Option Description --help , -h help for show Default: false Global options Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human Related commands Command Description upctl storage Manage storages","title":"storage show"},{"location":"commands_reference/upctl_storage/show/#upctl-storage-show","text":"Show storage details upctl storage show [flags]","title":"upctl storage show"},{"location":"commands_reference/upctl_storage/show/#examples","text":"upctl storage show 01271548-2e92-44bb-9774-d282508cc762 upctl storage show 01271548-2e92-44bb-9774-d282508cc762 01c60190-3a01-4108-b1c3-2e828855ccc0 upctl storage show \"My Storage\"","title":"Examples"},{"location":"commands_reference/upctl_storage/show/#options","text":"Option Description --help , -h help for show Default: false","title":"Options"},{"location":"commands_reference/upctl_storage/show/#global-options","text":"Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human","title":"Global options"},{"location":"commands_reference/upctl_storage/show/#related-commands","text":"Command Description upctl storage Manage storages","title":"Related commands"},{"location":"commands_reference/upctl_storage/templatise/","text":"upctl storage templatise Templatise a storage upctl storage templatise [flags] Examples upctl storage templatise 01271548-2e92-44bb-9774-d282508cc762 --title \"My Template\" upctl storage templatise 01271548-2e92-44bb-9774-d282508cc762 --title \"My Template\" --wait upctl storage templatise \"My Storage\" --title super_template Options Option Description --title A short, informational description. --wait Wait for storage to be in online state before returning. --help , -h help for templatise Default: false Global options Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human Related commands Command Description upctl storage Manage storages","title":"storage templatise"},{"location":"commands_reference/upctl_storage/templatise/#upctl-storage-templatise","text":"Templatise a storage upctl storage templatise [flags]","title":"upctl storage templatise"},{"location":"commands_reference/upctl_storage/templatise/#examples","text":"upctl storage templatise 01271548-2e92-44bb-9774-d282508cc762 --title \"My Template\" upctl storage templatise 01271548-2e92-44bb-9774-d282508cc762 --title \"My Template\" --wait upctl storage templatise \"My Storage\" --title super_template","title":"Examples"},{"location":"commands_reference/upctl_storage/templatise/#options","text":"Option Description --title A short, informational description. --wait Wait for storage to be in online state before returning. --help , -h help for templatise Default: false","title":"Options"},{"location":"commands_reference/upctl_storage/templatise/#global-options","text":"Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human","title":"Global options"},{"location":"commands_reference/upctl_storage/templatise/#related-commands","text":"Command Description upctl storage Manage storages","title":"Related commands"},{"location":"commands_reference/upctl_storage/backup/","text":"upctl storage backup Manage backups upctl storage backup [flags] Options Option Description --help , -h help for backup Default: false Global options Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human Related commands Command Description upctl storage Manage storages upctl storage backup create Create backup of a storage upctl storage backup restore Restore backup of a storage","title":"backup "},{"location":"commands_reference/upctl_storage/backup/#upctl-storage-backup","text":"Manage backups upctl storage backup [flags]","title":"upctl storage backup"},{"location":"commands_reference/upctl_storage/backup/#options","text":"Option Description --help , -h help for backup Default: false","title":"Options"},{"location":"commands_reference/upctl_storage/backup/#global-options","text":"Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human","title":"Global options"},{"location":"commands_reference/upctl_storage/backup/#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","title":"Related commands"},{"location":"commands_reference/upctl_storage/backup/create/","text":"upctl storage backup create Create backup of a storage upctl storage backup create [flags] Examples upctl storage backup create 01cbea5e-eb5b-4072-b2ac-9b635120e5d8 --title \"first backup\" upctl storage backup create \"My Storage\" --title second_backup Options Option Description --title A short, informational description. --help , -h help for create Default: false Global options Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human Related commands Command Description upctl storage backup Manage backups","title":"backup create"},{"location":"commands_reference/upctl_storage/backup/create/#upctl-storage-backup-create","text":"Create backup of a storage upctl storage backup create [flags]","title":"upctl storage backup create"},{"location":"commands_reference/upctl_storage/backup/create/#examples","text":"upctl storage backup create 01cbea5e-eb5b-4072-b2ac-9b635120e5d8 --title \"first backup\" upctl storage backup create \"My Storage\" --title second_backup","title":"Examples"},{"location":"commands_reference/upctl_storage/backup/create/#options","text":"Option Description --title A short, informational description. --help , -h help for create Default: false","title":"Options"},{"location":"commands_reference/upctl_storage/backup/create/#global-options","text":"Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human","title":"Global options"},{"location":"commands_reference/upctl_storage/backup/create/#related-commands","text":"Command Description upctl storage backup Manage backups","title":"Related commands"},{"location":"commands_reference/upctl_storage/backup/restore/","text":"upctl storage backup restore Restore backup of a storage upctl storage backup restore [flags] Examples upctl storage backup restore 01177c9e-7f76-4ce4-b128-bcaa3448f7ec upctl storage backup restore second_backup Options Option Description --help , -h help for restore Default: false Global options Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human Related commands Command Description upctl storage backup Manage backups","title":"backup restore"},{"location":"commands_reference/upctl_storage/backup/restore/#upctl-storage-backup-restore","text":"Restore backup of a storage upctl storage backup restore [flags]","title":"upctl storage backup restore"},{"location":"commands_reference/upctl_storage/backup/restore/#examples","text":"upctl storage backup restore 01177c9e-7f76-4ce4-b128-bcaa3448f7ec upctl storage backup restore second_backup","title":"Examples"},{"location":"commands_reference/upctl_storage/backup/restore/#options","text":"Option Description --help , -h help for restore Default: false","title":"Options"},{"location":"commands_reference/upctl_storage/backup/restore/#global-options","text":"Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human","title":"Global options"},{"location":"commands_reference/upctl_storage/backup/restore/#related-commands","text":"Command Description upctl storage backup Manage backups","title":"Related commands"},{"location":"commands_reference/upctl_zone/","text":"upctl zone Display zone information upctl zone [flags] Options Option Description --help , -h help for zone Default: false Global options Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human Related commands Command Description upctl UpCloud command-line interface upctl zone list List available zones","title":"zone "},{"location":"commands_reference/upctl_zone/#upctl-zone","text":"Display zone information upctl zone [flags]","title":"upctl zone"},{"location":"commands_reference/upctl_zone/#options","text":"Option Description --help , -h help for zone Default: false","title":"Options"},{"location":"commands_reference/upctl_zone/#global-options","text":"Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human","title":"Global options"},{"location":"commands_reference/upctl_zone/#related-commands","text":"Command Description upctl UpCloud command-line interface upctl zone list List available zones","title":"Related commands"},{"location":"commands_reference/upctl_zone/list/","text":"upctl zone list List available zones upctl zone list [flags] Examples upctl zone list Options Option Description --help , -h help for list Default: false Global options Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human Related commands Command Description upctl zone Display zone information","title":"zone list"},{"location":"commands_reference/upctl_zone/list/#upctl-zone-list","text":"List available zones upctl zone list [flags]","title":"upctl zone list"},{"location":"commands_reference/upctl_zone/list/#examples","text":"upctl zone list","title":"Examples"},{"location":"commands_reference/upctl_zone/list/#options","text":"Option Description --help , -h help for list Default: false","title":"Options"},{"location":"commands_reference/upctl_zone/list/#global-options","text":"Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human","title":"Global options"},{"location":"commands_reference/upctl_zone/list/#related-commands","text":"Command Description upctl zone Display zone information","title":"Related commands"}]} \ No newline at end of file +{"config":{"indexing":"full","lang":["en"],"min_search_length":3,"prebuild_index":false,"separator":"[\\s\\-]+"},"docs":[{"location":"","text":"Getting started upctl provides a command-line interface to UpCloud services. It allows you to control your resources from the command line or any compatible interface.","title":"Getting started"},{"location":"#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.","title":"Getting started"},{"location":"changelog/","text":"Changelog 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 . Unreleased Added Add backend TLS configs field to loadbalancer show command 3.2.0 - 2023-11-15 Added Add objectstorage commands ( delete , list , show ) for Managed object storage management 3.1.0 - 2023-11-06 Added Add network_peerings , ntp_excess_gib , storage_maxiops and load_balancers fields to account show outputs. Add --version parameter to kubernetes create and version field to kubernetes show output. Changed Breaking : Update return type of kubernetes versions from list of strings to list of objects. (No major version bump, because this end-point has not been included in the API docs) Fixed Use correct currency symbol, \u20ac instead of $ , in human output of account show . 3.0.0 - 2023-10-18 This release updates output of show and list commands to return the API response as defined in the UpCloud Go SDK. See below for detailed list of changes. In addition, kubernetes create will now, by default, block all access to the cluster. To be able to connect to the cluster, define list of allowed IP addresses and/or CIDR blocks or allow access from any IP. Added Breaking : Add --kubernetes-api-allow-ip argument to kubernetes create command. This changes default behavior from allow access from any IP to block access from all IPs . To be able to connect to the cluster, define list of allowed IP addresses and/or CIDR blocks or allow access from any IP. Add Kubernetes API allowed IPs field to kubernetes show output. Add kubernetes nodegroup show for displaying node-group details. This also adds Nodes table and Anti-affinity field that were not available in previous kubernetes show output. Add kubernetes modify command for modifying IP addresses that are allowed to access cluster's Kubernetes API. Add Kubernetes API allowed IPs field to kubernetes show output. Add database session list for listing active database sessions. Add database session cancel for cancelling an active database session. Changed Breaking : In JSON and YAML output of database list : return the full API response. Value of title is not replaced with value from name , if title is empty. Breaking : In JSON and YAML output of database types : return the full API response. This changes the top level datatype from list to object, where keys are the available database type, e.g., pg and mysql . Breaking : In JSON and YAML output of ip-address list : return the full API response. This changes partofplan key to part_of_plan and ptrrecord key to ptr_record . The top level data-type changes from list to object. Breaking : In JSON and YAML output of loadbalancer list : return the full API response. This changes state field to operational_state . Breaking : In JSON and YAML output of network list and network show : return the full API response. Servers list will only contain server UUID and name. In network list output, the top level data-type changes from list to object. Breaking : In JSON and YAML output of server list and server show : return the full API response. This changes field host_id to host . nics is replaced with networking subfield interfaces . storage is replaced with storage_devices . labels contain subfield label which in turn contains the labels. In server list output, the top level data-type changes from list to object. Breaking : In JSON and YAML output of server firewall show : return the full API response. This removes fields destination and source fields in favor of [destination|source]_address_start , [destination|source]_address_end , [destination|source]_port_start and [destination|source]_port_end . Breaking : In JSON and YAML output of server plans : return the full API response. The top level data-type changes from list to object. Breaking : In JSON and YAML output of storage list and storage show : return the full API response. This changes servers field to contain server field, which in turn contains the servers. labels field will not be outputted if empty. In storage list output, the top level data-type changes from list to object. Breaking : In JSON and YAML output of zone list : return the full API response. The top level data-type changes from list to object. In JSON and YAML output of kubernetes list : return the full API response. In human readable output of kubernetes show command, show node-groups as table. Node-group details are available with kubernetes nodegroup show command. Fixed Breaking : In JSON and YAML output of ip-address show : use same JSON keys as in API documentation. This removes credits key that was used in place of floating . Removed Breaking : Remove database connection list and database connection cancel commands in favor of database session counterparts Breaking : In JSON and YAML output of database properties * show : pass-through the API response. This removes key field from the output. 2.10.0 - 2023-07-17 Added Add --disable-utility-network-access for kubernetes nodegroup create command Fixed Use pending color (yellow) for kubernetes node group scaling-down and scaling-up states 2.9.1 - 2023-07-06 Changed Release artifacts to follow package naming conventions provided by nFPM . upcloud-cli-2.9.0_x86_64.rpm vs upcloud-cli-2.9.1.x86_64.rpm # no convention changes upcloud-cli-2.9.0_arm64.rpm vs upcloud-cli-2.9.1.aarch64.rpm # `arm64` -> `aarch64` upcloud-cli-2.9.0_amd64.apk vs upcloud-cli_2.9.1_x86_64.apk # `cli-` -> `cli_` & `amd64` -> `x86_64` upcloud-cli-2.9.0_arm64.apk vs upcloud-cli_2.9.1_aarch64.apk # `cli-` -> `cli_` & `arm64` -> `aarch64` upcloud-cli-2.9.0_amd64.deb vs upcloud-cli_2.9.1_amd64.deb # `cli-` -> `cli_` upcloud-cli-2.9.0_arm64.deb vs upcloud-cli_2.9.1_arm64.deb # `cli-` -> `cli_` 2.9.0 - 2023-06-30 Added Add servergroup commands ( create , delete , list , modify , show ) for server group management 2.8.0 - 2023-06-21 Added Add support for OpenSearch database type Add database index list and database index commands for managing OpenSearch database indices Add completions for --zone arguments. Add --private-node-groups argument to kubernetes create command. Add Private node groups field to kubernetes show output. Add --label flag to server create and server modify commands 2.7.1 - 2023-05-16 Fixed Updated examples of kubernetes create command to use valid plans. 2.7.0 - 2023-05-02 Added Add ip and net as aliases to ip-address and network commands, respectively. Add Labels table to loadbalancer show , network show , router show , server show , and storage show outputs. Add kubernetes plans command for listing available plans. Add --plan argument to kubernetes create command for selecting cluster plan. Add --wait flag to kubernetes create command for waiting created cluster to reach running state. 2.6.0 - 2023-03-14 Added The upctl container image now includes jq tool for parsing values from JSON output. Add node-group states to kubernetes show output. Add completions for --network argument of kubernetes create and server network-interface create . Support also network name as input for --network argument of kubernetes create and server network-interface create Changed Completions will now only suggest private networks as arguments because names or UUIDs of public or utility networks are often not valid arguments. 2.5.0 - 2023-02-15 Added Print warning about unknown resource state before exiting when execution is interrupted with SIGINT. Add kubernetes nodegroup create , kubernetes nodegroup scale , and kubernetes nodegroup delete commands (EXPERIMENTAL) Added support for all shell completions provided by cobra . Add database properties command to list database properties for given database type and database properties show command to show database property details. Changed Remove custom bash completion logic and replace it with completion command provided by cobra . To do this while supporting args with whitespace, whitespace in completions is replaced with non-breaking spaces. Fixed In database show : parse database version from metadata instead of properties. This enables displaying redis version instead of . 2.4.0 - 2022-12-19 Added Add kubernetes create , kubernetes config , kubernetes delete , kubernetes list , kubernetes show , kubernetes versions commands (EXPERIMENTAL) Add loadbalancer plans command for listing available LB plans 2.3.0 - 2022-11-11 Added Complete available types for database plans . Suppress positional argument filename completion for commands without specific completions. In database list output: if database has no title, database name is displayed in the title cell instead of leaving the cell empty, similarly than in the hub. Version information is parsed from BuildInfo when upctl binary was built without specifying -ldflags to define value for .../config.Version . Use alpine as base image for upcloud/upctl container image. This adds sh and other OS tools to the image and thus makes it more suitable for usage in CI systems. Fixed Remove debug leftover print from IP address completions. Added /v2 postfix to module name in go.mod , this enables installing v2 versions of CLI with go install . 2.2.0 - 2022-10-17 Added Include runtime operating system and architecture in version command output. Include instructions for defining credentials and API access in upctl --help output. Fixed Fix commands in server delete usage examples. Tune human output so that normal output is directed to stdout . Progess and error messages are still outputted to stderr . 2.1.0 - 2022-09-07 Added Add --wait flag to storage import and storage templatise commands to wait until storage is in online state. In JSON and YAML output of storage import : information on target storage is now available under storage key. Fixed In human output of storage list : capitalize zone column header and color storage state similarly than in storage show . In human output of storage import : output UUID of created storage, instead of storage import operation. No UUID is outputted if existing storage was used. 2.0.0 - 2022-08-30 Added Add database delete command. Add loadbalancer delete command. Add Access field to storage show output. Add fields argument and resource to JSON and YAML error outputs. Changed Breaking : Human output, including errors, is written to stderr instead of stdout. Refactor progress logging. This changes the appearance of progress logs. See UpCloudLtd / progress for the new implementation. Fixed Breaking : Set non-zero exit code if command execution fails. Breaking : Render servers IP addresses as array of objects, instead of previous pretty-printed string, in JSON and YAML outputs of server show . Breaking : Use key names from json field tag also in YAML output to have equal key names in JSON and YAML outputs. For example, bootorder key in server details will now be boot_order also in YAML output. As a side-effect data-types are limited to those supported by JSON. For example, timestamps will be presented as (double-quoted) strings. In addition, if command targets multiple resources, YAML output will now be a list, similarly than in JSON output, instead of previous multiple YAML documents. Breaking : In JSON and YAML output, storage show lists attached servers in servers list instead of server string. Breaking : In JSON and YAML output, network show lists DHCP DNS values in list instead of string. On network show , output server details as unknown instead of outputting an error, if fetching server details fails. This allows displaying network details for networks that contain a load balancer. Progress logging to non TTY output uses now 100 as text width instead of 0. 1.5.1 - 2022-07-15 Fixed On server create , mount OS disk by default on virtio bus. Previously default OS storage address was not explicit and varyed depending on template type. Disable colors if user has set NO_COLOR environment variable to non-empty value. 1.5.0 - 2022-07-05 Added Add --show-ip-addresses flag to server list command to optionally include IP addresses in command output. Add database connection list , database connection cancel , database start , and database stop commands. Changed Make --family parameter of server firewall create command optional to allow editing the default rules. Update cobra to v1.5.0 and refactor required flag validation code. This affects validation error messages. Fixed Complete shell input with uppercase letters (e.g., Cap to CapitalizedName will now work) Display UUID of created template in storage templatise output. 1.4.0 - 2022-06-15 Added Add database list , database show , database plans , and database types commands. Add loadbalancer list and loadbalancer show commands. Add db and lb aliases to database and loadbalancer , respectively. Changed Color server state in server list output similarly than in server show output. Update Go version to 1.18 Update upcloud-go-api to v4.8.0 1.3.0 - 2022-05-17 Added Add zone list command that lists available zones. Add --wait flag to server create and server stop commands to wait until server is in started and stopped state, respectively. Changed Update upcloud-go-api to v4.5.2 Fixed Do not display usage if execution fails because of missing credentials Mark error and warning livelogs finished when they will not be updated anymore: this stops the timer in the end of the row and stops livelog from refreshing these lines. 1.2.0 - 2022-04-29 Added Include UUID (or address) of created resource in create command output storage modify command now accepts enable-filesystem-autoresize flag. When that flag is set upctl will attempt to resize partition and filesystem after storage size has been modified. Changed New go-api version v4.5.0 Fixed Improved errors relating to argument resolver failures Print version info, instead of missing credentials error, when runnning upctl version without credentials Disable colors when outputting in JSON or YAML format Display both public and private addresses in server create output Render livelog messages of commands which execution takes less than render tick interval 1.1.3 - 2022-02-24 Changed Update documentation Fixed Fix storage command attached-to-server key overrides zone 1.1.2 - 2022-01-21 Fixed New release with no changes to fix the Homebrew deprecation notice 1.1.1 - 2021-09-30 Changed Change password creation to be disabled by default in server creation Always create a password when password delivery method is chosen 1.1.0 - 2021-06-03 Added Debug mode for finding root causes to problems Docker image and upload to Docker Hub Autogenerated documentation under /docs Terminal width handling Changed Global flags for colors refactored to --force-colour and --no-colour New go-api version Improved error messages Fixes No coloring of texts if stdout is not a terminal Detaching routers works now with the new --detach-router parameter in network modify 1.0.0 - 2021-04-16 First non-beta release! Includes all previous changes and fixes. 0.6.0 - 2021-04-16 Changed Use goreleaser for releasing packages Move creation of service outside runcommand to facilitate testing Fixes fix(pre-commit): add missing golangci config file fix(root): use default cobra behavious when called 0.5.0 - 2021-04-14 Initial public beta release :tada: Added Added commands for managing server firewall rules Fixed Shell auto-completion fixed Changed Input & output handling rewritten Several help text fixes & changes Default OS changed to Ubuntu 20.04 Defaults for networks / routers in line with storages, so we'll show users' own resources by default 0.1.1 - 2021-03-12 Fixed Load config files from the correct place on Windows Fix storage import failing on readerCounter not implementing io.Reader 0.1.0 - 2021-03-10 Added Current feature set added! First internal release","title":"Changelog"},{"location":"changelog/#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 .","title":"Changelog"},{"location":"changelog/#unreleased","text":"","title":"Unreleased"},{"location":"changelog/#added","text":"Add backend TLS configs field to loadbalancer show command","title":"Added"},{"location":"changelog/#320-2023-11-15","text":"","title":"3.2.0 - 2023-11-15"},{"location":"changelog/#added_1","text":"Add objectstorage commands ( delete , list , show ) for Managed object storage management","title":"Added"},{"location":"changelog/#310-2023-11-06","text":"","title":"3.1.0 - 2023-11-06"},{"location":"changelog/#added_2","text":"Add network_peerings , ntp_excess_gib , storage_maxiops and load_balancers fields to account show outputs. Add --version parameter to kubernetes create and version field to kubernetes show output.","title":"Added"},{"location":"changelog/#changed","text":"Breaking : Update return type of kubernetes versions from list of strings to list of objects. (No major version bump, because this end-point has not been included in the API docs)","title":"Changed"},{"location":"changelog/#fixed","text":"Use correct currency symbol, \u20ac instead of $ , in human output of account show .","title":"Fixed"},{"location":"changelog/#300-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.","title":"3.0.0 - 2023-10-18"},{"location":"changelog/#added_3","text":"Breaking : Add --kubernetes-api-allow-ip argument to kubernetes create command. This changes default behavior from allow access from any IP to block access from all IPs . To be able to connect to the cluster, define list of allowed IP addresses and/or CIDR blocks or allow access from any IP. Add Kubernetes API allowed IPs field to kubernetes show output. Add kubernetes nodegroup show for displaying node-group details. This also adds Nodes table and Anti-affinity field that were not available in previous kubernetes show output. Add kubernetes modify command for modifying IP addresses that are allowed to access cluster's Kubernetes API. Add Kubernetes API allowed IPs field to kubernetes show output. Add database session list for listing active database sessions. Add database session cancel for cancelling an active database session.","title":"Added"},{"location":"changelog/#changed_1","text":"Breaking : In JSON and YAML output of database list : return the full API response. Value of title is not replaced with value from name , if title is empty. Breaking : In JSON and YAML output of database types : return the full API response. This changes the top level datatype from list to object, where keys are the available database type, e.g., pg and mysql . Breaking : In JSON and YAML output of ip-address list : return the full API response. This changes partofplan key to part_of_plan and ptrrecord key to ptr_record . The top level data-type changes from list to object. Breaking : In JSON and YAML output of loadbalancer list : return the full API response. This changes state field to operational_state . Breaking : In JSON and YAML output of network list and network show : return the full API response. Servers list will only contain server UUID and name. In network list output, the top level data-type changes from list to object. Breaking : In JSON and YAML output of server list and server show : return the full API response. This changes field host_id to host . nics is replaced with networking subfield interfaces . storage is replaced with storage_devices . labels contain subfield label which in turn contains the labels. In server list output, the top level data-type changes from list to object. Breaking : In JSON and YAML output of server firewall show : return the full API response. This removes fields destination and source fields in favor of [destination|source]_address_start , [destination|source]_address_end , [destination|source]_port_start and [destination|source]_port_end . Breaking : In JSON and YAML output of server plans : return the full API response. The top level data-type changes from list to object. Breaking : In JSON and YAML output of storage list and storage show : return the full API response. This changes servers field to contain server field, which in turn contains the servers. labels field will not be outputted if empty. In storage list output, the top level data-type changes from list to object. Breaking : In JSON and YAML output of zone list : return the full API response. The top level data-type changes from list to object. In JSON and YAML output of kubernetes list : return the full API response. In human readable output of kubernetes show command, show node-groups as table. Node-group details are available with kubernetes nodegroup show command.","title":"Changed"},{"location":"changelog/#fixed_1","text":"Breaking : In JSON and YAML output of ip-address show : use same JSON keys as in API documentation. This removes credits key that was used in place of floating .","title":"Fixed"},{"location":"changelog/#removed","text":"Breaking : Remove database connection list and database connection cancel commands in favor of database session counterparts Breaking : In JSON and YAML output of database properties * show : pass-through the API response. This removes key field from the output.","title":"Removed"},{"location":"changelog/#2100-2023-07-17","text":"","title":"2.10.0 - 2023-07-17"},{"location":"changelog/#added_4","text":"Add --disable-utility-network-access for kubernetes nodegroup create command","title":"Added"},{"location":"changelog/#fixed_2","text":"Use pending color (yellow) for kubernetes node group scaling-down and scaling-up states","title":"Fixed"},{"location":"changelog/#291-2023-07-06","text":"","title":"2.9.1 - 2023-07-06"},{"location":"changelog/#changed_2","text":"Release artifacts to follow package naming conventions provided by nFPM . upcloud-cli-2.9.0_x86_64.rpm vs upcloud-cli-2.9.1.x86_64.rpm # no convention changes upcloud-cli-2.9.0_arm64.rpm vs upcloud-cli-2.9.1.aarch64.rpm # `arm64` -> `aarch64` upcloud-cli-2.9.0_amd64.apk vs upcloud-cli_2.9.1_x86_64.apk # `cli-` -> `cli_` & `amd64` -> `x86_64` upcloud-cli-2.9.0_arm64.apk vs upcloud-cli_2.9.1_aarch64.apk # `cli-` -> `cli_` & `arm64` -> `aarch64` upcloud-cli-2.9.0_amd64.deb vs upcloud-cli_2.9.1_amd64.deb # `cli-` -> `cli_` upcloud-cli-2.9.0_arm64.deb vs upcloud-cli_2.9.1_arm64.deb # `cli-` -> `cli_`","title":"Changed"},{"location":"changelog/#290-2023-06-30","text":"","title":"2.9.0 - 2023-06-30"},{"location":"changelog/#added_5","text":"Add servergroup commands ( create , delete , list , modify , show ) for server group management","title":"Added"},{"location":"changelog/#280-2023-06-21","text":"","title":"2.8.0 - 2023-06-21"},{"location":"changelog/#added_6","text":"Add support for OpenSearch database type Add database index list and database index commands for managing OpenSearch database indices Add completions for --zone arguments. Add --private-node-groups argument to kubernetes create command. Add Private node groups field to kubernetes show output. Add --label flag to server create and server modify commands","title":"Added"},{"location":"changelog/#271-2023-05-16","text":"","title":"2.7.1 - 2023-05-16"},{"location":"changelog/#fixed_3","text":"Updated examples of kubernetes create command to use valid plans.","title":"Fixed"},{"location":"changelog/#270-2023-05-02","text":"","title":"2.7.0 - 2023-05-02"},{"location":"changelog/#added_7","text":"Add ip and net as aliases to ip-address and network commands, respectively. Add Labels table to loadbalancer show , network show , router show , server show , and storage show outputs. Add kubernetes plans command for listing available plans. Add --plan argument to kubernetes create command for selecting cluster plan. Add --wait flag to kubernetes create command for waiting created cluster to reach running state.","title":"Added"},{"location":"changelog/#260-2023-03-14","text":"","title":"2.6.0 - 2023-03-14"},{"location":"changelog/#added_8","text":"The upctl container image now includes jq tool for parsing values from JSON output. Add node-group states to kubernetes show output. Add completions for --network argument of kubernetes create and server network-interface create . Support also network name as input for --network argument of kubernetes create and server network-interface create","title":"Added"},{"location":"changelog/#changed_3","text":"Completions will now only suggest private networks as arguments because names or UUIDs of public or utility networks are often not valid arguments.","title":"Changed"},{"location":"changelog/#250-2023-02-15","text":"","title":"2.5.0 - 2023-02-15"},{"location":"changelog/#added_9","text":"Print warning about unknown resource state before exiting when execution is interrupted with SIGINT. Add kubernetes nodegroup create , kubernetes nodegroup scale , and kubernetes nodegroup delete commands (EXPERIMENTAL) Added support for all shell completions provided by cobra . Add database properties command to list database properties for given database type and database properties show command to show database property details.","title":"Added"},{"location":"changelog/#changed_4","text":"Remove custom bash completion logic and replace it with completion command provided by cobra . To do this while supporting args with whitespace, whitespace in completions is replaced with non-breaking spaces.","title":"Changed"},{"location":"changelog/#fixed_4","text":"In database show : parse database version from metadata instead of properties. This enables displaying redis version instead of .","title":"Fixed"},{"location":"changelog/#240-2022-12-19","text":"","title":"2.4.0 - 2022-12-19"},{"location":"changelog/#added_10","text":"Add kubernetes create , kubernetes config , kubernetes delete , kubernetes list , kubernetes show , kubernetes versions commands (EXPERIMENTAL) Add loadbalancer plans command for listing available LB plans","title":"Added"},{"location":"changelog/#230-2022-11-11","text":"","title":"2.3.0 - 2022-11-11"},{"location":"changelog/#added_11","text":"Complete available types for database plans . Suppress positional argument filename completion for commands without specific completions. In database list output: if database has no title, database name is displayed in the title cell instead of leaving the cell empty, similarly than in the hub. Version information is parsed from BuildInfo when upctl binary was built without specifying -ldflags to define value for .../config.Version . Use alpine as base image for upcloud/upctl container image. This adds sh and other OS tools to the image and thus makes it more suitable for usage in CI systems.","title":"Added"},{"location":"changelog/#fixed_5","text":"Remove debug leftover print from IP address completions. Added /v2 postfix to module name in go.mod , this enables installing v2 versions of CLI with go install .","title":"Fixed"},{"location":"changelog/#220-2022-10-17","text":"","title":"2.2.0 - 2022-10-17"},{"location":"changelog/#added_12","text":"Include runtime operating system and architecture in version command output. Include instructions for defining credentials and API access in upctl --help output.","title":"Added"},{"location":"changelog/#fixed_6","text":"Fix commands in server delete usage examples. Tune human output so that normal output is directed to stdout . Progess and error messages are still outputted to stderr .","title":"Fixed"},{"location":"changelog/#210-2022-09-07","text":"","title":"2.1.0 - 2022-09-07"},{"location":"changelog/#added_13","text":"Add --wait flag to storage import and storage templatise commands to wait until storage is in online state. In JSON and YAML output of storage import : information on target storage is now available under storage key.","title":"Added"},{"location":"changelog/#fixed_7","text":"In human output of storage list : capitalize zone column header and color storage state similarly than in storage show . In human output of storage import : output UUID of created storage, instead of storage import operation. No UUID is outputted if existing storage was used.","title":"Fixed"},{"location":"changelog/#200-2022-08-30","text":"","title":"2.0.0 - 2022-08-30"},{"location":"changelog/#added_14","text":"Add database delete command. Add loadbalancer delete command. Add Access field to storage show output. Add fields argument and resource to JSON and YAML error outputs.","title":"Added"},{"location":"changelog/#changed_5","text":"Breaking : Human output, including errors, is written to stderr instead of stdout. Refactor progress logging. This changes the appearance of progress logs. See UpCloudLtd / progress for the new implementation.","title":"Changed"},{"location":"changelog/#fixed_8","text":"Breaking : Set non-zero exit code if command execution fails. Breaking : Render servers IP addresses as array of objects, instead of previous pretty-printed string, in JSON and YAML outputs of server show . Breaking : Use key names from json field tag also in YAML output to have equal key names in JSON and YAML outputs. For example, bootorder key in server details will now be boot_order also in YAML output. As a side-effect data-types are limited to those supported by JSON. For example, timestamps will be presented as (double-quoted) strings. In addition, if command targets multiple resources, YAML output will now be a list, similarly than in JSON output, instead of previous multiple YAML documents. Breaking : In JSON and YAML output, storage show lists attached servers in servers list instead of server string. Breaking : In JSON and YAML output, network show lists DHCP DNS values in list instead of string. On network show , output server details as unknown instead of outputting an error, if fetching server details fails. This allows displaying network details for networks that contain a load balancer. Progress logging to non TTY output uses now 100 as text width instead of 0.","title":"Fixed"},{"location":"changelog/#151-2022-07-15","text":"","title":"1.5.1 - 2022-07-15"},{"location":"changelog/#fixed_9","text":"On server create , mount OS disk by default on virtio bus. Previously default OS storage address was not explicit and varyed depending on template type. Disable colors if user has set NO_COLOR environment variable to non-empty value.","title":"Fixed"},{"location":"changelog/#150-2022-07-05","text":"","title":"1.5.0 - 2022-07-05"},{"location":"changelog/#added_15","text":"Add --show-ip-addresses flag to server list command to optionally include IP addresses in command output. Add database connection list , database connection cancel , database start , and database stop commands.","title":"Added"},{"location":"changelog/#changed_6","text":"Make --family parameter of server firewall create command optional to allow editing the default rules. Update cobra to v1.5.0 and refactor required flag validation code. This affects validation error messages.","title":"Changed"},{"location":"changelog/#fixed_10","text":"Complete shell input with uppercase letters (e.g., Cap to CapitalizedName will now work) Display UUID of created template in storage templatise output.","title":"Fixed"},{"location":"changelog/#140-2022-06-15","text":"","title":"1.4.0 - 2022-06-15"},{"location":"changelog/#added_16","text":"Add database list , database show , database plans , and database types commands. Add loadbalancer list and loadbalancer show commands. Add db and lb aliases to database and loadbalancer , respectively.","title":"Added"},{"location":"changelog/#changed_7","text":"Color server state in server list output similarly than in server show output. Update Go version to 1.18 Update upcloud-go-api to v4.8.0","title":"Changed"},{"location":"changelog/#130-2022-05-17","text":"","title":"1.3.0 - 2022-05-17"},{"location":"changelog/#added_17","text":"Add zone list command that lists available zones. Add --wait flag to server create and server stop commands to wait until server is in started and stopped state, respectively.","title":"Added"},{"location":"changelog/#changed_8","text":"Update upcloud-go-api to v4.5.2","title":"Changed"},{"location":"changelog/#fixed_11","text":"Do not display usage if execution fails because of missing credentials Mark error and warning livelogs finished when they will not be updated anymore: this stops the timer in the end of the row and stops livelog from refreshing these lines.","title":"Fixed"},{"location":"changelog/#120-2022-04-29","text":"","title":"1.2.0 - 2022-04-29"},{"location":"changelog/#added_18","text":"Include UUID (or address) of created resource in create command output storage modify command now accepts enable-filesystem-autoresize flag. When that flag is set upctl will attempt to resize partition and filesystem after storage size has been modified.","title":"Added"},{"location":"changelog/#changed_9","text":"New go-api version v4.5.0","title":"Changed"},{"location":"changelog/#fixed_12","text":"Improved errors relating to argument resolver failures Print version info, instead of missing credentials error, when runnning upctl version without credentials Disable colors when outputting in JSON or YAML format Display both public and private addresses in server create output Render livelog messages of commands which execution takes less than render tick interval","title":"Fixed"},{"location":"changelog/#113-2022-02-24","text":"","title":"1.1.3 - 2022-02-24"},{"location":"changelog/#changed_10","text":"Update documentation","title":"Changed"},{"location":"changelog/#fixed_13","text":"Fix storage command attached-to-server key overrides zone","title":"Fixed"},{"location":"changelog/#112-2022-01-21","text":"","title":"1.1.2 - 2022-01-21"},{"location":"changelog/#fixed_14","text":"New release with no changes to fix the Homebrew deprecation notice","title":"Fixed"},{"location":"changelog/#111-2021-09-30","text":"","title":"1.1.1 - 2021-09-30"},{"location":"changelog/#changed_11","text":"Change password creation to be disabled by default in server creation Always create a password when password delivery method is chosen","title":"Changed"},{"location":"changelog/#110-2021-06-03","text":"","title":"1.1.0 - 2021-06-03"},{"location":"changelog/#added_19","text":"Debug mode for finding root causes to problems Docker image and upload to Docker Hub Autogenerated documentation under /docs Terminal width handling","title":"Added"},{"location":"changelog/#changed_12","text":"Global flags for colors refactored to --force-colour and --no-colour New go-api version Improved error messages","title":"Changed"},{"location":"changelog/#fixes","text":"No coloring of texts if stdout is not a terminal Detaching routers works now with the new --detach-router parameter in network modify","title":"Fixes"},{"location":"changelog/#100-2021-04-16","text":"First non-beta release! Includes all previous changes and fixes.","title":"1.0.0 - 2021-04-16"},{"location":"changelog/#060-2021-04-16","text":"","title":"0.6.0 - 2021-04-16"},{"location":"changelog/#changed_13","text":"Use goreleaser for releasing packages Move creation of service outside runcommand to facilitate testing","title":"Changed"},{"location":"changelog/#fixes_1","text":"fix(pre-commit): add missing golangci config file fix(root): use default cobra behavious when called","title":"Fixes"},{"location":"changelog/#050-2021-04-14","text":"Initial public beta release :tada:","title":"0.5.0 - 2021-04-14"},{"location":"changelog/#added_20","text":"Added commands for managing server firewall rules","title":"Added"},{"location":"changelog/#fixed_15","text":"Shell auto-completion fixed","title":"Fixed"},{"location":"changelog/#changed_14","text":"Input & output handling rewritten Several help text fixes & changes Default OS changed to Ubuntu 20.04 Defaults for networks / routers in line with storages, so we'll show users' own resources by default","title":"Changed"},{"location":"changelog/#011-2021-03-12","text":"","title":"0.1.1 - 2021-03-12"},{"location":"changelog/#fixed_16","text":"Load config files from the correct place on Windows Fix storage import failing on readerCounter not implementing io.Reader","title":"Fixed"},{"location":"changelog/#010-2021-03-10","text":"","title":"0.1.0 - 2021-03-10"},{"location":"changelog/#added_21","text":"Current feature set added! First internal release","title":"Added"},{"location":"commands_reference/upctl/","text":"upctl UpCloud command-line interface upctl provides a command-line interface to UpCloud services. It allows you to control your resources from the command line or any compatible interface. To be able to manage your UpCLoud resources, you need to configure credentials for upctl 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. Options Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --help , -h help for upctl Default: false --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human Related commands Command Description upctl account Manage accounts upctl database Manage databases upctl ip-address Manage IP addresses upctl kubernetes Manage Kubernetes clusters upctl loadbalancer Manage load balancers upctl network Manage networks upctl objectstorage Manage Managed object storage services 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","title":"upctl"},{"location":"commands_reference/upctl/#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.","title":"upctl"},{"location":"commands_reference/upctl/#options","text":"Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --help , -h help for upctl Default: false --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human","title":"Options"},{"location":"commands_reference/upctl/#related-commands","text":"Command Description upctl account Manage accounts upctl database Manage databases upctl ip-address Manage IP addresses upctl kubernetes Manage Kubernetes clusters upctl loadbalancer Manage load balancers upctl network Manage networks upctl objectstorage Manage Managed object storage services 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","title":"Related commands"},{"location":"commands_reference/upctl_version/","text":"upctl version Display software information upctl version [flags] Examples upctl version Options Option Description --help , -h help for version Default: false Global options Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human Related commands Command Description upctl UpCloud command-line interface","title":"upctl version"},{"location":"commands_reference/upctl_version/#upctl-version","text":"Display software information upctl version [flags]","title":"upctl version"},{"location":"commands_reference/upctl_version/#examples","text":"upctl version","title":"Examples"},{"location":"commands_reference/upctl_version/#options","text":"Option Description --help , -h help for version Default: false","title":"Options"},{"location":"commands_reference/upctl_version/#global-options","text":"Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human","title":"Global options"},{"location":"commands_reference/upctl_version/#related-commands","text":"Command Description upctl UpCloud command-line interface","title":"Related commands"},{"location":"commands_reference/upctl_account/","text":"upctl account Manage accounts upctl account [flags] Options Option Description --help , -h help for account Default: false Global options Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human Related commands Command Description upctl UpCloud command-line interface upctl account show Show account","title":"account "},{"location":"commands_reference/upctl_account/#upctl-account","text":"Manage accounts upctl account [flags]","title":"upctl account"},{"location":"commands_reference/upctl_account/#options","text":"Option Description --help , -h help for account Default: false","title":"Options"},{"location":"commands_reference/upctl_account/#global-options","text":"Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human","title":"Global options"},{"location":"commands_reference/upctl_account/#related-commands","text":"Command Description upctl UpCloud command-line interface upctl account show Show account","title":"Related commands"},{"location":"commands_reference/upctl_account/show/","text":"upctl account show Show account upctl account show [flags] Examples upctl account show Options Option Description --help , -h help for show Default: false Global options Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human Related commands Command Description upctl account Manage accounts","title":"account show"},{"location":"commands_reference/upctl_account/show/#upctl-account-show","text":"Show account upctl account show [flags]","title":"upctl account show"},{"location":"commands_reference/upctl_account/show/#examples","text":"upctl account show","title":"Examples"},{"location":"commands_reference/upctl_account/show/#options","text":"Option Description --help , -h help for show Default: false","title":"Options"},{"location":"commands_reference/upctl_account/show/#global-options","text":"Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human","title":"Global options"},{"location":"commands_reference/upctl_account/show/#related-commands","text":"Command Description upctl account Manage accounts","title":"Related commands"},{"location":"commands_reference/upctl_database/","text":"upctl database Manage databases upctl database [flags] Aliases db Options Option Description --help , -h help for database Default: false Global options Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human Related commands 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","title":"database "},{"location":"commands_reference/upctl_database/#upctl-database","text":"Manage databases upctl database [flags]","title":"upctl database"},{"location":"commands_reference/upctl_database/#aliases","text":"db","title":"Aliases"},{"location":"commands_reference/upctl_database/#options","text":"Option Description --help , -h help for database Default: false","title":"Options"},{"location":"commands_reference/upctl_database/#global-options","text":"Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human","title":"Global options"},{"location":"commands_reference/upctl_database/#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","title":"Related commands"},{"location":"commands_reference/upctl_database/delete/","text":"upctl database delete Delete a database upctl database delete [flags] Examples upctl database delete 0497728e-76ef-41d0-997f-fa9449eb71bc upctl database delete my_database Options Option Description --help , -h help for delete Default: false Global options Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human Related commands Command Description upctl database Manage databases","title":"database delete"},{"location":"commands_reference/upctl_database/delete/#upctl-database-delete","text":"Delete a database upctl database delete [flags]","title":"upctl database delete"},{"location":"commands_reference/upctl_database/delete/#examples","text":"upctl database delete 0497728e-76ef-41d0-997f-fa9449eb71bc upctl database delete my_database","title":"Examples"},{"location":"commands_reference/upctl_database/delete/#options","text":"Option Description --help , -h help for delete Default: false","title":"Options"},{"location":"commands_reference/upctl_database/delete/#global-options","text":"Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human","title":"Global options"},{"location":"commands_reference/upctl_database/delete/#related-commands","text":"Command Description upctl database Manage databases","title":"Related commands"},{"location":"commands_reference/upctl_database/list/","text":"upctl database list List current databases upctl database list [flags] Examples upctl database list Options Option Description --help , -h help for list Default: false Global options Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human Related commands Command Description upctl database Manage databases","title":"database list"},{"location":"commands_reference/upctl_database/list/#upctl-database-list","text":"List current databases upctl database list [flags]","title":"upctl database list"},{"location":"commands_reference/upctl_database/list/#examples","text":"upctl database list","title":"Examples"},{"location":"commands_reference/upctl_database/list/#options","text":"Option Description --help , -h help for list Default: false","title":"Options"},{"location":"commands_reference/upctl_database/list/#global-options","text":"Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human","title":"Global options"},{"location":"commands_reference/upctl_database/list/#related-commands","text":"Command Description upctl database Manage databases","title":"Related commands"},{"location":"commands_reference/upctl_database/plans/","text":"upctl database plans List available plans for given database type upctl database plans [flags] Examples upctl database plans pg upctl database plans mysql Options Option Description --help , -h help for plans Default: false Global options Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human Related commands Command Description upctl database Manage databases","title":"database plans"},{"location":"commands_reference/upctl_database/plans/#upctl-database-plans","text":"List available plans for given database type upctl database plans [flags]","title":"upctl database plans"},{"location":"commands_reference/upctl_database/plans/#examples","text":"upctl database plans pg upctl database plans mysql","title":"Examples"},{"location":"commands_reference/upctl_database/plans/#options","text":"Option Description --help , -h help for plans Default: false","title":"Options"},{"location":"commands_reference/upctl_database/plans/#global-options","text":"Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human","title":"Global options"},{"location":"commands_reference/upctl_database/plans/#related-commands","text":"Command Description upctl database Manage databases","title":"Related commands"},{"location":"commands_reference/upctl_database/show/","text":"upctl database show Show database details upctl database show [flags] Examples upctl database show 9a8effcb-80e6-4a63-a7e5-066a6d093c14 upctl database show my-pg-database upctl database show my-mysql-database Options Option Description --help , -h help for show Default: false Global options Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human Related commands Command Description upctl database Manage databases","title":"database show"},{"location":"commands_reference/upctl_database/show/#upctl-database-show","text":"Show database details upctl database show [flags]","title":"upctl database show"},{"location":"commands_reference/upctl_database/show/#examples","text":"upctl database show 9a8effcb-80e6-4a63-a7e5-066a6d093c14 upctl database show my-pg-database upctl database show my-mysql-database","title":"Examples"},{"location":"commands_reference/upctl_database/show/#options","text":"Option Description --help , -h help for show Default: false","title":"Options"},{"location":"commands_reference/upctl_database/show/#global-options","text":"Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human","title":"Global options"},{"location":"commands_reference/upctl_database/show/#related-commands","text":"Command Description upctl database Manage databases","title":"Related commands"},{"location":"commands_reference/upctl_database/start/","text":"upctl database start Start on a managed database upctl database start [flags] Examples upctl database start b0952286-1193-4a81-a1af-62efc014ae4b upctl database start b0952286-1193-4a81-a1af-62efc014ae4b 666bcd3c-5c63-428d-a4fd-07c27469a5a6 upctl database start pg-1x1xcpu-2gb-25gb-pl-waw1 Options Option Description --help , -h help for start Default: false Global options Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human Related commands Command Description upctl database Manage databases","title":"database start"},{"location":"commands_reference/upctl_database/start/#upctl-database-start","text":"Start on a managed database upctl database start [flags]","title":"upctl database start"},{"location":"commands_reference/upctl_database/start/#examples","text":"upctl database start b0952286-1193-4a81-a1af-62efc014ae4b upctl database start b0952286-1193-4a81-a1af-62efc014ae4b 666bcd3c-5c63-428d-a4fd-07c27469a5a6 upctl database start pg-1x1xcpu-2gb-25gb-pl-waw1","title":"Examples"},{"location":"commands_reference/upctl_database/start/#options","text":"Option Description --help , -h help for start Default: false","title":"Options"},{"location":"commands_reference/upctl_database/start/#global-options","text":"Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human","title":"Global options"},{"location":"commands_reference/upctl_database/start/#related-commands","text":"Command Description upctl database Manage databases","title":"Related commands"},{"location":"commands_reference/upctl_database/stop/","text":"upctl database stop Stop a managed database upctl database stop [flags] Aliases shutdown Examples upctl database stop b0952286-1193-4a81-a1af-62efc014ae4b upctl database stop b0952286-1193-4a81-a1af-62efc014ae4b 666bcd3c-5c63-428d-a4fd-07c27469a5a6 upctl database stop pg-1x1xcpu-2gb-25gb-pl-waw1 Options Option Description --help , -h help for stop Default: false Global options Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human Related commands Command Description upctl database Manage databases","title":"database stop"},{"location":"commands_reference/upctl_database/stop/#upctl-database-stop","text":"Stop a managed database upctl database stop [flags]","title":"upctl database stop"},{"location":"commands_reference/upctl_database/stop/#aliases","text":"shutdown","title":"Aliases"},{"location":"commands_reference/upctl_database/stop/#examples","text":"upctl database stop b0952286-1193-4a81-a1af-62efc014ae4b upctl database stop b0952286-1193-4a81-a1af-62efc014ae4b 666bcd3c-5c63-428d-a4fd-07c27469a5a6 upctl database stop pg-1x1xcpu-2gb-25gb-pl-waw1","title":"Examples"},{"location":"commands_reference/upctl_database/stop/#options","text":"Option Description --help , -h help for stop Default: false","title":"Options"},{"location":"commands_reference/upctl_database/stop/#global-options","text":"Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human","title":"Global options"},{"location":"commands_reference/upctl_database/stop/#related-commands","text":"Command Description upctl database Manage databases","title":"Related commands"},{"location":"commands_reference/upctl_database/types/","text":"upctl database types List available database types upctl database types [flags] Examples upctl database types Options Option Description --help , -h help for types Default: false Global options Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human Related commands Command Description upctl database Manage databases","title":"database types"},{"location":"commands_reference/upctl_database/types/#upctl-database-types","text":"List available database types upctl database types [flags]","title":"upctl database types"},{"location":"commands_reference/upctl_database/types/#examples","text":"upctl database types","title":"Examples"},{"location":"commands_reference/upctl_database/types/#options","text":"Option Description --help , -h help for types Default: false","title":"Options"},{"location":"commands_reference/upctl_database/types/#global-options","text":"Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human","title":"Global options"},{"location":"commands_reference/upctl_database/types/#related-commands","text":"Command Description upctl database Manage databases","title":"Related commands"},{"location":"commands_reference/upctl_database/index/","text":"upctl database index Manage database indices upctl database index [flags] Aliases indices Options Option Description --help , -h help for index Default: false Global options Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human Related commands 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","title":"index "},{"location":"commands_reference/upctl_database/index/#upctl-database-index","text":"Manage database indices upctl database index [flags]","title":"upctl database index"},{"location":"commands_reference/upctl_database/index/#aliases","text":"indices","title":"Aliases"},{"location":"commands_reference/upctl_database/index/#options","text":"Option Description --help , -h help for index Default: false","title":"Options"},{"location":"commands_reference/upctl_database/index/#global-options","text":"Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human","title":"Global options"},{"location":"commands_reference/upctl_database/index/#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","title":"Related commands"},{"location":"commands_reference/upctl_database/index/delete/","text":"upctl database index delete Delete an index from the specified database. upctl database index delete [flags] Examples upctl database index delete 55199a44-4751-4e27-9394-7c7661910be3 --name .index-to-delete Options Option Description --name Index name --help , -h help for delete Default: false Global options Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human Related commands Command Description upctl database index Manage database indices","title":"index delete"},{"location":"commands_reference/upctl_database/index/delete/#upctl-database-index-delete","text":"Delete an index from the specified database. upctl database index delete [flags]","title":"upctl database index delete"},{"location":"commands_reference/upctl_database/index/delete/#examples","text":"upctl database index delete 55199a44-4751-4e27-9394-7c7661910be3 --name .index-to-delete","title":"Examples"},{"location":"commands_reference/upctl_database/index/delete/#options","text":"Option Description --name Index name --help , -h help for delete Default: false","title":"Options"},{"location":"commands_reference/upctl_database/index/delete/#global-options","text":"Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human","title":"Global options"},{"location":"commands_reference/upctl_database/index/delete/#related-commands","text":"Command Description upctl database index Manage database indices","title":"Related commands"},{"location":"commands_reference/upctl_database/index/list/","text":"upctl database index list List current indices of the specified databases upctl database index list [flags] Examples upctl database index list 55199a44-4751-4e27-9394-7c7661910be3 Options Option Description --help , -h help for list Default: false Global options Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human Related commands Command Description upctl database index Manage database indices","title":"index list"},{"location":"commands_reference/upctl_database/index/list/#upctl-database-index-list","text":"List current indices of the specified databases upctl database index list [flags]","title":"upctl database index list"},{"location":"commands_reference/upctl_database/index/list/#examples","text":"upctl database index list 55199a44-4751-4e27-9394-7c7661910be3","title":"Examples"},{"location":"commands_reference/upctl_database/index/list/#options","text":"Option Description --help , -h help for list Default: false","title":"Options"},{"location":"commands_reference/upctl_database/index/list/#global-options","text":"Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human","title":"Global options"},{"location":"commands_reference/upctl_database/index/list/#related-commands","text":"Command Description upctl database index Manage database indices","title":"Related commands"},{"location":"commands_reference/upctl_database/properties/","text":"upctl database properties List available properties for given database type upctl database properties [flags] Examples upctl database properties pg upctl database properties mysql Options Option Description --help , -h help for properties Default: false Global options Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human Related commands 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","title":"properties "},{"location":"commands_reference/upctl_database/properties/#upctl-database-properties","text":"List available properties for given database type upctl database properties [flags]","title":"upctl database properties"},{"location":"commands_reference/upctl_database/properties/#examples","text":"upctl database properties pg upctl database properties mysql","title":"Examples"},{"location":"commands_reference/upctl_database/properties/#options","text":"Option Description --help , -h help for properties Default: false","title":"Options"},{"location":"commands_reference/upctl_database/properties/#global-options","text":"Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human","title":"Global options"},{"location":"commands_reference/upctl_database/properties/#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","title":"Related commands"},{"location":"commands_reference/upctl_database/properties/mysql/","text":"upctl database properties mysql List available properties for MySQL databases upctl database properties mysql [flags] Examples upctl database properties mysql Options Option Description --help , -h help for mysql Default: false Global options Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human Related commands Command Description upctl database properties List available properties for given database type upctl database properties mysql show Show MySQL database property details","title":"mysql "},{"location":"commands_reference/upctl_database/properties/mysql/#upctl-database-properties-mysql","text":"List available properties for MySQL databases upctl database properties mysql [flags]","title":"upctl database properties mysql"},{"location":"commands_reference/upctl_database/properties/mysql/#examples","text":"upctl database properties mysql","title":"Examples"},{"location":"commands_reference/upctl_database/properties/mysql/#options","text":"Option Description --help , -h help for mysql Default: false","title":"Options"},{"location":"commands_reference/upctl_database/properties/mysql/#global-options","text":"Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human","title":"Global options"},{"location":"commands_reference/upctl_database/properties/mysql/#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","title":"Related commands"},{"location":"commands_reference/upctl_database/properties/mysql/show/","text":"upctl database properties mysql show Show MySQL database property details upctl database properties mysql show [flags] Examples upctl database properties mysql show version Options Option Description --help , -h help for show Default: false Global options Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human Related commands Command Description upctl database properties mysql List available properties for MySQL databases","title":"mysql show"},{"location":"commands_reference/upctl_database/properties/mysql/show/#upctl-database-properties-mysql-show","text":"Show MySQL database property details upctl database properties mysql show [flags]","title":"upctl database properties mysql show"},{"location":"commands_reference/upctl_database/properties/mysql/show/#examples","text":"upctl database properties mysql show version","title":"Examples"},{"location":"commands_reference/upctl_database/properties/mysql/show/#options","text":"Option Description --help , -h help for show Default: false","title":"Options"},{"location":"commands_reference/upctl_database/properties/mysql/show/#global-options","text":"Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human","title":"Global options"},{"location":"commands_reference/upctl_database/properties/mysql/show/#related-commands","text":"Command Description upctl database properties mysql List available properties for MySQL databases","title":"Related commands"},{"location":"commands_reference/upctl_database/properties/opensearch/","text":"upctl database properties opensearch List available properties for OpenSearch databases upctl database properties opensearch [flags] Examples upctl database properties opensearch Options Option Description --help , -h help for opensearch Default: false Global options Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human Related commands Command Description upctl database properties List available properties for given database type upctl database properties opensearch show Show OpenSearch database property details","title":"opensearch "},{"location":"commands_reference/upctl_database/properties/opensearch/#upctl-database-properties-opensearch","text":"List available properties for OpenSearch databases upctl database properties opensearch [flags]","title":"upctl database properties opensearch"},{"location":"commands_reference/upctl_database/properties/opensearch/#examples","text":"upctl database properties opensearch","title":"Examples"},{"location":"commands_reference/upctl_database/properties/opensearch/#options","text":"Option Description --help , -h help for opensearch Default: false","title":"Options"},{"location":"commands_reference/upctl_database/properties/opensearch/#global-options","text":"Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human","title":"Global options"},{"location":"commands_reference/upctl_database/properties/opensearch/#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","title":"Related commands"},{"location":"commands_reference/upctl_database/properties/opensearch/show/","text":"upctl database properties opensearch show Show OpenSearch database property details upctl database properties opensearch show [flags] Examples upctl database properties opensearch show version Options Option Description --help , -h help for show Default: false Global options Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human Related commands Command Description upctl database properties opensearch List available properties for OpenSearch databases","title":"opensearch show"},{"location":"commands_reference/upctl_database/properties/opensearch/show/#upctl-database-properties-opensearch-show","text":"Show OpenSearch database property details upctl database properties opensearch show [flags]","title":"upctl database properties opensearch show"},{"location":"commands_reference/upctl_database/properties/opensearch/show/#examples","text":"upctl database properties opensearch show version","title":"Examples"},{"location":"commands_reference/upctl_database/properties/opensearch/show/#options","text":"Option Description --help , -h help for show Default: false","title":"Options"},{"location":"commands_reference/upctl_database/properties/opensearch/show/#global-options","text":"Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human","title":"Global options"},{"location":"commands_reference/upctl_database/properties/opensearch/show/#related-commands","text":"Command Description upctl database properties opensearch List available properties for OpenSearch databases","title":"Related commands"},{"location":"commands_reference/upctl_database/properties/pg/","text":"upctl database properties pg List available properties for PostgreSQL databases upctl database properties pg [flags] Examples upctl database properties pg Options Option Description --help , -h help for pg Default: false Global options Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human Related commands Command Description upctl database properties List available properties for given database type upctl database properties pg show Show PostgreSQL database property details","title":"pg "},{"location":"commands_reference/upctl_database/properties/pg/#upctl-database-properties-pg","text":"List available properties for PostgreSQL databases upctl database properties pg [flags]","title":"upctl database properties pg"},{"location":"commands_reference/upctl_database/properties/pg/#examples","text":"upctl database properties pg","title":"Examples"},{"location":"commands_reference/upctl_database/properties/pg/#options","text":"Option Description --help , -h help for pg Default: false","title":"Options"},{"location":"commands_reference/upctl_database/properties/pg/#global-options","text":"Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human","title":"Global options"},{"location":"commands_reference/upctl_database/properties/pg/#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","title":"Related commands"},{"location":"commands_reference/upctl_database/properties/pg/show/","text":"upctl database properties pg show Show PostgreSQL database property details upctl database properties pg show [flags] Examples upctl database properties pg show version Options Option Description --help , -h help for show Default: false Global options Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human Related commands Command Description upctl database properties pg List available properties for PostgreSQL databases","title":"pg show"},{"location":"commands_reference/upctl_database/properties/pg/show/#upctl-database-properties-pg-show","text":"Show PostgreSQL database property details upctl database properties pg show [flags]","title":"upctl database properties pg show"},{"location":"commands_reference/upctl_database/properties/pg/show/#examples","text":"upctl database properties pg show version","title":"Examples"},{"location":"commands_reference/upctl_database/properties/pg/show/#options","text":"Option Description --help , -h help for show Default: false","title":"Options"},{"location":"commands_reference/upctl_database/properties/pg/show/#global-options","text":"Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human","title":"Global options"},{"location":"commands_reference/upctl_database/properties/pg/show/#related-commands","text":"Command Description upctl database properties pg List available properties for PostgreSQL databases","title":"Related commands"},{"location":"commands_reference/upctl_database/properties/redis/","text":"upctl database properties redis List available properties for Redis databases upctl database properties redis [flags] Examples upctl database properties redis Options Option Description --help , -h help for redis Default: false Global options Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human Related commands Command Description upctl database properties List available properties for given database type upctl database properties redis show Show Redis database property details","title":"redis "},{"location":"commands_reference/upctl_database/properties/redis/#upctl-database-properties-redis","text":"List available properties for Redis databases upctl database properties redis [flags]","title":"upctl database properties redis"},{"location":"commands_reference/upctl_database/properties/redis/#examples","text":"upctl database properties redis","title":"Examples"},{"location":"commands_reference/upctl_database/properties/redis/#options","text":"Option Description --help , -h help for redis Default: false","title":"Options"},{"location":"commands_reference/upctl_database/properties/redis/#global-options","text":"Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human","title":"Global options"},{"location":"commands_reference/upctl_database/properties/redis/#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","title":"Related commands"},{"location":"commands_reference/upctl_database/properties/redis/show/","text":"upctl database properties redis show Show Redis database property details upctl database properties redis show [flags] Examples upctl database properties redis show version Options Option Description --help , -h help for show Default: false Global options Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human Related commands Command Description upctl database properties redis List available properties for Redis databases","title":"redis show"},{"location":"commands_reference/upctl_database/properties/redis/show/#upctl-database-properties-redis-show","text":"Show Redis database property details upctl database properties redis show [flags]","title":"upctl database properties redis show"},{"location":"commands_reference/upctl_database/properties/redis/show/#examples","text":"upctl database properties redis show version","title":"Examples"},{"location":"commands_reference/upctl_database/properties/redis/show/#options","text":"Option Description --help , -h help for show Default: false","title":"Options"},{"location":"commands_reference/upctl_database/properties/redis/show/#global-options","text":"Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human","title":"Global options"},{"location":"commands_reference/upctl_database/properties/redis/show/#related-commands","text":"Command Description upctl database properties redis List available properties for Redis databases","title":"Related commands"},{"location":"commands_reference/upctl_database/session/","text":"upctl database session Manage database sessions upctl database session [flags] Options Option Description --help , -h help for session Default: false Global options Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human Related commands 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","title":"session "},{"location":"commands_reference/upctl_database/session/#upctl-database-session","text":"Manage database sessions upctl database session [flags]","title":"upctl database session"},{"location":"commands_reference/upctl_database/session/#options","text":"Option Description --help , -h help for session Default: false","title":"Options"},{"location":"commands_reference/upctl_database/session/#global-options","text":"Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human","title":"Global options"},{"location":"commands_reference/upctl_database/session/#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","title":"Related commands"},{"location":"commands_reference/upctl_database/session/cancel/","text":"upctl database session cancel Terminate client session or cancel running query for a database upctl database session cancel [flags] Examples upctl database session cancel 0fa980c4-0e4f-460b-9869-11b7bd62b832 --pid 2345422 upctl database session cancel mysql-1 --pid 2345422 --terminate Options Option Description --pid Process ID of the session to cancel. Default: 0 --terminate Request immediate termination instead of soft cancel. --help , -h help for cancel Default: false Global options Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human Related commands Command Description upctl database session Manage database sessions","title":"session cancel"},{"location":"commands_reference/upctl_database/session/cancel/#upctl-database-session-cancel","text":"Terminate client session or cancel running query for a database upctl database session cancel [flags]","title":"upctl database session cancel"},{"location":"commands_reference/upctl_database/session/cancel/#examples","text":"upctl database session cancel 0fa980c4-0e4f-460b-9869-11b7bd62b832 --pid 2345422 upctl database session cancel mysql-1 --pid 2345422 --terminate","title":"Examples"},{"location":"commands_reference/upctl_database/session/cancel/#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 cancel Default: false","title":"Options"},{"location":"commands_reference/upctl_database/session/cancel/#global-options","text":"Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human","title":"Global options"},{"location":"commands_reference/upctl_database/session/cancel/#related-commands","text":"Command Description upctl database session Manage database sessions","title":"Related commands"},{"location":"commands_reference/upctl_database/session/list/","text":"upctl database session list List current sessions to specified database upctl database session list [flags] Examples upctl database session list 0fa980c4-0e4f-460b-9869-11b7bd62b832 upctl database session list mysql-1 --limit 16 --offset 32 --order pid:desc Options 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 list Default: false Global options Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human Related commands Command Description upctl database session Manage database sessions","title":"session list"},{"location":"commands_reference/upctl_database/session/list/#upctl-database-session-list","text":"List current sessions to specified database upctl database session list [flags]","title":"upctl database session list"},{"location":"commands_reference/upctl_database/session/list/#examples","text":"upctl database session list 0fa980c4-0e4f-460b-9869-11b7bd62b832 upctl database session list mysql-1 --limit 16 --offset 32 --order pid:desc","title":"Examples"},{"location":"commands_reference/upctl_database/session/list/#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 list Default: false","title":"Options"},{"location":"commands_reference/upctl_database/session/list/#global-options","text":"Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human","title":"Global options"},{"location":"commands_reference/upctl_database/session/list/#related-commands","text":"Command Description upctl database session Manage database sessions","title":"Related commands"},{"location":"commands_reference/upctl_ip-address/","text":"upctl ip-address Manage IP addresses upctl ip-address [flags] Aliases ip Options Option Description --help , -h help for ip-address Default: false Global options Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human Related commands 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","title":"ip-address "},{"location":"commands_reference/upctl_ip-address/#upctl-ip-address","text":"Manage IP addresses upctl ip-address [flags]","title":"upctl ip-address"},{"location":"commands_reference/upctl_ip-address/#aliases","text":"ip","title":"Aliases"},{"location":"commands_reference/upctl_ip-address/#options","text":"Option Description --help , -h help for ip-address Default: false","title":"Options"},{"location":"commands_reference/upctl_ip-address/#global-options","text":"Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human","title":"Global options"},{"location":"commands_reference/upctl_ip-address/#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","title":"Related commands"},{"location":"commands_reference/upctl_ip-address/assign/","text":"upctl ip-address assign Assign or create an IP address upctl ip-address assign [flags] Examples upctl ip-address assign --server 00038afc-d526-4148-af0e-d2f1eeaded9b upctl ip-address assign --server 00944977-89ce-4d10-89c3-bb5ba482e48d --family IPv6 upctl ip-address assign --server 00944977-89ce-4d10-89c3-bb5ba482e48d --floating --zone pl-waw1 upctl ip-address assign --server 00b78f8b-521d-4ffb-8baa-adf96c7b8f45 --floating --mac d6:0e:4a:6f:11:8f Options 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 speficied. --floating Whether the address to be assigned is a floating one. --help , -h help for assign Default: false Global options Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human Related commands Command Description upctl ip-address Manage IP addresses","title":"ip-address assign"},{"location":"commands_reference/upctl_ip-address/assign/#upctl-ip-address-assign","text":"Assign or create an IP address upctl ip-address assign [flags]","title":"upctl ip-address assign"},{"location":"commands_reference/upctl_ip-address/assign/#examples","text":"upctl ip-address assign --server 00038afc-d526-4148-af0e-d2f1eeaded9b upctl ip-address assign --server 00944977-89ce-4d10-89c3-bb5ba482e48d --family IPv6 upctl ip-address assign --server 00944977-89ce-4d10-89c3-bb5ba482e48d --floating --zone pl-waw1 upctl ip-address assign --server 00b78f8b-521d-4ffb-8baa-adf96c7b8f45 --floating --mac d6:0e:4a:6f:11:8f","title":"Examples"},{"location":"commands_reference/upctl_ip-address/assign/#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 speficied. --floating Whether the address to be assigned is a floating one. --help , -h help for assign Default: false","title":"Options"},{"location":"commands_reference/upctl_ip-address/assign/#global-options","text":"Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human","title":"Global options"},{"location":"commands_reference/upctl_ip-address/assign/#related-commands","text":"Command Description upctl ip-address Manage IP addresses","title":"Related commands"},{"location":"commands_reference/upctl_ip-address/list/","text":"upctl ip-address list List IP addresses upctl ip-address list [flags] Examples upctl ip-address list Options Option Description --help , -h help for list Default: false Global options Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human Related commands Command Description upctl ip-address Manage IP addresses","title":"ip-address list"},{"location":"commands_reference/upctl_ip-address/list/#upctl-ip-address-list","text":"List IP addresses upctl ip-address list [flags]","title":"upctl ip-address list"},{"location":"commands_reference/upctl_ip-address/list/#examples","text":"upctl ip-address list","title":"Examples"},{"location":"commands_reference/upctl_ip-address/list/#options","text":"Option Description --help , -h help for list Default: false","title":"Options"},{"location":"commands_reference/upctl_ip-address/list/#global-options","text":"Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human","title":"Global options"},{"location":"commands_reference/upctl_ip-address/list/#related-commands","text":"Command Description upctl ip-address Manage IP addresses","title":"Related commands"},{"location":"commands_reference/upctl_ip-address/modify/","text":"upctl ip-address modify Modify an IP address upctl ip-address modify
    [flags] Examples upctl ip-address modify 185.70.196.225 --ptr-record myapp.com upctl ip-address modify 185.70.197.175 --mac d6:0e:4a:6f:2b:06 Options 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 modify Default: false Global options Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human Related commands Command Description upctl ip-address Manage IP addresses","title":"ip-address modify"},{"location":"commands_reference/upctl_ip-address/modify/#upctl-ip-address-modify","text":"Modify an IP address upctl ip-address modify
    [flags]","title":"upctl ip-address modify"},{"location":"commands_reference/upctl_ip-address/modify/#examples","text":"upctl ip-address modify 185.70.196.225 --ptr-record myapp.com upctl ip-address modify 185.70.197.175 --mac d6:0e:4a:6f:2b:06","title":"Examples"},{"location":"commands_reference/upctl_ip-address/modify/#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 modify Default: false","title":"Options"},{"location":"commands_reference/upctl_ip-address/modify/#global-options","text":"Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human","title":"Global options"},{"location":"commands_reference/upctl_ip-address/modify/#related-commands","text":"Command Description upctl ip-address Manage IP addresses","title":"Related commands"},{"location":"commands_reference/upctl_ip-address/remove/","text":"upctl ip-address remove Remove an IP address upctl ip-address remove
    [flags] Examples upctl ip-address remove 185.70.197.44 upctl ip-address remove 2a04:3544:8000:1000:d40e:4aff:fe6f:2c85 Options Option Description --help , -h help for remove Default: false Global options Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human Related commands Command Description upctl ip-address Manage IP addresses","title":"ip-address remove"},{"location":"commands_reference/upctl_ip-address/remove/#upctl-ip-address-remove","text":"Remove an IP address upctl ip-address remove
    [flags]","title":"upctl ip-address remove"},{"location":"commands_reference/upctl_ip-address/remove/#examples","text":"upctl ip-address remove 185.70.197.44 upctl ip-address remove 2a04:3544:8000:1000:d40e:4aff:fe6f:2c85","title":"Examples"},{"location":"commands_reference/upctl_ip-address/remove/#options","text":"Option Description --help , -h help for remove Default: false","title":"Options"},{"location":"commands_reference/upctl_ip-address/remove/#global-options","text":"Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human","title":"Global options"},{"location":"commands_reference/upctl_ip-address/remove/#related-commands","text":"Command Description upctl ip-address Manage IP addresses","title":"Related commands"},{"location":"commands_reference/upctl_ip-address/show/","text":"upctl ip-address show Show current IP address upctl ip-address show
    [flags] Examples upctl ip-address show 185.70.196.47 upctl ip-address show 2a04:3544:8000:1000:d40e:4aff:fe6f:5d34 Options Option Description --help , -h help for show Default: false Global options Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human Related commands Command Description upctl ip-address Manage IP addresses","title":"ip-address show"},{"location":"commands_reference/upctl_ip-address/show/#upctl-ip-address-show","text":"Show current IP address upctl ip-address show
    [flags]","title":"upctl ip-address show"},{"location":"commands_reference/upctl_ip-address/show/#examples","text":"upctl ip-address show 185.70.196.47 upctl ip-address show 2a04:3544:8000:1000:d40e:4aff:fe6f:5d34","title":"Examples"},{"location":"commands_reference/upctl_ip-address/show/#options","text":"Option Description --help , -h help for show Default: false","title":"Options"},{"location":"commands_reference/upctl_ip-address/show/#global-options","text":"Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human","title":"Global options"},{"location":"commands_reference/upctl_ip-address/show/#related-commands","text":"Command Description upctl ip-address Manage IP addresses","title":"Related commands"},{"location":"commands_reference/upctl_kubernetes/","text":"upctl kubernetes Manage Kubernetes clusters upctl kubernetes [flags] Aliases k8s , uks Options Option Description --help , -h help for kubernetes Default: false Global options Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human Related commands 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 Modifiy 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","title":"kubernetes "},{"location":"commands_reference/upctl_kubernetes/#upctl-kubernetes","text":"Manage Kubernetes clusters upctl kubernetes [flags]","title":"upctl kubernetes"},{"location":"commands_reference/upctl_kubernetes/#aliases","text":"k8s , uks","title":"Aliases"},{"location":"commands_reference/upctl_kubernetes/#options","text":"Option Description --help , -h help for kubernetes Default: false","title":"Options"},{"location":"commands_reference/upctl_kubernetes/#global-options","text":"Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human","title":"Global options"},{"location":"commands_reference/upctl_kubernetes/#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 Modifiy 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","title":"Related commands"},{"location":"commands_reference/upctl_kubernetes/config/","text":"upctl kubernetes config Output Kubernetes cluster kubeconfig upctl kubernetes config [flags] Examples upctl kubernetes config 0fa980c4-0e4f-460b-9869-11b7bd62b831 --output human upctl kubernetes config 0fa980c4-0e4f-460b-9869-11b7bd62b831 --output yaml --write $KUBECONFIG upctl kubernetes config 0fa980c4-0e4f-460b-9869-11b7bd62b831 --output yaml --write ./my_kubeconfig.yaml Options Option Description --write Absolute path for writing output. If the file exists, the config will be merged. --help , -h help for config Default: false Global options Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human Related commands Command Description upctl kubernetes Manage Kubernetes clusters","title":"kubernetes config"},{"location":"commands_reference/upctl_kubernetes/config/#upctl-kubernetes-config","text":"Output Kubernetes cluster kubeconfig upctl kubernetes config [flags]","title":"upctl kubernetes config"},{"location":"commands_reference/upctl_kubernetes/config/#examples","text":"upctl kubernetes config 0fa980c4-0e4f-460b-9869-11b7bd62b831 --output human upctl kubernetes config 0fa980c4-0e4f-460b-9869-11b7bd62b831 --output yaml --write $KUBECONFIG upctl kubernetes config 0fa980c4-0e4f-460b-9869-11b7bd62b831 --output yaml --write ./my_kubeconfig.yaml","title":"Examples"},{"location":"commands_reference/upctl_kubernetes/config/#options","text":"Option Description --write Absolute path for writing output. If the file exists, the config will be merged. --help , -h help for config Default: false","title":"Options"},{"location":"commands_reference/upctl_kubernetes/config/#global-options","text":"Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human","title":"Global options"},{"location":"commands_reference/upctl_kubernetes/config/#related-commands","text":"Command Description upctl kubernetes Manage Kubernetes clusters","title":"Related commands"},{"location":"commands_reference/upctl_kubernetes/create/","text":"upctl kubernetes create Create a Kubernetes cluster upctl kubernetes create [flags] Examples upctl kubernetes create \\ --name my-cluster \\ --network 03e5ca07-f36c-4957-a676-e001e40441eb \\ --node-group count=2,name=my-minimal-node-group,plan=2xCPU-4GB, \\ --zone de-fra1 upctl kubernetes create \\ --name my-cluster \\ --plan production-small \\ --network 03e5ca07-f36c-4957-a676-e001e40441eb \\ --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\" \\ --zone de-fra1 Options Option Description --name Kubernetes cluster name. --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 create Default: false Global options Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human Related commands Command Description upctl kubernetes Manage Kubernetes clusters","title":"kubernetes create"},{"location":"commands_reference/upctl_kubernetes/create/#upctl-kubernetes-create","text":"Create a Kubernetes cluster upctl kubernetes create [flags]","title":"upctl kubernetes create"},{"location":"commands_reference/upctl_kubernetes/create/#examples","text":"upctl kubernetes create \\ --name my-cluster \\ --network 03e5ca07-f36c-4957-a676-e001e40441eb \\ --node-group count=2,name=my-minimal-node-group,plan=2xCPU-4GB, \\ --zone de-fra1 upctl kubernetes create \\ --name my-cluster \\ --plan production-small \\ --network 03e5ca07-f36c-4957-a676-e001e40441eb \\ --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\" \\ --zone de-fra1","title":"Examples"},{"location":"commands_reference/upctl_kubernetes/create/#options","text":"Option Description --name Kubernetes cluster name. --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 create Default: false","title":"Options"},{"location":"commands_reference/upctl_kubernetes/create/#global-options","text":"Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human","title":"Global options"},{"location":"commands_reference/upctl_kubernetes/create/#related-commands","text":"Command Description upctl kubernetes Manage Kubernetes clusters","title":"Related commands"},{"location":"commands_reference/upctl_kubernetes/delete/","text":"upctl kubernetes delete Delete a Kubernetes cluster upctl kubernetes delete [flags] Examples upctl kubernetes delete 55199a44-4751-4e27-9394-7c7661910be3 upctl kubernetes delete my-kubernetes-cluster Options Option Description --help , -h help for delete Default: false Global options Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human Related commands Command Description upctl kubernetes Manage Kubernetes clusters","title":"kubernetes delete"},{"location":"commands_reference/upctl_kubernetes/delete/#upctl-kubernetes-delete","text":"Delete a Kubernetes cluster upctl kubernetes delete [flags]","title":"upctl kubernetes delete"},{"location":"commands_reference/upctl_kubernetes/delete/#examples","text":"upctl kubernetes delete 55199a44-4751-4e27-9394-7c7661910be3 upctl kubernetes delete my-kubernetes-cluster","title":"Examples"},{"location":"commands_reference/upctl_kubernetes/delete/#options","text":"Option Description --help , -h help for delete Default: false","title":"Options"},{"location":"commands_reference/upctl_kubernetes/delete/#global-options","text":"Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human","title":"Global options"},{"location":"commands_reference/upctl_kubernetes/delete/#related-commands","text":"Command Description upctl kubernetes Manage Kubernetes clusters","title":"Related commands"},{"location":"commands_reference/upctl_kubernetes/list/","text":"upctl kubernetes list List current Kubernetes clusters upctl kubernetes list [flags] Examples upctl kubernetes list Options Option Description --help , -h help for list Default: false Global options Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human Related commands Command Description upctl kubernetes Manage Kubernetes clusters","title":"kubernetes list"},{"location":"commands_reference/upctl_kubernetes/list/#upctl-kubernetes-list","text":"List current Kubernetes clusters upctl kubernetes list [flags]","title":"upctl kubernetes list"},{"location":"commands_reference/upctl_kubernetes/list/#examples","text":"upctl kubernetes list","title":"Examples"},{"location":"commands_reference/upctl_kubernetes/list/#options","text":"Option Description --help , -h help for list Default: false","title":"Options"},{"location":"commands_reference/upctl_kubernetes/list/#global-options","text":"Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human","title":"Global options"},{"location":"commands_reference/upctl_kubernetes/list/#related-commands","text":"Command Description upctl kubernetes Manage Kubernetes clusters","title":"Related commands"},{"location":"commands_reference/upctl_kubernetes/modify/","text":"upctl kubernetes modify Modifiy an existing cluster upctl kubernetes modify [flags] Examples upctl cluster modify 00bb4617-c592-4b32-b869-35a60b323b18 --plan 1xCPU-1GB Options 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: [] --help , -h help for modify Default: false Global options Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human Related commands Command Description upctl kubernetes Manage Kubernetes clusters","title":"kubernetes modify"},{"location":"commands_reference/upctl_kubernetes/modify/#upctl-kubernetes-modify","text":"Modifiy an existing cluster upctl kubernetes modify [flags]","title":"upctl kubernetes modify"},{"location":"commands_reference/upctl_kubernetes/modify/#examples","text":"upctl cluster modify 00bb4617-c592-4b32-b869-35a60b323b18 --plan 1xCPU-1GB","title":"Examples"},{"location":"commands_reference/upctl_kubernetes/modify/#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: [] --help , -h help for modify Default: false","title":"Options"},{"location":"commands_reference/upctl_kubernetes/modify/#global-options","text":"Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human","title":"Global options"},{"location":"commands_reference/upctl_kubernetes/modify/#related-commands","text":"Command Description upctl kubernetes Manage Kubernetes clusters","title":"Related commands"},{"location":"commands_reference/upctl_kubernetes/plans/","text":"upctl kubernetes plans List available cluster plans upctl kubernetes plans [flags] Examples upctl kubernetes plans Options Option Description --help , -h help for plans Default: false Global options Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human Related commands Command Description upctl kubernetes Manage Kubernetes clusters","title":"kubernetes plans"},{"location":"commands_reference/upctl_kubernetes/plans/#upctl-kubernetes-plans","text":"List available cluster plans upctl kubernetes plans [flags]","title":"upctl kubernetes plans"},{"location":"commands_reference/upctl_kubernetes/plans/#examples","text":"upctl kubernetes plans","title":"Examples"},{"location":"commands_reference/upctl_kubernetes/plans/#options","text":"Option Description --help , -h help for plans Default: false","title":"Options"},{"location":"commands_reference/upctl_kubernetes/plans/#global-options","text":"Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human","title":"Global options"},{"location":"commands_reference/upctl_kubernetes/plans/#related-commands","text":"Command Description upctl kubernetes Manage Kubernetes clusters","title":"Related commands"},{"location":"commands_reference/upctl_kubernetes/show/","text":"upctl kubernetes show Show Kubernetes cluster details upctl kubernetes show [flags] Examples upctl kubernetes show 55199a44-4751-4e27-9394-7c7661910be3 upctl kubernetes show my-cluster Options Option Description --help , -h help for show Default: false Global options Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human Related commands Command Description upctl kubernetes Manage Kubernetes clusters","title":"kubernetes show"},{"location":"commands_reference/upctl_kubernetes/show/#upctl-kubernetes-show","text":"Show Kubernetes cluster details upctl kubernetes show [flags]","title":"upctl kubernetes show"},{"location":"commands_reference/upctl_kubernetes/show/#examples","text":"upctl kubernetes show 55199a44-4751-4e27-9394-7c7661910be3 upctl kubernetes show my-cluster","title":"Examples"},{"location":"commands_reference/upctl_kubernetes/show/#options","text":"Option Description --help , -h help for show Default: false","title":"Options"},{"location":"commands_reference/upctl_kubernetes/show/#global-options","text":"Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human","title":"Global options"},{"location":"commands_reference/upctl_kubernetes/show/#related-commands","text":"Command Description upctl kubernetes Manage Kubernetes clusters","title":"Related commands"},{"location":"commands_reference/upctl_kubernetes/versions/","text":"upctl kubernetes versions List available versions for Kubernetes clusters upctl kubernetes versions [flags] Examples upctl kubernetes versions Options Option Description --help , -h help for versions Default: false Global options Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human Related commands Command Description upctl kubernetes Manage Kubernetes clusters","title":"kubernetes versions"},{"location":"commands_reference/upctl_kubernetes/versions/#upctl-kubernetes-versions","text":"List available versions for Kubernetes clusters upctl kubernetes versions [flags]","title":"upctl kubernetes versions"},{"location":"commands_reference/upctl_kubernetes/versions/#examples","text":"upctl kubernetes versions","title":"Examples"},{"location":"commands_reference/upctl_kubernetes/versions/#options","text":"Option Description --help , -h help for versions Default: false","title":"Options"},{"location":"commands_reference/upctl_kubernetes/versions/#global-options","text":"Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human","title":"Global options"},{"location":"commands_reference/upctl_kubernetes/versions/#related-commands","text":"Command Description upctl kubernetes Manage Kubernetes clusters","title":"Related commands"},{"location":"commands_reference/upctl_kubernetes/nodegroup/","text":"upctl kubernetes nodegroup Manage cluster node-groups upctl kubernetes nodegroup [flags] Aliases node-group Options Option Description --help , -h help for nodegroup Default: false Global options Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human Related commands 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","title":"nodegroup "},{"location":"commands_reference/upctl_kubernetes/nodegroup/#upctl-kubernetes-nodegroup","text":"Manage cluster node-groups upctl kubernetes nodegroup [flags]","title":"upctl kubernetes nodegroup"},{"location":"commands_reference/upctl_kubernetes/nodegroup/#aliases","text":"node-group","title":"Aliases"},{"location":"commands_reference/upctl_kubernetes/nodegroup/#options","text":"Option Description --help , -h help for nodegroup Default: false","title":"Options"},{"location":"commands_reference/upctl_kubernetes/nodegroup/#global-options","text":"Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human","title":"Global options"},{"location":"commands_reference/upctl_kubernetes/nodegroup/#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","title":"Related commands"},{"location":"commands_reference/upctl_kubernetes/nodegroup/create/","text":"upctl kubernetes nodegroup create Create a new node group into the specified cluster. upctl kubernetes nodegroup create [flags] Examples upctl kubernetes nodegroup create 55199a44-4751-4e27-9394-7c7661910be3 --name secondary-node-group --count 3 --plan 2xCPU-4GB Options Option Description --count Number of nodes in the node group Default: 0 --kubelet-arg Arguments to use when executing kubelet in argument=value format Default: [] --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 format Default: [] --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 create Default: false Global options Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human Related commands Command Description upctl kubernetes nodegroup Manage cluster node-groups","title":"nodegroup create"},{"location":"commands_reference/upctl_kubernetes/nodegroup/create/#upctl-kubernetes-nodegroup-create","text":"Create a new node group into the specified cluster. upctl kubernetes nodegroup create [flags]","title":"upctl kubernetes nodegroup create"},{"location":"commands_reference/upctl_kubernetes/nodegroup/create/#examples","text":"upctl kubernetes nodegroup create 55199a44-4751-4e27-9394-7c7661910be3 --name secondary-node-group --count 3 --plan 2xCPU-4GB","title":"Examples"},{"location":"commands_reference/upctl_kubernetes/nodegroup/create/#options","text":"Option Description --count Number of nodes in the node group Default: 0 --kubelet-arg Arguments to use when executing kubelet in argument=value format Default: [] --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 format Default: [] --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 create Default: false","title":"Options"},{"location":"commands_reference/upctl_kubernetes/nodegroup/create/#global-options","text":"Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human","title":"Global options"},{"location":"commands_reference/upctl_kubernetes/nodegroup/create/#related-commands","text":"Command Description upctl kubernetes nodegroup Manage cluster node-groups","title":"Related commands"},{"location":"commands_reference/upctl_kubernetes/nodegroup/delete/","text":"upctl kubernetes nodegroup delete Delete the node group from the cluster. upctl kubernetes nodegroup delete [flags] Examples upctl kubernetes nodegroup delete 55199a44-4751-4e27-9394-7c7661910be3 --name secondary-node-group Options Option Description --name Node group name --help , -h help for delete Default: false Global options Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human Related commands Command Description upctl kubernetes nodegroup Manage cluster node-groups","title":"nodegroup delete"},{"location":"commands_reference/upctl_kubernetes/nodegroup/delete/#upctl-kubernetes-nodegroup-delete","text":"Delete the node group from the cluster. upctl kubernetes nodegroup delete [flags]","title":"upctl kubernetes nodegroup delete"},{"location":"commands_reference/upctl_kubernetes/nodegroup/delete/#examples","text":"upctl kubernetes nodegroup delete 55199a44-4751-4e27-9394-7c7661910be3 --name secondary-node-group","title":"Examples"},{"location":"commands_reference/upctl_kubernetes/nodegroup/delete/#options","text":"Option Description --name Node group name --help , -h help for delete Default: false","title":"Options"},{"location":"commands_reference/upctl_kubernetes/nodegroup/delete/#global-options","text":"Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human","title":"Global options"},{"location":"commands_reference/upctl_kubernetes/nodegroup/delete/#related-commands","text":"Command Description upctl kubernetes nodegroup Manage cluster node-groups","title":"Related commands"},{"location":"commands_reference/upctl_kubernetes/nodegroup/scale/","text":"upctl kubernetes nodegroup scale Scale the number of nodes in the node group. upctl kubernetes nodegroup scale [flags] Examples upctl kubernetes nodegroup scale 55199a44-4751-4e27-9394-7c7661910be3 --name secondary-node-group --count 3 Options Option Description --name Node group name --count Node count Default: 0 --help , -h help for scale Default: false Global options Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human Related commands Command Description upctl kubernetes nodegroup Manage cluster node-groups","title":"nodegroup scale"},{"location":"commands_reference/upctl_kubernetes/nodegroup/scale/#upctl-kubernetes-nodegroup-scale","text":"Scale the number of nodes in the node group. upctl kubernetes nodegroup scale [flags]","title":"upctl kubernetes nodegroup scale"},{"location":"commands_reference/upctl_kubernetes/nodegroup/scale/#examples","text":"upctl kubernetes nodegroup scale 55199a44-4751-4e27-9394-7c7661910be3 --name secondary-node-group --count 3","title":"Examples"},{"location":"commands_reference/upctl_kubernetes/nodegroup/scale/#options","text":"Option Description --name Node group name --count Node count Default: 0 --help , -h help for scale Default: false","title":"Options"},{"location":"commands_reference/upctl_kubernetes/nodegroup/scale/#global-options","text":"Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human","title":"Global options"},{"location":"commands_reference/upctl_kubernetes/nodegroup/scale/#related-commands","text":"Command Description upctl kubernetes nodegroup Manage cluster node-groups","title":"Related commands"},{"location":"commands_reference/upctl_kubernetes/nodegroup/show/","text":"upctl kubernetes nodegroup show Show node group details upctl kubernetes nodegroup show [flags] Examples upctl kubernetes nodegroup show 55199a44-4751-4e27-9394-7c7661910be3 --name default Options Option Description --name Node group name --help , -h help for show Default: false Global options Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human Related commands Command Description upctl kubernetes nodegroup Manage cluster node-groups","title":"nodegroup show"},{"location":"commands_reference/upctl_kubernetes/nodegroup/show/#upctl-kubernetes-nodegroup-show","text":"Show node group details upctl kubernetes nodegroup show [flags]","title":"upctl kubernetes nodegroup show"},{"location":"commands_reference/upctl_kubernetes/nodegroup/show/#examples","text":"upctl kubernetes nodegroup show 55199a44-4751-4e27-9394-7c7661910be3 --name default","title":"Examples"},{"location":"commands_reference/upctl_kubernetes/nodegroup/show/#options","text":"Option Description --name Node group name --help , -h help for show Default: false","title":"Options"},{"location":"commands_reference/upctl_kubernetes/nodegroup/show/#global-options","text":"Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human","title":"Global options"},{"location":"commands_reference/upctl_kubernetes/nodegroup/show/#related-commands","text":"Command Description upctl kubernetes nodegroup Manage cluster node-groups","title":"Related commands"},{"location":"commands_reference/upctl_loadbalancer/","text":"upctl loadbalancer Manage load balancers upctl loadbalancer [flags] Aliases lb Options Option Description --help , -h help for loadbalancer Default: false Global options Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human Related commands 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","title":"loadbalancer "},{"location":"commands_reference/upctl_loadbalancer/#upctl-loadbalancer","text":"Manage load balancers upctl loadbalancer [flags]","title":"upctl loadbalancer"},{"location":"commands_reference/upctl_loadbalancer/#aliases","text":"lb","title":"Aliases"},{"location":"commands_reference/upctl_loadbalancer/#options","text":"Option Description --help , -h help for loadbalancer Default: false","title":"Options"},{"location":"commands_reference/upctl_loadbalancer/#global-options","text":"Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human","title":"Global options"},{"location":"commands_reference/upctl_loadbalancer/#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","title":"Related commands"},{"location":"commands_reference/upctl_loadbalancer/delete/","text":"upctl loadbalancer delete Delete a load balancer upctl loadbalancer delete [flags] Examples upctl loadbalancer delete 55199a44-4751-4e27-9394-7c7661910be3 upctl loadbalancer delete my-load-balancer Options Option Description --help , -h help for delete Default: false Global options Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human Related commands Command Description upctl loadbalancer Manage load balancers","title":"loadbalancer delete"},{"location":"commands_reference/upctl_loadbalancer/delete/#upctl-loadbalancer-delete","text":"Delete a load balancer upctl loadbalancer delete [flags]","title":"upctl loadbalancer delete"},{"location":"commands_reference/upctl_loadbalancer/delete/#examples","text":"upctl loadbalancer delete 55199a44-4751-4e27-9394-7c7661910be3 upctl loadbalancer delete my-load-balancer","title":"Examples"},{"location":"commands_reference/upctl_loadbalancer/delete/#options","text":"Option Description --help , -h help for delete Default: false","title":"Options"},{"location":"commands_reference/upctl_loadbalancer/delete/#global-options","text":"Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human","title":"Global options"},{"location":"commands_reference/upctl_loadbalancer/delete/#related-commands","text":"Command Description upctl loadbalancer Manage load balancers","title":"Related commands"},{"location":"commands_reference/upctl_loadbalancer/list/","text":"upctl loadbalancer list List current load balancers upctl loadbalancer list [flags] Examples upctl loadbalancer list Options Option Description --help , -h help for list Default: false Global options Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human Related commands Command Description upctl loadbalancer Manage load balancers","title":"loadbalancer list"},{"location":"commands_reference/upctl_loadbalancer/list/#upctl-loadbalancer-list","text":"List current load balancers upctl loadbalancer list [flags]","title":"upctl loadbalancer list"},{"location":"commands_reference/upctl_loadbalancer/list/#examples","text":"upctl loadbalancer list","title":"Examples"},{"location":"commands_reference/upctl_loadbalancer/list/#options","text":"Option Description --help , -h help for list Default: false","title":"Options"},{"location":"commands_reference/upctl_loadbalancer/list/#global-options","text":"Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human","title":"Global options"},{"location":"commands_reference/upctl_loadbalancer/list/#related-commands","text":"Command Description upctl loadbalancer Manage load balancers","title":"Related commands"},{"location":"commands_reference/upctl_loadbalancer/plans/","text":"upctl loadbalancer plans List available load balancer plans upctl loadbalancer plans [flags] Examples upctl loadbalancer plans Options Option Description --help , -h help for plans Default: false Global options Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human Related commands Command Description upctl loadbalancer Manage load balancers","title":"loadbalancer plans"},{"location":"commands_reference/upctl_loadbalancer/plans/#upctl-loadbalancer-plans","text":"List available load balancer plans upctl loadbalancer plans [flags]","title":"upctl loadbalancer plans"},{"location":"commands_reference/upctl_loadbalancer/plans/#examples","text":"upctl loadbalancer plans","title":"Examples"},{"location":"commands_reference/upctl_loadbalancer/plans/#options","text":"Option Description --help , -h help for plans Default: false","title":"Options"},{"location":"commands_reference/upctl_loadbalancer/plans/#global-options","text":"Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human","title":"Global options"},{"location":"commands_reference/upctl_loadbalancer/plans/#related-commands","text":"Command Description upctl loadbalancer Manage load balancers","title":"Related commands"},{"location":"commands_reference/upctl_loadbalancer/show/","text":"upctl loadbalancer show Show load balancer details upctl loadbalancer show [flags] Examples upctl loadbalancer show 55199a44-4751-4e27-9394-7c7661910be3 upctl loadbalancer show my-load-balancer Options Option Description --help , -h help for show Default: false Global options Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human Related commands Command Description upctl loadbalancer Manage load balancers","title":"loadbalancer show"},{"location":"commands_reference/upctl_loadbalancer/show/#upctl-loadbalancer-show","text":"Show load balancer details upctl loadbalancer show [flags]","title":"upctl loadbalancer show"},{"location":"commands_reference/upctl_loadbalancer/show/#examples","text":"upctl loadbalancer show 55199a44-4751-4e27-9394-7c7661910be3 upctl loadbalancer show my-load-balancer","title":"Examples"},{"location":"commands_reference/upctl_loadbalancer/show/#options","text":"Option Description --help , -h help for show Default: false","title":"Options"},{"location":"commands_reference/upctl_loadbalancer/show/#global-options","text":"Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human","title":"Global options"},{"location":"commands_reference/upctl_loadbalancer/show/#related-commands","text":"Command Description upctl loadbalancer Manage load balancers","title":"Related commands"},{"location":"commands_reference/upctl_network/","text":"upctl network Manage networks upctl network [flags] Aliases net Options Option Description --help , -h help for network Default: false Global options Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human Related commands 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","title":"network "},{"location":"commands_reference/upctl_network/#upctl-network","text":"Manage networks upctl network [flags]","title":"upctl network"},{"location":"commands_reference/upctl_network/#aliases","text":"net","title":"Aliases"},{"location":"commands_reference/upctl_network/#options","text":"Option Description --help , -h help for network Default: false","title":"Options"},{"location":"commands_reference/upctl_network/#global-options","text":"Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human","title":"Global options"},{"location":"commands_reference/upctl_network/#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","title":"Related commands"},{"location":"commands_reference/upctl_network/create/","text":"upctl network create Create a network upctl network create [flags] Examples upctl network create --name \"My Network\" --zone pl-waw1 --ip-network address=10.0.1.0/24 upctl network create --name my_net --zone pl-waw1 --ip-network address=10.0.2.0/24,dhcp=true Options 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 strings Default: [] --help , -h help for create Default: false Global options Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human Related commands Command Description upctl network Manage networks","title":"network create"},{"location":"commands_reference/upctl_network/create/#upctl-network-create","text":"Create a network upctl network create [flags]","title":"upctl network create"},{"location":"commands_reference/upctl_network/create/#examples","text":"upctl network create --name \"My Network\" --zone pl-waw1 --ip-network address=10.0.1.0/24 upctl network create --name my_net --zone pl-waw1 --ip-network address=10.0.2.0/24,dhcp=true","title":"Examples"},{"location":"commands_reference/upctl_network/create/#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 strings Default: [] --help , -h help for create Default: false","title":"Options"},{"location":"commands_reference/upctl_network/create/#global-options","text":"Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human","title":"Global options"},{"location":"commands_reference/upctl_network/create/#related-commands","text":"Command Description upctl network Manage networks","title":"Related commands"},{"location":"commands_reference/upctl_network/delete/","text":"upctl network delete Delete a network upctl network delete [flags] Examples upctl network delete 037f260c-9568-4d9b-97e5-44cf52440ccb upctl network delete 03d7b5c2-b80a-4636-88d4-f9911185c975 0312a237-8204-4c1c-9fd1-2314013ec687 upctl network delete \"My Network 1\" Options Option Description --help , -h help for delete Default: false Global options Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human Related commands Command Description upctl network Manage networks","title":"network delete"},{"location":"commands_reference/upctl_network/delete/#upctl-network-delete","text":"Delete a network upctl network delete [flags]","title":"upctl network delete"},{"location":"commands_reference/upctl_network/delete/#examples","text":"upctl network delete 037f260c-9568-4d9b-97e5-44cf52440ccb upctl network delete 03d7b5c2-b80a-4636-88d4-f9911185c975 0312a237-8204-4c1c-9fd1-2314013ec687 upctl network delete \"My Network 1\"","title":"Examples"},{"location":"commands_reference/upctl_network/delete/#options","text":"Option Description --help , -h help for delete Default: false","title":"Options"},{"location":"commands_reference/upctl_network/delete/#global-options","text":"Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human","title":"Global options"},{"location":"commands_reference/upctl_network/delete/#related-commands","text":"Command Description upctl network Manage networks","title":"Related commands"},{"location":"commands_reference/upctl_network/list/","text":"upctl network list List networks, by default private networks only upctl network list [flags] Examples upctl network list upctl network list --zone pl-waw1 upctl network list --zone pl-waw1 --public upctl network list --all upctl network list --zone pl-waw1 --all Options 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 list Default: false Global options Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human Related commands Command Description upctl network Manage networks","title":"network list"},{"location":"commands_reference/upctl_network/list/#upctl-network-list","text":"List networks, by default private networks only upctl network list [flags]","title":"upctl network list"},{"location":"commands_reference/upctl_network/list/#examples","text":"upctl network list upctl network list --zone pl-waw1 upctl network list --zone pl-waw1 --public upctl network list --all upctl network list --zone pl-waw1 --all","title":"Examples"},{"location":"commands_reference/upctl_network/list/#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 list Default: false","title":"Options"},{"location":"commands_reference/upctl_network/list/#global-options","text":"Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human","title":"Global options"},{"location":"commands_reference/upctl_network/list/#related-commands","text":"Command Description upctl network Manage networks","title":"Related commands"},{"location":"commands_reference/upctl_network/modify/","text":"upctl network modify Modify a network upctl network modify [flags] Examples upctl network modify 037a530b-533e-4cef-b6ad-6af8094bb2bc --ip-network dhcp=false,family=IPv4 upctl network modify \"My Network\" --name \"My Super Network\" Options 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 strings Default: [] --help , -h help for modify Default: false Global options Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human Related commands Command Description upctl network Manage networks","title":"network modify"},{"location":"commands_reference/upctl_network/modify/#upctl-network-modify","text":"Modify a network upctl network modify [flags]","title":"upctl network modify"},{"location":"commands_reference/upctl_network/modify/#examples","text":"upctl network modify 037a530b-533e-4cef-b6ad-6af8094bb2bc --ip-network dhcp=false,family=IPv4 upctl network modify \"My Network\" --name \"My Super Network\"","title":"Examples"},{"location":"commands_reference/upctl_network/modify/#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 strings Default: [] --help , -h help for modify Default: false","title":"Options"},{"location":"commands_reference/upctl_network/modify/#global-options","text":"Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human","title":"Global options"},{"location":"commands_reference/upctl_network/modify/#related-commands","text":"Command Description upctl network Manage networks","title":"Related commands"},{"location":"commands_reference/upctl_network/show/","text":"upctl network show Show network details upctl network show [flags] Examples upctl network show 037a530b-533e-4cef-b6ad-6af8094bb2bc upctl network show 037a530b-533e-4cef-b6ad-6af8094bb2bc 0311480d-d0c0-4951-ab41-bf12097f5d3c upctl network show \"My Network\" Options Option Description --help , -h help for show Default: false Global options Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human Related commands Command Description upctl network Manage networks","title":"network show"},{"location":"commands_reference/upctl_network/show/#upctl-network-show","text":"Show network details upctl network show [flags]","title":"upctl network show"},{"location":"commands_reference/upctl_network/show/#examples","text":"upctl network show 037a530b-533e-4cef-b6ad-6af8094bb2bc upctl network show 037a530b-533e-4cef-b6ad-6af8094bb2bc 0311480d-d0c0-4951-ab41-bf12097f5d3c upctl network show \"My Network\"","title":"Examples"},{"location":"commands_reference/upctl_network/show/#options","text":"Option Description --help , -h help for show Default: false","title":"Options"},{"location":"commands_reference/upctl_network/show/#global-options","text":"Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human","title":"Global options"},{"location":"commands_reference/upctl_network/show/#related-commands","text":"Command Description upctl network Manage networks","title":"Related commands"},{"location":"commands_reference/upctl_objectstorage/","text":"upctl objectstorage Manage Managed object storage services upctl objectstorage [flags] Aliases object-storage , objsto Options Option Description --help , -h help for objectstorage Default: false Global options Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human Related commands 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 show Show Managed object storage service details","title":"objectstorage "},{"location":"commands_reference/upctl_objectstorage/#upctl-objectstorage","text":"Manage Managed object storage services upctl objectstorage [flags]","title":"upctl objectstorage"},{"location":"commands_reference/upctl_objectstorage/#aliases","text":"object-storage , objsto","title":"Aliases"},{"location":"commands_reference/upctl_objectstorage/#options","text":"Option Description --help , -h help for objectstorage Default: false","title":"Options"},{"location":"commands_reference/upctl_objectstorage/#global-options","text":"Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human","title":"Global options"},{"location":"commands_reference/upctl_objectstorage/#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 show Show Managed object storage service details","title":"Related commands"},{"location":"commands_reference/upctl_objectstorage/delete/","text":"upctl objectstorage delete Delete a Managed object storage service upctl objectstorage delete [flags] Examples upctl objectstorage delete 55199a44-4751-4e27-9394-7c7661910be8 Options Option Description --help , -h help for delete Default: false Global options Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human Related commands Command Description upctl objectstorage Manage Managed object storage services","title":"objectstorage delete"},{"location":"commands_reference/upctl_objectstorage/delete/#upctl-objectstorage-delete","text":"Delete a Managed object storage service upctl objectstorage delete [flags]","title":"upctl objectstorage delete"},{"location":"commands_reference/upctl_objectstorage/delete/#examples","text":"upctl objectstorage delete 55199a44-4751-4e27-9394-7c7661910be8","title":"Examples"},{"location":"commands_reference/upctl_objectstorage/delete/#options","text":"Option Description --help , -h help for delete Default: false","title":"Options"},{"location":"commands_reference/upctl_objectstorage/delete/#global-options","text":"Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human","title":"Global options"},{"location":"commands_reference/upctl_objectstorage/delete/#related-commands","text":"Command Description upctl objectstorage Manage Managed object storage services","title":"Related commands"},{"location":"commands_reference/upctl_objectstorage/list/","text":"upctl objectstorage list List current Managed object storage services upctl objectstorage list [flags] Examples upctl objectstorage list Options Option Description --help , -h help for list Default: false Global options Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human Related commands Command Description upctl objectstorage Manage Managed object storage services","title":"objectstorage list"},{"location":"commands_reference/upctl_objectstorage/list/#upctl-objectstorage-list","text":"List current Managed object storage services upctl objectstorage list [flags]","title":"upctl objectstorage list"},{"location":"commands_reference/upctl_objectstorage/list/#examples","text":"upctl objectstorage list","title":"Examples"},{"location":"commands_reference/upctl_objectstorage/list/#options","text":"Option Description --help , -h help for list Default: false","title":"Options"},{"location":"commands_reference/upctl_objectstorage/list/#global-options","text":"Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human","title":"Global options"},{"location":"commands_reference/upctl_objectstorage/list/#related-commands","text":"Command Description upctl objectstorage Manage Managed object storage services","title":"Related commands"},{"location":"commands_reference/upctl_objectstorage/show/","text":"upctl objectstorage show Show Managed object storage service details upctl objectstorage show [flags] Examples upctl objectstorage show 55199a44-4751-4e27-9394-7c7661910be8 Options Option Description --help , -h help for show Default: false Global options Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human Related commands Command Description upctl objectstorage Manage Managed object storage services","title":"objectstorage show"},{"location":"commands_reference/upctl_objectstorage/show/#upctl-objectstorage-show","text":"Show Managed object storage service details upctl objectstorage show [flags]","title":"upctl objectstorage show"},{"location":"commands_reference/upctl_objectstorage/show/#examples","text":"upctl objectstorage show 55199a44-4751-4e27-9394-7c7661910be8","title":"Examples"},{"location":"commands_reference/upctl_objectstorage/show/#options","text":"Option Description --help , -h help for show Default: false","title":"Options"},{"location":"commands_reference/upctl_objectstorage/show/#global-options","text":"Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human","title":"Global options"},{"location":"commands_reference/upctl_objectstorage/show/#related-commands","text":"Command Description upctl objectstorage Manage Managed object storage services","title":"Related commands"},{"location":"commands_reference/upctl_router/","text":"upctl router Manage routers upctl router [flags] Options Option Description --help , -h help for router Default: false Global options Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human Related commands 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","title":"router "},{"location":"commands_reference/upctl_router/#upctl-router","text":"Manage routers upctl router [flags]","title":"upctl router"},{"location":"commands_reference/upctl_router/#options","text":"Option Description --help , -h help for router Default: false","title":"Options"},{"location":"commands_reference/upctl_router/#global-options","text":"Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human","title":"Global options"},{"location":"commands_reference/upctl_router/#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","title":"Related commands"},{"location":"commands_reference/upctl_router/create/","text":"upctl router create Create a router upctl router create [flags] Examples upctl router create --name my_router upctl router create --name \"My Router\" Options Option Description --name Router name. --help , -h help for create Default: false Global options Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human Related commands Command Description upctl router Manage routers","title":"router create"},{"location":"commands_reference/upctl_router/create/#upctl-router-create","text":"Create a router upctl router create [flags]","title":"upctl router create"},{"location":"commands_reference/upctl_router/create/#examples","text":"upctl router create --name my_router upctl router create --name \"My Router\"","title":"Examples"},{"location":"commands_reference/upctl_router/create/#options","text":"Option Description --name Router name. --help , -h help for create Default: false","title":"Options"},{"location":"commands_reference/upctl_router/create/#global-options","text":"Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human","title":"Global options"},{"location":"commands_reference/upctl_router/create/#related-commands","text":"Command Description upctl router Manage routers","title":"Related commands"},{"location":"commands_reference/upctl_router/delete/","text":"upctl router delete Delete a router upctl router delete [flags] Examples upctl router delete 0497728e-76ef-41d0-997f-fa9449eb71bc upctl router delete my_router Options Option Description --help , -h help for delete Default: false Global options Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human Related commands Command Description upctl router Manage routers","title":"router delete"},{"location":"commands_reference/upctl_router/delete/#upctl-router-delete","text":"Delete a router upctl router delete [flags]","title":"upctl router delete"},{"location":"commands_reference/upctl_router/delete/#examples","text":"upctl router delete 0497728e-76ef-41d0-997f-fa9449eb71bc upctl router delete my_router","title":"Examples"},{"location":"commands_reference/upctl_router/delete/#options","text":"Option Description --help , -h help for delete Default: false","title":"Options"},{"location":"commands_reference/upctl_router/delete/#global-options","text":"Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human","title":"Global options"},{"location":"commands_reference/upctl_router/delete/#related-commands","text":"Command Description upctl router Manage routers","title":"Related commands"},{"location":"commands_reference/upctl_router/list/","text":"upctl router list List routers upctl router list [flags] Examples upctl router list upctl router list --all Options Option Description --all Show all routers. --normal Show normal routers. --service Show service routers. --help , -h help for list Default: false Global options Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human Related commands Command Description upctl router Manage routers","title":"router list"},{"location":"commands_reference/upctl_router/list/#upctl-router-list","text":"List routers upctl router list [flags]","title":"upctl router list"},{"location":"commands_reference/upctl_router/list/#examples","text":"upctl router list upctl router list --all","title":"Examples"},{"location":"commands_reference/upctl_router/list/#options","text":"Option Description --all Show all routers. --normal Show normal routers. --service Show service routers. --help , -h help for list Default: false","title":"Options"},{"location":"commands_reference/upctl_router/list/#global-options","text":"Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human","title":"Global options"},{"location":"commands_reference/upctl_router/list/#related-commands","text":"Command Description upctl router Manage routers","title":"Related commands"},{"location":"commands_reference/upctl_router/modify/","text":"upctl router modify Modify a router upctl router modify [flags] Examples upctl router modify 04d031ab-4b85-4cbc-9f0e-6a2977541327 --name my_super_router upctl router modify \"My Router\" --name \"My Turbo Router\" Options Option Description --name New router name. --help , -h help for modify Default: false Global options Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human Related commands Command Description upctl router Manage routers","title":"router modify"},{"location":"commands_reference/upctl_router/modify/#upctl-router-modify","text":"Modify a router upctl router modify [flags]","title":"upctl router modify"},{"location":"commands_reference/upctl_router/modify/#examples","text":"upctl router modify 04d031ab-4b85-4cbc-9f0e-6a2977541327 --name my_super_router upctl router modify \"My Router\" --name \"My Turbo Router\"","title":"Examples"},{"location":"commands_reference/upctl_router/modify/#options","text":"Option Description --name New router name. --help , -h help for modify Default: false","title":"Options"},{"location":"commands_reference/upctl_router/modify/#global-options","text":"Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human","title":"Global options"},{"location":"commands_reference/upctl_router/modify/#related-commands","text":"Command Description upctl router Manage routers","title":"Related commands"},{"location":"commands_reference/upctl_router/show/","text":"upctl router show Show current router upctl router show [flags] Examples upctl router show 04d0a7f6-ee78-42b5-8077-6947f9e67c5a upctl router show 04d0a7f6-ee78-42b5-8077-6947f9e67c5a 04d031ab-4b85-4cbc-9f0e-6a2977541327 upctl router show \"My Turbo Router\" my_super_router Options Option Description --help , -h help for show Default: false Global options Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human Related commands Command Description upctl router Manage routers","title":"router show"},{"location":"commands_reference/upctl_router/show/#upctl-router-show","text":"Show current router upctl router show [flags]","title":"upctl router show"},{"location":"commands_reference/upctl_router/show/#examples","text":"upctl router show 04d0a7f6-ee78-42b5-8077-6947f9e67c5a upctl router show 04d0a7f6-ee78-42b5-8077-6947f9e67c5a 04d031ab-4b85-4cbc-9f0e-6a2977541327 upctl router show \"My Turbo Router\" my_super_router","title":"Examples"},{"location":"commands_reference/upctl_router/show/#options","text":"Option Description --help , -h help for show Default: false","title":"Options"},{"location":"commands_reference/upctl_router/show/#global-options","text":"Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human","title":"Global options"},{"location":"commands_reference/upctl_router/show/#related-commands","text":"Command Description upctl router Manage routers","title":"Related commands"},{"location":"commands_reference/upctl_server/","text":"upctl server Manage servers upctl server [flags] Options Option Description --help , -h help for server Default: false Global options Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human Related commands Command Description upctl UpCloud command-line interface upctl server create Create a 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","title":"server "},{"location":"commands_reference/upctl_server/#upctl-server","text":"Manage servers upctl server [flags]","title":"upctl server"},{"location":"commands_reference/upctl_server/#options","text":"Option Description --help , -h help for server Default: false","title":"Options"},{"location":"commands_reference/upctl_server/#global-options","text":"Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human","title":"Global options"},{"location":"commands_reference/upctl_server/#related-commands","text":"Command Description upctl UpCloud command-line interface upctl server create Create a 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","title":"Related commands"},{"location":"commands_reference/upctl_server/create/","text":"upctl server create Create a server upctl server create [flags] Examples upctl server create --title myapp --zone fi-hel1 --hostname myapp --password-delivery email upctl server create --wait --title myapp --zone fi-hel1 --hostname myapp --password-delivery email upctl server create --title \"My Server\" --zone fi-hel1 --hostname myapp --password-delivery email upctl server create --zone fi-hel1 --hostname myapp --password-delivery email --plan 2xCPU-4GB upctl server create --zone fi-hel1 --hostname myapp --password-delivery email --plan custom --cores 2 --memory 4096 upctl server create --zone fi-hel1 --hostname myapp --password-delivery email --os \"Debian GNU/Linux 10 (Buster)\" --server-group a4643646-8342-4324-4134-364138712378 upctl server create --zone fi-hel1 --hostname myapp --ssh-keys /path/to/publickey --network type=private,network=037a530b-533e-4cef-b6ad-6af8094bb2bc,ip-address=10.0.0.1 Options Option Description --avoid-host 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. --enable-remote-access Enable remote access. --host Use this to start a VM on a specific private cloud 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=operations Default: [] --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.1 Default: [] --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 20.04 LTS (Focal Fossa) --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 --password-delivery Defines how password is delivered. Available: email, sms Default: 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=cdrom Default: [] --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, cirrus Default: 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 create Default: false Global options Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human Related commands Command Description upctl server Manage servers","title":"server create"},{"location":"commands_reference/upctl_server/create/#upctl-server-create","text":"Create a server upctl server create [flags]","title":"upctl server create"},{"location":"commands_reference/upctl_server/create/#examples","text":"upctl server create --title myapp --zone fi-hel1 --hostname myapp --password-delivery email upctl server create --wait --title myapp --zone fi-hel1 --hostname myapp --password-delivery email upctl server create --title \"My Server\" --zone fi-hel1 --hostname myapp --password-delivery email upctl server create --zone fi-hel1 --hostname myapp --password-delivery email --plan 2xCPU-4GB upctl server create --zone fi-hel1 --hostname myapp --password-delivery email --plan custom --cores 2 --memory 4096 upctl server create --zone fi-hel1 --hostname myapp --password-delivery email --os \"Debian GNU/Linux 10 (Buster)\" --server-group a4643646-8342-4324-4134-364138712378 upctl server create --zone fi-hel1 --hostname myapp --ssh-keys /path/to/publickey --network type=private,network=037a530b-533e-4cef-b6ad-6af8094bb2bc,ip-address=10.0.0.1","title":"Examples"},{"location":"commands_reference/upctl_server/create/#options","text":"Option Description --avoid-host 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. --enable-remote-access Enable remote access. --host Use this to start a VM on a specific private cloud 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=operations Default: [] --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.1 Default: [] --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 20.04 LTS (Focal Fossa) --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 --password-delivery Defines how password is delivered. Available: email, sms Default: 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=cdrom Default: [] --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, cirrus Default: 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 create Default: false","title":"Options"},{"location":"commands_reference/upctl_server/create/#global-options","text":"Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human","title":"Global options"},{"location":"commands_reference/upctl_server/create/#related-commands","text":"Command Description upctl server Manage servers","title":"Related commands"},{"location":"commands_reference/upctl_server/delete/","text":"upctl server delete Delete a server upctl server delete [flags] Examples upctl server delete 00cbe2f3-4cf9-408b-afee-bd340e13cdd8 upctl server delete 00cbe2f3-4cf9-408b-afee-bd340e13cdd8 0053a6f5-e6d1-4b0b-b9dc-b90d0894e8d0 upctl server delete my_server Options Option Description --delete-storages Delete storages that are attached to the server. --help , -h help for delete Default: false Global options Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human Related commands Command Description upctl server Manage servers","title":"server delete"},{"location":"commands_reference/upctl_server/delete/#upctl-server-delete","text":"Delete a server upctl server delete [flags]","title":"upctl server delete"},{"location":"commands_reference/upctl_server/delete/#examples","text":"upctl server delete 00cbe2f3-4cf9-408b-afee-bd340e13cdd8 upctl server delete 00cbe2f3-4cf9-408b-afee-bd340e13cdd8 0053a6f5-e6d1-4b0b-b9dc-b90d0894e8d0 upctl server delete my_server","title":"Examples"},{"location":"commands_reference/upctl_server/delete/#options","text":"Option Description --delete-storages Delete storages that are attached to the server. --help , -h help for delete Default: false","title":"Options"},{"location":"commands_reference/upctl_server/delete/#global-options","text":"Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human","title":"Global options"},{"location":"commands_reference/upctl_server/delete/#related-commands","text":"Command Description upctl server Manage servers","title":"Related commands"},{"location":"commands_reference/upctl_server/eject/","text":"upctl server eject Eject a CD-ROM from the server upctl server eject [flags] Examples upctl server eject my_server Options Option Description --help , -h help for eject Default: false Global options Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human Related commands Command Description upctl server Manage servers","title":"server eject"},{"location":"commands_reference/upctl_server/eject/#upctl-server-eject","text":"Eject a CD-ROM from the server upctl server eject [flags]","title":"upctl server eject"},{"location":"commands_reference/upctl_server/eject/#examples","text":"upctl server eject my_server","title":"Examples"},{"location":"commands_reference/upctl_server/eject/#options","text":"Option Description --help , -h help for eject Default: false","title":"Options"},{"location":"commands_reference/upctl_server/eject/#global-options","text":"Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human","title":"Global options"},{"location":"commands_reference/upctl_server/eject/#related-commands","text":"Command Description upctl server Manage servers","title":"Related commands"},{"location":"commands_reference/upctl_server/list/","text":"upctl server list List current servers upctl server list [flags] Examples upctl server list upctl server list --show-ip-addresses upctl server list --show-ip-addresses=public Options 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 list Default: false Global options Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human Related commands Command Description upctl server Manage servers","title":"server list"},{"location":"commands_reference/upctl_server/list/#upctl-server-list","text":"List current servers upctl server list [flags]","title":"upctl server list"},{"location":"commands_reference/upctl_server/list/#examples","text":"upctl server list upctl server list --show-ip-addresses upctl server list --show-ip-addresses=public","title":"Examples"},{"location":"commands_reference/upctl_server/list/#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 list Default: false","title":"Options"},{"location":"commands_reference/upctl_server/list/#global-options","text":"Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human","title":"Global options"},{"location":"commands_reference/upctl_server/list/#related-commands","text":"Command Description upctl server Manage servers","title":"Related commands"},{"location":"commands_reference/upctl_server/load/","text":"upctl server load Load a CD-ROM into the server upctl server load [flags] Examples upctl server load my_server4 --storage 01000000-0000-4000-8000-000080030101 Options Option Description --storage The UUID of the storage to be loaded in the CD-ROM device. --help , -h help for load Default: false Global options Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human Related commands Command Description upctl server Manage servers","title":"server load"},{"location":"commands_reference/upctl_server/load/#upctl-server-load","text":"Load a CD-ROM into the server upctl server load [flags]","title":"upctl server load"},{"location":"commands_reference/upctl_server/load/#examples","text":"upctl server load my_server4 --storage 01000000-0000-4000-8000-000080030101","title":"Examples"},{"location":"commands_reference/upctl_server/load/#options","text":"Option Description --storage The UUID of the storage to be loaded in the CD-ROM device. --help , -h help for load Default: false","title":"Options"},{"location":"commands_reference/upctl_server/load/#global-options","text":"Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human","title":"Global options"},{"location":"commands_reference/upctl_server/load/#related-commands","text":"Command Description upctl server Manage servers","title":"Related commands"},{"location":"commands_reference/upctl_server/modify/","text":"upctl server modify Modifies the configuration of an existing server upctl server modify [flags] Examples upctl server modify 00bb4617-c592-4b32-b869-35a60b323b18 --plan 1xCPU-1GB upctl server modify 00bb4617-c592-4b32-b869-35a60b323b18 0053a6f5-e6d1-4b0b-b9dc-b90d0894e8d0 --plan 1xCPU-1GB upctl server modify my_server1 --plan 1xCPU-2GB upctl server modify myapp --hostname superapp Options 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=operations Default: [] --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 modify Default: false Global options Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human Related commands Command Description upctl server Manage servers","title":"server modify"},{"location":"commands_reference/upctl_server/modify/#upctl-server-modify","text":"Modifies the configuration of an existing server upctl server modify [flags]","title":"upctl server modify"},{"location":"commands_reference/upctl_server/modify/#examples","text":"upctl server modify 00bb4617-c592-4b32-b869-35a60b323b18 --plan 1xCPU-1GB upctl server modify 00bb4617-c592-4b32-b869-35a60b323b18 0053a6f5-e6d1-4b0b-b9dc-b90d0894e8d0 --plan 1xCPU-1GB upctl server modify my_server1 --plan 1xCPU-2GB upctl server modify myapp --hostname superapp","title":"Examples"},{"location":"commands_reference/upctl_server/modify/#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=operations Default: [] --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 modify Default: false","title":"Options"},{"location":"commands_reference/upctl_server/modify/#global-options","text":"Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human","title":"Global options"},{"location":"commands_reference/upctl_server/modify/#related-commands","text":"Command Description upctl server Manage servers","title":"Related commands"},{"location":"commands_reference/upctl_server/plans/","text":"upctl server plans List server plans upctl server plans [flags] Examples upctl server plans Options Option Description --help , -h help for plans Default: false Global options Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human Related commands Command Description upctl server Manage servers","title":"server plans"},{"location":"commands_reference/upctl_server/plans/#upctl-server-plans","text":"List server plans upctl server plans [flags]","title":"upctl server plans"},{"location":"commands_reference/upctl_server/plans/#examples","text":"upctl server plans","title":"Examples"},{"location":"commands_reference/upctl_server/plans/#options","text":"Option Description --help , -h help for plans Default: false","title":"Options"},{"location":"commands_reference/upctl_server/plans/#global-options","text":"Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human","title":"Global options"},{"location":"commands_reference/upctl_server/plans/#related-commands","text":"Command Description upctl server Manage servers","title":"Related commands"},{"location":"commands_reference/upctl_server/restart/","text":"upctl server restart Restart a server upctl server restart [flags] Examples upctl server restart 00038afc-d526-4148-af0e-d2f1eeaded9b upctl server restart 00038afc-d526-4148-af0e-d2f1eeaded9b --stop-type hard upctl server restart my_server1 my_server2 Options Option Description --stop-type The type of stop operation. Available: soft, hard Default: soft --help , -h help for restart Default: false Global options Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human Related commands Command Description upctl server Manage servers","title":"server restart"},{"location":"commands_reference/upctl_server/restart/#upctl-server-restart","text":"Restart a server upctl server restart [flags]","title":"upctl server restart"},{"location":"commands_reference/upctl_server/restart/#examples","text":"upctl server restart 00038afc-d526-4148-af0e-d2f1eeaded9b upctl server restart 00038afc-d526-4148-af0e-d2f1eeaded9b --stop-type hard upctl server restart my_server1 my_server2","title":"Examples"},{"location":"commands_reference/upctl_server/restart/#options","text":"Option Description --stop-type The type of stop operation. Available: soft, hard Default: soft --help , -h help for restart Default: false","title":"Options"},{"location":"commands_reference/upctl_server/restart/#global-options","text":"Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human","title":"Global options"},{"location":"commands_reference/upctl_server/restart/#related-commands","text":"Command Description upctl server Manage servers","title":"Related commands"},{"location":"commands_reference/upctl_server/show/","text":"upctl server show Show server details upctl server show [flags] Examples upctl server show 21aeb3b7-cd89-4123-a376-559b0e75be8b upctl server show 21aeb3b7-cd89-4123-a376-559b0e75be8b 0053a6f5-e6d1-4b0b-b9dc-b90d0894e8d0 upctl server show myhostname upctl server show my_server1 my_server2 Options Option Description --help , -h help for show Default: false Global options Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human Related commands Command Description upctl server Manage servers","title":"server show"},{"location":"commands_reference/upctl_server/show/#upctl-server-show","text":"Show server details upctl server show [flags]","title":"upctl server show"},{"location":"commands_reference/upctl_server/show/#examples","text":"upctl server show 21aeb3b7-cd89-4123-a376-559b0e75be8b upctl server show 21aeb3b7-cd89-4123-a376-559b0e75be8b 0053a6f5-e6d1-4b0b-b9dc-b90d0894e8d0 upctl server show myhostname upctl server show my_server1 my_server2","title":"Examples"},{"location":"commands_reference/upctl_server/show/#options","text":"Option Description --help , -h help for show Default: false","title":"Options"},{"location":"commands_reference/upctl_server/show/#global-options","text":"Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human","title":"Global options"},{"location":"commands_reference/upctl_server/show/#related-commands","text":"Command Description upctl server Manage servers","title":"Related commands"},{"location":"commands_reference/upctl_server/start/","text":"upctl server start Start a server upctl server start [flags] Examples upctl server start 00038afc-d526-4148-af0e-d2f1eeaded9b upctl server start 00038afc-d526-4148-af0e-d2f1eeaded9b 0053a6f5-e6d1-4b0b-b9dc-b90d0894e8d0 upctl server start my_server1 Options Option Description --help , -h help for start Default: false Global options Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human Related commands Command Description upctl server Manage servers","title":"server start"},{"location":"commands_reference/upctl_server/start/#upctl-server-start","text":"Start a server upctl server start [flags]","title":"upctl server start"},{"location":"commands_reference/upctl_server/start/#examples","text":"upctl server start 00038afc-d526-4148-af0e-d2f1eeaded9b upctl server start 00038afc-d526-4148-af0e-d2f1eeaded9b 0053a6f5-e6d1-4b0b-b9dc-b90d0894e8d0 upctl server start my_server1","title":"Examples"},{"location":"commands_reference/upctl_server/start/#options","text":"Option Description --help , -h help for start Default: false","title":"Options"},{"location":"commands_reference/upctl_server/start/#global-options","text":"Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human","title":"Global options"},{"location":"commands_reference/upctl_server/start/#related-commands","text":"Command Description upctl server Manage servers","title":"Related commands"},{"location":"commands_reference/upctl_server/stop/","text":"upctl server stop Stop a server upctl server stop [flags] Examples upctl server stop 00cbe2f3-4cf9-408b-afee-bd340e13cdd8 upctl server stop 00cbe2f3-4cf9-408b-afee-bd340e13cdd8 0053a6f5-e6d1-4b0b-b9dc-b90d0894e8d0 upctl server stop my_server upctl server stop --wait my_server Options Option Description --type The type of stop operation. Available: soft, hard Default: soft --wait Wait for server to be in stopped state before returning. --help , -h help for stop Default: false Global options Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human Related commands Command Description upctl server Manage servers","title":"server stop"},{"location":"commands_reference/upctl_server/stop/#upctl-server-stop","text":"Stop a server upctl server stop [flags]","title":"upctl server stop"},{"location":"commands_reference/upctl_server/stop/#examples","text":"upctl server stop 00cbe2f3-4cf9-408b-afee-bd340e13cdd8 upctl server stop 00cbe2f3-4cf9-408b-afee-bd340e13cdd8 0053a6f5-e6d1-4b0b-b9dc-b90d0894e8d0 upctl server stop my_server upctl server stop --wait my_server","title":"Examples"},{"location":"commands_reference/upctl_server/stop/#options","text":"Option Description --type The type of stop operation. Available: soft, hard Default: soft --wait Wait for server to be in stopped state before returning. --help , -h help for stop Default: false","title":"Options"},{"location":"commands_reference/upctl_server/stop/#global-options","text":"Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human","title":"Global options"},{"location":"commands_reference/upctl_server/stop/#related-commands","text":"Command Description upctl server Manage servers","title":"Related commands"},{"location":"commands_reference/upctl_server/firewall/","text":"upctl server firewall Manage server firewall rules. Enabling or disabling the firewall is done in server modify. upctl server firewall [flags] Options Option Description --help , -h help for firewall Default: false Global options Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human Related commands 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.","title":"firewall "},{"location":"commands_reference/upctl_server/firewall/#upctl-server-firewall","text":"Manage server firewall rules. Enabling or disabling the firewall is done in server modify. upctl server firewall [flags]","title":"upctl server firewall"},{"location":"commands_reference/upctl_server/firewall/#options","text":"Option Description --help , -h help for firewall Default: false","title":"Options"},{"location":"commands_reference/upctl_server/firewall/#global-options","text":"Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human","title":"Global options"},{"location":"commands_reference/upctl_server/firewall/#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.","title":"Related commands"},{"location":"commands_reference/upctl_server/firewall/create/","text":"upctl server firewall create 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 [flags] Examples upctl server firewall create 00038afc-d526-4148-af0e-d2f1eeaded9b --direction in --action drop upctl server firewall create 00038afc-d526-4148-af0e-d2f1eeaded9b --direction in --action accept --family IPv4 upctl server firewall create 00038afc-d526-4148-af0e-d2f1eeaded9b --direction in --action drop --family IPv4 --src-ipaddress-block 10.11.0.88/24 Options 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-1000 Default: 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 create Default: false Global options Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human Related commands Command Description upctl server firewall Manage server firewall rules. Enabling or disabling the firewall is done in server modify.","title":"firewall create"},{"location":"commands_reference/upctl_server/firewall/create/#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 [flags]","title":"upctl server firewall create"},{"location":"commands_reference/upctl_server/firewall/create/#examples","text":"upctl server firewall create 00038afc-d526-4148-af0e-d2f1eeaded9b --direction in --action drop upctl server firewall create 00038afc-d526-4148-af0e-d2f1eeaded9b --direction in --action accept --family IPv4 upctl server firewall create 00038afc-d526-4148-af0e-d2f1eeaded9b --direction in --action drop --family IPv4 --src-ipaddress-block 10.11.0.88/24","title":"Examples"},{"location":"commands_reference/upctl_server/firewall/create/#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-1000 Default: 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 create Default: false","title":"Options"},{"location":"commands_reference/upctl_server/firewall/create/#global-options","text":"Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human","title":"Global options"},{"location":"commands_reference/upctl_server/firewall/create/#related-commands","text":"Command Description upctl server firewall Manage server firewall rules. Enabling or disabling the firewall is done in server modify.","title":"Related commands"},{"location":"commands_reference/upctl_server/firewall/delete/","text":"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 delete [flags] Examples upctl server firewall delete 00038afc-d526-4148-af0e-d2f1eeaded9b --position 1 Options Option Description --position Rule position. Available: 1-1000 Default: 0 --help , -h help for delete Default: false Global options Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human Related commands Command Description upctl server firewall Manage server firewall rules. Enabling or disabling the firewall is done in server modify.","title":"firewall delete"},{"location":"commands_reference/upctl_server/firewall/delete/#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 [flags]","title":"upctl server firewall delete"},{"location":"commands_reference/upctl_server/firewall/delete/#examples","text":"upctl server firewall delete 00038afc-d526-4148-af0e-d2f1eeaded9b --position 1","title":"Examples"},{"location":"commands_reference/upctl_server/firewall/delete/#options","text":"Option Description --position Rule position. Available: 1-1000 Default: 0 --help , -h help for delete Default: false","title":"Options"},{"location":"commands_reference/upctl_server/firewall/delete/#global-options","text":"Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human","title":"Global options"},{"location":"commands_reference/upctl_server/firewall/delete/#related-commands","text":"Command Description upctl server firewall Manage server firewall rules. Enabling or disabling the firewall is done in server modify.","title":"Related commands"},{"location":"commands_reference/upctl_server/firewall/show/","text":"upctl server firewall show Show server firewall details. upctl server firewall show [flags] Examples upctl server firewall show 00038afc-d526-4148-af0e-d2f1eeaded9b upctl server firewall show 00038afc-d526-4148-af0e-d2f1eeaded9b 009d7f4e-99ce-4c78-88f1-e695d4c37743 upctl server firewall show my_server Options Option Description --help , -h help for show Default: false Global options Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human Related commands Command Description upctl server firewall Manage server firewall rules. Enabling or disabling the firewall is done in server modify.","title":"firewall show"},{"location":"commands_reference/upctl_server/firewall/show/#upctl-server-firewall-show","text":"Show server firewall details. upctl server firewall show [flags]","title":"upctl server firewall show"},{"location":"commands_reference/upctl_server/firewall/show/#examples","text":"upctl server firewall show 00038afc-d526-4148-af0e-d2f1eeaded9b upctl server firewall show 00038afc-d526-4148-af0e-d2f1eeaded9b 009d7f4e-99ce-4c78-88f1-e695d4c37743 upctl server firewall show my_server","title":"Examples"},{"location":"commands_reference/upctl_server/firewall/show/#options","text":"Option Description --help , -h help for show Default: false","title":"Options"},{"location":"commands_reference/upctl_server/firewall/show/#global-options","text":"Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human","title":"Global options"},{"location":"commands_reference/upctl_server/firewall/show/#related-commands","text":"Command Description upctl server firewall Manage server firewall rules. Enabling or disabling the firewall is done in server modify.","title":"Related commands"},{"location":"commands_reference/upctl_server/network-interface/","text":"upctl server network-interface Manage network interface upctl server network-interface [flags] Options Option Description --help , -h help for network-interface Default: false Global options Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human Related commands 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","title":"network-interface "},{"location":"commands_reference/upctl_server/network-interface/#upctl-server-network-interface","text":"Manage network interface upctl server network-interface [flags]","title":"upctl server network-interface"},{"location":"commands_reference/upctl_server/network-interface/#options","text":"Option Description --help , -h help for network-interface Default: false","title":"Options"},{"location":"commands_reference/upctl_server/network-interface/#global-options","text":"Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human","title":"Global options"},{"location":"commands_reference/upctl_server/network-interface/#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","title":"Related commands"},{"location":"commands_reference/upctl_server/network-interface/create/","text":"upctl server network-interface create Create a network interface upctl server network-interface create [flags] Examples 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 upctl server network-interface create my_server2 --type public --family IPv6 upctl server network-interface create my_server2 --type public --family IPv4 upctl server network-interface create my_server2 --network 037a530b-533e-4cef-b6ad-6af8094bb2bc Options Option Description --network Private network name or UUID to join. --type Set the type of the network. Available: public, utility, private Default: 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 addresses Default: [] --help , -h help for create Default: false Global options Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human Related commands Command Description upctl server network-interface Manage network interface","title":"network-interface create"},{"location":"commands_reference/upctl_server/network-interface/create/#upctl-server-network-interface-create","text":"Create a network interface upctl server network-interface create [flags]","title":"upctl server network-interface create"},{"location":"commands_reference/upctl_server/network-interface/create/#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 upctl server network-interface create my_server2 --type public --family IPv6 upctl server network-interface create my_server2 --type public --family IPv4 upctl server network-interface create my_server2 --network 037a530b-533e-4cef-b6ad-6af8094bb2bc","title":"Examples"},{"location":"commands_reference/upctl_server/network-interface/create/#options","text":"Option Description --network Private network name or UUID to join. --type Set the type of the network. Available: public, utility, private Default: 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 addresses Default: [] --help , -h help for create Default: false","title":"Options"},{"location":"commands_reference/upctl_server/network-interface/create/#global-options","text":"Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human","title":"Global options"},{"location":"commands_reference/upctl_server/network-interface/create/#related-commands","text":"Command Description upctl server network-interface Manage network interface","title":"Related commands"},{"location":"commands_reference/upctl_server/network-interface/delete/","text":"upctl server network-interface delete Delete a network interface upctl server network-interface delete [flags] Examples upctl server network-interface delete 009d7f4e-99ce-4c78-88f1-e695d4c37743 --index 1 upctl server network-interface delete my_server --index 7 Options Option Description --index Interface index. Default: 0 --help , -h help for delete Default: false Global options Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human Related commands Command Description upctl server network-interface Manage network interface","title":"network-interface delete"},{"location":"commands_reference/upctl_server/network-interface/delete/#upctl-server-network-interface-delete","text":"Delete a network interface upctl server network-interface delete [flags]","title":"upctl server network-interface delete"},{"location":"commands_reference/upctl_server/network-interface/delete/#examples","text":"upctl server network-interface delete 009d7f4e-99ce-4c78-88f1-e695d4c37743 --index 1 upctl server network-interface delete my_server --index 7","title":"Examples"},{"location":"commands_reference/upctl_server/network-interface/delete/#options","text":"Option Description --index Interface index. Default: 0 --help , -h help for delete Default: false","title":"Options"},{"location":"commands_reference/upctl_server/network-interface/delete/#global-options","text":"Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human","title":"Global options"},{"location":"commands_reference/upctl_server/network-interface/delete/#related-commands","text":"Command Description upctl server network-interface Manage network interface","title":"Related commands"},{"location":"commands_reference/upctl_server/network-interface/modify/","text":"upctl server network-interface modify Modify a network interface upctl server network-interface modify [flags] Examples upctl server network-interface modify 009d7f4e-99ce-4c78-88f1-e695d4c37743 --index 2 --new-index 1 Options 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 declared Usage: --ip-address address=94.237.112.143,family=IPv4 Default: [] --help , -h help for modify Default: false Global options Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human Related commands Command Description upctl server network-interface Manage network interface","title":"network-interface modify"},{"location":"commands_reference/upctl_server/network-interface/modify/#upctl-server-network-interface-modify","text":"Modify a network interface upctl server network-interface modify [flags]","title":"upctl server network-interface modify"},{"location":"commands_reference/upctl_server/network-interface/modify/#examples","text":"upctl server network-interface modify 009d7f4e-99ce-4c78-88f1-e695d4c37743 --index 2 --new-index 1","title":"Examples"},{"location":"commands_reference/upctl_server/network-interface/modify/#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 declared Usage: --ip-address address=94.237.112.143,family=IPv4 Default: [] --help , -h help for modify Default: false","title":"Options"},{"location":"commands_reference/upctl_server/network-interface/modify/#global-options","text":"Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human","title":"Global options"},{"location":"commands_reference/upctl_server/network-interface/modify/#related-commands","text":"Command Description upctl server network-interface Manage network interface","title":"Related commands"},{"location":"commands_reference/upctl_server/storage/","text":"upctl server storage Manage server storages upctl server storage [flags] Options Option Description --help , -h help for storage Default: false Global options Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human Related commands 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","title":"storage "},{"location":"commands_reference/upctl_server/storage/#upctl-server-storage","text":"Manage server storages upctl server storage [flags]","title":"upctl server storage"},{"location":"commands_reference/upctl_server/storage/#options","text":"Option Description --help , -h help for storage Default: false","title":"Options"},{"location":"commands_reference/upctl_server/storage/#global-options","text":"Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human","title":"Global options"},{"location":"commands_reference/upctl_server/storage/#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","title":"Related commands"},{"location":"commands_reference/upctl_server/storage/attach/","text":"upctl server storage attach Attach a storage as a device to a server upctl server storage attach [flags] Examples upctl server storage attach 00038afc-d526-4148-af0e-d2f1eeaded9b --storage 015899e0-0a68-4949-85bb-261a99de5fdd upctl server storage attach 00038afc-d526-4148-af0e-d2f1eeaded9b --storage 01a5568f-4766-4ce7-abf5-7d257903a735 --address virtio:2 upctl server storage attach my_server1 --storage \"My Storage\" Options Option Description --type Type of the attached storage. Available: disk, cdrom Default: 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 attach Default: false Global options Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human Related commands Command Description upctl server storage Manage server storages","title":"storage attach"},{"location":"commands_reference/upctl_server/storage/attach/#upctl-server-storage-attach","text":"Attach a storage as a device to a server upctl server storage attach [flags]","title":"upctl server storage attach"},{"location":"commands_reference/upctl_server/storage/attach/#examples","text":"upctl server storage attach 00038afc-d526-4148-af0e-d2f1eeaded9b --storage 015899e0-0a68-4949-85bb-261a99de5fdd upctl server storage attach 00038afc-d526-4148-af0e-d2f1eeaded9b --storage 01a5568f-4766-4ce7-abf5-7d257903a735 --address virtio:2 upctl server storage attach my_server1 --storage \"My Storage\"","title":"Examples"},{"location":"commands_reference/upctl_server/storage/attach/#options","text":"Option Description --type Type of the attached storage. Available: disk, cdrom Default: 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 attach Default: false","title":"Options"},{"location":"commands_reference/upctl_server/storage/attach/#global-options","text":"Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human","title":"Global options"},{"location":"commands_reference/upctl_server/storage/attach/#related-commands","text":"Command Description upctl server storage Manage server storages","title":"Related commands"},{"location":"commands_reference/upctl_server/storage/detach/","text":"upctl server storage detach Detaches a storage resource from a server upctl server storage detach [flags] Examples upctl server storage detach 00038afc-d526-4148-af0e-d2f1eeaded9b --address virtio:1 upctl server storage detach my_server1 --address virtio:2 Options Option Description --address Detach the storage attached to this address. --help , -h help for detach Default: false Global options Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human Related commands Command Description upctl server storage Manage server storages","title":"storage detach"},{"location":"commands_reference/upctl_server/storage/detach/#upctl-server-storage-detach","text":"Detaches a storage resource from a server upctl server storage detach [flags]","title":"upctl server storage detach"},{"location":"commands_reference/upctl_server/storage/detach/#examples","text":"upctl server storage detach 00038afc-d526-4148-af0e-d2f1eeaded9b --address virtio:1 upctl server storage detach my_server1 --address virtio:2","title":"Examples"},{"location":"commands_reference/upctl_server/storage/detach/#options","text":"Option Description --address Detach the storage attached to this address. --help , -h help for detach Default: false","title":"Options"},{"location":"commands_reference/upctl_server/storage/detach/#global-options","text":"Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human","title":"Global options"},{"location":"commands_reference/upctl_server/storage/detach/#related-commands","text":"Command Description upctl server storage Manage server storages","title":"Related commands"},{"location":"commands_reference/upctl_servergroup/","text":"upctl servergroup Manage server groups upctl servergroup [flags] Options Option Description --help , -h help for servergroup Default: false Global options Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human Related commands 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","title":"servergroup "},{"location":"commands_reference/upctl_servergroup/#upctl-servergroup","text":"Manage server groups upctl servergroup [flags]","title":"upctl servergroup"},{"location":"commands_reference/upctl_servergroup/#options","text":"Option Description --help , -h help for servergroup Default: false","title":"Options"},{"location":"commands_reference/upctl_servergroup/#global-options","text":"Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human","title":"Global options"},{"location":"commands_reference/upctl_servergroup/#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","title":"Related commands"},{"location":"commands_reference/upctl_servergroup/create/","text":"upctl servergroup create Create a server group upctl servergroup create [flags] Examples upctl servergroup create \\ --title my-server-group \\ --anti-affinity-policy yes \\ --server 1fdfda29-ead1-4855-b71f-a432179800ab \\ --server my-server upctl servergroup create \\ --title my-server-group \\ --anti-affinity-policy yes \\ --label env=dev upctl servergroup create \\ --title my-server-group \\ --anti-affinity-policy strict \\ --label env=dev \\ --label owner=operations Options 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=operations Default: [] --server Servers to be added to the server group, multiple can be declared. Usage: --server my-server --server 00333d1b-3a4a-4b75-820a-4a56d70395dd Default: [] --help , -h help for create Default: false Global options Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human Related commands Command Description upctl servergroup Manage server groups","title":"servergroup create"},{"location":"commands_reference/upctl_servergroup/create/#upctl-servergroup-create","text":"Create a server group upctl servergroup create [flags]","title":"upctl servergroup create"},{"location":"commands_reference/upctl_servergroup/create/#examples","text":"upctl servergroup create \\ --title my-server-group \\ --anti-affinity-policy yes \\ --server 1fdfda29-ead1-4855-b71f-a432179800ab \\ --server my-server upctl servergroup create \\ --title my-server-group \\ --anti-affinity-policy yes \\ --label env=dev upctl servergroup create \\ --title my-server-group \\ --anti-affinity-policy strict \\ --label env=dev \\ --label owner=operations","title":"Examples"},{"location":"commands_reference/upctl_servergroup/create/#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=operations Default: [] --server Servers to be added to the server group, multiple can be declared. Usage: --server my-server --server 00333d1b-3a4a-4b75-820a-4a56d70395dd Default: [] --help , -h help for create Default: false","title":"Options"},{"location":"commands_reference/upctl_servergroup/create/#global-options","text":"Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human","title":"Global options"},{"location":"commands_reference/upctl_servergroup/create/#related-commands","text":"Command Description upctl servergroup Manage server groups","title":"Related commands"},{"location":"commands_reference/upctl_servergroup/delete/","text":"upctl servergroup delete Delete a server group upctl servergroup delete [flags] Examples upctl servergroup delete 8abc8009-4325-4b23-4321-b1232cd81231 upctl servergroup delete my-server-group Options Option Description --help , -h help for delete Default: false Global options Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human Related commands Command Description upctl servergroup Manage server groups","title":"servergroup delete"},{"location":"commands_reference/upctl_servergroup/delete/#upctl-servergroup-delete","text":"Delete a server group upctl servergroup delete [flags]","title":"upctl servergroup delete"},{"location":"commands_reference/upctl_servergroup/delete/#examples","text":"upctl servergroup delete 8abc8009-4325-4b23-4321-b1232cd81231 upctl servergroup delete my-server-group","title":"Examples"},{"location":"commands_reference/upctl_servergroup/delete/#options","text":"Option Description --help , -h help for delete Default: false","title":"Options"},{"location":"commands_reference/upctl_servergroup/delete/#global-options","text":"Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human","title":"Global options"},{"location":"commands_reference/upctl_servergroup/delete/#related-commands","text":"Command Description upctl servergroup Manage server groups","title":"Related commands"},{"location":"commands_reference/upctl_servergroup/list/","text":"upctl servergroup list List current server groups upctl servergroup list [flags] Examples upctl servergroup list Options Option Description --help , -h help for list Default: false Global options Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human Related commands Command Description upctl servergroup Manage server groups","title":"servergroup list"},{"location":"commands_reference/upctl_servergroup/list/#upctl-servergroup-list","text":"List current server groups upctl servergroup list [flags]","title":"upctl servergroup list"},{"location":"commands_reference/upctl_servergroup/list/#examples","text":"upctl servergroup list","title":"Examples"},{"location":"commands_reference/upctl_servergroup/list/#options","text":"Option Description --help , -h help for list Default: false","title":"Options"},{"location":"commands_reference/upctl_servergroup/list/#global-options","text":"Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human","title":"Global options"},{"location":"commands_reference/upctl_servergroup/list/#related-commands","text":"Command Description upctl servergroup Manage server groups","title":"Related commands"},{"location":"commands_reference/upctl_servergroup/modify/","text":"upctl servergroup modify Modify a server group upctl servergroup modify [flags] Examples upctl servergroup modify 8abc8009-4325-4b23-4321-b1232cd81231 --title your-server-group upctl servergroup modify my-server-group --anti-affinity-policy strict upctl servergroup modify my-server-group --server my-server-1 --server my-server-2 --server my-server-3- upctl servergroup modify 8abc8009-4325-4b23-4321-b1232cd81231 --server 0bab98e5-b327-4ab8-ba16-738d4af7578b --server my-server-2 upctl servergroup modify my-server-group --label env=dev Options 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=operations Default: [] --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-4a56d70395dd Default: [] --help , -h help for modify Default: false Global options Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human Related commands Command Description upctl servergroup Manage server groups","title":"servergroup modify"},{"location":"commands_reference/upctl_servergroup/modify/#upctl-servergroup-modify","text":"Modify a server group upctl servergroup modify [flags]","title":"upctl servergroup modify"},{"location":"commands_reference/upctl_servergroup/modify/#examples","text":"upctl servergroup modify 8abc8009-4325-4b23-4321-b1232cd81231 --title your-server-group upctl servergroup modify my-server-group --anti-affinity-policy strict upctl servergroup modify my-server-group --server my-server-1 --server my-server-2 --server my-server-3- upctl servergroup modify 8abc8009-4325-4b23-4321-b1232cd81231 --server 0bab98e5-b327-4ab8-ba16-738d4af7578b --server my-server-2 upctl servergroup modify my-server-group --label env=dev","title":"Examples"},{"location":"commands_reference/upctl_servergroup/modify/#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=operations Default: [] --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-4a56d70395dd Default: [] --help , -h help for modify Default: false","title":"Options"},{"location":"commands_reference/upctl_servergroup/modify/#global-options","text":"Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human","title":"Global options"},{"location":"commands_reference/upctl_servergroup/modify/#related-commands","text":"Command Description upctl servergroup Manage server groups","title":"Related commands"},{"location":"commands_reference/upctl_servergroup/show/","text":"upctl servergroup show Show server group details upctl servergroup show [flags] Examples upctl servergroup show 8abc8009-4325-4b23-4321-b1232cd81231 upctl servergroup show my-server-group Options Option Description --help , -h help for show Default: false Global options Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human Related commands Command Description upctl servergroup Manage server groups","title":"servergroup show"},{"location":"commands_reference/upctl_servergroup/show/#upctl-servergroup-show","text":"Show server group details upctl servergroup show [flags]","title":"upctl servergroup show"},{"location":"commands_reference/upctl_servergroup/show/#examples","text":"upctl servergroup show 8abc8009-4325-4b23-4321-b1232cd81231 upctl servergroup show my-server-group","title":"Examples"},{"location":"commands_reference/upctl_servergroup/show/#options","text":"Option Description --help , -h help for show Default: false","title":"Options"},{"location":"commands_reference/upctl_servergroup/show/#global-options","text":"Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human","title":"Global options"},{"location":"commands_reference/upctl_servergroup/show/#related-commands","text":"Command Description upctl servergroup Manage server groups","title":"Related commands"},{"location":"commands_reference/upctl_storage/","text":"upctl storage Manage storages upctl storage [flags] Options Option Description --help , -h help for storage Default: false Global options Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human Related commands 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","title":"storage "},{"location":"commands_reference/upctl_storage/#upctl-storage","text":"Manage storages upctl storage [flags]","title":"upctl storage"},{"location":"commands_reference/upctl_storage/#options","text":"Option Description --help , -h help for storage Default: false","title":"Options"},{"location":"commands_reference/upctl_storage/#global-options","text":"Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human","title":"Global options"},{"location":"commands_reference/upctl_storage/#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","title":"Related commands"},{"location":"commands_reference/upctl_storage/clone/","text":"upctl storage clone Clone a storage upctl storage clone [flags] Examples upctl storage clone 015899e0-0a68-4949-85bb-261a99de5fdd --title my_storage_clone --zone fi-hel1 upctl storage clone 015899e0-0a68-4949-85bb-261a99de5fdd --title my_storage_clone2 --zone pl-waw1 --tier maxiops upctl storage clone \"My Storage\" --title my_storage_clone3 --zone pl-waw1 --tier maxiops Options 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. --help , -h help for clone Default: false Global options Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human Related commands Command Description upctl storage Manage storages","title":"storage clone"},{"location":"commands_reference/upctl_storage/clone/#upctl-storage-clone","text":"Clone a storage upctl storage clone [flags]","title":"upctl storage clone"},{"location":"commands_reference/upctl_storage/clone/#examples","text":"upctl storage clone 015899e0-0a68-4949-85bb-261a99de5fdd --title my_storage_clone --zone fi-hel1 upctl storage clone 015899e0-0a68-4949-85bb-261a99de5fdd --title my_storage_clone2 --zone pl-waw1 --tier maxiops upctl storage clone \"My Storage\" --title my_storage_clone3 --zone pl-waw1 --tier maxiops","title":"Examples"},{"location":"commands_reference/upctl_storage/clone/#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. --help , -h help for clone Default: false","title":"Options"},{"location":"commands_reference/upctl_storage/clone/#global-options","text":"Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human","title":"Global options"},{"location":"commands_reference/upctl_storage/clone/#related-commands","text":"Command Description upctl storage Manage storages","title":"Related commands"},{"location":"commands_reference/upctl_storage/create/","text":"upctl storage create Create a storage upctl storage create [flags] Examples upctl storage create --zone pl-waw1 --title \"My Storage\" upctl storage create --zone pl-waw1 --title my_storage --size 20 --backup-interval wed --backup-retention 4 Options 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 --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 Default: daily --backup-retention How long to store the backups in days. The accepted range is 1-1095 Default: 7 --help , -h help for create Default: false Global options Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human Related commands Command Description upctl storage Manage storages","title":"storage create"},{"location":"commands_reference/upctl_storage/create/#upctl-storage-create","text":"Create a storage upctl storage create [flags]","title":"upctl storage create"},{"location":"commands_reference/upctl_storage/create/#examples","text":"upctl storage create --zone pl-waw1 --title \"My Storage\" upctl storage create --zone pl-waw1 --title my_storage --size 20 --backup-interval wed --backup-retention 4","title":"Examples"},{"location":"commands_reference/upctl_storage/create/#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 --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 Default: daily --backup-retention How long to store the backups in days. The accepted range is 1-1095 Default: 7 --help , -h help for create Default: false","title":"Options"},{"location":"commands_reference/upctl_storage/create/#global-options","text":"Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human","title":"Global options"},{"location":"commands_reference/upctl_storage/create/#related-commands","text":"Command Description upctl storage Manage storages","title":"Related commands"},{"location":"commands_reference/upctl_storage/delete/","text":"upctl storage delete Delete a storage upctl storage delete [flags] Examples upctl storage delete 01ac5319-08ac-4e7b-81e5-3140d2bbd7d8 upctl storage delete 0175bb34-8aed-47ce-9290-10cc45f78601 01fcb78f-e73d-4e4d-af5a-0bd6cdba4306 upctl storage delete \"My Storage\" Options Option Description --help , -h help for delete Default: false Global options Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human Related commands Command Description upctl storage Manage storages","title":"storage delete"},{"location":"commands_reference/upctl_storage/delete/#upctl-storage-delete","text":"Delete a storage upctl storage delete [flags]","title":"upctl storage delete"},{"location":"commands_reference/upctl_storage/delete/#examples","text":"upctl storage delete 01ac5319-08ac-4e7b-81e5-3140d2bbd7d8 upctl storage delete 0175bb34-8aed-47ce-9290-10cc45f78601 01fcb78f-e73d-4e4d-af5a-0bd6cdba4306 upctl storage delete \"My Storage\"","title":"Examples"},{"location":"commands_reference/upctl_storage/delete/#options","text":"Option Description --help , -h help for delete Default: false","title":"Options"},{"location":"commands_reference/upctl_storage/delete/#global-options","text":"Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human","title":"Global options"},{"location":"commands_reference/upctl_storage/delete/#related-commands","text":"Command Description upctl storage Manage storages","title":"Related commands"},{"location":"commands_reference/upctl_storage/import/","text":"upctl storage import Import a storage from external or local source upctl storage import [flags] Examples 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 Options 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 --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 Default: daily --backup-retention How long to store the backups in days. The accepted range is 1-1095 Default: 7 --help , -h help for import Default: false Global options Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human Related commands Command Description upctl storage Manage storages","title":"storage import"},{"location":"commands_reference/upctl_storage/import/#upctl-storage-import","text":"Import a storage from external or local source upctl storage import [flags]","title":"upctl storage import"},{"location":"commands_reference/upctl_storage/import/#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","title":"Examples"},{"location":"commands_reference/upctl_storage/import/#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 --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 Default: daily --backup-retention How long to store the backups in days. The accepted range is 1-1095 Default: 7 --help , -h help for import Default: false","title":"Options"},{"location":"commands_reference/upctl_storage/import/#global-options","text":"Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human","title":"Global options"},{"location":"commands_reference/upctl_storage/import/#related-commands","text":"Command Description upctl storage Manage storages","title":"Related commands"},{"location":"commands_reference/upctl_storage/list/","text":"upctl storage list List current storages upctl storage list [flags] Examples upctl storage list upctl storage list --all Options 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 list Default: false Global options Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human Related commands Command Description upctl storage Manage storages","title":"storage list"},{"location":"commands_reference/upctl_storage/list/#upctl-storage-list","text":"List current storages upctl storage list [flags]","title":"upctl storage list"},{"location":"commands_reference/upctl_storage/list/#examples","text":"upctl storage list upctl storage list --all","title":"Examples"},{"location":"commands_reference/upctl_storage/list/#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 list Default: false","title":"Options"},{"location":"commands_reference/upctl_storage/list/#global-options","text":"Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human","title":"Global options"},{"location":"commands_reference/upctl_storage/list/#related-commands","text":"Command Description upctl storage Manage storages","title":"Related commands"},{"location":"commands_reference/upctl_storage/modify/","text":"upctl storage modify Modify a storage upctl storage modify [flags] Examples upctl storage modify 01271548-2e92-44bb-9774-d282508cc762 --title \"My Storage\" --size 20 upctl storage modify \"My Storage\" --size 25 Options 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 incure costs.. --help , -h help for modify Default: false Global options Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human Related commands Command Description upctl storage Manage storages","title":"storage modify"},{"location":"commands_reference/upctl_storage/modify/#upctl-storage-modify","text":"Modify a storage upctl storage modify [flags]","title":"upctl storage modify"},{"location":"commands_reference/upctl_storage/modify/#examples","text":"upctl storage modify 01271548-2e92-44bb-9774-d282508cc762 --title \"My Storage\" --size 20 upctl storage modify \"My Storage\" --size 25","title":"Examples"},{"location":"commands_reference/upctl_storage/modify/#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 incure costs.. --help , -h help for modify Default: false","title":"Options"},{"location":"commands_reference/upctl_storage/modify/#global-options","text":"Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human","title":"Global options"},{"location":"commands_reference/upctl_storage/modify/#related-commands","text":"Command Description upctl storage Manage storages","title":"Related commands"},{"location":"commands_reference/upctl_storage/show/","text":"upctl storage show Show storage details upctl storage show [flags] Examples upctl storage show 01271548-2e92-44bb-9774-d282508cc762 upctl storage show 01271548-2e92-44bb-9774-d282508cc762 01c60190-3a01-4108-b1c3-2e828855ccc0 upctl storage show \"My Storage\" Options Option Description --help , -h help for show Default: false Global options Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human Related commands Command Description upctl storage Manage storages","title":"storage show"},{"location":"commands_reference/upctl_storage/show/#upctl-storage-show","text":"Show storage details upctl storage show [flags]","title":"upctl storage show"},{"location":"commands_reference/upctl_storage/show/#examples","text":"upctl storage show 01271548-2e92-44bb-9774-d282508cc762 upctl storage show 01271548-2e92-44bb-9774-d282508cc762 01c60190-3a01-4108-b1c3-2e828855ccc0 upctl storage show \"My Storage\"","title":"Examples"},{"location":"commands_reference/upctl_storage/show/#options","text":"Option Description --help , -h help for show Default: false","title":"Options"},{"location":"commands_reference/upctl_storage/show/#global-options","text":"Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human","title":"Global options"},{"location":"commands_reference/upctl_storage/show/#related-commands","text":"Command Description upctl storage Manage storages","title":"Related commands"},{"location":"commands_reference/upctl_storage/templatise/","text":"upctl storage templatise Templatise a storage upctl storage templatise [flags] Examples upctl storage templatise 01271548-2e92-44bb-9774-d282508cc762 --title \"My Template\" upctl storage templatise 01271548-2e92-44bb-9774-d282508cc762 --title \"My Template\" --wait upctl storage templatise \"My Storage\" --title super_template Options Option Description --title A short, informational description. --wait Wait for storage to be in online state before returning. --help , -h help for templatise Default: false Global options Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human Related commands Command Description upctl storage Manage storages","title":"storage templatise"},{"location":"commands_reference/upctl_storage/templatise/#upctl-storage-templatise","text":"Templatise a storage upctl storage templatise [flags]","title":"upctl storage templatise"},{"location":"commands_reference/upctl_storage/templatise/#examples","text":"upctl storage templatise 01271548-2e92-44bb-9774-d282508cc762 --title \"My Template\" upctl storage templatise 01271548-2e92-44bb-9774-d282508cc762 --title \"My Template\" --wait upctl storage templatise \"My Storage\" --title super_template","title":"Examples"},{"location":"commands_reference/upctl_storage/templatise/#options","text":"Option Description --title A short, informational description. --wait Wait for storage to be in online state before returning. --help , -h help for templatise Default: false","title":"Options"},{"location":"commands_reference/upctl_storage/templatise/#global-options","text":"Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human","title":"Global options"},{"location":"commands_reference/upctl_storage/templatise/#related-commands","text":"Command Description upctl storage Manage storages","title":"Related commands"},{"location":"commands_reference/upctl_storage/backup/","text":"upctl storage backup Manage backups upctl storage backup [flags] Options Option Description --help , -h help for backup Default: false Global options Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human Related commands Command Description upctl storage Manage storages upctl storage backup create Create backup of a storage upctl storage backup restore Restore backup of a storage","title":"backup "},{"location":"commands_reference/upctl_storage/backup/#upctl-storage-backup","text":"Manage backups upctl storage backup [flags]","title":"upctl storage backup"},{"location":"commands_reference/upctl_storage/backup/#options","text":"Option Description --help , -h help for backup Default: false","title":"Options"},{"location":"commands_reference/upctl_storage/backup/#global-options","text":"Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human","title":"Global options"},{"location":"commands_reference/upctl_storage/backup/#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","title":"Related commands"},{"location":"commands_reference/upctl_storage/backup/create/","text":"upctl storage backup create Create backup of a storage upctl storage backup create [flags] Examples upctl storage backup create 01cbea5e-eb5b-4072-b2ac-9b635120e5d8 --title \"first backup\" upctl storage backup create \"My Storage\" --title second_backup Options Option Description --title A short, informational description. --help , -h help for create Default: false Global options Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human Related commands Command Description upctl storage backup Manage backups","title":"backup create"},{"location":"commands_reference/upctl_storage/backup/create/#upctl-storage-backup-create","text":"Create backup of a storage upctl storage backup create [flags]","title":"upctl storage backup create"},{"location":"commands_reference/upctl_storage/backup/create/#examples","text":"upctl storage backup create 01cbea5e-eb5b-4072-b2ac-9b635120e5d8 --title \"first backup\" upctl storage backup create \"My Storage\" --title second_backup","title":"Examples"},{"location":"commands_reference/upctl_storage/backup/create/#options","text":"Option Description --title A short, informational description. --help , -h help for create Default: false","title":"Options"},{"location":"commands_reference/upctl_storage/backup/create/#global-options","text":"Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human","title":"Global options"},{"location":"commands_reference/upctl_storage/backup/create/#related-commands","text":"Command Description upctl storage backup Manage backups","title":"Related commands"},{"location":"commands_reference/upctl_storage/backup/restore/","text":"upctl storage backup restore Restore backup of a storage upctl storage backup restore [flags] Examples upctl storage backup restore 01177c9e-7f76-4ce4-b128-bcaa3448f7ec upctl storage backup restore second_backup Options Option Description --help , -h help for restore Default: false Global options Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human Related commands Command Description upctl storage backup Manage backups","title":"backup restore"},{"location":"commands_reference/upctl_storage/backup/restore/#upctl-storage-backup-restore","text":"Restore backup of a storage upctl storage backup restore [flags]","title":"upctl storage backup restore"},{"location":"commands_reference/upctl_storage/backup/restore/#examples","text":"upctl storage backup restore 01177c9e-7f76-4ce4-b128-bcaa3448f7ec upctl storage backup restore second_backup","title":"Examples"},{"location":"commands_reference/upctl_storage/backup/restore/#options","text":"Option Description --help , -h help for restore Default: false","title":"Options"},{"location":"commands_reference/upctl_storage/backup/restore/#global-options","text":"Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human","title":"Global options"},{"location":"commands_reference/upctl_storage/backup/restore/#related-commands","text":"Command Description upctl storage backup Manage backups","title":"Related commands"},{"location":"commands_reference/upctl_zone/","text":"upctl zone Display zone information upctl zone [flags] Options Option Description --help , -h help for zone Default: false Global options Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human Related commands Command Description upctl UpCloud command-line interface upctl zone list List available zones","title":"zone "},{"location":"commands_reference/upctl_zone/#upctl-zone","text":"Display zone information upctl zone [flags]","title":"upctl zone"},{"location":"commands_reference/upctl_zone/#options","text":"Option Description --help , -h help for zone Default: false","title":"Options"},{"location":"commands_reference/upctl_zone/#global-options","text":"Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human","title":"Global options"},{"location":"commands_reference/upctl_zone/#related-commands","text":"Command Description upctl UpCloud command-line interface upctl zone list List available zones","title":"Related commands"},{"location":"commands_reference/upctl_zone/list/","text":"upctl zone list List available zones upctl zone list [flags] Examples upctl zone list Options Option Description --help , -h help for list Default: false Global options Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human Related commands Command Description upctl zone Display zone information","title":"zone list"},{"location":"commands_reference/upctl_zone/list/#upctl-zone-list","text":"List available zones upctl zone list [flags]","title":"upctl zone list"},{"location":"commands_reference/upctl_zone/list/#examples","text":"upctl zone list","title":"Examples"},{"location":"commands_reference/upctl_zone/list/#options","text":"Option Description --help , -h help for list Default: false","title":"Options"},{"location":"commands_reference/upctl_zone/list/#global-options","text":"Option Description --client-timeout , -t Client timeout to use in API calls. Default: 0s --config Configuration file path. --debug Print out more verbose debug logs. Default: false --force-colours Force coloured output despite detected terminal support. --no-colours Disable coloured output despite detected terminal support. Colours can also be disabled by setting NO_COLOR environment variable. --output , -o Output format (supported: json, yaml and human) Default: human","title":"Global options"},{"location":"commands_reference/upctl_zone/list/#related-commands","text":"Command Description upctl zone Display zone information","title":"Related commands"},{"location":"examples/","text":"Examples 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.","title":"Examples"},{"location":"examples/#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.","title":"Examples"},{"location":"examples/create_a_custom_template/","text":"Create a custom template 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- First, we will create server which disk will be used as a source for the custom template. # Create ssh-key into current working directory ssh-keygen -t ed25519 -q -f \"./id_ed25519\" -N \"\" upctl server create \\ --hostname ${ prefix } source-server \\ --zone pl-waw1 \\ --ssh-keys ./id_ed25519.pub \\ --network type = public \\ --network type = utility \\ --wait 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 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 \\ | jq -r \".storage[0].uuid\" Now we are ready for creating the template. upctl storage templatise ${ prefix } source-server-OS \\ --title ${ prefix } template \\ --wait Once the template is created, we can delete the source server upctl server delete ${ prefix } source-server --delete-storages To test that the template creation succeeded, create a new server from the just created template. upctl server create \\ --hostname ${ prefix } server \\ --zone pl-waw1 \\ --network type = public \\ --network type = utility \\ --os ${ prefix } template \\ --wait Finally, we can cleanup the created resources. upctl server stop --type hard --wait ${ prefix } server upctl server delete ${ prefix } server --delete-storages upctl storage delete ${ prefix } template","title":"Create a custom template"},{"location":"examples/create_a_custom_template/#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- First, we will create server which disk will be used as a source for the custom template. # Create ssh-key into current working directory ssh-keygen -t ed25519 -q -f \"./id_ed25519\" -N \"\" upctl server create \\ --hostname ${ prefix } source-server \\ --zone pl-waw1 \\ --ssh-keys ./id_ed25519.pub \\ --network type = public \\ --network type = utility \\ --wait 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 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 \\ | jq -r \".storage[0].uuid\" Now we are ready for creating the template. upctl storage templatise ${ prefix } source-server-OS \\ --title ${ prefix } template \\ --wait Once the template is created, we can delete the source server upctl server delete ${ prefix } source-server --delete-storages To test that the template creation succeeded, create a new server from the just created template. upctl server create \\ --hostname ${ prefix } server \\ --zone pl-waw1 \\ --network type = public \\ --network type = utility \\ --os ${ prefix } template \\ --wait Finally, we can cleanup the created resources. upctl server stop --type hard --wait ${ prefix } server upctl server delete ${ prefix } server --delete-storages upctl storage delete ${ prefix } template","title":"Create a custom template"},{"location":"examples/create_and_ssh_into_a_server/","text":"Create and ssh into a server 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- 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 ssh-keygen -t ed25519 -q -f \"./id_ed25519\" -N \"\" Create a server using the above created ssh-key as login method. upctl server create \\ --hostname ${ prefix } server \\ --zone pl-waw1 \\ --ssh-keys ./id_ed25519.pub \\ --network type = public \\ --network type = utility \\ --wait 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 ip = $( upctl server show ${ prefix } server -o json | jq -r '.networking.interfaces[] | select(.type == \"public\") | .ip_addresses[0].address' ) # Wait for a moment for the ssh server to become available sleep 15 ssh -i id_ed25519 -o StrictHostKeyChecking = accept-new root@ $ip \"hostname\" Finally, we can cleanup the created resources. upctl server stop --type hard --wait ${ prefix } server upctl server delete ${ prefix } server --delete-storages","title":"Create and ssh into a server"},{"location":"examples/create_and_ssh_into_a_server/#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- 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 ssh-keygen -t ed25519 -q -f \"./id_ed25519\" -N \"\" Create a server using the above created ssh-key as login method. upctl server create \\ --hostname ${ prefix } server \\ --zone pl-waw1 \\ --ssh-keys ./id_ed25519.pub \\ --network type = public \\ --network type = utility \\ --wait 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 ip = $( upctl server show ${ prefix } server -o json | jq -r '.networking.interfaces[] | select(.type == \"public\") | .ip_addresses[0].address' ) # Wait for a moment for the ssh server to become available sleep 15 ssh -i id_ed25519 -o StrictHostKeyChecking = accept-new root@ $ip \"hostname\" Finally, we can cleanup the created resources. upctl server stop --type hard --wait ${ prefix } server upctl server delete ${ prefix } server --delete-storages","title":"Create and ssh into a server"},{"location":"examples/possible_exit_codes/","text":"Possible exit codes 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- Exit code 100 is set, for example, when command argument validation fails. upctl server create # Error: required flag(s) \"hostname\", \"zone\" not set Let's create two server and stop one of those to later see other failing exit codes. These command should succceed, and thus return zero exit code. # Create ssh-key into current working directory ssh-keygen -t ed25519 -q -f \"./id_ed25519\" -N \"\" upctl server create --hostname ${ prefix } vm-1 --zone pl-waw1 --ssh-keys ./id_ed25519.pub --wait upctl server create --hostname ${ prefix } vm-2 --zone pl-waw1 --ssh-keys ./id_ed25519.pub --wait upctl server stop ${ prefix } vm-1 --wait 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 ${ prefix } vm-1 ${ prefix } vm-2 --wait 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 ${ prefix } vm-1 ${ prefix } vm-2 --wait Finally, we can cleanup the created resources. upctl server delete ${ prefix } vm-1 ${ prefix } vm-2 --delete-storages","title":"Possible exit codes"},{"location":"examples/possible_exit_codes/#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- Exit code 100 is set, for example, when command argument validation fails. upctl server create # Error: required flag(s) \"hostname\", \"zone\" not set Let's create two server and stop one of those to later see other failing exit codes. These command should succceed, and thus return zero exit code. # Create ssh-key into current working directory ssh-keygen -t ed25519 -q -f \"./id_ed25519\" -N \"\" upctl server create --hostname ${ prefix } vm-1 --zone pl-waw1 --ssh-keys ./id_ed25519.pub --wait upctl server create --hostname ${ prefix } vm-2 --zone pl-waw1 --ssh-keys ./id_ed25519.pub --wait upctl server stop ${ prefix } vm-1 --wait 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 ${ prefix } vm-1 ${ prefix } vm-2 --wait 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 ${ prefix } vm-1 ${ prefix } vm-2 --wait Finally, we can cleanup the created resources. upctl server delete ${ prefix } vm-1 ${ prefix } vm-2 --delete-storages","title":"Possible exit codes"}]} \ No newline at end of file diff --git a/sitemap.xml b/sitemap.xml index bbabb4a0f..f7d97d003 100644 --- a/sitemap.xml +++ b/sitemap.xml @@ -565,4 +565,24 @@ 2023-11-27 daily + + https://upcloudltd.github.io/upcloud-cli/examples/ + 2023-11-27 + daily + + + https://upcloudltd.github.io/upcloud-cli/examples/create_a_custom_template/ + 2023-11-27 + daily + + + https://upcloudltd.github.io/upcloud-cli/examples/create_and_ssh_into_a_server/ + 2023-11-27 + daily + + + https://upcloudltd.github.io/upcloud-cli/examples/possible_exit_codes/ + 2023-11-27 + daily + \ No newline at end of file diff --git a/sitemap.xml.gz b/sitemap.xml.gz index dda0a70a8..ab37dd257 100644 Binary files a/sitemap.xml.gz and b/sitemap.xml.gz differ