udp_farms

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

Overview

Name	udp_farms
Type	Resource
Id	ovh.ip_loadbalancing.udp_farms

Fields

The following fields are returned by SELECT queries:

get

successful operation

Name	Datatype	Description
farm_id	integer	Id of your farm (wire: farmId)
vrack_network_id	integer	Internal Load Balancer identifier of the vRack private network attached to your farm, mandatory when your Load Balancer is attached to a vRack (wire: vrackNetworkId)
display_name	string	Human readable name for your backend, this field is for you (wire: displayName)
port	integer	Port attached to your farm. Inherited from frontend if null
zone	string	Zone of you farm

list

UDP Farm

Name	Datatype	Description
farm_id	integer	Id of your farm (wire: farmId)
vrack_network_id	integer	Internal Load Balancer identifier of the vRack private network attached to your farm, mandatory when your Load Balancer is attached to a vRack (wire: vrackNetworkId)
display_name	string	Human readable name for your backend, this field is for you (wire: displayName)
port	integer	Port attached to your farm. Inherited from frontend if null
zone	string	Zone of you farm

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	farm_id, service_name		Get a UDP farm (Beta version)
list	select	service_name	vrack_network_id, zone, x_pagination_mode	List UDP farms (Beta version)
create	insert	service_name, port, zone		Create a UDP farm (Beta version)
update	update	farm_id, service_name		Update a UDP farm (Beta version)
delete	delete	farm_id, service_name		Delete a UDP farm (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)
service_name	string	The internal name of your IP load balancing (wire: serviceName)
vrack_network_id	integer	Filter the value of vrackNetworkId property (=) (wire: vrackNetworkId)
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)
zone	string	Filter the value of zone property (=)

SELECT examples

get

Get a UDP farm (Beta version)

SELECT
farm_id,
vrack_network_id,
display_name,
port,
zone
FROM ovh.ip_loadbalancing.udp_farms
WHERE farm_id = '{{ farm_id }}' -- required
AND service_name = '{{ service_name }}' -- required
;

list

List UDP farms (Beta version)

SELECT
farm_id,
vrack_network_id,
display_name,
port,
zone
FROM ovh.ip_loadbalancing.udp_farms
WHERE service_name = '{{ service_name }}' -- required
AND vrack_network_id = '{{ vrack_network_id }}'
AND zone = '{{ zone }}'
AND x_pagination_mode = '{{ x_pagination_mode }}'
;

INSERT examples

create

Create a UDP farm (Beta version)

INSERT INTO ovh.ip_loadbalancing.udp_farms (
display_name,
port,
vrack_network_id,
zone,
service_name
)
SELECT 
'{{ display_name }}',
{{ port }} /* required */,
{{ vrack_network_id }},
'{{ zone }}' /* required */,
'{{ service_name }}'
RETURNING
farm_id,
vrack_network_id,
display_name,
port,
zone
;

Manifest

# Description fields are for documentation purposes
- name: udp_farms
props:
  - name: service_name
    value: "{{ service_name }}"
    description: Required parameter for the udp_farms resource.
  - name: display_name
    value: "{{ display_name }}"
    description: |
      Human readable name for your backend, this field is for you
  - name: port
    value: {{ port }}
    description: |
      Port attached to your farm ([1..49151]). Inherited from frontend if null
  - name: vrack_network_id
    value: {{ vrack_network_id }}
    description: |
      Internal Load Balancer identifier of the vRack private network to attach to your farm, mandatory when your Load Balancer is attached to a vRack
  - name: zone
    value: "{{ zone }}"
    description: |
      Zone of your farm

UPDATE examples

update

Update a UDP farm (Beta version)

UPDATE ovh.ip_loadbalancing.udp_farms
SET 
display_name = '{{ display_name }}',
port = {{ port }},
vrack_network_id = {{ vrack_network_id }}
WHERE 
farm_id = '{{ farm_id }}' --required
AND service_name = '{{ service_name }}' --required;

DELETE examples

delete

Delete a UDP farm (Beta version)

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