udp_frontends

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

Overview

Name	udp_frontends
Type	Resource
Id	ovh.ip_loadbalancing.udp_frontends

Fields

The following fields are returned by SELECT queries:

get

successful operation

Name	Datatype	Description
default_farm_id	integer	Default UDP Farm of your frontend (wire: defaultFarmId)
frontend_id	integer	Id of your frontend (wire: frontendId)
display_name	string	Human readable name for your frontend, this field is for you (wire: displayName)
dedicated_ipfo	array	Only attach frontend on these ip. No restriction if null (wire: dedicatedIpfo)
disabled	boolean	Disable frontend. Default: 'false'
port	string	Listening port(s) on the server
zone	string	Zone of you frontend

list

Frontend UDP

Name	Datatype	Description
default_farm_id	integer	Default UDP Farm of your frontend (wire: defaultFarmId)
frontend_id	integer	Id of your frontend (wire: frontendId)
display_name	string	Human readable name for your frontend, this field is for you (wire: displayName)
dedicated_ipfo	array	Only attach frontend on these ip. No restriction if null (wire: dedicatedIpfo)
disabled	boolean	Disable frontend. Default: 'false'
port	string	Listening port(s) on the server
zone	string	Zone of you frontend

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	frontend_id, service_name		Get a UDP frontend (Beta version)
list	select	service_name	default_farm_id, port, zone, x_pagination_mode	List UDP frontends (Beta version)
create	insert	service_name, port, zone		Create a UDP frontend (Beta version)
update	update	frontend_id, service_name		Update a UDP frontend (Beta version)
delete	delete	frontend_id, service_name		Delete a UDP frontend (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"}})
frontend_id	integer	Id of your frontend (wire: frontendId)
service_name	string	The internal name of your IP load balancing (wire: serviceName)
default_farm_id	integer	Filter the value of defaultFarmId property (=) (wire: defaultFarmId)
port	string	Filter the value of port property (like)
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 frontend (Beta version)

SELECT
default_farm_id,
frontend_id,
display_name,
dedicated_ipfo,
disabled,
port,
zone
FROM ovh.ip_loadbalancing.udp_frontends
WHERE frontend_id = '{{ frontend_id }}' -- required
AND service_name = '{{ service_name }}' -- required
;

list

List UDP frontends (Beta version)

SELECT
default_farm_id,
frontend_id,
display_name,
dedicated_ipfo,
disabled,
port,
zone
FROM ovh.ip_loadbalancing.udp_frontends
WHERE service_name = '{{ service_name }}' -- required
AND default_farm_id = '{{ default_farm_id }}'
AND port = '{{ port }}'
AND zone = '{{ zone }}'
AND x_pagination_mode = '{{ x_pagination_mode }}'
;

INSERT examples

create

Create a UDP frontend (Beta version)

INSERT INTO ovh.ip_loadbalancing.udp_frontends (
dedicated_ipfo,
default_farm_id,
disabled,
display_name,
port,
zone,
service_name
)
SELECT 
'{{ dedicated_ipfo }}',
{{ default_farm_id }},
{{ disabled }},
'{{ display_name }}',
'{{ port }}' /* required */,
'{{ zone }}' /* required */,
'{{ service_name }}'
RETURNING
default_farm_id,
frontend_id,
display_name,
dedicated_ipfo,
disabled,
port,
zone
;

Manifest

# Description fields are for documentation purposes
- name: udp_frontends
props:
  - name: service_name
    value: "{{ service_name }}"
    description: Required parameter for the udp_frontends resource.
  - name: dedicated_ipfo
    value:
      - "{{ dedicated_ipfo }}"
    description: |
      Only attach frontend on these ip. No restriction if null
  - name: default_farm_id
    value: {{ default_farm_id }}
    description: |
      Default UDP Farm of your frontend
  - name: disabled
    value: {{ disabled }}
    description: |
      Disable your frontend. Default: 'false'
  - name: display_name
    value: "{{ display_name }}"
    description: |
      Human readable name for your frontend, this field is for you
  - name: port
    value: "{{ port }}"
    description: |
      Port(s) attached to your frontend. Supports single port (numerical value), range (2 dash-delimited increasing ports) and comma-separated list of 'single port' and/or 'range'. Each port must be in the [1;49151] range.
  - name: zone
    value: "{{ zone }}"
    description: |
      Zone of your frontend. Use "all" for all owned zone.

UPDATE examples

update

Update a UDP frontend (Beta version)

UPDATE ovh.ip_loadbalancing.udp_frontends
SET 
dedicated_ipfo = '{{ dedicated_ipfo }}',
default_farm_id = {{ default_farm_id }},
disabled = {{ disabled }},
display_name = '{{ display_name }}',
port = '{{ port }}',
zone = '{{ zone }}'
WHERE 
frontend_id = '{{ frontend_id }}' --required
AND service_name = '{{ service_name }}' --required;

DELETE examples

delete

Delete a UDP frontend (Beta version)

DELETE FROM ovh.ip_loadbalancing.udp_frontends
WHERE frontend_id = '{{ frontend_id }}' --required
AND service_name = '{{ service_name }}' --required
;