udp_farm_servers

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

Overview

Name	udp_farm_servers
Type	Resource
Id	ovh.ip_loadbalancing.udp_farm_servers

Fields

The following fields are returned by SELECT queries:

get

successful operation

Name	Datatype	Description
backend_id	integer	farm id (wire: backendId)
server_id	integer	Id of your server (wire: serverId)
display_name	string	Human readable name for your server, this field is for you (wire: displayName)
address	string (ipv4)	Address of your server (example: 192.0.2.0)
port	integer	Port attached to your server. Inherited from farm if null
status	string	Status attached to your server (active, inactive)

list

UDP Farm's Server

Name	Datatype	Description
backend_id	integer	farm id (wire: backendId)
server_id	integer	Id of your server (wire: serverId)
display_name	string	Human readable name for your server, this field is for you (wire: displayName)
address	string (ipv4)	Address of your server (example: 192.0.2.0)
port	integer	Port attached to your server. Inherited from farm if null
status	string	Status attached to your server (active, inactive)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	farm_id, server_id, service_name		Get a farm server (Beta version)
list	select	farm_id, service_name	address, status, x_pagination_mode	List farm servers (Beta version)
create	insert	farm_id, service_name, address, status		Create a farm server (Beta version)
update	update	farm_id, server_id, service_name		Update a farm server (Beta version)
delete	delete	farm_id, server_id, service_name		Delete a farm server (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"}})
farm_id	integer	Id of your farm (wire: farmId)
server_id	integer	Id of your server (wire: serverId)
service_name	string	The internal name of your IP load balancing (wire: serviceName)
address	string (ipv4)	Filter the value of address property (=)
status	string	Filter the value of status property (=)
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 farm server (Beta version)

SELECT
backend_id,
server_id,
display_name,
address,
port,
status
FROM ovh.ip_loadbalancing.udp_farm_servers
WHERE farm_id = '{{ farm_id }}' -- required
AND server_id = '{{ server_id }}' -- required
AND service_name = '{{ service_name }}' -- required
;

list

List farm servers (Beta version)

SELECT
backend_id,
server_id,
display_name,
address,
port,
status
FROM ovh.ip_loadbalancing.udp_farm_servers
WHERE farm_id = '{{ farm_id }}' -- required
AND service_name = '{{ service_name }}' -- required
AND address = '{{ address }}'
AND status = '{{ status }}'
AND x_pagination_mode = '{{ x_pagination_mode }}'
;

INSERT examples

create

Create a farm server (Beta version)

INSERT INTO ovh.ip_loadbalancing.udp_farm_servers (
address,
display_name,
port,
status,
farm_id,
service_name
)
SELECT 
'{{ address }}' /* required */,
'{{ display_name }}',
{{ port }},
'{{ status }}' /* required */,
'{{ farm_id }}',
'{{ service_name }}'
RETURNING
backend_id,
server_id,
display_name,
address,
port,
status
;

Manifest

# Description fields are for documentation purposes
- name: udp_farm_servers
props:
  - name: farm_id
    value: {{ farm_id }}
    description: Required parameter for the udp_farm_servers resource.
  - name: service_name
    value: "{{ service_name }}"
    description: Required parameter for the udp_farm_servers resource.
  - name: address
    value: "{{ address }}"
    description: |
      IPv4 address (e.g., 192.0.2.0)
  - name: display_name
    value: "{{ display_name }}"
    description: |
      Human readable name for your server, this field is for you
  - name: port
    value: {{ port }}
    description: |
      Port attached to your server ([1..49151]). Inherited from farm if null
  - name: status
    value: "{{ status }}"
    description: |
      Possible values for server status
    valid_values: ['active', 'inactive']

UPDATE examples

update

Update a farm server (Beta version)

UPDATE ovh.ip_loadbalancing.udp_farm_servers
SET 
display_name = '{{ display_name }}',
port = {{ port }},
status = '{{ status }}'
WHERE 
farm_id = '{{ farm_id }}' --required
AND server_id = '{{ server_id }}' --required
AND service_name = '{{ service_name }}' --required;

DELETE examples

delete

Delete a farm server (Beta version)

DELETE FROM ovh.ip_loadbalancing.udp_farm_servers
WHERE farm_id = '{{ farm_id }}' --required
AND server_id = '{{ server_id }}' --required
AND service_name = '{{ service_name }}' --required
;