Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions doc/ovhcloud_iploadbalancing.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,4 +33,7 @@ Retrieve information and manage your IP LoadBalancing services
* [ovhcloud iploadbalancing edit](ovhcloud_iploadbalancing_edit.md) - Edit the given IpLoadbalancing
* [ovhcloud iploadbalancing get](ovhcloud_iploadbalancing_get.md) - Retrieve information of a specific IpLoadbalancing
* [ovhcloud iploadbalancing list](ovhcloud_iploadbalancing_list.md) - List your IpLoadbalancing services
* [ovhcloud iploadbalancing pending-changes](ovhcloud_iploadbalancing_pending-changes.md) - List pending changes per zone
* [ovhcloud iploadbalancing refresh](ovhcloud_iploadbalancing_refresh.md) - Apply the pending configuration changes of the given IpLoadbalancing
* [ovhcloud iploadbalancing ssl](ovhcloud_iploadbalancing_ssl.md) - Manage SSL certificates of your IpLoadbalancing services

44 changes: 44 additions & 0 deletions doc/ovhcloud_iploadbalancing_pending-changes.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
## ovhcloud iploadbalancing pending-changes

List pending changes per zone

```
ovhcloud iploadbalancing pending-changes <service_name> [flags]
```

### Options

```
--filter stringArray Filter results by any property using https://github.com/PaesslerAG/gval syntax
Examples:
--filter 'state=="running"'
--filter 'name=~"^my.*"'
--filter 'nested.property.subproperty>10'
--filter 'startDate>="2023-12-01"'
--filter 'name=~"something" && nbField>10'
-h, --help help for pending-changes
```

### Options inherited from parent commands

```
-d, --debug Activate debug mode (will log all HTTP requests details)
-e, --ignore-errors Ignore errors in API calls when it is not fatal to the execution
-o, --output string Output format: json, yaml, interactive, or a custom format expression (using https://github.com/PaesslerAG/gval syntax)
Examples:
--output json
--output yaml
--output interactive
--output 'id' (to extract a single field)
--output 'nested.field.subfield' (to extract a nested field)
--output '[id, "name"]' (to extract multiple fields as an array)
--output '{"newKey": oldKey, "otherKey": nested.field}' (to extract and rename fields in an object)
--output 'name+","+type' (to extract and concatenate fields in a string)
--output '(nbFieldA + nbFieldB) * 10' (to compute values from numeric fields)
--profile string Use a specific profile from the configuration file
```

### SEE ALSO

* [ovhcloud iploadbalancing](ovhcloud_iploadbalancing.md) - Retrieve information and manage your IP LoadBalancing services

38 changes: 38 additions & 0 deletions doc/ovhcloud_iploadbalancing_refresh.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
## ovhcloud iploadbalancing refresh

Apply the pending configuration changes of the given IpLoadbalancing

```
ovhcloud iploadbalancing refresh <service_name> [flags]
```

### Options

```
-h, --help help for refresh
--zone string Zone to apply the configuration to (all zones if not set)
```

### Options inherited from parent commands

```
-d, --debug Activate debug mode (will log all HTTP requests details)
-e, --ignore-errors Ignore errors in API calls when it is not fatal to the execution
-o, --output string Output format: json, yaml, interactive, or a custom format expression (using https://github.com/PaesslerAG/gval syntax)
Examples:
--output json
--output yaml
--output interactive
--output 'id' (to extract a single field)
--output 'nested.field.subfield' (to extract a nested field)
--output '[id, "name"]' (to extract multiple fields as an array)
--output '{"newKey": oldKey, "otherKey": nested.field}' (to extract and rename fields in an object)
--output 'name+","+type' (to extract and concatenate fields in a string)
--output '(nbFieldA + nbFieldB) * 10' (to compute values from numeric fields)
--profile string Use a specific profile from the configuration file
```

### SEE ALSO

* [ovhcloud iploadbalancing](ovhcloud_iploadbalancing.md) - Retrieve information and manage your IP LoadBalancing services

37 changes: 37 additions & 0 deletions doc/ovhcloud_iploadbalancing_ssl.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
## ovhcloud iploadbalancing ssl

Manage SSL certificates of your IpLoadbalancing services

### Options

```
-h, --help help for ssl
```

### Options inherited from parent commands

```
-d, --debug Activate debug mode (will log all HTTP requests details)
-e, --ignore-errors Ignore errors in API calls when it is not fatal to the execution
-o, --output string Output format: json, yaml, interactive, or a custom format expression (using https://github.com/PaesslerAG/gval syntax)
Examples:
--output json
--output yaml
--output interactive
--output 'id' (to extract a single field)
--output 'nested.field.subfield' (to extract a nested field)
--output '[id, "name"]' (to extract multiple fields as an array)
--output '{"newKey": oldKey, "otherKey": nested.field}' (to extract and rename fields in an object)
--output 'name+","+type' (to extract and concatenate fields in a string)
--output '(nbFieldA + nbFieldB) * 10' (to compute values from numeric fields)
--profile string Use a specific profile from the configuration file
```

### SEE ALSO

* [ovhcloud iploadbalancing](ovhcloud_iploadbalancing.md) - Retrieve information and manage your IP LoadBalancing services
* [ovhcloud iploadbalancing ssl create](ovhcloud_iploadbalancing_ssl_create.md) - Add a new custom SSL certificate on the given IpLoadbalancing
* [ovhcloud iploadbalancing ssl delete](ovhcloud_iploadbalancing_ssl_delete.md) - Delete a custom SSL certificate of the given IpLoadbalancing
* [ovhcloud iploadbalancing ssl get](ovhcloud_iploadbalancing_ssl_get.md) - Retrieve information of a specific SSL certificate of the given IpLoadbalancing
* [ovhcloud iploadbalancing ssl list](ovhcloud_iploadbalancing_ssl_list.md) - List SSL certificate IDs of the given IpLoadbalancing

85 changes: 85 additions & 0 deletions doc/ovhcloud_iploadbalancing_ssl_create.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,85 @@
## ovhcloud iploadbalancing ssl create

Add a new custom SSL certificate on the given IpLoadbalancing

### Synopsis

Use this command to add a new custom SSL certificate on the given IpLoadbalancing.
There are three ways to define the creation parameters:

1. Using only CLI flags:

ovhcloud iploadbalancing ssl create <service_name> --certificate "$(cat cert.pem)" --key "$(cat key.pem)"

2. Using a configuration file:

First you can generate an example of parameters file using the following command:

ovhcloud iploadbalancing ssl create <service_name> --init-file ./params.json

You will be able to choose from several examples of parameters. Once an example has been selected, the content is written in the given file.
After editing the file to set the correct creation parameters, run:

ovhcloud iploadbalancing ssl create <service_name> --from-file ./params.json

Note that you can also pipe the content of the parameters file, like the following:

cat ./params.json | ovhcloud iploadbalancing ssl create <service_name>

In both cases, you can override the parameters in the given file using command line flags, for example:

ovhcloud iploadbalancing ssl create <service_name> --from-file ./params.json --display-name nameoverriden

3. Using your default text editor:

ovhcloud iploadbalancing ssl create <service_name> --editor

You will be able to choose from several examples of parameters. Once an example has been selected, the CLI will open your
default text editor to update the parameters. When saving the file, the creation will start.

Note that it is also possible to override values in the presented examples using command line flags like the following:

ovhcloud iploadbalancing ssl create <service_name> --editor --display-name nameoverriden


```
ovhcloud iploadbalancing ssl create <service_name> [flags]
```

### Options

```
--certificate string SSL certificate (PEM)
--chain string SSL certificate chain (PEM)
--display-name string Human readable name for your SSL certificate
--editor Use a text editor to define parameters
--from-file string File containing parameters
-h, --help help for create
--init-file string Create a file with example parameters
--key string SSL private key (PEM)
--replace Replace parameters file if it already exists
```

### Options inherited from parent commands

```
-d, --debug Activate debug mode (will log all HTTP requests details)
-e, --ignore-errors Ignore errors in API calls when it is not fatal to the execution
-o, --output string Output format: json, yaml, interactive, or a custom format expression (using https://github.com/PaesslerAG/gval syntax)
Examples:
--output json
--output yaml
--output interactive
--output 'id' (to extract a single field)
--output 'nested.field.subfield' (to extract a nested field)
--output '[id, "name"]' (to extract multiple fields as an array)
--output '{"newKey": oldKey, "otherKey": nested.field}' (to extract and rename fields in an object)
--output 'name+","+type' (to extract and concatenate fields in a string)
--output '(nbFieldA + nbFieldB) * 10' (to compute values from numeric fields)
--profile string Use a specific profile from the configuration file
```

### SEE ALSO

* [ovhcloud iploadbalancing ssl](ovhcloud_iploadbalancing_ssl.md) - Manage SSL certificates of your IpLoadbalancing services

37 changes: 37 additions & 0 deletions doc/ovhcloud_iploadbalancing_ssl_delete.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
## ovhcloud iploadbalancing ssl delete

Delete a custom SSL certificate of the given IpLoadbalancing

```
ovhcloud iploadbalancing ssl delete <service_name> <ssl_id> [flags]
```

### Options

```
-h, --help help for delete
```

### Options inherited from parent commands

```
-d, --debug Activate debug mode (will log all HTTP requests details)
-e, --ignore-errors Ignore errors in API calls when it is not fatal to the execution
-o, --output string Output format: json, yaml, interactive, or a custom format expression (using https://github.com/PaesslerAG/gval syntax)
Examples:
--output json
--output yaml
--output interactive
--output 'id' (to extract a single field)
--output 'nested.field.subfield' (to extract a nested field)
--output '[id, "name"]' (to extract multiple fields as an array)
--output '{"newKey": oldKey, "otherKey": nested.field}' (to extract and rename fields in an object)
--output 'name+","+type' (to extract and concatenate fields in a string)
--output '(nbFieldA + nbFieldB) * 10' (to compute values from numeric fields)
--profile string Use a specific profile from the configuration file
```

### SEE ALSO

* [ovhcloud iploadbalancing ssl](ovhcloud_iploadbalancing_ssl.md) - Manage SSL certificates of your IpLoadbalancing services

37 changes: 37 additions & 0 deletions doc/ovhcloud_iploadbalancing_ssl_get.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
## ovhcloud iploadbalancing ssl get

Retrieve information of a specific SSL certificate of the given IpLoadbalancing

```
ovhcloud iploadbalancing ssl get <service_name> <ssl_id> [flags]
```

### Options

```
-h, --help help for get
```

### Options inherited from parent commands

```
-d, --debug Activate debug mode (will log all HTTP requests details)
-e, --ignore-errors Ignore errors in API calls when it is not fatal to the execution
-o, --output string Output format: json, yaml, interactive, or a custom format expression (using https://github.com/PaesslerAG/gval syntax)
Examples:
--output json
--output yaml
--output interactive
--output 'id' (to extract a single field)
--output 'nested.field.subfield' (to extract a nested field)
--output '[id, "name"]' (to extract multiple fields as an array)
--output '{"newKey": oldKey, "otherKey": nested.field}' (to extract and rename fields in an object)
--output 'name+","+type' (to extract and concatenate fields in a string)
--output '(nbFieldA + nbFieldB) * 10' (to compute values from numeric fields)
--profile string Use a specific profile from the configuration file
```

### SEE ALSO

* [ovhcloud iploadbalancing ssl](ovhcloud_iploadbalancing_ssl.md) - Manage SSL certificates of your IpLoadbalancing services

37 changes: 37 additions & 0 deletions doc/ovhcloud_iploadbalancing_ssl_list.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
## ovhcloud iploadbalancing ssl list

List SSL certificate IDs of the given IpLoadbalancing

```
ovhcloud iploadbalancing ssl list <service_name> [flags]
```

### Options

```
-h, --help help for list
```

### Options inherited from parent commands

```
-d, --debug Activate debug mode (will log all HTTP requests details)
-e, --ignore-errors Ignore errors in API calls when it is not fatal to the execution
-o, --output string Output format: json, yaml, interactive, or a custom format expression (using https://github.com/PaesslerAG/gval syntax)
Examples:
--output json
--output yaml
--output interactive
--output 'id' (to extract a single field)
--output 'nested.field.subfield' (to extract a nested field)
--output '[id, "name"]' (to extract multiple fields as an array)
--output '{"newKey": oldKey, "otherKey": nested.field}' (to extract and rename fields in an object)
--output 'name+","+type' (to extract and concatenate fields in a string)
--output '(nbFieldA + nbFieldB) * 10' (to compute values from numeric fields)
--profile string Use a specific profile from the configuration file
```

### SEE ALSO

* [ovhcloud iploadbalancing ssl](ovhcloud_iploadbalancing_ssl.md) - Manage SSL certificates of your IpLoadbalancing services

Loading