xcsh_dns_lb_pool (Data Source)

Retrieves information about DNS Load Balancer Pool in a given namespace. If one already exist it will give a error in F5 Distributed Cloud. This is a read-only data source.

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

Example Usage

# DNSLBPool Data Source Example

terraform {
  required_version = ">= 1.0"

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

# Look up an existing DNSLBPool by name
data "xcsh_dns_lb_pool" "example" {
  name      = "example-dns-lb-pool"
  namespace = "system"
}

output "dns_lb_pool_id" {
  value = data.xcsh_dns_lb_pool.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 DNSLBPool

• namespace - Optional String
Namespace where the DNSLBPool exists

Attributes Reference

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

• a_pool - Optional String
Pool for A Record

• aaaa_pool - Optional String
Pool for AAAA Record

• annotations - Optional Map
Annotations applied to this resource

• cname_pool - Optional String
Pool for CNAME Record

• description - Optional String
Description of the DNSLBPool

• id - Optional String
Unique identifier for the resource

• labels - Optional Map
Labels applied to this resource

• load_balancing_mode - Optional 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

• mx_pool - Optional String
Pool for MX Record

• srv_pool - Optional String
Pool for SRV Record

• ttl - Optional Number
Custom TTL in seconds (default 30) for responses from this pool

• use_rrset_ttl - Optional Object
Configuration parameter for use rrset TTL

• disable_health_check - Optional Object
Configuration parameter for disable health check

• health_check - 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

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

• members - Optional List
Pool Members. Configuration parameter for members

• 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

• 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