region_loadbalancing_pools

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

Overview

Name	region_loadbalancing_pools
Type	Resource
Id	ovh.cloud_network.region_loadbalancing_pools

Fields

The following fields are returned by SELECT queries:

get

successful operation

Name	Datatype	Description
id	string (uuid)	ID of the resource
name	string	Name of the resource
listener_id	string (uuid)	ID of the listener (wire: listenerId)
loadbalancer_id	string (uuid)	ID of the loadbalancer (wire: loadbalancerId)
algorithm	string	Algorithm of the pool (leastConnections, roundRobin, sourceIP)
operating_status	string	Operating status of the resource (degraded, draining, error, noMonitor, offline, online) (wire: operatingStatus)
protocol	string	Protocol of the pool (http, https, proxy, proxyV2, sctp, tcp, udp)
provisioning_status	string	Provisioning status of the resource (active, creating, deleted, deleting, error, updating) (wire: provisioningStatus)
session_persistence	object	Information about session persistence (wire: sessionPersistence)

list

Pool

Name	Datatype	Description
id	string (uuid)	ID of the resource
name	string	Name of the resource
listener_id	string (uuid)	ID of the listener (wire: listenerId)
loadbalancer_id	string (uuid)	ID of the loadbalancer (wire: loadbalancerId)
algorithm	string	Algorithm of the pool (leastConnections, roundRobin, sourceIP)
operating_status	string	Operating status of the resource (degraded, draining, error, noMonitor, offline, online) (wire: operatingStatus)
protocol	string	Protocol of the pool (http, https, proxy, proxyV2, sctp, tcp, udp)
provisioning_status	string	Provisioning status of the resource (active, creating, deleted, deleting, error, updating) (wire: provisioningStatus)
session_persistence	object	Information about session persistence (wire: sessionPersistence)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	pool_id, region_name, service_name		Get details about a loadbalancer pool
list	select	region_name, service_name	loadbalancer_id	List your loadbalancer pools
create	insert	region_name, service_name, algorithm, protocol		Create a loadbalancer pool
update	update	pool_id, region_name, service_name		Update a loadbalancer pool
delete	delete	pool_id, region_name, service_name		Delete a loadbalancer pool

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"}})
pool_id	string (uuid)	Pool ID (wire: poolId)
region_name	string	Region name (wire: regionName)
service_name	string	The Public Cloud project ID. Resolved from OVH_CLOUD_PROJECT_SERVICE when set.
loadbalancer_id	string (uuid)	Filter by loadbalancer (wire: loadbalancerId)

SELECT examples

get

Get details about a loadbalancer pool

SELECT
id,
name,
listener_id,
loadbalancer_id,
algorithm,
operating_status,
protocol,
provisioning_status,
session_persistence
FROM ovh.cloud_network.region_loadbalancing_pools
WHERE pool_id = '{{ pool_id }}' -- required
AND region_name = '{{ region_name }}' -- required
AND service_name = '{{ service_name }}' -- required unless OVH_CLOUD_PROJECT_SERVICE is set
;

list

List your loadbalancer pools

SELECT
id,
name,
listener_id,
loadbalancer_id,
algorithm,
operating_status,
protocol,
provisioning_status,
session_persistence
FROM ovh.cloud_network.region_loadbalancing_pools
WHERE region_name = '{{ region_name }}' -- required
AND service_name = '{{ service_name }}' -- required unless OVH_CLOUD_PROJECT_SERVICE is set
AND loadbalancer_id = '{{ loadbalancer_id }}'
;

INSERT examples

create

Create a loadbalancer pool

INSERT INTO ovh.cloud_network.region_loadbalancing_pools (
algorithm,
listener_id,
loadbalancer_id,
name,
protocol,
session_persistence,
region_name,
service_name
)
SELECT 
'{{ algorithm }}' /* required */,
'{{ listener_id }}',
'{{ loadbalancer_id }}',
'{{ name }}',
'{{ protocol }}' /* required */,
'{{ session_persistence }}',
'{{ region_name }}',
'{{ service_name }}'
RETURNING
id,
name,
listener_id,
loadbalancer_id,
algorithm,
operating_status,
protocol,
provisioning_status,
session_persistence
;

Manifest

# Description fields are for documentation purposes
- name: region_loadbalancing_pools
props:
  - name: region_name
    value: "{{ region_name }}"
    description: Required parameter for the region_loadbalancing_pools resource.
  - name: service_name
    value: "{{ service_name }}"
    description: Required parameter for the region_loadbalancing_pools resource.
  - name: algorithm
    value: "{{ algorithm }}"
    description: |
      Algorithm of the pool
    valid_values: ['leastConnections', 'roundRobin', 'sourceIP']
  - name: listener_id
    value: "{{ listener_id }}"
    description: |
      ID of the listener
  - name: loadbalancer_id
    value: "{{ loadbalancer_id }}"
    description: |
      ID of the loadbalancer
  - name: name
    value: "{{ name }}"
    description: |
      Name of the resource
  - name: protocol
    value: "{{ protocol }}"
    description: |
      Protocol of the pool
    valid_values: ['http', 'https', 'proxy', 'proxyV2', 'sctp', 'tcp', 'udp']
  - name: session_persistence
    description: |
      Information about session persistence
    value:
      cookieName: "{{ cookieName }}"
      type: "{{ type }}"

UPDATE examples

update

Update a loadbalancer pool

UPDATE ovh.cloud_network.region_loadbalancing_pools
SET 
algorithm = '{{ algorithm }}',
name = '{{ name }}',
session_persistence = '{{ session_persistence }}'
WHERE 
pool_id = '{{ pool_id }}' --required
AND region_name = '{{ region_name }}' --required
AND service_name = '{{ service_name }}' --required unless OVH_CLOUD_PROJECT_SERVICE is set
RETURNING
id,
name,
listener_id,
loadbalancer_id,
algorithm,
operating_status,
protocol,
provisioning_status,
session_persistence;

DELETE examples

delete

Delete a loadbalancer pool

DELETE FROM ovh.cloud_network.region_loadbalancing_pools
WHERE pool_id = '{{ pool_id }}' --required
AND region_name = '{{ region_name }}' --required
AND service_name = '{{ service_name }}' --required unless OVH_CLOUD_PROJECT_SERVICE is set
;