xcsh_gcp_vpc_site (Data Source)

Retrieves information about a GCP VPC Site resource in F5 Distributed Cloud for deploying F5 sites within Google Cloud VPC environments. This is a read-only data source.

~> Note: For more information, see the GCP VPC Site API documentation.

Example Usage

# GCPVPCSite Data Source Example

terraform {
  required_version = ">= 1.0"

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

# Look up an existing GCPVPCSite by name
data "xcsh_gcp_vpc_site" "example" {
  name      = "example-gcp-vpc-site"
  namespace = "staging"
}

output "gcp_vpc_site_id" {
  value = data.xcsh_gcp_vpc_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.

~> Dependencies — This resource requires: cloud_credentials.

Metadata Argument Reference

• name - Required String
Name of the GCPVPCSite

• namespace - Required String
Namespace where the GCPVPCSite 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

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

• annotations - Optional Map
Annotations applied to this resource

• block_all_services - Optional Object
Enable this option

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

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

• 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

• default_blocked_services - Optional Object
Enable this option

• description - Optional String
Description of the GCPVPCSite

• disable_encryption - Optional Object
Configuration parameter for disable encryption

• disk_size - Optional Number
Disk size to be used for this instance in GiB. 80 is 80 GiB

• enable_encryption - Optional String
Configuration parameter for enable encryption

• gcp_labels - Optional Map
GCP Label is a label consisting of a user-defined key and value. It helps to manage, identify, organize, search for, and filter resources in GCP console

• gcp_region - Optional String
GCP Region. Name for GCP Region

• id - Optional String
Unique identifier for the resource

• ingress_egress_gw - Optional String
Configuration parameter for ingress egress gw

• ingress_gw - Optional String
GCP Ingress Gateway. Single interface GCP ingress site

• instance_type - Optional String
Select Instance size based on performance needed

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

• labels - Optional Map
Labels applied to this resource

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

• logs_streaming_disabled - Optional Object
Enable this option

• 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

• private_connect_disabled - Optional Object
Enable this option

• private_connectivity - Optional String
Configuration parameter for private connectivity

• ssh_key - Optional String
Public SSH key. Public SSH key for accessing the site

• 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

• voltstack_cluster - Optional String
App Stack cluster of single interface GCP site

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

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

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

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

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

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

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

• 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

• 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

---

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

Default Blocked Services

A default_blocked_services block supports the following:

Disable Encryption

A disable_encryption block supports the following:

Enable Encryption

An enable_encryption block supports the following:

• kms_key_resource_id - Optional String
GCP KMS Key to be used to encrypt the disk attached to the VM

• kms_key_ring_id - Optional String
Key ring in which the CMK to be used to encrypt is present

Ingress Egress Gw

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

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

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

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

• gcp_certified_hw - Optional String
[Enum: GCP-byol-multi-nic-voltmesh] GCP Certified Hardware. Name for GCP certified hardware. The only possible value is GCP-byol-multi-nic-voltmesh

• gcp_zone_names - Optional List
X-required List of zones when instances will be created, needs to match with region selected

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

• inside_network - Optional String
Defines choice about GCP VPC network for a view

• inside_static_routes - Optional String
Configuration parameter for inside static routes

• inside_subnet - Optional String
Defines choice about GCP VPC network for a view

• no_dc_cluster_group - Optional Object
Enable this option

• no_forward_proxy - Optional Object
Configuration parameter for no forward proxy

• no_global_network - Optional Object
Configuration parameter for no global network

• no_inside_static_routes - Optional Object
Configuration parameter for no inside static routes

• no_network_policy - Optional Object
Policy configuration for this feature

• no_outside_static_routes - Optional Object
Configuration parameter for no outside static routes

• node_number - Optional Number
Number of main nodes to create, either 1 or 3

• outside_network - Optional String
Defines choice about GCP VPC network for a view

• outside_static_routes - Optional String
Configuration parameter for outside static routes

• outside_subnet - Optional String
Defines choice about GCP VPC network for a view

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

• sm_connection_public_ip - Optional Object
Enable this option

• sm_connection_pvt_ip - Optional Object
Enable this option

Ingress Egress Gw Active Enhanced Firewall Policies

An active_enhanced_firewall_policies block (within ingress_egress_gw) supports the following:

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

Ingress Egress Gw Active Enhanced Firewall Policies Enhanced Firewall Policies

Deeply nested Policies block collapsed for readability.

Ingress Egress Gw Active Forward Proxy Policies

An active_forward_proxy_policies block (within ingress_egress_gw) supports the following:

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

Ingress Egress Gw Active Forward Proxy Policies Forward Proxy Policies

Deeply nested Policies block collapsed for readability.

Ingress Egress Gw Active Network Policies

An active_network_policies block (within ingress_egress_gw) supports the following:

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

Ingress Egress Gw Active Network Policies Network Policies

Deeply nested Policies block collapsed for readability.

Ingress Egress Gw Dc Cluster Group Inside Vn

Deeply nested Vn block collapsed for readability.

Ingress Egress Gw Dc Cluster Group Outside Vn

Deeply nested Vn block collapsed for readability.

Ingress Egress Gw Forward Proxy Allow All

A forward_proxy_allow_all block (within ingress_egress_gw) supports the following:

Ingress Egress Gw Global Network List

A global_network_list block (within ingress_egress_gw) supports the following:

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

Ingress Egress Gw Global Network List Global Network Connections

Deeply nested Connections block collapsed for readability.

Ingress Egress Gw Global Network List Global Network Connections SLI To Global DR

Deeply nested DR block collapsed for readability.

Ingress Egress Gw Global Network List Global Network Connections SLI To Global DR Global Vn

Deeply nested Vn block collapsed for readability.

Ingress Egress Gw Global Network List Global Network Connections Slo To Global DR

Deeply nested DR block collapsed for readability.

Ingress Egress Gw Global Network List Global Network Connections Slo To Global DR Global Vn

Deeply nested Vn block collapsed for readability.

Ingress Egress Gw Inside Network

An inside_network block (within ingress_egress_gw) supports the following:

• existing_network - Optional String
Configuration parameter for existing network

• new_network - Optional String
Parameters to create a new GCP VPC Network

• new_network_autogenerate - Optional Object
Create a new GCP VPC Network with autogenerated name

Ingress Egress Gw Inside Network Existing Network

An existing_network block (within ingress_egress_gw.inside_network) supports the following:

• name - Optional String
GCP VPC Network Name. Name for your GCP VPC Network

Ingress Egress Gw Inside Network New Network

A new_network block (within ingress_egress_gw.inside_network) supports the following:

• name - Optional String
GCP VPC Network Name. Name for your GCP VPC Network

Ingress Egress Gw Inside Network New Network Autogenerate

Deeply nested Autogenerate block collapsed for readability.

Ingress Egress Gw Inside Static Routes

An inside_static_routes block (within ingress_egress_gw) supports the following:

• static_route_list - Optional List
List of Static Routes. List of Static routes

Ingress Egress Gw Inside Static Routes Static Route List

Deeply nested List block collapsed for readability.

Ingress Egress Gw Inside Static Routes Static Route List Custom Static Route

Deeply nested Route block collapsed for readability.

Ingress Egress Gw Inside Static Routes Static Route List Custom Static Route Labels

Deeply nested Labels block collapsed for readability.

Ingress Egress Gw Inside Static Routes Static Route List Custom Static Route Nexthop

Deeply nested Nexthop block collapsed for readability.

Ingress Egress Gw Inside Static Routes Static Route List Custom Static Route Nexthop Interface

Deeply nested Interface block collapsed for readability.

Ingress Egress Gw Inside Static Routes Static Route List Custom Static Route Nexthop Nexthop Address

Deeply nested Address block collapsed for readability.

Ingress Egress Gw Inside Static Routes Static Route List Custom Static Route Nexthop Nexthop Address IPv4

Deeply nested IPv4 block collapsed for readability.

Ingress Egress Gw Inside Static Routes Static Route List Custom Static Route Nexthop Nexthop Address IPv6

Deeply nested IPv6 block collapsed for readability.

Ingress Egress Gw Inside Static Routes Static Route List Custom Static Route Subnets

Deeply nested Subnets block collapsed for readability.

Ingress Egress Gw Inside Static Routes Static Route List Custom Static Route Subnets IPv4

Deeply nested IPv4 block collapsed for readability.

Ingress Egress Gw Inside Static Routes Static Route List Custom Static Route Subnets IPv6

Deeply nested IPv6 block collapsed for readability.

Ingress Egress Gw Inside Subnet

An inside_subnet block (within ingress_egress_gw) supports the following:

• existing_subnet - Optional String
Configuration parameter for existing subnet

• new_subnet - Optional String
GCP subnet parameters Type. Parameters for GCP subnet

Ingress Egress Gw Inside Subnet Existing Subnet

An existing_subnet block (within ingress_egress_gw.inside_subnet) supports the following:

• subnet_name - Optional String
VPC Subnet Name. Name of your subnet in VPC network

Ingress Egress Gw Inside Subnet New Subnet

A new_subnet block (within ingress_egress_gw.inside_subnet) supports the following:

• primary_ipv4 - Optional String
IPv4 prefix for this Subnet. It has to be private address space

• subnet_name - Optional String
Name of new VPC Subnet, will be autogenerated if empty

Ingress Egress Gw No Dc Cluster Group

A no_dc_cluster_group block (within ingress_egress_gw) supports the following:

Ingress Egress Gw No Forward Proxy

A no_forward_proxy block (within ingress_egress_gw) supports the following:

Ingress Egress Gw No Global Network

A no_global_network block (within ingress_egress_gw) supports the following:

Ingress Egress Gw No Inside Static Routes

A no_inside_static_routes block (within ingress_egress_gw) supports the following:

Ingress Egress Gw No Network Policy

A no_network_policy block (within ingress_egress_gw) supports the following:

Ingress Egress Gw No Outside Static Routes

A no_outside_static_routes block (within ingress_egress_gw) supports the following:

Ingress Egress Gw Outside Network

An outside_network block (within ingress_egress_gw) supports the following:

• existing_network - Optional String
Configuration parameter for existing network

• new_network - Optional String
Parameters to create a new GCP VPC Network

• new_network_autogenerate - Optional Object
Create a new GCP VPC Network with autogenerated name

Ingress Egress Gw Outside Network Existing Network

An existing_network block (within ingress_egress_gw.outside_network) supports the following:

• name - Optional String
GCP VPC Network Name. Name for your GCP VPC Network

Ingress Egress Gw Outside Network New Network

A new_network block (within ingress_egress_gw.outside_network) supports the following:

• name - Optional String
GCP VPC Network Name. Name for your GCP VPC Network

Ingress Egress Gw Outside Network New Network Autogenerate

Deeply nested Autogenerate block collapsed for readability.

Ingress Egress Gw Outside Static Routes

An outside_static_routes block (within ingress_egress_gw) supports the following:

• static_route_list - Optional List
List of Static Routes. List of Static routes

Ingress Egress Gw Outside Static Routes Static Route List

Deeply nested List block collapsed for readability.

Ingress Egress Gw Outside Static Routes Static Route List Custom Static Route

Deeply nested Route block collapsed for readability.

Ingress Egress Gw Outside Static Routes Static Route List Custom Static Route Labels

Deeply nested Labels block collapsed for readability.

Ingress Egress Gw Outside Static Routes Static Route List Custom Static Route Nexthop

Deeply nested Nexthop block collapsed for readability.

Ingress Egress Gw Outside Static Routes Static Route List Custom Static Route Nexthop Interface

Deeply nested Interface block collapsed for readability.

Ingress Egress Gw Outside Static Routes Static Route List Custom Static Route Nexthop Nexthop Address

Deeply nested Address block collapsed for readability.

Ingress Egress Gw Outside Static Routes Static Route List Custom Static Route Nexthop Nexthop Address IPv4

Deeply nested IPv4 block collapsed for readability.

Ingress Egress Gw Outside Static Routes Static Route List Custom Static Route Nexthop Nexthop Address IPv6

Deeply nested IPv6 block collapsed for readability.

Ingress Egress Gw Outside Static Routes Static Route List Custom Static Route Subnets

Deeply nested Subnets block collapsed for readability.

Ingress Egress Gw Outside Static Routes Static Route List Custom Static Route Subnets IPv4

Deeply nested IPv4 block collapsed for readability.

Ingress Egress Gw Outside Static Routes Static Route List Custom Static Route Subnets IPv6

Deeply nested IPv6 block collapsed for readability.

Ingress Egress Gw Outside Subnet

An outside_subnet block (within ingress_egress_gw) supports the following:

• existing_subnet - Optional String
Configuration parameter for existing subnet

• new_subnet - Optional String
GCP subnet parameters Type. Parameters for GCP subnet

Ingress Egress Gw Outside Subnet Existing Subnet

An existing_subnet block (within ingress_egress_gw.outside_subnet) supports the following:

• subnet_name - Optional String
VPC Subnet Name. Name of your subnet in VPC network

Ingress Egress Gw Outside Subnet New Subnet

A new_subnet block (within ingress_egress_gw.outside_subnet) supports the following:

• primary_ipv4 - Optional String
IPv4 prefix for this Subnet. It has to be private address space

• subnet_name - Optional String
Name of new VPC Subnet, will be autogenerated if empty

Ingress Egress Gw Performance Enhancement Mode

A performance_enhancement_mode block (within ingress_egress_gw) supports the following:

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

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

Ingress Egress Gw Performance Enhancement Mode Perf Mode L3 Enhanced

Deeply nested Enhanced block collapsed for readability.

Ingress Egress Gw Performance Enhancement Mode Perf Mode L3 Enhanced Jumbo

Deeply nested Jumbo block collapsed for readability.

Ingress Egress Gw Performance Enhancement Mode Perf Mode L3 Enhanced No Jumbo

Deeply nested Jumbo block collapsed for readability.

Ingress Egress Gw Performance Enhancement Mode Perf Mode L7 Enhanced

Deeply nested Enhanced block collapsed for readability.

Ingress Egress Gw Performance Enhancement Mode Perf Mode L7 Enhanced Jumbo Disabled

Deeply nested Disabled block collapsed for readability.

Ingress Egress Gw Performance Enhancement Mode Perf Mode L7 Enhanced Jumbo Enabled

Deeply nested Enabled block collapsed for readability.

Ingress Egress Gw Sm Connection Public IP

A sm_connection_public_ip block (within ingress_egress_gw) supports the following:

Ingress Egress Gw Sm Connection Pvt IP

A sm_connection_pvt_ip block (within ingress_egress_gw) supports the following:

Ingress Gw

An ingress_gw block supports the following:

• gcp_certified_hw - Optional String
[Enum: GCP-byol-voltmesh] GCP Certified Hardware. Name for GCP certified hardware. The only possible value is GCP-byol-voltmesh

• gcp_zone_names - Optional List
X-required List of zones when instances will be created, needs to match with region selected

• local_network - Optional String
Defines choice about GCP VPC network for a view

• local_subnet - Optional String
Defines choice about GCP VPC network for a view

• node_number - Optional Number
Number of main nodes to create, either 1 or 3

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

Ingress Gw Local Network

A local_network block (within ingress_gw) supports the following:

• existing_network - Optional String
Configuration parameter for existing network

• new_network - Optional String
Parameters to create a new GCP VPC Network

• new_network_autogenerate - Optional Object
Create a new GCP VPC Network with autogenerated name

Ingress Gw Local Network Existing Network

An existing_network block (within ingress_gw.local_network) supports the following:

• name - Optional String
GCP VPC Network Name. Name for your GCP VPC Network

Ingress Gw Local Network New Network

A new_network block (within ingress_gw.local_network) supports the following:

• name - Optional String
GCP VPC Network Name. Name for your GCP VPC Network

Ingress Gw Local Network New Network Autogenerate

A new_network_autogenerate block (within ingress_gw.local_network) supports the following:

Ingress Gw Local Subnet

A local_subnet block (within ingress_gw) supports the following:

• existing_subnet - Optional String
Configuration parameter for existing subnet

• new_subnet - Optional String
GCP subnet parameters Type. Parameters for GCP subnet

Ingress Gw Local Subnet Existing Subnet

An existing_subnet block (within ingress_gw.local_subnet) supports the following:

• subnet_name - Optional String
VPC Subnet Name. Name of your subnet in VPC network

Ingress Gw Local Subnet New Subnet

A new_subnet block (within ingress_gw.local_subnet) supports the following:

• primary_ipv4 - Optional String
IPv4 prefix for this Subnet. It has to be private address space

• subnet_name - Optional String
Name of new VPC Subnet, will be autogenerated if empty

Ingress Gw Performance Enhancement Mode

A performance_enhancement_mode block (within ingress_gw) supports the following:

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

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

Ingress Gw Performance Enhancement Mode Perf Mode L3 Enhanced

Deeply nested Enhanced block collapsed for readability.

Ingress Gw Performance Enhancement Mode Perf Mode L3 Enhanced Jumbo

Deeply nested Jumbo block collapsed for readability.

Ingress Gw Performance Enhancement Mode Perf Mode L3 Enhanced No Jumbo

Deeply nested Jumbo block collapsed for readability.

Ingress Gw Performance Enhancement Mode Perf Mode L7 Enhanced

Deeply nested Enhanced block collapsed for readability.

Ingress Gw Performance Enhancement Mode Perf Mode L7 Enhanced Jumbo Disabled

Deeply nested Disabled block collapsed for readability.

Ingress Gw Performance Enhancement Mode Perf Mode L7 Enhanced Jumbo Enabled

Deeply nested Enabled block collapsed for readability.

Kubernetes Upgrade Drain

A kubernetes_upgrade_drain block supports the following:

• disable_upgrade_drain - Optional Object
Configuration parameter for disable upgrade drain

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

Kubernetes Upgrade Drain Disable Upgrade Drain

A disable_upgrade_drain block (within kubernetes_upgrade_drain) supports the following:

Kubernetes Upgrade Drain Enable Upgrade Drain

An enable_upgrade_drain block (within kubernetes_upgrade_drain) supports the following:

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

• drain_max_unavailable_node_count - Optional Number
Node Batch Size Count

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

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

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

Kubernetes Upgrade Drain Enable Upgrade Drain Disable Vega Upgrade Mode

Deeply nested Mode block collapsed for readability.

Kubernetes Upgrade Drain Enable Upgrade Drain Enable Vega Upgrade Mode

Deeply nested Mode block collapsed for readability.

Log Receiver

A log_receiver block supports the following:

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

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

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

Logs Streaming Disabled

A logs_streaming_disabled block supports the following:

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:

Private Connect Disabled

A private_connect_disabled block supports the following:

Private Connectivity

A private_connectivity block supports the following:

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

• inside - Optional Object
Enable this option

• outside - Optional Object
Enable this option

Private Connectivity Cloud Link

A cloud_link block (within private_connectivity) 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

Private Connectivity Inside

An inside block (within private_connectivity) supports the following:

Private Connectivity Outside

An outside block (within private_connectivity) supports the following:

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:

Voltstack Cluster

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

• 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

• default_storage - Optional Object
Configuration parameter for default storage

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

• gcp_certified_hw - Optional String
[Enum: GCP-byol-voltstack-combo] GCP Certified Hardware. Name for GCP certified hardware. The only possible value is GCP-byol-voltstack-combo

• gcp_zone_names - Optional List
X-required List of zones when instances will be created, needs to match with region selected

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

• 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

• no_dc_cluster_group - Optional Object
Enable this option

• no_forward_proxy - Optional Object
Configuration parameter for no forward proxy

• no_global_network - Optional Object
Configuration parameter for no global network

• no_k8s_cluster - Optional Object
Enable this option

• no_network_policy - Optional Object
Policy configuration for this feature

• no_outside_static_routes - Optional Object
Configuration parameter for no outside static routes

• node_number - Optional Number
Number of main nodes to create, either 1 or 3

• outside_static_routes - Optional String
Configuration parameter for outside static routes

• site_local_network - Optional String
Defines choice about GCP VPC network for a view

• site_local_subnet - Optional String
Defines choice about GCP VPC network for a view

• sm_connection_public_ip - Optional Object
Enable this option

• sm_connection_pvt_ip - Optional Object
Enable this option

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

Voltstack Cluster Active Enhanced Firewall Policies

An active_enhanced_firewall_policies block (within voltstack_cluster) supports the following:

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

Voltstack Cluster Active Enhanced Firewall Policies Enhanced Firewall Policies

Deeply nested Policies block collapsed for readability.

Voltstack Cluster Active Forward Proxy Policies

An active_forward_proxy_policies block (within voltstack_cluster) supports the following:

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

Voltstack Cluster Active Forward Proxy Policies Forward Proxy Policies

Deeply nested Policies block collapsed for readability.

Voltstack Cluster Active Network Policies

An active_network_policies block (within voltstack_cluster) supports the following:

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

Voltstack Cluster Active Network Policies Network Policies

A network_policies block (within voltstack_cluster.active_network_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

Voltstack Cluster Dc Cluster Group

A dc_cluster_group block (within voltstack_cluster) 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

Voltstack Cluster Default Storage

A default_storage block (within voltstack_cluster) supports the following:

Voltstack Cluster Forward Proxy Allow All

A forward_proxy_allow_all block (within voltstack_cluster) supports the following:

Voltstack Cluster Global Network List

A global_network_list block (within voltstack_cluster) supports the following:

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

Voltstack Cluster Global Network List Global Network Connections

Deeply nested Connections block collapsed for readability.

Voltstack Cluster Global Network List Global Network Connections SLI To Global DR

Deeply nested DR block collapsed for readability.

Voltstack Cluster Global Network List Global Network Connections SLI To Global DR Global Vn

Deeply nested Vn block collapsed for readability.

Voltstack Cluster Global Network List Global Network Connections Slo To Global DR

Deeply nested DR block collapsed for readability.

Voltstack Cluster Global Network List Global Network Connections Slo To Global DR Global Vn

Deeply nested Vn block collapsed for readability.

Voltstack Cluster K8S Cluster

A k8s_cluster block (within voltstack_cluster) 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

Voltstack Cluster No Dc Cluster Group

A no_dc_cluster_group block (within voltstack_cluster) supports the following:

Voltstack Cluster No Forward Proxy

A no_forward_proxy block (within voltstack_cluster) supports the following:

Voltstack Cluster No Global Network

A no_global_network block (within voltstack_cluster) supports the following:

Voltstack Cluster No K8S Cluster

A no_k8s_cluster block (within voltstack_cluster) supports the following:

Voltstack Cluster No Network Policy

A no_network_policy block (within voltstack_cluster) supports the following:

Voltstack Cluster No Outside Static Routes

A no_outside_static_routes block (within voltstack_cluster) supports the following:

Voltstack Cluster Outside Static Routes

An outside_static_routes block (within voltstack_cluster) supports the following:

• static_route_list - Optional List
List of Static Routes. List of Static routes

Voltstack Cluster Outside Static Routes Static Route List

Deeply nested List block collapsed for readability.

Voltstack Cluster Outside Static Routes Static Route List Custom Static Route

Deeply nested Route block collapsed for readability.

Voltstack Cluster Outside Static Routes Static Route List Custom Static Route Labels

Deeply nested Labels block collapsed for readability.

Voltstack Cluster Outside Static Routes Static Route List Custom Static Route Nexthop

Deeply nested Nexthop block collapsed for readability.

Voltstack Cluster Outside Static Routes Static Route List Custom Static Route Nexthop Interface

Deeply nested Interface block collapsed for readability.

Voltstack Cluster Outside Static Routes Static Route List Custom Static Route Nexthop Nexthop Address

Deeply nested Address block collapsed for readability.

Voltstack Cluster Outside Static Routes Static Route List Custom Static Route Nexthop Nexthop Address IPv4

Deeply nested IPv4 block collapsed for readability.

Voltstack Cluster Outside Static Routes Static Route List Custom Static Route Nexthop Nexthop Address IPv6

Deeply nested IPv6 block collapsed for readability.

Voltstack Cluster Outside Static Routes Static Route List Custom Static Route Subnets

Deeply nested Subnets block collapsed for readability.

Voltstack Cluster Outside Static Routes Static Route List Custom Static Route Subnets IPv4

Deeply nested IPv4 block collapsed for readability.

Voltstack Cluster Outside Static Routes Static Route List Custom Static Route Subnets IPv6

Deeply nested IPv6 block collapsed for readability.

Voltstack Cluster Site Local Network

A site_local_network block (within voltstack_cluster) supports the following:

• existing_network - Optional String
Configuration parameter for existing network

• new_network - Optional String
Parameters to create a new GCP VPC Network

• new_network_autogenerate - Optional Object
Create a new GCP VPC Network with autogenerated name

Voltstack Cluster Site Local Network Existing Network

An existing_network block (within voltstack_cluster.site_local_network) supports the following:

• name - Optional String
GCP VPC Network Name. Name for your GCP VPC Network

Voltstack Cluster Site Local Network New Network

A new_network block (within voltstack_cluster.site_local_network) supports the following:

• name - Optional String
GCP VPC Network Name. Name for your GCP VPC Network

Voltstack Cluster Site Local Network New Network Autogenerate

Deeply nested Autogenerate block collapsed for readability.

Voltstack Cluster Site Local Subnet

A site_local_subnet block (within voltstack_cluster) supports the following:

• existing_subnet - Optional String
Configuration parameter for existing subnet

• new_subnet - Optional String
GCP subnet parameters Type. Parameters for GCP subnet

Voltstack Cluster Site Local Subnet Existing Subnet

An existing_subnet block (within voltstack_cluster.site_local_subnet) supports the following:

• subnet_name - Optional String
VPC Subnet Name. Name of your subnet in VPC network

Voltstack Cluster Site Local Subnet New Subnet

A new_subnet block (within voltstack_cluster.site_local_subnet) supports the following:

• primary_ipv4 - Optional String
IPv4 prefix for this Subnet. It has to be private address space

• subnet_name - Optional String
Name of new VPC Subnet, will be autogenerated if empty

Voltstack Cluster Sm Connection Public IP

A sm_connection_public_ip block (within voltstack_cluster) supports the following:

Voltstack Cluster Sm Connection Pvt IP

A sm_connection_pvt_ip block (within voltstack_cluster) supports the following:

Voltstack Cluster Storage Class List

A storage_class_list block (within voltstack_cluster) supports the following:

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

Voltstack Cluster Storage Class List Storage Classes

A storage_classes block (within voltstack_cluster.storage_class_list) supports the following:

• default_storage_class - Optional Bool
Make this storage class default storage class for the K8S cluster

• storage_class_name - Optional String
Name of the storage class as it will appear in K8S

---

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