- Home
- Documentation
- Sites
- Resources
- xcsh_securemesh_site_v2 (Resource)
xcsh_securemesh_site_v2 (Resource)
Manages a Securemesh Site V2 resource in F5 Distributed Cloud for deploying secure mesh edge sites with security and networking controls.
~> Note: For more information, see the F5 Distributed Cloud API documentation.
Example Usage
Section titled “Example Usage”# SecuremeshSiteV2 Resource Example# Manages a Securemesh Site V2 resource in F5 Distributed Cloud for deploying secure mesh edge sites with security and networking controls.
terraform { required_version = ">= 1.0"
required_providers { xcsh = { source = "f5-sales-demo/xcsh" version = ">= 0.1.0" } }}
# Basic SecuremeshSiteV2 configurationresource "xcsh_securemesh_site_v2" "example" { name = "example-securemesh-site-v2" namespace = "system"}Argument Reference
Section titled “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
Section titled “Metadata Argument Reference”• name - Required String
Name of the Securemesh Site V2. Must be unique within the namespace. Must be at most 63 characters (DNS-1035)
• annotations - Optional Map
Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata
• description - Optional String
Human readable description for the object
• disable - Optional Bool
A value of true administratively disables the object
• labels - Optional Map
Labels is a user defined key value map that can be attached to resources for organization and filtering
• namespace - Optional String
Namespace for the Securemesh Site V2. The F5 XC API restricts this resource to the system namespace; it defaults to that value and may be omitted
Spec Argument Reference
Section titled “Spec Argument Reference”-> One of the following:
• active_enhanced_firewall_policies - Optional Block
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
See Active Enhanced Firewall
Policies below for details.
-> One of the following:
• active_forward_proxy_policies - Optional Block
Ordered List of Forward Proxy Policies active
See Active Forward Proxy Policies below for details.
• admin_user_credentials - Optional Block
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
See Admin User Credentials below for details.
-> One of the following:
• aws - Optional Block
AWS Provider Type. AWS Provider Type
See AWS below for details.
• azure - Optional Block
Azure Provider Type. Azure Provider Type
See Azure below for details.
• baremetal - Optional Block
Baremetal Provider Type. Baremetal Provider Type
• equinix - Optional Block
Equinix Provider Type. Equinix Provider Type
• gcp - Optional Block
GCP Provider Type. GCP Provider Type
• kvm - Optional Block
KVM Provider Type. KVM Provider Type
• nutanix - Optional Block
Nutanix Provider Type. Nutanix Provider Type
• oci - Optional Block
OCI Provider Type. OCI Provider Type
• openshift_virtualization - Optional Block
Configuration parameter for openshift virtualization
• openstack - Optional Block
Openstack Provider Type. Openstack Provider Type
• vmware - Optional Block
VMware Provider Type. VMware Provider Type
-> One of the following:
• block_all_services - Optional Object
Enable this option
• blocked_services - Optional Block
Disable node local services on this site
-> One of the following:
• custom_proxy - Optional Block
Configuration parameter for custom proxy
• f5_proxy - Optional Object
Enable this option
-> One of the following:
• custom_proxy_bypass - Optional Block
Configuration parameter for custom proxy bypass
-> One of the following:
• dc_cluster_group_sli - Optional Block
Type establishes a direct reference from one object(the referrer) to another(the referred). Such a reference is in form of tenant/namespace/name
-> One of the following:
• dc_cluster_group_slo - Optional Block
Type establishes a direct reference from one object(the referrer) to another(the referred). Such a reference is in form of tenant/namespace/name
• no_s2s_connectivity_slo - Optional Object
Configuration parameter for no S2S connectivity slo
-> One of the following:
• disable_advanced_delivery - Optional Object
Configuration parameter for disable advanced delivery
-> One of the following:
• disable_ha - Optional Object
Enable this option
-> One of the following:
• disable_log_anonymization - Optional Object
Configuration parameter for disable log anonymization
-> One of the following:
• disable_management_network - Optional Object
Configuration parameter for disable management network
-> One of the following:
• disable_url_categorization - Optional Object
Enable this option
• dns_ntp_config - Optional Block
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
• load_balancing - Optional Block
Section contains settings on the site that relate to Load Balancing functionality
• local_vrf - Optional Block
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
-> One of the following:
• log_receiver_with_net - Optional Block
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
• offline_survivability_mode - Optional Block
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
• performance_enhancement_mode - Optional Block
Optimize the site for L3 or L7 traffic processing. L7 optimized is the default
• re_select - Optional Block
Selection criteria to connect the site with F5 Distributed Cloud Regional Edge(s)
• segment_vrf - Optional Block
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 Block
Select how the site mesh group will be connected. By default, public IPs of the control nodes of the site will be used
• software_settings - Optional Block
Select OS and Software version for the site. All nodes in the site will run the same OS and Software version. These settings cannot be changed after the site is created. This block is a create-only, write-only input; changing it replaces the resource, and refresh preserves the configured value
without claiming XC observed it
• timeouts - Optional Block
• 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 Block
Configuration parameter for upgrade settings
Attributes Reference
Section titled “Attributes Reference”In addition to all arguments above, the following attributes are exported:
• id - Optional String
Unique identifier for the resource
Active Enhanced Firewall Policies
Section titled “Active Enhanced Firewall Policies”An active_enhanced_firewall_policies block supports the following:
• enhanced_firewall_policies - Optional Block
Ordered List of Enhanced Firewall Policies active
See Enhanced Firewall Policies below.
Active Enhanced Firewall Policies Enhanced Firewall Policies
Section titled “Active Enhanced Firewall Policies Enhanced Firewall Policies”An enhanced_firewall_policies block (within active_enhanced_firewall_policies) 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
Active Forward Proxy Policies
Section titled “Active Forward Proxy Policies”An active_forward_proxy_policies block supports the following:
• forward_proxy_policies - Optional Block
Ordered List of Forward Proxy Policies active
See Forward Proxy Policies below.
Active Forward Proxy Policies Forward Proxy Policies
Section titled “Active Forward Proxy Policies Forward Proxy Policies”A forward_proxy_policies block (within active_forward_proxy_policies) 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
Admin User Credentials
Section titled “Admin User Credentials”An admin_user_credentials block supports the following:
• admin_password - Optional Block
SecretType is used in an object to indicate a sensitive/confidential field
See Admin Password below.
• 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
Admin User Credentials Admin Password
Section titled “Admin User Credentials Admin Password”An admin_password block (within admin_user_credentials) supports the following:
• blindfold_secret_info - Optional Block
BlindfoldSecretInfoType specifies information about the Secret managed by F5XC Secret Management
See Blindfold Secret Info below.
• clear_secret_info - Optional Block
ClearSecretInfoType specifies information about the Secret that is not encrypted
See Clear Secret Info below.
Admin User Credentials Admin Password Blindfold Secret Info
Section titled “Admin User Credentials Admin Password Blindfold Secret Info”Deeply nested Info block collapsed for readability.
Admin User Credentials Admin Password Clear Secret Info
Section titled “Admin User Credentials Admin Password Clear Secret Info”Deeply nested Info block collapsed for readability.
An aws block supports the following:
• not_managed - Optional Block
Section will show nodes associated with this site
See Not Managed below.
AWS Not Managed
Section titled “AWS Not Managed”A not_managed block (within aws) supports the following:
• node_list - Optional Block
Section will show nodes associated with this site
See Node List below.
AWS Not Managed Node List
Section titled “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 Block
Manage interfaces belonging to this node
See Interface List below.
• 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
Section titled “AWS Not Managed Node List Interface List”An interface_list block (within aws.not_managed.node_list) supports the following:
• bond_interface - Optional Block
Configuration parameter for bond interface
See Bond Interface below.
• description_spec - Optional String
Interface Description. Description for this Interface
• dhcp_client - Optional Object
Enable this option
• dhcp_server - Optional Block
DHCPServerParametersType
See DHCP Server below.
• ethernet_interface - Optional Block
Configuration parameter for ethernet interface
See Ethernet Interface below.
• ipv6_auto_config - Optional Block
IPV6AutoConfigType
See IPv6 Auto Config below.
• 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 Block
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
See
Network Option below.
• 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 Block
Configure Static IP parameters for a node
See Static IP below.
• static_ipv6_address - Optional Block
Static IP Parameters. Configure Static IP parameters
See Static IPv6 Address below.
• vlan_interface - Optional Block
Configuration parameter for VLAN interface
See VLAN Interface below.
• is_management - Optional Bool
Configuration for is_management
• is_primary - Optional Bool
Configuration for is_primary
AWS Not Managed Node List Interface List Bond Interface
Section titled “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
Section titled “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
Section titled “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
Section titled “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
Section titled “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
Section titled “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
Section titled “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
Section titled “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
Section titled “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
Section titled “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
Section titled “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
Section titled “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
Section titled “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
Section titled “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
Section titled “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
Section titled “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
Section titled “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
Section titled “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
Section titled “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
Section titled “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
Section titled “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
Section titled “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
Section titled “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
Section titled “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
Section titled “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
Section titled “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
Section titled “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
Section titled “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
Section titled “AWS Not Managed Node List Interface List Monitor”Deeply nested Monitor block collapsed for readability.
AWS Not Managed Node List Interface List Monitor Disabled
Section titled “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
Section titled “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
Section titled “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
Section titled “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
Section titled “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
Section titled “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
Section titled “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
Section titled “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
Section titled “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
Section titled “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
Section titled “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
Section titled “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
Section titled “AWS Not Managed Node List Interface List VLAN Interface”Deeply nested Interface block collapsed for readability.
An azure block supports the following:
• not_managed - Optional Block
Section will show nodes associated with this site
See Not Managed below.
Azure Not Managed
Section titled “Azure Not Managed”A not_managed block (within azure) supports the following:
• node_list - Optional Block
Section will show nodes associated with this site
See Node List below.
Azure Not Managed Node List
Section titled “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 Block
Manage interfaces belonging to this node
See Interface List below.
• 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
Section titled “Azure Not Managed Node List Interface List”An interface_list block (within azure.not_managed.node_list) supports the following:
• bond_interface - Optional Block
Configuration parameter for bond interface
See Bond Interface below.
• description_spec - Optional String
Interface Description. Description for this Interface
• dhcp_client - Optional Object
Enable this option
• dhcp_server - Optional Block
DHCPServerParametersType
See DHCP Server below.
• ethernet_interface - Optional Block
Configuration parameter for ethernet interface
See Ethernet Interface below.
• ipv6_auto_config - Optional Block
IPV6AutoConfigType
See IPv6 Auto Config below.
• 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 Block
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
See
Network Option below.
• 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 Block
Configure Static IP parameters for a node
See Static IP below.
• static_ipv6_address - Optional Block
Static IP Parameters. Configure Static IP parameters
See Static IPv6 Address below.
• vlan_interface - Optional Block
Configuration parameter for VLAN interface
See VLAN Interface below.
• is_management - Optional Bool
Configuration for is_management
• is_primary - Optional Bool
Configuration for is_primary
Azure Not Managed Node List Interface List Bond Interface
Section titled “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
Section titled “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
Section titled “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
Section titled “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
Section titled “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
Section titled “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
Section titled “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
Section titled “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
Section titled “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
Section titled “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
Section titled “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
Section titled “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
Section titled “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
Section titled “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
Section titled “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
Section titled “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
Section titled “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
Section titled “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
Section titled “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
Section titled “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
Section titled “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
Section titled “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
Section titled “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
Section titled “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
Section titled “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
Section titled “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
Section titled “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
Section titled “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
Section titled “Azure Not Managed Node List Interface List Monitor”Deeply nested Monitor block collapsed for readability.
Azure Not Managed Node List Interface List Monitor Disabled
Section titled “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
Section titled “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
Section titled “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
Section titled “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
Section titled “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
Section titled “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
Section titled “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
Section titled “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
Section titled “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
Section titled “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
Section titled “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
Section titled “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
Section titled “Azure Not Managed Node List Interface List VLAN Interface”Deeply nested Interface block collapsed for readability.
Baremetal
Section titled “Baremetal”A baremetal block supports the following:
• not_managed - Optional Block
Section will show nodes associated with this site
See Not Managed below.
Baremetal Not Managed
Section titled “Baremetal Not Managed”A not_managed block (within baremetal) supports the following:
• node_list - Optional Block
Section will show nodes associated with this site
See Node List below.
Baremetal Not Managed Node List
Section titled “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 Block
Manage interfaces belonging to this node
See Interface List below.
• 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
Section titled “Baremetal Not Managed Node List Interface List”An interface_list block (within baremetal.not_managed.node_list) supports the following:
• bond_interface - Optional Block
Configuration parameter for bond interface
See Bond Interface below.
• description_spec - Optional String
Interface Description. Description for this Interface
• dhcp_client - Optional Object
Enable this option
• dhcp_server - Optional Block
DHCPServerParametersType
See DHCP Server below.
• ethernet_interface - Optional Block
Configuration parameter for ethernet interface
See Ethernet Interface below.
• ipv6_auto_config - Optional Block
IPV6AutoConfigType
See IPv6 Auto Config below.
• 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 Block
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
See
Network Option below.
• 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 Block
Configure Static IP parameters for a node
See Static IP below.
• static_ipv6_address - Optional Block
Static IP Parameters. Configure Static IP parameters
See Static IPv6 Address below.
• vlan_interface - Optional Block
Configuration parameter for VLAN interface
See VLAN Interface below.
• is_management - Optional Bool
Configuration for is_management
• is_primary - Optional Bool
Configuration for is_primary
Baremetal Not Managed Node List Interface List Bond Interface
Section titled “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
Section titled “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
Section titled “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
Section titled “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
Section titled “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
Section titled “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
Section titled “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
Section titled “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
Section titled “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
Section titled “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
Section titled “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
Section titled “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
Section titled “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
Section titled “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
Section titled “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
Section titled “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
Section titled “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
Section titled “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
Section titled “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
Section titled “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
Section titled “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
Section titled “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
Section titled “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
Section titled “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
Section titled “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
Section titled “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
Section titled “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
Section titled “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
Section titled “Baremetal Not Managed Node List Interface List Monitor”Deeply nested Monitor block collapsed for readability.
Baremetal Not Managed Node List Interface List Monitor Disabled
Section titled “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
Section titled “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
Section titled “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
Section titled “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
Section titled “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
Section titled “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
Section titled “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
Section titled “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
Section titled “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
Section titled “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
Section titled “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
Section titled “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
Section titled “Baremetal Not Managed Node List Interface List VLAN Interface”Deeply nested Interface block collapsed for readability.
Block All Services
Section titled “Block All Services”A block_all_services block supports the following:
Blocked Services
Section titled “Blocked Services”A blocked_services block supports the following:
• blocked_service - Optional Block
Disable Node Local Services. Blocking or denial configuration
See Blocked Service below.
Blocked Services Blocked Service
Section titled “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
Section titled “Blocked Services Blocked Service DNS”A dns block (within blocked_services.blocked_service) supports the following:
Blocked Services Blocked Service SSH
Section titled “Blocked Services Blocked Service SSH”A ssh block (within blocked_services.blocked_service) supports the following:
Blocked Services Blocked Service Web User Interface
Section titled “Blocked Services Blocked Service Web User Interface”A web_user_interface block (within blocked_services.blocked_service) supports the following:
Custom Proxy
Section titled “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 Block
SecretType is used in an object to indicate a sensitive/confidential field
See Password below.
• 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
Section titled “Custom Proxy Disable RE Tunnel”A disable_re_tunnel block (within custom_proxy) supports the following:
Custom Proxy Enable RE Tunnel
Section titled “Custom Proxy Enable RE Tunnel”An enable_re_tunnel block (within custom_proxy) supports the following:
Custom Proxy Password
Section titled “Custom Proxy Password”A password block (within custom_proxy) supports the following:
• blindfold_secret_info - Optional Block
BlindfoldSecretInfoType specifies information about the Secret managed by F5XC Secret Management
See Blindfold Secret Info below.
• clear_secret_info - Optional Block
ClearSecretInfoType specifies information about the Secret that is not encrypted
See Clear Secret Info below.
Custom Proxy Password Blindfold Secret Info
Section titled “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
• 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:///
Custom Proxy Password Clear Secret Info
Section titled “Custom Proxy Password Clear Secret Info”A clear_secret_info block (within custom_proxy.password) supports the following:
• 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
Custom Proxy Bypass
Section titled “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
Section titled “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
Section titled “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
Section titled “Disable Advanced Delivery”A disable_advanced_delivery block supports the following:
Disable HA
Section titled “Disable HA”A disable_ha block supports the following:
Disable Log Anonymization
Section titled “Disable Log Anonymization”A disable_log_anonymization block supports the following:
Disable Management Network
Section titled “Disable Management Network”A disable_management_network block supports the following:
Disable URL Categorization
Section titled “Disable URL Categorization”A disable_url_categorization block supports the following:
DNS NTP Config
Section titled “DNS NTP Config”A dns_ntp_config block supports the following:
• custom_dns - Optional Block
DNS Servers. DNS Servers
See Custom DNS below.
• custom_ntp - Optional Block
NTP Servers. NTP Servers
See Custom NTP below.
• 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
Section titled “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
Section titled “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
Section titled “DNS NTP Config F5 DNS Default”A f5_dns_default block (within dns_ntp_config) supports the following:
DNS NTP Config F5 NTP Default
Section titled “DNS NTP Config F5 NTP Default”A f5_ntp_default block (within dns_ntp_config) supports the following:
Enable Advanced Delivery
Section titled “Enable Advanced Delivery”An enable_advanced_delivery block supports the following:
Enable HA
Section titled “Enable HA”An enable_ha block supports the following:
Enable Log Anonymization
Section titled “Enable Log Anonymization”An enable_log_anonymization block supports the following:
Enable Management Network
Section titled “Enable Management Network”An enable_management_network block supports the following:
Enable URL Categorization
Section titled “Enable URL Categorization”An enable_url_categorization block supports the following:
Equinix
Section titled “Equinix”An equinix block supports the following:
• not_managed - Optional Block
Section will show nodes associated with this site
See Not Managed below.
Equinix Not Managed
Section titled “Equinix Not Managed”A not_managed block (within equinix) supports the following:
• node_list - Optional Block
Section will show nodes associated with this site
See Node List below.
Equinix Not Managed Node List
Section titled “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 Block
Manage interfaces belonging to this node
See Interface List below.
• 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
Section titled “Equinix Not Managed Node List Interface List”An interface_list block (within equinix.not_managed.node_list) supports the following:
• bond_interface - Optional Block
Configuration parameter for bond interface
See Bond Interface below.
• description_spec - Optional String
Interface Description. Description for this Interface
• dhcp_client - Optional Object
Enable this option
• dhcp_server - Optional Block
DHCPServerParametersType
See DHCP Server below.
• ethernet_interface - Optional Block
Configuration parameter for ethernet interface
See Ethernet Interface below.
• ipv6_auto_config - Optional Block
IPV6AutoConfigType
See IPv6 Auto Config below.
• 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 Block
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
See
Network Option below.
• 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 Block
Configure Static IP parameters for a node
See Static IP below.
• static_ipv6_address - Optional Block
Static IP Parameters. Configure Static IP parameters
See Static IPv6 Address below.
• vlan_interface - Optional Block
Configuration parameter for VLAN interface
See VLAN Interface below.
• is_management - Optional Bool
Configuration for is_management
• is_primary - Optional Bool
Configuration for is_primary
Equinix Not Managed Node List Interface List Bond Interface
Section titled “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
Section titled “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
Section titled “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
Section titled “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
Section titled “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
Section titled “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
Section titled “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
Section titled “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
Section titled “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
Section titled “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
Section titled “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
Section titled “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
Section titled “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
Section titled “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
Section titled “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
Section titled “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
Section titled “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
Section titled “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
Section titled “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
Section titled “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
Section titled “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
Section titled “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
Section titled “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
Section titled “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
Section titled “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
Section titled “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
Section titled “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
Section titled “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
Section titled “Equinix Not Managed Node List Interface List Monitor”Deeply nested Monitor block collapsed for readability.
Equinix Not Managed Node List Interface List Monitor Disabled
Section titled “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
Section titled “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
Section titled “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
Section titled “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
Section titled “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
Section titled “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
Section titled “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
Section titled “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
Section titled “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
Section titled “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
Section titled “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
Section titled “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
Section titled “Equinix Not Managed Node List Interface List VLAN Interface”Deeply nested Interface block collapsed for readability.
F5 Proxy
Section titled “F5 Proxy”A f5_proxy block supports the following:
A gcp block supports the following:
• not_managed - Optional Block
Section will show nodes associated with this site
See Not Managed below.
GCP Not Managed
Section titled “GCP Not Managed”A not_managed block (within gcp) supports the following:
• node_list - Optional Block
Section will show nodes associated with this site
See Node List below.
GCP Not Managed Node List
Section titled “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 Block
Manage interfaces belonging to this node
See Interface List below.
• 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
Section titled “GCP Not Managed Node List Interface List”An interface_list block (within gcp.not_managed.node_list) supports the following:
• bond_interface - Optional Block
Configuration parameter for bond interface
See Bond Interface below.
• description_spec - Optional String
Interface Description. Description for this Interface
• dhcp_client - Optional Object
Enable this option
• dhcp_server - Optional Block
DHCPServerParametersType
See DHCP Server below.
• ethernet_interface - Optional Block
Configuration parameter for ethernet interface
See Ethernet Interface below.
• ipv6_auto_config - Optional Block
IPV6AutoConfigType
See IPv6 Auto Config below.
• 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 Block
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
See
Network Option below.
• 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 Block
Configure Static IP parameters for a node
See Static IP below.
• static_ipv6_address - Optional Block
Static IP Parameters. Configure Static IP parameters
See Static IPv6 Address below.
• vlan_interface - Optional Block
Configuration parameter for VLAN interface
See VLAN Interface below.
• is_management - Optional Bool
Configuration for is_management
• is_primary - Optional Bool
Configuration for is_primary
GCP Not Managed Node List Interface List Bond Interface
Section titled “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
Section titled “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
Section titled “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
Section titled “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
Section titled “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
Section titled “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
Section titled “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
Section titled “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
Section titled “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
Section titled “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
Section titled “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
Section titled “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
Section titled “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
Section titled “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
Section titled “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
Section titled “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
Section titled “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
Section titled “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
Section titled “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
Section titled “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
Section titled “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
Section titled “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
Section titled “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
Section titled “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
Section titled “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
Section titled “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
Section titled “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
Section titled “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
Section titled “GCP Not Managed Node List Interface List Monitor”Deeply nested Monitor block collapsed for readability.
GCP Not Managed Node List Interface List Monitor Disabled
Section titled “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
Section titled “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
Section titled “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
Section titled “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
Section titled “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
Section titled “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
Section titled “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
Section titled “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
Section titled “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
Section titled “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
Section titled “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
Section titled “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
Section titled “GCP Not Managed Node List Interface List VLAN Interface”Deeply nested Interface block collapsed for readability.
A kvm block supports the following:
• not_managed - Optional Block
Section will show nodes associated with this site
See Not Managed below.
Kvm Not Managed
Section titled “Kvm Not Managed”A not_managed block (within kvm) supports the following:
• node_list - Optional Block
Section will show nodes associated with this site
See Node List below.
Kvm Not Managed Node List
Section titled “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 Block
Manage interfaces belonging to this node
See Interface List below.
• 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
Section titled “Kvm Not Managed Node List Interface List”An interface_list block (within kvm.not_managed.node_list) supports the following:
• bond_interface - Optional Block
Configuration parameter for bond interface
See Bond Interface below.
• description_spec - Optional String
Interface Description. Description for this Interface
• dhcp_client - Optional Object
Enable this option
• dhcp_server - Optional Block
DHCPServerParametersType
See DHCP Server below.
• ethernet_interface - Optional Block
Configuration parameter for ethernet interface
See Ethernet Interface below.
• ipv6_auto_config - Optional Block
IPV6AutoConfigType
See IPv6 Auto Config below.
• 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 Block
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
See
Network Option below.
• 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 Block
Configure Static IP parameters for a node
See Static IP below.
• static_ipv6_address - Optional Block
Static IP Parameters. Configure Static IP parameters
See Static IPv6 Address below.
• vlan_interface - Optional Block
Configuration parameter for VLAN interface
See VLAN Interface below.
• is_management - Optional Bool
Configuration for is_management
• is_primary - Optional Bool
Configuration for is_primary
Kvm Not Managed Node List Interface List Bond Interface
Section titled “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
Section titled “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
Section titled “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
Section titled “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
Section titled “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
Section titled “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
Section titled “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
Section titled “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
Section titled “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
Section titled “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
Section titled “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
Section titled “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
Section titled “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
Section titled “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
Section titled “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
Section titled “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
Section titled “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
Section titled “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
Section titled “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
Section titled “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
Section titled “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
Section titled “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
Section titled “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
Section titled “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
Section titled “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
Section titled “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
Section titled “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
Section titled “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
Section titled “Kvm Not Managed Node List Interface List Monitor”Deeply nested Monitor block collapsed for readability.
Kvm Not Managed Node List Interface List Monitor Disabled
Section titled “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
Section titled “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
Section titled “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
Section titled “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
Section titled “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
Section titled “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
Section titled “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
Section titled “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
Section titled “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
Section titled “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
Section titled “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
Section titled “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
Section titled “Kvm Not Managed Node List Interface List VLAN Interface”Deeply nested Interface block collapsed for readability.
Load Balancing
Section titled “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
Section titled “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 Block
Site Local Network Configuration. Site local network configuration
See SLI Config below.
• slo_config - Optional Block
Site Local Network Configuration. Site local network configuration
See Slo Config below.
Local Vrf Default Config
Section titled “Local Vrf Default Config”A default_config block (within local_vrf) supports the following:
Local Vrf Default SLI Config
Section titled “Local Vrf Default SLI Config”A default_sli_config block (within local_vrf) supports the following:
Local Vrf SLI Config
Section titled “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 Block
Configuration parameter for static routes
See Static Routes below.
• static_v6_routes - Optional Block
Configuration parameter for static v6 routes
See Static V6 Routes below.
• vip - Optional String
Optional common virtual V4 IP across all nodes to be used as automatic VIP
Local Vrf SLI Config No Static Routes
Section titled “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
Section titled “Local Vrf SLI Config No V6 Static Routes”Deeply nested Routes block collapsed for readability.
Local Vrf SLI Config Static Routes
Section titled “Local Vrf SLI Config Static Routes”A static_routes block (within local_vrf.sli_config) supports the following:
• static_routes - Optional Block
Configuration parameter for static routes
See Static Routes below.
Local Vrf SLI Config Static Routes Static Routes
Section titled “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
Section titled “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
Section titled “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
Section titled “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
Section titled “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
Section titled “Local Vrf SLI Config Static V6 Routes”A static_v6_routes block (within local_vrf.sli_config) supports the following:
• static_routes - Optional Block
Static IPv6 Routes. List of IPv6 static routes
See Static Routes below.
Local Vrf SLI Config Static V6 Routes Static Routes
Section titled “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
Section titled “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
Section titled “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
Section titled “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
Section titled “Local Vrf SLI Config Static V6 Routes Static Routes Node Interface List Interface”Deeply nested Interface block collapsed for readability.
Local Vrf Slo Config
Section titled “Local Vrf Slo Config”A slo_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 Block
Configuration parameter for static routes
See Static Routes below.
• static_v6_routes - Optional Block
Configuration parameter for static v6 routes
See Static V6 Routes below.
• vip - Optional String
Optional common virtual V4 IP across all nodes to be used as automatic VIP
Local Vrf Slo Config No Static Routes
Section titled “Local Vrf Slo Config No Static Routes”A no_static_routes block (within local_vrf.slo_config) supports the following:
Local Vrf Slo Config No V6 Static Routes
Section titled “Local Vrf Slo Config No V6 Static Routes”Deeply nested Routes block collapsed for readability.
Local Vrf Slo Config Static Routes
Section titled “Local Vrf Slo Config Static Routes”A static_routes block (within local_vrf.slo_config) supports the following:
• static_routes - Optional Block
Configuration parameter for static routes
See Static Routes below.
Local Vrf Slo Config Static Routes Static Routes
Section titled “Local Vrf Slo Config Static Routes Static Routes”Deeply nested Routes block collapsed for readability.
Local Vrf Slo Config Static Routes Static Routes Default Gateway
Section titled “Local Vrf Slo Config Static Routes Static Routes Default Gateway”Deeply nested Gateway block collapsed for readability.
Local Vrf Slo Config Static Routes Static Routes Node Interface
Section titled “Local Vrf Slo Config Static Routes Static Routes Node Interface”Deeply nested Interface block collapsed for readability.
Local Vrf Slo Config Static Routes Static Routes Node Interface List
Section titled “Local Vrf Slo Config Static Routes Static Routes Node Interface List”Deeply nested List block collapsed for readability.
Local Vrf Slo Config Static Routes Static Routes Node Interface List Interface
Section titled “Local Vrf Slo Config Static Routes Static Routes Node Interface List Interface”Deeply nested Interface block collapsed for readability.
Local Vrf Slo Config Static V6 Routes
Section titled “Local Vrf Slo Config Static V6 Routes”A static_v6_routes block (within local_vrf.slo_config) supports the following:
• static_routes - Optional Block
Static IPv6 Routes. List of IPv6 static routes
See Static Routes below.
Local Vrf Slo Config Static V6 Routes Static Routes
Section titled “Local Vrf Slo Config Static V6 Routes Static Routes”Deeply nested Routes block collapsed for readability.
Local Vrf Slo Config Static V6 Routes Static Routes Default Gateway
Section titled “Local Vrf Slo Config Static V6 Routes Static Routes Default Gateway”Deeply nested Gateway block collapsed for readability.
Local Vrf Slo Config Static V6 Routes Static Routes Node Interface
Section titled “Local Vrf Slo Config Static V6 Routes Static Routes Node Interface”Deeply nested Interface block collapsed for readability.
Local Vrf Slo Config Static V6 Routes Static Routes Node Interface List
Section titled “Local Vrf Slo Config Static V6 Routes Static Routes Node Interface List”Deeply nested List block collapsed for readability.
Local Vrf Slo Config Static V6 Routes Static Routes Node Interface List Interface
Section titled “Local Vrf Slo Config Static V6 Routes Static Routes Node Interface List Interface”Deeply nested Interface block collapsed for readability.
Log Receiver With Net
Section titled “Log Receiver With Net”A log_receiver_with_net block supports the following:
• log_receiver - Optional Block
Type establishes a direct reference from one object(the referrer) to another(the referred). Such a reference is in form of tenant/namespace/name
See Log Receiver below.
• use_management_network - Optional Object
Configuration parameter for use management network
• use_slo_sli - Optional Object
Configuration parameter for use slo SLI
Log Receiver With Net Log Receiver
Section titled “Log Receiver With Net Log Receiver”A log_receiver block (within log_receiver_with_net) 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
Log Receiver With Net Use Management Network
Section titled “Log Receiver With Net Use Management Network”An use_management_network block (within log_receiver_with_net) supports the following:
Log Receiver With Net Use Slo SLI
Section titled “Log Receiver With Net Use Slo SLI”An use_slo_sli block (within log_receiver_with_net) supports the following:
Logs Streaming Disabled
Section titled “Logs Streaming Disabled”A logs_streaming_disabled block supports the following:
No Forward Proxy
Section titled “No Forward Proxy”A no_forward_proxy block supports the following:
No Network Policy
Section titled “No Network Policy”A no_network_policy block supports the following:
No Proxy Bypass
Section titled “No Proxy Bypass”A no_proxy_bypass block supports the following:
No S2S Connectivity SLI
Section titled “No S2S Connectivity SLI”A no_s2s_connectivity_sli block supports the following:
No S2S Connectivity Slo
Section titled “No S2S Connectivity Slo”A no_s2s_connectivity_slo block supports the following:
Nutanix
Section titled “Nutanix”A nutanix block supports the following:
• not_managed - Optional Block
Section will show nodes associated with this site
See Not Managed below.
Nutanix Not Managed
Section titled “Nutanix Not Managed”A not_managed block (within nutanix) supports the following:
• node_list - Optional Block
Section will show nodes associated with this site
See Node List below.
Nutanix Not Managed Node List
Section titled “Nutanix Not Managed Node List”A node_list block (within nutanix.not_managed) supports the following:
• hostname - Optional String
Hostname. Hostname for this Node
• interface_list - Optional Block
Manage interfaces belonging to this node
See Interface List below.
• 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
Nutanix Not Managed Node List Interface List
Section titled “Nutanix Not Managed Node List Interface List”An interface_list block (within nutanix.not_managed.node_list) supports the following:
• bond_interface - Optional Block
Configuration parameter for bond interface
See Bond Interface below.
• description_spec - Optional String
Interface Description. Description for this Interface
• dhcp_client - Optional Object
Enable this option
• dhcp_server - Optional Block
DHCPServerParametersType
See DHCP Server below.
• ethernet_interface - Optional Block
Configuration parameter for ethernet interface
See Ethernet Interface below.
• ipv6_auto_config - Optional Block
IPV6AutoConfigType
See IPv6 Auto Config below.
• 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 Block
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
See
Network Option below.
• 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 Block
Configure Static IP parameters for a node
See Static IP below.
• static_ipv6_address - Optional Block
Static IP Parameters. Configure Static IP parameters
See Static IPv6 Address below.
• vlan_interface - Optional Block
Configuration parameter for VLAN interface
See VLAN Interface below.
• is_management - Optional Bool
Configuration for is_management
• is_primary - Optional Bool
Configuration for is_primary
Nutanix Not Managed Node List Interface List Bond Interface
Section titled “Nutanix Not Managed Node List Interface List Bond Interface”Deeply nested Interface block collapsed for readability.
Nutanix Not Managed Node List Interface List Bond Interface Active Backup
Section titled “Nutanix Not Managed Node List Interface List Bond Interface Active Backup”Deeply nested Backup block collapsed for readability.
Nutanix Not Managed Node List Interface List Bond Interface Lacp
Section titled “Nutanix Not Managed Node List Interface List Bond Interface Lacp”Deeply nested Lacp block collapsed for readability.
Nutanix Not Managed Node List Interface List DHCP Client
Section titled “Nutanix Not Managed Node List Interface List DHCP Client”Deeply nested Client block collapsed for readability.
Nutanix Not Managed Node List Interface List DHCP Server
Section titled “Nutanix Not Managed Node List Interface List DHCP Server”Deeply nested Server block collapsed for readability.
Nutanix Not Managed Node List Interface List DHCP Server Automatic From End
Section titled “Nutanix Not Managed Node List Interface List DHCP Server Automatic From End”Deeply nested End block collapsed for readability.
Nutanix Not Managed Node List Interface List DHCP Server Automatic From Start
Section titled “Nutanix Not Managed Node List Interface List DHCP Server Automatic From Start”Deeply nested Start block collapsed for readability.
Nutanix Not Managed Node List Interface List DHCP Server DHCP Networks
Section titled “Nutanix Not Managed Node List Interface List DHCP Server DHCP Networks”Deeply nested Networks block collapsed for readability.
Nutanix Not Managed Node List Interface List DHCP Server DHCP Networks First Address
Section titled “Nutanix Not Managed Node List Interface List DHCP Server DHCP Networks First Address”Deeply nested Address block collapsed for readability.
Nutanix Not Managed Node List Interface List DHCP Server DHCP Networks Last Address
Section titled “Nutanix Not Managed Node List Interface List DHCP Server DHCP Networks Last Address”Deeply nested Address block collapsed for readability.
Nutanix Not Managed Node List Interface List DHCP Server DHCP Networks Pools
Section titled “Nutanix Not Managed Node List Interface List DHCP Server DHCP Networks Pools”Deeply nested Pools block collapsed for readability.
Nutanix Not Managed Node List Interface List DHCP Server DHCP Networks Same As Dgw
Section titled “Nutanix Not Managed Node List Interface List DHCP Server DHCP Networks Same As Dgw”Deeply nested Dgw block collapsed for readability.
Nutanix Not Managed Node List Interface List DHCP Server Interface IP Map
Section titled “Nutanix Not Managed Node List Interface List DHCP Server Interface IP Map”Deeply nested Map block collapsed for readability.
Nutanix Not Managed Node List Interface List Ethernet Interface
Section titled “Nutanix Not Managed Node List Interface List Ethernet Interface”Deeply nested Interface block collapsed for readability.
Nutanix Not Managed Node List Interface List IPv6 Auto Config
Section titled “Nutanix Not Managed Node List Interface List IPv6 Auto Config”Deeply nested Config block collapsed for readability.
Nutanix Not Managed Node List Interface List IPv6 Auto Config Host
Section titled “Nutanix Not Managed Node List Interface List IPv6 Auto Config Host”Deeply nested Host block collapsed for readability.
Nutanix Not Managed Node List Interface List IPv6 Auto Config Router
Section titled “Nutanix Not Managed Node List Interface List IPv6 Auto Config Router”Deeply nested Router block collapsed for readability.
Nutanix Not Managed Node List Interface List IPv6 Auto Config Router DNS Config
Section titled “Nutanix Not Managed Node List Interface List IPv6 Auto Config Router DNS Config”Deeply nested Config block collapsed for readability.
Nutanix Not Managed Node List Interface List IPv6 Auto Config Router DNS Config Configured List
Section titled “Nutanix Not Managed Node List Interface List IPv6 Auto Config Router DNS Config Configured List”Deeply nested List block collapsed for readability.
Nutanix Not Managed Node List Interface List IPv6 Auto Config Router DNS Config Local DNS
Section titled “Nutanix Not Managed Node List Interface List IPv6 Auto Config Router DNS Config Local DNS”Deeply nested DNS block collapsed for readability.
Nutanix Not Managed Node List Interface List IPv6 Auto Config Router DNS Config Local DNS First Address
Section titled “Nutanix Not Managed Node List Interface List IPv6 Auto Config Router DNS Config Local DNS First Address”Deeply nested Address block collapsed for readability.
Nutanix Not Managed Node List Interface List IPv6 Auto Config Router DNS Config Local DNS Last Address
Section titled “Nutanix Not Managed Node List Interface List IPv6 Auto Config Router DNS Config Local DNS Last Address”Deeply nested Address block collapsed for readability.
Nutanix Not Managed Node List Interface List IPv6 Auto Config Router Stateful
Section titled “Nutanix Not Managed Node List Interface List IPv6 Auto Config Router Stateful”Deeply nested Stateful block collapsed for readability.
Nutanix Not Managed Node List Interface List IPv6 Auto Config Router Stateful Automatic From End
Section titled “Nutanix Not Managed Node List Interface List IPv6 Auto Config Router Stateful Automatic From End”Deeply nested End block collapsed for readability.
Nutanix Not Managed Node List Interface List IPv6 Auto Config Router Stateful Automatic From Start
Section titled “Nutanix Not Managed Node List Interface List IPv6 Auto Config Router Stateful Automatic From Start”Deeply nested Start block collapsed for readability.
Nutanix Not Managed Node List Interface List IPv6 Auto Config Router Stateful DHCP Networks
Section titled “Nutanix Not Managed Node List Interface List IPv6 Auto Config Router Stateful DHCP Networks”Deeply nested Networks block collapsed for readability.
Nutanix Not Managed Node List Interface List IPv6 Auto Config Router Stateful DHCP Networks Pools
Section titled “Nutanix Not Managed Node List Interface List IPv6 Auto Config Router Stateful DHCP Networks Pools”Deeply nested Pools block collapsed for readability.
Nutanix Not Managed Node List Interface List IPv6 Auto Config Router Stateful Interface IP Map
Section titled “Nutanix Not Managed Node List Interface List IPv6 Auto Config Router Stateful Interface IP Map”Deeply nested Map block collapsed for readability.
Nutanix Not Managed Node List Interface List Monitor
Section titled “Nutanix Not Managed Node List Interface List Monitor”Deeply nested Monitor block collapsed for readability.
Nutanix Not Managed Node List Interface List Monitor Disabled
Section titled “Nutanix Not Managed Node List Interface List Monitor Disabled”Deeply nested Disabled block collapsed for readability.
Nutanix Not Managed Node List Interface List Network Option
Section titled “Nutanix Not Managed Node List Interface List Network Option”Deeply nested Option block collapsed for readability.
Nutanix Not Managed Node List Interface List Network Option Site Local Inside Network
Section titled “Nutanix Not Managed Node List Interface List Network Option Site Local Inside Network”Deeply nested Network block collapsed for readability.
Nutanix Not Managed Node List Interface List Network Option Site Local Network
Section titled “Nutanix Not Managed Node List Interface List Network Option Site Local Network”Deeply nested Network block collapsed for readability.
Nutanix Not Managed Node List Interface List No IPv4 Address
Section titled “Nutanix Not Managed Node List Interface List No IPv4 Address”Deeply nested Address block collapsed for readability.
Nutanix Not Managed Node List Interface List No IPv6 Address
Section titled “Nutanix Not Managed Node List Interface List No IPv6 Address”Deeply nested Address block collapsed for readability.
Nutanix Not Managed Node List Interface List Site To Site Connectivity Interface Disabled
Section titled “Nutanix Not Managed Node List Interface List Site To Site Connectivity Interface Disabled”Deeply nested Disabled block collapsed for readability.
Nutanix Not Managed Node List Interface List Site To Site Connectivity Interface Enabled
Section titled “Nutanix Not Managed Node List Interface List Site To Site Connectivity Interface Enabled”Deeply nested Enabled block collapsed for readability.
Nutanix Not Managed Node List Interface List Static IP
Section titled “Nutanix Not Managed Node List Interface List Static IP”Deeply nested IP block collapsed for readability.
Nutanix Not Managed Node List Interface List Static IPv6 Address
Section titled “Nutanix Not Managed Node List Interface List Static IPv6 Address”Deeply nested Address block collapsed for readability.
Nutanix Not Managed Node List Interface List Static IPv6 Address Cluster Static IP
Section titled “Nutanix Not Managed Node List Interface List Static IPv6 Address Cluster Static IP”Deeply nested IP block collapsed for readability.
Nutanix Not Managed Node List Interface List Static IPv6 Address Node Static IP
Section titled “Nutanix Not Managed Node List Interface List Static IPv6 Address Node Static IP”Deeply nested IP block collapsed for readability.
Nutanix Not Managed Node List Interface List VLAN Interface
Section titled “Nutanix Not Managed Node List Interface List VLAN Interface”Deeply nested Interface block collapsed for readability.
An oci block supports the following:
• not_managed - Optional Block
Section will show nodes associated with this site
See Not Managed below.
Oci Not Managed
Section titled “Oci Not Managed”A not_managed block (within oci) supports the following:
• node_list - Optional Block
Section will show nodes associated with this site
See Node List below.
Oci Not Managed Node List
Section titled “Oci Not Managed Node List”A node_list block (within oci.not_managed) supports the following:
• hostname - Optional String
Hostname. Hostname for this Node
• interface_list - Optional Block
Manage interfaces belonging to this node
See Interface List below.
• 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
Oci Not Managed Node List Interface List
Section titled “Oci Not Managed Node List Interface List”An interface_list block (within oci.not_managed.node_list) supports the following:
• bond_interface - Optional Block
Configuration parameter for bond interface
See Bond Interface below.
• description_spec - Optional String
Interface Description. Description for this Interface
• dhcp_client - Optional Object
Enable this option
• dhcp_server - Optional Block
DHCPServerParametersType
See DHCP Server below.
• ethernet_interface - Optional Block
Configuration parameter for ethernet interface
See Ethernet Interface below.
• ipv6_auto_config - Optional Block
IPV6AutoConfigType
See IPv6 Auto Config below.
• 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 Block
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
See
Network Option below.
• 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 Block
Configure Static IP parameters for a node
See Static IP below.
• static_ipv6_address - Optional Block
Static IP Parameters. Configure Static IP parameters
See Static IPv6 Address below.
• vlan_interface - Optional Block
Configuration parameter for VLAN interface
See VLAN Interface below.
• is_management - Optional Bool
Configuration for is_management
• is_primary - Optional Bool
Configuration for is_primary
Oci Not Managed Node List Interface List Bond Interface
Section titled “Oci Not Managed Node List Interface List Bond Interface”Deeply nested Interface block collapsed for readability.
Oci Not Managed Node List Interface List Bond Interface Active Backup
Section titled “Oci Not Managed Node List Interface List Bond Interface Active Backup”Deeply nested Backup block collapsed for readability.
Oci Not Managed Node List Interface List Bond Interface Lacp
Section titled “Oci Not Managed Node List Interface List Bond Interface Lacp”Deeply nested Lacp block collapsed for readability.
Oci Not Managed Node List Interface List DHCP Client
Section titled “Oci Not Managed Node List Interface List DHCP Client”Deeply nested Client block collapsed for readability.
Oci Not Managed Node List Interface List DHCP Server
Section titled “Oci Not Managed Node List Interface List DHCP Server”Deeply nested Server block collapsed for readability.
Oci Not Managed Node List Interface List DHCP Server Automatic From End
Section titled “Oci Not Managed Node List Interface List DHCP Server Automatic From End”Deeply nested End block collapsed for readability.
Oci Not Managed Node List Interface List DHCP Server Automatic From Start
Section titled “Oci Not Managed Node List Interface List DHCP Server Automatic From Start”Deeply nested Start block collapsed for readability.
Oci Not Managed Node List Interface List DHCP Server DHCP Networks
Section titled “Oci Not Managed Node List Interface List DHCP Server DHCP Networks”Deeply nested Networks block collapsed for readability.
Oci Not Managed Node List Interface List DHCP Server DHCP Networks First Address
Section titled “Oci Not Managed Node List Interface List DHCP Server DHCP Networks First Address”Deeply nested Address block collapsed for readability.
Oci Not Managed Node List Interface List DHCP Server DHCP Networks Last Address
Section titled “Oci Not Managed Node List Interface List DHCP Server DHCP Networks Last Address”Deeply nested Address block collapsed for readability.
Oci Not Managed Node List Interface List DHCP Server DHCP Networks Pools
Section titled “Oci Not Managed Node List Interface List DHCP Server DHCP Networks Pools”Deeply nested Pools block collapsed for readability.
Oci Not Managed Node List Interface List DHCP Server DHCP Networks Same As Dgw
Section titled “Oci Not Managed Node List Interface List DHCP Server DHCP Networks Same As Dgw”Deeply nested Dgw block collapsed for readability.
Oci Not Managed Node List Interface List DHCP Server Interface IP Map
Section titled “Oci Not Managed Node List Interface List DHCP Server Interface IP Map”Deeply nested Map block collapsed for readability.
Oci Not Managed Node List Interface List Ethernet Interface
Section titled “Oci Not Managed Node List Interface List Ethernet Interface”Deeply nested Interface block collapsed for readability.
Oci Not Managed Node List Interface List IPv6 Auto Config
Section titled “Oci Not Managed Node List Interface List IPv6 Auto Config”Deeply nested Config block collapsed for readability.
Oci Not Managed Node List Interface List IPv6 Auto Config Host
Section titled “Oci Not Managed Node List Interface List IPv6 Auto Config Host”Deeply nested Host block collapsed for readability.
Oci Not Managed Node List Interface List IPv6 Auto Config Router
Section titled “Oci Not Managed Node List Interface List IPv6 Auto Config Router”Deeply nested Router block collapsed for readability.
Oci Not Managed Node List Interface List IPv6 Auto Config Router DNS Config
Section titled “Oci Not Managed Node List Interface List IPv6 Auto Config Router DNS Config”Deeply nested Config block collapsed for readability.
Oci Not Managed Node List Interface List IPv6 Auto Config Router DNS Config Configured List
Section titled “Oci Not Managed Node List Interface List IPv6 Auto Config Router DNS Config Configured List”Deeply nested List block collapsed for readability.
Oci Not Managed Node List Interface List IPv6 Auto Config Router DNS Config Local DNS
Section titled “Oci Not Managed Node List Interface List IPv6 Auto Config Router DNS Config Local DNS”Deeply nested DNS block collapsed for readability.
Oci Not Managed Node List Interface List IPv6 Auto Config Router DNS Config Local DNS First Address
Section titled “Oci Not Managed Node List Interface List IPv6 Auto Config Router DNS Config Local DNS First Address”Deeply nested Address block collapsed for readability.
Oci Not Managed Node List Interface List IPv6 Auto Config Router DNS Config Local DNS Last Address
Section titled “Oci Not Managed Node List Interface List IPv6 Auto Config Router DNS Config Local DNS Last Address”Deeply nested Address block collapsed for readability.
Oci Not Managed Node List Interface List IPv6 Auto Config Router Stateful
Section titled “Oci Not Managed Node List Interface List IPv6 Auto Config Router Stateful”Deeply nested Stateful block collapsed for readability.
Oci Not Managed Node List Interface List IPv6 Auto Config Router Stateful Automatic From End
Section titled “Oci Not Managed Node List Interface List IPv6 Auto Config Router Stateful Automatic From End”Deeply nested End block collapsed for readability.
Oci Not Managed Node List Interface List IPv6 Auto Config Router Stateful Automatic From Start
Section titled “Oci Not Managed Node List Interface List IPv6 Auto Config Router Stateful Automatic From Start”Deeply nested Start block collapsed for readability.
Oci Not Managed Node List Interface List IPv6 Auto Config Router Stateful DHCP Networks
Section titled “Oci Not Managed Node List Interface List IPv6 Auto Config Router Stateful DHCP Networks”Deeply nested Networks block collapsed for readability.
Oci Not Managed Node List Interface List IPv6 Auto Config Router Stateful DHCP Networks Pools
Section titled “Oci Not Managed Node List Interface List IPv6 Auto Config Router Stateful DHCP Networks Pools”Deeply nested Pools block collapsed for readability.
Oci Not Managed Node List Interface List IPv6 Auto Config Router Stateful Interface IP Map
Section titled “Oci Not Managed Node List Interface List IPv6 Auto Config Router Stateful Interface IP Map”Deeply nested Map block collapsed for readability.
Oci Not Managed Node List Interface List Monitor
Section titled “Oci Not Managed Node List Interface List Monitor”Deeply nested Monitor block collapsed for readability.
Oci Not Managed Node List Interface List Monitor Disabled
Section titled “Oci Not Managed Node List Interface List Monitor Disabled”Deeply nested Disabled block collapsed for readability.
Oci Not Managed Node List Interface List Network Option
Section titled “Oci Not Managed Node List Interface List Network Option”Deeply nested Option block collapsed for readability.
Oci Not Managed Node List Interface List Network Option Site Local Inside Network
Section titled “Oci Not Managed Node List Interface List Network Option Site Local Inside Network”Deeply nested Network block collapsed for readability.
Oci Not Managed Node List Interface List Network Option Site Local Network
Section titled “Oci Not Managed Node List Interface List Network Option Site Local Network”Deeply nested Network block collapsed for readability.
Oci Not Managed Node List Interface List No IPv4 Address
Section titled “Oci Not Managed Node List Interface List No IPv4 Address”Deeply nested Address block collapsed for readability.
Oci Not Managed Node List Interface List No IPv6 Address
Section titled “Oci Not Managed Node List Interface List No IPv6 Address”Deeply nested Address block collapsed for readability.
Oci Not Managed Node List Interface List Site To Site Connectivity Interface Disabled
Section titled “Oci Not Managed Node List Interface List Site To Site Connectivity Interface Disabled”Deeply nested Disabled block collapsed for readability.
Oci Not Managed Node List Interface List Site To Site Connectivity Interface Enabled
Section titled “Oci Not Managed Node List Interface List Site To Site Connectivity Interface Enabled”Deeply nested Enabled block collapsed for readability.
Oci Not Managed Node List Interface List Static IP
Section titled “Oci Not Managed Node List Interface List Static IP”Deeply nested IP block collapsed for readability.
Oci Not Managed Node List Interface List Static IPv6 Address
Section titled “Oci Not Managed Node List Interface List Static IPv6 Address”Deeply nested Address block collapsed for readability.
Oci Not Managed Node List Interface List Static IPv6 Address Cluster Static IP
Section titled “Oci Not Managed Node List Interface List Static IPv6 Address Cluster Static IP”Deeply nested IP block collapsed for readability.
Oci Not Managed Node List Interface List Static IPv6 Address Node Static IP
Section titled “Oci Not Managed Node List Interface List Static IPv6 Address Node Static IP”Deeply nested IP block collapsed for readability.
Oci Not Managed Node List Interface List VLAN Interface
Section titled “Oci Not Managed Node List Interface List VLAN Interface”Deeply nested Interface block collapsed for readability.
Offline Survivability Mode
Section titled “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
Section titled “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
Section titled “Offline Survivability Mode No Offline Survivability Mode”A no_offline_survivability_mode block (within offline_survivability_mode) supports the following:
Openshift Virtualization
Section titled “Openshift Virtualization”An openshift_virtualization block supports the following:
• not_managed - Optional Block
Section will show nodes associated with this site
See Not Managed below.
Openshift Virtualization Not Managed
Section titled “Openshift Virtualization Not Managed”A not_managed block (within openshift_virtualization) supports the following:
• node_list - Optional Block
Section will show nodes associated with this site
See Node List below.
Openshift Virtualization Not Managed Node List
Section titled “Openshift Virtualization Not Managed Node List”A node_list block (within openshift_virtualization.not_managed) supports the following:
• hostname - Optional String
Hostname. Hostname for this Node
• interface_list - Optional Block
Manage interfaces belonging to this node
See Interface List below.
• 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
Openshift Virtualization Not Managed Node List Interface List
Section titled “Openshift Virtualization Not Managed Node List Interface List”Deeply nested List block collapsed for readability.
Openshift Virtualization Not Managed Node List Interface List Bond Interface
Section titled “Openshift Virtualization Not Managed Node List Interface List Bond Interface”Deeply nested Interface block collapsed for readability.
Openshift Virtualization Not Managed Node List Interface List Bond Interface Active Backup
Section titled “Openshift Virtualization Not Managed Node List Interface List Bond Interface Active Backup”Deeply nested Backup block collapsed for readability.
Openshift Virtualization Not Managed Node List Interface List Bond Interface Lacp
Section titled “Openshift Virtualization Not Managed Node List Interface List Bond Interface Lacp”Deeply nested Lacp block collapsed for readability.
Openshift Virtualization Not Managed Node List Interface List DHCP Client
Section titled “Openshift Virtualization Not Managed Node List Interface List DHCP Client”Deeply nested Client block collapsed for readability.
Openshift Virtualization Not Managed Node List Interface List DHCP Server
Section titled “Openshift Virtualization Not Managed Node List Interface List DHCP Server”Deeply nested Server block collapsed for readability.
Openshift Virtualization Not Managed Node List Interface List DHCP Server Automatic From End
Section titled “Openshift Virtualization Not Managed Node List Interface List DHCP Server Automatic From End”Deeply nested End block collapsed for readability.
Openshift Virtualization Not Managed Node List Interface List DHCP Server Automatic From Start
Section titled “Openshift Virtualization Not Managed Node List Interface List DHCP Server Automatic From Start”Deeply nested Start block collapsed for readability.
Openshift Virtualization Not Managed Node List Interface List DHCP Server DHCP Networks
Section titled “Openshift Virtualization Not Managed Node List Interface List DHCP Server DHCP Networks”Deeply nested Networks block collapsed for readability.
Openshift Virtualization Not Managed Node List Interface List DHCP Server DHCP Networks First Address
Section titled “Openshift Virtualization Not Managed Node List Interface List DHCP Server DHCP Networks First Address”Deeply nested Address block collapsed for readability.
Openshift Virtualization Not Managed Node List Interface List DHCP Server DHCP Networks Last Address
Section titled “Openshift Virtualization Not Managed Node List Interface List DHCP Server DHCP Networks Last Address”Deeply nested Address block collapsed for readability.
Openshift Virtualization Not Managed Node List Interface List DHCP Server DHCP Networks Pools
Section titled “Openshift Virtualization Not Managed Node List Interface List DHCP Server DHCP Networks Pools”Deeply nested Pools block collapsed for readability.
Openshift Virtualization Not Managed Node List Interface List DHCP Server DHCP Networks Same As Dgw
Section titled “Openshift Virtualization Not Managed Node List Interface List DHCP Server DHCP Networks Same As Dgw”Deeply nested Dgw block collapsed for readability.
Openshift Virtualization Not Managed Node List Interface List DHCP Server Interface IP Map
Section titled “Openshift Virtualization Not Managed Node List Interface List DHCP Server Interface IP Map”Deeply nested Map block collapsed for readability.
Openshift Virtualization Not Managed Node List Interface List Ethernet Interface
Section titled “Openshift Virtualization Not Managed Node List Interface List Ethernet Interface”Deeply nested Interface block collapsed for readability.
Openshift Virtualization Not Managed Node List Interface List IPv6 Auto Config
Section titled “Openshift Virtualization Not Managed Node List Interface List IPv6 Auto Config”Deeply nested Config block collapsed for readability.
Openshift Virtualization Not Managed Node List Interface List IPv6 Auto Config Host
Section titled “Openshift Virtualization Not Managed Node List Interface List IPv6 Auto Config Host”Deeply nested Host block collapsed for readability.
Openshift Virtualization Not Managed Node List Interface List IPv6 Auto Config Router
Section titled “Openshift Virtualization Not Managed Node List Interface List IPv6 Auto Config Router”Deeply nested Router block collapsed for readability.
Openshift Virtualization Not Managed Node List Interface List IPv6 Auto Config Router DNS Config
Section titled “Openshift Virtualization Not Managed Node List Interface List IPv6 Auto Config Router DNS Config”Deeply nested Config block collapsed for readability.
Openshift Virtualization Not Managed Node List Interface List IPv6 Auto Config Router DNS Config Configured List
Section titled “Openshift Virtualization Not Managed Node List Interface List IPv6 Auto Config Router DNS Config Configured List”Deeply nested List block collapsed for readability.
Openshift Virtualization Not Managed Node List Interface List IPv6 Auto Config Router DNS Config Local DNS
Section titled “Openshift Virtualization Not Managed Node List Interface List IPv6 Auto Config Router DNS Config Local DNS”Deeply nested DNS block collapsed for readability.
Openshift Virtualization Not Managed Node List Interface List IPv6 Auto Config Router DNS Config Local DNS First Address
Section titled “Openshift Virtualization Not Managed Node List Interface List IPv6 Auto Config Router DNS Config Local DNS First Address”Deeply nested Address block collapsed for readability.
Openshift Virtualization Not Managed Node List Interface List IPv6 Auto Config Router DNS Config Local DNS Last Address
Section titled “Openshift Virtualization Not Managed Node List Interface List IPv6 Auto Config Router DNS Config Local DNS Last Address”Deeply nested Address block collapsed for readability.
Openshift Virtualization Not Managed Node List Interface List IPv6 Auto Config Router Stateful
Section titled “Openshift Virtualization Not Managed Node List Interface List IPv6 Auto Config Router Stateful”Deeply nested Stateful block collapsed for readability.
Openshift Virtualization Not Managed Node List Interface List IPv6 Auto Config Router Stateful Automatic From End
Section titled “Openshift Virtualization Not Managed Node List Interface List IPv6 Auto Config Router Stateful Automatic From End”Deeply nested End block collapsed for readability.
Openshift Virtualization Not Managed Node List Interface List IPv6 Auto Config Router Stateful Automatic From Start
Section titled “Openshift Virtualization Not Managed Node List Interface List IPv6 Auto Config Router Stateful Automatic From Start”Deeply nested Start block collapsed for readability.
Openshift Virtualization Not Managed Node List Interface List IPv6 Auto Config Router Stateful DHCP Networks
Section titled “Openshift Virtualization Not Managed Node List Interface List IPv6 Auto Config Router Stateful DHCP Networks”Deeply nested Networks block collapsed for readability.
Openshift Virtualization Not Managed Node List Interface List IPv6 Auto Config Router Stateful DHCP Networks Pools
Section titled “Openshift Virtualization Not Managed Node List Interface List IPv6 Auto Config Router Stateful DHCP Networks Pools”Deeply nested Pools block collapsed for readability.
Openshift Virtualization Not Managed Node List Interface List IPv6 Auto Config Router Stateful Interface IP Map
Section titled “Openshift Virtualization Not Managed Node List Interface List IPv6 Auto Config Router Stateful Interface IP Map”Deeply nested Map block collapsed for readability.
Openshift Virtualization Not Managed Node List Interface List Monitor
Section titled “Openshift Virtualization Not Managed Node List Interface List Monitor”Deeply nested Monitor block collapsed for readability.
Openshift Virtualization Not Managed Node List Interface List Monitor Disabled
Section titled “Openshift Virtualization Not Managed Node List Interface List Monitor Disabled”Deeply nested Disabled block collapsed for readability.
Openshift Virtualization Not Managed Node List Interface List Network Option
Section titled “Openshift Virtualization Not Managed Node List Interface List Network Option”Deeply nested Option block collapsed for readability.
Openshift Virtualization Not Managed Node List Interface List Network Option Site Local Inside Network
Section titled “Openshift Virtualization Not Managed Node List Interface List Network Option Site Local Inside Network”Deeply nested Network block collapsed for readability.
Openshift Virtualization Not Managed Node List Interface List Network Option Site Local Network
Section titled “Openshift Virtualization Not Managed Node List Interface List Network Option Site Local Network”Deeply nested Network block collapsed for readability.
Openshift Virtualization Not Managed Node List Interface List No IPv4 Address
Section titled “Openshift Virtualization Not Managed Node List Interface List No IPv4 Address”Deeply nested Address block collapsed for readability.
Openshift Virtualization Not Managed Node List Interface List No IPv6 Address
Section titled “Openshift Virtualization Not Managed Node List Interface List No IPv6 Address”Deeply nested Address block collapsed for readability.
Openshift Virtualization Not Managed Node List Interface List Site To Site Connectivity Interface Disabled
Section titled “Openshift Virtualization Not Managed Node List Interface List Site To Site Connectivity Interface Disabled”Deeply nested Disabled block collapsed for readability.
Openshift Virtualization Not Managed Node List Interface List Site To Site Connectivity Interface Enabled
Section titled “Openshift Virtualization Not Managed Node List Interface List Site To Site Connectivity Interface Enabled”Deeply nested Enabled block collapsed for readability.
Openshift Virtualization Not Managed Node List Interface List Static IP
Section titled “Openshift Virtualization Not Managed Node List Interface List Static IP”Deeply nested IP block collapsed for readability.
Openshift Virtualization Not Managed Node List Interface List Static IPv6 Address
Section titled “Openshift Virtualization Not Managed Node List Interface List Static IPv6 Address”Deeply nested Address block collapsed for readability.
Openshift Virtualization Not Managed Node List Interface List Static IPv6 Address Cluster Static IP
Section titled “Openshift Virtualization Not Managed Node List Interface List Static IPv6 Address Cluster Static IP”Deeply nested IP block collapsed for readability.
Openshift Virtualization Not Managed Node List Interface List Static IPv6 Address Node Static IP
Section titled “Openshift Virtualization Not Managed Node List Interface List Static IPv6 Address Node Static IP”Deeply nested IP block collapsed for readability.
Openshift Virtualization Not Managed Node List Interface List VLAN Interface
Section titled “Openshift Virtualization Not Managed Node List Interface List VLAN Interface”Deeply nested Interface block collapsed for readability.
Openstack
Section titled “Openstack”An openstack block supports the following:
• not_managed - Optional Block
Section will show nodes associated with this site
See Not Managed below.
Openstack Not Managed
Section titled “Openstack Not Managed”A not_managed block (within openstack) supports the following:
• node_list - Optional Block
Section will show nodes associated with this site
See Node List below.
Openstack Not Managed Node List
Section titled “Openstack Not Managed Node List”A node_list block (within openstack.not_managed) supports the following:
• hostname - Optional String
Hostname. Hostname for this Node
• interface_list - Optional Block
Manage interfaces belonging to this node
See Interface List below.
• 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
Openstack Not Managed Node List Interface List
Section titled “Openstack Not Managed Node List Interface List”An interface_list block (within openstack.not_managed.node_list) supports the following:
• bond_interface - Optional Block
Configuration parameter for bond interface
See Bond Interface below.
• description_spec - Optional String
Interface Description. Description for this Interface
• dhcp_client - Optional Object
Enable this option
• dhcp_server - Optional Block
DHCPServerParametersType
See DHCP Server below.
• ethernet_interface - Optional Block
Configuration parameter for ethernet interface
See Ethernet Interface below.
• ipv6_auto_config - Optional Block
IPV6AutoConfigType
See IPv6 Auto Config below.
• 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 Block
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
See
Network Option below.
• 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 Block
Configure Static IP parameters for a node
See Static IP below.
• static_ipv6_address - Optional Block
Static IP Parameters. Configure Static IP parameters
See Static IPv6 Address below.
• vlan_interface - Optional Block
Configuration parameter for VLAN interface
See VLAN Interface below.
• is_management - Optional Bool
Configuration for is_management
• is_primary - Optional Bool
Configuration for is_primary
Openstack Not Managed Node List Interface List Bond Interface
Section titled “Openstack Not Managed Node List Interface List Bond Interface”Deeply nested Interface block collapsed for readability.
Openstack Not Managed Node List Interface List Bond Interface Active Backup
Section titled “Openstack Not Managed Node List Interface List Bond Interface Active Backup”Deeply nested Backup block collapsed for readability.
Openstack Not Managed Node List Interface List Bond Interface Lacp
Section titled “Openstack Not Managed Node List Interface List Bond Interface Lacp”Deeply nested Lacp block collapsed for readability.
Openstack Not Managed Node List Interface List DHCP Client
Section titled “Openstack Not Managed Node List Interface List DHCP Client”Deeply nested Client block collapsed for readability.
Openstack Not Managed Node List Interface List DHCP Server
Section titled “Openstack Not Managed Node List Interface List DHCP Server”Deeply nested Server block collapsed for readability.
Openstack Not Managed Node List Interface List DHCP Server Automatic From End
Section titled “Openstack Not Managed Node List Interface List DHCP Server Automatic From End”Deeply nested End block collapsed for readability.
Openstack Not Managed Node List Interface List DHCP Server Automatic From Start
Section titled “Openstack Not Managed Node List Interface List DHCP Server Automatic From Start”Deeply nested Start block collapsed for readability.
Openstack Not Managed Node List Interface List DHCP Server DHCP Networks
Section titled “Openstack Not Managed Node List Interface List DHCP Server DHCP Networks”Deeply nested Networks block collapsed for readability.
Openstack Not Managed Node List Interface List DHCP Server DHCP Networks First Address
Section titled “Openstack Not Managed Node List Interface List DHCP Server DHCP Networks First Address”Deeply nested Address block collapsed for readability.
Openstack Not Managed Node List Interface List DHCP Server DHCP Networks Last Address
Section titled “Openstack Not Managed Node List Interface List DHCP Server DHCP Networks Last Address”Deeply nested Address block collapsed for readability.
Openstack Not Managed Node List Interface List DHCP Server DHCP Networks Pools
Section titled “Openstack Not Managed Node List Interface List DHCP Server DHCP Networks Pools”Deeply nested Pools block collapsed for readability.
Openstack Not Managed Node List Interface List DHCP Server DHCP Networks Same As Dgw
Section titled “Openstack Not Managed Node List Interface List DHCP Server DHCP Networks Same As Dgw”Deeply nested Dgw block collapsed for readability.
Openstack Not Managed Node List Interface List DHCP Server Interface IP Map
Section titled “Openstack Not Managed Node List Interface List DHCP Server Interface IP Map”Deeply nested Map block collapsed for readability.
Openstack Not Managed Node List Interface List Ethernet Interface
Section titled “Openstack Not Managed Node List Interface List Ethernet Interface”Deeply nested Interface block collapsed for readability.
Openstack Not Managed Node List Interface List IPv6 Auto Config
Section titled “Openstack Not Managed Node List Interface List IPv6 Auto Config”Deeply nested Config block collapsed for readability.
Openstack Not Managed Node List Interface List IPv6 Auto Config Host
Section titled “Openstack Not Managed Node List Interface List IPv6 Auto Config Host”Deeply nested Host block collapsed for readability.
Openstack Not Managed Node List Interface List IPv6 Auto Config Router
Section titled “Openstack Not Managed Node List Interface List IPv6 Auto Config Router”Deeply nested Router block collapsed for readability.
Openstack Not Managed Node List Interface List IPv6 Auto Config Router DNS Config
Section titled “Openstack Not Managed Node List Interface List IPv6 Auto Config Router DNS Config”Deeply nested Config block collapsed for readability.
Openstack Not Managed Node List Interface List IPv6 Auto Config Router DNS Config Configured List
Section titled “Openstack Not Managed Node List Interface List IPv6 Auto Config Router DNS Config Configured List”Deeply nested List block collapsed for readability.
Openstack Not Managed Node List Interface List IPv6 Auto Config Router DNS Config Local DNS
Section titled “Openstack Not Managed Node List Interface List IPv6 Auto Config Router DNS Config Local DNS”Deeply nested DNS block collapsed for readability.
Openstack Not Managed Node List Interface List IPv6 Auto Config Router DNS Config Local DNS First Address
Section titled “Openstack Not Managed Node List Interface List IPv6 Auto Config Router DNS Config Local DNS First Address”Deeply nested Address block collapsed for readability.
Openstack Not Managed Node List Interface List IPv6 Auto Config Router DNS Config Local DNS Last Address
Section titled “Openstack Not Managed Node List Interface List IPv6 Auto Config Router DNS Config Local DNS Last Address”Deeply nested Address block collapsed for readability.
Openstack Not Managed Node List Interface List IPv6 Auto Config Router Stateful
Section titled “Openstack Not Managed Node List Interface List IPv6 Auto Config Router Stateful”Deeply nested Stateful block collapsed for readability.
Openstack Not Managed Node List Interface List IPv6 Auto Config Router Stateful Automatic From End
Section titled “Openstack Not Managed Node List Interface List IPv6 Auto Config Router Stateful Automatic From End”Deeply nested End block collapsed for readability.
Openstack Not Managed Node List Interface List IPv6 Auto Config Router Stateful Automatic From Start
Section titled “Openstack Not Managed Node List Interface List IPv6 Auto Config Router Stateful Automatic From Start”Deeply nested Start block collapsed for readability.
Openstack Not Managed Node List Interface List IPv6 Auto Config Router Stateful DHCP Networks
Section titled “Openstack Not Managed Node List Interface List IPv6 Auto Config Router Stateful DHCP Networks”Deeply nested Networks block collapsed for readability.
Openstack Not Managed Node List Interface List IPv6 Auto Config Router Stateful DHCP Networks Pools
Section titled “Openstack Not Managed Node List Interface List IPv6 Auto Config Router Stateful DHCP Networks Pools”Deeply nested Pools block collapsed for readability.
Openstack Not Managed Node List Interface List IPv6 Auto Config Router Stateful Interface IP Map
Section titled “Openstack Not Managed Node List Interface List IPv6 Auto Config Router Stateful Interface IP Map”Deeply nested Map block collapsed for readability.
Openstack Not Managed Node List Interface List Monitor
Section titled “Openstack Not Managed Node List Interface List Monitor”Deeply nested Monitor block collapsed for readability.
Openstack Not Managed Node List Interface List Monitor Disabled
Section titled “Openstack Not Managed Node List Interface List Monitor Disabled”Deeply nested Disabled block collapsed for readability.
Openstack Not Managed Node List Interface List Network Option
Section titled “Openstack Not Managed Node List Interface List Network Option”Deeply nested Option block collapsed for readability.
Openstack Not Managed Node List Interface List Network Option Site Local Inside Network
Section titled “Openstack Not Managed Node List Interface List Network Option Site Local Inside Network”Deeply nested Network block collapsed for readability.
Openstack Not Managed Node List Interface List Network Option Site Local Network
Section titled “Openstack Not Managed Node List Interface List Network Option Site Local Network”Deeply nested Network block collapsed for readability.
Openstack Not Managed Node List Interface List No IPv4 Address
Section titled “Openstack Not Managed Node List Interface List No IPv4 Address”Deeply nested Address block collapsed for readability.
Openstack Not Managed Node List Interface List No IPv6 Address
Section titled “Openstack Not Managed Node List Interface List No IPv6 Address”Deeply nested Address block collapsed for readability.
Openstack Not Managed Node List Interface List Site To Site Connectivity Interface Disabled
Section titled “Openstack Not Managed Node List Interface List Site To Site Connectivity Interface Disabled”Deeply nested Disabled block collapsed for readability.
Openstack Not Managed Node List Interface List Site To Site Connectivity Interface Enabled
Section titled “Openstack Not Managed Node List Interface List Site To Site Connectivity Interface Enabled”Deeply nested Enabled block collapsed for readability.
Openstack Not Managed Node List Interface List Static IP
Section titled “Openstack Not Managed Node List Interface List Static IP”Deeply nested IP block collapsed for readability.
Openstack Not Managed Node List Interface List Static IPv6 Address
Section titled “Openstack Not Managed Node List Interface List Static IPv6 Address”Deeply nested Address block collapsed for readability.
Openstack Not Managed Node List Interface List Static IPv6 Address Cluster Static IP
Section titled “Openstack Not Managed Node List Interface List Static IPv6 Address Cluster Static IP”Deeply nested IP block collapsed for readability.
Openstack Not Managed Node List Interface List Static IPv6 Address Node Static IP
Section titled “Openstack Not Managed Node List Interface List Static IPv6 Address Node Static IP”Deeply nested IP block collapsed for readability.
Openstack Not Managed Node List Interface List VLAN Interface
Section titled “Openstack Not Managed Node List Interface List VLAN Interface”Deeply nested Interface block collapsed for readability.
Performance Enhancement Mode
Section titled “Performance Enhancement Mode”A performance_enhancement_mode block supports the following:
• perf_mode_l3_enhanced - Optional Block
Configuration parameter for perf mode l3 enhanced
See Perf Mode L3 Enhanced below.
• perf_mode_l7_enhanced - Optional Block
Configuration parameter for perf mode l7 enhanced
See Perf Mode L7 Enhanced below.
Performance Enhancement Mode Perf Mode L3 Enhanced
Section titled “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
Section titled “Performance Enhancement Mode Perf Mode L3 Enhanced Jumbo”Deeply nested Jumbo block collapsed for readability.
Performance Enhancement Mode Perf Mode L3 Enhanced No Jumbo
Section titled “Performance Enhancement Mode Perf Mode L3 Enhanced No Jumbo”Deeply nested Jumbo block collapsed for readability.
Performance Enhancement Mode Perf Mode L7 Enhanced
Section titled “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
Section titled “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
Section titled “Performance Enhancement Mode Perf Mode L7 Enhanced Jumbo Enabled”Deeply nested Enabled block collapsed for readability.
RE Select
Section titled “RE Select”A re_select block supports the following:
• geo_proximity - Optional Object
Configuration parameter for geo proximity
• specific_geography - Optional String
Geographic selection for the site’s Regional Edge connections
• specific_re - Optional Block
Select specific REs. This is useful when a site needs to deterministically connect to a set of REs. A site will always be connected to 2 REs
See Specific RE below.
RE Select Geo Proximity
Section titled “RE Select Geo Proximity”A geo_proximity block (within re_select) supports the following:
RE Select Specific RE
Section titled “RE Select Specific RE”A specific_re block (within re_select) supports the following:
• backup_re - Optional String
Select backup RE for this site, cannot be the same as Primary RE
• primary_re - Optional String
Primary RE Geography. Select primary RE for this site
Segment Vrf
Section titled “Segment Vrf”A segment_vrf block supports the following:
• segment_config - Optional Block
Segment Network Configuration. Segment Network Configuration
See Segment Config below.
• segment_network - Optional Block
Type establishes a ‘direct reference’ from one object(the referrer) to another(the referred). Such a reference is in form of tenant/namespace/name for public API and Uid for private API This type of reference is called direct because the relation is explicit and concrete (as
opposed to selector
See Segment Network below.
Segment Vrf Segment Config
Section titled “Segment Vrf Segment Config”A segment_config block (within segment_vrf) supports the following:
• 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 Block
Configuration parameter for static routes
See Static Routes below.
• static_v6_routes - Optional Block
Configuration parameter for static v6 routes
See Static V6 Routes below.
Segment Vrf Segment Config No Static Routes
Section titled “Segment Vrf Segment Config No Static Routes”A no_static_routes block (within segment_vrf.segment_config) supports the following:
Segment Vrf Segment Config No V6 Static Routes
Section titled “Segment Vrf Segment Config No V6 Static Routes”Deeply nested Routes block collapsed for readability.
Segment Vrf Segment Config Static Routes
Section titled “Segment Vrf Segment Config Static Routes”A static_routes block (within segment_vrf.segment_config) supports the following:
• static_routes - Optional Block
Configuration parameter for static routes
See Static Routes below.
Segment Vrf Segment Config Static Routes Static Routes
Section titled “Segment Vrf Segment Config Static Routes Static Routes”Deeply nested Routes block collapsed for readability.
Segment Vrf Segment Config Static Routes Static Routes Default Gateway
Section titled “Segment Vrf Segment Config Static Routes Static Routes Default Gateway”Deeply nested Gateway block collapsed for readability.
Segment Vrf Segment Config Static Routes Static Routes Node Interface
Section titled “Segment Vrf Segment Config Static Routes Static Routes Node Interface”Deeply nested Interface block collapsed for readability.
Segment Vrf Segment Config Static Routes Static Routes Node Interface List
Section titled “Segment Vrf Segment Config Static Routes Static Routes Node Interface List”Deeply nested List block collapsed for readability.
Segment Vrf Segment Config Static Routes Static Routes Node Interface List Interface
Section titled “Segment Vrf Segment Config Static Routes Static Routes Node Interface List Interface”Deeply nested Interface block collapsed for readability.
Segment Vrf Segment Config Static V6 Routes
Section titled “Segment Vrf Segment Config Static V6 Routes”A static_v6_routes block (within segment_vrf.segment_config) supports the following:
• static_routes - Optional Block
Static IPv6 Routes. List of IPv6 static routes
See Static Routes below.
Segment Vrf Segment Config Static V6 Routes Static Routes
Section titled “Segment Vrf Segment Config Static V6 Routes Static Routes”Deeply nested Routes block collapsed for readability.
Segment Vrf Segment Config Static V6 Routes Static Routes Default Gateway
Section titled “Segment Vrf Segment Config Static V6 Routes Static Routes Default Gateway”Deeply nested Gateway block collapsed for readability.
Segment Vrf Segment Config Static V6 Routes Static Routes Node Interface
Section titled “Segment Vrf Segment Config Static V6 Routes Static Routes Node Interface”Deeply nested Interface block collapsed for readability.
Segment Vrf Segment Config Static V6 Routes Static Routes Node Interface List
Section titled “Segment Vrf Segment Config Static V6 Routes Static Routes Node Interface List”Deeply nested List block collapsed for readability.
Segment Vrf Segment Config Static V6 Routes Static Routes Node Interface List Interface
Section titled “Segment Vrf Segment Config Static V6 Routes Static Routes Node Interface List Interface”Deeply nested Interface block collapsed for readability.
Segment Vrf Segment Network
Section titled “Segment Vrf Segment Network”A segment_network block (within segment_vrf) supports the following:
• name - Optional String
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object’s(e.g. Route’s) name
• namespace - Optional String
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object’s(e.g. Route’s) namespace
• kind - Optional String
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then kind will hold the referred object’s kind (e.g. ‘route’)
• tenant - Optional String
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then tenant will hold the referred object’s(e.g. Route’s) tenant
• uid - Optional String
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then uid will hold the referred object’s(e.g. Route’s) uid
Site Mesh Group On Slo
Section titled “Site Mesh Group On Slo”A site_mesh_group_on_slo block supports the following:
• no_site_mesh_group - Optional Object
Enable this option
• site_mesh_group - Optional Block
Type establishes a direct reference from one object(the referrer) to another(the referred). Such a reference is in form of tenant/namespace/name
See Site Mesh Group below.
• sm_connection_public_ip - Optional Object
Enable this option
• sm_connection_pvt_ip - Optional Object
Enable this option
Site Mesh Group On Slo No Site Mesh Group
Section titled “Site Mesh Group On Slo No Site Mesh Group”Deeply nested Group block collapsed for readability.
Site Mesh Group On Slo Site Mesh Group
Section titled “Site Mesh Group On Slo Site Mesh Group”Deeply nested Group block collapsed for readability.
Site Mesh Group On Slo Sm Connection Public IP
Section titled “Site Mesh Group On Slo Sm Connection Public IP”Deeply nested IP block collapsed for readability.
Site Mesh Group On Slo Sm Connection Pvt IP
Section titled “Site Mesh Group On Slo Sm Connection Pvt IP”Deeply nested IP block collapsed for readability.
Software Settings
Section titled “Software Settings”A software_settings block supports the following:
• os - Optional Block
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
See OS below.
• sw - Optional Block
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
See Sw below.
Software Settings OS
Section titled “Software Settings OS”An os block (within software_settings) 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
Software Settings OS Default OS Version
Section titled “Software Settings OS Default OS Version”A default_os_version block (within software_settings.os) supports the following:
Software Settings Sw
Section titled “Software Settings Sw”A sw block (within software_settings) 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
Software Settings Sw Default Sw Version
Section titled “Software Settings Sw Default Sw Version”A default_sw_version block (within software_settings.sw) supports the following:
Timeouts
Section titled “Timeouts”A timeouts block supports the following:
• create - Optional String (Defaults to 30 minutes)
Used when creating the resource
• delete - Optional String (Defaults to 30 minutes)
Used when deleting the resource
• read - Optional String (Defaults to 5 minutes)
Used when retrieving the resource
• update - Optional String (Defaults to 30 minutes)
Used when updating the resource
Upgrade Settings
Section titled “Upgrade Settings”An upgrade_settings block supports the following:
• kubernetes_upgrade_drain - Optional Block
Specify how worker nodes within a site will be upgraded
See Kubernetes Upgrade Drain below.
Upgrade Settings Kubernetes Upgrade Drain
Section titled “Upgrade Settings Kubernetes Upgrade Drain”A kubernetes_upgrade_drain block (within upgrade_settings) supports the following:
• disable_upgrade_drain - Optional Object
Configuration parameter for disable upgrade drain
• enable_upgrade_drain - Optional Block
Specify batch upgrade settings for worker nodes within a site
See Enable Upgrade Drain below.
Upgrade Settings Kubernetes Upgrade Drain Disable Upgrade Drain
Section titled “Upgrade Settings Kubernetes Upgrade Drain Disable Upgrade Drain”Deeply nested Drain block collapsed for readability.
Upgrade Settings Kubernetes Upgrade Drain Enable Upgrade Drain
Section titled “Upgrade Settings Kubernetes Upgrade Drain Enable Upgrade Drain”Deeply nested Drain block collapsed for readability.
Upgrade Settings Kubernetes Upgrade Drain Enable Upgrade Drain Disable Vega Upgrade Mode
Section titled “Upgrade Settings Kubernetes Upgrade Drain Enable Upgrade Drain Disable Vega Upgrade Mode”Deeply nested Mode block collapsed for readability.
Upgrade Settings Kubernetes Upgrade Drain Enable Upgrade Drain Enable Vega Upgrade Mode
Section titled “Upgrade Settings Kubernetes Upgrade Drain Enable Upgrade Drain Enable Vega Upgrade Mode”Deeply nested Mode block collapsed for readability.
Vmware
Section titled “Vmware”A vmware block supports the following:
• not_managed - Optional Block
Section will show nodes associated with this site
See Not Managed below.
Vmware Not Managed
Section titled “Vmware Not Managed”A not_managed block (within vmware) supports the following:
• node_list - Optional Block
Section will show nodes associated with this site
See Node List below.
Vmware Not Managed Node List
Section titled “Vmware Not Managed Node List”A node_list block (within vmware.not_managed) supports the following:
• hostname - Optional String
Hostname. Hostname for this Node
• interface_list - Optional Block
Manage interfaces belonging to this node
See Interface List below.
• 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
Vmware Not Managed Node List Interface List
Section titled “Vmware Not Managed Node List Interface List”An interface_list block (within vmware.not_managed.node_list) supports the following:
• bond_interface - Optional Block
Configuration parameter for bond interface
See Bond Interface below.
• description_spec - Optional String
Interface Description. Description for this Interface
• dhcp_client - Optional Object
Enable this option
• dhcp_server - Optional Block
DHCPServerParametersType
See DHCP Server below.
• ethernet_interface - Optional Block
Configuration parameter for ethernet interface
See Ethernet Interface below.
• ipv6_auto_config - Optional Block
IPV6AutoConfigType
See IPv6 Auto Config below.
• 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 Block
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
See
Network Option below.
• 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 Block
Configure Static IP parameters for a node
See Static IP below.
• static_ipv6_address - Optional Block
Static IP Parameters. Configure Static IP parameters
See Static IPv6 Address below.
• vlan_interface - Optional Block
Configuration parameter for VLAN interface
See VLAN Interface below.
• is_management - Optional Bool
Configuration for is_management
• is_primary - Optional Bool
Configuration for is_primary
Vmware Not Managed Node List Interface List Bond Interface
Section titled “Vmware Not Managed Node List Interface List Bond Interface”Deeply nested Interface block collapsed for readability.
Vmware Not Managed Node List Interface List Bond Interface Active Backup
Section titled “Vmware Not Managed Node List Interface List Bond Interface Active Backup”Deeply nested Backup block collapsed for readability.
Vmware Not Managed Node List Interface List Bond Interface Lacp
Section titled “Vmware Not Managed Node List Interface List Bond Interface Lacp”Deeply nested Lacp block collapsed for readability.
Vmware Not Managed Node List Interface List DHCP Client
Section titled “Vmware Not Managed Node List Interface List DHCP Client”Deeply nested Client block collapsed for readability.
Vmware Not Managed Node List Interface List DHCP Server
Section titled “Vmware Not Managed Node List Interface List DHCP Server”Deeply nested Server block collapsed for readability.
Vmware Not Managed Node List Interface List DHCP Server Automatic From End
Section titled “Vmware Not Managed Node List Interface List DHCP Server Automatic From End”Deeply nested End block collapsed for readability.
Vmware Not Managed Node List Interface List DHCP Server Automatic From Start
Section titled “Vmware Not Managed Node List Interface List DHCP Server Automatic From Start”Deeply nested Start block collapsed for readability.
Vmware Not Managed Node List Interface List DHCP Server DHCP Networks
Section titled “Vmware Not Managed Node List Interface List DHCP Server DHCP Networks”Deeply nested Networks block collapsed for readability.
Vmware Not Managed Node List Interface List DHCP Server DHCP Networks First Address
Section titled “Vmware Not Managed Node List Interface List DHCP Server DHCP Networks First Address”Deeply nested Address block collapsed for readability.
Vmware Not Managed Node List Interface List DHCP Server DHCP Networks Last Address
Section titled “Vmware Not Managed Node List Interface List DHCP Server DHCP Networks Last Address”Deeply nested Address block collapsed for readability.
Vmware Not Managed Node List Interface List DHCP Server DHCP Networks Pools
Section titled “Vmware Not Managed Node List Interface List DHCP Server DHCP Networks Pools”Deeply nested Pools block collapsed for readability.
Vmware Not Managed Node List Interface List DHCP Server DHCP Networks Same As Dgw
Section titled “Vmware Not Managed Node List Interface List DHCP Server DHCP Networks Same As Dgw”Deeply nested Dgw block collapsed for readability.
Vmware Not Managed Node List Interface List DHCP Server Interface IP Map
Section titled “Vmware Not Managed Node List Interface List DHCP Server Interface IP Map”Deeply nested Map block collapsed for readability.
Vmware Not Managed Node List Interface List Ethernet Interface
Section titled “Vmware Not Managed Node List Interface List Ethernet Interface”Deeply nested Interface block collapsed for readability.
Vmware Not Managed Node List Interface List IPv6 Auto Config
Section titled “Vmware Not Managed Node List Interface List IPv6 Auto Config”Deeply nested Config block collapsed for readability.
Vmware Not Managed Node List Interface List IPv6 Auto Config Host
Section titled “Vmware Not Managed Node List Interface List IPv6 Auto Config Host”Deeply nested Host block collapsed for readability.
Vmware Not Managed Node List Interface List IPv6 Auto Config Router
Section titled “Vmware Not Managed Node List Interface List IPv6 Auto Config Router”Deeply nested Router block collapsed for readability.
Vmware Not Managed Node List Interface List IPv6 Auto Config Router DNS Config
Section titled “Vmware Not Managed Node List Interface List IPv6 Auto Config Router DNS Config”Deeply nested Config block collapsed for readability.
Vmware Not Managed Node List Interface List IPv6 Auto Config Router DNS Config Configured List
Section titled “Vmware Not Managed Node List Interface List IPv6 Auto Config Router DNS Config Configured List”Deeply nested List block collapsed for readability.
Vmware Not Managed Node List Interface List IPv6 Auto Config Router DNS Config Local DNS
Section titled “Vmware Not Managed Node List Interface List IPv6 Auto Config Router DNS Config Local DNS”Deeply nested DNS block collapsed for readability.
Vmware Not Managed Node List Interface List IPv6 Auto Config Router DNS Config Local DNS First Address
Section titled “Vmware Not Managed Node List Interface List IPv6 Auto Config Router DNS Config Local DNS First Address”Deeply nested Address block collapsed for readability.
Vmware Not Managed Node List Interface List IPv6 Auto Config Router DNS Config Local DNS Last Address
Section titled “Vmware Not Managed Node List Interface List IPv6 Auto Config Router DNS Config Local DNS Last Address”Deeply nested Address block collapsed for readability.
Vmware Not Managed Node List Interface List IPv6 Auto Config Router Stateful
Section titled “Vmware Not Managed Node List Interface List IPv6 Auto Config Router Stateful”Deeply nested Stateful block collapsed for readability.
Vmware Not Managed Node List Interface List IPv6 Auto Config Router Stateful Automatic From End
Section titled “Vmware Not Managed Node List Interface List IPv6 Auto Config Router Stateful Automatic From End”Deeply nested End block collapsed for readability.
Vmware Not Managed Node List Interface List IPv6 Auto Config Router Stateful Automatic From Start
Section titled “Vmware Not Managed Node List Interface List IPv6 Auto Config Router Stateful Automatic From Start”Deeply nested Start block collapsed for readability.
Vmware Not Managed Node List Interface List IPv6 Auto Config Router Stateful DHCP Networks
Section titled “Vmware Not Managed Node List Interface List IPv6 Auto Config Router Stateful DHCP Networks”Deeply nested Networks block collapsed for readability.
Vmware Not Managed Node List Interface List IPv6 Auto Config Router Stateful DHCP Networks Pools
Section titled “Vmware Not Managed Node List Interface List IPv6 Auto Config Router Stateful DHCP Networks Pools”Deeply nested Pools block collapsed for readability.
Vmware Not Managed Node List Interface List IPv6 Auto Config Router Stateful Interface IP Map
Section titled “Vmware Not Managed Node List Interface List IPv6 Auto Config Router Stateful Interface IP Map”Deeply nested Map block collapsed for readability.
Vmware Not Managed Node List Interface List Monitor
Section titled “Vmware Not Managed Node List Interface List Monitor”Deeply nested Monitor block collapsed for readability.
Vmware Not Managed Node List Interface List Monitor Disabled
Section titled “Vmware Not Managed Node List Interface List Monitor Disabled”Deeply nested Disabled block collapsed for readability.
Vmware Not Managed Node List Interface List Network Option
Section titled “Vmware Not Managed Node List Interface List Network Option”Deeply nested Option block collapsed for readability.
Vmware Not Managed Node List Interface List Network Option Site Local Inside Network
Section titled “Vmware Not Managed Node List Interface List Network Option Site Local Inside Network”Deeply nested Network block collapsed for readability.
Vmware Not Managed Node List Interface List Network Option Site Local Network
Section titled “Vmware Not Managed Node List Interface List Network Option Site Local Network”Deeply nested Network block collapsed for readability.
Vmware Not Managed Node List Interface List No IPv4 Address
Section titled “Vmware Not Managed Node List Interface List No IPv4 Address”Deeply nested Address block collapsed for readability.
Vmware Not Managed Node List Interface List No IPv6 Address
Section titled “Vmware Not Managed Node List Interface List No IPv6 Address”Deeply nested Address block collapsed for readability.
Vmware Not Managed Node List Interface List Site To Site Connectivity Interface Disabled
Section titled “Vmware Not Managed Node List Interface List Site To Site Connectivity Interface Disabled”Deeply nested Disabled block collapsed for readability.
Vmware Not Managed Node List Interface List Site To Site Connectivity Interface Enabled
Section titled “Vmware Not Managed Node List Interface List Site To Site Connectivity Interface Enabled”Deeply nested Enabled block collapsed for readability.
Vmware Not Managed Node List Interface List Static IP
Section titled “Vmware Not Managed Node List Interface List Static IP”Deeply nested IP block collapsed for readability.
Vmware Not Managed Node List Interface List Static IPv6 Address
Section titled “Vmware Not Managed Node List Interface List Static IPv6 Address”Deeply nested Address block collapsed for readability.
Vmware Not Managed Node List Interface List Static IPv6 Address Cluster Static IP
Section titled “Vmware Not Managed Node List Interface List Static IPv6 Address Cluster Static IP”Deeply nested IP block collapsed for readability.
Vmware Not Managed Node List Interface List Static IPv6 Address Node Static IP
Section titled “Vmware Not Managed Node List Interface List Static IPv6 Address Node Static IP”Deeply nested IP block collapsed for readability.
Vmware Not Managed Node List Interface List VLAN Interface
Section titled “Vmware Not Managed Node List Interface List VLAN Interface”Deeply nested Interface block collapsed for readability.
Common Types
Section titled “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}
Section titled “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}
Section titled “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}
Section titled “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}
Section titled “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}
Section titled “IP Threat Categories {#common-ip-threat-categories}”IP address threat categories for security filtering.
| Value | Description |
|---|---|
SPAM_SOURCES | Known spam sources |
WINDOWS_EXPLOITS | Windows exploit sources |
WEB_ATTACKS | Web attack sources |
BOTNETS | Known botnet IPs |
SCANNERS | Network scanner IPs |
REPUTATION | Poor reputation IPs |
PHISHING | Phishing-related IPs |
PROXY | Anonymous proxy IPs |
MOBILE_THREATS | Mobile threat sources |
TOR_PROXY | Tor exit nodes |
DENIAL_OF_SERVICE | DoS attack sources |
NETWORK | Known bad network ranges |
Import
Section titled “Import”Import is supported using the following syntax:
# Import using namespace/name formatterraform import xcsh_securemesh_site_v2.example system/example