xcsh_dns_lb_health_check (Resource)

Manages DNS Load Balancer Health Check 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

# DNSLBHealthCheck Resource Example
# Manages DNS Load Balancer Health Check in a given namespace.

terraform {
  required_version = ">= 1.0"

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

# Basic DNSLBHealthCheck configuration
resource "xcsh_dns_lb_health_check" "example" {
  name      = "example-dns-lb-health-check"
  namespace = "system"
}

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 Health Check. 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 Health Check. 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: • http_health_check - Optional Block
Configuration parameter for HTTP health check
See HTTP Health Check below for details.

• https_health_check - Optional Block
Configuration parameter for HTTPS health check
See HTTPS Health Check below for details.

• icmp_health_check - Optional Block
Configuration parameter for ICMP health check

• tcp_health_check - Optional Block
Configuration parameter for TCP health check
See TCP Health Check below for details.

• tcp_hex_health_check - Optional Block
Configuration parameter for TCP hex health check
See TCP Hex Health Check below for details.

• udp_health_check - Optional Block
Configuration parameter for UDP health check
See UDP Health Check below for details.

• timeouts - Optional Block
See Timeouts below for details.

Attributes Reference

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

• id - Optional String
Unique identifier for the resource

HTTP Health Check

A http_health_check block supports the following:

• disable_virtual_host - Optional Block
Enable this option

• health_check_port - Optional Number
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

HTTPS Health Check

A https_health_check block supports the following:

• disable_virtual_host - Optional Block
Enable this option

• health_check_port - Optional Number
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

• 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

TCP Health Check

A tcp_health_check block supports the following:

• health_check_port - Optional Number
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)

TCP Hex Health Check

A tcp_hex_health_check block supports the following:

• health_check_port - Optional Number
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

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

UDP Health Check

An udp_health_check block supports the following:

• health_check_port - Optional Number
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

Import

Import is supported using the following syntax:

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