xcsh_dns_zone (Resource)

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

~> Note Please refer to DNS Zone API docs to learn more.

Example Usage

# DNSZone Resource Example
# Manages DNS Zone in a given namespace.

terraform {
  required_version = ">= 1.0"

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

# Basic DNSZone configuration
resource "xcsh_dns_zone" "example" {
  name      = "example-dns-zone"
  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
Domain name for the DNS Zone (e.g., example.com). Must be a valid DNS domain name

• 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 Zone. 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: • primary - Optional Block
PrimaryDNSCreateSpecType
See Primary below for details.

• secondary - Optional Block
SecondaryDNSCreateSpecType

• timeouts - Optional Block

Attributes Reference

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

• id - Optional String
Unique identifier for the resource

Primary

A primary block supports the following:

• allow_http_lb_managed_records - Optional Bool
Option to allow user-created HTTP, TCP, and CDN load balancer related resource records to be automatically managed in a protected RRset

• default_rr_set_group - Optional Block
Add and manage DNS resource record sets part of Default set group
See Default Rr Set Group below.

• default_soa_parameters - Optional Block
Configuration parameter for default soa parameters

• dnssec_mode - Optional Block
Disable
See Dnssec Mode below.

• rr_set_group - Optional Block
Create and manage set groups, and resource record sets within them, x-VES-I/O-managed set is managed by F5
See Rr Set Group below.

• soa_parameters - Optional Block
Configuration parameter for soa parameters
See Soa Parameters below.

Primary Default Rr Set Group

A default_rr_set_group block (within primary) supports the following:

• a_record - Optional Block
DNSAResourceRecord. A Records
See A Record below.

• aaaa_record - Optional Block
Configuration parameter for aaaa record
See Aaaa Record below.

• afsdb_record - Optional Block
Configuration parameter for afsdb record
See Afsdb Record below.

• alias_record - Optional Block
Configuration parameter for alias record
See Alias Record below.

• caa_record - Optional Block
DNSCAAResourceRecord
See Caa Record below.

• cds_record - Optional Block
DNS CDS Record. DNS CDS Record
See Cds Record below.

• cert_record - Optional Block
Configuration parameter for cert record
See Cert Record below.

• cname_record - Optional Block
DNSCNAMEResourceRecord
See Cname Record below.

• description_spec - Optional String
Comment. Human-readable description text

• ds_record - Optional Block
DNS DS Record. DNS DS Record
See Ds Record below.

• eui48_record - Optional Block
Configuration parameter for eui48 record
See Eui48 Record below.

• eui64_record - Optional Block
Configuration parameter for eui64 record
See Eui64 Record below.

• lb_record - Optional Block
DNS Load Balancer Record. DNS Load Balancer Record
See LB Record below.

• loc_record - Optional Block
DNS LOC Record. DNS LOC Record
See Loc Record below.

• mx_record - Optional Block
DNSMXResourceRecord
See Mx Record below.

• naptr_record - Optional Block
Configuration parameter for naptr record
See Naptr Record below.

• ns_record - Optional Block
DNSNSResourceRecord
See Ns Record below.

• ptr_record - Optional Block
DNSPTRResourceRecord
See Ptr Record below.

• srv_record - Optional Block
DNSSRVResourceRecord
See Srv Record below.

• sshfp_record - Optional Block
Configuration parameter for sshfp record
See Sshfp Record below.

• tlsa_record - Optional Block
Configuration parameter for tlsa record
See Tlsa Record below.

• ttl - Optional Number
Time to live. Time-to-live duration in seconds

• txt_record - Optional Block
DNSTXTResourceRecord
See Txt Record below.

Primary Default Rr Set Group A Record

An a_record block (within primary.default_rr_set_group) supports the following:

• name - Optional String
Record name, please provide only the specific subdomain or record name without the base domain

• values - Optional List
IPv4 Addresses. A valid IPv4 address, for example: 192.0.2.1

Primary Default Rr Set Group Aaaa Record

An aaaa_record block (within primary.default_rr_set_group) supports the following:

• name - Optional String
AAAA Record name, please provide only the specific subdomain or record name without the base domain

• values - Optional List
IPv6 Addresses. A valid IPv6 address, for example: 2001:0db8:85a3:0000:0000:8a2e:0370:7334

Primary Default Rr Set Group Afsdb Record

An afsdb_record block (within primary.default_rr_set_group) supports the following:

• name - Optional String
AFSDB Record name, please provide only the specific subdomain or record name without the base domain

• values - Optional Block
AFSDB Value
See Values below.

Primary Default Rr Set Group Afsdb Record Values

Deeply nested Values block collapsed for readability.

Primary Default Rr Set Group Alias Record

An alias_record block (within primary.default_rr_set_group) supports the following:

• value - Optional String
Domain. A valid domain name, for example: example.com

Primary Default Rr Set Group Caa Record

A caa_record block (within primary.default_rr_set_group) supports the following:

• name - Optional String
CAA Record name, please provide only the specific subdomain or record name without the base domain

• values - Optional Block
CAA Record Value. Configuration parameter for values
See Values below.

Primary Default Rr Set Group Caa Record Values

Deeply nested Values block collapsed for readability.

Primary Default Rr Set Group Cds Record

A cds_record block (within primary.default_rr_set_group) supports the following:

• name - Optional String
CDS Record name, please provide only the specific subdomain or record name without the base domain

• values - Optional Block
DS Value
See Values below.

Primary Default Rr Set Group Cds Record Values

Deeply nested Values block collapsed for readability.

Primary Default Rr Set Group Cds Record Values Sha1 Digest

Deeply nested Digest block collapsed for readability.

Primary Default Rr Set Group Cds Record Values Sha256 Digest

Deeply nested Digest block collapsed for readability.

Primary Default Rr Set Group Cds Record Values Sha384 Digest

Deeply nested Digest block collapsed for readability.

Primary Default Rr Set Group Cert Record

A cert_record block (within primary.default_rr_set_group) supports the following:

• name - Optional String
CERT Record name, please provide only the specific subdomain or record name without the base domain

• values - Optional Block
CERT Value
See Values below.

Primary Default Rr Set Group Cert Record Values

Deeply nested Values block collapsed for readability.

Primary Default Rr Set Group Cname Record

A cname_record block (within primary.default_rr_set_group) supports the following:

• name - Optional String
CName Record name, please provide only the specific subdomain or record name without the base domain

• value - Optional String
Domain. Configuration parameter for value

Primary Default Rr Set Group Ds Record

A ds_record block (within primary.default_rr_set_group) supports the following:

• name - Optional String
DS Record name, please provide only the specific subdomain or record name without the base domain

• values - Optional Block
DS Value
See Values below.

Primary Default Rr Set Group Ds Record Values

Deeply nested Values block collapsed for readability.

Primary Default Rr Set Group Ds Record Values Sha1 Digest

Deeply nested Digest block collapsed for readability.

Primary Default Rr Set Group Ds Record Values Sha256 Digest

Deeply nested Digest block collapsed for readability.

Primary Default Rr Set Group Ds Record Values Sha384 Digest

Deeply nested Digest block collapsed for readability.

Primary Default Rr Set Group Eui48 Record

An eui48_record block (within primary.default_rr_set_group) supports the following:

• name - Optional String
EUI48 Record name, please provide only the specific subdomain or record name without the base domain

• value - Optional String
EUI48 Identifier. A valid eui48 identifier, for example: 01-23-45-67-89-ab

Primary Default Rr Set Group Eui64 Record

An eui64_record block (within primary.default_rr_set_group) supports the following:

• name - Optional String
EUI64 Record name, please provide only the specific subdomain or record name without the base domain

• value - Optional String
EUI64 Identifier. A valid EUI64 identifier, for example: 01-23-45-67-89-ab-cd-ef

Primary Default Rr Set Group LB Record

A lb_record block (within primary.default_rr_set_group) supports the following:

• name - Optional String
Load Balancer record name (except for SRV DNS Load balancer record) should be a simple record name and not a subdomain of a subdomain

• value - 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 Value below.

Primary Default Rr Set Group LB Record Value

Deeply nested Value block collapsed for readability.

Primary Default Rr Set Group Loc Record

A loc_record block (within primary.default_rr_set_group) supports the following:

• name - Optional String
LOC Record name, please provide only the specific subdomain or record name without the base domain

• values - Optional Block
LOC Value
See Values below.

Primary Default Rr Set Group Loc Record Values

Deeply nested Values block collapsed for readability.

Primary Default Rr Set Group Mx Record

A mx_record block (within primary.default_rr_set_group) supports the following:

• name - Optional String
MX Record name, please provide only the specific subdomain or record name without the base domain

• values - Optional Block
MX Record Value
See Values below.

Primary Default Rr Set Group Mx Record Values

Deeply nested Values block collapsed for readability.

Primary Default Rr Set Group Naptr Record

A naptr_record block (within primary.default_rr_set_group) supports the following:

• name - Optional String
NAPTR Record name, please provide only the specific subdomain or record name without the base domain

• values - Optional Block
NAPTR Value
See Values below.

Primary Default Rr Set Group Naptr Record Values

Deeply nested Values block collapsed for readability.

Primary Default Rr Set Group Ns Record

A ns_record block (within primary.default_rr_set_group) supports the following:

• name - Optional String
NS Record name, please provide only the specific subdomain or record name without the base domain

• values - Optional List
Name Servers

Primary Default Rr Set Group Ptr Record

A ptr_record block (within primary.default_rr_set_group) supports the following:

• name - Optional String
PTR Record name, please provide only the specific subdomain or record name without the base domain

• values - Optional List
Domain Name

Primary Default Rr Set Group Srv Record

A srv_record block (within primary.default_rr_set_group) supports the following:

• name - Optional String
SRV Record name, please provide only the specific subdomain or record name without the base domain

• values - Optional Block
SRV Value
See Values below.

Primary Default Rr Set Group Srv Record Values

Deeply nested Values block collapsed for readability.

Primary Default Rr Set Group Sshfp Record

A sshfp_record block (within primary.default_rr_set_group) supports the following:

• name - Optional String
SSHFP Record name, please provide only the specific subdomain or record name without the base domain

• values - Optional Block
SSHFP Value
See Values below.

Primary Default Rr Set Group Sshfp Record Values

Deeply nested Values block collapsed for readability.

Primary Default Rr Set Group Sshfp Record Values Sha1 Fingerprint

Deeply nested Fingerprint block collapsed for readability.

Primary Default Rr Set Group Sshfp Record Values Sha256 Fingerprint

Deeply nested Fingerprint block collapsed for readability.

Primary Default Rr Set Group Tlsa Record

A tlsa_record block (within primary.default_rr_set_group) supports the following:

• name - Optional String
TLSA Record name, please provide only the specific subdomain or record name without the base domain

• values - Optional Block
TLSA Value
See Values below.

Primary Default Rr Set Group Tlsa Record Values

Deeply nested Values block collapsed for readability.

Primary Default Rr Set Group Txt Record

A txt_record block (within primary.default_rr_set_group) supports the following:

• name - Optional String
TXT Record name, please provide only the specific subdomain or record name without the base domain

• values - Optional List
Text

Primary Dnssec Mode

A dnssec_mode block (within primary) supports the following:

• disable_spec - Optional Block
Enable this option

• enable - Optional Block
Enable. DNSSEC enable

Primary Rr Set Group

A rr_set_group block (within primary) supports the following:

• metadata - Optional Block
MessageMetaType is metadata (common attributes) of a message that only certain messages have. This information is propagated to the metadata of a child object that gets created from the containing message during view processing. The information in this type can be specified by user during create
See Metadata below.

• rr_set - Optional Block
Resource Record Sets. Collection of DNS resource record sets
See Rr Set below.

Primary Rr Set Group Metadata

A metadata block (within primary.rr_set_group) supports the following:

• description_spec - Optional String
Description. Human readable description

• name - Optional String
Name of the message. The value of name has to follow DNS-1035 format

Primary Rr Set Group Rr Set

A rr_set block (within primary.rr_set_group) supports the following: