loadbalancer_configurations

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

Overview

Name	loadbalancer_configurations
Type	Resource
Id	ovh.cloud_network.loadbalancer_configurations

Fields

The following fields are returned by SELECT queries:

get

successful operation

Name	Datatype	Description
backends	array	List of backends
certificates	array	List of certificate ID
frontends	array	List of frontends
networking	object	networking configuration
version	integer	Identifier and version of the configuration

list

A load balancer configuration

Name	Datatype	Description
backends	array	List of backends
certificates	array	List of certificate ID
frontends	array	List of frontends
networking	object	networking configuration
version	integer	Identifier and version of the configuration

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	load_balancer_id, version, service_name		Get a configuration (Beta version)
list	select	load_balancer_id, service_name	x_pagination_mode	List all versions of the configuration (Beta version)
create	insert	load_balancer_id, service_name		Create a configuration (Beta version)
delete	delete	load_balancer_id, version, service_name		Delete a configuration (Beta version)
apply	exec	loadBalancerId, version, service_name		Apply a configuration (Beta version)

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"}})
loadBalancerId	string (uuid)	Load balancer ID
load_balancer_id	string (uuid)	Load balancer ID (wire: loadBalancerId)
service_name	string	The Public Cloud project ID. Resolved from OVH_CLOUD_PROJECT_SERVICE when set.
version	integer	Version
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 configuration (Beta version)

SELECT
backends,
certificates,
frontends,
networking,
version
FROM ovh.cloud_network.loadbalancer_configurations
WHERE load_balancer_id = '{{ load_balancer_id }}' -- required
AND version = '{{ version }}' -- required
AND service_name = '{{ service_name }}' -- required unless OVH_CLOUD_PROJECT_SERVICE is set
;

list

List all versions of the configuration (Beta version)

SELECT
backends,
certificates,
frontends,
networking,
version
FROM ovh.cloud_network.loadbalancer_configurations
WHERE load_balancer_id = '{{ load_balancer_id }}' -- required
AND service_name = '{{ service_name }}' -- required unless OVH_CLOUD_PROJECT_SERVICE is set
AND x_pagination_mode = '{{ x_pagination_mode }}'
;

INSERT examples

create

Create a configuration (Beta version)

INSERT INTO ovh.cloud_network.loadbalancer_configurations (
backends,
certificates,
frontends,
networking,
load_balancer_id,
service_name
)
SELECT 
'{{ backends }}',
'{{ certificates }}',
'{{ frontends }}',
'{{ networking }}',
'{{ load_balancer_id }}',
'{{ service_name }}'
RETURNING
backends,
certificates,
frontends,
networking,
version
;

Manifest

# Description fields are for documentation purposes
- name: loadbalancer_configurations
props:
  - name: load_balancer_id
    value: "{{ load_balancer_id }}"
    description: Required parameter for the loadbalancer_configurations resource.
  - name: service_name
    value: "{{ service_name }}"
    description: Required parameter for the loadbalancer_configurations resource.
  - name: backends
    description: |
      List of backends
    value:
      - balancer: "{{ balancer }}"
        name: "{{ name }}"
        proxyProtocol: "{{ proxyProtocol }}"
        servers: "{{ servers }}"
        sticky: {{ sticky }}
  - name: certificates
    value:
      - "{{ certificates }}"
    description: |
      List of certificate ID
  - name: frontends
    description: |
      List of frontends
    value:
      - backends: "{{ backends }}"
        mode: "{{ mode }}"
        name: "{{ name }}"
        port: {{ port }}
        portRanges: "{{ portRanges }}"
        ports: "{{ ports }}"
        tls: {{ tls }}
        whitelist: "{{ whitelist }}"
  - name: networking
    description: |
      networking configuration
    value:
      egress:
        id: "{{ id }}"
        kind: "{{ kind }}"
      ingress:
        kind: "{{ kind }}"

DELETE examples

delete

Delete a configuration (Beta version)

DELETE FROM ovh.cloud_network.loadbalancer_configurations
WHERE load_balancer_id = '{{ load_balancer_id }}' --required
AND version = '{{ version }}' --required
AND service_name = '{{ service_name }}' --required unless OVH_CLOUD_PROJECT_SERVICE is set
;

Lifecycle Methods

EXEC variables use wire (API) names.

apply

Apply a configuration (Beta version)

EXEC ovh.cloud_network.loadbalancer_configurations.apply 
@loadBalancerId='{{ loadBalancerId }}' --required, 
@version='{{ version }}' --required, 
@service_name='{{ service_name }}' --required unless OVH_CLOUD_PROJECT_SERVICE is set
;