region_loadbalancing_pool_members

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

Overview

Name	region_loadbalancing_pool_members
Type	Resource
Id	ovh.cloud_network.region_loadbalancing_pool_members

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
address	string (ipv4)	IP address of the resource (example: 192.0.2.0)
operating_status	string	Operating status of the resource (degraded, draining, error, noMonitor, offline, online) (wire: operatingStatus)
protocol_port	integer	Protocol port number for the resource (wire: protocolPort)
provisioning_status	string	Provisioning status of the resource (active, creating, deleted, deleting, error, updating) (wire: provisioningStatus)
weight	integer	Weight of a member determines the portion of requests or connections it services compared to the other members of the pool

list

Member

Name	Datatype	Description
id	string (uuid)	ID of the resource
name	string	Name of the resource
address	string (ipv4)	IP address of the resource (example: 192.0.2.0)
operating_status	string	Operating status of the resource (degraded, draining, error, noMonitor, offline, online) (wire: operatingStatus)
protocol_port	integer	Protocol port number for the resource (wire: protocolPort)
provisioning_status	string	Provisioning status of the resource (active, creating, deleted, deleting, error, updating) (wire: provisioningStatus)
weight	integer	Weight of a member determines the portion of requests or connections it services compared to the other members of the pool

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	member_id, pool_id, region_name, service_name		Get details about a pool member
list	select	pool_id, region_name, service_name		List your pool members
create	insert	pool_id, region_name, service_name, members		Create pool members
update	update	member_id, pool_id, region_name, service_name		Update a pool member
delete	delete	member_id, pool_id, region_name, service_name		Delete a pool member

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"}})
member_id	string (uuid)	Member ID (wire: memberId)
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.

SELECT examples

get

Get details about a pool member

SELECT
id,
name,
address,
operating_status,
protocol_port,
provisioning_status,
weight
FROM ovh.cloud_network.region_loadbalancing_pool_members
WHERE member_id = '{{ member_id }}' -- required
AND 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 pool members

SELECT
id,
name,
address,
operating_status,
protocol_port,
provisioning_status,
weight
FROM ovh.cloud_network.region_loadbalancing_pool_members
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
;

INSERT examples

create

Create pool members

INSERT INTO ovh.cloud_network.region_loadbalancing_pool_members (
members,
pool_id,
region_name,
service_name
)
SELECT 
'{{ members }}' /* required */,
'{{ pool_id }}',
'{{ region_name }}',
'{{ service_name }}'
RETURNING
id,
name,
address,
operating_status,
protocol_port,
provisioning_status,
weight
;

Manifest

# Description fields are for documentation purposes
- name: region_loadbalancing_pool_members
props:
  - name: pool_id
    value: "{{ pool_id }}"
    description: Required parameter for the region_loadbalancing_pool_members resource.
  - name: region_name
    value: "{{ region_name }}"
    description: Required parameter for the region_loadbalancing_pool_members resource.
  - name: service_name
    value: "{{ service_name }}"
    description: Required parameter for the region_loadbalancing_pool_members resource.
  - name: members
    description: |
      Members of a pool
    value:
      - address: "{{ address }}"
        id: "{{ id }}"
        name: "{{ name }}"
        operatingStatus: "{{ operatingStatus }}"
        protocolPort: {{ protocolPort }}
        provisioningStatus: "{{ provisioningStatus }}"
        weight: {{ weight }}

UPDATE examples

update

Update a pool member

UPDATE ovh.cloud_network.region_loadbalancing_pool_members
SET 
name = '{{ name }}',
weight = {{ weight }}
WHERE 
member_id = '{{ member_id }}' --required
AND 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,
address,
operating_status,
protocol_port,
provisioning_status,
weight;

DELETE examples

delete

Delete a pool member

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