xcsh_site_mesh_group (Resource)

Manages Site Mesh Group in system namespace of user in F5 Distributed Cloud.

~> Note: For more information, see the Site Mesh Group API documentation.

Example Usage

# SiteMeshGroup Resource Example
# Manages Site Mesh Group in system namespace of user in F5 Distributed Cloud.

terraform {
  required_version = ">= 1.0"

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

# Basic SiteMeshGroup configuration
resource "xcsh_site_mesh_group" "example" {
  name      = "example-site-mesh-group"
  namespace = "staging"
}

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.

~> Dependencies — This resource requires: site.

Metadata Argument Reference

• name - Required String
Name of the Site Mesh Group. Must be unique within the namespace

• namespace - Required String
Namespace where the Site Mesh Group is created

• 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 administratively disables the object

• labels - Optional Map
Labels is a user defined key value map that can be attached to resources for organization and filtering

Spec Argument Reference

-> One of the following: • bfd_disabled - Optional Object
Enable this option

• bfd_enabled - Optional Block
BFD. BFD parameters
See Bfd Enabled below for details.

-> One of the following: • disable_re_fallback - Optional Object
Configuration parameter for disable RE fallback

• enable_re_fallback - Optional Object
Configuration parameter for enable RE fallback

-> One of the following: • full_mesh - Optional Block
Full Mesh. Details of Full Mesh Group Type
See Full Mesh below for details.

• hub_mesh - Optional Block
Hub Full Mesh. Details of Hub Full Mesh Group Type
See Hub Mesh below for details.

• spoke_mesh - Optional Block
Spoke. Details of Spoke Mesh Group Type
See Spoke Mesh below for details.

• timeouts - Optional Block
See Timeouts below for details.

• virtual_site - Optional Block
Set of sites for which this mesh group config is valid. If ‘Type’ is Spoke, then it gives set of spoke sites. If ‘Type’ is Hub, then it gives set of hub sites
See Virtual Site below for details.

Attributes Reference

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

• id - Optional String
Unique identifier for the resource

---

Bfd Enabled

A bfd_enabled block supports the following:

• multiplier - Optional Number
Specify Number of missed packets to bring session down’

• receive_interval_milliseconds - Optional Number
BFD receive interval timer, in milliseconds

• transmit_interval_milliseconds - Optional Number
BFD transmit interval timer, in milliseconds

Disable RE Fallback

A disable_re_fallback block supports the following:

Enable RE Fallback

An enable_re_fallback block supports the following:

Full Mesh

A full_mesh block supports the following:

• control_and_data_plane_mesh - Optional Object
Enable this option

• data_plane_mesh - Optional Object
Enable this option

Full Mesh Control And Data Plane Mesh

A control_and_data_plane_mesh block (within full_mesh) supports the following:

Full Mesh Data Plane Mesh

A data_plane_mesh block (within full_mesh) supports the following:

Hub Mesh

A hub_mesh block supports the following:

• control_and_data_plane_mesh - Optional Object
Enable this option

• data_plane_mesh - Optional Object
Enable this option

Hub Mesh Control And Data Plane Mesh

A control_and_data_plane_mesh block (within hub_mesh) supports the following:

Hub Mesh Data Plane Mesh

A data_plane_mesh block (within hub_mesh) supports the following:

Spoke Mesh

A spoke_mesh block supports the following:

• control_and_data_plane_mesh - Optional Object
Enable this option

• data_plane_mesh - Optional Object
Enable this option

• hub_mesh_group - 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 Hub Mesh Group below.

Spoke Mesh Control And Data Plane Mesh

A control_and_data_plane_mesh block (within spoke_mesh) supports the following:

Spoke Mesh Data Plane Mesh

A data_plane_mesh block (within spoke_mesh) supports the following:

Spoke Mesh Hub Mesh Group

A hub_mesh_group block (within spoke_mesh) supports the following:

• 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

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

Virtual Site

A virtual_site block supports the following:

• 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

• kind - Optional String
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then kind will hold the referred object’s kind (e.g. ‘route’)

• 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

• uid - Optional String
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then uid will hold the referred object’s(e.g. Route’s) uid

---

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_site_mesh_group.example system/example