TCP Load Balancer

TCP Load Balancer provides tools for creating, listing, retrieving, updating, and deleting resources in F5 Distributed Cloud.

Tools

Tool	Description
`f5xc-api-virtual-tcp-loadbalancer-create`	Create TCP Load Balancer.
`f5xc-api-virtual-tcp-loadbalancer-get`	Get TCP Load Balancer.
`f5xc-api-virtual-tcp-loadbalancer-list`	List Configure TCP Load Balancer.
`f5xc-api-virtual-tcp-loadbalancer-update`	Update TCP Load Balancer.
`f5xc-api-virtual-tcp-loadbalancer-delete`	Delete Configure TCP Load Balancer.

Parameters

Path Parameters

Parameter	Description	Example
`namespace`	Namespace This defines the workspace within which each the configuration object is to be created.	`system`
`name`	Name The name of the configuration object to be fetched.	`example-resource`

Query Parameters

Parameter	Description	Example
`response_format`	The format in which the configuration object is to be fetched. This could be for example - in GetSpec form for the contents of object…	`GET_RSP_FORMAT_DEFAULT`
`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`	Advertise custom
`spec.advertise_on_public`	Advertise on public
`spec.advertise_on_public_default_vip`	Advertise on public default vip
`spec.do_not_advertise`	Do not advertise

cluster_retract_choice

Option	Description	Recommended
`spec.do_not_retract_cluster`	Do not retract cluster
`spec.retract_cluster`	Retract cluster

hash_policy_choice

Option	Description	Recommended
`spec.hash_policy_choice_least_active`	Hash policy choice least active
`spec.hash_policy_choice_random`	Hash policy choice random
`spec.hash_policy_choice_round_robin`	Hash policy choice round robin
`spec.hash_policy_choice_source_ip_stickiness`	Hash policy choice source ip stickiness

loadbalancer_type

Option	Description	Recommended
`spec.tcp`	Tcp
`spec.tls_tcp`	Tls tcp
`spec.tls_tcp_auto_cert`	Tls tcp auto cert

port_choice

Option	Description	Recommended
`spec.listen_port`	Listen port
`spec.port_ranges`	Port ranges

service_policy_choice

Option	Description	Recommended
`spec.active_service_policies`	Active service policies
`spec.no_service_policies`	No service policies
`spec.service_policies_from_namespace`	Service policies from namespace

sni_default_lb_choice

Option	Description	Recommended
`spec.default_lb_with_sni`	Default lb with sni
`spec.no_sni`	No sni
`spec.sni`	Sni

Example Usage

Ask Claude to help you work with TCP Load Balancer resources:

Create TCP Load Balancer

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

List TCP Load Balancers

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

Get TCP Load Balancer Details

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

CURL Examples

# List resources
curl -X GET "https://${TENANT}.console.ves.volterra.io/api/config/namespaces/$${PARAM}/tcp_loadbalancers" \
  -H "Authorization: APIToken ${F5XC_API_TOKEN}"

# Get specific resource
curl -X GET "https://${TENANT}.console.ves.volterra.io/api/config/namespaces/$${PARAM}/tcp_loadbalancers/$${PARAM}" \
  -H "Authorization: APIToken ${F5XC_API_TOKEN}"

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

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