Skip to content

Commit 8cd510a

Browse files
authored
Merge pull request #8651 from ovh/sa-iplb-batch-4
IPLB Refresh - Batch 4
2 parents e39d06f + 4792230 commit 8cd510a

32 files changed

+4125
-2286
lines changed
Lines changed: 74 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,40 @@
11
---
2-
title: 'Load Balancer FAQ'
3-
excerpt: 'FAQ Load Balancer'
4-
updated: 2018-03-26
2+
title: 'OVHcloud Load Balancer FAQ'
3+
excerpt: 'Frequently Asked Questions on the OVHcloud Load Balancer'
4+
updated: 2025-11-12
55
---
66

7-
## How do I configure my Firewall to accept traffic from the OVHcloud Load Balancer?
8-
When using the Load Balancer, your clients do not connect directly to your servers. A good practice is to setup a firewall to allow only traffic from the OVHcloud Load Balancer service.
7+
## Objective
98

10-
- To determine which IPs to allow in your firewall, you can use the following API call:
9+
This document provides a set of the most frequently asked questions and their corresponding OVHcloud API calls for performing common management and configuration tasks on your OVHcloud Load Balancer service.
10+
11+
## FAQ
12+
13+
### How do I configure my Firewall to accept traffic from the OVHcloud Load Balancer?
14+
15+
When using the Load Balancer, your clients do not connect directly to your servers. A good practice is to set up a firewall to allow only traffic from the OVHcloud Load Balancer service.
16+
17+
#### Via the OVHcloud API
18+
19+
To determine which IP addresses you need to allow in your firewall, you can use the following API call:
1120

1221
> [!api]
1322
>
1423
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/natIp
1524
>
1625
17-
## How do I know the status of my service?
26+
#### Via the OVHcloud Control Panel
27+
28+
In your Load Balancer service, navigate to the `Home`{.action} tab, and find the **Information** section. On the **Outbound IPv4** line, click the ellipsis, and select "Read".
29+
A window will open, listing the IP addresses you need to allow in your firewall.
30+
31+
### How do I know the status of my service?
32+
1833
Sometimes it may be useful to know the status of your OVHcloud Load Balancer.
1934

20-
- To determine the status of your service, you can use the following API call :
35+
#### Via the OVHcloud API
36+
37+
To determine the status of your service, you can use the following API call:
2138

2239
> [!api]
2340
>
@@ -26,45 +43,75 @@ Sometimes it may be useful to know the status of your OVHcloud Load Balancer.
2643
2744
The different statuses of the OVHcloud Load Balancer can be `running`{.action} (Active), `reload`{.action} (Refresh in progress), `unknown`{.action} (Not yet started), or `dead`{.action} (inactive).
2845

29-
## How to add an Additional IP to the OVHcloud Load Balancer?
30-
An Additional IP is an additional IP in which can be joined with your primary IP. The Additional IP can be switched from one server to another in seconds.
46+
#### Via the OVHcloud Control Panel
47+
48+
In your Load Balancer service dashboard, navigate to the `Home`{.action} tab, and find the **Status** section, which lists the internal service name of your Load Balancer and its status.
49+
50+
### How to add an Additional IP to the OVHcloud Load Balancer?
51+
52+
An Additional IP is an secondary IP address which can be associated to your service in addition to your primary IP. The Additional IP can be switched from one server to another in seconds.
53+
54+
#### Via the OVHcloud API
3155

32-
- To add an Additional IP to an OVHcloud Load Balancer service :
56+
- To add an Additional IP to an OVHcloud Load Balancer service:
3357

3458
> [!api]
3559
>
3660
> @api {v1} /ip POST /ip/{ip}/move
3761
>
3862
39-
- Apply the change :
63+
- Apply the change:
4064

4165
> [!api]
4266
>
4367
> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/refresh
4468
>
4569
46-
## How to list the Additional IPs routed to the OVHcloud Load Balancer?
70+
#### Via the OVHcloud Control Panel
71+
72+
In your Load Balancer service dashboard, click on `Front-ends`{.action}, then on `Add a front-end`{.action}.
73+
Then, expand the `Advanced settings`{.action}, and select the Additional IPs you would like to add to your front-end *(listed on the interface as "Dedicated failover IP")*.
74+
75+
### How to list the Additional IPs routed to the OVHcloud Load Balancer?
4776

4877
> [!api]
4978
>
5079
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/failover
5180
>
5281
53-
## How do I order a free SSL certificate ?
54-
It is possible to order a free SSL ceritificate for the OVHcloud Load Balancer..
82+
### How do I order a free SSL certificate?
83+
84+
#### Via the OVHcloud Control Panel
85+
86+
In your Load Balancer service dashboard, navigate to the `SSL certificates`{.action} tab, and click on `Order an SSL certificate`{.action}.
87+
Fill in the FQDN in the dedicated field, then click on `Order`{.action}.
88+
89+
For the order to be completed, it is required that the domain name points to your OVHcloud Load Balancer.
90+
91+
#### Via the OVHcloud API
92+
93+
It is possible to order a free SSL certificate for the OVHcloud Load Balancer.
5594

56-
- To order a free SSL certificate, you can use the following API call and entering your domain in the `fqdn` field:
95+
- To order a free SSL certificate, you can use the following API call and enter your domain in the fqdn field:
5796

5897
> [!api]
5998
>
6099
> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/freeCertificate
61100
>
62101
63-
It is possible to order a multi-domain certificate; the `fqdn` fields accepts a sting type input.
102+
It is possible to order a multi-domain certificate; the `fqdn` field accepts a string type input.
64103

65-
For the orer to be completed, it is required that the domain name points to your OVHcloud Load Balancer.
104+
For the order to be completed, it is required that the domain name points to your OVHcloud Load Balancer.
66105

67-
## How to list the SSL certificates associated with the OVHcloud Load Balancer ?
106+
### How to list the SSL certificates associated with the OVHcloud Load Balancer?
107+
108+
#### Via the OVHcloud Control Panel
109+
110+
In your Load Balancer service dashboard, navigate to the `SSL certificates`{.action} section, where you will find a table listing the certificates associated to that Load Balancer.
111+
112+
To retrieve the details of an SSL certificate, click the ellipsis button to the right of the desired certificate, then click on `See a preview`{.action}.
113+
114+
#### Via the OVHcloud API
68115

69116
- To list the SSL certificates associated with the OVHcloud Load Balancer, you can use the following API call:
70117

@@ -73,14 +120,19 @@ For the orer to be completed, it is required that the domain name points to your
73120
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/ssl
74121
>
75122
76-
The SSL certificates that have been ordered (free or not) will appear as `built`. Those added by yourself are will appear as `custom`.
123+
The SSL certificates that have been ordered (free or not) will appear as `built`. Those added by yourself will appear as `custom`.
77124

78-
An SSL certificate appearing as `built_not_routed` is a certificate that has been order and delivered, but whose domain cannot be validated. Usually, this is because the domain to longer points to the OVHcloud Load Balancer.
125+
An SSL certificate appearing as `built_not_routed` is a certificate that has been ordered and delivered, but whose domain cannot be validated. Usually, this is because the domain no longer points to the OVHcloud Load Balancer.
79126

80-
- To retrieve the details of an SSL certificate, you can use the following API call :
127+
- To retrieve the details of an SSL certificate, you can use the following API call:
81128

82129
> [!api]
83130
>
84131
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/ssl/{id}
85132
>
86133
134+
## Go further
135+
136+
Find details about all the API calls related to the OVHcloud Load Balancer in [this guide](/pages/network/load_balancer/use_api_details).
137+
138+
Join our [community of users](/links/community).
Lines changed: 74 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,40 @@
11
---
2-
title: 'Load Balancer FAQ'
3-
excerpt: 'FAQ Load Balancer'
4-
updated: 2018-03-26
2+
title: 'OVHcloud Load Balancer FAQ'
3+
excerpt: 'Frequently Asked Questions on the OVHcloud Load Balancer'
4+
updated: 2025-11-12
55
---
66

7-
## How do I configure my Firewall to accept traffic from the OVHcloud Load Balancer?
8-
When using the Load Balancer, your clients do not connect directly to your servers. A good practice is to setup a firewall to allow only traffic from the OVHcloud Load Balancer service.
7+
## Objective
98

10-
- To determine which IPs to allow in your firewall, you can use the following API call:
9+
This document provides a set of the most frequently asked questions and their corresponding OVHcloud API calls for performing common management and configuration tasks on your OVHcloud Load Balancer service.
10+
11+
## FAQ
12+
13+
### How do I configure my Firewall to accept traffic from the OVHcloud Load Balancer?
14+
15+
When using the Load Balancer, your clients do not connect directly to your servers. A good practice is to set up a firewall to allow only traffic from the OVHcloud Load Balancer service.
16+
17+
#### Via the OVHcloud API
18+
19+
To determine which IP addresses you need to allow in your firewall, you can use the following API call:
1120

1221
> [!api]
1322
>
1423
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/natIp
1524
>
1625
17-
## How do I know the status of my service?
26+
#### Via the OVHcloud Control Panel
27+
28+
In your Load Balancer service, navigate to the `Home`{.action} tab, and find the **Information** section. On the **Outbound IPv4** line, click the ellipsis, and select "Read".
29+
A window will open, listing the IP addresses you need to allow in your firewall.
30+
31+
### How do I know the status of my service?
32+
1833
Sometimes it may be useful to know the status of your OVHcloud Load Balancer.
1934

20-
- To determine the status of your service, you can use the following API call :
35+
#### Via the OVHcloud API
36+
37+
To determine the status of your service, you can use the following API call:
2138

2239
> [!api]
2340
>
@@ -26,45 +43,75 @@ Sometimes it may be useful to know the status of your OVHcloud Load Balancer.
2643
2744
The different statuses of the OVHcloud Load Balancer can be `running`{.action} (Active), `reload`{.action} (Refresh in progress), `unknown`{.action} (Not yet started), or `dead`{.action} (inactive).
2845

29-
## How to add an Additional IP to the OVHcloud Load Balancer?
30-
An Additional IP is an additional IP in which can be joined with your primary IP. The Additional IP can be switched from one server to another in seconds.
46+
#### Via the OVHcloud Control Panel
47+
48+
In your Load Balancer service dashboard, navigate to the `Home`{.action} tab, and find the **Status** section, which lists the internal service name of your Load Balancer and its status.
49+
50+
### How to add an Additional IP to the OVHcloud Load Balancer?
51+
52+
An Additional IP is an secondary IP address which can be associated to your service in addition to your primary IP. The Additional IP can be switched from one server to another in seconds.
53+
54+
#### Via the OVHcloud API
3155

32-
- To add an Additional IP to an OVHcloud Load Balancer service :
56+
- To add an Additional IP to an OVHcloud Load Balancer service:
3357

3458
> [!api]
3559
>
3660
> @api {v1} /ip POST /ip/{ip}/move
3761
>
3862
39-
- Apply the change :
63+
- Apply the change:
4064

4165
> [!api]
4266
>
4367
> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/refresh
4468
>
4569
46-
## How to list the Additional IPs routed to the OVHcloud Load Balancer?
70+
#### Via the OVHcloud Control Panel
71+
72+
In your Load Balancer service dashboard, click on `Front-ends`{.action}, then on `Add a front-end`{.action}.
73+
Then, expand the `Advanced settings`{.action}, and select the Additional IPs you would like to add to your front-end *(listed on the interface as "Dedicated failover IP")*.
74+
75+
### How to list the Additional IPs routed to the OVHcloud Load Balancer?
4776

4877
> [!api]
4978
>
5079
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/failover
5180
>
5281
53-
## How do I order a free SSL certificate ?
54-
It is possible to order a free SSL ceritificate for the OVHcloud Load Balancer..
82+
### How do I order a free SSL certificate?
83+
84+
#### Via the OVHcloud Control Panel
85+
86+
In your Load Balancer service dashboard, navigate to the `SSL certificates`{.action} tab, and click on `Order an SSL certificate`{.action}.
87+
Fill in the FQDN in the dedicated field, then click on `Order`{.action}.
88+
89+
For the order to be completed, it is required that the domain name points to your OVHcloud Load Balancer.
90+
91+
#### Via the OVHcloud API
92+
93+
It is possible to order a free SSL certificate for the OVHcloud Load Balancer.
5594

56-
- To order a free SSL certificate, you can use the following API call and entering your domain in the `fqdn` field:
95+
- To order a free SSL certificate, you can use the following API call and enter your domain in the fqdn field:
5796

5897
> [!api]
5998
>
6099
> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/freeCertificate
61100
>
62101
63-
It is possible to order a multi-domain certificate; the `fqdn` fields accepts a sting type input.
102+
It is possible to order a multi-domain certificate; the `fqdn` field accepts a string type input.
64103

65-
For the orer to be completed, it is required that the domain name points to your OVHcloud Load Balancer.
104+
For the order to be completed, it is required that the domain name points to your OVHcloud Load Balancer.
66105

67-
## How to list the SSL certificates associated with the OVHcloud Load Balancer ?
106+
### How to list the SSL certificates associated with the OVHcloud Load Balancer?
107+
108+
#### Via the OVHcloud Control Panel
109+
110+
In your Load Balancer service dashboard, navigate to the `SSL certificates`{.action} section, where you will find a table listing the certificates associated to that Load Balancer.
111+
112+
To retrieve the details of an SSL certificate, click the ellipsis button to the right of the desired certificate, then click on `See a preview`{.action}.
113+
114+
#### Via the OVHcloud API
68115

69116
- To list the SSL certificates associated with the OVHcloud Load Balancer, you can use the following API call:
70117

@@ -73,14 +120,19 @@ For the orer to be completed, it is required that the domain name points to your
73120
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/ssl
74121
>
75122
76-
The SSL certificates that have been ordered (free or not) will appear as `built`. Those added by yourself are will appear as `custom`.
123+
The SSL certificates that have been ordered (free or not) will appear as `built`. Those added by yourself will appear as `custom`.
77124

78-
An SSL certificate appearing as `built_not_routed` is a certificate that has been order and delivered, but whose domain cannot be validated. Usually, this is because the domain to longer points to the OVHcloud Load Balancer.
125+
An SSL certificate appearing as `built_not_routed` is a certificate that has been ordered and delivered, but whose domain cannot be validated. Usually, this is because the domain no longer points to the OVHcloud Load Balancer.
79126

80-
- To retrieve the details of an SSL certificate, you can use the following API call :
127+
- To retrieve the details of an SSL certificate, you can use the following API call:
81128

82129
> [!api]
83130
>
84131
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/ssl/{id}
85132
>
86133
134+
## Go further
135+
136+
Find details about all the API calls related to the OVHcloud Load Balancer in [this guide](/pages/network/load_balancer/use_api_details).
137+
138+
Join our [community of users](/links/community).

0 commit comments

Comments
 (0)