xcsh_udp_loadbalancer (Data Source)

Retrieves information about a UDP Load Balancer resource in F5 Distributed Cloud for load balancing UDP traffic across origin pools. This is a read-only data source.

~> Note: For more information, see the F5 Distributed Cloud API documentation.

Example Usage

# UDPLoadBalancer Data Source Example

terraform {
  required_version = ">= 1.0"

  required_providers {
    xcsh = {
      source  = "f5-sales-demo/xcsh"
      version = ">= 0.1.0"
    }
  }
}

# Look up an existing UDPLoadBalancer by name
data "xcsh_udp_loadbalancer" "example" {
  name      = "example-udp-loadbalancer"
  namespace = "staging"
}

output "udp_loadbalancer_id" {
  value = data.xcsh_udp_loadbalancer.example.id
}

Argument Reference

-> Syntax Rule: This provider uses OneOf groups for mutually exclusive options. Fields documented as “Optional Block” use block syntax field_name { ... }. Empty OneOf object attributes use field_name = {}; conditional selection uses condition ? {} : null. Boolean attributes (such as add_hsts and http_redirect) use = true or = false.

🔶 High Risk Operations — Some operations on this resource have high danger level. Destructive operations may require confirmation.

Metadata Argument Reference

• name - Required String
Name of the UDPLoadBalancer

• namespace - Required String
Namespace where the UDPLoadBalancer exists

Attributes Reference

In addition to all arguments above, the following attributes are exported:

• active_service_policies - Optional String
Configuration parameter for active service policies

• advertise_custom - Optional String
Defines a way to advertise a VIP on specific sites

• advertise_on_public - Optional String
Defines a way to advertise a load balancer on public. If optional public_ip is provided, it will only be advertised on RE sites where that public_ip is available

• advertise_on_public_default_vip - Optional Object
Enable this option

• annotations - Optional Map
Annotations applied to this resource

• description - Optional String
Description of the UDPLoadBalancer

• dns_volterra_managed - Optional Bool
DNS records for domains will be managed automatically by F5 Distributed Cloud. As a prerequisite, the domain to be delegated to F5 Distributed Cloud using the Delegated Domain feature or a DNS CNAME record must be created in your DNS provider’s portal

• do_not_advertise - Optional Object
Configuration parameter for do not advertise

• domains - Optional List
List of domains (host/authority header) that will be matched to this load balancer

• hash_policy_choice_random - Optional Object
Configuration parameter for hash policy choice random

• hash_policy_choice_round_robin - Optional Object
Configuration parameter for hash policy choice round robin

• hash_policy_choice_source_ip_stickiness - Optional Object
Enable this option

• id - Optional String
Unique identifier for the resource

• idle_timeout - Optional Number
The amount of time that a session can exist without upstream or downstream activity, in milliseconds

• labels - Optional Map
Labels applied to this resource

• listen_port - Optional Number
Listen Port for this load balancer

• no_service_policies - Optional Object
Configuration parameter for no service policies

• origin_pools_weights - Optional List
Origin pools with weights and priorities used for this load balancer

• port_ranges - Optional String
A string containing a comma separated list of port ranges. Each port range consists of a single port or two ports separated by ’-’

• service_policies_from_namespace - Optional Object
Enable this option

• udp - Optional String
Enable this option

• policies - Optional List
Service Policies is a sequential engine where policies (and rules within the policy) are evaluated one after the other. It’s important to define the correct order (policies evaluated from top to bottom in the list) for service policies, to GET the intended result. For each request, its

• name - Optional String
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object’s(e.g. Route’s) name

• namespace - Optional String
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object’s(e.g. Route’s) namespace

• tenant - Optional String
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then tenant will hold the referred object’s(e.g. Route’s) tenant

• advertise_where - Optional List
Where should this load balancer be available

• port - Optional Number
Port to Listen

• port_ranges - Optional String
A string containing a comma separated list of port ranges. Each port range consists of a single port or two ports separated by ’-’

• site - Optional String
Defines a reference to a CE site along with network type and an optional IP address where a load balancer could be advertised

• use_default_port - Optional Object
Enable this option

• virtual_network - Optional String
Parameters to advertise on a given virtual network

• virtual_site - Optional String
Defines a reference to a customer site virtual site along with network type where a load balancer could be advertised

• virtual_site_with_vip - Optional String
Defines a reference to a customer site virtual site along with network type and IP where a load balancer could be advertised

• vk8s_service - Optional String
Defines a reference to a RE site or virtual site where a load balancer could be advertised in the vK8s service network

• public_ip - Optional String
Type establishes a direct reference from one object(the referrer) to another(the referred). Such a reference is in form of tenant/namespace/name

• name - Optional String
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object’s(e.g. Route’s) name

• namespace - Optional String
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object’s(e.g. Route’s) namespace

• tenant - Optional String
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then tenant will hold the referred object’s(e.g. Route’s) tenant

• ip - Optional String
Use given IP address as VIP on the site

• network - Optional String Defaults to SITE_NETWORK_INSIDE_AND_OUTSIDE
Possible values are SITE_NETWORK_INSIDE_AND_OUTSIDE, SITE_NETWORK_INSIDE, SITE_NETWORK_OUTSIDE, SITE_NETWORK_SERVICE, SITE_NETWORK_OUTSIDE_WITH_INTERNET_VIP, SITE_NETWORK_INSIDE_AND_OUTSIDE_WITH_INTERNET_VIP, SITE_NETWORK_IP_FABRIC
[Enum: SITE_NETWORK_INSIDE_AND_OUTSIDE|SITE_NETWORK_INSIDE|SITE_NETWORK_OUTSIDE|SITE_NETWORK_SERVICE|SITE_NETWORK_OUTSIDE_WITH_INTERNET_VIP|SITE_NETWORK_INSIDE_AND_OUTSIDE_WITH_INTERNET_VIP|SITE_NETWORK_IP_FABRIC] Defines network types to be used on site All inside and outside networks. All inside and outside networks with internet VIP support. All inside networks

• site - Optional String
Type establishes a direct reference from one object(the referrer) to another(the referred). Such a reference is in form of tenant/namespace/name

• name - Optional String
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object’s(e.g. Route’s) name

• namespace - Optional String
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object’s(e.g. Route’s) namespace

• tenant - Optional String
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then tenant will hold the referred object’s(e.g. Route’s) tenant

• default_v6_vip - Optional Object
Enable this option

• default_vip - Optional Object
Enable this option

• specific_v6_vip - Optional String
Use given IPv6 address as VIP on virtual Network

• specific_vip - Optional String
Use given IPv4 address as VIP on virtual Network

• virtual_network - Optional String
Type establishes a direct reference from one object(the referrer) to another(the referred). Such a reference is in form of tenant/namespace/name

• name - Optional String
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object’s(e.g. Route’s) name

• namespace - Optional String
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object’s(e.g. Route’s) namespace

• tenant - Optional String
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then tenant will hold the referred object’s(e.g. Route’s) tenant

• virtual_site - Optional String
Type establishes a direct reference from one object(the referrer) to another(the referred). Such a reference is in form of tenant/namespace/name

• name - Optional String
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object’s(e.g. Route’s) name

• namespace - Optional String
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object’s(e.g. Route’s) namespace

• tenant - Optional String
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then tenant will hold the referred object’s(e.g. Route’s) tenant

• ip - Optional String
Use given IP address as VIP on the site

• network - Optional String Defaults to SITE_NETWORK_SPECIFIED_VIP_OUTSIDE
Possible values are SITE_NETWORK_SPECIFIED_VIP_OUTSIDE, SITE_NETWORK_SPECIFIED_VIP_INSIDE
[Enum: SITE_NETWORK_SPECIFIED_VIP_OUTSIDE|SITE_NETWORK_SPECIFIED_VIP_INSIDE] Defines network types to be used on virtual-site with specified VIP All outside networks. All inside networks