loadbalancers

Creates, updates, deletes, gets or lists a loadbalancers resource.

Overview

Name	loadbalancers
Type	Resource
Id	ovh.ip_loadbalancing.loadbalancers

Fields

The following fields are returned by SELECT queries:

get

successful operation

Name	Datatype	Description
display_name	string	Set the name displayed in ManagerV6 for your iplb (max 50 chars) (wire: displayName)
service_name	string	The internal name of your IP load balancing (wire: serviceName)
vrack_name	string	Name of the vRack on which the current Load Balancer is attached to, as it is named on vRack product (wire: vrackName)
iam	object	IAM resource metadata
ip_loadbalancing	string (ipv4)	Your IP load balancing (example: 192.0.2.0) (wire: ipLoadbalancing)
ipv_4	string (ipv4)	The IPV4 associated to your IP load balancing (example: 192.0.2.0) (wire: ipv4)
ipv_6	string (ipv6)	The IPV6 associated to your IP load balancing (example: 2001:41d0:1:1994::1) (wire: ipv6)
metrics_token	string	The metrics token associated with your IP load balancing (wire: metricsToken)
offer	string	The offer of your IP load balancing
orderable_zone	array	Available additional zone for your Load Balancer (wire: orderableZone)
ssl_configuration	string	Modern oldest compatible clients : Firefox 27, Chrome 30, IE 11 on Windows 7, Edge, Opera 17, Safari 9, Android 5.0, and Java 8. Intermediate oldest compatible clients : Firefox 1, Chrome 1, IE 7, Opera 5, Safari 1, Windows XP IE8, Android 2.3, Java 7. Intermediate if null. (intermediate, modern) (wire: sslConfiguration)
state	string	Current state of your IP (blacklisted, deleted, free, ok, quarantined, suspended)
vrack_eligibility	boolean	Vrack eligibility (wire: vrackEligibility)
zone	array	Location where your service is

list

Your IP load balancing

Name	Datatype	Description
display_name	string	Set the name displayed in ManagerV6 for your iplb (max 50 chars) (wire: displayName)
service_name	string	The internal name of your IP load balancing (wire: serviceName)
vrack_name	string	Name of the vRack on which the current Load Balancer is attached to, as it is named on vRack product (wire: vrackName)
iam	object	IAM resource metadata
ip_loadbalancing	string (ipv4)	Your IP load balancing (example: 192.0.2.0) (wire: ipLoadbalancing)
ipv_4	string (ipv4)	The IPV4 associated to your IP load balancing (example: 192.0.2.0) (wire: ipv4)
ipv_6	string (ipv6)	The IPV6 associated to your IP load balancing (example: 2001:41d0:1:1994::1) (wire: ipv6)
metrics_token	string	The metrics token associated with your IP load balancing (wire: metricsToken)
offer	string	The offer of your IP load balancing
orderable_zone	array	Available additional zone for your Load Balancer (wire: orderableZone)
ssl_configuration	string	Modern oldest compatible clients : Firefox 27, Chrome 30, IE 11 on Windows 7, Edge, Opera 17, Safari 9, Android 5.0, and Java 8. Intermediate oldest compatible clients : Firefox 1, Chrome 1, IE 7, Opera 5, Safari 1, Windows XP IE8, Android 2.3, Java 7. Intermediate if null. (intermediate, modern) (wire: sslConfiguration)
state	string	Current state of your IP (blacklisted, deleted, free, ok, quarantined, suspended)
vrack_eligibility	boolean	Vrack eligibility (wire: vrackEligibility)
zone	array	Location where your service is

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	service_name		Get a Load Balancer service
list	select		iam_tags, x_pagination_mode	List Load Balancer services
update	update	service_name		Update a Load Balancer service
change_contact	exec	serviceName		Change service contacts. Starts a procedure to change the admin, tech or billing contact of the service.
confirm_termination	exec	serviceName, token		Confirm service termination. Terminates the service with the token sent by email to the admin contact. A reason, a future use and a comment can be given.
free_certificate	exec	serviceName, fqdn		Order a free certificate
log_url	exec	serviceName, kind		Generate a temporary log URL
refresh	exec	serviceName		Apply the configuration
terminate	exec	serviceName		Request service termination. Starts the termination of the service. The admin contact receives a token by email, to confirm with the confirmTermination call.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
api_host	string	The OVHcloud API host. Selected by OVH_ENDPOINT (ovh-eu, ovh-ca or ovh-us; default ovh-eu). (default: api.eu.ovhcloud.com, x-stackQL-envVarSelector: {"envVar":"OVH_ENDPOINT","default":"ovh-eu","values":{"ovh-eu":"api.eu.ovhcloud.com","ovh-ca":"api.ca.ovhcloud.com","ovh-us":"api.us.ovhcloud.com"}})
serviceName	string	The internal name of your IP load balancing
service_name	string	The internal name of your IP load balancing (wire: serviceName)
iam_tags	object	Filter resources on IAM tags (wire: iamTags)
x_pagination_mode	string	Sent as CachedObjectList-Pages by default so the list returns the full objects rather than their identifiers. (wire: X-Pagination-Mode)

SELECT examples

get

Get a Load Balancer service

SELECT
display_name,
service_name,
vrack_name,
iam,
ip_loadbalancing,
ipv_4,
ipv_6,
metrics_token,
offer,
orderable_zone,
ssl_configuration,
state,
vrack_eligibility,
zone
FROM ovh.ip_loadbalancing.loadbalancers
WHERE service_name = '{{ service_name }}' -- required
;

list

List Load Balancer services

SELECT
display_name,
service_name,
vrack_name,
iam,
ip_loadbalancing,
ipv_4,
ipv_6,
metrics_token,
offer,
orderable_zone,
ssl_configuration,
state,
vrack_eligibility,
zone
FROM ovh.ip_loadbalancing.loadbalancers
WHERE iam_tags = '{{ iam_tags }}'
AND x_pagination_mode = '{{ x_pagination_mode }}'
;

UPDATE examples

update

Update a Load Balancer service

UPDATE ovh.ip_loadbalancing.loadbalancers
SET 
display_name = '{{ display_name }}',
ssl_configuration = '{{ ssl_configuration }}'
WHERE 
service_name = '{{ service_name }}' --required;

Lifecycle Methods

EXEC variables use wire (API) names.

change_contact

Change service contacts. Starts a procedure to change the admin, tech or billing contact of the service.

EXEC ovh.ip_loadbalancing.loadbalancers.change_contact 
@serviceName='{{ serviceName }}' --required 
@@json=
'{
"contactAdmin": "{{ contactAdmin }}", 
"contactBilling": "{{ contactBilling }}", 
"contactTech": "{{ contactTech }}"
}'
;

confirm_termination

Confirm service termination. Terminates the service with the token sent by email to the admin contact. A reason, a future use and a comment can be given.

EXEC ovh.ip_loadbalancing.loadbalancers.confirm_termination 
@serviceName='{{ serviceName }}' --required 
@@json=
'{
"commentary": "{{ commentary }}", 
"futureUse": "{{ futureUse }}", 
"reason": "{{ reason }}", 
"token": "{{ token }}"
}'
;

free_certificate

Order a free certificate

EXEC ovh.ip_loadbalancing.loadbalancers.free_certificate 
@serviceName='{{ serviceName }}' --required 
@@json=
'{
"fqdn": "{{ fqdn }}"
}'
;

log_url

Generate a temporary log URL

EXEC ovh.ip_loadbalancing.loadbalancers.log_url 
@serviceName='{{ serviceName }}' --required 
@@json=
'{
"kind": "{{ kind }}"
}'
;

refresh

Apply the configuration

EXEC ovh.ip_loadbalancing.loadbalancers.refresh 
@serviceName='{{ serviceName }}' --required 
@@json=
'{
"zone": "{{ zone }}"
}'
;

terminate

Request service termination. Starts the termination of the service. The admin contact receives a token by email, to confirm with the confirmTermination call.

EXEC ovh.ip_loadbalancing.loadbalancers.terminate 
@serviceName='{{ serviceName }}' --required
;