xcsh_dns_lb_health_check (Data Source)

Retrieves information about DNS Load Balancer Health Check 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

# DNSLBHealthCheck Data Source Example

terraform {
  required_version = ">= 1.0"

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

# Look up an existing DNSLBHealthCheck by name
data "xcsh_dns_lb_health_check" "example" {
  name      = "example-dns-lb-health-check"
  namespace = "system"
}

output "dns_lb_health_check_id" {
  value = data.xcsh_dns_lb_health_check.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 DNSLBHealthCheck

• namespace - Optional String
Namespace where the DNSLBHealthCheck exists

Attributes Reference

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

• annotations - Optional Map
Annotations applied to this resource

• description - Optional String
Description of the DNSLBHealthCheck

• http_health_check - Optional String
Configuration parameter for HTTP health check

• https_health_check - Optional String
Configuration parameter for HTTPS health check

• icmp_health_check - Optional Object
Configuration parameter for ICMP health check

• id - Optional String
Unique identifier for the resource

• labels - Optional Map
Labels applied to this resource

• tcp_health_check - Optional String
Configuration parameter for TCP health check

• tcp_hex_health_check - Optional String
Configuration parameter for TCP hex health check

• udp_health_check - Optional String
Configuration parameter for UDP health check

• disable_virtual_host - Optional Object
Enable this option

• health_check_port - Optional Number
Health Check Port. Port used for performing health check

• health_check_secondary_port - Optional Number
Secondary port used for performing health check. If included, both ports must be healthy for the health check to pass

• receive - Optional String
Regular expression used to match against the response to the health check’s request. Mark node up upon receipt of a successful regular expression match. Uses re2 regular expression syntax

• send - Optional String
Send String. HTTP payload to send to the target

• virtual_host - Optional String
Name of the virtual host to use for SNI

• disable_virtual_host - Optional Object
Enable this option

• health_check_port - Optional Number
Health Check Port. Port used for performing health check

• health_check_secondary_port - Optional Number
Secondary port used for performing health check. If included, both ports must be healthy for the health check to pass

• receive - Optional String
Regular expression used to match against the response to the health check’s request. Mark node up upon receipt of a successful regular expression match. Uses re2 regular expression syntax

• send - Optional String
Send String. HTTP payload to send to the target

• virtual_host - Optional String
Name of the virtual host to use for SNI

• health_check_port - Optional Number
Health Check Port. Port used for performing health check

• health_check_secondary_port - Optional Number
Secondary port used for performing health check. If included, both ports must be healthy for the health check to pass

• receive - Optional String
Regular expression used to match against the response to the monitor’s request. Mark node up upon receipt of a successful regular expression match. Uses re2 regular expression syntax

• send - Optional String
Send this string to target (default empty. When send and receive are both empty, monitor just tests 3WHS)

• health_check_port - Optional Number
Health Check Port. Port used for performing health check

• health_check_secondary_port - Optional Number
Secondary port used for performing health check. If included, both ports must be healthy for the health check to pass

• receive - Optional String
Hex encoded raw bytes expected in the response

• send - Optional String
Hex encoded raw bytes sent in the request. Empty payloads imply a connect-only health check

• health_check_port - Optional Number
Health Check Port. Port used for performing health check

• health_check_secondary_port - Optional Number
Secondary port used for performing health check. If included, both ports must be healthy for the health check to pass

• receive - Optional String
UDP response to be matched. It can be a regex

• send - Optional String
Send String. UDP payload

---

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