Skip to content

Commit 0c50bb5

Browse files
authored
Merge pull request #146 from ovh/dev/aamstutz/new-lb-cmds
Dev/aamstutz/new lb cmds
2 parents eb82847 + 8e796ce commit 0c50bb5

File tree

83 files changed

+5290
-116
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

83 files changed

+5290
-116
lines changed

doc/ovhcloud_cloud_loadbalancer.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,17 @@ Manage loadbalancers in the given cloud project
3030
### SEE ALSO
3131

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

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
## ovhcloud cloud loadbalancer associate-floating-ip
2+
3+
Associate an existing floating IP to a loadbalancer
4+
5+
```
6+
ovhcloud cloud loadbalancer associate-floating-ip <loadbalancer_id> [flags]
7+
```
8+
9+
### Options
10+
11+
```
12+
--editor Use a text editor to define parameters
13+
--floating-ip-id string Floating IP ID
14+
--from-file string File containing parameters
15+
-h, --help help for associate-floating-ip
16+
--init-file string Create a file with example parameters
17+
--ip string Private loadbalancer IP to associate the floating IP with
18+
--replace Replace parameters file if it already exists
19+
```
20+
21+
### Options inherited from parent commands
22+
23+
```
24+
--cloud-project string Cloud project ID
25+
-d, --debug Activate debug mode (will log all HTTP requests details)
26+
-e, --ignore-errors Ignore errors in API calls when it is not fatal to the execution
27+
-o, --output string Output format: json, yaml, interactive, or a custom format expression (using https://github.com/PaesslerAG/gval syntax)
28+
Examples:
29+
--output json
30+
--output yaml
31+
--output interactive
32+
--output 'id' (to extract a single field)
33+
--output 'nested.field.subfield' (to extract a nested field)
34+
--output '[id, "name"]' (to extract multiple fields as an array)
35+
--output '{"newKey": oldKey, "otherKey": nested.field}' (to extract and rename fields in an object)
36+
--output 'name+","+type' (to extract and concatenate fields in a string)
37+
--output '(nbFieldA + nbFieldB) * 10' (to compute values from numeric fields)
38+
```
39+
40+
### SEE ALSO
41+
42+
* [ovhcloud cloud loadbalancer](ovhcloud_cloud_loadbalancer.md) - Manage loadbalancers in the given cloud project
43+
Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
## ovhcloud cloud loadbalancer create-floating-ip
2+
3+
Create a floating IP and attach it to a loadbalancer
4+
5+
```
6+
ovhcloud cloud loadbalancer create-floating-ip <loadbalancer_id> [flags]
7+
```
8+
9+
### Options
10+
11+
```
12+
--editor Use a text editor to define parameters
13+
--from-file string File containing parameters
14+
-h, --help help for create-floating-ip
15+
--init-file string Create a file with example parameters
16+
--ip string Private loadbalancer IP to associate the floating IP with
17+
--replace Replace parameters file if it already exists
18+
```
19+
20+
### Options inherited from parent commands
21+
22+
```
23+
--cloud-project string Cloud project ID
24+
-d, --debug Activate debug mode (will log all HTTP requests details)
25+
-e, --ignore-errors Ignore errors in API calls when it is not fatal to the execution
26+
-o, --output string Output format: json, yaml, interactive, or a custom format expression (using https://github.com/PaesslerAG/gval syntax)
27+
Examples:
28+
--output json
29+
--output yaml
30+
--output interactive
31+
--output 'id' (to extract a single field)
32+
--output 'nested.field.subfield' (to extract a nested field)
33+
--output '[id, "name"]' (to extract multiple fields as an array)
34+
--output '{"newKey": oldKey, "otherKey": nested.field}' (to extract and rename fields in an object)
35+
--output 'name+","+type' (to extract and concatenate fields in a string)
36+
--output '(nbFieldA + nbFieldB) * 10' (to compute values from numeric fields)
37+
```
38+
39+
### SEE ALSO
40+
41+
* [ovhcloud cloud loadbalancer](ovhcloud_cloud_loadbalancer.md) - Manage loadbalancers in the given cloud project
42+
Lines changed: 73 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,73 @@
1+
## ovhcloud cloud loadbalancer create
2+
3+
Create a loadbalancer in the given cloud project
4+
5+
### Synopsis
6+
7+
Use this command to create a loadbalancer.
8+
There are three ways to define the parameters:
9+
10+
1. Using a configuration file:
11+
12+
First you can generate an example of parameters file using the following command:
13+
14+
ovhcloud cloud loadbalancer create <region> --init-file ./params.json
15+
16+
After editing the file to set the correct creation parameters, run:
17+
18+
ovhcloud cloud loadbalancer create <region> --from-file ./params.json
19+
20+
Note that you can also pipe the content of the parameters file.
21+
22+
2. Using your default text editor:
23+
24+
ovhcloud cloud loadbalancer create <region> --editor
25+
26+
3. Using only CLI flags:
27+
28+
ovhcloud cloud loadbalancer create <region> --name my-lb --flavor <flavor_id>
29+
30+
31+
```
32+
ovhcloud cloud loadbalancer create <region> [flags]
33+
```
34+
35+
### Options
36+
37+
```
38+
--editor Use a text editor to define parameters
39+
--flavor string Flavor ID (can be retrieved with 'cloud reference loadbalancer list-flavors <region>')
40+
--floating-ip string Floating IP ID to associate to the loadbalancer
41+
--from-file string File containing parameters
42+
--gateway string Gateway ID to associate to the loadbalancer
43+
-h, --help help for create
44+
--init-file string Create a file with example parameters
45+
--name string Name of the loadbalancer
46+
--network-id string Network ID
47+
--replace Replace parameters file if it already exists
48+
--subnet-id string Subnet ID
49+
```
50+
51+
### Options inherited from parent commands
52+
53+
```
54+
--cloud-project string Cloud project ID
55+
-d, --debug Activate debug mode (will log all HTTP requests details)
56+
-e, --ignore-errors Ignore errors in API calls when it is not fatal to the execution
57+
-o, --output string Output format: json, yaml, interactive, or a custom format expression (using https://github.com/PaesslerAG/gval syntax)
58+
Examples:
59+
--output json
60+
--output yaml
61+
--output interactive
62+
--output 'id' (to extract a single field)
63+
--output 'nested.field.subfield' (to extract a nested field)
64+
--output '[id, "name"]' (to extract multiple fields as an array)
65+
--output '{"newKey": oldKey, "otherKey": nested.field}' (to extract and rename fields in an object)
66+
--output 'name+","+type' (to extract and concatenate fields in a string)
67+
--output '(nbFieldA + nbFieldB) * 10' (to compute values from numeric fields)
68+
```
69+
70+
### SEE ALSO
71+
72+
* [ovhcloud cloud loadbalancer](ovhcloud_cloud_loadbalancer.md) - Manage loadbalancers in the given cloud project
73+
Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
## ovhcloud cloud loadbalancer delete
2+
3+
Delete a specific loadbalancer
4+
5+
```
6+
ovhcloud cloud loadbalancer delete <loadbalancer_id> [flags]
7+
```
8+
9+
### Options
10+
11+
```
12+
-h, --help help for delete
13+
```
14+
15+
### Options inherited from parent commands
16+
17+
```
18+
--cloud-project string Cloud project ID
19+
-d, --debug Activate debug mode (will log all HTTP requests details)
20+
-e, --ignore-errors Ignore errors in API calls when it is not fatal to the execution
21+
-o, --output string Output format: json, yaml, interactive, or a custom format expression (using https://github.com/PaesslerAG/gval syntax)
22+
Examples:
23+
--output json
24+
--output yaml
25+
--output interactive
26+
--output 'id' (to extract a single field)
27+
--output 'nested.field.subfield' (to extract a nested field)
28+
--output '[id, "name"]' (to extract multiple fields as an array)
29+
--output '{"newKey": oldKey, "otherKey": nested.field}' (to extract and rename fields in an object)
30+
--output 'name+","+type' (to extract and concatenate fields in a string)
31+
--output '(nbFieldA + nbFieldB) * 10' (to compute values from numeric fields)
32+
```
33+
34+
### SEE ALSO
35+
36+
* [ovhcloud cloud loadbalancer](ovhcloud_cloud_loadbalancer.md) - Manage loadbalancers in the given cloud project
37+
Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
## ovhcloud cloud loadbalancer health-monitor
2+
3+
Manage health monitors of loadbalancers
4+
5+
### Options
6+
7+
```
8+
-h, --help help for health-monitor
9+
```
10+
11+
### Options inherited from parent commands
12+
13+
```
14+
--cloud-project string Cloud project ID
15+
-d, --debug Activate debug mode (will log all HTTP requests details)
16+
-e, --ignore-errors Ignore errors in API calls when it is not fatal to the execution
17+
-o, --output string Output format: json, yaml, interactive, or a custom format expression (using https://github.com/PaesslerAG/gval syntax)
18+
Examples:
19+
--output json
20+
--output yaml
21+
--output interactive
22+
--output 'id' (to extract a single field)
23+
--output 'nested.field.subfield' (to extract a nested field)
24+
--output '[id, "name"]' (to extract multiple fields as an array)
25+
--output '{"newKey": oldKey, "otherKey": nested.field}' (to extract and rename fields in an object)
26+
--output 'name+","+type' (to extract and concatenate fields in a string)
27+
--output '(nbFieldA + nbFieldB) * 10' (to compute values from numeric fields)
28+
```
29+
30+
### SEE ALSO
31+
32+
* [ovhcloud cloud loadbalancer](ovhcloud_cloud_loadbalancer.md) - Manage loadbalancers in the given cloud project
33+
* [ovhcloud cloud loadbalancer health-monitor create](ovhcloud_cloud_loadbalancer_health-monitor_create.md) - Create a health monitor in the given region
34+
* [ovhcloud cloud loadbalancer health-monitor delete](ovhcloud_cloud_loadbalancer_health-monitor_delete.md) - Delete a specific health monitor
35+
* [ovhcloud cloud loadbalancer health-monitor edit](ovhcloud_cloud_loadbalancer_health-monitor_edit.md) - Edit a specific health monitor
36+
* [ovhcloud cloud loadbalancer health-monitor get](ovhcloud_cloud_loadbalancer_health-monitor_get.md) - Get a specific health monitor
37+
* [ovhcloud cloud loadbalancer health-monitor list](ovhcloud_cloud_loadbalancer_health-monitor_list.md) - List all health monitors
38+
Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
## ovhcloud cloud loadbalancer health-monitor create
2+
3+
Create a health monitor in the given region
4+
5+
```
6+
ovhcloud cloud loadbalancer health-monitor create <region> [flags]
7+
```
8+
9+
### Options
10+
11+
```
12+
--delay int Duration between sending probes to members, in seconds
13+
--editor Use a text editor to define parameters
14+
--from-file string File containing parameters
15+
-h, --help help for create
16+
--init-file string Create a file with example parameters
17+
--max-retries int Number of successful checks before changing status to ONLINE
18+
--max-retries-down int Number of allowed check failures before changing status to ERROR
19+
--monitor-type string Type of the monitor (http, https, ping, tcp, tls-hello, udp-connect, sctp)
20+
--name string Name of the health monitor
21+
--pool-id string Pool ID
22+
--replace Replace parameters file if it already exists
23+
--timeout int Maximum time in seconds to connect before timeout
24+
```
25+
26+
### Options inherited from parent commands
27+
28+
```
29+
--cloud-project string Cloud project ID
30+
-d, --debug Activate debug mode (will log all HTTP requests details)
31+
-e, --ignore-errors Ignore errors in API calls when it is not fatal to the execution
32+
-o, --output string Output format: json, yaml, interactive, or a custom format expression (using https://github.com/PaesslerAG/gval syntax)
33+
Examples:
34+
--output json
35+
--output yaml
36+
--output interactive
37+
--output 'id' (to extract a single field)
38+
--output 'nested.field.subfield' (to extract a nested field)
39+
--output '[id, "name"]' (to extract multiple fields as an array)
40+
--output '{"newKey": oldKey, "otherKey": nested.field}' (to extract and rename fields in an object)
41+
--output 'name+","+type' (to extract and concatenate fields in a string)
42+
--output '(nbFieldA + nbFieldB) * 10' (to compute values from numeric fields)
43+
```
44+
45+
### SEE ALSO
46+
47+
* [ovhcloud cloud loadbalancer health-monitor](ovhcloud_cloud_loadbalancer_health-monitor.md) - Manage health monitors of loadbalancers
48+
Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
## ovhcloud cloud loadbalancer health-monitor delete
2+
3+
Delete a specific health monitor
4+
5+
```
6+
ovhcloud cloud loadbalancer health-monitor delete <health_monitor_id> [flags]
7+
```
8+
9+
### Options
10+
11+
```
12+
-h, --help help for delete
13+
```
14+
15+
### Options inherited from parent commands
16+
17+
```
18+
--cloud-project string Cloud project ID
19+
-d, --debug Activate debug mode (will log all HTTP requests details)
20+
-e, --ignore-errors Ignore errors in API calls when it is not fatal to the execution
21+
-o, --output string Output format: json, yaml, interactive, or a custom format expression (using https://github.com/PaesslerAG/gval syntax)
22+
Examples:
23+
--output json
24+
--output yaml
25+
--output interactive
26+
--output 'id' (to extract a single field)
27+
--output 'nested.field.subfield' (to extract a nested field)
28+
--output '[id, "name"]' (to extract multiple fields as an array)
29+
--output '{"newKey": oldKey, "otherKey": nested.field}' (to extract and rename fields in an object)
30+
--output 'name+","+type' (to extract and concatenate fields in a string)
31+
--output '(nbFieldA + nbFieldB) * 10' (to compute values from numeric fields)
32+
```
33+
34+
### SEE ALSO
35+
36+
* [ovhcloud cloud loadbalancer health-monitor](ovhcloud_cloud_loadbalancer_health-monitor.md) - Manage health monitors of loadbalancers
37+
Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
## ovhcloud cloud loadbalancer health-monitor edit
2+
3+
Edit a specific health monitor
4+
5+
```
6+
ovhcloud cloud loadbalancer health-monitor edit <health_monitor_id> [flags]
7+
```
8+
9+
### Options
10+
11+
```
12+
--delay int Duration between sending probes to members, in seconds
13+
--editor Use a text editor to define parameters
14+
-h, --help help for edit
15+
--max-retries int Number of successful checks before changing status to ONLINE
16+
--max-retries-down int Number of allowed check failures before changing status to ERROR
17+
--name string Name of the health monitor
18+
--timeout int Maximum time in seconds to connect before timeout
19+
```
20+
21+
### Options inherited from parent commands
22+
23+
```
24+
--cloud-project string Cloud project ID
25+
-d, --debug Activate debug mode (will log all HTTP requests details)
26+
-e, --ignore-errors Ignore errors in API calls when it is not fatal to the execution
27+
-o, --output string Output format: json, yaml, interactive, or a custom format expression (using https://github.com/PaesslerAG/gval syntax)
28+
Examples:
29+
--output json
30+
--output yaml
31+
--output interactive
32+
--output 'id' (to extract a single field)
33+
--output 'nested.field.subfield' (to extract a nested field)
34+
--output '[id, "name"]' (to extract multiple fields as an array)
35+
--output '{"newKey": oldKey, "otherKey": nested.field}' (to extract and rename fields in an object)
36+
--output 'name+","+type' (to extract and concatenate fields in a string)
37+
--output '(nbFieldA + nbFieldB) * 10' (to compute values from numeric fields)
38+
```
39+
40+
### SEE ALSO
41+
42+
* [ovhcloud cloud loadbalancer health-monitor](ovhcloud_cloud_loadbalancer_health-monitor.md) - Manage health monitors of loadbalancers
43+

0 commit comments

Comments
 (0)