ip_loadbalancings

Creates, updates, deletes, gets or lists an ip_loadbalancings resource.

Overview

Name	ip_loadbalancings
Type	Resource
Id	ovh.vrack.ip_loadbalancings

Fields

The following fields are returned by SELECT queries:

get

successful operation

Name	Datatype	Description
ip_loadbalancing	string	Your ipLoadbalancing (wire: ipLoadbalancing)
vrack	string	vrack name

list

ipLoadbalancing in vrack

Name	Datatype	Description
ip_loadbalancing	string	Your ipLoadbalancing (wire: ipLoadbalancing)
vrack	string	vrack name

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	ip_loadbalancing, service_name		Get a load balancer. Returns the attached IP Load Balancer service and its vRack.
list	select	service_name	x_pagination_mode	List load balancers. Returns the IP Load Balancer services attached to the vRack.
create	insert	service_name, ip_loadbalancing		Attach a load balancer. Attaches an IP Load Balancer service to the vRack. Returns the task that performs it.
delete	delete	ip_loadbalancing, service_name		Detach a load balancer. Detaches the IP Load Balancer service from the vRack. Returns the task that performs it.

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"}})
ip_loadbalancing	string	Your ipLoadbalancing (wire: ipLoadbalancing)
service_name	string	The internal name of your vrack (wire: serviceName)
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. Returns the attached IP Load Balancer service and its vRack.

SELECT
ip_loadbalancing,
vrack
FROM ovh.vrack.ip_loadbalancings
WHERE ip_loadbalancing = '{{ ip_loadbalancing }}' -- required
AND service_name = '{{ service_name }}' -- required
;

list

List load balancers. Returns the IP Load Balancer services attached to the vRack.

SELECT
ip_loadbalancing,
vrack
FROM ovh.vrack.ip_loadbalancings
WHERE service_name = '{{ service_name }}' -- required
AND x_pagination_mode = '{{ x_pagination_mode }}'
;

INSERT examples

create

Attach a load balancer. Attaches an IP Load Balancer service to the vRack. Returns the task that performs it.

INSERT INTO ovh.vrack.ip_loadbalancings (
ip_loadbalancing,
service_name
)
SELECT 
'{{ ip_loadbalancing }}' /* required */,
'{{ service_name }}'
RETURNING
id,
order_id,
service_name,
function,
last_update,
status,
target_domain,
todo_date
;

Manifest

# Description fields are for documentation purposes
- name: ip_loadbalancings
props:
  - name: service_name
    value: "{{ service_name }}"
    description: Required parameter for the ip_loadbalancings resource.
  - name: ip_loadbalancing
    value: "{{ ip_loadbalancing }}"
    description: |
      Your ipLoadbalancing

DELETE examples

delete

Detach a load balancer. Detaches the IP Load Balancer service from the vRack. Returns the task that performs it.

DELETE FROM ovh.vrack.ip_loadbalancings
WHERE ip_loadbalancing = '{{ ip_loadbalancing }}' --required
AND service_name = '{{ service_name }}' --required
;