xcsh_securemesh_site (Data Source)

Retrieves information about a Securemesh Site resource in F5 Distributed Cloud for deploying secure mesh edge sites with distributed security. This is a read-only data source.

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

Example Usage

# SecuremeshSite Data Source Example

terraform {
  required_version = ">= 1.0"

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

# Look up an existing SecuremeshSite by name
data "xcsh_securemesh_site" "example" {
  name      = "example-securemesh-site"
  namespace = "staging"
}

output "securemesh_site_id" {
  value = data.xcsh_securemesh_site.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 SecuremeshSite

• namespace - Required String
Namespace where the SecuremeshSite exists

Attributes Reference

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

• address - Optional String
Site’s geographical address that can be used to determine its latitude and longitude

• annotations - Optional Map
Annotations applied to this resource

• blocked_services - Optional String
Disable node local services on this site

• bond_device_list - Optional String
Bond Devices List. List of bond devices for this fleet

• coordinates - Optional String
Coordinates of the site which provides the site physical location

• custom_network_config - Optional String
SmsNetworkConfiguration

• default_blocked_services - Optional Object
Enable this option

• default_network_config - Optional Object
Enable this option

• description - Optional String
Description of the SecuremeshSite

• id - Optional String
Unique identifier for the resource

• kubernetes_upgrade_drain - Optional String
Specify how worker nodes within a site will be upgraded

• labels - Optional Map
Labels applied to this resource

• log_receiver - Optional String
Type establishes a direct reference from one object(the referrer) to another(the referred). Such a reference is in form of tenant/namespace/name

• logs_streaming_disabled - Optional Object
Enable this option

• master_node_configuration - Optional List
Master Nodes. Configuration of master nodes

• no_bond_devices - Optional Object
Configuration parameter for no bond devices

• offline_survivability_mode - Optional String
Offline Survivability allows the Site to continue functioning normally without traffic loss during periods of connectivity loss to the Regional Edge (RE) or the Global Controller (GC). When this feature is enabled, a site can continue to function as is with existing configuration for upto 7

• os - Optional String
Select the F5XC Operating System Version for the site. By default, latest available OS Version will be used. Refer to release notes to find required released OS versions

• performance_enhancement_mode - Optional String
Optimize the site for L3 or L7 traffic processing. L7 optimized is the default

• sw - Optional String
Select the F5XC Software Version for the site. By default, latest available F5XC Software Version will be used. Refer to release notes to find required released SW versions

• volterra_certified_hw - Optional String
Name for generic server certified hardware to form this Secure Mesh site

• worker_nodes - Optional List
Worker Nodes. Names of worker nodes

• blocked_service - Optional List
Disable Node Local Services. Blocking or denial configuration

• dns - Optional Object
Enable this option

• network_type - Optional String Defaults to VIRTUAL_NETWORK_SITE_LOCAL
Possible values are VIRTUAL_NETWORK_SITE_LOCAL, VIRTUAL_NETWORK_SITE_LOCAL_INSIDE, VIRTUAL_NETWORK_PER_SITE, VIRTUAL_NETWORK_PUBLIC, VIRTUAL_NETWORK_GLOBAL, VIRTUAL_NETWORK_SITE_SERVICE, VIRTUAL_NETWORK_VER_INTERNAL, VIRTUAL_NETWORK_SITE_LOCAL_INSIDE_OUTSIDE, VIRTUAL_NETWORK_IP_AUTO, VIRTUAL_NETWORK_VOLTADN_PRIVATE_NETWORK, VIRTUAL_NETWORK_SRV6_NETWORK, VIRTUAL_NETWORK_IP_FABRIC, VIRTUAL_NETWORK_SEGMENT, VIRTUAL_NETWORK_MANAGEMENT
[Enum: VIRTUAL_NETWORK_SITE_LOCAL|VIRTUAL_NETWORK_SITE_LOCAL_INSIDE|VIRTUAL_NETWORK_PER_SITE|VIRTUAL_NETWORK_PUBLIC|VIRTUAL_NETWORK_GLOBAL|VIRTUAL_NETWORK_SITE_SERVICE|VIRTUAL_NETWORK_VER_INTERNAL|VIRTUAL_NETWORK_SITE_LOCAL_INSIDE_OUTSIDE|VIRTUAL_NETWORK_IP_AUTO|VIRTUAL_NETWORK_VOLTADN_PRIVATE_NETWORK|VIRTUAL_NETWORK_SRV6_NETWORK|VIRTUAL_NETWORK_IP_FABRIC|VIRTUAL_NETWORK_SEGMENT|VIRTUAL_NETWORK_MANAGEMENT] Different types of virtual networks understood by the system Virtual-network of type VIRTUAL_NETWORK_SITE_LOCAL provides connectivity to public (outside) network. This is an insecure network and is connected to public internet via NAT Gateways/firwalls Virtual-network of this type is local to

• ssh - Optional Object
Enable this option

• web_user_interface - Optional Object
Enable this option

• bond_devices - Optional List
Bond Devices. List of bond devices

• active_backup - Optional Object
Configuration parameter for active backup

• devices - Optional List
Ethernet devices that will make up this bond

• lacp - Optional String
LACP parameters. LACP parameters for the bond device

• link_polling_interval - Optional Number
Link Polling Interval. Link polling interval in milliseconds

• link_up_delay - Optional Number
Milliseconds wait before link is declared up

• name - Optional String
Bond Device Name. Name for the Bond. Ex ‘bond0’

• rate - Optional Number
Interval in seconds to transmit LACP packets

---

Coordinates

A coordinates block supports the following:

• latitude - Optional Number
Latitude. Latitude of the site location

• longitude - Optional Number
Longitude. Longitude of site location

Custom Network Config

A custom_network_config block supports the following:

• active_enhanced_firewall_policies - Optional String
List of Enhanced Firewall Policies These policies use session-based rules and provide all OPTIONS available under firewall policies with an additional option for service insertion

• active_forward_proxy_policies - Optional String
Ordered List of Forward Proxy Policies active

• active_network_policies - Optional String
Configuration parameter for active network policies

• default_config - Optional Object
Enable this option

• default_interface_config - Optional Object
Enable this option

• default_sli_config - Optional Object
Enable this option

• forward_proxy_allow_all - Optional Object
Configuration parameter for forward proxy allow all

• global_network_list - Optional String
Global Network Connection List. List of global network connections

• interface_list - Optional String
Configure network interfaces for this Secure Mesh site

• no_forward_proxy - Optional Object
Configuration parameter for no forward proxy

• no_global_network - Optional Object
Configuration parameter for no global network

• no_network_policy - Optional Object
Policy configuration for this feature

• sli_config - Optional String
Site Local Network Configuration. Site local network configuration

• slo_config - Optional String
Site Local Network Configuration. Site local network configuration

• sm_connection_public_ip - Optional Object
Enable this option

• sm_connection_pvt_ip - Optional Object
Enable this option

• tunnel_dead_timeout - Optional Number
Time interval, in millisec, within which any IPsec / SSL connection from the site going down is detected. When not set (== 0), a default value of 10000 msec will be used

• vip_vrrp_mode - Optional String Defaults to VIP_VRRP_INVALID
Possible values are VIP_VRRP_INVALID, VIP_VRRP_ENABLE, VIP_VRRP_DISABLE
[Enum: VIP_VRRP_INVALID|VIP_VRRP_ENABLE|VIP_VRRP_DISABLE] VRRP advertisement mode for VIP Invalid VRRP mode

Custom Network Config Active Enhanced Firewall Policies

An active_enhanced_firewall_policies block (within custom_network_config) supports the following:

• enhanced_firewall_policies - Optional List
Ordered List of Enhanced Firewall Policies active

Custom Network Config Active Enhanced Firewall Policies Enhanced Firewall Policies

Deeply nested Policies block collapsed for readability.

Custom Network Config Active Forward Proxy Policies

An active_forward_proxy_policies block (within custom_network_config) supports the following:

• forward_proxy_policies - Optional List
Ordered List of Forward Proxy Policies active

Custom Network Config Active Forward Proxy Policies Forward Proxy Policies

Deeply nested Policies block collapsed for readability.

Custom Network Config Active Network Policies

An active_network_policies block (within custom_network_config) supports the following:

• network_policies - Optional List
Ordered List of Firewall Policies active for this network firewall

Custom Network Config Active Network Policies Network Policies

Deeply nested Policies block collapsed for readability.

Custom Network Config Default Config

A default_config block (within custom_network_config) supports the following:

Custom Network Config Default Interface Config

A default_interface_config block (within custom_network_config) supports the following:

Custom Network Config Default SLI Config

A default_sli_config block (within custom_network_config) supports the following:

Custom Network Config Forward Proxy Allow All

A forward_proxy_allow_all block (within custom_network_config) supports the following:

Custom Network Config Global Network List

A global_network_list block (within custom_network_config) supports the following:

• global_network_connections - Optional List
Global Network Connections. Global network connections

Custom Network Config Global Network List Global Network Connections

Deeply nested Connections block collapsed for readability.

Custom Network Config Global Network List Global Network Connections SLI To Global DR

Deeply nested DR block collapsed for readability.

Custom Network Config Global Network List Global Network Connections SLI To Global DR Global Vn

Deeply nested Vn block collapsed for readability.

Custom Network Config Global Network List Global Network Connections Slo To Global DR

Deeply nested DR block collapsed for readability.

Custom Network Config Global Network List Global Network Connections Slo To Global DR Global Vn

Deeply nested Vn block collapsed for readability.

Custom Network Config Interface List

An interface_list block (within custom_network_config) supports the following:

• interfaces - Optional List
Configure network interfaces for this Secure Mesh site

Custom Network Config Interface List Interfaces

An interfaces block (within custom_network_config.interface_list) supports the following:

• dc_cluster_group_connectivity_interface_disabled - Optional Object
Enable this option

• dc_cluster_group_connectivity_interface_enabled - Optional Object
Enable this option

• dedicated_interface - Optional String
Configuration parameter for dedicated interface

• dedicated_management_interface - Optional String
Configuration parameter for dedicated management interface

• description_spec - Optional String
Interface Description. Description for this Interface

• ethernet_interface - Optional String
Configuration parameter for ethernet interface

• labels - Optional Map
Add Labels for this Interface, these labels can be used in firewall policy

Custom Network Config Interface List Interfaces Dc Cluster Group Connectivity Interface Disabled

Deeply nested Disabled block collapsed for readability.

Custom Network Config Interface List Interfaces Dc Cluster Group Connectivity Interface Enabled

Deeply nested Enabled block collapsed for readability.

Custom Network Config Interface List Interfaces Dedicated Interface

Deeply nested Interface block collapsed for readability.

Custom Network Config Interface List Interfaces Dedicated Interface Cluster

Deeply nested Cluster block collapsed for readability.

Custom Network Config Interface List Interfaces Dedicated Interface Is Primary

Deeply nested Primary block collapsed for readability.

Custom Network Config Interface List Interfaces Dedicated Interface Monitor

Deeply nested Monitor block collapsed for readability.

Custom Network Config Interface List Interfaces Dedicated Interface Monitor Disabled

Deeply nested Disabled block collapsed for readability.

Custom Network Config Interface List Interfaces Dedicated Interface Not Primary

Deeply nested Primary block collapsed for readability.

Custom Network Config Interface List Interfaces Dedicated Management Interface

Deeply nested Interface block collapsed for readability.

Custom Network Config Interface List Interfaces Dedicated Management Interface Cluster

Deeply nested Cluster block collapsed for readability.

Custom Network Config Interface List Interfaces Ethernet Interface

Deeply nested Interface block collapsed for readability.

Custom Network Config Interface List Interfaces Ethernet Interface Cluster

Deeply nested Cluster block collapsed for readability.

Custom Network Config Interface List Interfaces Ethernet Interface DHCP Client

Deeply nested Client block collapsed for readability.

Custom Network Config Interface List Interfaces Ethernet Interface DHCP Server

Deeply nested Server block collapsed for readability.

Custom Network Config Interface List Interfaces Ethernet Interface DHCP Server Automatic From End

Deeply nested End block collapsed for readability.

Custom Network Config Interface List Interfaces Ethernet Interface DHCP Server Automatic From Start

Deeply nested Start block collapsed for readability.

Custom Network Config Interface List Interfaces Ethernet Interface DHCP Server DHCP Networks

Deeply nested Networks block collapsed for readability.

Custom Network Config Interface List Interfaces Ethernet Interface DHCP Server DHCP Networks First Address

Deeply nested Address block collapsed for readability.

Custom Network Config Interface List Interfaces Ethernet Interface DHCP Server DHCP Networks Last Address

Deeply nested Address block collapsed for readability.

Custom Network Config Interface List Interfaces Ethernet Interface DHCP Server DHCP Networks Pools

Deeply nested Pools block collapsed for readability.

Custom Network Config Interface List Interfaces Ethernet Interface DHCP Server DHCP Networks Same As Dgw

Deeply nested Dgw block collapsed for readability.

Custom Network Config Interface List Interfaces Ethernet Interface DHCP Server Interface IP Map

Deeply nested Map block collapsed for readability.

Custom Network Config Interface List Interfaces Ethernet Interface IPv6 Auto Config

Deeply nested Config block collapsed for readability.

Custom Network Config Interface List Interfaces Ethernet Interface IPv6 Auto Config Host

Deeply nested Host block collapsed for readability.

Custom Network Config Interface List Interfaces Ethernet Interface IPv6 Auto Config Router

Deeply nested Router block collapsed for readability.

Custom Network Config Interface List Interfaces Ethernet Interface IPv6 Auto Config Router DNS Config

Deeply nested Config block collapsed for readability.

Custom Network Config Interface List Interfaces Ethernet Interface IPv6 Auto Config Router DNS Config Configured List

Deeply nested List block collapsed for readability.

Custom Network Config Interface List Interfaces Ethernet Interface IPv6 Auto Config Router DNS Config Local DNS

Deeply nested DNS block collapsed for readability.

Custom Network Config Interface List Interfaces Ethernet Interface IPv6 Auto Config Router DNS Config Local DNS First Address

Deeply nested Address block collapsed for readability.

Custom Network Config Interface List Interfaces Ethernet Interface IPv6 Auto Config Router DNS Config Local DNS Last Address

Deeply nested Address block collapsed for readability.

Custom Network Config Interface List Interfaces Ethernet Interface IPv6 Auto Config Router Stateful

Deeply nested Stateful block collapsed for readability.

Custom Network Config Interface List Interfaces Ethernet Interface IPv6 Auto Config Router Stateful Automatic From End

Deeply nested End block collapsed for readability.

Custom Network Config Interface List Interfaces Ethernet Interface IPv6 Auto Config Router Stateful Automatic From Start

Deeply nested Start block collapsed for readability.

Custom Network Config Interface List Interfaces Ethernet Interface IPv6 Auto Config Router Stateful DHCP Networks

Deeply nested Networks block collapsed for readability.

Custom Network Config Interface List Interfaces Ethernet Interface IPv6 Auto Config Router Stateful DHCP Networks Pools

Deeply nested Pools block collapsed for readability.

Custom Network Config Interface List Interfaces Ethernet Interface IPv6 Auto Config Router Stateful Interface IP Map

Deeply nested Map block collapsed for readability.

Custom Network Config Interface List Interfaces Ethernet Interface Is Primary

Deeply nested Primary block collapsed for readability.

Custom Network Config Interface List Interfaces Ethernet Interface Monitor

Deeply nested Monitor block collapsed for readability.

Custom Network Config Interface List Interfaces Ethernet Interface Monitor Disabled

Deeply nested Disabled block collapsed for readability.

Custom Network Config Interface List Interfaces Ethernet Interface No IPv6 Address

Deeply nested Address block collapsed for readability.

Custom Network Config Interface List Interfaces Ethernet Interface Not Primary

Deeply nested Primary block collapsed for readability.

Custom Network Config Interface List Interfaces Ethernet Interface Site Local Inside Network

Deeply nested Network block collapsed for readability.

Custom Network Config Interface List Interfaces Ethernet Interface Site Local Network

Deeply nested Network block collapsed for readability.

Custom Network Config Interface List Interfaces Ethernet Interface Static IP

Deeply nested IP block collapsed for readability.

Custom Network Config Interface List Interfaces Ethernet Interface Static IP Cluster Static IP

Deeply nested IP block collapsed for readability.

Custom Network Config Interface List Interfaces Ethernet Interface Static IP Node Static IP

Deeply nested IP block collapsed for readability.

Custom Network Config Interface List Interfaces Ethernet Interface Static IPv6 Address

Deeply nested Address block collapsed for readability.

Custom Network Config Interface List Interfaces Ethernet Interface Static IPv6 Address Cluster Static IP

Deeply nested IP block collapsed for readability.

Custom Network Config Interface List Interfaces Ethernet Interface Static IPv6 Address Node Static IP

Deeply nested IP block collapsed for readability.

Custom Network Config Interface List Interfaces Ethernet Interface Storage Network

Deeply nested Network block collapsed for readability.

Custom Network Config Interface List Interfaces Ethernet Interface Untagged

Deeply nested Untagged block collapsed for readability.

Custom Network Config No Forward Proxy

A no_forward_proxy block (within custom_network_config) supports the following:

Custom Network Config No Global Network

A no_global_network block (within custom_network_config) supports the following:

Custom Network Config No Network Policy

A no_network_policy block (within custom_network_config) supports the following:

Custom Network Config SLI Config

A sli_config block (within custom_network_config) supports the following:

• dc_cluster_group - Optional String
Type establishes a direct reference from one object(the referrer) to another(the referred). Such a reference is in form of tenant/namespace/name

• labels - Optional Map
Add Labels for this network, these labels can be used in firewall policy

• nameserver - Optional String
Optional DNS V4 server IP to be used for name resolution

• no_dc_cluster_group - Optional Object
Enable this option

• no_static_routes - Optional Object
Configuration parameter for no static routes

• no_v6_static_routes - Optional Object
Configuration parameter for no v6 static routes

• static_routes - Optional String
Configuration parameter for static routes

• static_v6_routes - Optional String
Configuration parameter for static v6 routes

• vip - Optional String
Optional common virtual V4 IP across all nodes to be used as automatic VIP

Custom Network Config SLI Config Dc Cluster Group

Deeply nested Group block collapsed for readability.

Custom Network Config SLI Config No Dc Cluster Group

Deeply nested Group block collapsed for readability.

Custom Network Config SLI Config No Static Routes

Deeply nested Routes block collapsed for readability.

Custom Network Config SLI Config No V6 Static Routes

Deeply nested Routes block collapsed for readability.

Custom Network Config SLI Config Static Routes

A static_routes block (within custom_network_config.sli_config) supports the following:

• static_routes - Optional List
Static Routes. List of static routes

Custom Network Config SLI Config Static Routes Static Routes

Deeply nested Routes block collapsed for readability.

Custom Network Config SLI Config Static Routes Static Routes Default Gateway

Deeply nested Gateway block collapsed for readability.

Custom Network Config SLI Config Static Routes Static Routes Node Interface

Deeply nested Interface block collapsed for readability.

Custom Network Config SLI Config Static Routes Static Routes Node Interface List

Deeply nested List block collapsed for readability.

Custom Network Config SLI Config Static Routes Static Routes Node Interface List Interface

Deeply nested Interface block collapsed for readability.

Custom Network Config SLI Config Static V6 Routes

Deeply nested Routes block collapsed for readability.

Custom Network Config SLI Config Static V6 Routes Static Routes

Deeply nested Routes block collapsed for readability.

Custom Network Config SLI Config Static V6 Routes Static Routes Default Gateway

Deeply nested Gateway block collapsed for readability.

Custom Network Config SLI Config Static V6 Routes Static Routes Node Interface

Deeply nested Interface block collapsed for readability.

Custom Network Config SLI Config Static V6 Routes Static Routes Node Interface List

Deeply nested List block collapsed for readability.

Custom Network Config SLI Config Static V6 Routes Static Routes Node Interface List Interface

Deeply nested Interface block collapsed for readability.

Custom Network Config Slo Config

A slo_config block (within custom_network_config) supports the following:

• dc_cluster_group - Optional String
Type establishes a direct reference from one object(the referrer) to another(the referred). Such a reference is in form of tenant/namespace/name

• labels - Optional Map
Add Labels for this network, these labels can be used in firewall policy

• nameserver - Optional String
Optional DNS V4 server IP to be used for name resolution

• no_dc_cluster_group - Optional Object
Enable this option

• no_static_routes - Optional Object
Configuration parameter for no static routes

• no_v6_static_routes - Optional Object
Configuration parameter for no v6 static routes

• static_routes - Optional String
Configuration parameter for static routes

• static_v6_routes - Optional String
Configuration parameter for static v6 routes

• vip - Optional String
Optional common virtual V4 IP across all nodes to be used as automatic VIP

Custom Network Config Slo Config Dc Cluster Group

Deeply nested Group block collapsed for readability.

Custom Network Config Slo Config No Dc Cluster Group

Deeply nested Group block collapsed for readability.

Custom Network Config Slo Config No Static Routes

Deeply nested Routes block collapsed for readability.

Custom Network Config Slo Config No V6 Static Routes

Deeply nested Routes block collapsed for readability.

Custom Network Config Slo Config Static Routes

A static_routes block (within custom_network_config.slo_config) supports the following:

• static_routes - Optional List
Static Routes. List of static routes

Custom Network Config Slo Config Static Routes Static Routes

Deeply nested Routes block collapsed for readability.

Custom Network Config Slo Config Static Routes Static Routes Default Gateway

Deeply nested Gateway block collapsed for readability.

Custom Network Config Slo Config Static Routes Static Routes Node Interface

Deeply nested Interface block collapsed for readability.

Custom Network Config Slo Config Static Routes Static Routes Node Interface List

Deeply nested List block collapsed for readability.

Custom Network Config Slo Config Static Routes Static Routes Node Interface List Interface

Deeply nested Interface block collapsed for readability.

Custom Network Config Slo Config Static V6 Routes

Deeply nested Routes block collapsed for readability.

Custom Network Config Slo Config Static V6 Routes Static Routes

Deeply nested Routes block collapsed for readability.

Custom Network Config Slo Config Static V6 Routes Static Routes Default Gateway

Deeply nested Gateway block collapsed for readability.

Custom Network Config Slo Config Static V6 Routes Static Routes Node Interface

Deeply nested Interface block collapsed for readability.

Custom Network Config Slo Config Static V6 Routes Static Routes Node Interface List

Deeply nested List block collapsed for readability.

Custom Network Config Slo Config Static V6 Routes Static Routes Node Interface List Interface

Deeply nested Interface block collapsed for readability.

Custom Network Config Sm Connection Public IP

A sm_connection_public_ip block (within custom_network_config) supports the following:

Custom Network Config Sm Connection Pvt IP

A sm_connection_pvt_ip block (within custom_network_config) supports the following:

Default Blocked Services

A default_blocked_services block supports the following:

Default Network Config

A default_network_config block supports the following:

Kubernetes Upgrade Drain

A kubernetes_upgrade_drain block supports the following:

• disable_upgrade_drain - Optional Object
Configuration parameter for disable upgrade drain

• enable_upgrade_drain - Optional String
Specify batch upgrade settings for worker nodes within a site

Kubernetes Upgrade Drain Disable Upgrade Drain

A disable_upgrade_drain block (within kubernetes_upgrade_drain) supports the following:

Kubernetes Upgrade Drain Enable Upgrade Drain

An enable_upgrade_drain block (within kubernetes_upgrade_drain) supports the following:

• disable_vega_upgrade_mode - Optional Object
Configuration parameter for disable vega upgrade mode

• drain_max_unavailable_node_count - Optional Number
Node Batch Size Count

• drain_max_unavailable_node_percentage - Optional Number
Maximum percentage of nodes unavailable during upgrade draining

• drain_node_timeout - Optional Number
Seconds to wait before initiating upgrade on the next set of nodes. Setting it to 0 will wait indefinitely for all services on nodes to be upgraded gracefully before proceeding to the next set of nodes. (Warning: It may block upgrade if services on a node cannot be gracefully upgraded. It is

• enable_vega_upgrade_mode - Optional Object
Configuration parameter for enable vega upgrade mode

Kubernetes Upgrade Drain Enable Upgrade Drain Disable Vega Upgrade Mode

Deeply nested Mode block collapsed for readability.

Kubernetes Upgrade Drain Enable Upgrade Drain Enable Vega Upgrade Mode

Deeply nested Mode block collapsed for readability.

Log Receiver

A log_receiver 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

• 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

Logs Streaming Disabled

A logs_streaming_disabled block supports the following:

Master Node Configuration

A master_node_configuration block supports the following:

• name - Optional String
Name. Names of master node

• public_ip - Optional String
IP Address of the master node. This IP will be used when other sites connect via Site Mesh Group

No Bond Devices

A no_bond_devices block supports the following:

Offline Survivability Mode

An offline_survivability_mode block supports the following:

• enable_offline_survivability_mode - Optional Object
Configuration parameter for enable offline survivability mode

• no_offline_survivability_mode - Optional Object
Configuration parameter for no offline survivability mode

Offline Survivability Mode Enable Offline Survivability Mode

An enable_offline_survivability_mode block (within offline_survivability_mode) supports the following:

Offline Survivability Mode No Offline Survivability Mode

A no_offline_survivability_mode block (within offline_survivability_mode) supports the following:

OS

An os block supports the following:

• default_os_version - Optional Object
Enable this option

• operating_system_version - Optional String
Specify a OS version to be used e.g. 9.2024.6

OS Default OS Version

A default_os_version block (within os) supports the following:

Performance Enhancement Mode

A performance_enhancement_mode block supports the following:

• perf_mode_l3_enhanced - Optional String
Configuration parameter for perf mode l3 enhanced

• perf_mode_l7_enhanced - Optional String
Configuration parameter for perf mode l7 enhanced

Performance Enhancement Mode Perf Mode L3 Enhanced

A perf_mode_l3_enhanced block (within performance_enhancement_mode) supports the following:

• jumbo - Optional Object
Enable this option

• no_jumbo - Optional Object
Enable this option

Performance Enhancement Mode Perf Mode L3 Enhanced Jumbo

Deeply nested Jumbo block collapsed for readability.

Performance Enhancement Mode Perf Mode L3 Enhanced No Jumbo

Deeply nested Jumbo block collapsed for readability.

Performance Enhancement Mode Perf Mode L7 Enhanced

A perf_mode_l7_enhanced block (within performance_enhancement_mode) supports the following:

• jumbo_disabled - Optional Object
Enable this option

• jumbo_enabled - Optional Object
Enable this option

Performance Enhancement Mode Perf Mode L7 Enhanced Jumbo Disabled

Deeply nested Disabled block collapsed for readability.

Performance Enhancement Mode Perf Mode L7 Enhanced Jumbo Enabled

Deeply nested Enabled block collapsed for readability.

Sw

A sw block supports the following:

• default_sw_version - Optional Object
Enable this option

• volterra_software_version - Optional String
Specify a F5XC Software Version to be used e.g. Crt-20210329-1002

Sw Default Sw Version

A default_sw_version block (within sw) supports the following:

---

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