Skip to content
Merged
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
10 changes: 10 additions & 0 deletions doc/ovhcloud_cloud_loadbalancer.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,17 @@ Manage loadbalancers in the given cloud project
### SEE ALSO

* [ovhcloud cloud](ovhcloud_cloud.md) - Manage your projects and services in the Public Cloud universe (MKS, MPR, MRS, Object Storage...)
* [ovhcloud cloud loadbalancer associate-floating-ip](ovhcloud_cloud_loadbalancer_associate-floating-ip.md) - Associate an existing floating IP to a loadbalancer
* [ovhcloud cloud loadbalancer create](ovhcloud_cloud_loadbalancer_create.md) - Create a loadbalancer in the given cloud project
* [ovhcloud cloud loadbalancer create-floating-ip](ovhcloud_cloud_loadbalancer_create-floating-ip.md) - Create a floating IP and attach it to a loadbalancer
* [ovhcloud cloud loadbalancer delete](ovhcloud_cloud_loadbalancer_delete.md) - Delete a specific loadbalancer
* [ovhcloud cloud loadbalancer edit](ovhcloud_cloud_loadbalancer_edit.md) - Edit the given loadbalancer
* [ovhcloud cloud loadbalancer get](ovhcloud_cloud_loadbalancer_get.md) - Get a specific loadbalancer
* [ovhcloud cloud loadbalancer health-monitor](ovhcloud_cloud_loadbalancer_health-monitor.md) - Manage health monitors of loadbalancers
* [ovhcloud cloud loadbalancer l7policy](ovhcloud_cloud_loadbalancer_l7policy.md) - Manage L7 policies of loadbalancers
* [ovhcloud cloud loadbalancer list](ovhcloud_cloud_loadbalancer_list.md) - List your loadbalancers
* [ovhcloud cloud loadbalancer listener](ovhcloud_cloud_loadbalancer_listener.md) - Manage listeners of loadbalancers
* [ovhcloud cloud loadbalancer log](ovhcloud_cloud_loadbalancer_log.md) - Manage loadbalancer logs
* [ovhcloud cloud loadbalancer pool](ovhcloud_cloud_loadbalancer_pool.md) - Manage pools of loadbalancers
* [ovhcloud cloud loadbalancer stats](ovhcloud_cloud_loadbalancer_stats.md) - Get statistics for a loadbalancer

43 changes: 43 additions & 0 deletions doc/ovhcloud_cloud_loadbalancer_associate-floating-ip.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
## ovhcloud cloud loadbalancer associate-floating-ip

Associate an existing floating IP to a loadbalancer

```
ovhcloud cloud loadbalancer associate-floating-ip <loadbalancer_id> [flags]
```

### Options

```
--editor Use a text editor to define parameters
--floating-ip-id string Floating IP ID
--from-file string File containing parameters
-h, --help help for associate-floating-ip
--init-file string Create a file with example parameters
--ip string Private loadbalancer IP to associate the floating IP with
--replace Replace parameters file if it already exists
```

### Options inherited from parent commands

```
--cloud-project string Cloud project ID
-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)
```

### SEE ALSO

* [ovhcloud cloud loadbalancer](ovhcloud_cloud_loadbalancer.md) - Manage loadbalancers in the given cloud project

42 changes: 42 additions & 0 deletions doc/ovhcloud_cloud_loadbalancer_create-floating-ip.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
## ovhcloud cloud loadbalancer create-floating-ip

Create a floating IP and attach it to a loadbalancer

```
ovhcloud cloud loadbalancer create-floating-ip <loadbalancer_id> [flags]
```

### Options

```
--editor Use a text editor to define parameters
--from-file string File containing parameters
-h, --help help for create-floating-ip
--init-file string Create a file with example parameters
--ip string Private loadbalancer IP to associate the floating IP with
--replace Replace parameters file if it already exists
```

### Options inherited from parent commands

```
--cloud-project string Cloud project ID
-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)
```

### SEE ALSO

* [ovhcloud cloud loadbalancer](ovhcloud_cloud_loadbalancer.md) - Manage loadbalancers in the given cloud project

73 changes: 73 additions & 0 deletions doc/ovhcloud_cloud_loadbalancer_create.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,73 @@
## ovhcloud cloud loadbalancer create

Create a loadbalancer in the given cloud project

### Synopsis

Use this command to create a loadbalancer.
There are three ways to define the parameters:

1. Using a configuration file:

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

ovhcloud cloud loadbalancer create <region> --init-file ./params.json

After editing the file to set the correct creation parameters, run:

ovhcloud cloud loadbalancer create <region> --from-file ./params.json

Note that you can also pipe the content of the parameters file.

2. Using your default text editor:

ovhcloud cloud loadbalancer create <region> --editor

3. Using only CLI flags:

ovhcloud cloud loadbalancer create <region> --name my-lb --flavor <flavor_id>


```
ovhcloud cloud loadbalancer create <region> [flags]
```

### Options

```
--editor Use a text editor to define parameters
--flavor string Flavor ID (can be retrieved with 'cloud reference loadbalancer list-flavors <region>')
--floating-ip string Floating IP ID to associate to the loadbalancer
--from-file string File containing parameters
--gateway string Gateway ID to associate to the loadbalancer
-h, --help help for create
--init-file string Create a file with example parameters
--name string Name of the loadbalancer
--network-id string Network ID
--replace Replace parameters file if it already exists
--subnet-id string Subnet ID
```

### Options inherited from parent commands

```
--cloud-project string Cloud project ID
-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)
```

### SEE ALSO

* [ovhcloud cloud loadbalancer](ovhcloud_cloud_loadbalancer.md) - Manage loadbalancers in the given cloud project

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

Delete a specific loadbalancer

```
ovhcloud cloud loadbalancer delete <loadbalancer_id> [flags]
```

### Options

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

### Options inherited from parent commands

```
--cloud-project string Cloud project ID
-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)
```

### SEE ALSO

* [ovhcloud cloud loadbalancer](ovhcloud_cloud_loadbalancer.md) - Manage loadbalancers in the given cloud project

38 changes: 38 additions & 0 deletions doc/ovhcloud_cloud_loadbalancer_health-monitor.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
## ovhcloud cloud loadbalancer health-monitor

Manage health monitors of loadbalancers

### Options

```
-h, --help help for health-monitor
```

### Options inherited from parent commands

```
--cloud-project string Cloud project ID
-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)
```

### SEE ALSO

* [ovhcloud cloud loadbalancer](ovhcloud_cloud_loadbalancer.md) - Manage loadbalancers in the given cloud project
* [ovhcloud cloud loadbalancer health-monitor create](ovhcloud_cloud_loadbalancer_health-monitor_create.md) - Create a health monitor in the given region
* [ovhcloud cloud loadbalancer health-monitor delete](ovhcloud_cloud_loadbalancer_health-monitor_delete.md) - Delete a specific health monitor
* [ovhcloud cloud loadbalancer health-monitor edit](ovhcloud_cloud_loadbalancer_health-monitor_edit.md) - Edit a specific health monitor
* [ovhcloud cloud loadbalancer health-monitor get](ovhcloud_cloud_loadbalancer_health-monitor_get.md) - Get a specific health monitor
* [ovhcloud cloud loadbalancer health-monitor list](ovhcloud_cloud_loadbalancer_health-monitor_list.md) - List all health monitors

48 changes: 48 additions & 0 deletions doc/ovhcloud_cloud_loadbalancer_health-monitor_create.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
## ovhcloud cloud loadbalancer health-monitor create

Create a health monitor in the given region

```
ovhcloud cloud loadbalancer health-monitor create <region> [flags]
```

### Options

```
--delay int Duration between sending probes to members, in seconds
--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
--max-retries int Number of successful checks before changing status to ONLINE
--max-retries-down int Number of allowed check failures before changing status to ERROR
--monitor-type string Type of the monitor (http, https, ping, tcp, tls-hello, udp-connect, sctp)
--name string Name of the health monitor
--pool-id string Pool ID
--replace Replace parameters file if it already exists
--timeout int Maximum time in seconds to connect before timeout
```

### Options inherited from parent commands

```
--cloud-project string Cloud project ID
-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)
```

### SEE ALSO

* [ovhcloud cloud loadbalancer health-monitor](ovhcloud_cloud_loadbalancer_health-monitor.md) - Manage health monitors of loadbalancers

37 changes: 37 additions & 0 deletions doc/ovhcloud_cloud_loadbalancer_health-monitor_delete.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
## ovhcloud cloud loadbalancer health-monitor delete

Delete a specific health monitor

```
ovhcloud cloud loadbalancer health-monitor delete <health_monitor_id> [flags]
```

### Options

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

### Options inherited from parent commands

```
--cloud-project string Cloud project ID
-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)
```

### SEE ALSO

* [ovhcloud cloud loadbalancer health-monitor](ovhcloud_cloud_loadbalancer_health-monitor.md) - Manage health monitors of loadbalancers

43 changes: 43 additions & 0 deletions doc/ovhcloud_cloud_loadbalancer_health-monitor_edit.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
## ovhcloud cloud loadbalancer health-monitor edit

Edit a specific health monitor

```
ovhcloud cloud loadbalancer health-monitor edit <health_monitor_id> [flags]
```

### Options

```
--delay int Duration between sending probes to members, in seconds
--editor Use a text editor to define parameters
-h, --help help for edit
--max-retries int Number of successful checks before changing status to ONLINE
--max-retries-down int Number of allowed check failures before changing status to ERROR
--name string Name of the health monitor
--timeout int Maximum time in seconds to connect before timeout
```

### Options inherited from parent commands

```
--cloud-project string Cloud project ID
-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)
```

### SEE ALSO

* [ovhcloud cloud loadbalancer health-monitor](ovhcloud_cloud_loadbalancer_health-monitor.md) - Manage health monitors of loadbalancers

Loading
Loading