xcsh_site_registration (Data Source)

Resolves the runtime registration of a site’s Customer Edge (CE) node in F5 Distributed Cloud. This is a read-only data source.

A registration is named r-<uuid>, not after the site it belongs to, so it cannot be read by site name. This data source lists the registrations belonging to a site and returns the one that matches, giving you the name that xcsh_registration_approval requires.

The registration only exists once the CE has booted and registered with its token. Until then this data source reports found = false without raising an error, so an approval can safely be gated on it:

data "xcsh_site_registration" "ce" {
  site_name = xcsh_securemesh_site_v2.ce.name
}

resource "xcsh_registration_approval" "ce" {
  count        = data.xcsh_site_registration.ce.found ? 1 : 0
  name         = data.xcsh_site_registration.ce.name
  namespace    = "system"
  cluster_size = 1
}

Possible state values: NOTSET, NEW, APPROVED, ADMITTED, RETIRED, FAILED, DONE, PENDING, ONLINE, UPGRADING, MAINTENANCE, FAILED_INACTIVE.

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

Example Usage

# Example: Resolve a Customer Edge registration so it can be approved
#
# A registration is named "r-<uuid>", NOT after the site, so it cannot be read
# by site name. This data source finds the registration that belongs to a site.
#
# It returns found = false — with no error — until the CE has booted and
# registered, so an approval can safely be gated on it.

terraform {
  required_version = ">= 1.0"

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

data "xcsh_site_registration" "ce" {
  site_name = "my-ce-site"
  namespace = "system"
}

# A multi-node site returns one registration per node; pick one by hostname.
data "xcsh_site_registration" "ha_ce_node_0" {
  site_name = "my-ha-ce-site"
  hostname  = "master-0"
}

output "registration_name" {
  description = "Registration name (r-<uuid>) to approve, null until the CE registers"
  value       = data.xcsh_site_registration.ce.name
}

output "registration_state" {
  description = "Current registration state (PENDING, ONLINE, ...)"
  value       = data.xcsh_site_registration.ce.state
}

output "ha_node_0_registration_name" {
  description = "Registration name of the master-0 node of the three-node site"
  value       = data.xcsh_site_registration.ha_ce_node_0.name
}

# Approve the registration only once it exists — on the first apply the CE has
# not registered yet, so nothing is planned; re-apply after the node boots.
resource "xcsh_registration_approval" "ce" {
  count = data.xcsh_site_registration.ce.found ? 1 : 0

  name         = data.xcsh_site_registration.ce.name
  namespace    = data.xcsh_site_registration.ce.namespace
  cluster_size = 1
}

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.

Metadata Argument Reference

• namespace - Optional String Defaults to “system, where site registrations live
Namespace holding the registrations

Spec Argument Reference

• hostname - Optional String
Node hostname used to pick one registration when a multi-node site has several. Optional for a single-node site; when omitted, the resolved node’s hostname is returned here. Hostnames are only unique within a site

• site_name - Required String
Name of the F5 XC site whose CE registration should be resolved. Matched against each registration’s get_spec.passport.cluster_name

Attributes Reference

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

• cluster_name - Optional String
Cluster name the CE registered with, as reported in its passport. Equals site_name for a correctly configured site

• cluster_size - Optional Number
Number of nodes the CE reported for its cluster (1 for a single-node site, 3 for a three-node site)

• found - Optional Bool
Whether a registration was resolved. false (with no error) while the CE has not registered yet — gate an approval’s count on this

• id - Optional String
Identifier of this lookup: the registration name when one is found, otherwise null

• instance_id - Optional String
Infrastructure instance identifier reported by the CE registration (get_spec.infra.instance_id). This distinguishes rebuilt nodes that reuse the same site and hostname

• name - Optional String
Registration name (r-“) to pass to xcsh_registration_approval. Null when found is false

• provider_type - Optional String
Infrastructure provider the CE reported, e.g. AZURE, AWS, GCP, VMWARE

• state - Optional String
Current registration state, e.g. PENDING (awaiting approval) or ONLINE (node admitted and healthy)

• uid - Optional String
Unique identifier of the registration (the <uuid> part of the name)

---

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