xcsh_voltstack_site (Data Source)

Retrieves information about a Voltstack Site resource in F5 Distributed Cloud for deploying App Stack edge computing sites. This is a read-only data source.

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

Example Usage

# VoltstackSite Data Source Example

terraform {
  required_version = ">= 1.0"

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

# Look up an existing VoltstackSite by name
data "xcsh_voltstack_site" "example" {
  name      = "example-voltstack-site"
  namespace = "staging"
}

output "voltstack_site_id" {
  value = data.xcsh_voltstack_site.example.id
}

Argument Reference

-> Syntax Rule: This provider uses OneOf groups for mutually exclusive options. Fields documented as “Optional Block” use block syntax field_name { ... }. Empty OneOf object attributes use field_name = {}; conditional selection uses condition ? {} : null. Boolean attributes (such as add_hsts and http_redirect) use = true or = false.

🔶 High Risk Operations — Some operations on this resource have high danger level. Destructive operations may require confirmation.

Metadata Argument Reference

• name - Required String
Name of the VoltstackSite

• namespace - Required String
Namespace where the VoltstackSite exists

Attributes Reference

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

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

• allow_all_usb - Optional Object
Configuration parameter for allow all usb

• annotations - Optional Map
Annotations applied to this resource

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

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

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

• custom_dns - Optional String
Custom DNS is the configured for specify CE site

• custom_network_config - Optional String
VssNetworkConfiguration

• custom_storage_config - Optional String
VssStorageConfiguration

• default_blocked_services - Optional Object
Enable this option

• default_network_config - Optional Object
Enable this option

• default_sriov_interface - Optional Object
Configuration parameter for default sriov interface

• default_storage_config - Optional Object
Enable this option

• deny_all_usb - Optional Object
Configuration parameter for deny all usb

• description - Optional String
Description of the VoltstackSite

• disable_gpu - Optional Object
Configuration parameter for disable GPU

• disable_vm - Optional Object
Enable this option

• enable_gpu - Optional Object
Enable this option

• enable_vgpu - Optional String
Licensing configuration for NVIDIA vGPU

• enable_vm - Optional Object
VM Configuration. VMs support configuration

• id - Optional String
Unique identifier for the resource

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

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

• labels - Optional Map
Labels applied to this resource

• local_control_plane - Optional String
Enable local control plane for L3VPN, SRV6, EVPN etc

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

• logs_streaming_disabled - Optional Object
Enable this option

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

• no_bond_devices - Optional Object
Configuration parameter for no bond devices

• no_k8s_cluster - Optional Object
Enable this option

• no_local_control_plane - Optional Object
Configuration parameter for no local control plane

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

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

• sriov_interfaces - Optional String
List of all custom SR-IOV interfaces configuration

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

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

• volterra_certified_hw - Optional String
Name for generic server certified hardware to form this App Stack site

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

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

• dns - Optional Object
Enable this option

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

• ssh - Optional Object
Enable this option

• web_user_interface - Optional Object
Enable this option

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

• active_backup - Optional Object
Configuration parameter for active backup

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

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

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

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

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

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

Coordinates

A coordinates block supports the following:

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

• longitude - Optional Number
Longitude. Longitude of site location

Custom DNS

A custom_dns block supports the following:

• inside_nameserver - Optional String
Optional DNS server IP to be used for name resolution in inside network

• outside_nameserver - Optional String
Optional DNS server IP to be used for name resolution in outside network

Custom Network Config

A custom_network_config block supports the following:

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

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

• active_network_policies - Optional String
Configuration parameter for active network policies

• bgp_peer_address - Optional String
Optional BGP peer address that can be used as parameter for BGP configuration when BGP is configured to fetch BGP peer address from site Object. This can be used to change peer address per site in fleet

• bgp_router_id - Optional String
Optional BGP router ID that can be used as parameter for BGP configuration when BGP is configured to fetch BGP router ID from site object

• default_config - Optional Object
Enable this option

• default_interface_config - Optional Object
Enable this option

• default_sli_config - Optional Object
Enable this option

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

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

• interface_list - Optional String
Configure network interfaces for this App Stack site

• no_forward_proxy - Optional Object
Configuration parameter for no forward proxy

• no_global_network - Optional Object
Configuration parameter for no global network

• no_network_policy - Optional Object
Policy configuration for this feature

• outside_nameserver - Optional String
Optional DNS server V4 IP to be used for name resolution in local network

• outside_vip - Optional String
Optional common virtual V4 IP across all nodes to be used as automatic VIP for site local network

• site_to_site_tunnel_ip - Optional String
Site Mesh Group Connection Via Virtual IP. This option will use the Virtual IP provided for creating IPsec between two sites which are part of the site mesh group

• sli_config - Optional String
Site local inside network configuration

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

• sm_connection_public_ip - Optional Object
Enable this option

• sm_connection_pvt_ip - Optional Object
Enable this option

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

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

Custom Network Config Active Enhanced Firewall Policies

An active_enhanced_firewall_policies block (within custom_network_config) supports the following:

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

Custom Network Config Active Enhanced Firewall Policies Enhanced Firewall Policies

Deeply nested Policies block collapsed for readability.

Custom Network Config Active Forward Proxy Policies

An active_forward_proxy_policies block (within custom_network_config) supports the following:

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

Custom Network Config Active Forward Proxy Policies Forward Proxy Policies

Deeply nested Policies block collapsed for readability.

Custom Network Config Active Network Policies

An active_network_policies block (within custom_network_config) supports the following:

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

Custom Network Config Active Network Policies Network Policies

Deeply nested Policies block collapsed for readability.

Custom Network Config Default Config

A default_config block (within custom_network_config) supports the following:

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

Custom Network Config Global Network List Global Network Connections

Deeply nested Connections block collapsed for readability.

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

Deeply nested DR block collapsed for readability.

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

Deeply nested Vn block collapsed for readability.

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

Deeply nested DR block collapsed for readability.

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

Deeply nested Vn block collapsed for readability.

Custom Network Config Interface List

An interface_list block (within custom_network_config) supports the following:

• interfaces - Optional List
Configure network interfaces for this App Stack site

Custom Network Config Interface List Interfaces

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

• dc_cluster_group_connectivity_interface_disabled - Optional Object
Enable this option

• dc_cluster_group_connectivity_interface_enabled - Optional Object
Enable this option

• dedicated_interface - Optional String
Configuration parameter for dedicated interface

• dedicated_management_interface - Optional String
Configuration parameter for dedicated management interface

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

• ethernet_interface - Optional String
Configuration parameter for ethernet interface

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

• tunnel_interface - Optional String
Configuration parameter for tunnel interface

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

Deeply nested Disabled block collapsed for readability.

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

Deeply nested Enabled block collapsed for readability.

Custom Network Config Interface List Interfaces Dedicated Interface

Deeply nested Interface block collapsed for readability.

Custom Network Config Interface List Interfaces Dedicated Interface Cluster

Deeply nested Cluster block collapsed for readability.

Custom Network Config Interface List Interfaces Dedicated Interface Is Primary

Deeply nested Primary block collapsed for readability.

Custom Network Config Interface List Interfaces Dedicated Interface Monitor

Deeply nested Monitor block collapsed for readability.

Custom Network Config Interface List Interfaces Dedicated Interface Monitor Disabled

Deeply nested Disabled block collapsed for readability.

Custom Network Config Interface List Interfaces Dedicated Interface Not Primary

Deeply nested Primary block collapsed for readability.

Custom Network Config Interface List Interfaces Dedicated Management Interface

Deeply nested Interface block collapsed for readability.

Custom Network Config Interface List Interfaces Dedicated Management Interface Cluster

Deeply nested Cluster block collapsed for readability.

Custom Network Config Interface List Interfaces Ethernet Interface

Deeply nested Interface block collapsed for readability.

Custom Network Config Interface List Interfaces Ethernet Interface Cluster

Deeply nested Cluster block collapsed for readability.

Custom Network Config Interface List Interfaces Ethernet Interface DHCP Client

Deeply nested Client block collapsed for readability.

Custom Network Config Interface List Interfaces Ethernet Interface DHCP Server

Deeply nested Server block collapsed for readability.

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

Deeply nested End block collapsed for readability.

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

Deeply nested Start block collapsed for readability.

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

Deeply nested Networks block collapsed for readability.

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

Deeply nested Address block collapsed for readability.

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

Deeply nested Address block collapsed for readability.

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

Deeply nested Pools block collapsed for readability.

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

Deeply nested Dgw block collapsed for readability.

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

Deeply nested Map block collapsed for readability.

Custom Network Config Interface List Interfaces Ethernet Interface IPv6 Auto Config

Deeply nested Config block collapsed for readability.

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

Deeply nested Host block collapsed for readability.

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

Deeply nested Router block collapsed for readability.

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

Deeply nested Config block collapsed for readability.

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

Deeply nested List block collapsed for readability.

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

Deeply nested DNS block collapsed for readability.

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

Deeply nested Address block collapsed for readability.

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

Deeply nested Address block collapsed for readability.

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

Deeply nested Stateful block collapsed for readability.

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

Deeply nested End block collapsed for readability.

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

Deeply nested Start block collapsed for readability.

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

Deeply nested Networks block collapsed for readability.

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

Deeply nested Pools block collapsed for readability.

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

Deeply nested Map block collapsed for readability.

Custom Network Config Interface List Interfaces Ethernet Interface Is Primary

Deeply nested Primary block collapsed for readability.

Custom Network Config Interface List Interfaces Ethernet Interface Monitor

Deeply nested Monitor block collapsed for readability.

Custom Network Config Interface List Interfaces Ethernet Interface Monitor Disabled

Deeply nested Disabled block collapsed for readability.

Custom Network Config Interface List Interfaces Ethernet Interface No IPv6 Address

Deeply nested Address block collapsed for readability.

Custom Network Config Interface List Interfaces Ethernet Interface Not Primary

Deeply nested Primary block collapsed for readability.

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

Deeply nested Network block collapsed for readability.

Custom Network Config Interface List Interfaces Ethernet Interface Site Local Network

Deeply nested Network block collapsed for readability.

Custom Network Config Interface List Interfaces Ethernet Interface Static IP

Deeply nested IP block collapsed for readability.

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

Deeply nested IP block collapsed for readability.

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

Deeply nested IP block collapsed for readability.

Custom Network Config Interface List Interfaces Ethernet Interface Static IPv6 Address

Deeply nested Address block collapsed for readability.

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

Deeply nested IP block collapsed for readability.

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

Deeply nested IP block collapsed for readability.

Custom Network Config Interface List Interfaces Ethernet Interface Storage Network

Deeply nested Network block collapsed for readability.

Custom Network Config Interface List Interfaces Ethernet Interface Untagged

Deeply nested Untagged block collapsed for readability.

Custom Network Config Interface List Interfaces Labels

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

Custom Network Config Interface List Interfaces Tunnel Interface

Deeply nested Interface block collapsed for readability.

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

Deeply nested Network block collapsed for readability.

Custom Network Config Interface List Interfaces Tunnel Interface Site Local Network

Deeply nested Network block collapsed for readability.

Custom Network Config Interface List Interfaces Tunnel Interface Static IP

Deeply nested IP block collapsed for readability.

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

Deeply nested IP block collapsed for readability.

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

Deeply nested IP block collapsed for readability.

Custom Network Config Interface List Interfaces Tunnel Interface Tunnel

Deeply nested Tunnel block collapsed for readability.

Custom Network Config No Forward Proxy

A no_forward_proxy block (within custom_network_config) supports the following:

Custom Network Config No Global Network

A no_global_network block (within custom_network_config) supports the following:

Custom Network Config No Network Policy

A no_network_policy block (within custom_network_config) supports the following:

Custom Network Config SLI Config

A sli_config block (within custom_network_config) supports the following:

• no_static_routes - Optional Object
Configuration parameter for no static routes

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

• static_routes - Optional String
Configuration parameter for static routes

• static_v6_routes - Optional String
Configuration parameter for static v6 routes

Custom Network Config SLI Config No Static Routes

Deeply nested Routes block collapsed for readability.

Custom Network Config SLI Config No V6 Static Routes

Deeply nested Routes block collapsed for readability.

Custom Network Config SLI Config Static Routes

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

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

Custom Network Config SLI Config Static Routes Static Routes

Deeply nested Routes block collapsed for readability.

Custom Network Config SLI Config Static Routes Static Routes Default Gateway

Deeply nested Gateway block collapsed for readability.

Custom Network Config SLI Config Static Routes Static Routes Node Interface

Deeply nested Interface block collapsed for readability.

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

Deeply nested List block collapsed for readability.

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

Deeply nested Interface block collapsed for readability.

Custom Network Config SLI Config Static V6 Routes

Deeply nested Routes block collapsed for readability.

Custom Network Config SLI Config Static V6 Routes Static Routes

Deeply nested Routes block collapsed for readability.

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

Deeply nested Gateway block collapsed for readability.

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

Deeply nested Interface block collapsed for readability.

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

Deeply nested List block collapsed for readability.

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

Deeply nested Interface block collapsed for readability.

Custom Network Config Slo Config

A slo_config block (within custom_network_config) supports the following:

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

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

• no_dc_cluster_group - Optional Object
Enable this option

• no_static_routes - Optional Object
Configuration parameter for no static routes

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

• static_routes - Optional String
Configuration parameter for static routes

• static_v6_routes - Optional String
Configuration parameter for static v6 routes

Custom Network Config Slo Config Dc Cluster Group

Deeply nested Group block collapsed for readability.

Custom Network Config Slo Config Labels

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

Custom Network Config Slo Config No Dc Cluster Group

Deeply nested Group block collapsed for readability.

Custom Network Config Slo Config No Static Routes

Deeply nested Routes block collapsed for readability.

Custom Network Config Slo Config No Static V6 Routes

Deeply nested Routes block collapsed for readability.

Custom Network Config Slo Config Static Routes

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

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

Custom Network Config Slo Config Static Routes Static Routes

Deeply nested Routes block collapsed for readability.

Custom Network Config Slo Config Static Routes Static Routes Default Gateway

Deeply nested Gateway block collapsed for readability.

Custom Network Config Slo Config Static Routes Static Routes Node Interface

Deeply nested Interface block collapsed for readability.

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

Deeply nested List block collapsed for readability.

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

Deeply nested Interface block collapsed for readability.

Custom Network Config Slo Config Static V6 Routes

Deeply nested Routes block collapsed for readability.

Custom Network Config Slo Config Static V6 Routes Static Routes

Deeply nested Routes block collapsed for readability.

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

Deeply nested Gateway block collapsed for readability.

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

Deeply nested Interface block collapsed for readability.

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

Deeply nested List block collapsed for readability.

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

Deeply nested Interface block collapsed for readability.

Custom Network Config Sm Connection Public IP

A sm_connection_public_ip block (within custom_network_config) supports the following:

Custom Network Config Sm Connection Pvt IP

A sm_connection_pvt_ip block (within custom_network_config) supports the following:

Custom Storage Config

A custom_storage_config block supports the following:

• default_storage_class - Optional Object
Configuration parameter for default storage class

• no_static_routes - Optional Object
Configuration parameter for no static routes

• no_storage_device - Optional Object
Configuration parameter for no storage device

• no_storage_interfaces - Optional Object
Configuration parameter for no storage interfaces

• static_routes - Optional String
Configuration parameter for static routes

• storage_class_list - Optional String
Add additional custom storage classes in Kubernetes for this fleet

• storage_device_list - Optional String
Add additional custom storage classes in Kubernetes for this fleet

• storage_interface_list - Optional String
Configure storage interfaces for this App Stack site

Custom Storage Config Default Storage Class

A default_storage_class block (within custom_storage_config) supports the following:

Custom Storage Config No Static Routes

A no_static_routes block (within custom_storage_config) supports the following:

Custom Storage Config No Storage Device

A no_storage_device block (within custom_storage_config) supports the following:

Custom Storage Config No Storage Interfaces

A no_storage_interfaces block (within custom_storage_config) supports the following:

Custom Storage Config Static Routes

A static_routes block (within custom_storage_config) supports the following:

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

Custom Storage Config Static Routes Static Routes

A static_routes block (within custom_storage_config.static_routes) supports the following:

• attrs - Optional List Defaults to ROUTE_ATTR_NO_OP
Possible values are ROUTE_ATTR_NO_OP, ROUTE_ATTR_ADVERTISE, ROUTE_ATTR_INSTALL_HOST, ROUTE_ATTR_INSTALL_FORWARDING, ROUTE_ATTR_MERGE_ONLY
[Enum: ROUTE_ATTR_NO_OP|ROUTE_ATTR_ADVERTISE|ROUTE_ATTR_INSTALL_HOST|ROUTE_ATTR_INSTALL_FORWARDING|ROUTE_ATTR_MERGE_ONLY] List of attributes that control forwarding, dynamic routing and control plane (host) reachability

• default_gateway - Optional Object
Configuration parameter for default gateway

• ip_address - Optional String
Traffic matching the IP prefixes is sent to this IP Address

• ip_prefixes - Optional List
List of route prefixes that have common next hop and attributes

• node_interface - Optional String
On multinode site, this type holds the information about per node interfaces

Custom Storage Config Static Routes Static Routes Default Gateway

Deeply nested Gateway block collapsed for readability.

Custom Storage Config Static Routes Static Routes Node Interface

Deeply nested Interface block collapsed for readability.

Custom Storage Config Static Routes Static Routes Node Interface List

Deeply nested List block collapsed for readability.

Custom Storage Config Static Routes Static Routes Node Interface List Interface

Deeply nested Interface block collapsed for readability.

Custom Storage Config Storage Class List

A storage_class_list block (within custom_storage_config) supports the following:

• storage_classes - Optional List
List of Storage Classes. List of custom storage classes

Custom Storage Config Storage Class List Storage Classes

Deeply nested Classes block collapsed for readability.

Custom Storage Config Storage Class List Storage Classes Custom Storage

Deeply nested Storage block collapsed for readability.

Custom Storage Config Storage Class List Storage Classes Hpe Storage

Deeply nested Storage block collapsed for readability.

Custom Storage Config Storage Class List Storage Classes Netapp Trident

Deeply nested Trident block collapsed for readability.

Custom Storage Config Storage Class List Storage Classes Netapp Trident Selector

Deeply nested Selector block collapsed for readability.

Custom Storage Config Storage Class List Storage Classes Pure Service Orchestrator

Deeply nested Orchestrator block collapsed for readability.

Custom Storage Config Storage Device List

A storage_device_list block (within custom_storage_config) supports the following:

• storage_devices - Optional List
List of Storage Devices. List of custom storage devices

Custom Storage Config Storage Device List Storage Devices

Deeply nested Devices block collapsed for readability.

Custom Storage Config Storage Device List Storage Devices Custom Storage

Deeply nested Storage block collapsed for readability.

Custom Storage Config Storage Device List Storage Devices Hpe Storage

Deeply nested Storage block collapsed for readability.

Custom Storage Config Storage Device List Storage Devices Hpe Storage iSCSI Chap Password

Deeply nested Password block collapsed for readability.

Custom Storage Config Storage Device List Storage Devices Hpe Storage iSCSI Chap Password Blindfold Secret Info

Deeply nested Info block collapsed for readability.

Custom Storage Config Storage Device List Storage Devices Hpe Storage iSCSI Chap Password Clear Secret Info

Deeply nested Info block collapsed for readability.

Custom Storage Config Storage Device List Storage Devices Hpe Storage Password

Deeply nested Password block collapsed for readability.

Custom Storage Config Storage Device List Storage Devices Hpe Storage Password Blindfold Secret Info

Deeply nested Info block collapsed for readability.

Custom Storage Config Storage Device List Storage Devices Hpe Storage Password Clear Secret Info

Deeply nested Info block collapsed for readability.

Custom Storage Config Storage Device List Storage Devices Netapp Trident

Deeply nested Trident block collapsed for readability.

Custom Storage Config Storage Device List Storage Devices Netapp Trident Netapp Backend Ontap Nas

Deeply nested Nas block collapsed for readability.

Custom Storage Config Storage Device List Storage Devices Netapp Trident Netapp Backend Ontap Nas Auto Export Cidrs

Deeply nested Cidrs block collapsed for readability.

Custom Storage Config Storage Device List Storage Devices Netapp Trident Netapp Backend Ontap Nas Client Private Key

Deeply nested Key block collapsed for readability.

Custom Storage Config Storage Device List Storage Devices Netapp Trident Netapp Backend Ontap Nas Client Private Key Blindfold Secret Info

Deeply nested Info block collapsed for readability.

Custom Storage Config Storage Device List Storage Devices Netapp Trident Netapp Backend Ontap Nas Client Private Key Clear Secret Info

Deeply nested Info block collapsed for readability.

Custom Storage Config Storage Device List Storage Devices Netapp Trident Netapp Backend Ontap Nas Password

Deeply nested Password block collapsed for readability.

Custom Storage Config Storage Device List Storage Devices Netapp Trident Netapp Backend Ontap Nas Password Blindfold Secret Info

Deeply nested Info block collapsed for readability.

Custom Storage Config Storage Device List Storage Devices Netapp Trident Netapp Backend Ontap Nas Password Clear Secret Info

Deeply nested Info block collapsed for readability.

Custom Storage Config Storage Device List Storage Devices Netapp Trident Netapp Backend Ontap Nas Storage

Deeply nested Storage block collapsed for readability.

Custom Storage Config Storage Device List Storage Devices Netapp Trident Netapp Backend Ontap Nas Storage Volume Defaults

Deeply nested Defaults block collapsed for readability.

Custom Storage Config Storage Device List Storage Devices Netapp Trident Netapp Backend Ontap Nas Storage Volume Defaults No QOS

Deeply nested QOS block collapsed for readability.

Custom Storage Config Storage Device List Storage Devices Netapp Trident Netapp Backend Ontap Nas Volume Defaults

Deeply nested Defaults block collapsed for readability.

Custom Storage Config Storage Device List Storage Devices Netapp Trident Netapp Backend Ontap Nas Volume Defaults No QOS

Deeply nested QOS block collapsed for readability.

Custom Storage Config Storage Device List Storage Devices Netapp Trident Netapp Backend Ontap San

Deeply nested San block collapsed for readability.

Custom Storage Config Storage Device List Storage Devices Netapp Trident Netapp Backend Ontap San Client Private Key

Deeply nested Key block collapsed for readability.

Custom Storage Config Storage Device List Storage Devices Netapp Trident Netapp Backend Ontap San Client Private Key Blindfold Secret Info

Deeply nested Info block collapsed for readability.

Custom Storage Config Storage Device List Storage Devices Netapp Trident Netapp Backend Ontap San Client Private Key Clear Secret Info

Deeply nested Info block collapsed for readability.

Custom Storage Config Storage Device List Storage Devices Netapp Trident Netapp Backend Ontap San No Chap

Deeply nested Chap block collapsed for readability.

Custom Storage Config Storage Device List Storage Devices Netapp Trident Netapp Backend Ontap San Password

Deeply nested Password block collapsed for readability.

Custom Storage Config Storage Device List Storage Devices Netapp Trident Netapp Backend Ontap San Password Blindfold Secret Info

Deeply nested Info block collapsed for readability.

Custom Storage Config Storage Device List Storage Devices Netapp Trident Netapp Backend Ontap San Password Clear Secret Info

Deeply nested Info block collapsed for readability.

Custom Storage Config Storage Device List Storage Devices Netapp Trident Netapp Backend Ontap San Storage

Deeply nested Storage block collapsed for readability.

Custom Storage Config Storage Device List Storage Devices Netapp Trident Netapp Backend Ontap San Storage Volume Defaults

Deeply nested Defaults block collapsed for readability.

Custom Storage Config Storage Device List Storage Devices Netapp Trident Netapp Backend Ontap San Storage Volume Defaults No QOS

Deeply nested QOS block collapsed for readability.

Custom Storage Config Storage Device List Storage Devices Netapp Trident Netapp Backend Ontap San Use Chap

Deeply nested Chap block collapsed for readability.

Custom Storage Config Storage Device List Storage Devices Netapp Trident Netapp Backend Ontap San Use Chap Chap Initiator Secret

Deeply nested Secret block collapsed for readability.

Custom Storage Config Storage Device List Storage Devices Netapp Trident Netapp Backend Ontap San Use Chap Chap Initiator Secret Blindfold Secret Info

Deeply nested Info block collapsed for readability.

Custom Storage Config Storage Device List Storage Devices Netapp Trident Netapp Backend Ontap San Use Chap Chap Initiator Secret Clear Secret Info

Deeply nested Info block collapsed for readability.

Custom Storage Config Storage Device List Storage Devices Netapp Trident Netapp Backend Ontap San Use Chap Chap Target Initiator Secret

Deeply nested Secret block collapsed for readability.

Custom Storage Config Storage Device List Storage Devices Netapp Trident Netapp Backend Ontap San Use Chap Chap Target Initiator Secret Blindfold Secret Info

Deeply nested Info block collapsed for readability.

Custom Storage Config Storage Device List Storage Devices Netapp Trident Netapp Backend Ontap San Use Chap Chap Target Initiator Secret Clear Secret Info

Deeply nested Info block collapsed for readability.

Custom Storage Config Storage Device List Storage Devices Netapp Trident Netapp Backend Ontap San Volume Defaults

Deeply nested Defaults block collapsed for readability.

Custom Storage Config Storage Device List Storage Devices Netapp Trident Netapp Backend Ontap San Volume Defaults No QOS

Deeply nested QOS block collapsed for readability.

Custom Storage Config Storage Device List Storage Devices Pure Service Orchestrator

Deeply nested Orchestrator block collapsed for readability.

Custom Storage Config Storage Device List Storage Devices Pure Service Orchestrator Arrays

Deeply nested Arrays block collapsed for readability.

Custom Storage Config Storage Device List Storage Devices Pure Service Orchestrator Arrays Flash Array

Deeply nested Array block collapsed for readability.

Custom Storage Config Storage Device List Storage Devices Pure Service Orchestrator Arrays Flash Array Flash Arrays

Deeply nested Arrays block collapsed for readability.

Custom Storage Config Storage Device List Storage Devices Pure Service Orchestrator Arrays Flash Array Flash Arrays API Token

Deeply nested Token block collapsed for readability.

Custom Storage Config Storage Device List Storage Devices Pure Service Orchestrator Arrays Flash Array Flash Arrays API Token Blindfold Secret Info

Deeply nested Info block collapsed for readability.

Custom Storage Config Storage Device List Storage Devices Pure Service Orchestrator Arrays Flash Array Flash Arrays API Token Clear Secret Info

Deeply nested Info block collapsed for readability.

Custom Storage Config Storage Device List Storage Devices Pure Service Orchestrator Arrays Flash Blade

Deeply nested Blade block collapsed for readability.

Custom Storage Config Storage Device List Storage Devices Pure Service Orchestrator Arrays Flash Blade Flash Blades

Deeply nested Blades block collapsed for readability.

Custom Storage Config Storage Device List Storage Devices Pure Service Orchestrator Arrays Flash Blade Flash Blades API Token

Deeply nested Token block collapsed for readability.

Custom Storage Config Storage Device List Storage Devices Pure Service Orchestrator Arrays Flash Blade Flash Blades API Token Blindfold Secret Info

Deeply nested Info block collapsed for readability.

Custom Storage Config Storage Device List Storage Devices Pure Service Orchestrator Arrays Flash Blade Flash Blades API Token Clear Secret Info

Deeply nested Info block collapsed for readability.

Custom Storage Config Storage Interface List

A storage_interface_list block (within custom_storage_config) supports the following:

• storage_interfaces - Optional List
Configure storage interfaces for this App Stack site

Custom Storage Config Storage Interface List Storage Interfaces

Deeply nested Interfaces block collapsed for readability.

Custom Storage Config Storage Interface List Storage Interfaces Labels

Deeply nested Labels block collapsed for readability.

Custom Storage Config Storage Interface List Storage Interfaces Storage Interface

Deeply nested Interface block collapsed for readability.

Custom Storage Config Storage Interface List Storage Interfaces Storage Interface Cluster

Deeply nested Cluster block collapsed for readability.

Custom Storage Config Storage Interface List Storage Interfaces Storage Interface DHCP Client

Deeply nested Client block collapsed for readability.

Custom Storage Config Storage Interface List Storage Interfaces Storage Interface DHCP Server

Deeply nested Server block collapsed for readability.

Custom Storage Config Storage Interface List Storage Interfaces Storage Interface DHCP Server Automatic From End

Deeply nested End block collapsed for readability.

Custom Storage Config Storage Interface List Storage Interfaces Storage Interface DHCP Server Automatic From Start

Deeply nested Start block collapsed for readability.

Custom Storage Config Storage Interface List Storage Interfaces Storage Interface DHCP Server DHCP Networks

Deeply nested Networks block collapsed for readability.

Custom Storage Config Storage Interface List Storage Interfaces Storage Interface DHCP Server DHCP Networks First Address

Deeply nested Address block collapsed for readability.

Custom Storage Config Storage Interface List Storage Interfaces Storage Interface DHCP Server DHCP Networks Last Address

Deeply nested Address block collapsed for readability.

Custom Storage Config Storage Interface List Storage Interfaces Storage Interface DHCP Server DHCP Networks Pools

Deeply nested Pools block collapsed for readability.

Custom Storage Config Storage Interface List Storage Interfaces Storage Interface DHCP Server DHCP Networks Same As Dgw

Deeply nested Dgw block collapsed for readability.

Custom Storage Config Storage Interface List Storage Interfaces Storage Interface DHCP Server Interface IP Map

Deeply nested Map block collapsed for readability.

Custom Storage Config Storage Interface List Storage Interfaces Storage Interface IPv6 Auto Config

Deeply nested Config block collapsed for readability.

Custom Storage Config Storage Interface List Storage Interfaces Storage Interface IPv6 Auto Config Host

Deeply nested Host block collapsed for readability.

Custom Storage Config Storage Interface List Storage Interfaces Storage Interface IPv6 Auto Config Router

Deeply nested Router block collapsed for readability.

Custom Storage Config Storage Interface List Storage Interfaces Storage Interface IPv6 Auto Config Router DNS Config

Deeply nested Config block collapsed for readability.

Custom Storage Config Storage Interface List Storage Interfaces Storage Interface IPv6 Auto Config Router DNS Config Configured List

Deeply nested List block collapsed for readability.

Custom Storage Config Storage Interface List Storage Interfaces Storage Interface IPv6 Auto Config Router DNS Config Local DNS

Deeply nested DNS block collapsed for readability.

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

Deeply nested Address block collapsed for readability.

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

Deeply nested Address block collapsed for readability.

Custom Storage Config Storage Interface List Storage Interfaces Storage Interface IPv6 Auto Config Router Stateful

Deeply nested Stateful block collapsed for readability.

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

Deeply nested End block collapsed for readability.

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

Deeply nested Start block collapsed for readability.

Custom Storage Config Storage Interface List Storage Interfaces Storage Interface IPv6 Auto Config Router Stateful DHCP Networks

Deeply nested Networks block collapsed for readability.

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

Deeply nested Pools block collapsed for readability.

Custom Storage Config Storage Interface List Storage Interfaces Storage Interface IPv6 Auto Config Router Stateful Interface IP Map

Deeply nested Map block collapsed for readability.

Custom Storage Config Storage Interface List Storage Interfaces Storage Interface Is Primary

Deeply nested Primary block collapsed for readability.

Custom Storage Config Storage Interface List Storage Interfaces Storage Interface Monitor

Deeply nested Monitor block collapsed for readability.

Custom Storage Config Storage Interface List Storage Interfaces Storage Interface Monitor Disabled

Deeply nested Disabled block collapsed for readability.

Custom Storage Config Storage Interface List Storage Interfaces Storage Interface No IPv6 Address

Deeply nested Address block collapsed for readability.

Custom Storage Config Storage Interface List Storage Interfaces Storage Interface Not Primary

Deeply nested Primary block collapsed for readability.

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

Deeply nested Network block collapsed for readability.

Custom Storage Config Storage Interface List Storage Interfaces Storage Interface Site Local Network

Deeply nested Network block collapsed for readability.

Custom Storage Config Storage Interface List Storage Interfaces Storage Interface Static IP

Deeply nested IP block collapsed for readability.

Custom Storage Config Storage Interface List Storage Interfaces Storage Interface Static IP Cluster Static IP

Deeply nested IP block collapsed for readability.

Custom Storage Config Storage Interface List Storage Interfaces Storage Interface Static IP Node Static IP

Deeply nested IP block collapsed for readability.

Custom Storage Config Storage Interface List Storage Interfaces Storage Interface Static IPv6 Address

Deeply nested Address block collapsed for readability.

Custom Storage Config Storage Interface List Storage Interfaces Storage Interface Static IPv6 Address Cluster Static IP

Deeply nested IP block collapsed for readability.

Custom Storage Config Storage Interface List Storage Interfaces Storage Interface Static IPv6 Address Node Static IP

Deeply nested IP block collapsed for readability.

Custom Storage Config Storage Interface List Storage Interfaces Storage Interface Storage Network

Deeply nested Network block collapsed for readability.

Custom Storage Config Storage Interface List Storage Interfaces Storage Interface Untagged

Deeply nested Untagged block collapsed for readability.

Default Blocked Services

A default_blocked_services block supports the following:

Default Network Config

A default_network_config block supports the following:

Default Sriov Interface

A default_sriov_interface block supports the following:

Default Storage Config

A default_storage_config block supports the following:

Deny All Usb

A deny_all_usb block supports the following:

Disable GPU

A disable_gpu block supports the following:

Disable VM

A disable_vm block supports the following:

Enable GPU

An enable_gpu block supports the following:

Enable Vgpu

An enable_vgpu block supports the following:

• feature_type - Optional String Defaults to UNLICENSED
Possible values are UNLICENSED, VGPU, VWS, VCS
[Enum: UNLICENSED|VGPU|VWS|VCS] Set feature to be enabled Operate with a degraded vGPU performance Enable NVIDIA vGPU Enable NVIDIA RTX Virtual Workstation Enable NVIDIA Virtual Compute Server

• server_address - Optional String
License Server Address. Set License Server Address

• server_port - Optional Number
License Server Port Number. Set License Server port number

Enable VM

An enable_vm block supports the following:

K8S Cluster

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

Kubernetes Upgrade Drain

A kubernetes_upgrade_drain block supports the following:

• disable_upgrade_drain - Optional Object
Configuration parameter for disable upgrade drain

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

Kubernetes Upgrade Drain Disable Upgrade Drain

A disable_upgrade_drain block (within kubernetes_upgrade_drain) supports the following:

Kubernetes Upgrade Drain Enable Upgrade Drain

An enable_upgrade_drain block (within kubernetes_upgrade_drain) supports the following:

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

• drain_max_unavailable_node_count - Optional Number
Node Batch Size Count

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

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

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

Kubernetes Upgrade Drain Enable Upgrade Drain Disable Vega Upgrade Mode

Deeply nested Mode block collapsed for readability.

Kubernetes Upgrade Drain Enable Upgrade Drain Enable Vega Upgrade Mode

Deeply nested Mode block collapsed for readability.

Local Control Plane

A local_control_plane block supports the following:

• bgp_config - Optional String
BGP Configuration. BGP configuration parameters

• inside_vn - Optional Object
Enable this option

• outside_vn - Optional Object
Enable this option

Local Control Plane BGP Config

A bgp_config block (within local_control_plane) supports the following:

• asn - Optional Number
ASN. Autonomous System Number

• peers - Optional List
Peers. BGP parameters for peer

Local Control Plane BGP Config Peers

A peers block (within local_control_plane.bgp_config) supports the following:

• bfd_disabled - Optional Object
Enable this option

• bfd_enabled - Optional String
BFD. BFD parameters

• disable_spec - Optional Object
Enable this option

• external - Optional String
External BGP Peer. External BGP Peer parameters

• label - Optional String
Label. Specify whether this peer should be

• metadata - Optional String
MessageMetaType is metadata (common attributes) of a message that only certain messages have. This information is propagated to the metadata of a child object that gets created from the containing message during view processing. The information in this type can be specified by user during create

• passive_mode_disabled - Optional Object
Enable this option

• passive_mode_enabled - Optional Object
Enable this option

• routing_policies - Optional String
List of rules which can be applied on all or particular nodes

Local Control Plane BGP Config Peers Bfd Disabled

Deeply nested Disabled block collapsed for readability.

Local Control Plane BGP Config Peers Bfd Enabled

Deeply nested Enabled block collapsed for readability.

Local Control Plane BGP Config Peers Disable Spec

Deeply nested Spec block collapsed for readability.

Local Control Plane BGP Config Peers External

An external block (within local_control_plane.bgp_config.peers) supports the following:

• address - Optional String
Specify IPv4 peer address

• address_ipv6 - Optional String
Specify peer IPv6 address

• asn - Optional Number
ASN. Autonomous System Number for BGP peer

• default_gateway - Optional Object
Configuration parameter for default gateway

• default_gateway_v6 - Optional Object
Configuration parameter for default gateway v6

• disable_spec - Optional Object
Enable this option

• disable_v6 - Optional Object
Enable this option

• external_connector - Optional Object
Configuration parameter for external connector

• family_inet - Optional String
Configuration parameter for family inet

• from_site - Optional Object
Enable this option

• from_site_v6 - Optional Object
Enable this option

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

• interface_list - Optional String
Interface List. List of network interfaces

• md5_auth_key - Optional String
MD5 key for protecting BGP Sessions (RFC 2385)

• no_authentication - Optional Object
Configuration parameter for no authentication

• port - Optional Number
Peer Port. Peer TCP port number

• subnet_begin_offset - Optional Number
Calculate peer address using offset from the beginning of the subnet

• subnet_begin_offset_v6 - Optional Number
Calculate peer address using offset from the beginning of the subnet

• subnet_end_offset - Optional Number
Calculate peer address using offset from the end of the subnet

• subnet_end_offset_v6 - Optional Number
Calculate peer address using offset from the end of the subnet

Local Control Plane BGP Config Peers External Default Gateway

Deeply nested Gateway block collapsed for readability.

Local Control Plane BGP Config Peers External Default Gateway V6

Deeply nested V6 block collapsed for readability.

Local Control Plane BGP Config Peers External Disable Spec

Deeply nested Spec block collapsed for readability.

Local Control Plane BGP Config Peers External Disable V6

Deeply nested V6 block collapsed for readability.

Local Control Plane BGP Config Peers External External Connector

Deeply nested Connector block collapsed for readability.

Local Control Plane BGP Config Peers External Family Inet

Deeply nested Inet block collapsed for readability.

Local Control Plane BGP Config Peers External Family Inet Disable Spec

Deeply nested Spec block collapsed for readability.

Local Control Plane BGP Config Peers External Family Inet Enable

Deeply nested Enable block collapsed for readability.

Local Control Plane BGP Config Peers External Family Inet Enable Aggregation

Deeply nested Aggregation block collapsed for readability.

Local Control Plane BGP Config Peers External Family Inet Enable Aggregation Options

Deeply nested Options block collapsed for readability.

Local Control Plane BGP Config Peers External Family Inet Enable Aggregation Options Summary Only

Deeply nested Only block collapsed for readability.

Local Control Plane BGP Config Peers External From Site

Deeply nested Site block collapsed for readability.

Local Control Plane BGP Config Peers External From Site V6

Deeply nested V6 block collapsed for readability.

Local Control Plane BGP Config Peers External Interface

Deeply nested Interface block collapsed for readability.

Local Control Plane BGP Config Peers External Interface List

Deeply nested List block collapsed for readability.

Local Control Plane BGP Config Peers External Interface List Interfaces

Deeply nested Interfaces block collapsed for readability.

Local Control Plane BGP Config Peers External No Authentication

Deeply nested Authentication block collapsed for readability.

Local Control Plane BGP Config Peers Metadata

A metadata block (within local_control_plane.bgp_config.peers) supports the following:

• description_spec - Optional String
Description. Human readable description

• name - Optional String
Name of the message. The value of name has to follow DNS-1035 format

Local Control Plane BGP Config Peers Passive Mode Disabled

Deeply nested Disabled block collapsed for readability.

Local Control Plane BGP Config Peers Passive Mode Enabled

Deeply nested Enabled block collapsed for readability.

Local Control Plane BGP Config Peers Routing Policies

Deeply nested Policies block collapsed for readability.

Local Control Plane BGP Config Peers Routing Policies Route Policy

Deeply nested Policy block collapsed for readability.

Local Control Plane BGP Config Peers Routing Policies Route Policy All Nodes

Deeply nested Nodes block collapsed for readability.

Local Control Plane BGP Config Peers Routing Policies Route Policy Inbound

Deeply nested Inbound block collapsed for readability.

Local Control Plane BGP Config Peers Routing Policies Route Policy Node Name

Deeply nested Name block collapsed for readability.

Local Control Plane BGP Config Peers Routing Policies Route Policy Object Refs

Deeply nested Refs block collapsed for readability.

Local Control Plane BGP Config Peers Routing Policies Route Policy Outbound

Deeply nested Outbound block collapsed for readability.

Local Control Plane Inside Vn

An inside_vn block (within local_control_plane) supports the following:

Local Control Plane Outside Vn

An outside_vn block (within local_control_plane) supports the following:

Log Receiver

A log_receiver block supports the following:

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

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

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

Logs Streaming Disabled

A logs_streaming_disabled block supports the following:

Master Node Configuration

A master_node_configuration block supports the following:

• name - Optional String
Name. Names of master node

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

No Bond Devices

A no_bond_devices block supports the following:

No K8S Cluster

A no_k8s_cluster block supports the following:

No Local Control Plane

A no_local_control_plane block supports the following:

Offline Survivability Mode

An offline_survivability_mode block supports the following:

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

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

Offline Survivability Mode Enable Offline Survivability Mode

An enable_offline_survivability_mode block (within offline_survivability_mode) supports the following:

Offline Survivability Mode No Offline Survivability Mode

A no_offline_survivability_mode block (within offline_survivability_mode) supports the following:

OS

An os block supports the following:

• default_os_version - Optional Object
Enable this option

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

OS Default OS Version

A default_os_version block (within os) supports the following:

Sriov Interfaces

A sriov_interfaces block supports the following:

• sriov_interface - Optional List
Use custom SR-IOV interfaces Configuration

Sriov Interfaces Sriov Interface

A sriov_interface block (within sriov_interfaces) supports the following:

• interface_name - Optional String
Name of physical interface. Name of SR-IOV physical interface

• number_of_vfio_vfs - Optional Number
Number of virtual functions reserved for VNFs and DPDK-based CNFs

• number_of_vfs - Optional Number
Total number of virtual functions. Total number of virtual functions

Sw

A sw block supports the following:

• default_sw_version - Optional Object
Enable this option

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

Sw Default Sw Version

A default_sw_version block (within sw) supports the following:

Usb Policy

An usb_policy 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

Common Types

The following type definitions are used throughout this resource. See the full definition here rather than repeated inline.

Object Reference {#common-object-reference}

Object references establish a direct reference from one configuration object to another in F5 Distributed Cloud. References use the format tenant/namespace/name.

Field	Type	Description
`name`	String	Name of the referenced object
`namespace`	String	Namespace containing the referenced object
`tenant`	String	Tenant of the referenced object (system-managed)

Transformers {#common-transformers}

Transformers apply transformations to input values before matching. Multiple transformers can be applied in order.

Value	Description
`LOWER_CASE`	Convert to lowercase
`UPPER_CASE`	Convert to uppercase
`BASE64_DECODE`	Decodebase64 content
`NORMALIZE_PATH`	Normalize URL path
`REMOVE_WHITESPACE`	Remove whitespace characters
`URL_DECODE`	Decode URL-encoded characters
`TRIM_LEFT`	Trim leading whitespace
`TRIM_RIGHT`	Trim trailing whitespace
`TRIM`	Trim both leading and trailing whitespace

HTTP Methods {#common-http-methods}

HTTP methods used for request matching.

Value	Description
`ANY`	Match any HTTP method
`GET`	HTTP GET request
`HEAD`	HTTP HEAD request
`POST`	HTTP POST request
`PUT`	HTTP PUT request
`DELETE`	HTTP DELETE request
`CONNECT`	HTTP CONNECT request
`OPTIONS`	HTTP OPTIONS request
`TRACE`	HTTP TRACE request
`PATCH`	HTTP PATCH request
`COPY`	HTTP COPY request (WebDAV)

TLS Fingerprints {#common-tls-fingerprints}

TLS fingerprint categories for malicious client detection.

Value	Description
`TLS_FINGERPRINT_NONE`	No fingerprint matching
`ANY_MALICIOUS_FINGERPRINT`	Match any known malicious fingerprint
`ADWARE`	Adware-associated fingerprints
`DRIDEX`	Dridex malware fingerprints
`GOOTKIT`	Gootkit malware fingerprints
`RANSOMWARE`	Ransomware-associated fingerprints
`TRICKBOT`	Trickbot malware fingerprints

IP Threat Categories {#common-ip-threat-categories}

IP address threat categories for security filtering.

Value	Description
`SPAM_SOURCES`	Known spam sources
`WINDOWS_EXPLOITS`	Windows exploit sources
`WEB_ATTACKS`	Web attack sources
`BOTNETS`	Known botnet IPs
`SCANNERS`	Network scanner IPs
`REPUTATION`	Poor reputation IPs
`PHISHING`	Phishing-related IPs
`PROXY`	Anonymous proxy IPs
`MOBILE_THREATS`	Mobile threat sources
`TOR_PROXY`	Tor exit nodes
`DENIAL_OF_SERVICE`	DoS attack sources
`NETWORK`	Known bad network ranges

xcsh_voltstack_site (Data Source)

Example Usage

Argument Reference

Metadata Argument Reference

Attributes Reference

Coordinates

Custom DNS

Custom Network Config

Custom Network Config Active Enhanced Firewall Policies

Custom Network Config Active Enhanced Firewall Policies Enhanced Firewall Policies

Custom Network Config Active Forward Proxy Policies

Custom Network Config Active Forward Proxy Policies Forward Proxy Policies

Custom Network Config Active Network Policies

Custom Network Config Active Network Policies Network Policies

Custom Network Config Default Config

Custom Network Config Default Interface Config

Custom Network Config Default SLI Config

Custom Network Config Forward Proxy Allow All

Custom Network Config Global Network List

Custom Network Config Global Network List Global Network Connections

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

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

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

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

Custom Network Config Interface List

Custom Network Config Interface List Interfaces

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

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

Custom Network Config Interface List Interfaces Dedicated Interface

Custom Network Config Interface List Interfaces Dedicated Interface Cluster

Custom Network Config Interface List Interfaces Dedicated Interface Is Primary

Custom Network Config Interface List Interfaces Dedicated Interface Monitor

Custom Network Config Interface List Interfaces Dedicated Interface Monitor Disabled

Custom Network Config Interface List Interfaces Dedicated Interface Not Primary

Custom Network Config Interface List Interfaces Dedicated Management Interface

Custom Network Config Interface List Interfaces Dedicated Management Interface Cluster

Custom Network Config Interface List Interfaces Ethernet Interface

Custom Network Config Interface List Interfaces Ethernet Interface Cluster

Custom Network Config Interface List Interfaces Ethernet Interface DHCP Client

Custom Network Config Interface List Interfaces Ethernet Interface DHCP Server

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

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

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

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

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

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

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

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

Custom Network Config Interface List Interfaces Ethernet Interface IPv6 Auto Config

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

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

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

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

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

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

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

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

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

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

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

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

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

Custom Network Config Interface List Interfaces Ethernet Interface Is Primary

Custom Network Config Interface List Interfaces Ethernet Interface Monitor

Custom Network Config Interface List Interfaces Ethernet Interface Monitor Disabled

Custom Network Config Interface List Interfaces Ethernet Interface No IPv6 Address

Custom Network Config Interface List Interfaces Ethernet Interface Not Primary

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

Custom Network Config Interface List Interfaces Ethernet Interface Site Local Network

Custom Network Config Interface List Interfaces Ethernet Interface Static IP

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

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

Custom Network Config Interface List Interfaces Ethernet Interface Static IPv6 Address

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

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

Custom Network Config Interface List Interfaces Ethernet Interface Storage Network

Custom Network Config Interface List Interfaces Ethernet Interface Untagged

Custom Network Config Interface List Interfaces Labels

Custom Network Config Interface List Interfaces Tunnel Interface

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