From 25cf95831939f09e589615f7a0248a380d173aa4 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?R=C3=A9my=20L=C3=A9one?= Date: Tue, 15 Sep 2020 10:42:57 +0200 Subject: [PATCH] docs: update generated documentation --- docs/commands/account.md | 38 +- docs/commands/baremetal.md | 93 +++- docs/commands/config.md | 20 + docs/commands/help.md | 214 ++++++++ docs/commands/instance.md | 207 ++++++-- docs/commands/iot.md | 477 ++++++++++++++++++ docs/commands/k8s.md | 20 +- docs/commands/lb.md | 967 +++++++++++++++++++++++++++++++++++++ docs/commands/rdb.md | 224 +++++---- docs/commands/registry.md | 9 +- docs/commands/vpc.md | 132 +++++ 11 files changed, 2235 insertions(+), 166 deletions(-) create mode 100644 docs/commands/help.md create mode 100644 docs/commands/iot.md create mode 100644 docs/commands/lb.md create mode 100644 docs/commands/vpc.md diff --git a/docs/commands/account.md b/docs/commands/account.md index 6fd838893a..0b1c15379c 100644 --- a/docs/commands/account.md +++ b/docs/commands/account.md @@ -3,12 +3,12 @@ Account API - [SSH keys management commands](#ssh-keys-management-commands) - - [Add a SSH key to your organization](#add-a-ssh-key-to-your-organization) - - [Get a SSH key from your organization](#get-a-ssh-key-from-your-organization) + - [Add an SSH key to your project](#add-an-ssh-key-to-your-project) + - [Get an SSH key from your project](#get-an-ssh-key-from-your-project) - [Initialize SSH key](#initialize-ssh-key) - - [List all SSH keys of your organization](#list-all-ssh-keys-of-your-organization) - - [Remove a SSH key from your organization](#remove-a-ssh-key-from-your-organization) - - [Update a SSH key on your organization](#update-a-ssh-key-on-your-organization) + - [List all SSH keys of your project](#list-all-ssh-keys-of-your-project) + - [Remove an SSH key from your project](#remove-an-ssh-key-from-your-project) + - [Update an SSH key on your project](#update-an-ssh-key-on-your-project) ## SSH keys management commands @@ -16,9 +16,9 @@ Account API SSH keys management commands. -### Add a SSH key to your organization +### Add an SSH key to your project -Add a SSH key to your organization. +Add an SSH key to your project. **Usage:** @@ -33,8 +33,8 @@ scw account ssh-key add [arg=value ...] |------|---|-------------| | name | | The name of the SSH key | | public-key | Required | SSH public key. Currently ssh-rsa, ssh-dss (DSA), ssh-ed25519 and ecdsa keys with NIST curves are supported | -| project-id | | Project owning the resource | -| organization-id | | Organization ID to use. If none is passed will use default organization ID from the config | +| project-id | | Project ID to use. If none is passed the default project ID will be used | +| organization-id | | Organization ID to use. If none is passed the default organization ID will be used | **Examples:** @@ -42,15 +42,15 @@ scw account ssh-key add [arg=value ...] Add a given ssh key ``` -scw account ssh-key add name=foobar public_key="$(cat )" +scw account ssh-key add name=foobar public-key="$(cat )" ``` -### Get a SSH key from your organization +### Get an SSH key from your project -Get a SSH key from your organization. +Get an SSH key from your project. **Usage:** @@ -79,9 +79,9 @@ scw account ssh-key init -### List all SSH keys of your organization +### List all SSH keys of your project -List all SSH keys of your organization. +List all SSH keys of your project. **Usage:** @@ -101,9 +101,9 @@ scw account ssh-key list [arg=value ...] -### Remove a SSH key from your organization +### Remove an SSH key from your project -Remove a SSH key from your organization. +Remove an SSH key from your project. **Usage:** @@ -130,9 +130,9 @@ scw account ssh-key remove 11111111-1111-1111-1111-111111111111 -### Update a SSH key on your organization +### Update an SSH key on your project -Update a SSH key on your organization. +Update an SSH key on your project. **Usage:** @@ -146,7 +146,7 @@ scw account ssh-key update [arg=value ...] | Name | | Description | |------|---|-------------| | ssh-key-id | Required | | -| name | | | +| name | | Name of the SSH key | diff --git a/docs/commands/baremetal.md b/docs/commands/baremetal.md index a6bb7f6256..c77abde3af 100644 --- a/docs/commands/baremetal.md +++ b/docs/commands/baremetal.md @@ -2,6 +2,10 @@ # Documentation for `scw baremetal` Baremetal API +- [Baseboard Management Controller (BMC) management commands](#baseboard-management-controller-(bmc)-management-commands) + - [Get BMC (Baseboard Management Controller) access for a given baremetal server](#get-bmc-(baseboard-management-controller)-access-for-a-given-baremetal-server) + - [Start BMC (Baseboard Management Controller) access for a given baremetal server](#start-bmc-(baseboard-management-controller)-access-for-a-given-baremetal-server) + - [Stop BMC (Baseboard Management Controller) access for a given baremetal server](#stop-bmc-(baseboard-management-controller)-access-for-a-given-baremetal-server) - [Operating System (OS) management commands](#operating-system-(os)-management-commands) - [Get an OS with a given ID](#get-an-os-with-a-given-id) - [List all available OS that can be install on a baremetal server](#list-all-available-os-that-can-be-install-on-a-baremetal-server) @@ -10,7 +14,7 @@ Baremetal API - [Delete a baremetal server](#delete-a-baremetal-server) - [Get a specific baremetal server](#get-a-specific-baremetal-server) - [Install a baremetal server](#install-a-baremetal-server) - - [List baremetal servers](#list-baremetal-servers) + - [List baremetal servers for organization](#list-baremetal-servers-for-organization) - [Reboot a baremetal server](#reboot-a-baremetal-server) - [Start a baremetal server](#start-a-baremetal-server) - [Stop a baremetal server](#stop-a-baremetal-server) @@ -18,6 +22,76 @@ Baremetal API - [Wait for a server to reach a stable state (delivery and installation)](#wait-for-a-server-to-reach-a-stable-state-(delivery-and-installation)) +## Baseboard Management Controller (BMC) management commands + +Baseboard Management Controller (BMC) allows you to remotely access the low-level parameters of your dedicated server. +For instance, your KVM-IP management console could be accessed with it. + + + +### Get BMC (Baseboard Management Controller) access for a given baremetal server + +Get the BMC (Baseboard Management Controller) access associated with the given ID. + +**Usage:** + +``` +scw baremetal bmc get [arg=value ...] +``` + + +**Args:** + +| Name | | Description | +|------|---|-------------| +| server-id | Required | ID of the server | +| zone | Default: `fr-par-1`
One of: `fr-par-2` | Zone to target. If none is passed will use default zone from the config | + + + +### Start BMC (Baseboard Management Controller) access for a given baremetal server + +Start BMC (Baseboard Management Controller) access associated with the given ID. +The BMC (Baseboard Management Controller) access is available one hour after the installation of the server. + + +**Usage:** + +``` +scw baremetal bmc start [arg=value ...] +``` + + +**Args:** + +| Name | | Description | +|------|---|-------------| +| server-id | Required | ID of the server | +| ip | Required | The IP authorized to connect to the given server | +| zone | Default: `fr-par-1`
One of: `fr-par-2` | Zone to target. If none is passed will use default zone from the config | + + + +### Stop BMC (Baseboard Management Controller) access for a given baremetal server + +Stop BMC (Baseboard Management Controller) access associated with the given ID. + +**Usage:** + +``` +scw baremetal bmc stop [arg=value ...] +``` + + +**Args:** + +| Name | | Description | +|------|---|-------------| +| server-id | Required | ID of the server | +| zone | Default: `fr-par-1`
One of: `fr-par-2` | Zone to target. If none is passed will use default zone from the config | + + + ## Operating System (OS) management commands An Operating System (OS) is the underlying software installed on your server @@ -93,11 +167,15 @@ scw baremetal server create [arg=value ...] | Name | | Description | |------|---|-------------| +| project-id | | Project ID to use. If none is passed the default project ID will be used | | name | Required
Default: `` | Name of the server (≠hostname) | | description | | Description associated to the server, max 255 characters | | type | Default: `GP-BM1-S`
One of: `GP-BM1-L`, `GP-BM1-M`, `GP-BM1-S`, `HC-BM1-L`, `HC-BM1-S`, `HM-BM1-XL`, `HM-BM1-M` | Server commercial type | | tags.{index} | | Tags to associate to the server | -| organization-id | | Organization ID to use. If none is passed will use default organization ID from the config | +| install.os-id | | | +| install.hostname | | | +| install.ssh-key-ids.{index} | | | +| organization-id | | Organization ID to use. If none is passed the default organization ID will be used | | zone | Default: `fr-par-1`
One of: `fr-par-2` | Zone to target. If none is passed will use default zone from the config | @@ -211,9 +289,9 @@ scw baremetal server install 11111111-1111-1111-1111-111111111111 os-id=11111111 -### List baremetal servers +### List baremetal servers for organization -List baremetal servers. +List baremetal servers for organization. **Usage:** @@ -230,6 +308,7 @@ scw baremetal server list [arg=value ...] | tags.{index} | | Filter servers by tags | | status.{index} | | Filter servers by status | | name | | Filter servers by name | +| project-id | | Filter servers by project ID | | organization-id | | Filter servers by organization ID | | zone | Default: `fr-par-1`
One of: `fr-par-2` | Zone to target. If none is passed will use default zone from the config | @@ -297,6 +376,7 @@ scw baremetal server start [arg=value ...] | Name | | Description | |------|---|-------------| | server-id | Required | ID of the server to start | +| boot-type | One of: `unknown_boot_type`, `normal`, `rescue` | The type of boot | | zone | Default: `fr-par-1`
One of: `fr-par-2` | Zone to target. If none is passed will use default zone from the config | @@ -308,6 +388,11 @@ Start a baremetal server scw baremetal server start 11111111-1111-1111-1111-111111111111 ``` +Start a server in rescue mode +``` +scw baremetal server start 11111111-1111-1111-1111-111111111111 boot-type=rescue +``` + diff --git a/docs/commands/config.md b/docs/commands/config.md index b840a0211c..dabce66615 100644 --- a/docs/commands/config.md +++ b/docs/commands/config.md @@ -24,6 +24,7 @@ Read more about the config management engine at https://github.com/scaleway/scal - [Dump the config file](#dump-the-config-file) - [Get a value from the config file](#get-a-value-from-the-config-file) - [Allows the deletion of a profile from the config file](#allows-the-deletion-of-a-profile-from-the-config-file) + - [Mark a profile as active in the config file](#mark-a-profile-as-active-in-the-config-file) - [Delete a profile from the config file](#delete-a-profile-from-the-config-file) - [Reset the config](#reset-the-config) - [Set a line from the config file](#set-a-line-from-the-config-file) @@ -85,6 +86,25 @@ scw -p prod config get default_region +### Mark a profile as active in the config file + + + +**Usage:** + +``` +scw config profile activate [arg=value ...] +``` + + +**Args:** + +| Name | | Description | +|------|---|-------------| +| profile-name | Required | | + + + ### Delete a profile from the config file diff --git a/docs/commands/help.md b/docs/commands/help.md new file mode 100644 index 0000000000..ff33168e63 --- /dev/null +++ b/docs/commands/help.md @@ -0,0 +1,214 @@ + +# Documentation for `scw help` +Get help about how the CLI works + +- [Get help about how date parsing works in the CLI](#get-help-about-how-date-parsing-works-in-the-cli) +- [Get help about how the CLI output works](#get-help-about-how-the-cli-output-works) + + +## Get help about how date parsing works in the CLI + +Date parsing + +You have two ways for managing date in the CLI: Absolute and Relative + +- Absolute time + + Absolute time refers to a specific and absolute point in time. + CLI uses RFC3339 to parse those time and pass a time.Time go structure to the underlying functions. + + Example: "2006-01-02T15:04:05Z07:00" + +- Relative time + + Relative time refers to a time calculated from adding a given duration to the time when a command is launched. + + Example: + - +1d4m => current time plus 1 day and 4 minutes + - -1d4m => current time minus 1 day and 4 minutes + +- Units of time + + Nanosecond: ns + Microsecond: us, µs (U+00B5 = micro symbol), μs (U+03BC = Greek letter mu) + Millisecond: ms + Second: s, sec, second, seconds + Minute: m, min, minute, minutes + Hour: h, hr, hour, hours + Day: d, day, days + Week: w, wk, week, weeks + Month: mo, mon, month, months + Year: y, yr, year, years + + +Date parsing + +You have two ways for managing date in the CLI: Absolute and Relative + +- Absolute time + + Absolute time refers to a specific and absolute point in time. + CLI uses RFC3339 to parse those time and pass a time.Time go structure to the underlying functions. + + Example: "2006-01-02T15:04:05Z07:00" + +- Relative time + + Relative time refers to a time calculated from adding a given duration to the time when a command is launched. + + Example: + - +1d4m => current time plus 1 day and 4 minutes + - -1d4m => current time minus 1 day and 4 minutes + +- Units of time + + Nanosecond: ns + Microsecond: us, µs (U+00B5 = micro symbol), μs (U+03BC = Greek letter mu) + Millisecond: ms + Second: s, sec, second, seconds + Minute: m, min, minute, minutes + Hour: h, hr, hour, hours + Day: d, day, days + Week: w, wk, week, weeks + Month: mo, mon, month, months + Year: y, yr, year, years + + +**Usage:** + +``` +scw help date +``` + + + +## Get help about how the CLI output works + +Output formatting in the CLI + +Human output (default one) + + scw instance server list + + ID NAME TYPE STATE ZONE PUBLIC IP + 088b01da-9ba7-40d2-bc55-eb3170f42185 scw-cool-franklin DEV1-S running fr-par-1 51.15.251.251 + +Human with column selection + +You can select the columns that you want to print with commands that return a list + + scw instance server list -o human=Name,PublicIP + + NAME PUBLIC IP + scw-cool-franklin 51.15.251.251 + +Standard JSON output + + scw config dump -o json + + {"access_key":"SCWXXXXXXXXXXXXXXXXX","secret_key":"11111111-1111-1111-1111-111111111111","default_organization_id":"11111111-1111-1111-1111-111111111111","default_region":"fr-par","default_zone":"fr-par-1","send_telemetry":true} + +Pretty JSON output + + scw config dump -o json=pretty + + { + "access_key": "SCWXXXXXXXXXXXXXXXXX", + "secret_key": "11111111-1111-1111-1111-111111111111", + "default_organization_id": "11111111-1111-1111-1111-111111111111", + "default_region": "fr-par", + "default_zone": "fr-par-1", + "send_telemetry": true + } + +Standard YAML output + + scw config dump -o yaml + + access_key: SCWXXXXXXXXXXXXXXXXX + secret_key: 11111111-1111-1111-1111-111111111111 + default_organization_id: 11111111-1111-1111-1111-111111111111 + default_region: fr-par + default_zone: fr-par-1 + send_telemetry: true + + +Template output + +You can use Go template to manipulate the output of a command and create a custom rendering of your resources. +Visit https://golang.org/pkg/text/template/ to learn more about Go template format. + + scw instance server list -o template="{{ .Name }}||{{ .ID }}" + + foo||11111111-1111-1111-1111-111111111111 + bar||22222222-2222-2222-2222-222222222222 + + +Output formatting in the CLI + +Human output (default one) + + scw instance server list + + ID NAME TYPE STATE ZONE PUBLIC IP + 088b01da-9ba7-40d2-bc55-eb3170f42185 scw-cool-franklin DEV1-S running fr-par-1 51.15.251.251 + +Human with column selection + +You can select the columns that you want to print with commands that return a list + + scw instance server list -o human=Name,PublicIP + + NAME PUBLIC IP + scw-cool-franklin 51.15.251.251 + +Standard JSON output + + scw config dump -o json + + {"access_key":"SCWXXXXXXXXXXXXXXXXX","secret_key":"11111111-1111-1111-1111-111111111111","default_organization_id":"11111111-1111-1111-1111-111111111111","default_region":"fr-par","default_zone":"fr-par-1","send_telemetry":true} + +Pretty JSON output + + scw config dump -o json=pretty + + { + "access_key": "SCWXXXXXXXXXXXXXXXXX", + "secret_key": "11111111-1111-1111-1111-111111111111", + "default_organization_id": "11111111-1111-1111-1111-111111111111", + "default_region": "fr-par", + "default_zone": "fr-par-1", + "send_telemetry": true + } + +Standard YAML output + + scw config dump -o yaml + + access_key: SCWXXXXXXXXXXXXXXXXX + secret_key: 11111111-1111-1111-1111-111111111111 + default_organization_id: 11111111-1111-1111-1111-111111111111 + default_region: fr-par + default_zone: fr-par-1 + send_telemetry: true + + +Template output + +You can use Go template to manipulate the output of a command and create a custom rendering of your resources. +Visit https://golang.org/pkg/text/template/ to learn more about Go template format. + + scw instance server list -o template="{{ .Name }}||{{ .ID }}" + + foo||11111111-1111-1111-1111-111111111111 + bar||22222222-2222-2222-2222-222222222222 + + +**Usage:** + +``` +scw help output +``` + + + diff --git a/docs/commands/instance.md b/docs/commands/instance.md index 20a240d153..d24e86fe2d 100644 --- a/docs/commands/instance.md +++ b/docs/commands/instance.md @@ -20,6 +20,11 @@ Instance API - [Get a placement group](#get-a-placement-group) - [List placement groups](#list-placement-groups) - [Update a placement group](#update-a-placement-group) +- [Private NIC management commands](#private-nic-management-commands) + - [Create a private NIC connecting a server to a private network](#create-a-private-nic-connecting-a-server-to-a-private-network) + - [Delete a private NIC](#delete-a-private-nic) + - [Get a private NIC](#get-a-private-nic) + - [List all private NICs](#list-all-private-nics) - [Security group management commands](#security-group-management-commands) - [Remove all rules of a security group](#remove-all-rules-of-a-security-group) - [Create a security group](#create-a-security-group) @@ -99,9 +104,11 @@ scw instance image create [arg=value ...] | additional-snapshots.{key}.name | | Name of the additional snapshot | | additional-snapshots.{key}.size | | Size of the additional snapshot | | additional-snapshots.{key}.volume-type | One of: `l_ssd`, `b_ssd` | Underlying volume type of the additional snapshot | +| additional-snapshots.{key}.project-id | | Project ID that own the additional snapshot | | additional-snapshots.{key}.organization-id | | Organization ID that own the additional snapshot | +| project-id | | Project ID to use. If none is passed the default project ID will be used | | public | | True to create a public image | -| organization-id | | Organization ID to use. If none is passed will use default organization ID from the config | +| organization-id | | Organization ID to use. If none is passed the default organization ID will be used | | zone | Default: `fr-par-1`
One of: `fr-par-1`, `nl-ams-1` | Zone to target. If none is passed will use default zone from the config | @@ -131,7 +138,7 @@ scw instance image delete [arg=value ...] | Name | | Description | |------|---|-------------| -| image-id | Required | | +| image-id | Required | UUID of the image you want to delete | | with-snapshots | | Delete the snapshots attached to this image | | zone | Default: `fr-par-1`
One of: `fr-par-1`, `nl-ams-1` | Zone to target. If none is passed will use default zone from the config | @@ -167,7 +174,7 @@ scw instance image get [arg=value ...] | Name | | Description | |------|---|-------------| -| image-id | Required | | +| image-id | Required | UUID of the image you want to get | | zone | Default: `fr-par-1`
One of: `fr-par-1`, `nl-ams-1` | Zone to target. If none is passed will use default zone from the config | @@ -205,6 +212,7 @@ scw instance image list [arg=value ...] | name | | | | public | | | | arch | | | +| project-id | | | | organization-id | | | | zone | Default: `fr-par-1`
One of: `fr-par-1`, `nl-ams-1` | Zone to target. If none is passed will use default zone from the config | @@ -274,10 +282,10 @@ scw instance ip create [arg=value ...] | Name | | Description | |------|---|-------------| -| project-id | | The project ID the IP is reserved in | +| project-id | | Project ID to use. If none is passed the default project ID will be used | | server | | UUID of the server you want to attach the IP to | | tags.{index} | | An array of keywords you want to tag this IP with | -| organization-id | | Organization ID to use. If none is passed will use default organization ID from the config | +| organization-id | | Organization ID to use. If none is passed the default organization ID will be used | | zone | Default: `fr-par-1`
One of: `fr-par-1`, `nl-ams-1` | Zone to target. If none is passed will use default zone from the config | @@ -397,8 +405,8 @@ scw instance ip list [arg=value ...] | Name | | Description | |------|---|-------------| -| project | | The project ID the IPs are reserved in | | name | | Filter on the IP address (Works as a LIKE operation on the IP address) | +| project-id | | The project ID the IPs are reserved in | | organization-id | | The organization ID the IPs are reserved in | | zone | Default: `fr-par-1`
One of: `fr-par-1`, `nl-ams-1` | Zone to target. If none is passed will use default zone from the config | @@ -500,9 +508,10 @@ scw instance placement-group create [arg=value ...] | Name | | Description | |------|---|-------------| | name | Default: `` | Name of the placement group | -| policy-mode | One of: `optional`, `enforced` | | -| policy-type | One of: `max_availability`, `low_latency` | | -| organization-id | | Organization ID to use. If none is passed will use default organization ID from the config | +| project-id | | Project ID to use. If none is passed the default project ID will be used | +| policy-mode | One of: `optional`, `enforced` | The operating mode of the placement group | +| policy-type | One of: `max_availability`, `low_latency` | The policy type of the placement group | +| organization-id | | Organization ID to use. If none is passed the default organization ID will be used | | zone | Default: `fr-par-1`
One of: `fr-par-1`, `nl-ams-1` | Zone to target. If none is passed will use default zone from the config | @@ -557,7 +566,7 @@ scw instance placement-group delete [arg=value ...] | Name | | Description | |------|---|-------------| -| placement-group-id | Required | | +| placement-group-id | Required | UUID of the placement group you want to delete | | zone | Default: `fr-par-1`
One of: `fr-par-1`, `nl-ams-1` | Zone to target. If none is passed will use default zone from the config | @@ -592,7 +601,7 @@ scw instance placement-group get [arg=value ...] | Name | | Description | |------|---|-------------| -| placement-group-id | Required | | +| placement-group-id | Required | UUID of the placement group you want to get | | zone | Default: `fr-par-1`
One of: `fr-par-1`, `nl-ams-1` | Zone to target. If none is passed will use default zone from the config | @@ -622,8 +631,9 @@ scw instance placement-group list [arg=value ...] | Name | | Description | |------|---|-------------| +| project-id | | List only placement groups of this project ID | | name | | Filter placement groups by name (for eg. "cluster1" will return "cluster100" and "cluster1" but not "foo") | -| organization-id | | List only placement groups of this organization | +| organization-id | | List only placement groups of this organization ID | | zone | Default: `fr-par-1`
One of: `fr-par-1`, `nl-ams-1` | Zone to target. If none is passed will use default zone from the config | @@ -686,6 +696,112 @@ scw instance placement-group update 0954ec26-9917-47b6-8c5c-7bc81d7bb9d2 policy- +## Private NIC management commands + +A Private NIC is the network interface that connects a server to a +Private Network. There can be at most one Private NIC connecting a +server to a network. + + + +### Create a private NIC connecting a server to a private network + +Create a private NIC connecting a server to a private network. + +**Usage:** + +``` +scw instance private-nic create [arg=value ...] +``` + + +**Args:** + +| Name | | Description | +|------|---|-------------| +| server-id | Required | | +| private-network-id | | | +| zone | Default: `fr-par-1`
One of: `fr-par-1`, `nl-ams-1` | Zone to target. If none is passed will use default zone from the config | + + + +### Delete a private NIC + +Delete a private NIC. + +**Usage:** + +``` +scw instance private-nic delete [arg=value ...] +``` + + +**Args:** + +| Name | | Description | +|------|---|-------------| +| server-id | Required | | +| private-nic-id | Required | | +| zone | Default: `fr-par-1`
One of: `fr-par-1`, `nl-ams-1` | Zone to target. If none is passed will use default zone from the config | + + + +### Get a private NIC + +Get private NIC properties. + +**Usage:** + +``` +scw instance private-nic get [arg=value ...] +``` + + +**Args:** + +| Name | | Description | +|------|---|-------------| +| server-id | Required | | +| private-nic-id | Required | | +| zone | Default: `fr-par-1`
One of: `fr-par-1`, `nl-ams-1` | Zone to target. If none is passed will use default zone from the config | + + + +### List all private NICs + +List all private NICs of a given server. + +**Usage:** + +``` +scw instance private-nic list [arg=value ...] +``` + + +**Args:** + +| Name | | Description | +|------|---|-------------| +| server-id | Required | | +| zone | Default: `fr-par-1`
One of: `fr-par-1`, `nl-ams-1` | Zone to target. If none is passed will use default zone from the config | + + +**Examples:** + + +List all private NICs on a specific server +``` +scw instance private-nic list +``` + +List private NICs of the server ID 'my_server_id' +``` +scw instance private-nic list server-id=my_server_id +``` + + + + ## Security group management commands A security group is a set of firewall rules on a set of instances. @@ -743,11 +859,13 @@ scw instance security-group create [arg=value ...] |------|---|-------------| | name | Required
Default: `` | Name of the security group | | description | | Description of the security group | +| project-id | | Project ID to use. If none is passed the default project ID will be used | | organization-default | Default: `false` | Whether this security group becomes the default security group for new instances | +| project-default | Default: `false` | Whether this security group becomes the default security group for new instances | | stateful | Default: `true` | Whether the security group is stateful or not | | inbound-default-policy | Default: `accept`
One of: `accept`, `drop` | Default policy for inbound rules | | outbound-default-policy | Default: `accept`
One of: `accept`, `drop` | Default policy for outbound rules | -| organization-id | | Organization ID to use. If none is passed will use default organization ID from the config | +| organization-id | | Organization ID to use. If none is passed the default organization ID will be used | | zone | Default: `fr-par-1`
One of: `fr-par-1`, `nl-ams-1` | Zone to target. If none is passed will use default zone from the config | @@ -759,9 +877,9 @@ Create a Security Group with the given name and description scw instance security-group create name=foobar description=foobar foobar ``` -Create a Security Group that will be applied as a default on instances of your organization +Create a Security Group that will be applied as a default on instances of your project ``` -scw instance security-group create organization-default=true +scw instance security-group create project-default=true ``` Create a Security Group that will have a default drop inbound policy (Traffic your instance receive) @@ -797,7 +915,7 @@ scw instance security-group delete [arg=value ...] | Name | | Description | |------|---|-------------| -| security-group-id | Required | | +| security-group-id | Required | UUID of the security group you want to delete | | zone | Default: `fr-par-1`
One of: `fr-par-1`, `nl-ams-1` | Zone to target. If none is passed will use default zone from the config | @@ -827,7 +945,7 @@ scw instance security-group get [arg=value ...] | Name | | Description | |------|---|-------------| -| security-group-id | Required | | +| security-group-id | Required | UUID of the security group you want to get | | zone | Default: `fr-par-1`
One of: `fr-par-1`, `nl-ams-1` | Zone to target. If none is passed will use default zone from the config | @@ -858,6 +976,7 @@ scw instance security-group list [arg=value ...] | Name | | Description | |------|---|-------------| | name | | Name of the security group | +| project-id | | The security group project ID | | organization-id | | The security group organization ID | | zone | Default: `fr-par-1`
One of: `fr-par-1`, `nl-ams-1` | Zone to target. If none is passed will use default zone from the config | @@ -895,6 +1014,7 @@ scw instance security-group update [arg=value ...] | inbound-default-policy | One of: `accept`, `drop` | | | outbound-default-policy | One of: `accept`, `drop` | | | organization-default | | | +| project-default | | | | zone | Default: `fr-par-1` | Zone to target. If none is passed will use default zone from the config | @@ -906,9 +1026,9 @@ Set the default outbound policy as drop scw instance security-group update security-group-id=11111111-1111-1111-1111-111111111111 outbound-default-policy=drop ``` -Set the given security group as the default for the organization +Set the given security group as the default for the project ``` -scw instance security-group update security-group-id=11111111-1111-1111-1111-111111111111 organization-default=true +scw instance security-group update security-group-id=11111111-1111-1111-1111-111111111111 project-default=true ``` Change the name of the given security group @@ -1082,8 +1202,9 @@ scw instance server create [arg=value ...] | placement-group-id | | The placement group ID in witch the server has to be created | | bootscript-id | | The bootscript ID to use, if empty the local boot will be used | | cloud-init | | The cloud-init script to use | -| organization-id | | Organization ID to use. If none is passed will use default organization ID from the config | +| project-id | | Project ID to use. If none is passed the default project ID will be used | | zone | Default: `fr-par-1` | Zone to target. If none is passed will use default zone from the config | +| ~~organization-id~~ | Deprecated | Please use project-id instead | **Examples:** @@ -1201,7 +1322,7 @@ scw instance server get [arg=value ...] | Name | | Description | |------|---|-------------| -| server-id | Required | | +| server-id | Required | UUID of the server you want to get | | zone | Default: `fr-par-1`
One of: `fr-par-1`, `nl-ams-1` | Zone to target. If none is passed will use default zone from the config | @@ -1231,13 +1352,15 @@ scw instance server list [arg=value ...] | Name | | Description | |------|---|-------------| +| project-id | | List only servers of this project ID | | name | | Filter servers by name (for eg. "server1" will return "server100" and "server1" but not "foo") | | private-ip | | List servers by private_ip | | without-ip | | List servers that are not attached to a public IP | | commercial-type | | List servers of this commercial type | | state | One of: `running`, `stopped`, `stopped in place`, `starting`, `stopping`, `locked` | List servers in this state | | tags.{index} | | List servers with these exact tags | -| organization-id | | List only servers of this organization | +| private-network | | List servers in this Private Network | +| organization-id | | List only servers of this organization ID | | zone | Default: `fr-par-1`
One of: `fr-par-1`, `nl-ams-1` | Zone to target. If none is passed will use default zone from the config | @@ -1500,6 +1623,10 @@ scw instance server update [arg=value ...] | security-group-id | | | | volume-ids.{index} | | Will update ALL volume IDs at once, including the root volume of the server (use volume-ids=none to detach all volumes) | | placement-group-id | | Placement group ID if server must be part of a placement group | +| private-nics.{index}.id | | The private NIC unique ID | +| private-nics.{index}.server-id | | The server the private NIC is attached to | +| private-nics.{index}.private-network-id | | The private network where the private NIC is attached | +| private-nics.{index}.mac-address | | The private NIC MAC address | | zone | Default: `fr-par-1`
One of: `fr-par-1`, `nl-ams-1` | Zone to target. If none is passed will use default zone from the config | @@ -1643,7 +1770,8 @@ scw instance snapshot create [arg=value ...] |------|---|-------------| | name | Default: `` | Name of the snapshot | | volume-id | Required | UUID of the volume | -| organization-id | | Organization ID to use. If none is passed will use default organization ID from the config | +| project-id | | Project ID to use. If none is passed the default project ID will be used | +| organization-id | | Organization ID to use. If none is passed the default organization ID will be used | | zone | Default: `fr-par-1`
One of: `fr-par-1`, `nl-ams-1` | Zone to target. If none is passed will use default zone from the config | @@ -1683,7 +1811,7 @@ scw instance snapshot delete [arg=value ...] | Name | | Description | |------|---|-------------| -| snapshot-id | Required | | +| snapshot-id | Required | UUID of the snapshot you want to delete | | zone | Default: `fr-par-1`
One of: `fr-par-1`, `nl-ams-1` | Zone to target. If none is passed will use default zone from the config | @@ -1718,7 +1846,7 @@ scw instance snapshot get [arg=value ...] | Name | | Description | |------|---|-------------| -| snapshot-id | Required | | +| snapshot-id | Required | UUID of the snapshot you want to get | | zone | Default: `fr-par-1`
One of: `fr-par-1`, `nl-ams-1` | Zone to target. If none is passed will use default zone from the config | @@ -1754,6 +1882,7 @@ scw instance snapshot list [arg=value ...] | Name | | Description | |------|---|-------------| | name | | | +| project-id | | | | organization-id | | | | zone | Default: `fr-par-1`
One of: `fr-par-1`, `nl-ams-1` | Zone to target. If none is passed will use default zone from the config | @@ -1827,7 +1956,7 @@ Delete the given key from a server user data. **Usage:** ``` -scw instance user-data delete [arg=value ...] +scw instance user-data delete [arg=value ...] ``` @@ -1848,7 +1977,7 @@ Get the content of a user data with the given key on a server. **Usage:** ``` -scw instance user-data get [arg=value ...] +scw instance user-data get [arg=value ...] ``` @@ -1869,7 +1998,7 @@ List all user data keys registered on a given server. **Usage:** ``` -scw instance user-data list [arg=value ...] +scw instance user-data list [arg=value ...] ``` @@ -1889,7 +2018,7 @@ Add or update a user data with the given key on a server. **Usage:** ``` -scw instance user-data set [arg=value ...] +scw instance user-data set [arg=value ...] ``` @@ -1954,12 +2083,13 @@ scw instance volume create [arg=value ...] | Name | | Description | |------|---|-------------| -| name | | | -| volume-type | One of: `l_ssd`, `b_ssd` | | -| size | | | -| base-volume | | | -| base-snapshot | | | -| organization-id | | Organization ID to use. If none is passed will use default organization ID from the config | +| name | | The volume name | +| project-id | | Project ID to use. If none is passed the default project ID will be used | +| volume-type | One of: `l_ssd`, `b_ssd` | The volume type | +| size | | The volume disk size | +| base-volume | | The ID of the volume on which this volume will be based | +| base-snapshot | | The ID of the snapshot on which this volume will be based | +| organization-id | | Organization ID to use. If none is passed the default organization ID will be used | | zone | Default: `fr-par-1`
One of: `fr-par-1`, `nl-ams-1` | Zone to target. If none is passed will use default zone from the config | @@ -1999,7 +2129,7 @@ scw instance volume delete [arg=value ...] | Name | | Description | |------|---|-------------| -| volume-id | Required | | +| volume-id | Required | UUID of the volume you want to delete | | zone | Default: `fr-par-1`
One of: `fr-par-1`, `nl-ams-1` | Zone to target. If none is passed will use default zone from the config | @@ -2029,7 +2159,7 @@ scw instance volume get [arg=value ...] | Name | | Description | |------|---|-------------| -| volume-id | Required | | +| volume-id | Required | UUID of the volume you want to get | | zone | Default: `fr-par-1`
One of: `fr-par-1`, `nl-ams-1` | Zone to target. If none is passed will use default zone from the config | @@ -2060,8 +2190,9 @@ scw instance volume list [arg=value ...] | Name | | Description | |------|---|-------------| | volume-type | One of: `l_ssd`, `b_ssd` | Filter by volume type | +| project-id | | Filter volume by project ID | | name | | Filter volume by name (for eg. "vol" will return "myvolume" but not "data") | -| organization-id | | Filter volume by organization | +| organization-id | | Filter volume by organization ID | | zone | Default: `fr-par-1`
One of: `fr-par-1`, `nl-ams-1` | Zone to target. If none is passed will use default zone from the config | diff --git a/docs/commands/iot.md b/docs/commands/iot.md new file mode 100644 index 0000000000..9e429ecc3c --- /dev/null +++ b/docs/commands/iot.md @@ -0,0 +1,477 @@ + +# Documentation for `scw iot` +This API allows you to manage IoT hubs and devices + +- [IoT Device commands](#iot-device-commands) + - [Add a device](#add-a-device) + - [Remove a device](#remove-a-device) + - [Disable a device](#disable-a-device) + - [Enable a device](#enable-a-device) + - [Get a device](#get-a-device) + - [Get a device's metrics](#get-a-device's-metrics) + - [List devices](#list-devices) + - [Update a device](#update-a-device) +- [IoT Hub commands](#iot-hub-commands) + - [Create a hub](#create-a-hub) + - [Delete a hub](#delete-a-hub) + - [Disable a hub](#disable-a-hub) + - [Enable a hub](#enable-a-hub) + - [Get a hub](#get-a-hub) + - [List hubs](#list-hubs) + - [Update a hub](#update-a-hub) +- [IoT Network commands](#iot-network-commands) + - [Create a new Network](#create-a-new-network) + - [Delete a Network](#delete-a-network) + - [Retrieve a specific Network](#retrieve-a-specific-network) + - [List the Networks](#list-the-networks) +- [IoT Route commands](#iot-route-commands) + + +## IoT Device commands + +IoT Device commands. + + +### Add a device + +Add a device. + +**Usage:** + +``` +scw iot device create [arg=value ...] +``` + + +**Args:** + +| Name | | Description | +|------|---|-------------| +| name | Required
Default: `` | Device name | +| hub-id | Required | ID of the device's hub | +| allow-insecure | | Allow plain and server-authenticated SSL connections in addition to mutually-authenticated ones | +| message-filters.publish.policy | One of: `unknown`, `accept`, `reject` | | +| message-filters.publish.topics.{index} | | | +| message-filters.subscribe.policy | One of: `unknown`, `accept`, `reject` | | +| message-filters.subscribe.topics.{index} | | | +| region | Default: `fr-par`
One of: `fr-par` | Region to target. If none is passed will use default region from the config | + + + +### Remove a device + +Remove a device. + +**Usage:** + +``` +scw iot device delete [arg=value ...] +``` + + +**Args:** + +| Name | | Description | +|------|---|-------------| +| device-id | Required | Device ID | +| region | Default: `fr-par`
One of: `fr-par` | Region to target. If none is passed will use default region from the config | + + + +### Disable a device + +Disable a device. + +**Usage:** + +``` +scw iot device disable [arg=value ...] +``` + + +**Args:** + +| Name | | Description | +|------|---|-------------| +| device-id | Required | Device ID | +| region | Default: `fr-par`
One of: `fr-par` | Region to target. If none is passed will use default region from the config | + + + +### Enable a device + +Enable a device. + +**Usage:** + +``` +scw iot device enable [arg=value ...] +``` + + +**Args:** + +| Name | | Description | +|------|---|-------------| +| device-id | Required | Device ID | +| region | Default: `fr-par`
One of: `fr-par` | Region to target. If none is passed will use default region from the config | + + + +### Get a device + +Get a device. + +**Usage:** + +``` +scw iot device get [arg=value ...] +``` + + +**Args:** + +| Name | | Description | +|------|---|-------------| +| device-id | Required | Device ID | +| region | Default: `fr-par`
One of: `fr-par` | Region to target. If none is passed will use default region from the config | + + + +### Get a device's metrics + +Get a device's metrics. + +**Usage:** + +``` +scw iot device get-metrics [arg=value ...] +``` + + +**Args:** + +| Name | | Description | +|------|---|-------------| +| device-id | Required | Device ID | +| period | Required
Default: `hour`
One of: `hour`, `day`, `week`, `month`, `year` | Period over which the metrics span | +| region | Default: `fr-par`
One of: `fr-par` | Region to target. If none is passed will use default region from the config | + + + +### List devices + +List devices. + +**Usage:** + +``` +scw iot device list [arg=value ...] +``` + + +**Args:** + +| Name | | Description | +|------|---|-------------| +| order-by | One of: `name_asc`, `name_desc`, `status_asc`, `status_desc`, `hub_id_asc`, `hub_id_desc`, `created_at_asc`, `created_at_desc`, `updated_at_asc`, `updated_at_desc`, `allow_insecure_asc`, `allow_insecure_desc` | Ordering of requested devices | +| name | | Filter on the name | +| hub-id | | Filter on the hub | +| enabled | | Deprecated, ignored filter | +| allow-insecure | | Filter on the allow_insecure flag | +| is-connected | | Deprecated, ignored filter | +| organization-id | | Filter on the organization | +| region | Default: `fr-par`
One of: `fr-par` | Region to target. If none is passed will use default region from the config | + + + +### Update a device + +Update a device. + +**Usage:** + +``` +scw iot device update [arg=value ...] +``` + + +**Args:** + +| Name | | Description | +|------|---|-------------| +| device-id | Required | Device ID | +| name | | Device name | +| allow-insecure | | Allow plain and server-authenticated SSL connections in addition to mutually-authenticated ones | +| message-filters.publish.policy | One of: `unknown`, `accept`, `reject` | | +| message-filters.publish.topics.{index} | | | +| message-filters.subscribe.policy | One of: `unknown`, `accept`, `reject` | | +| message-filters.subscribe.topics.{index} | | | +| hub-id | | Change Hub for this device, additional fees may apply, see IoT Hub pricing | +| region | Default: `fr-par`
One of: `fr-par` | Region to target. If none is passed will use default region from the config | + + + +## IoT Hub commands + +IoT Hub commands. + + +### Create a hub + +Create a hub. + +**Usage:** + +``` +scw iot hub create [arg=value ...] +``` + + +**Args:** + +| Name | | Description | +|------|---|-------------| +| name | Required
Default: `` | Hub name (up to 255 characters) | +| product-plan | Required
Default: `plan_shared`
One of: `plan_unknown`, `plan_shared`, `plan_dedicated`, `plan_ha` | Hub feature set | +| disable-events | | Disable Hub events (default false) | +| events-topic-prefix | | Hub events topic prefix (default '$SCW/events') | +| organization-id | | Organization ID to use. If none is passed the default organization ID will be used | +| region | Default: `fr-par`
One of: `fr-par` | Region to target. If none is passed will use default region from the config | + + + +### Delete a hub + +Delete a hub. + +**Usage:** + +``` +scw iot hub delete [arg=value ...] +``` + + +**Args:** + +| Name | | Description | +|------|---|-------------| +| hub-id | Required | Hub ID | +| delete-devices | | Force deletion of devices added to this hub instead of rejecting operation | +| region | Default: `fr-par`
One of: `fr-par` | Region to target. If none is passed will use default region from the config | + + + +### Disable a hub + +Disable a hub. + +**Usage:** + +``` +scw iot hub disable [arg=value ...] +``` + + +**Args:** + +| Name | | Description | +|------|---|-------------| +| hub-id | Required | Hub ID | +| region | Default: `fr-par`
One of: `fr-par` | Region to target. If none is passed will use default region from the config | + + + +### Enable a hub + +Enable a hub. + +**Usage:** + +``` +scw iot hub enable [arg=value ...] +``` + + +**Args:** + +| Name | | Description | +|------|---|-------------| +| hub-id | Required | Hub ID | +| region | Default: `fr-par`
One of: `fr-par` | Region to target. If none is passed will use default region from the config | + + + +### Get a hub + +Get a hub. + +**Usage:** + +``` +scw iot hub get [arg=value ...] +``` + + +**Args:** + +| Name | | Description | +|------|---|-------------| +| hub-id | Required | Hub ID | +| region | Default: `fr-par`
One of: `fr-par` | Region to target. If none is passed will use default region from the config | + + + +### List hubs + +List hubs. + +**Usage:** + +``` +scw iot hub list [arg=value ...] +``` + + +**Args:** + +| Name | | Description | +|------|---|-------------| +| order-by | One of: `name_asc`, `name_desc`, `status_asc`, `status_desc`, `product_plan_asc`, `product_plan_desc`, `created_at_asc`, `created_at_desc`, `updated_at_asc`, `updated_at_desc` | Ordering of requested hub | +| name | | Filter on the name | +| organization-id | | Filter on the organization | +| region | Default: `fr-par`
One of: `fr-par` | Region to target. If none is passed will use default region from the config | + + + +### Update a hub + +Update a hub. + +**Usage:** + +``` +scw iot hub update [arg=value ...] +``` + + +**Args:** + +| Name | | Description | +|------|---|-------------| +| hub-id | Required | Hub ID | +| name | | Hub name (up to 255 characters) | +| product-plan | One of: `plan_unknown`, `plan_shared`, `plan_dedicated`, `plan_ha` | Hub feature set | +| disable-events | | Disable Hub events | +| events-topic-prefix | | Hub events topic prefix | +| region | Default: `fr-par`
One of: `fr-par` | Region to target. If none is passed will use default region from the config | + + + +## IoT Network commands + +IoT Network commands. + + +### Create a new Network + +Create a new Network. + +**Usage:** + +``` +scw iot network create [arg=value ...] +``` + + +**Args:** + +| Name | | Description | +|------|---|-------------| +| name | Required
Default: `` | Network name | +| type | Required
One of: `unknown`, `sigfox`, `rest` | Type of network to connect with | +| hub-id | Required | Hub ID to connect the Network to | +| topic-prefix | Required | Topic prefix for the Network | +| organization-id | | Organization ID to use. If none is passed the default organization ID will be used | +| region | Default: `fr-par`
One of: `fr-par` | Region to target. If none is passed will use default region from the config | + + + +### Delete a Network + +Delete a Network. + +**Usage:** + +``` +scw iot network delete [arg=value ...] +``` + + +**Args:** + +| Name | | Description | +|------|---|-------------| +| network-id | Required | Network ID | +| region | Default: `fr-par`
One of: `fr-par` | Region to target. If none is passed will use default region from the config | + + + +### Retrieve a specific Network + +Retrieve a specific Network. + +**Usage:** + +``` +scw iot network get [arg=value ...] +``` + + +**Args:** + +| Name | | Description | +|------|---|-------------| +| network-id | Required | Network ID | +| region | Default: `fr-par`
One of: `fr-par` | Region to target. If none is passed will use default region from the config | + + + +### List the Networks + +List the Networks. + +**Usage:** + +``` +scw iot network list [arg=value ...] +``` + + +**Args:** + +| Name | | Description | +|------|---|-------------| +| order-by | One of: `name_asc`, `name_desc`, `type_asc`, `type_desc`, `created_at_asc`, `created_at_desc` | Ordering of requested routes | +| name | | Filter on Network name | +| hub-id | | Filter on the hub | +| topic-prefix | | Filter on the topic prefix | +| organization-id | | Filter on the organization | +| region | Default: `fr-par`
One of: `fr-par` | Region to target. If none is passed will use default region from the config | + + + +## IoT Route commands + +IoT Route commands. + +IoT Route commands. + +**Usage:** + +``` +scw iot route +``` + + + diff --git a/docs/commands/k8s.md b/docs/commands/k8s.md index 067c3c9e0f..5b863e4724 100644 --- a/docs/commands/k8s.md +++ b/docs/commands/k8s.md @@ -58,6 +58,7 @@ scw k8s cluster create [arg=value ...] | Name | | Description | |------|---|-------------| +| project-id | | Project ID to use. If none is passed the default project ID will be used | | name | Required | The name of the cluster | | description | | The description of the cluster | | tags.{index} | | The tags associated with the cluster | @@ -88,7 +89,7 @@ scw k8s cluster create [arg=value ...] | auto-upgrade.maintenance-window.day | One of: `any`, `monday`, `tuesday`, `wednesday`, `thursday`, `friday`, `saturday`, `sunday` | The day of the week for the maintenance window | | feature-gates.{index} | | List of feature gates to enable | | admission-plugins.{index} | | List of admission plugins to enable | -| organization-id | | Organization ID to use. If none is passed will use default organization ID from the config | +| organization-id | | Organization ID to use. If none is passed the default organization ID will be used | | region | Default: `fr-par`
One of: `fr-par`, `nl-ams` | Region to target. If none is passed will use default region from the config | @@ -184,6 +185,7 @@ scw k8s cluster list [arg=value ...] | Name | | Description | |------|---|-------------| +| project-id | | The project ID on which to filter the returned clusters | | order-by | One of: `created_at_asc`, `created_at_desc`, `updated_at_asc`, `updated_at_desc`, `name_asc`, `name_desc`, `status_asc`, `status_desc`, `version_asc`, `version_desc` | The sort order of the returned clusters | | name | | The name on which to filter the returned clusters | | status | One of: `unknown`, `creating`, `ready`, `deleting`, `deleted`, `updating`, `locked`, `pool_required` | The status on which to filter the returned clusters | @@ -417,6 +419,16 @@ scw k8s kubeconfig get [arg=value ...] | region | Default: `fr-par` | Region to target. If none is passed will use default region from the config | +**Examples:** + + +Get the kubeconfig for a given cluster +``` +scw k8s kubeconfig get 11111111-1111-1111-1111-111111111111 +``` + + + ### Install a kubeconfig @@ -525,7 +537,7 @@ This method allows to list all the existing nodes for a specific Kubernetes clus **Usage:** ``` -scw k8s node list [arg=value ...] +scw k8s node list [arg=value ...] ``` @@ -667,7 +679,7 @@ This method allows to create a new pool in a specific Kubernetes cluster. **Usage:** ``` -scw k8s pool create [arg=value ...] +scw k8s pool create [arg=value ...] ``` @@ -777,7 +789,7 @@ This method allows to list all the existing pools for a specific Kubernetes clus **Usage:** ``` -scw k8s pool list [arg=value ...] +scw k8s pool list [arg=value ...] ``` diff --git a/docs/commands/lb.md b/docs/commands/lb.md new file mode 100644 index 0000000000..6cb61b17c4 --- /dev/null +++ b/docs/commands/lb.md @@ -0,0 +1,967 @@ + +# Documentation for `scw lb` +This API allows you to manage your load balancer service + +- [Access Control List (ACL) management commands](#access-control-list-(acl)-management-commands) + - [Create an ACL for a given frontend](#create-an-acl-for-a-given-frontend) + - [Delete an ACL](#delete-an-acl) + - [Get an ACL](#get-an-acl) + - [List ACL for a given frontend](#list-acl-for-a-given-frontend) + - [Update an ACL](#update-an-acl) +- [Backend management commands](#backend-management-commands) + - [Add a set of servers in a given backend](#add-a-set-of-servers-in-a-given-backend) + - [Create a backend in a given load balancer](#create-a-backend-in-a-given-load-balancer) + - [Delete a backend in a given load balancer](#delete-a-backend-in-a-given-load-balancer) + - [Get a backend in a given load balancer](#get-a-backend-in-a-given-load-balancer) + - [List backends in a given load balancer](#list-backends-in-a-given-load-balancer) + - [Remove a set of servers for a given backend](#remove-a-set-of-servers-for-a-given-backend) + - [Define all servers in a given backend](#define-all-servers-in-a-given-backend) + - [Update a backend in a given load balancer](#update-a-backend-in-a-given-load-balancer) + - [Update an healthcheck for a given backend](#update-an-healthcheck-for-a-given-backend) +- [TLS certificate management commands](#tls-certificate-management-commands) + - [Create a TLS certificate](#create-a-tls-certificate) + - [Delete a TLS certificate](#delete-a-tls-certificate) + - [Get a TLS certificate](#get-a-tls-certificate) + - [List all TLS certificates on a given load balancer](#list-all-tls-certificates-on-a-given-load-balancer) + - [Update a TLS certificate](#update-a-tls-certificate) +- [Frontend management commands](#frontend-management-commands) + - [Create a frontend in a given load balancer](#create-a-frontend-in-a-given-load-balancer) + - [Delete a frontend](#delete-a-frontend) + - [Get a frontend](#get-a-frontend) + - [List frontends in a given load balancer](#list-frontends-in-a-given-load-balancer) + - [Update a frontend](#update-a-frontend) +- [IP management commands](#ip-management-commands) + - [Create an IP](#create-an-ip) + - [Delete an IP](#delete-an-ip) + - [Get an IP](#get-an-ip) + - [List IPs](#list-ips) + - [Update an IP](#update-an-ip) +- [Load-balancer management commands](#load-balancer-management-commands) + - [Create a load balancer](#create-a-load-balancer) + - [Delete a load balancer](#delete-a-load-balancer) + - [Get a load balancer](#get-a-load-balancer) + - [Get usage statistics of a given load balancer](#get-usage-statistics-of-a-given-load-balancer) + - [List load balancers](#list-load-balancers) + - [Migrate a load balancer](#migrate-a-load-balancer) + - [Update a load balancer](#update-a-load-balancer) + - [Wait for a load balancer to reach a stable state](#wait-for-a-load-balancer-to-reach-a-stable-state) +- [Load-balancer types management commands](#load-balancer-types-management-commands) + - [List all load balancer offer type](#list-all-load-balancer-offer-type) + + +## Access Control List (ACL) management commands + +Access Control List (ACL) management commands. + + +### Create an ACL for a given frontend + +Create an ACL for a given frontend. + +**Usage:** + +``` +scw lb acl create [arg=value ...] +``` + + +**Args:** + +| Name | | Description | +|------|---|-------------| +| frontend-id | Required | ID of your frontend | +| name | Required
Default: `` | Name of your ACL ressource | +| action.type | One of: `allow`, `deny` | The action type | +| match.ip-subnet.{index} | | A list of IPs or CIDR v4/v6 addresses of the client of the session to match | +| match.http-filter | One of: `acl_http_filter_none`, `path_begin`, `path_end`, `regex` | The HTTP filter to match | +| match.http-filter-value.{index} | | A list of possible values to match for the given HTTP filter | +| match.invert | | If set to `true`, the ACL matching condition will be of type "UNLESS" | +| index | Required | Order between your Acls (ascending order, 0 is first acl executed) | +| region | Default: `fr-par`
One of: `fr-par`, `nl-ams` | Region to target. If none is passed will use default region from the config | + + + +### Delete an ACL + +Delete an ACL. + +**Usage:** + +``` +scw lb acl delete [arg=value ...] +``` + + +**Args:** + +| Name | | Description | +|------|---|-------------| +| acl-id | Required | ID of your ACL ressource | +| region | Default: `fr-par`
One of: `fr-par`, `nl-ams` | Region to target. If none is passed will use default region from the config | + + + +### Get an ACL + +Get an ACL. + +**Usage:** + +``` +scw lb acl get [arg=value ...] +``` + + +**Args:** + +| Name | | Description | +|------|---|-------------| +| acl-id | Required | ID of your ACL ressource | +| region | Default: `fr-par`
One of: `fr-par`, `nl-ams` | Region to target. If none is passed will use default region from the config | + + + +### List ACL for a given frontend + +List ACL for a given frontend. + +**Usage:** + +``` +scw lb acl list [arg=value ...] +``` + + +**Args:** + +| Name | | Description | +|------|---|-------------| +| frontend-id | Required | ID of your frontend | +| order-by | One of: `created_at_asc`, `created_at_desc`, `name_asc`, `name_desc` | You can order the response by created_at asc/desc or name asc/desc | +| name | | Filter acl per name | +| region | Default: `fr-par`
One of: `fr-par`, `nl-ams` | Region to target. If none is passed will use default region from the config | + + + +### Update an ACL + +Update an ACL. + +**Usage:** + +``` +scw lb acl update [arg=value ...] +``` + + +**Args:** + +| Name | | Description | +|------|---|-------------| +| acl-id | Required | ID of your ACL ressource | +| name | Required | Name of your ACL ressource | +| action.type | One of: `allow`, `deny` | The action type | +| match.ip-subnet.{index} | | A list of IPs or CIDR v4/v6 addresses of the client of the session to match | +| match.http-filter | One of: `acl_http_filter_none`, `path_begin`, `path_end`, `regex` | The HTTP filter to match | +| match.http-filter-value.{index} | | A list of possible values to match for the given HTTP filter | +| match.invert | | If set to `true`, the ACL matching condition will be of type "UNLESS" | +| index | Required | Order between your Acls (ascending order, 0 is first acl executed) | +| region | Default: `fr-par`
One of: `fr-par`, `nl-ams` | Region to target. If none is passed will use default region from the config | + + + +## Backend management commands + +Backend management commands. + + +### Add a set of servers in a given backend + +Add a set of servers in a given backend. + +**Usage:** + +``` +scw lb backend add-servers [arg=value ...] +``` + + +**Args:** + +| Name | | Description | +|------|---|-------------| +| backend-id | Required | Backend ID | +| server-ip.{index} | Required | Set all IPs to add on your backend | +| region | Default: `fr-par`
One of: `fr-par`, `nl-ams` | Region to target. If none is passed will use default region from the config | + + + +### Create a backend in a given load balancer + +Create a backend in a given load balancer. + +**Usage:** + +``` +scw lb backend create [arg=value ...] +``` + + +**Args:** + +| Name | | Description | +|------|---|-------------| +| name | Required
Default: `` | Resource name | +| forward-protocol | Required
One of: `tcp`, `http` | Backend protocol. TCP or HTTP | +| forward-port | Required | User sessions will be forwarded to this port of backend servers | +| forward-port-algorithm | Required
Default: `roundrobin`
One of: `roundrobin`, `leastconn` | Load balancing algorithm | +| sticky-sessions | Required
Default: `none`
One of: `none`, `cookie`, `table` | Enables cookie-based session persistence | +| sticky-sessions-cookie-name | | Cookie name for for sticky sessions | +| health-check.mysql-config.user | | | +| health-check.check-max-retries | | | +| health-check.pgsql-config.user | | | +| health-check.http-config.uri | | | +| health-check.http-config.method | | | +| health-check.http-config.code | | | +| health-check.https-config.uri | | | +| health-check.https-config.method | | | +| health-check.https-config.code | | | +| health-check.port | | | +| health-check.check-timeout | | | +| health-check.check-delay | | | +| lb-id | Required | Load balancer ID | +| server-ip.{index} | Required | Backend server IP addresses list (IPv4 or IPv6) | +| send-proxy-v2 | | Deprecated in favor of proxy_protocol field ! | +| timeout-server | | Maximum server connection inactivity time | +| timeout-connect | | Maximum initical server connection establishment time | +| timeout-tunnel | | Maximum tunnel inactivity time | +| on-marked-down-action | One of: `on_marked_down_action_none`, `shutdown_sessions` | Modify what occurs when a backend server is marked down | +| proxy-protocol | One of: `proxy_protocol_unknown`, `proxy_protocol_none`, `proxy_protocol_v1`, `proxy_protocol_v2`, `proxy_protocol_v2_ssl`, `proxy_protocol_v2_ssl_cn` | PROXY protocol, forward client's address (must be supported by backend servers software) | +| region | Default: `fr-par`
One of: `fr-par`, `nl-ams` | Region to target. If none is passed will use default region from the config | + + + +### Delete a backend in a given load balancer + +Delete a backend in a given load balancer. + +**Usage:** + +``` +scw lb backend delete [arg=value ...] +``` + + +**Args:** + +| Name | | Description | +|------|---|-------------| +| backend-id | Required | ID of the backend to delete | +| region | Default: `fr-par`
One of: `fr-par`, `nl-ams` | Region to target. If none is passed will use default region from the config | + + + +### Get a backend in a given load balancer + +Get a backend in a given load balancer. + +**Usage:** + +``` +scw lb backend get [arg=value ...] +``` + + +**Args:** + +| Name | | Description | +|------|---|-------------| +| backend-id | Required | Backend ID | +| region | Default: `fr-par`
One of: `fr-par`, `nl-ams` | Region to target. If none is passed will use default region from the config | + + + +### List backends in a given load balancer + +List backends in a given load balancer. + +**Usage:** + +``` +scw lb backend list [arg=value ...] +``` + + +**Args:** + +| Name | | Description | +|------|---|-------------| +| lb-id | Required | Load balancer ID | +| name | | Use this to search by name | +| order-by | One of: `created_at_asc`, `created_at_desc`, `name_asc`, `name_desc` | Choose order of response | +| region | Default: `fr-par`
One of: `fr-par`, `nl-ams` | Region to target. If none is passed will use default region from the config | + + + +### Remove a set of servers for a given backend + +Remove a set of servers for a given backend. + +**Usage:** + +``` +scw lb backend remove-servers [arg=value ...] +``` + + +**Args:** + +| Name | | Description | +|------|---|-------------| +| backend-id | Required | Backend ID | +| server-ip.{index} | Required | Set all IPs to remove of your backend | +| region | Default: `fr-par`
One of: `fr-par`, `nl-ams` | Region to target. If none is passed will use default region from the config | + + + +### Define all servers in a given backend + +Define all servers in a given backend. + +**Usage:** + +``` +scw lb backend set-servers [arg=value ...] +``` + + +**Args:** + +| Name | | Description | +|------|---|-------------| +| backend-id | Required | Backend ID | +| server-ip.{index} | Required | Set all IPs to add on your backend and remove all other | +| region | Default: `fr-par`
One of: `fr-par`, `nl-ams` | Region to target. If none is passed will use default region from the config | + + + +### Update a backend in a given load balancer + +Update a backend in a given load balancer. + +**Usage:** + +``` +scw lb backend update [arg=value ...] +``` + + +**Args:** + +| Name | | Description | +|------|---|-------------| +| backend-id | Required | | +| name | | | +| forward-protocol | One of: `tcp`, `http` | | +| forward-port | | | +| forward-port-algorithm | One of: `roundrobin`, `leastconn` | | +| sticky-sessions | One of: `none`, `cookie`, `table` | | +| sticky-sessions-cookie-name | | | +| send-proxy-v2 | | | +| timeout-server | | | +| timeout-connect | | | +| timeout-tunnel | | | +| on-marked-down-action | One of: `on_marked_down_action_none`, `shutdown_sessions` | | +| proxy-protocol | One of: `proxy_protocol_unknown`, `proxy_protocol_none`, `proxy_protocol_v1`, `proxy_protocol_v2`, `proxy_protocol_v2_ssl`, `proxy_protocol_v2_ssl_cn` | | +| region | Default: `fr-par`
One of: `fr-par`, `nl-ams` | Region to target. If none is passed will use default region from the config | + + + +### Update an healthcheck for a given backend + +Update an healthcheck for a given backend. + +**Usage:** + +``` +scw lb backend update-healthcheck [arg=value ...] +``` + + +**Args:** + +| Name | | Description | +|------|---|-------------| +| port | Required | Specify the port used to health check | +| check-delay | Required | Time between two consecutive health checks | +| check-timeout | Required | Additional check timeout, after the connection has been already established | +| check-max-retries | Required | Number of consecutive unsuccessful health checks, after wich the server will be considered dead | +| backend-id | Required | Backend ID | +| mysql-config.user | | | +| pgsql-config.user | | | +| http-config.uri | | | +| http-config.method | | | +| http-config.code | | | +| https-config.uri | | | +| https-config.method | | | +| https-config.code | | | +| region | Default: `fr-par`
One of: `fr-par`, `nl-ams` | Region to target. If none is passed will use default region from the config | + + + +## TLS certificate management commands + +TLS certificate management commands. + + +### Create a TLS certificate + +Generate a new TLS certificate using Let's Encrypt or import your certificate. + +**Usage:** + +``` +scw lb certificate create [arg=value ...] +``` + + +**Args:** + +| Name | | Description | +|------|---|-------------| +| lb-id | Required | Load balancer ID | +| name | Required
Default: `` | Certificate name | +| letsencrypt-common-name | | Main domain name of certificate (make sure this domain exists and resolves to your load balancer HA IP) | +| letsencrypt-alternative-name.{index} | | Alternative domain names (make sure all domain names exists and resolves to your load balancer HA IP) | +| custom-certificate-chain | | The full PEM-formatted include an entire certificate chain including public key, private key, and optionally certificate authorities. | +| region | Default: `fr-par`
One of: `fr-par`, `nl-ams` | Region to target. If none is passed will use default region from the config | + + + +### Delete a TLS certificate + +Delete a TLS certificate. + +**Usage:** + +``` +scw lb certificate delete [arg=value ...] +``` + + +**Args:** + +| Name | | Description | +|------|---|-------------| +| certificate-id | Required | Certificate ID | +| region | Default: `fr-par`
One of: `fr-par`, `nl-ams` | Region to target. If none is passed will use default region from the config | + + + +### Get a TLS certificate + +Get a TLS certificate. + +**Usage:** + +``` +scw lb certificate get [arg=value ...] +``` + + +**Args:** + +| Name | | Description | +|------|---|-------------| +| certificate-id | Required | Certificate ID | +| region | Default: `fr-par`
One of: `fr-par`, `nl-ams` | Region to target. If none is passed will use default region from the config | + + + +### List all TLS certificates on a given load balancer + +List all TLS certificates on a given load balancer. + +**Usage:** + +``` +scw lb certificate list [arg=value ...] +``` + + +**Args:** + +| Name | | Description | +|------|---|-------------| +| lb-id | Required | Load balancer ID | +| order-by | One of: `created_at_asc`, `created_at_desc`, `name_asc`, `name_desc` | You can order the response by created_at asc/desc or name asc/desc | +| name | | Use this to search by name | +| region | Default: `fr-par`
One of: `fr-par`, `nl-ams` | Region to target. If none is passed will use default region from the config | + + + +### Update a TLS certificate + +Update a TLS certificate. + +**Usage:** + +``` +scw lb certificate update [arg=value ...] +``` + + +**Args:** + +| Name | | Description | +|------|---|-------------| +| certificate-id | Required | Certificate ID | +| name | Required | Certificate name | +| region | Default: `fr-par`
One of: `fr-par`, `nl-ams` | Region to target. If none is passed will use default region from the config | + + + +## Frontend management commands + +Frontend management commands. + + +### Create a frontend in a given load balancer + +Create a frontend in a given load balancer. + +**Usage:** + +``` +scw lb frontend create [arg=value ...] +``` + + +**Args:** + +| Name | | Description | +|------|---|-------------| +| name | Required
Default: `` | Resource name | +| inbound-port | Required | TCP port to listen on the front side | +| lb-id | Required | Load balancer ID | +| backend-id | Required | Backend ID | +| timeout-client | | Set the maximum inactivity time on the client side | +| certificate-id | | Certificate ID, deprecated in favor of certificate_ids array ! | +| certificate-ids.{index} | | List of certificate IDs to bind on the frontend | +| region | Default: `fr-par`
One of: `fr-par`, `nl-ams` | Region to target. If none is passed will use default region from the config | + + + +### Delete a frontend + +Delete a frontend. + +**Usage:** + +``` +scw lb frontend delete [arg=value ...] +``` + + +**Args:** + +| Name | | Description | +|------|---|-------------| +| frontend-id | Required | Frontend ID to delete | +| region | Default: `fr-par`
One of: `fr-par`, `nl-ams` | Region to target. If none is passed will use default region from the config | + + + +### Get a frontend + +Get a frontend. + +**Usage:** + +``` +scw lb frontend get [arg=value ...] +``` + + +**Args:** + +| Name | | Description | +|------|---|-------------| +| frontend-id | Required | Frontend ID | +| region | Default: `fr-par`
One of: `fr-par`, `nl-ams` | Region to target. If none is passed will use default region from the config | + + + +### List frontends in a given load balancer + +List frontends in a given load balancer. + +**Usage:** + +``` +scw lb frontend list [arg=value ...] +``` + + +**Args:** + +| Name | | Description | +|------|---|-------------| +| lb-id | Required | Load balancer ID | +| name | | Use this to search by name | +| order-by | One of: `created_at_asc`, `created_at_desc`, `name_asc`, `name_desc` | Response order | +| region | Default: `fr-par`
One of: `fr-par`, `nl-ams` | Region to target. If none is passed will use default region from the config | + + + +### Update a frontend + +Update a frontend. + +**Usage:** + +``` +scw lb frontend update [arg=value ...] +``` + + +**Args:** + +| Name | | Description | +|------|---|-------------| +| frontend-id | Required | Frontend ID | +| name | Required | Resource name | +| inbound-port | Required | TCP port to listen on the front side | +| backend-id | Required | Backend ID | +| timeout-client | | Client session maximum inactivity time | +| certificate-id | | Certificate ID, deprecated in favor of `certificate_ids` array! | +| certificate-ids.{index} | | List of certificate IDs to bind on the frontend | +| region | Default: `fr-par`
One of: `fr-par`, `nl-ams` | Region to target. If none is passed will use default region from the config | + + + +## IP management commands + +IP management commands. + + +### Create an IP + +Create an IP. + +**Usage:** + +``` +scw lb ip create [arg=value ...] +``` + + +**Args:** + +| Name | | Description | +|------|---|-------------| +| project-id | | Project ID to use. If none is passed the default project ID will be used | +| reverse | | Reverse domain name | +| organization-id | | Organization ID to use. If none is passed the default organization ID will be used | +| region | Default: `fr-par`
One of: `fr-par`, `nl-ams` | Region to target. If none is passed will use default region from the config | + + + +### Delete an IP + +Delete an IP. + +**Usage:** + +``` +scw lb ip delete [arg=value ...] +``` + + +**Args:** + +| Name | | Description | +|------|---|-------------| +| ip-id | Required | IP address ID | +| region | Default: `fr-par`
One of: `fr-par`, `nl-ams` | Region to target. If none is passed will use default region from the config | + + + +### Get an IP + +Get an IP. + +**Usage:** + +``` +scw lb ip get [arg=value ...] +``` + + +**Args:** + +| Name | | Description | +|------|---|-------------| +| ip-id | Required | IP address ID | +| region | Default: `fr-par`
One of: `fr-par`, `nl-ams` | Region to target. If none is passed will use default region from the config | + + + +### List IPs + +List IPs. + +**Usage:** + +``` +scw lb ip list [arg=value ...] +``` + + +**Args:** + +| Name | | Description | +|------|---|-------------| +| ip-address | | Use this to search by IP address | +| project-id | | Filter IPs by project ID | +| organization-id | | Filter IPs by organization id | +| region | Default: `fr-par`
One of: `fr-par`, `nl-ams` | Region to target. If none is passed will use default region from the config | + + + +### Update an IP + +Update an IP. + +**Usage:** + +``` +scw lb ip update [arg=value ...] +``` + + +**Args:** + +| Name | | Description | +|------|---|-------------| +| ip-id | Required | IP address ID | +| reverse | | Reverse DNS | +| region | Default: `fr-par`
One of: `fr-par`, `nl-ams` | Region to target. If none is passed will use default region from the config | + + + +## Load-balancer management commands + +Load-balancer management commands. + + +### Create a load balancer + +Create a load balancer. + +**Usage:** + +``` +scw lb lb create [arg=value ...] +``` + + +**Args:** + +| Name | | Description | +|------|---|-------------| +| project-id | | Project ID to use. If none is passed the default project ID will be used | +| name | Required
Default: `` | Resource names | +| description | | Resource description | +| ip-id | | Just like for compute instances, when you destroy a load balancer, you can keep its highly available IP address and reuse it for another load balancer later | +| tags.{index} | | List of keyword | +| type | Default: `LB-S`
One of: `LB-S`, `LB-GP-M`, `LB-GP-L` | Load balancer offer type | +| ssl-compatibility-level | One of: `ssl_compatibility_level_unknown`, `ssl_compatibility_level_intermediate`, `ssl_compatibility_level_modern`, `ssl_compatibility_level_old` | | +| organization-id | | Organization ID to use. If none is passed the default organization ID will be used | +| region | Default: `fr-par`
One of: `fr-par`, `nl-ams` | Region to target. If none is passed will use default region from the config | + + + +### Delete a load balancer + +Delete a load balancer. + +**Usage:** + +``` +scw lb lb delete [arg=value ...] +``` + + +**Args:** + +| Name | | Description | +|------|---|-------------| +| lb-id | Required | Load balancer ID | +| release-ip | | Set true if you don't want to keep this IP address | +| region | Default: `fr-par`
One of: `fr-par`, `nl-ams` | Region to target. If none is passed will use default region from the config | + + + +### Get a load balancer + +Get a load balancer. + +**Usage:** + +``` +scw lb lb get [arg=value ...] +``` + + +**Args:** + +| Name | | Description | +|------|---|-------------| +| lb-id | Required | Load balancer ID | +| region | Default: `fr-par`
One of: `fr-par`, `nl-ams` | Region to target. If none is passed will use default region from the config | + + + +### Get usage statistics of a given load balancer + +Get usage statistics of a given load balancer. + +**Usage:** + +``` +scw lb lb get-stats [arg=value ...] +``` + + +**Args:** + +| Name | | Description | +|------|---|-------------| +| lb-id | Required | Load balancer ID | +| region | Default: `fr-par`
One of: `fr-par`, `nl-ams` | Region to target. If none is passed will use default region from the config | + + + +### List load balancers + +List load balancers. + +**Usage:** + +``` +scw lb lb list [arg=value ...] +``` + + +**Args:** + +| Name | | Description | +|------|---|-------------| +| name | | Use this to search by name | +| order-by | One of: `created_at_asc`, `created_at_desc`, `name_asc`, `name_desc` | | +| project-id | | Filter LBs by project ID | +| organization-id | | Filter LBs by organization ID | +| region | Default: `fr-par`
One of: `fr-par`, `nl-ams` | Region to target. If none is passed will use default region from the config | + + + +### Migrate a load balancer + +Migrate a load balancer. + +**Usage:** + +``` +scw lb lb migrate [arg=value ...] +``` + + +**Args:** + +| Name | | Description | +|------|---|-------------| +| lb-id | Required | Load balancer ID | +| type | Required
One of: `LB-S`, `LB-GP-M`, `LB-GP-L` | Load balancer type (check /lb-types to list all type) | +| region | Default: `fr-par`
One of: `fr-par`, `nl-ams` | Region to target. If none is passed will use default region from the config | + + + +### Update a load balancer + +Update a load balancer. + +**Usage:** + +``` +scw lb lb update [arg=value ...] +``` + + +**Args:** + +| Name | | Description | +|------|---|-------------| +| lb-id | Required | Load balancer ID | +| name | Required | Resource name | +| description | Required | Resource description | +| tags.{index} | | List of keywords | +| ssl-compatibility-level | One of: `ssl_compatibility_level_unknown`, `ssl_compatibility_level_intermediate`, `ssl_compatibility_level_modern`, `ssl_compatibility_level_old` | | +| region | Default: `fr-par`
One of: `fr-par`, `nl-ams` | Region to target. If none is passed will use default region from the config | + + + +### Wait for a load balancer to reach a stable state + +Wait for a load balancer to reach a stable state. This is similar to using --wait flag. + +**Usage:** + +``` +scw lb lb wait [arg=value ...] +``` + + +**Args:** + +| Name | | Description | +|------|---|-------------| +| lb-id | Required | ID of the load balancer you want to wait for. | +| region | Default: `fr-par`
One of: `fr-par`, `nl-ams` | Region to target. If none is passed will use default region from the config | + + +**Examples:** + + +Wait for a load balancer to reach a stable state +``` +scw lb lb wait 11111111-1111-1111-1111-111111111111 +``` + + + + +## Load-balancer types management commands + +Load-balancer types management commands. + + +### List all load balancer offer type + +List all load balancer offer type. + +**Usage:** + +``` +scw lb lb-types list [arg=value ...] +``` + + +**Args:** + +| Name | | Description | +|------|---|-------------| +| region | Default: `fr-par`
One of: `fr-par`, `nl-ams` | Region to target. If none is passed will use default region from the config | + + + diff --git a/docs/commands/rdb.md b/docs/commands/rdb.md index cb1acc0ca3..53315192c4 100644 --- a/docs/commands/rdb.md +++ b/docs/commands/rdb.md @@ -9,13 +9,13 @@ Database RDB API - [Backup management commands](#backup-management-commands) - [Create a database backup](#create-a-database-backup) - [Delete a database backup](#delete-a-database-backup) + - [Download a backup locally](#download-a-backup-locally) - [Export a database backup](#export-a-database-backup) - [Get a database backup](#get-a-database-backup) - [List database backups](#list-database-backups) - [Restore a database backup](#restore-a-database-backup) - [Update a database backup](#update-a-database-backup) -- [Instance TLS certificate management commands](#instance-tls-certificate-management-commands) - - [Get the TLS certificate of an instance](#get-the-tls-certificate-of-an-instance) + - [Wait for a backup to reach a stable state](#wait-for-a-backup-to-reach-a-stable-state) - [Database management commands](#database-management-commands) - [Create a database in a given instance](#create-a-database-in-a-given-instance) - [Delete a database in a given instance](#delete-a-database-in-a-given-instance) @@ -24,15 +24,17 @@ Database RDB API - [List available database engines](#list-available-database-engines) - [Instance management commands](#instance-management-commands) - [Clone an instance](#clone-an-instance) + - [Connect to an instance using locally installed CLI](#connect-to-an-instance-using-locally-installed-cli) - [Create an instance](#create-an-instance) - [Delete an instance](#delete-an-instance) - [Get an instance](#get-an-instance) + - [Get the TLS certificate of an instance](#get-the-tls-certificate-of-an-instance) - [List instances](#list-instances) - - [Get instance metrics](#get-instance-metrics) - [Update an instance](#update-an-instance) - [Upgrade an instance to an higher instance type](#upgrade-an-instance-to-an-higher-instance-type) - [Wait for an instance to reach a stable state](#wait-for-an-instance-to-reach-a-stable-state) - [Instance logs management commands](#instance-logs-management-commands) + - [Get specific logs of a given instance](#get-specific-logs-of-a-given-instance) - [List available logs of a given instance](#list-available-logs-of-a-given-instance) - [Prepare logs of a given instance](#prepare-logs-of-a-given-instance) - [Node types management commands](#node-types-management-commands) @@ -40,9 +42,6 @@ Database RDB API - [User privileges management commands](#user-privileges-management-commands) - [List privileges of a given user in a given database in a given instance](#list-privileges-of-a-given-user-in-a-given-database-in-a-given-instance) - [Set privileges of a given user in a given database in a given instance](#set-privileges-of-a-given-user-in-a-given-database-in-a-given-instance) -- [Settings management commands](#settings-management-commands) - - [Add an instance setting](#add-an-instance-setting) - - [Delete an instance setting](#delete-an-instance-setting) - [User management commands](#user-management-commands) - [Create an user in a given instance](#create-an-user-in-a-given-instance) - [Delete an user in a given instance](#delete-an-user-in-a-given-instance) @@ -63,7 +62,7 @@ Add an ACL instance to a given instance. **Usage:** ``` -scw rdb acl add [arg=value ...] +scw rdb acl add [arg=value ...] ``` @@ -85,7 +84,7 @@ Delete ACL rules of a given instance. **Usage:** ``` -scw rdb acl delete [arg=value ...] +scw rdb acl delete [arg=value ...] ``` @@ -106,7 +105,7 @@ List ACL rules of a given instance. **Usage:** ``` -scw rdb acl list [arg=value ...] +scw rdb acl list [arg=value ...] ``` @@ -142,7 +141,7 @@ scw rdb backup create [arg=value ...] |------|---|-------------| | instance-id | | UUID of the instance | | database-name | | Name of the database you want to make a backup of | -| name | | Name of the backup | +| name | Default: `` | Name of the backup | | expires-at | | Expiration date (Format ISO 8601) | | region | Default: `fr-par`
One of: `fr-par`, `nl-ams` | Region to target. If none is passed will use default region from the config | @@ -168,6 +167,37 @@ scw rdb backup delete [arg=value ...] +### Download a backup locally + +Download a backup locally. + +**Usage:** + +``` +scw rdb backup download [arg=value ...] +``` + + +**Args:** + +| Name | | Description | +|------|---|-------------| +| backup-id | Required | ID of the backup you want to download. | +| output | | Filename to write to | +| region | Default: `fr-par`
One of: `fr-par`, `nl-ams` | Region to target. If none is passed will use default region from the config | + + +**Examples:** + + +Download a backup +``` +scw rdb backup download 11111111-1111-1111-1111-111111111111 +``` + + + + ### Export a database backup Export a database backup. @@ -183,7 +213,7 @@ scw rdb backup export [arg=value ...] | Name | | Description | |------|---|-------------| -| database-backup-id | Required | | +| database-backup-id | Required | UUID of the database backup you want to export | | region | Default: `fr-par`
One of: `fr-par`, `nl-ams` | Region to target. If none is passed will use default region from the config | @@ -275,19 +305,14 @@ scw rdb backup update [arg=value ...] -## Instance TLS certificate management commands - -Instance TLS certificate management commands. - +### Wait for a backup to reach a stable state -### Get the TLS certificate of an instance - -Get the TLS certificate of an instance. +Wait for a backup to reach a stable state. This is similar to using --wait flag. **Usage:** ``` -scw rdb certificate get [arg=value ...] +scw rdb backup wait [arg=value ...] ``` @@ -295,10 +320,20 @@ scw rdb certificate get [arg=value ...] | Name | | Description | |------|---|-------------| -| instance-id | Required | UUID of the instance | +| backup-id | Required | ID of the backup you want to wait for. | | region | Default: `fr-par`
One of: `fr-par`, `nl-ams` | Region to target. If none is passed will use default region from the config | +**Examples:** + + +Wait for a backup to reach a stable state +``` +scw rdb backup wait 11111111-1111-1111-1111-111111111111 +``` + + + ## Database management commands @@ -313,7 +348,7 @@ Create a database in a given instance. **Usage:** ``` -scw rdb database create [arg=value ...] +scw rdb database create [arg=value ...] ``` @@ -355,7 +390,7 @@ List all database in a given instance. **Usage:** ``` -scw rdb database list [arg=value ...] +scw rdb database list [arg=value ...] ``` @@ -425,6 +460,29 @@ scw rdb instance clone [arg=value ...] +### Connect to an instance using locally installed CLI + +Connect to an instance using locally installed CLI such as psql or mysql. + +**Usage:** + +``` +scw rdb instance connect [arg=value ...] +``` + + +**Args:** + +| Name | | Description | +|------|---|-------------| +| instance-id | Required | UUID of the instance | +| username | Required | Name of the user to connect with to the database | +| database | Default: `rdb` | Name of the database | +| cli-db | | Command line tool to use, default to psql/mysql | +| region | Default: `fr-par`
One of: `fr-par`, `nl-ams` | Region to target. If none is passed will use default region from the config | + + + ### Create an instance Create an instance. @@ -440,7 +498,7 @@ scw rdb instance create [arg=value ...] | Name | | Description | |------|---|-------------| -| name | Required | Name of the instance | +| name | Default: `` | Name of the instance | | engine | Required | Database engine of the database (PostgreSQL, MySQL, ...) | | user-name | Required | Name of the user created when the instance is created | | password | Required | Password of the user | @@ -448,7 +506,9 @@ scw rdb instance create [arg=value ...] | is-ha-cluster | | Whether or not High-Availability is enabled | | disable-backup | | Whether or not backups are disabled | | tags.{index} | | Tags to apply to the instance | -| organization-id | | Organization ID to use. If none is passed will use default organization ID from the config | +| init-settings.{index}.name | | | +| init-settings.{index}.value | | | +| organization-id | | Organization ID to use. If none is passed the default organization ID will be used | | region | Default: `fr-par`
One of: `fr-par`, `nl-ams` | Region to target. If none is passed will use default region from the config | @@ -493,14 +553,14 @@ scw rdb instance get [arg=value ...] -### List instances +### Get the TLS certificate of an instance -List instances. +Get the TLS certificate of an instance. **Usage:** ``` -scw rdb instance list [arg=value ...] +scw rdb instance get-certificate [arg=value ...] ``` @@ -508,22 +568,19 @@ scw rdb instance list [arg=value ...] | Name | | Description | |------|---|-------------| -| tags.{index} | | List instance that have a given tags | -| name | | List instance that match a given name pattern | -| order-by | One of: `created_at_asc`, `created_at_desc`, `name_asc`, `name_desc`, `region`, `status_asc`, `status_desc` | Criteria to use when ordering instance listing | -| organization-id | | Organization ID to list the instance of | +| instance-id | Required | UUID of the instance | | region | Default: `fr-par`
One of: `fr-par`, `nl-ams` | Region to target. If none is passed will use default region from the config | -### Get instance metrics +### List instances -Get database instance metrics. +List instances. **Usage:** ``` -scw rdb instance metrics [arg=value ...] +scw rdb instance list [arg=value ...] ``` @@ -531,10 +588,10 @@ scw rdb instance metrics [arg=value ...] | Name | | Description | |------|---|-------------| -| instance-id | Required | UUID of the instance | -| start-date | | Start date to gather metrics from | -| end-date | | End date to gather metrics from | -| metric-name | | Name of the metric to gather | +| tags.{index} | | List instance that have a given tags | +| name | | List instance that match a given name pattern | +| order-by | One of: `created_at_asc`, `created_at_desc`, `name_asc`, `name_desc`, `region`, `status_asc`, `status_desc` | Criteria to use when ordering instance listing | +| organization-id | | Organization ID to list the instance of | | region | Default: `fr-par`
One of: `fr-par`, `nl-ams` | Region to target. If none is passed will use default region from the config | @@ -579,9 +636,9 @@ scw rdb instance upgrade [arg=value ...] | Name | | Description | |------|---|-------------| -| instance-id | Required | | -| node-type | One of: `DB-DEV-S`, `DB-DEV-M`, `DB-DEV-L`, `DB-DEV-XL`, `DB-GP-XS`, `DB-GP-S`, `DB-GP-M`, `DB-GP-L`, `DB-GP-XL` | | -| enable-ha | | | +| instance-id | Required | UUID of the instance you want to upgrade | +| node-type | One of: `DB-DEV-S`, `DB-DEV-M`, `DB-DEV-L`, `DB-DEV-XL`, `DB-GP-XS`, `DB-GP-S`, `DB-GP-M`, `DB-GP-L`, `DB-GP-XL` | Node type of the instance you want to upgrade to | +| enable-ha | | Set to true to enable high availability on your instance | | region | Default: `fr-par`
One of: `fr-par`, `nl-ams` | Region to target. If none is passed will use default region from the config | @@ -621,6 +678,26 @@ scw rdb instance wait 11111111-1111-1111-1111-111111111111 Instance logs management commands. +### Get specific logs of a given instance + +Get specific logs of a given instance. + +**Usage:** + +``` +scw rdb log get [arg=value ...] +``` + + +**Args:** + +| Name | | Description | +|------|---|-------------| +| instance-log-id | Required | UUID of the instance_log you want | +| region | Default: `fr-par`
One of: `fr-par`, `nl-ams` | Region to target. If none is passed will use default region from the config | + + + ### List available logs of a given instance List available logs of a given instance. @@ -628,7 +705,7 @@ List available logs of a given instance. **Usage:** ``` -scw rdb log list [arg=value ...] +scw rdb log list [arg=value ...] ``` @@ -636,8 +713,8 @@ scw rdb log list [arg=value ...] | Name | | Description | |------|---|-------------| -| instance-id | Required | | -| order-by | One of: `created_at_asc`, `created_at_desc` | | +| instance-id | Required | UUID of the instance you want logs of | +| order-by | One of: `created_at_asc`, `created_at_desc` | Criteria to use when ordering instance logs listing | | region | Default: `fr-par`
One of: `fr-par`, `nl-ams` | Region to target. If none is passed will use default region from the config | @@ -649,7 +726,7 @@ Prepare your instance logs. Logs will be grouped on a minimum interval of a day. **Usage:** ``` -scw rdb log prepare [arg=value ...] +scw rdb log prepare [arg=value ...] ``` @@ -703,7 +780,7 @@ List privileges of a given user in a given database in a given instance. **Usage:** ``` -scw rdb privilege list [arg=value ...] +scw rdb privilege list [arg=value ...] ``` @@ -726,7 +803,7 @@ Set privileges of a given user in a given database in a given instance. **Usage:** ``` -scw rdb privilege set [arg=value ...] +scw rdb privilege set [arg=value ...] ``` @@ -742,55 +819,6 @@ scw rdb privilege set [arg=value ...] -## Settings management commands - -Instance Settings are tunables of Database Engines. Available settings depend on the database engine and its version. - - - -### Add an instance setting - -Add an instance setting. - -**Usage:** - -``` -scw rdb settings add [arg=value ...] -``` - - -**Args:** - -| Name | | Description | -|------|---|-------------| -| instance-id | Required | UUID of the instance you want to add settings to | -| settings.{index}.name | | | -| settings.{index}.value | | | -| region | Default: `fr-par`
One of: `fr-par`, `nl-ams` | Region to target. If none is passed will use default region from the config | - - - -### Delete an instance setting - -Delete an instance setting. - -**Usage:** - -``` -scw rdb settings delete [arg=value ...] -``` - - -**Args:** - -| Name | | Description | -|------|---|-------------| -| instance-id | Required | UUID of the instance to delete settings from | -| setting-names.{index} | | Settings names to delete | -| region | Default: `fr-par`
One of: `fr-par`, `nl-ams` | Region to target. If none is passed will use default region from the config | - - - ## User management commands Manage users on your instance @@ -804,7 +832,7 @@ Create an user in a given instance. **Usage:** ``` -scw rdb user create [arg=value ...] +scw rdb user create [arg=value ...] ``` @@ -848,7 +876,7 @@ List users of a given instance. **Usage:** ``` -scw rdb user list [arg=value ...] +scw rdb user list [arg=value ...] ``` diff --git a/docs/commands/registry.md b/docs/commands/registry.md index 5692694483..fe643af90d 100644 --- a/docs/commands/registry.md +++ b/docs/commands/registry.md @@ -89,6 +89,7 @@ scw registry image list [arg=value ...] | order-by | One of: `created_at_asc`, `created_at_desc`, `name_asc`, `name_desc` | Field by which to order the display of Images | | namespace-id | | Filter by the Namespace ID | | name | | Filter by the Image name (exact match) | +| project-id | | Filter by Project ID | | organization-id | | Filter by Organization ID | | region | Default: `fr-par`
One of: `fr-par`, `nl-ams` | Region to target. If none is passed will use default region from the config | @@ -226,8 +227,9 @@ scw registry namespace create [arg=value ...] |------|---|-------------| | name | Required | Define a namespace name | | description | | Define a description | +| project-id | | Project ID to use. If none is passed the default project ID will be used | | is-public | | Define the default visibility policy | -| organization-id | | Organization ID to use. If none is passed will use default organization ID from the config | +| organization-id | | Organization ID to use. If none is passed the default organization ID will be used | | region | Default: `fr-par`
One of: `fr-par`, `nl-ams` | Region to target. If none is passed will use default region from the config | @@ -288,8 +290,9 @@ scw registry namespace list [arg=value ...] | Name | | Description | |------|---|-------------| | order-by | One of: `created_at_asc`, `created_at_desc`, `description_asc`, `description_desc`, `name_asc`, `name_desc` | Field by which to order the display of Images | +| project-id | | Filter by Project ID | | name | | Filter by the namespace name (exact match) | -| organization-id | | Filter by the namespace owner | +| organization-id | | Filter by Organization ID | | region | Default: `fr-par`
One of: `fr-par`, `nl-ams` | Region to target. If none is passed will use default region from the config | @@ -370,7 +373,7 @@ List all your tags. **Usage:** ``` -scw registry tag list [arg=value ...] +scw registry tag list [arg=value ...] ``` diff --git a/docs/commands/vpc.md b/docs/commands/vpc.md new file mode 100644 index 0000000000..e3f9f97bc1 --- /dev/null +++ b/docs/commands/vpc.md @@ -0,0 +1,132 @@ + +# Documentation for `scw vpc` +VPC API + +- [Private network management command](#private-network-management-command) + - [Create a private network](#create-a-private-network) + - [Delete a private network](#delete-a-private-network) + - [Get a private network](#get-a-private-network) + - [List private networks](#list-private-networks) + - [Update private network](#update-private-network) + + +## Private network management command + +A private network allows interconnecting your instances in an +isolated and private network. The network reachability is limited +to the instances that are on the same private network. Network +Interface Controllers (NICs) are available on the instance and can +be freely managed (adding IP addresses, shutdown interface...) + +Note that an instance can be a part of multiple private networks. + + + +### Create a private network + +Create a private network. + +**Usage:** + +``` +scw vpc private-network create [arg=value ...] +``` + + +**Args:** + +| Name | | Description | +|------|---|-------------| +| name | Required
Default: `` | The name of the private network | +| project-id | | Project ID to use. If none is passed the default project ID will be used | +| tags.{index} | | The private networks tags | +| zone | Default: `fr-par-1`
One of: `fr-par-1`, `nl-ams-1` | Zone to target. If none is passed will use default zone from the config | + + + +### Delete a private network + +Delete a private network. + +**Usage:** + +``` +scw vpc private-network delete [arg=value ...] +``` + + +**Args:** + +| Name | | Description | +|------|---|-------------| +| private-network-id | Required | The private network ID | +| zone | Default: `fr-par-1`
One of: `fr-par-1`, `nl-ams-1` | Zone to target. If none is passed will use default zone from the config | + + + +### Get a private network + +Get a private network. + +**Usage:** + +``` +scw vpc private-network get [arg=value ...] +``` + + +**Args:** + +| Name | | Description | +|------|---|-------------| +| private-network-id | Required | The private network id | +| zone | Default: `fr-par-1`
One of: `fr-par-1`, `nl-ams-1` | Zone to target. If none is passed will use default zone from the config | + + + +### List private networks + +List private networks. + +**Usage:** + +``` +scw vpc private-network list [arg=value ...] +``` + + +**Args:** + +| Name | | Description | +|------|---|-------------| +| order-by | One of: `created_at_asc`, `created_at_desc`, `name_asc`, `name_desc` | The sort order of the returned private networks | +| name | | Filter private networks with names containing this string | +| tags.{index} | | Filter private networks with one or more matching tags | +| project-id | | The project ID on which to filter the returned private networks | +| organization-id | | The organization ID on which to filter the returned private networks | +| zone | Default: `fr-par-1`
One of: `fr-par-1`, `nl-ams-1` | Zone to target. If none is passed will use default zone from the config | + + + +### Update private network + +Update private network. + +**Usage:** + +``` +scw vpc private-network update [arg=value ...] +``` + + +**Args:** + +| Name | | Description | +|------|---|-------------| +| private-network-id | Required | The private network ID | +| name | | The name of the private network | +| tags.{index} | | The private networks tags | +| zone | Default: `fr-par-1`
One of: `fr-par-1`, `nl-ams-1` | Zone to target. If none is passed will use default zone from the config | + + +