xcsh_securemesh_site_v2 (Data Source)

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

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

Example Usage

# SecuremeshSiteV2 Data Source Example

terraform {
  required_version = ">= 1.0"

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

# Look up an existing SecuremeshSiteV2 by name
data "xcsh_securemesh_site_v2" "example" {
  name      = "example-securemesh-site-v2"
  namespace = "system"
}

output "securemesh_site_v2_id" {
  value = data.xcsh_securemesh_site_v2.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 SecuremeshSiteV2

• namespace - Optional String
Namespace where the SecuremeshSiteV2 exists

Attributes Reference

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

• 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

• admin_user_credentials - Optional String
Setup user credentials to manage access to nodes belonging to the site. When configured, ‘admin’ user will be setup and customers can access these nodes via either the node local WebUI or via SSH to access shell/CLI Ensure ‘Node Local Services’ are enabled to allow for required access

• annotations - Optional Map
Annotations applied to this resource

• aws - Optional String
AWS Provider Type. AWS Provider Type

• azure - Optional String
Azure Provider Type. Azure Provider Type

• baremetal - Optional String
Baremetal Provider Type. Baremetal Provider Type

• block_all_services - Optional Object
Enable this option

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

• custom_proxy - Optional String
Configuration parameter for custom proxy

• custom_proxy_bypass - Optional String
Configuration parameter for custom proxy bypass

• dc_cluster_group_sli - 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

• dc_cluster_group_slo - 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

• description - Optional String
Description of the SecuremeshSiteV2

• disable_advanced_delivery - Optional Object
Configuration parameter for disable advanced delivery

• disable_ha - Optional Object
Enable this option

• disable_log_anonymization - Optional Object
Configuration parameter for disable log anonymization

• disable_management_network - Optional Object
Configuration parameter for disable management network

• disable_url_categorization - Optional Object
Enable this option

• dns_ntp_config - Optional String
Specify DNS and NTP servers that will be used by the nodes in this Customer Edge site

• enable_advanced_delivery - Optional Object
Configuration parameter for enable advanced delivery

• enable_ha - Optional Object
Enable this option

• enable_log_anonymization - Optional Object
Configuration parameter for enable log anonymization

• enable_management_network - Optional Object
Configuration parameter for enable management network

• enable_url_categorization - Optional Object
Enable this option

• equinix - Optional String
Equinix Provider Type. Equinix Provider Type

• f5_proxy - Optional Object
Enable this option

• gcp - Optional String
GCP Provider Type. GCP Provider Type

• id - Optional String
Unique identifier for the resource

• kvm - Optional String
KVM Provider Type. KVM Provider Type

• labels - Optional Map
Labels applied to this resource

• load_balancing - Optional String
Section contains settings on the site that relate to Load Balancing functionality

• local_vrf - Optional String
There can be two local VRFs on each site. The Site Local Outside (SLO) local VRF is used to connect WAN side workloads to this site and to connect the site to F5 Distributed Cloud for management. All sites are required to have an SLO local VRF

• log_receiver_with_net - Optional String
Select log receiver for logs streaming with network option

• logs_streaming_disabled - Optional Object
Enable this option

• no_forward_proxy - Optional Object
Configuration parameter for no forward proxy

• no_network_policy - Optional Object
Policy configuration for this feature

• no_proxy_bypass - Optional Object
Configuration parameter for no proxy bypass

• no_s2s_connectivity_sli - Optional Object
Configuration parameter for no S2S connectivity SLI

• no_s2s_connectivity_slo - Optional Object
Configuration parameter for no S2S connectivity slo

• nutanix - Optional String
Nutanix Provider Type. Nutanix Provider Type

• oci - Optional String
OCI Provider Type. OCI Provider Type

• 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

• openshift_virtualization - Optional String
Configuration parameter for openshift virtualization

• openstack - Optional String
Openstack Provider Type. Openstack Provider Type

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

• re_select - Optional String
Selection criteria to connect the site with F5 Distributed Cloud Regional Edge(s)

• segment_vrf - Optional List
The Segment VRF is valid across all Sites of a Tenant. These are identified with a Segment name. Though these VRFs are across all Sites of a Tenant, there are some configurations that are valid per Site that can be configured here

• site_mesh_group_on_slo - Optional String
Select how the site mesh group will be connected. By default, public IPs of the control nodes of the site will be used

• 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

• tunnel_type - Optional String Defaults to SITE_TO_SITE_TUNNEL_IPSEC_OR_SSL
Possible values are SITE_TO_SITE_TUNNEL_IPSEC_OR_SSL, SITE_TO_SITE_TUNNEL_IPSEC, SITE_TO_SITE_TUNNEL_SSL
[Enum: SITE_TO_SITE_TUNNEL_IPSEC_OR_SSL|SITE_TO_SITE_TUNNEL_IPSEC|SITE_TO_SITE_TUNNEL_SSL] Tunnel encapsulation to be used between sites Tunnel can operate in both IPsec and SSL, with IPsec being preferred over SSL. Tunnel is of type IPsec Tunnel is of type SSL

• upgrade_settings - Optional String
Configuration parameter for upgrade settings

• vmware - Optional String
VMware Provider Type. VMware Provider Type

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

• 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

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

• 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

• admin_password - Optional String
SecretType is used in an object to indicate a sensitive/confidential field

• ssh_key - Optional String
Provided Public SSH key can be used for accessing nodes of the site. When provided, customers can SSH to the nodes of this Customer Edge site using admin as the user

• blindfold_secret_info - Optional String
BlindfoldSecretInfoType specifies information about the Secret managed by F5XC Secret Management

• clear_secret_info - Optional String
ClearSecretInfoType specifies information about the Secret that is not encrypted

• decryption_provider - Optional String
Name of the Secret Management Access object that contains information about the backend Secret Management service

• location - Optional String
Location is the uri_ref. It could be in URL format for string:/// Or it could be a path if the store provider is an HTTP/HTTPS location

• store_provider - Optional String
Name of the Secret Management Access object that contains information about the store to GET encrypted bytes This field needs to be provided only if the URL scheme is not string:///

• provider_ref - Optional String
Name of the Secret Management Access object that contains information about the store to GET encrypted bytes This field needs to be provided only if the URL scheme is not string:///

• url - Optional String
URL of the secret. Currently supported URL schemes is string:///. For string:/// scheme, Secret needs to be encoded Base64 format. When asked for this secret, caller will GET Secret bytes after Base64 decoding

AWS

An aws block supports the following:

• not_managed - Optional String
Section will show nodes associated with this site

AWS Not Managed

A not_managed block (within aws) supports the following:

• node_list - Optional List
Section will show nodes associated with this site

AWS Not Managed Node List

A node_list block (within aws.not_managed) supports the following:

• hostname - Optional String
Hostname. Hostname for this Node

• interface_list - Optional List
Manage interfaces belonging to this node

• public_ip - Optional String
Public IP. Public IP for this Node

• type - Optional String
Possible values are Control, Worker
[Enum: Control|Worker] Type for this Node, can be Control or Worker

AWS Not Managed Node List Interface List

An interface_list block (within aws.not_managed.node_list) supports the following:

• bond_interface - Optional String
Configuration parameter for bond interface

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

• dhcp_client - Optional Object
Enable this option

• dhcp_server - Optional String
DHCPServerParametersType

• ethernet_interface - Optional String
Configuration parameter for ethernet interface

• ipv6_auto_config - Optional String
IPV6AutoConfigType

• is_management - Optional Bool
Configuration for is_management

• is_primary - Optional Bool
Configuration for is_primary

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

• monitor - Optional Object
Link Quality Monitoring configuration for a network interface

• monitor_disabled - Optional Object
Enable this option

• mtu - Optional Number
Maximum packet size (Maximum Transfer Unit) of the interface When configured, MTU must be between 512 and 16384

• name - Optional String
Interface Name. Name of this Interface

• network_option - Optional String
Select virtual network (VRF) for this interface. There are 2 kinds of VRFs, local VRFs which are local to the site and global VRFs which extend into multiple sites. A site can have 2 Local VRFs, Site Local Outside (SLO), which is required for every site and Site Local Inside (SLI) which is optional

• no_ipv4_address - Optional Object
Enable this option

• no_ipv6_address - Optional Object
Enable this option

• priority - Optional Number
For a node, if multiple interfaces are configured in a VRF, interfaces with highest priority will be used as active and interfaces with lower priority will be used as backup. If multiple interfaces have the same priority, ECMP will be used. Greater the value, higher the priority

• site_to_site_connectivity_interface_disabled - Optional Object
Enable this option

• site_to_site_connectivity_interface_enabled - Optional Object
Enable this option

• static_ip - Optional String
Configure Static IP parameters for a node

• static_ipv6_address - Optional String
Static IP Parameters. Configure Static IP parameters

• vlan_interface - Optional String
Configuration parameter for VLAN interface

AWS Not Managed Node List Interface List Bond Interface

Deeply nested Interface block collapsed for readability.

AWS Not Managed Node List Interface List Bond Interface Active Backup

Deeply nested Backup block collapsed for readability.

AWS Not Managed Node List Interface List Bond Interface Lacp

Deeply nested Lacp block collapsed for readability.

AWS Not Managed Node List Interface List DHCP Client

Deeply nested Client block collapsed for readability.

AWS Not Managed Node List Interface List DHCP Server

Deeply nested Server block collapsed for readability.

AWS Not Managed Node List Interface List DHCP Server Automatic From End

Deeply nested End block collapsed for readability.

AWS Not Managed Node List Interface List DHCP Server Automatic From Start

Deeply nested Start block collapsed for readability.

AWS Not Managed Node List Interface List DHCP Server DHCP Networks

Deeply nested Networks block collapsed for readability.

AWS Not Managed Node List Interface List DHCP Server DHCP Networks First Address

Deeply nested Address block collapsed for readability.

AWS Not Managed Node List Interface List DHCP Server DHCP Networks Last Address

Deeply nested Address block collapsed for readability.

AWS Not Managed Node List Interface List DHCP Server DHCP Networks Pools

Deeply nested Pools block collapsed for readability.

AWS Not Managed Node List Interface List DHCP Server DHCP Networks Same As Dgw

Deeply nested Dgw block collapsed for readability.

AWS Not Managed Node List Interface List DHCP Server Interface IP Map

Deeply nested Map block collapsed for readability.

AWS Not Managed Node List Interface List Ethernet Interface

Deeply nested Interface block collapsed for readability.

AWS Not Managed Node List Interface List IPv6 Auto Config

Deeply nested Config block collapsed for readability.

AWS Not Managed Node List Interface List IPv6 Auto Config Host

Deeply nested Host block collapsed for readability.

AWS Not Managed Node List Interface List IPv6 Auto Config Router

Deeply nested Router block collapsed for readability.

AWS Not Managed Node List Interface List IPv6 Auto Config Router DNS Config

Deeply nested Config block collapsed for readability.

AWS Not Managed Node List Interface List IPv6 Auto Config Router DNS Config Configured List

Deeply nested List block collapsed for readability.

AWS Not Managed Node List Interface List IPv6 Auto Config Router DNS Config Local DNS

Deeply nested DNS block collapsed for readability.

AWS Not Managed Node List Interface List IPv6 Auto Config Router DNS Config Local DNS First Address

Deeply nested Address block collapsed for readability.

AWS Not Managed Node List Interface List IPv6 Auto Config Router DNS Config Local DNS Last Address

Deeply nested Address block collapsed for readability.

AWS Not Managed Node List Interface List IPv6 Auto Config Router Stateful

Deeply nested Stateful block collapsed for readability.

AWS Not Managed Node List Interface List IPv6 Auto Config Router Stateful Automatic From End

Deeply nested End block collapsed for readability.

AWS Not Managed Node List Interface List IPv6 Auto Config Router Stateful Automatic From Start

Deeply nested Start block collapsed for readability.

AWS Not Managed Node List Interface List IPv6 Auto Config Router Stateful DHCP Networks

Deeply nested Networks block collapsed for readability.

AWS Not Managed Node List Interface List IPv6 Auto Config Router Stateful DHCP Networks Pools

Deeply nested Pools block collapsed for readability.

AWS Not Managed Node List Interface List IPv6 Auto Config Router Stateful Interface IP Map

Deeply nested Map block collapsed for readability.

AWS Not Managed Node List Interface List Monitor

Deeply nested Monitor block collapsed for readability.

AWS Not Managed Node List Interface List Monitor Disabled

Deeply nested Disabled block collapsed for readability.

AWS Not Managed Node List Interface List Network Option

Deeply nested Option block collapsed for readability.

AWS Not Managed Node List Interface List Network Option Site Local Inside Network

Deeply nested Network block collapsed for readability.

AWS Not Managed Node List Interface List Network Option Site Local Network

Deeply nested Network block collapsed for readability.

AWS Not Managed Node List Interface List No IPv4 Address

Deeply nested Address block collapsed for readability.

AWS Not Managed Node List Interface List No IPv6 Address

Deeply nested Address block collapsed for readability.

AWS Not Managed Node List Interface List Site To Site Connectivity Interface Disabled

Deeply nested Disabled block collapsed for readability.

AWS Not Managed Node List Interface List Site To Site Connectivity Interface Enabled

Deeply nested Enabled block collapsed for readability.

AWS Not Managed Node List Interface List Static IP

Deeply nested IP block collapsed for readability.

AWS Not Managed Node List Interface List Static IPv6 Address

Deeply nested Address block collapsed for readability.

AWS Not Managed Node List Interface List Static IPv6 Address Cluster Static IP

Deeply nested IP block collapsed for readability.

AWS Not Managed Node List Interface List Static IPv6 Address Node Static IP

Deeply nested IP block collapsed for readability.

AWS Not Managed Node List Interface List VLAN Interface

Deeply nested Interface block collapsed for readability.

Azure

An azure block supports the following:

• not_managed - Optional String
Section will show nodes associated with this site

Azure Not Managed

A not_managed block (within azure) supports the following:

• node_list - Optional List
Section will show nodes associated with this site

Azure Not Managed Node List

A node_list block (within azure.not_managed) supports the following:

• hostname - Optional String
Hostname. Hostname for this Node

• interface_list - Optional List
Manage interfaces belonging to this node

• public_ip - Optional String
Public IP. Public IP for this Node

• type - Optional String
Possible values are Control, Worker
[Enum: Control|Worker] Type for this Node, can be Control or Worker

Azure Not Managed Node List Interface List

An interface_list block (within azure.not_managed.node_list) supports the following:

• bond_interface - Optional String
Configuration parameter for bond interface

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

• dhcp_client - Optional Object
Enable this option

• dhcp_server - Optional String
DHCPServerParametersType

• ethernet_interface - Optional String
Configuration parameter for ethernet interface

• ipv6_auto_config - Optional String
IPV6AutoConfigType

• is_management - Optional Bool
Configuration for is_management

• is_primary - Optional Bool
Configuration for is_primary

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

• monitor - Optional Object
Link Quality Monitoring configuration for a network interface

• monitor_disabled - Optional Object
Enable this option

• mtu - Optional Number
Maximum packet size (Maximum Transfer Unit) of the interface When configured, MTU must be between 512 and 16384

• name - Optional String
Interface Name. Name of this Interface

• no_ipv4_address - Optional Object
Enable this option

• no_ipv6_address - Optional Object
Enable this option

• site_to_site_connectivity_interface_disabled - Optional Object
Enable this option

• site_to_site_connectivity_interface_enabled - Optional Object
Enable this option

• static_ip - Optional String
Configure Static IP parameters for a node

• static_ipv6_address - Optional String
Static IP Parameters. Configure Static IP parameters

• vlan_interface - Optional String
Configuration parameter for VLAN interface

Azure Not Managed Node List Interface List Bond Interface

Deeply nested Interface block collapsed for readability.

Azure Not Managed Node List Interface List Bond Interface Active Backup

Deeply nested Backup block collapsed for readability.

Azure Not Managed Node List Interface List Bond Interface Lacp

Deeply nested Lacp block collapsed for readability.

Azure Not Managed Node List Interface List DHCP Client

Deeply nested Client block collapsed for readability.

Azure Not Managed Node List Interface List DHCP Server

Deeply nested Server block collapsed for readability.

Azure Not Managed Node List Interface List DHCP Server Automatic From End

Deeply nested End block collapsed for readability.

Azure Not Managed Node List Interface List DHCP Server Automatic From Start

Deeply nested Start block collapsed for readability.

Azure Not Managed Node List Interface List DHCP Server DHCP Networks

Deeply nested Networks block collapsed for readability.

Azure Not Managed Node List Interface List DHCP Server DHCP Networks First Address

Deeply nested Address block collapsed for readability.

Azure Not Managed Node List Interface List DHCP Server DHCP Networks Last Address

Deeply nested Address block collapsed for readability.

Azure Not Managed Node List Interface List DHCP Server DHCP Networks Pools

Deeply nested Pools block collapsed for readability.

Azure Not Managed Node List Interface List DHCP Server DHCP Networks Same As Dgw

Deeply nested Dgw block collapsed for readability.

Azure Not Managed Node List Interface List DHCP Server Interface IP Map

Deeply nested Map block collapsed for readability.

Azure Not Managed Node List Interface List Ethernet Interface

Deeply nested Interface block collapsed for readability.

Azure Not Managed Node List Interface List IPv6 Auto Config

Deeply nested Config block collapsed for readability.

Azure Not Managed Node List Interface List IPv6 Auto Config Host

Deeply nested Host block collapsed for readability.

Azure Not Managed Node List Interface List IPv6 Auto Config Router

Deeply nested Router block collapsed for readability.

Azure Not Managed Node List Interface List IPv6 Auto Config Router DNS Config

Deeply nested Config block collapsed for readability.

Azure Not Managed Node List Interface List IPv6 Auto Config Router DNS Config Configured List

Deeply nested List block collapsed for readability.

Azure Not Managed Node List Interface List IPv6 Auto Config Router DNS Config Local DNS

Deeply nested DNS block collapsed for readability.

Azure Not Managed Node List Interface List IPv6 Auto Config Router DNS Config Local DNS First Address

Deeply nested Address block collapsed for readability.

Azure Not Managed Node List Interface List IPv6 Auto Config Router DNS Config Local DNS Last Address

Deeply nested Address block collapsed for readability.

Azure Not Managed Node List Interface List IPv6 Auto Config Router Stateful

Deeply nested Stateful block collapsed for readability.

Azure Not Managed Node List Interface List IPv6 Auto Config Router Stateful Automatic From End

Deeply nested End block collapsed for readability.

Azure Not Managed Node List Interface List IPv6 Auto Config Router Stateful Automatic From Start

Deeply nested Start block collapsed for readability.

Azure Not Managed Node List Interface List IPv6 Auto Config Router Stateful DHCP Networks

Deeply nested Networks block collapsed for readability.

Azure Not Managed Node List Interface List IPv6 Auto Config Router Stateful DHCP Networks Pools

Deeply nested Pools block collapsed for readability.

Azure Not Managed Node List Interface List IPv6 Auto Config Router Stateful Interface IP Map

Deeply nested Map block collapsed for readability.

Azure Not Managed Node List Interface List Monitor

Deeply nested Monitor block collapsed for readability.

Azure Not Managed Node List Interface List Monitor Disabled

Deeply nested Disabled block collapsed for readability.

Azure Not Managed Node List Interface List Network Option

Deeply nested Option block collapsed for readability.

Azure Not Managed Node List Interface List Network Option Site Local Inside Network

Deeply nested Network block collapsed for readability.

Azure Not Managed Node List Interface List Network Option Site Local Network

Deeply nested Network block collapsed for readability.

Azure Not Managed Node List Interface List No IPv4 Address

Deeply nested Address block collapsed for readability.

Azure Not Managed Node List Interface List No IPv6 Address

Deeply nested Address block collapsed for readability.

Azure Not Managed Node List Interface List Site To Site Connectivity Interface Disabled

Deeply nested Disabled block collapsed for readability.

Azure Not Managed Node List Interface List Site To Site Connectivity Interface Enabled

Deeply nested Enabled block collapsed for readability.

Azure Not Managed Node List Interface List Static IP

Deeply nested IP block collapsed for readability.

Azure Not Managed Node List Interface List Static IPv6 Address

Deeply nested Address block collapsed for readability.

Azure Not Managed Node List Interface List Static IPv6 Address Cluster Static IP

Deeply nested IP block collapsed for readability.

Azure Not Managed Node List Interface List Static IPv6 Address Node Static IP

Deeply nested IP block collapsed for readability.

Azure Not Managed Node List Interface List VLAN Interface

Deeply nested Interface block collapsed for readability.

Baremetal

A baremetal block supports the following:

• not_managed - Optional String
Section will show nodes associated with this site

Baremetal Not Managed

A not_managed block (within baremetal) supports the following:

• node_list - Optional List
Section will show nodes associated with this site

Baremetal Not Managed Node List

A node_list block (within baremetal.not_managed) supports the following:

• hostname - Optional String
Hostname. Hostname for this Node

• interface_list - Optional List
Manage interfaces belonging to this node

• public_ip - Optional String
Public IP. Public IP for this Node

• type - Optional String
Possible values are Control, Worker
[Enum: Control|Worker] Type for this Node, can be Control or Worker

Baremetal Not Managed Node List Interface List

An interface_list block (within baremetal.not_managed.node_list) supports the following:

• bond_interface - Optional String
Configuration parameter for bond interface

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

• dhcp_client - Optional Object
Enable this option

• dhcp_server - Optional String
DHCPServerParametersType

• ethernet_interface - Optional String
Configuration parameter for ethernet interface

• ipv6_auto_config - Optional String
IPV6AutoConfigType

• is_management - Optional Bool
Configuration for is_management

• is_primary - Optional Bool
Configuration for is_primary

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

• monitor - Optional Object
Link Quality Monitoring configuration for a network interface

• monitor_disabled - Optional Object
Enable this option

• mtu - Optional Number
Maximum packet size (Maximum Transfer Unit) of the interface When configured, MTU must be between 512 and 16384

• name - Optional String
Interface Name. Name of this Interface

• no_ipv4_address - Optional Object
Enable this option

• no_ipv6_address - Optional Object
Enable this option

• site_to_site_connectivity_interface_disabled - Optional Object
Enable this option

• site_to_site_connectivity_interface_enabled - Optional Object
Enable this option

• static_ip - Optional String
Configure Static IP parameters for a node

• static_ipv6_address - Optional String
Static IP Parameters. Configure Static IP parameters

• vlan_interface - Optional String
Configuration parameter for VLAN interface

Baremetal Not Managed Node List Interface List Bond Interface

Deeply nested Interface block collapsed for readability.

Baremetal Not Managed Node List Interface List Bond Interface Active Backup

Deeply nested Backup block collapsed for readability.

Baremetal Not Managed Node List Interface List Bond Interface Lacp

Deeply nested Lacp block collapsed for readability.

Baremetal Not Managed Node List Interface List DHCP Client

Deeply nested Client block collapsed for readability.

Baremetal Not Managed Node List Interface List DHCP Server

Deeply nested Server block collapsed for readability.

Baremetal Not Managed Node List Interface List DHCP Server Automatic From End

Deeply nested End block collapsed for readability.

Baremetal Not Managed Node List Interface List DHCP Server Automatic From Start

Deeply nested Start block collapsed for readability.

Baremetal Not Managed Node List Interface List DHCP Server DHCP Networks

Deeply nested Networks block collapsed for readability.

Baremetal Not Managed Node List Interface List DHCP Server DHCP Networks First Address

Deeply nested Address block collapsed for readability.

Baremetal Not Managed Node List Interface List DHCP Server DHCP Networks Last Address

Deeply nested Address block collapsed for readability.

Baremetal Not Managed Node List Interface List DHCP Server DHCP Networks Pools

Deeply nested Pools block collapsed for readability.

Baremetal Not Managed Node List Interface List DHCP Server DHCP Networks Same As Dgw

Deeply nested Dgw block collapsed for readability.

Baremetal Not Managed Node List Interface List DHCP Server Interface IP Map

Deeply nested Map block collapsed for readability.

Baremetal Not Managed Node List Interface List Ethernet Interface

Deeply nested Interface block collapsed for readability.

Baremetal Not Managed Node List Interface List IPv6 Auto Config

Deeply nested Config block collapsed for readability.

Baremetal Not Managed Node List Interface List IPv6 Auto Config Host

Deeply nested Host block collapsed for readability.

Baremetal Not Managed Node List Interface List IPv6 Auto Config Router

Deeply nested Router block collapsed for readability.

Baremetal Not Managed Node List Interface List IPv6 Auto Config Router DNS Config

Deeply nested Config block collapsed for readability.

Baremetal Not Managed Node List Interface List IPv6 Auto Config Router DNS Config Configured List

Deeply nested List block collapsed for readability.

Baremetal Not Managed Node List Interface List IPv6 Auto Config Router DNS Config Local DNS

Deeply nested DNS block collapsed for readability.

Baremetal Not Managed Node List Interface List IPv6 Auto Config Router DNS Config Local DNS First Address

Deeply nested Address block collapsed for readability.

Baremetal Not Managed Node List Interface List IPv6 Auto Config Router DNS Config Local DNS Last Address

Deeply nested Address block collapsed for readability.

Baremetal Not Managed Node List Interface List IPv6 Auto Config Router Stateful

Deeply nested Stateful block collapsed for readability.

Baremetal Not Managed Node List Interface List IPv6 Auto Config Router Stateful Automatic From End

Deeply nested End block collapsed for readability.

Baremetal Not Managed Node List Interface List IPv6 Auto Config Router Stateful Automatic From Start

Deeply nested Start block collapsed for readability.

Baremetal Not Managed Node List Interface List IPv6 Auto Config Router Stateful DHCP Networks

Deeply nested Networks block collapsed for readability.

Baremetal Not Managed Node List Interface List IPv6 Auto Config Router Stateful DHCP Networks Pools

Deeply nested Pools block collapsed for readability.

Baremetal Not Managed Node List Interface List IPv6 Auto Config Router Stateful Interface IP Map

Deeply nested Map block collapsed for readability.

Baremetal Not Managed Node List Interface List Monitor

Deeply nested Monitor block collapsed for readability.

Baremetal Not Managed Node List Interface List Monitor Disabled

Deeply nested Disabled block collapsed for readability.

Baremetal Not Managed Node List Interface List Network Option

Deeply nested Option block collapsed for readability.

Baremetal Not Managed Node List Interface List Network Option Site Local Inside Network

Deeply nested Network block collapsed for readability.

Baremetal Not Managed Node List Interface List Network Option Site Local Network

Deeply nested Network block collapsed for readability.

Baremetal Not Managed Node List Interface List No IPv4 Address

Deeply nested Address block collapsed for readability.

Baremetal Not Managed Node List Interface List No IPv6 Address

Deeply nested Address block collapsed for readability.

Baremetal Not Managed Node List Interface List Site To Site Connectivity Interface Disabled

Deeply nested Disabled block collapsed for readability.

Baremetal Not Managed Node List Interface List Site To Site Connectivity Interface Enabled

Deeply nested Enabled block collapsed for readability.

Baremetal Not Managed Node List Interface List Static IP

Deeply nested IP block collapsed for readability.

Baremetal Not Managed Node List Interface List Static IPv6 Address

Deeply nested Address block collapsed for readability.

Baremetal Not Managed Node List Interface List Static IPv6 Address Cluster Static IP

Deeply nested IP block collapsed for readability.

Baremetal Not Managed Node List Interface List Static IPv6 Address Node Static IP

Deeply nested IP block collapsed for readability.

Baremetal Not Managed Node List Interface List VLAN Interface

Deeply nested Interface block collapsed for readability.

Block All Services

A block_all_services block supports the following:

Blocked Services

A blocked_services block supports the following:

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

Blocked Services Blocked Service

A blocked_service block (within blocked_services) supports the following:

• 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

Blocked Services Blocked Service DNS

A dns block (within blocked_services.blocked_service) supports the following:

Blocked Services Blocked Service SSH

A ssh block (within blocked_services.blocked_service) supports the following:

Blocked Services Blocked Service Web User Interface

A web_user_interface block (within blocked_services.blocked_service) supports the following:

Custom Proxy

A custom_proxy block supports the following:

• disable_re_tunnel - Optional Object
Configuration parameter for disable RE tunnel

• enable_re_tunnel - Optional Object
Configuration parameter for enable RE tunnel

• password - Optional String
SecretType is used in an object to indicate a sensitive/confidential field

• proxy_ip_address - Optional String
Specify the IPv4 Address of the internal Enterprise Proxy

• proxy_port - Optional Number
Specify the Port of the internal Enterprise Proxy

• username - Optional String
If the internal Enterprise Proxy is using basic authentication, specify the username. This is an optional field

Custom Proxy Disable RE Tunnel

A disable_re_tunnel block (within custom_proxy) supports the following:

Custom Proxy Enable RE Tunnel

An enable_re_tunnel block (within custom_proxy) supports the following:

Custom Proxy Password

A password block (within custom_proxy) supports the following:

• blindfold_secret_info - Optional String
BlindfoldSecretInfoType specifies information about the Secret managed by F5XC Secret Management

• clear_secret_info - Optional String
ClearSecretInfoType specifies information about the Secret that is not encrypted

Custom Proxy Password Blindfold Secret Info

A blindfold_secret_info block (within custom_proxy.password) supports the following:

• decryption_provider - Optional String
Name of the Secret Management Access object that contains information about the backend Secret Management service

• location - Optional String
Location is the uri_ref. It could be in URL format for string:/// Or it could be a path if the store provider is an HTTP/HTTPS location

Custom Proxy Password Clear Secret Info

A clear_secret_info block (within custom_proxy.password) supports the following:

Custom Proxy Bypass

A custom_proxy_bypass block supports the following:

• proxy_bypass - Optional List
Proxy Bypass. List of domains to bypass the proxy

Dc Cluster Group SLI

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

Dc Cluster Group Slo

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

Disable Advanced Delivery

A disable_advanced_delivery block supports the following:

Disable HA

A disable_ha block supports the following:

Disable Log Anonymization

A disable_log_anonymization block supports the following:

Disable Management Network

A disable_management_network block supports the following:

Disable URL Categorization

A disable_url_categorization block supports the following:

DNS NTP Config

A dns_ntp_config block supports the following:

• custom_dns - Optional String
DNS Servers. DNS Servers

• custom_ntp - Optional String
NTP Servers. NTP Servers

• f5_dns_default - Optional Object
Configuration parameter for f5 DNS default

• f5_ntp_default - Optional Object
Configuration parameter for f5 NTP default

DNS NTP Config Custom DNS

A custom_dns block (within dns_ntp_config) supports the following:

• dns_servers - Optional List
DNS Servers. DNS Servers

DNS NTP Config Custom NTP

A custom_ntp block (within dns_ntp_config) supports the following:

• ntp_servers - Optional List
NTP Servers. NTP Servers

DNS NTP Config F5 DNS Default

A f5_dns_default block (within dns_ntp_config) supports the following:

DNS NTP Config F5 NTP Default

A f5_ntp_default block (within dns_ntp_config) supports the following:

Enable Advanced Delivery

An enable_advanced_delivery block supports the following:

Enable HA

An enable_ha block supports the following:

Enable Log Anonymization

An enable_log_anonymization block supports the following:

Enable Management Network

An enable_management_network block supports the following:

Enable URL Categorization

An enable_url_categorization block supports the following:

Equinix

An equinix block supports the following:

• not_managed - Optional String
Section will show nodes associated with this site

Equinix Not Managed

A not_managed block (within equinix) supports the following:

• node_list - Optional List
Section will show nodes associated with this site

Equinix Not Managed Node List

A node_list block (within equinix.not_managed) supports the following:

• hostname - Optional String
Hostname. Hostname for this Node

• interface_list - Optional List
Manage interfaces belonging to this node

• public_ip - Optional String
Public IP. Public IP for this Node

• type - Optional String
Possible values are Control, Worker
[Enum: Control|Worker] Type for this Node, can be Control or Worker

Equinix Not Managed Node List Interface List

An interface_list block (within equinix.not_managed.node_list) supports the following:

• bond_interface - Optional String
Configuration parameter for bond interface

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

• dhcp_client - Optional Object
Enable this option

• dhcp_server - Optional String
DHCPServerParametersType

• ethernet_interface - Optional String
Configuration parameter for ethernet interface

• ipv6_auto_config - Optional String
IPV6AutoConfigType

• is_management - Optional Bool
Configuration for is_management

• is_primary - Optional Bool
Configuration for is_primary

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

• monitor - Optional Object
Link Quality Monitoring configuration for a network interface

• monitor_disabled - Optional Object
Enable this option

• mtu - Optional Number
Maximum packet size (Maximum Transfer Unit) of the interface When configured, MTU must be between 512 and 16384

• name - Optional String
Interface Name. Name of this Interface

• no_ipv4_address - Optional Object
Enable this option

• no_ipv6_address - Optional Object
Enable this option

• site_to_site_connectivity_interface_disabled - Optional Object
Enable this option

• site_to_site_connectivity_interface_enabled - Optional Object
Enable this option

• static_ip - Optional String
Configure Static IP parameters for a node

• static_ipv6_address - Optional String
Static IP Parameters. Configure Static IP parameters

• vlan_interface - Optional String
Configuration parameter for VLAN interface

Equinix Not Managed Node List Interface List Bond Interface

Deeply nested Interface block collapsed for readability.

Equinix Not Managed Node List Interface List Bond Interface Active Backup

Deeply nested Backup block collapsed for readability.

Equinix Not Managed Node List Interface List Bond Interface Lacp

Deeply nested Lacp block collapsed for readability.

Equinix Not Managed Node List Interface List DHCP Client

Deeply nested Client block collapsed for readability.

Equinix Not Managed Node List Interface List DHCP Server

Deeply nested Server block collapsed for readability.

Equinix Not Managed Node List Interface List DHCP Server Automatic From End

Deeply nested End block collapsed for readability.

Equinix Not Managed Node List Interface List DHCP Server Automatic From Start

Deeply nested Start block collapsed for readability.

Equinix Not Managed Node List Interface List DHCP Server DHCP Networks

Deeply nested Networks block collapsed for readability.

Equinix Not Managed Node List Interface List DHCP Server DHCP Networks First Address

Deeply nested Address block collapsed for readability.

Equinix Not Managed Node List Interface List DHCP Server DHCP Networks Last Address

Deeply nested Address block collapsed for readability.

Equinix Not Managed Node List Interface List DHCP Server DHCP Networks Pools

Deeply nested Pools block collapsed for readability.

Equinix Not Managed Node List Interface List DHCP Server DHCP Networks Same As Dgw

Deeply nested Dgw block collapsed for readability.

Equinix Not Managed Node List Interface List DHCP Server Interface IP Map

Deeply nested Map block collapsed for readability.

Equinix Not Managed Node List Interface List Ethernet Interface

Deeply nested Interface block collapsed for readability.

Equinix Not Managed Node List Interface List IPv6 Auto Config

Deeply nested Config block collapsed for readability.

Equinix Not Managed Node List Interface List IPv6 Auto Config Host

Deeply nested Host block collapsed for readability.

Equinix Not Managed Node List Interface List IPv6 Auto Config Router

Deeply nested Router block collapsed for readability.

Equinix Not Managed Node List Interface List IPv6 Auto Config Router DNS Config

Deeply nested Config block collapsed for readability.

Equinix Not Managed Node List Interface List IPv6 Auto Config Router DNS Config Configured List

Deeply nested List block collapsed for readability.

Equinix Not Managed Node List Interface List IPv6 Auto Config Router DNS Config Local DNS

Deeply nested DNS block collapsed for readability.

Equinix Not Managed Node List Interface List IPv6 Auto Config Router DNS Config Local DNS First Address

Deeply nested Address block collapsed for readability.

Equinix Not Managed Node List Interface List IPv6 Auto Config Router DNS Config Local DNS Last Address

Deeply nested Address block collapsed for readability.

Equinix Not Managed Node List Interface List IPv6 Auto Config Router Stateful

Deeply nested Stateful block collapsed for readability.

Equinix Not Managed Node List Interface List IPv6 Auto Config Router Stateful Automatic From End

Deeply nested End block collapsed for readability.

Equinix Not Managed Node List Interface List IPv6 Auto Config Router Stateful Automatic From Start

Deeply nested Start block collapsed for readability.

Equinix Not Managed Node List Interface List IPv6 Auto Config Router Stateful DHCP Networks

Deeply nested Networks block collapsed for readability.

Equinix Not Managed Node List Interface List IPv6 Auto Config Router Stateful DHCP Networks Pools

Deeply nested Pools block collapsed for readability.

Equinix Not Managed Node List Interface List IPv6 Auto Config Router Stateful Interface IP Map

Deeply nested Map block collapsed for readability.

Equinix Not Managed Node List Interface List Monitor

Deeply nested Monitor block collapsed for readability.

Equinix Not Managed Node List Interface List Monitor Disabled

Deeply nested Disabled block collapsed for readability.

Equinix Not Managed Node List Interface List Network Option

Deeply nested Option block collapsed for readability.

Equinix Not Managed Node List Interface List Network Option Site Local Inside Network

Deeply nested Network block collapsed for readability.

Equinix Not Managed Node List Interface List Network Option Site Local Network

Deeply nested Network block collapsed for readability.

Equinix Not Managed Node List Interface List No IPv4 Address

Deeply nested Address block collapsed for readability.

Equinix Not Managed Node List Interface List No IPv6 Address

Deeply nested Address block collapsed for readability.

Equinix Not Managed Node List Interface List Site To Site Connectivity Interface Disabled

Deeply nested Disabled block collapsed for readability.

Equinix Not Managed Node List Interface List Site To Site Connectivity Interface Enabled

Deeply nested Enabled block collapsed for readability.

Equinix Not Managed Node List Interface List Static IP

Deeply nested IP block collapsed for readability.

Equinix Not Managed Node List Interface List Static IPv6 Address

Deeply nested Address block collapsed for readability.

Equinix Not Managed Node List Interface List Static IPv6 Address Cluster Static IP

Deeply nested IP block collapsed for readability.

Equinix Not Managed Node List Interface List Static IPv6 Address Node Static IP

Deeply nested IP block collapsed for readability.

Equinix Not Managed Node List Interface List VLAN Interface

Deeply nested Interface block collapsed for readability.

F5 Proxy

A f5_proxy block supports the following:

GCP

A gcp block supports the following:

• not_managed - Optional String
Section will show nodes associated with this site

GCP Not Managed

A not_managed block (within gcp) supports the following:

• node_list - Optional List
Section will show nodes associated with this site

GCP Not Managed Node List

A node_list block (within gcp.not_managed) supports the following:

• hostname - Optional String
Hostname. Hostname for this Node

• interface_list - Optional List
Manage interfaces belonging to this node

• public_ip - Optional String
Public IP. Public IP for this Node

• type - Optional String
Possible values are Control, Worker
[Enum: Control|Worker] Type for this Node, can be Control or Worker

GCP Not Managed Node List Interface List

An interface_list block (within gcp.not_managed.node_list) supports the following:

• bond_interface - Optional String
Configuration parameter for bond interface

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

• dhcp_client - Optional Object
Enable this option

• dhcp_server - Optional String
DHCPServerParametersType

• ethernet_interface - Optional String
Configuration parameter for ethernet interface

• ipv6_auto_config - Optional String
IPV6AutoConfigType

• is_management - Optional Bool
Configuration for is_management

• is_primary - Optional Bool
Configuration for is_primary

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

• monitor - Optional Object
Link Quality Monitoring configuration for a network interface

• monitor_disabled - Optional Object
Enable this option

• mtu - Optional Number
Maximum packet size (Maximum Transfer Unit) of the interface When configured, MTU must be between 512 and 16384

• name - Optional String
Interface Name. Name of this Interface

• no_ipv4_address - Optional Object
Enable this option

• no_ipv6_address - Optional Object
Enable this option

• site_to_site_connectivity_interface_disabled - Optional Object
Enable this option

• site_to_site_connectivity_interface_enabled - Optional Object
Enable this option

• static_ip - Optional String
Configure Static IP parameters for a node

• static_ipv6_address - Optional String
Static IP Parameters. Configure Static IP parameters

• vlan_interface - Optional String
Configuration parameter for VLAN interface

GCP Not Managed Node List Interface List Bond Interface

Deeply nested Interface block collapsed for readability.

GCP Not Managed Node List Interface List Bond Interface Active Backup

Deeply nested Backup block collapsed for readability.

GCP Not Managed Node List Interface List Bond Interface Lacp

Deeply nested Lacp block collapsed for readability.

GCP Not Managed Node List Interface List DHCP Client

Deeply nested Client block collapsed for readability.

GCP Not Managed Node List Interface List DHCP Server

Deeply nested Server block collapsed for readability.

GCP Not Managed Node List Interface List DHCP Server Automatic From End

Deeply nested End block collapsed for readability.

GCP Not Managed Node List Interface List DHCP Server Automatic From Start

Deeply nested Start block collapsed for readability.

GCP Not Managed Node List Interface List DHCP Server DHCP Networks

Deeply nested Networks block collapsed for readability.

GCP Not Managed Node List Interface List DHCP Server DHCP Networks First Address

Deeply nested Address block collapsed for readability.

GCP Not Managed Node List Interface List DHCP Server DHCP Networks Last Address

Deeply nested Address block collapsed for readability.

GCP Not Managed Node List Interface List DHCP Server DHCP Networks Pools

Deeply nested Pools block collapsed for readability.

GCP Not Managed Node List Interface List DHCP Server DHCP Networks Same As Dgw

Deeply nested Dgw block collapsed for readability.

GCP Not Managed Node List Interface List DHCP Server Interface IP Map

Deeply nested Map block collapsed for readability.

GCP Not Managed Node List Interface List Ethernet Interface

Deeply nested Interface block collapsed for readability.

GCP Not Managed Node List Interface List IPv6 Auto Config

Deeply nested Config block collapsed for readability.

GCP Not Managed Node List Interface List IPv6 Auto Config Host

Deeply nested Host block collapsed for readability.

GCP Not Managed Node List Interface List IPv6 Auto Config Router

Deeply nested Router block collapsed for readability.

GCP Not Managed Node List Interface List IPv6 Auto Config Router DNS Config

Deeply nested Config block collapsed for readability.

GCP Not Managed Node List Interface List IPv6 Auto Config Router DNS Config Configured List

Deeply nested List block collapsed for readability.

GCP Not Managed Node List Interface List IPv6 Auto Config Router DNS Config Local DNS

Deeply nested DNS block collapsed for readability.

GCP Not Managed Node List Interface List IPv6 Auto Config Router DNS Config Local DNS First Address

Deeply nested Address block collapsed for readability.

GCP Not Managed Node List Interface List IPv6 Auto Config Router DNS Config Local DNS Last Address

Deeply nested Address block collapsed for readability.

GCP Not Managed Node List Interface List IPv6 Auto Config Router Stateful

Deeply nested Stateful block collapsed for readability.

GCP Not Managed Node List Interface List IPv6 Auto Config Router Stateful Automatic From End

Deeply nested End block collapsed for readability.

GCP Not Managed Node List Interface List IPv6 Auto Config Router Stateful Automatic From Start

Deeply nested Start block collapsed for readability.

GCP Not Managed Node List Interface List IPv6 Auto Config Router Stateful DHCP Networks

Deeply nested Networks block collapsed for readability.

GCP Not Managed Node List Interface List IPv6 Auto Config Router Stateful DHCP Networks Pools

Deeply nested Pools block collapsed for readability.

GCP Not Managed Node List Interface List IPv6 Auto Config Router Stateful Interface IP Map

Deeply nested Map block collapsed for readability.

GCP Not Managed Node List Interface List Monitor

Deeply nested Monitor block collapsed for readability.

GCP Not Managed Node List Interface List Monitor Disabled

Deeply nested Disabled block collapsed for readability.

GCP Not Managed Node List Interface List Network Option

Deeply nested Option block collapsed for readability.

GCP Not Managed Node List Interface List Network Option Site Local Inside Network

Deeply nested Network block collapsed for readability.

GCP Not Managed Node List Interface List Network Option Site Local Network

Deeply nested Network block collapsed for readability.

GCP Not Managed Node List Interface List No IPv4 Address

Deeply nested Address block collapsed for readability.

GCP Not Managed Node List Interface List No IPv6 Address

Deeply nested Address block collapsed for readability.

GCP Not Managed Node List Interface List Site To Site Connectivity Interface Disabled

Deeply nested Disabled block collapsed for readability.

GCP Not Managed Node List Interface List Site To Site Connectivity Interface Enabled

Deeply nested Enabled block collapsed for readability.

GCP Not Managed Node List Interface List Static IP

Deeply nested IP block collapsed for readability.

GCP Not Managed Node List Interface List Static IPv6 Address

Deeply nested Address block collapsed for readability.

GCP Not Managed Node List Interface List Static IPv6 Address Cluster Static IP

Deeply nested IP block collapsed for readability.

GCP Not Managed Node List Interface List Static IPv6 Address Node Static IP

Deeply nested IP block collapsed for readability.

GCP Not Managed Node List Interface List VLAN Interface

Deeply nested Interface block collapsed for readability.

Kvm

A kvm block supports the following:

• not_managed - Optional String
Section will show nodes associated with this site

Kvm Not Managed

A not_managed block (within kvm) supports the following:

• node_list - Optional List
Section will show nodes associated with this site

Kvm Not Managed Node List

A node_list block (within kvm.not_managed) supports the following:

• hostname - Optional String
Hostname. Hostname for this Node

• interface_list - Optional List
Manage interfaces belonging to this node

• public_ip - Optional String
Public IP. Public IP for this Node

• type - Optional String
Possible values are Control, Worker
[Enum: Control|Worker] Type for this Node, can be Control or Worker

Kvm Not Managed Node List Interface List

An interface_list block (within kvm.not_managed.node_list) supports the following:

• bond_interface - Optional String
Configuration parameter for bond interface

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

• dhcp_client - Optional Object
Enable this option

• dhcp_server - Optional String
DHCPServerParametersType

• ethernet_interface - Optional String
Configuration parameter for ethernet interface

• ipv6_auto_config - Optional String
IPV6AutoConfigType

• is_management - Optional Bool
Configuration for is_management

• is_primary - Optional Bool
Configuration for is_primary

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

• monitor - Optional Object
Link Quality Monitoring configuration for a network interface

• monitor_disabled - Optional Object
Enable this option

• mtu - Optional Number
Maximum packet size (Maximum Transfer Unit) of the interface When configured, MTU must be between 512 and 16384

• name - Optional String
Interface Name. Name of this Interface

• no_ipv4_address - Optional Object
Enable this option

• no_ipv6_address - Optional Object
Enable this option

• site_to_site_connectivity_interface_disabled - Optional Object
Enable this option

• site_to_site_connectivity_interface_enabled - Optional Object
Enable this option

• static_ip - Optional String
Configure Static IP parameters for a node

• static_ipv6_address - Optional String
Static IP Parameters. Configure Static IP parameters

• vlan_interface - Optional String
Configuration parameter for VLAN interface

Kvm Not Managed Node List Interface List Bond Interface

Deeply nested Interface block collapsed for readability.

Kvm Not Managed Node List Interface List Bond Interface Active Backup

Deeply nested Backup block collapsed for readability.

Kvm Not Managed Node List Interface List Bond Interface Lacp

Deeply nested Lacp block collapsed for readability.

Kvm Not Managed Node List Interface List DHCP Client

Deeply nested Client block collapsed for readability.

Kvm Not Managed Node List Interface List DHCP Server

Deeply nested Server block collapsed for readability.

Kvm Not Managed Node List Interface List DHCP Server Automatic From End

Deeply nested End block collapsed for readability.

Kvm Not Managed Node List Interface List DHCP Server Automatic From Start

Deeply nested Start block collapsed for readability.

Kvm Not Managed Node List Interface List DHCP Server DHCP Networks

Deeply nested Networks block collapsed for readability.

Kvm Not Managed Node List Interface List DHCP Server DHCP Networks First Address

Deeply nested Address block collapsed for readability.

Kvm Not Managed Node List Interface List DHCP Server DHCP Networks Last Address

Deeply nested Address block collapsed for readability.

Kvm Not Managed Node List Interface List DHCP Server DHCP Networks Pools

Deeply nested Pools block collapsed for readability.

Kvm Not Managed Node List Interface List DHCP Server DHCP Networks Same As Dgw

Deeply nested Dgw block collapsed for readability.

Kvm Not Managed Node List Interface List DHCP Server Interface IP Map

Deeply nested Map block collapsed for readability.

Kvm Not Managed Node List Interface List Ethernet Interface

Deeply nested Interface block collapsed for readability.

Kvm Not Managed Node List Interface List IPv6 Auto Config

Deeply nested Config block collapsed for readability.

Kvm Not Managed Node List Interface List IPv6 Auto Config Host

Deeply nested Host block collapsed for readability.

Kvm Not Managed Node List Interface List IPv6 Auto Config Router

Deeply nested Router block collapsed for readability.

Kvm Not Managed Node List Interface List IPv6 Auto Config Router DNS Config

Deeply nested Config block collapsed for readability.

Kvm Not Managed Node List Interface List IPv6 Auto Config Router DNS Config Configured List

Deeply nested List block collapsed for readability.

Kvm Not Managed Node List Interface List IPv6 Auto Config Router DNS Config Local DNS

Deeply nested DNS block collapsed for readability.

Kvm Not Managed Node List Interface List IPv6 Auto Config Router DNS Config Local DNS First Address

Deeply nested Address block collapsed for readability.

Kvm Not Managed Node List Interface List IPv6 Auto Config Router DNS Config Local DNS Last Address

Deeply nested Address block collapsed for readability.

Kvm Not Managed Node List Interface List IPv6 Auto Config Router Stateful

Deeply nested Stateful block collapsed for readability.

Kvm Not Managed Node List Interface List IPv6 Auto Config Router Stateful Automatic From End

Deeply nested End block collapsed for readability.

Kvm Not Managed Node List Interface List IPv6 Auto Config Router Stateful Automatic From Start

Deeply nested Start block collapsed for readability.

Kvm Not Managed Node List Interface List IPv6 Auto Config Router Stateful DHCP Networks

Deeply nested Networks block collapsed for readability.

Kvm Not Managed Node List Interface List IPv6 Auto Config Router Stateful DHCP Networks Pools

Deeply nested Pools block collapsed for readability.

Kvm Not Managed Node List Interface List IPv6 Auto Config Router Stateful Interface IP Map

Deeply nested Map block collapsed for readability.

Kvm Not Managed Node List Interface List Monitor

Deeply nested Monitor block collapsed for readability.

Kvm Not Managed Node List Interface List Monitor Disabled

Deeply nested Disabled block collapsed for readability.

Kvm Not Managed Node List Interface List Network Option

Deeply nested Option block collapsed for readability.

Kvm Not Managed Node List Interface List Network Option Site Local Inside Network

Deeply nested Network block collapsed for readability.

Kvm Not Managed Node List Interface List Network Option Site Local Network

Deeply nested Network block collapsed for readability.

Kvm Not Managed Node List Interface List No IPv4 Address

Deeply nested Address block collapsed for readability.

Kvm Not Managed Node List Interface List No IPv6 Address

Deeply nested Address block collapsed for readability.

Kvm Not Managed Node List Interface List Site To Site Connectivity Interface Disabled

Deeply nested Disabled block collapsed for readability.

Kvm Not Managed Node List Interface List Site To Site Connectivity Interface Enabled

Deeply nested Enabled block collapsed for readability.

Kvm Not Managed Node List Interface List Static IP

Deeply nested IP block collapsed for readability.

Kvm Not Managed Node List Interface List Static IPv6 Address

Deeply nested Address block collapsed for readability.

Kvm Not Managed Node List Interface List Static IPv6 Address Cluster Static IP

Deeply nested IP block collapsed for readability.

Kvm Not Managed Node List Interface List Static IPv6 Address Node Static IP

Deeply nested IP block collapsed for readability.

Kvm Not Managed Node List Interface List VLAN Interface

Deeply nested Interface block collapsed for readability.

Load Balancing

A load_balancing block supports the following:

• 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

Local Vrf

A local_vrf block supports the following:

• default_config - Optional Object
Enable this option

• default_sli_config - Optional Object
Enable this option

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

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

Local Vrf Default Config

A default_config block (within local_vrf) supports the following:

Local Vrf Default SLI Config

A default_sli_config block (within local_vrf) supports the following:

Local Vrf SLI Config

A sli_config block (within local_vrf) supports the following:

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

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

• no_static_routes - Optional Object
Configuration parameter for no static routes

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

• secondary_nameserver - Optional String
Optional Secondary IPv4 DNS server to be used for name resolution

• 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

Local Vrf SLI Config No Static Routes

A no_static_routes block (within local_vrf.sli_config) supports the following:

Local Vrf SLI Config No V6 Static Routes

Deeply nested Routes block collapsed for readability.

Local Vrf SLI Config Static Routes

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

• static_routes - Optional List
Configuration parameter for static routes

Local Vrf SLI Config Static Routes Static Routes

Deeply nested Routes block collapsed for readability.

Local Vrf SLI Config Static Routes Static Routes Default Gateway

Deeply nested Gateway block collapsed for readability.

Local Vrf SLI Config Static Routes Static Routes Node Interface

Deeply nested Interface block collapsed for readability.

Local Vrf SLI Config Static Routes Static Routes Node Interface List

Deeply nested List block collapsed for readability.

Local Vrf SLI Config Static Routes Static Routes Node Interface List Interface

Deeply nested Interface block collapsed for readability.

Local Vrf SLI Config Static V6 Routes

A static_v6_routes block (within local_vrf.sli_config) supports the following:

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

Local Vrf SLI Config Static V6 Routes Static Routes

Deeply nested Routes block collapsed for readability.

Local Vrf SLI Config Static V6 Routes Static Routes Default Gateway

Deeply nested Gateway block collapsed for readability.

Local Vrf SLI Config Static V6 Routes Static Routes Node Interface

Deeply nested Interface block collapsed for readability.

Local Vrf SLI Config Static V6 Routes Static Routes Node Interface List

Deeply nested List block collapsed for readability.

Local Vrf SLI Config Static V6 Routes Static Routes Node Interface List Interface

Deeply nested Interface block collapsed for readability.

Local Vrf Slo Config

A slo_config block (within local_vrf) supports the following: