xcsh_dns_lb_pool (Resource)

Manages DNS Load Balancer Pool in a given namespace. If one already exist it will give a error. in F5 Distributed Cloud.

~> Note For more information about this resource, please refer to the F5 XC API Documentation.

Example Usage

# DNSLBPool Resource Example
# Manages DNS Load Balancer Pool in a given namespace.

terraform {
  required_version = ">= 1.0"

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

# Basic DNSLBPool configuration
resource "xcsh_dns_lb_pool" "example" {
  name      = "example-dns-lb-pool"
  namespace = "system"

  load_balancing_mode = "ROUND_ROBIN"
}

Argument Reference

-> Syntax Rule: This provider uses OneOf groups for mutually exclusive options. Fields documented as “Optional Block” use empty block syntax field_name {}, never field_name = true. Boolean attributes (like add_hsts, http_redirect) use = true/false as normal.

🔶 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 DNS LB Pool. Must be unique within the namespace

• annotations - Optional Map
Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata

• description - Optional String
Human readable description for the object

• disable - Optional Bool
A value of true will administratively disable the object

• labels - Optional Map
Labels is a user defined key value map that can be attached to resources for organization and filtering

• namespace - Optional String
Namespace for the DNS LB Pool. The F5 XC API restricts this resource to the system namespace; it defaults to that value and may be omitted

Spec Argument Reference

-> One of the following: • a_pool - Optional Block
Pool for A Record
See A Pool below for details.

• aaaa_pool - Optional Block
Pool for AAAA Record
See Aaaa Pool below for details.

• cname_pool - Optional Block
Pool for CNAME Record
See Cname Pool below for details.

• mx_pool - Optional Block
Pool for MX Record
See Mx Pool below for details.

• srv_pool - Optional Block
Pool for SRV Record
See Srv Pool below for details.

• load_balancing_mode - Required String Defaults to ROUND_ROBIN
Possible values are ROUND_ROBIN, RATIO_MEMBER, STATIC_PERSIST, PRIORITY
[Enum: ROUND_ROBIN|RATIO_MEMBER|STATIC_PERSIST|PRIORITY] - ROUND_ROBIN: Round-Robin Round Robin will ensure random equal distribution of requests among all pool members in a pool. - RATIO_MEMBER: Ratio-Member Ratio-Member performs load balancing of requests across the pool members based on the ratio assigned to each pool member - STATIC_PERSIST

• timeouts - Optional Block
See Timeouts below for details.

-> One of the following: • ttl - Optional Number
Custom TTL in seconds (default 30) for responses from this pool

• use_rrset_ttl - Optional Block
Configuration parameter for use rrset TTL

Attributes Reference

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

• id - Optional String
Unique identifier for the resource

---

A Pool

An a_pool block supports the following:

• disable_health_check - Optional Block
Configuration parameter for disable health check

• health_check - Optional Block
Type establishes a direct reference from one object(the referrer) to another(the referred). Such a reference is in form of tenant/namespace/name
See Health Check below.

• max_answers - Optional Number
Limit on number of Resource Records to be included in the response to query

• members - Optional Block
Pool Members
See Members below.

A Pool Health Check

A health_check block (within a_pool) supports the following:

• 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

A Pool Members

A members block (within a_pool) supports the following:

• disable_spec - Optional Bool
Value of true will disable the pool-member

• ip_endpoint - Optional String
Public IP. Public IP address

• name - Optional String
Name. Pool member name

• priority - Optional Number
Used if the pool’s load balancing mode is set to Priority

• ratio - Optional Number
Used if the pool’s load balancing mode is set to Ratio-Member

Aaaa Pool

An aaaa_pool block supports the following:

• max_answers - Optional Number
Limit on number of Resource Records to be included in the response to query

• members - Optional Block
Pool Members
See Members below.

Aaaa Pool Members

A members block (within aaaa_pool) supports the following:

• disable_spec - Optional Bool
Value of true will disable the pool-member

• ip_endpoint - Optional String
Public IP. Public IP address

• name - Optional String
Name. Pool member name

• priority - Optional Number
Used if the pool’s load balancing mode is set to Priority

• ratio - Optional Number
Used if the pool’s load balancing mode is set to Ratio-Member

Cname Pool

A cname_pool block supports the following:

• disable_health_check - Optional Block
Configuration parameter for disable health check

• health_check - Optional Block
Type establishes a direct reference from one object(the referrer) to another(the referred). Such a reference is in form of tenant/namespace/name
See Health Check below.

• members - Optional Block
Pool Members
See Members below.

Cname Pool Health Check

A health_check block (within cname_pool) supports the following:

• 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

Cname Pool Members

A members block (within cname_pool) supports the following:

• domain - Optional String
Specifies the fully qualified domain name

• final_translation - Optional Bool
If this flag is true, the CNAME record will not be translated further

• name - Optional String
Name. Pool member name

• priority - Optional Number
Used if the pool’s load balancing mode is set to Priority. Determines the order in which traffic is routed to pool members. The lower the number, the higher the priority, making those members active while higher-numbered members act as backups

• ratio - Optional Number
Used if the pool’s load balancing mode is set to Ratio-Member

Mx Pool

A mx_pool block supports the following:

• max_answers - Optional Number
Limit on number of Resource Records to be included in the response to query

• members - Optional Block
Pool Members
See Members below.

Mx Pool Members

A members block (within mx_pool) supports the following:

• domain - Optional String
Domain

• name - Optional String
Name. Pool member name

• priority - Optional Number
MX Record Priority. MX Record priority

• ratio - Optional Number
Load Balancing Ratio. Load Balancing Ratio

Srv Pool

A srv_pool block supports the following:

• max_answers - Optional Number
Limit on number of Resource Records to be included in the response to query

• members - Optional Block
Pool Members
See Members below.

Srv Pool Members

A members block (within srv_pool) supports the following:

• final_translation - Optional Bool
If this flag is true, the SRV record will not be translated further

• name - Optional String
Name. Pool member name

• port - Optional Number
Port on which the service can be found

• priority - Optional Number
Priority of the target. A lower number indicates a higher preference

• ratio - Optional Number
Load Balancing Ratio. Configuration parameter for ratio

• target - Optional String
Domain name of the machine providing the service

• weight - Optional Number
Weight of the target. A higher number indicates a higher preference

Timeouts

A timeouts block supports the following:

• create - Optional String (Defaults to 10 minutes)
Used when creating the resource

• delete - Optional String (Defaults to 10 minutes)
Used when deleting the resource

• read - Optional String (Defaults to 5 minutes)
Used when retrieving the resource

• update - Optional String (Defaults to 10 minutes)
Used when updating the resource

---

Common Types

The following type definitions are used throughout this resource. See the full definition here rather than repeated inline.

Object Reference {#common-object-reference}

Object references establish a direct reference from one configuration object to another in F5 Distributed Cloud. References use the format tenant/namespace/name.

Field	Type	Description
name	String	Name of the referenced object
namespace	String	Namespace containing the referenced object
tenant	String	Tenant of the referenced object (system-managed)

Transformers {#common-transformers}

Transformers apply transformations to input values before matching. Multiple transformers can be applied in order.

Value	Description
LOWER_CASE	Convert to lowercase
UPPER_CASE	Convert to uppercase
BASE64_DECODE	Decodebase64 content
NORMALIZE_PATH	Normalize URL path
REMOVE_WHITESPACE	Remove whitespace characters
URL_DECODE	Decode URL-encoded characters
TRIM_LEFT	Trim leading whitespace
TRIM_RIGHT	Trim trailing whitespace
TRIM	Trim both leading and trailing whitespace

HTTP Methods {#common-http-methods}

HTTP methods used for request matching.

Value	Description
ANY	Match any HTTP method
GET	HTTP GET request
HEAD	HTTP HEAD request
POST	HTTP POST request
PUT	HTTP PUT request
DELETE	HTTP DELETE request
CONNECT	HTTP CONNECT request
OPTIONS	HTTP OPTIONS request
TRACE	HTTP TRACE request
PATCH	HTTP PATCH request
COPY	HTTP COPY request (WebDAV)

TLS Fingerprints {#common-tls-fingerprints}

TLS fingerprint categories for malicious client detection.

Value	Description
TLS_FINGERPRINT_NONE	No fingerprint matching
ANY_MALICIOUS_FINGERPRINT	Match any known malicious fingerprint
ADWARE	Adware-associated fingerprints
DRIDEX	Dridex malware fingerprints
GOOTKIT	Gootkit malware fingerprints
RANSOMWARE	Ransomware-associated fingerprints
TRICKBOT	Trickbot malware fingerprints

IP Threat Categories {#common-ip-threat-categories}

IP address threat categories for security filtering.

Value	Description
SPAM_SOURCES	Known spam sources
WINDOWS_EXPLOITS	Windows exploit sources
WEB_ATTACKS	Web attack sources
BOTNETS	Known botnet IPs
SCANNERS	Network scanner IPs
REPUTATION	Poor reputation IPs
PHISHING	Phishing-related IPs
PROXY	Anonymous proxy IPs
MOBILE_THREATS	Mobile threat sources
TOR_PROXY	Tor exit nodes
DENIAL_OF_SERVICE	DoS attack sources
NETWORK	Known bad network ranges

Import

Import is supported using the following syntax:

# Import using namespace/name format
terraform import xcsh_dns_lb_pool.example system/example