UDP Loadbalancer

Shape of the UDP load balancer replace specification.

Tools

Tool	Description
`f5xc-api-virtual-udp-loadbalancer-create`	Create UDP Load Balancer.
`f5xc-api-virtual-udp-loadbalancer-get`	GET UDP Load Balancer.
`f5xc-api-virtual-udp-loadbalancer-list`	List Configure UDP Load Balancer.
`f5xc-api-virtual-udp-loadbalancer-update`	Replace UDP Load Balancer.
`f5xc-api-virtual-udp-loadbalancer-delete`	DELETE Configure UDP Load Balancer.

Parameters

Path Parameters

Parameter	Description	Example
`metadata.namespace`	Namespace	`-`
`name`	Name	`-`
`namespace`	Namespace	`-`
`metadata.name`	Name	`-`

Query Parameters

Parameter	Description	Example
`response_format`	The format in which the configuration object is to be fetched. This could be for example	`-`
`label_filter`	A LabelSelectorType expression that every item in list response will satisfy.	`-`
`report_fields`	The report_fields parameter	`-`
`report_status_fields`	The report_status_fields parameter	`-`

Configuration Choices

This resource includes mutually exclusive configuration options:

advertise_choice

Option	Description	Recommended
`spec.advertise_custom`	-
`spec.advertise_on_public`	-
`spec.advertise_on_public_default_vip`	-
`spec.do_not_advertise`	-

cluster_retract_choice

Option	Description	Recommended

hash_policy_choice

Option	Description	Recommended
`spec.hash_policy_choice_random`	-
`spec.hash_policy_choice_round_robin`	-
`spec.hash_policy_choice_source_ip_stickiness`	-

loadbalancer_type

Option	Description	Recommended
`spec.udp`	-

port_choice

Option	Description	Recommended
`spec.listen_port`	-
`spec.port_ranges`	-

choice

Option	Description	Recommended
`spec.advertise_custom.advertise_where[].advertise_on_public`	-
`spec.advertise_custom.advertise_where[].cloud_edge_segment`	-
`spec.advertise_custom.advertise_where[].segment`	-
`spec.advertise_custom.advertise_where[].site`	-
`spec.advertise_custom.advertise_where[].site_segment`	-
`spec.advertise_custom.advertise_where[].virtual_network`	-
`spec.advertise_custom.advertise_where[].virtual_site`	-
`spec.advertise_custom.advertise_where[].virtual_site_segment`	-
`spec.advertise_custom.advertise_where[].virtual_site_with_vip`	-
`spec.advertise_custom.advertise_where[].vk8s_service`	-

v6_vip_choice

Option	Description	Recommended
`spec.advertise_custom.advertise_where[].virtual_network.default_v6_vip`	-
`spec.advertise_custom.advertise_where[].virtual_network.specific_v6_vip`	-

vip_choice

Option	Description	Recommended
`spec.advertise_custom.advertise_where[].virtual_network.default_vip`	-
`spec.advertise_custom.advertise_where[].virtual_network.specific_vip`	-

pool_choice

Option	Description	Recommended
`spec.origin_pools_weights[].cluster`	-
`spec.origin_pools_weights[].pool`	-

Example Usage

Ask Claude to help you work with UDP Loadbalancer resources:

Create UDP Loadbalancer

“Create a udp-loadbalancer named ‘example’ in the ‘production’ namespace”

List UDP Loadbalancers

“List all udp-loadbalancers in the ‘production’ namespace”

Get UDP Loadbalancer Details

“Get details of the udp-loadbalancer named ‘example’ in namespace ‘production‘“

CURL Examples

# List resources
curl -X GET "https://${TENANT}.console.ves.volterra.io/api/config/namespaces/${NAMESPACE}/udp_loadbalancers" \
  -H "Authorization: APIToken ${F5XC_API_TOKEN}" \
  -H "Content-Type: application/json"

# Get specific resource
curl -X GET "https://${TENANT}.console.ves.volterra.io/api/config/namespaces/${NAMESPACE}/udp_loadbalancers/<name>" \
  -H "Authorization: APIToken ${F5XC_API_TOKEN}" \
  -H "Content-Type: application/json"

# Create resource
curl -X POST "https://${TENANT}.console.ves.volterra.io/api/config/namespaces/${NAMESPACE}/udp_loadbalancers" \
  -H "Authorization: APIToken ${F5XC_API_TOKEN}" \
  -H "Content-Type: application/json" \
  -d @udp_loadbalancer.json

# Delete resource
curl -X DELETE "https://${TENANT}.console.ves.volterra.io/api/config/namespaces/${NAMESPACE}/udp_loadbalancers/<name>" \
  -H "Authorization: APIToken ${F5XC_API_TOKEN}"