@robinmordasiewicz/f5xc-terraform-mcp 2.6.1 → 2.6.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/docs/data-sources/addon_subscription.md +85 -2
- package/dist/docs/data-sources/address_allocator.md +85 -2
- package/dist/docs/data-sources/advertise_policy.md +85 -2
- package/dist/docs/data-sources/alert_policy.md +85 -2
- package/dist/docs/data-sources/alert_receiver.md +85 -2
- package/dist/docs/data-sources/allowed_tenant.md +85 -2
- package/dist/docs/data-sources/api_crawler.md +85 -2
- package/dist/docs/data-sources/api_credential.md +85 -2
- package/dist/docs/data-sources/api_definition.md +85 -2
- package/dist/docs/data-sources/api_discovery.md +85 -2
- package/dist/docs/data-sources/api_testing.md +85 -2
- package/dist/docs/data-sources/apm.md +85 -2
- package/dist/docs/data-sources/app_api_group.md +85 -2
- package/dist/docs/data-sources/app_firewall.md +85 -2
- package/dist/docs/data-sources/app_setting.md +85 -2
- package/dist/docs/data-sources/app_type.md +85 -2
- package/dist/docs/data-sources/authentication.md +85 -2
- package/dist/docs/data-sources/aws_tgw_site.md +85 -2
- package/dist/docs/data-sources/aws_vpc_site.md +85 -2
- package/dist/docs/data-sources/azure_vnet_site.md +85 -2
- package/dist/docs/data-sources/bgp.md +85 -2
- package/dist/docs/data-sources/bgp_asn_set.md +85 -2
- package/dist/docs/data-sources/bgp_routing_policy.md +85 -2
- package/dist/docs/data-sources/bigip_irule.md +85 -2
- package/dist/docs/data-sources/bot_defense_app_infrastructure.md +85 -2
- package/dist/docs/data-sources/cdn_cache_rule.md +85 -2
- package/dist/docs/data-sources/cdn_loadbalancer.md +85 -2
- package/dist/docs/data-sources/certificate.md +85 -2
- package/dist/docs/data-sources/certificate_chain.md +85 -2
- package/dist/docs/data-sources/child_tenant.md +85 -2
- package/dist/docs/data-sources/child_tenant_manager.md +85 -2
- package/dist/docs/data-sources/cloud_connect.md +85 -2
- package/dist/docs/data-sources/cloud_credentials.md +85 -2
- package/dist/docs/data-sources/cloud_elastic_ip.md +85 -2
- package/dist/docs/data-sources/cloud_link.md +85 -2
- package/dist/docs/data-sources/cluster.md +85 -2
- package/dist/docs/data-sources/cminstance.md +85 -2
- package/dist/docs/data-sources/code_base_integration.md +85 -2
- package/dist/docs/data-sources/contact.md +85 -2
- package/dist/docs/data-sources/container_registry.md +85 -2
- package/dist/docs/data-sources/crl.md +85 -2
- package/dist/docs/data-sources/customer_support.md +85 -2
- package/dist/docs/data-sources/data_group.md +85 -2
- package/dist/docs/data-sources/data_type.md +85 -2
- package/dist/docs/data-sources/dc_cluster_group.md +85 -2
- package/dist/docs/data-sources/discovery.md +85 -2
- package/dist/docs/data-sources/dns_compliance_checks.md +85 -2
- package/dist/docs/data-sources/dns_domain.md +85 -2
- package/dist/docs/data-sources/dns_lb_health_check.md +85 -2
- package/dist/docs/data-sources/dns_lb_pool.md +85 -2
- package/dist/docs/data-sources/dns_load_balancer.md +85 -2
- package/dist/docs/data-sources/dns_zone.md +85 -2
- package/dist/docs/data-sources/endpoint.md +85 -2
- package/dist/docs/data-sources/enhanced_firewall_policy.md +85 -2
- package/dist/docs/data-sources/external_connector.md +85 -2
- package/dist/docs/data-sources/fast_acl.md +85 -2
- package/dist/docs/data-sources/fast_acl_rule.md +85 -2
- package/dist/docs/data-sources/filter_set.md +85 -2
- package/dist/docs/data-sources/fleet.md +85 -2
- package/dist/docs/data-sources/forward_proxy_policy.md +85 -2
- package/dist/docs/data-sources/forwarding_class.md +85 -2
- package/dist/docs/data-sources/gcp_vpc_site.md +85 -2
- package/dist/docs/data-sources/geo_location_set.md +85 -2
- package/dist/docs/data-sources/global_log_receiver.md +85 -2
- package/dist/docs/data-sources/healthcheck.md +85 -2
- package/dist/docs/data-sources/http_loadbalancer.md +85 -2
- package/dist/docs/data-sources/ike1.md +85 -2
- package/dist/docs/data-sources/ike2.md +85 -2
- package/dist/docs/data-sources/ike_phase1_profile.md +85 -2
- package/dist/docs/data-sources/ike_phase2_profile.md +85 -2
- package/dist/docs/data-sources/infraprotect_asn.md +85 -2
- package/dist/docs/data-sources/infraprotect_asn_prefix.md +85 -2
- package/dist/docs/data-sources/infraprotect_deny_list_rule.md +85 -2
- package/dist/docs/data-sources/infraprotect_firewall_rule.md +85 -2
- package/dist/docs/data-sources/infraprotect_firewall_rule_group.md +85 -2
- package/dist/docs/data-sources/infraprotect_internet_prefix_advertisement.md +85 -2
- package/dist/docs/data-sources/infraprotect_tunnel.md +85 -2
- package/dist/docs/data-sources/ip_prefix_set.md +85 -2
- package/dist/docs/data-sources/irule.md +85 -2
- package/dist/docs/data-sources/k8s_cluster.md +85 -2
- package/dist/docs/data-sources/k8s_cluster_role.md +85 -2
- package/dist/docs/data-sources/k8s_cluster_role_binding.md +85 -2
- package/dist/docs/data-sources/k8s_pod_security_admission.md +85 -2
- package/dist/docs/data-sources/k8s_pod_security_policy.md +85 -2
- package/dist/docs/data-sources/log_receiver.md +85 -2
- package/dist/docs/data-sources/malicious_user_mitigation.md +85 -2
- package/dist/docs/data-sources/managed_tenant.md +85 -2
- package/dist/docs/data-sources/namespace.md +85 -2
- package/dist/docs/data-sources/nat_policy.md +85 -2
- package/dist/docs/data-sources/network_connector.md +85 -2
- package/dist/docs/data-sources/network_firewall.md +85 -2
- package/dist/docs/data-sources/network_interface.md +85 -2
- package/dist/docs/data-sources/network_policy.md +85 -2
- package/dist/docs/data-sources/network_policy_rule.md +85 -2
- package/dist/docs/data-sources/network_policy_view.md +85 -2
- package/dist/docs/data-sources/nfv_service.md +85 -2
- package/dist/docs/data-sources/oidc_provider.md +85 -2
- package/dist/docs/data-sources/origin_pool.md +85 -2
- package/dist/docs/data-sources/policer.md +85 -2
- package/dist/docs/data-sources/policy_based_routing.md +85 -2
- package/dist/docs/data-sources/protocol_inspection.md +85 -2
- package/dist/docs/data-sources/protocol_policer.md +85 -2
- package/dist/docs/data-sources/proxy.md +85 -2
- package/dist/docs/data-sources/quota.md +85 -2
- package/dist/docs/data-sources/rate_limiter.md +85 -2
- package/dist/docs/data-sources/rate_limiter_policy.md +85 -2
- package/dist/docs/data-sources/registration.md +85 -2
- package/dist/docs/data-sources/report_config.md +85 -2
- package/dist/docs/data-sources/role.md +85 -2
- package/dist/docs/data-sources/route.md +85 -2
- package/dist/docs/data-sources/secret_management_access.md +85 -2
- package/dist/docs/data-sources/secret_policy.md +85 -2
- package/dist/docs/data-sources/secret_policy_rule.md +85 -2
- package/dist/docs/data-sources/securemesh_site.md +85 -2
- package/dist/docs/data-sources/securemesh_site_v2.md +85 -2
- package/dist/docs/data-sources/segment.md +85 -2
- package/dist/docs/data-sources/sensitive_data_policy.md +85 -2
- package/dist/docs/data-sources/service_policy.md +85 -2
- package/dist/docs/data-sources/service_policy_rule.md +85 -2
- package/dist/docs/data-sources/site_mesh_group.md +85 -2
- package/dist/docs/data-sources/srv6_network_slice.md +85 -2
- package/dist/docs/data-sources/subnet.md +85 -2
- package/dist/docs/data-sources/tcp_loadbalancer.md +85 -2
- package/dist/docs/data-sources/tenant_configuration.md +85 -2
- package/dist/docs/data-sources/tenant_profile.md +85 -2
- package/dist/docs/data-sources/ticket_tracking_system.md +85 -2
- package/dist/docs/data-sources/token.md +85 -2
- package/dist/docs/data-sources/tpm_api_key.md +85 -2
- package/dist/docs/data-sources/tpm_category.md +85 -2
- package/dist/docs/data-sources/tpm_manager.md +85 -2
- package/dist/docs/data-sources/trusted_ca_list.md +85 -2
- package/dist/docs/data-sources/tunnel.md +85 -2
- package/dist/docs/data-sources/udp_loadbalancer.md +85 -2
- package/dist/docs/data-sources/usb_policy.md +85 -2
- package/dist/docs/data-sources/user_identification.md +85 -2
- package/dist/docs/data-sources/virtual_host.md +85 -2
- package/dist/docs/data-sources/virtual_k8s.md +85 -2
- package/dist/docs/data-sources/virtual_network.md +85 -2
- package/dist/docs/data-sources/virtual_site.md +85 -2
- package/dist/docs/data-sources/voltshare_admin_policy.md +85 -2
- package/dist/docs/data-sources/voltstack_site.md +85 -2
- package/dist/docs/data-sources/waf_exclusion_policy.md +85 -2
- package/dist/docs/data-sources/workload.md +85 -2
- package/dist/docs/data-sources/workload_flavor.md +85 -2
- package/dist/docs/resources/addon_subscription.md +87 -10
- package/dist/docs/resources/address_allocator.md +86 -3
- package/dist/docs/resources/advertise_policy.md +112 -57
- package/dist/docs/resources/alert_policy.md +91 -8
- package/dist/docs/resources/alert_receiver.md +94 -55
- package/dist/docs/resources/allowed_tenant.md +87 -10
- package/dist/docs/resources/api_crawler.md +86 -3
- package/dist/docs/resources/api_credential.md +88 -5
- package/dist/docs/resources/api_definition.md +89 -6
- package/dist/docs/resources/api_discovery.md +86 -3
- package/dist/docs/resources/api_testing.md +95 -52
- package/dist/docs/resources/apm.md +156 -519
- package/dist/docs/resources/app_api_group.md +90 -25
- package/dist/docs/resources/app_firewall.md +87 -6
- package/dist/docs/resources/app_setting.md +97 -66
- package/dist/docs/resources/app_type.md +86 -3
- package/dist/docs/resources/authentication.md +90 -27
- package/dist/docs/resources/aws_tgw_site.md +125 -222
- package/dist/docs/resources/aws_vpc_site.md +149 -352
- package/dist/docs/resources/azure_vnet_site.md +233 -860
- package/dist/docs/resources/bgp.md +103 -32
- package/dist/docs/resources/bgp_asn_set.md +86 -3
- package/dist/docs/resources/bgp_routing_policy.md +86 -3
- package/dist/docs/resources/bigip_irule.md +86 -3
- package/dist/docs/resources/bot_defense_app_infrastructure.md +86 -3
- package/dist/docs/resources/cdn_cache_rule.md +97 -120
- package/dist/docs/resources/cdn_loadbalancer.md +325 -1620
- package/dist/docs/resources/certificate.md +87 -10
- package/dist/docs/resources/certificate_chain.md +86 -3
- package/dist/docs/resources/child_tenant.md +88 -17
- package/dist/docs/resources/child_tenant_manager.md +88 -17
- package/dist/docs/resources/cloud_connect.md +98 -63
- package/dist/docs/resources/cloud_credentials.md +92 -39
- package/dist/docs/resources/cloud_elastic_ip.md +91 -8
- package/dist/docs/resources/cloud_link.md +90 -29
- package/dist/docs/resources/cluster.md +109 -66
- package/dist/docs/resources/cminstance.md +86 -3
- package/dist/docs/resources/code_base_integration.md +100 -87
- package/dist/docs/resources/contact.md +86 -3
- package/dist/docs/resources/container_registry.md +86 -3
- package/dist/docs/resources/crl.md +86 -3
- package/dist/docs/resources/customer_support.md +91 -8
- package/dist/docs/resources/data_group.md +86 -3
- package/dist/docs/resources/data_type.md +88 -9
- package/dist/docs/resources/dc_cluster_group.md +86 -3
- package/dist/docs/resources/discovery.md +115 -104
- package/dist/docs/resources/dns_compliance_checks.md +86 -3
- package/dist/docs/resources/dns_domain.md +86 -3
- package/dist/docs/resources/dns_lb_health_check.md +86 -3
- package/dist/docs/resources/dns_lb_pool.md +87 -10
- package/dist/docs/resources/dns_load_balancer.md +95 -40
- package/dist/docs/resources/dns_zone.md +111 -926
- package/dist/docs/resources/endpoint.md +101 -18
- package/dist/docs/resources/enhanced_firewall_policy.md +89 -32
- package/dist/docs/resources/external_connector.md +94 -29
- package/dist/docs/resources/fast_acl.md +100 -101
- package/dist/docs/resources/fast_acl_rule.md +101 -18
- package/dist/docs/resources/filter_set.md +86 -3
- package/dist/docs/resources/fleet.md +170 -541
- package/dist/docs/resources/forward_proxy_policy.md +90 -31
- package/dist/docs/resources/forwarding_class.md +87 -10
- package/dist/docs/resources/gcp_vpc_site.md +141 -328
- package/dist/docs/resources/geo_location_set.md +86 -3
- package/dist/docs/resources/global_log_receiver.md +116 -181
- package/dist/docs/resources/healthcheck.md +86 -3
- package/dist/docs/resources/http_loadbalancer.md +523 -2778
- package/dist/docs/resources/ike1.md +86 -3
- package/dist/docs/resources/ike2.md +86 -3
- package/dist/docs/resources/ike_phase1_profile.md +86 -3
- package/dist/docs/resources/ike_phase2_profile.md +86 -3
- package/dist/docs/resources/infraprotect_asn.md +86 -3
- package/dist/docs/resources/infraprotect_asn_prefix.md +87 -10
- package/dist/docs/resources/infraprotect_deny_list_rule.md +86 -3
- package/dist/docs/resources/infraprotect_firewall_rule.md +86 -3
- package/dist/docs/resources/infraprotect_firewall_rule_group.md +86 -3
- package/dist/docs/resources/infraprotect_internet_prefix_advertisement.md +86 -3
- package/dist/docs/resources/infraprotect_tunnel.md +90 -29
- package/dist/docs/resources/ip_prefix_set.md +86 -3
- package/dist/docs/resources/irule.md +86 -3
- package/dist/docs/resources/k8s_cluster.md +93 -58
- package/dist/docs/resources/k8s_cluster_role.md +87 -8
- package/dist/docs/resources/k8s_cluster_role_binding.md +87 -10
- package/dist/docs/resources/k8s_pod_security_admission.md +86 -3
- package/dist/docs/resources/k8s_pod_security_policy.md +87 -8
- package/dist/docs/resources/log_receiver.md +88 -15
- package/dist/docs/resources/malicious_user_mitigation.md +86 -3
- package/dist/docs/resources/managed_tenant.md +89 -12
- package/dist/docs/resources/namespace.md +86 -3
- package/dist/docs/resources/nat_policy.md +126 -43
- package/dist/docs/resources/network_connector.md +94 -51
- package/dist/docs/resources/network_firewall.md +90 -31
- package/dist/docs/resources/network_interface.md +93 -46
- package/dist/docs/resources/network_policy.md +96 -13
- package/dist/docs/resources/network_policy_rule.md +91 -8
- package/dist/docs/resources/network_policy_view.md +96 -13
- package/dist/docs/resources/nfv_service.md +153 -446
- package/dist/docs/resources/oidc_provider.md +86 -3
- package/dist/docs/resources/origin_pool.md +108 -145
- package/dist/docs/resources/policer.md +86 -3
- package/dist/docs/resources/policy_based_routing.md +100 -89
- package/dist/docs/resources/protocol_inspection.md +87 -10
- package/dist/docs/resources/protocol_policer.md +91 -8
- package/dist/docs/resources/proxy.md +154 -571
- package/dist/docs/resources/quota.md +86 -3
- package/dist/docs/resources/rate_limiter.md +91 -8
- package/dist/docs/resources/rate_limiter_policy.md +100 -23
- package/dist/docs/resources/registration.md +86 -3
- package/dist/docs/resources/report_config.md +87 -10
- package/dist/docs/resources/role.md +86 -3
- package/dist/docs/resources/route.md +113 -82
- package/dist/docs/resources/secret_management_access.md +127 -156
- package/dist/docs/resources/secret_policy.md +87 -4
- package/dist/docs/resources/secret_policy_rule.md +86 -3
- package/dist/docs/resources/securemesh_site.md +137 -380
- package/dist/docs/resources/securemesh_site_v2.md +289 -1204
- package/dist/docs/resources/segment.md +86 -3
- package/dist/docs/resources/sensitive_data_policy.md +87 -10
- package/dist/docs/resources/service_policy.md +115 -122
- package/dist/docs/resources/service_policy_rule.md +110 -59
- package/dist/docs/resources/site_mesh_group.md +92 -15
- package/dist/docs/resources/srv6_network_slice.md +86 -3
- package/dist/docs/resources/subnet.md +89 -20
- package/dist/docs/resources/tcp_loadbalancer.md +114 -185
- package/dist/docs/resources/tenant_configuration.md +86 -3
- package/dist/docs/resources/tenant_profile.md +87 -10
- package/dist/docs/resources/ticket_tracking_system.md +86 -3
- package/dist/docs/resources/token.md +86 -3
- package/dist/docs/resources/tpm_api_key.md +91 -8
- package/dist/docs/resources/tpm_category.md +91 -8
- package/dist/docs/resources/tpm_manager.md +86 -3
- package/dist/docs/resources/trusted_ca_list.md +86 -3
- package/dist/docs/resources/tunnel.md +91 -8
- package/dist/docs/resources/udp_loadbalancer.md +97 -80
- package/dist/docs/resources/usb_policy.md +86 -3
- package/dist/docs/resources/user_identification.md +86 -3
- package/dist/docs/resources/virtual_host.md +152 -177
- package/dist/docs/resources/virtual_k8s.md +92 -15
- package/dist/docs/resources/virtual_network.md +91 -8
- package/dist/docs/resources/virtual_site.md +86 -3
- package/dist/docs/resources/voltshare_admin_policy.md +86 -11
- package/dist/docs/resources/voltstack_site.md +380 -1365
- package/dist/docs/resources/waf_exclusion_policy.md +91 -28
- package/dist/docs/resources/workload.md +1189 -4148
- package/dist/docs/resources/workload_flavor.md +86 -3
- package/package.json +1 -1
|
@@ -2,12 +2,12 @@
|
|
|
2
2
|
page_title: "f5xc_subnet Resource - terraform-provider-f5xc"
|
|
3
3
|
subcategory: "Networking"
|
|
4
4
|
description: |-
|
|
5
|
-
|
|
5
|
+
Manages a Subnet resource in F5 Distributed Cloud for subnet object contains configuration for an interface of a vm/pod. it is created in user or shared namespace. configuration.
|
|
6
6
|
---
|
|
7
7
|
|
|
8
8
|
# f5xc_subnet (Resource)
|
|
9
9
|
|
|
10
|
-
|
|
10
|
+
Manages a Subnet resource in F5 Distributed Cloud for subnet object contains configuration for an interface of a vm/pod. it is created in user or shared namespace. configuration.
|
|
11
11
|
|
|
12
12
|
~> **Note** Please refer to [Subnet API docs](https://docs.cloud.f5.com/docs-v2/api/subnet) to learn more.
|
|
13
13
|
|
|
@@ -15,7 +15,7 @@ description: |-
|
|
|
15
15
|
|
|
16
16
|
```terraform
|
|
17
17
|
# Subnet Resource Example
|
|
18
|
-
#
|
|
18
|
+
# Manages a Subnet resource in F5 Distributed Cloud for subnet object contains configuration for an interface of a vm/pod. it is created in user or shared namespace. configuration.
|
|
19
19
|
|
|
20
20
|
# Basic Subnet configuration
|
|
21
21
|
resource "f5xc_subnet" "example" {
|
|
@@ -91,13 +91,7 @@ A [`connect_to_layer2`](#connect-to-layer2) block supports the following:
|
|
|
91
91
|
|
|
92
92
|
#### Connect To Layer2 Layer2 Intf Ref
|
|
93
93
|
|
|
94
|
-
|
|
95
|
-
|
|
96
|
-
<a id="connect-to-layer2-layer2-intf-ref-name"></a>• [`name`](#connect-to-layer2-layer2-intf-ref-name) - Optional String<br>Name. 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
|
|
97
|
-
|
|
98
|
-
<a id="namespace-afda4a"></a>• [`namespace`](#namespace-afda4a) - Optional String<br>Namespace. 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
|
|
99
|
-
|
|
100
|
-
<a id="tenant-0fab0d"></a>• [`tenant`](#tenant-0fab0d) - Optional String<br>Tenant. 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
|
|
94
|
+
<a id="objref-6ea749"></a>Uses standard [Object Reference](#common-object-reference) fields (name, namespace, tenant).
|
|
101
95
|
|
|
102
96
|
#### Site Subnet Params
|
|
103
97
|
|
|
@@ -113,13 +107,7 @@ A [`site_subnet_params`](#site-subnet-params) block supports the following:
|
|
|
113
107
|
|
|
114
108
|
#### Site Subnet Params Site
|
|
115
109
|
|
|
116
|
-
|
|
117
|
-
|
|
118
|
-
<a id="site-subnet-params-site-name"></a>• [`name`](#site-subnet-params-site-name) - Optional String<br>Name. 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
|
|
119
|
-
|
|
120
|
-
<a id="site-subnet-params-site-namespace"></a>• [`namespace`](#site-subnet-params-site-namespace) - Optional String<br>Namespace. 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
|
|
121
|
-
|
|
122
|
-
<a id="site-subnet-params-site-tenant"></a>• [`tenant`](#site-subnet-params-site-tenant) - Optional String<br>Tenant. 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
|
|
110
|
+
<a id="objref-fdf6de"></a>Uses standard [Object Reference](#common-object-reference) fields (name, namespace, tenant).
|
|
123
111
|
|
|
124
112
|
#### Site Subnet Params Subnet DHCP Server Params
|
|
125
113
|
|
|
@@ -129,9 +117,7 @@ A [`subnet_dhcp_server_params`](#params-2a5102) block (within [`site_subnet_para
|
|
|
129
117
|
|
|
130
118
|
#### Site Subnet Params Subnet DHCP Server Params DHCP Networks
|
|
131
119
|
|
|
132
|
-
|
|
133
|
-
|
|
134
|
-
<a id="prefix-1fa00d"></a>• [`network_prefix`](#prefix-1fa00d) - Optional String<br>Network Prefix. Network prefix for subnet
|
|
120
|
+
<a id="deep-0d5553"></a>Deeply nested **Networks** block collapsed for readability.
|
|
135
121
|
|
|
136
122
|
#### Timeouts
|
|
137
123
|
|
|
@@ -145,6 +131,89 @@ A [`timeouts`](#timeouts) block supports the following:
|
|
|
145
131
|
|
|
146
132
|
<a id="timeouts-update"></a>• [`update`](#timeouts-update) - Optional String (Defaults to `10 minutes`)<br>Used when updating the resource
|
|
147
133
|
|
|
134
|
+
---
|
|
135
|
+
|
|
136
|
+
## Common Types
|
|
137
|
+
|
|
138
|
+
The following type definitions are used throughout this resource. See the full definition here rather than repeated inline.
|
|
139
|
+
|
|
140
|
+
### Object Reference {#common-object-reference}
|
|
141
|
+
|
|
142
|
+
Object references establish a direct reference from one configuration object to another in F5 Distributed Cloud. References use the format `tenant/namespace/name`.
|
|
143
|
+
|
|
144
|
+
| Field | Type | Description |
|
|
145
|
+
| ----- | ---- | ----------- |
|
|
146
|
+
| `name` | String | Name of the referenced object |
|
|
147
|
+
| `namespace` | String | Namespace containing the referenced object |
|
|
148
|
+
| `tenant` | String | Tenant of the referenced object (system-managed) |
|
|
149
|
+
|
|
150
|
+
### Transformers {#common-transformers}
|
|
151
|
+
|
|
152
|
+
Transformers apply transformations to input values before matching. Multiple transformers can be applied in order.
|
|
153
|
+
|
|
154
|
+
| Value | Description |
|
|
155
|
+
| ----- | ----------- |
|
|
156
|
+
| `LOWER_CASE` | Convert to lowercase |
|
|
157
|
+
| `UPPER_CASE` | Convert to uppercase |
|
|
158
|
+
| `BASE64_DECODE` | Decode base64 content |
|
|
159
|
+
| `NORMALIZE_PATH` | Normalize URL path |
|
|
160
|
+
| `REMOVE_WHITESPACE` | Remove whitespace characters |
|
|
161
|
+
| `URL_DECODE` | Decode URL-encoded characters |
|
|
162
|
+
| `TRIM_LEFT` | Trim leading whitespace |
|
|
163
|
+
| `TRIM_RIGHT` | Trim trailing whitespace |
|
|
164
|
+
| `TRIM` | Trim both leading and trailing whitespace |
|
|
165
|
+
|
|
166
|
+
### HTTP Methods {#common-http-methods}
|
|
167
|
+
|
|
168
|
+
HTTP methods used for request matching.
|
|
169
|
+
|
|
170
|
+
| Value | Description |
|
|
171
|
+
| ----- | ----------- |
|
|
172
|
+
| `ANY` | Match any HTTP method |
|
|
173
|
+
| `GET` | HTTP GET request |
|
|
174
|
+
| `HEAD` | HTTP HEAD request |
|
|
175
|
+
| `POST` | HTTP POST request |
|
|
176
|
+
| `PUT` | HTTP PUT request |
|
|
177
|
+
| `DELETE` | HTTP DELETE request |
|
|
178
|
+
| `CONNECT` | HTTP CONNECT request |
|
|
179
|
+
| `OPTIONS` | HTTP OPTIONS request |
|
|
180
|
+
| `TRACE` | HTTP TRACE request |
|
|
181
|
+
| `PATCH` | HTTP PATCH request |
|
|
182
|
+
| `COPY` | HTTP COPY request (WebDAV) |
|
|
183
|
+
|
|
184
|
+
### TLS Fingerprints {#common-tls-fingerprints}
|
|
185
|
+
|
|
186
|
+
TLS fingerprint categories for malicious client detection.
|
|
187
|
+
|
|
188
|
+
| Value | Description |
|
|
189
|
+
| ----- | ----------- |
|
|
190
|
+
| `TLS_FINGERPRINT_NONE` | No fingerprint matching |
|
|
191
|
+
| `ANY_MALICIOUS_FINGERPRINT` | Match any known malicious fingerprint |
|
|
192
|
+
| `ADWARE` | Adware-associated fingerprints |
|
|
193
|
+
| `DRIDEX` | Dridex malware fingerprints |
|
|
194
|
+
| `GOOTKIT` | Gootkit malware fingerprints |
|
|
195
|
+
| `RANSOMWARE` | Ransomware-associated fingerprints |
|
|
196
|
+
| `TRICKBOT` | Trickbot malware fingerprints |
|
|
197
|
+
|
|
198
|
+
### IP Threat Categories {#common-ip-threat-categories}
|
|
199
|
+
|
|
200
|
+
IP address threat categories for security filtering.
|
|
201
|
+
|
|
202
|
+
| Value | Description |
|
|
203
|
+
| ----- | ----------- |
|
|
204
|
+
| `SPAM_SOURCES` | Known spam sources |
|
|
205
|
+
| `WINDOWS_EXPLOITS` | Windows exploit sources |
|
|
206
|
+
| `WEB_ATTACKS` | Web attack sources |
|
|
207
|
+
| `BOTNETS` | Known botnet IPs |
|
|
208
|
+
| `SCANNERS` | Network scanner IPs |
|
|
209
|
+
| `REPUTATION` | Poor reputation IPs |
|
|
210
|
+
| `PHISHING` | Phishing-related IPs |
|
|
211
|
+
| `PROXY` | Anonymous proxy IPs |
|
|
212
|
+
| `MOBILE_THREATS` | Mobile threat sources |
|
|
213
|
+
| `TOR_PROXY` | Tor exit nodes |
|
|
214
|
+
| `DENIAL_OF_SERVICE` | DoS attack sources |
|
|
215
|
+
| `NETWORK` | Known bad network ranges |
|
|
216
|
+
|
|
148
217
|
## Import
|
|
149
218
|
|
|
150
219
|
Import is supported using the following syntax:
|
|
@@ -2,12 +2,12 @@
|
|
|
2
2
|
page_title: "f5xc_tcp_loadbalancer Resource - terraform-provider-f5xc"
|
|
3
3
|
subcategory: "Load Balancing"
|
|
4
4
|
description: |-
|
|
5
|
-
|
|
5
|
+
Manages a TCP Load Balancer resource in F5 Distributed Cloud for load balancing TCP traffic across origin pools.
|
|
6
6
|
---
|
|
7
7
|
|
|
8
8
|
# f5xc_tcp_loadbalancer (Resource)
|
|
9
9
|
|
|
10
|
-
|
|
10
|
+
Manages a TCP Load Balancer resource in F5 Distributed Cloud for load balancing TCP traffic across origin pools.
|
|
11
11
|
|
|
12
12
|
~> **Note** Please refer to [TCP Loadbalancer API docs](https://docs.cloud.f5.com/docs-v2/api/views-tcp-loadbalancer) to learn more.
|
|
13
13
|
|
|
@@ -15,7 +15,7 @@ description: |-
|
|
|
15
15
|
|
|
16
16
|
```terraform
|
|
17
17
|
# TCP Loadbalancer Resource Example
|
|
18
|
-
#
|
|
18
|
+
# Manages a TCP Load Balancer resource in F5 Distributed Cloud for load balancing TCP traffic across origin pools.
|
|
19
19
|
|
|
20
20
|
# Basic TCP Loadbalancer configuration
|
|
21
21
|
resource "f5xc_tcp_loadbalancer" "example" {
|
|
@@ -139,13 +139,7 @@ An [`active_service_policies`](#active-service-policies) block supports the foll
|
|
|
139
139
|
|
|
140
140
|
#### Active Service Policies Policies
|
|
141
141
|
|
|
142
|
-
|
|
143
|
-
|
|
144
|
-
<a id="active-service-policies-policies-name"></a>• [`name`](#active-service-policies-policies-name) - Optional String<br>Name. 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
|
|
145
|
-
|
|
146
|
-
<a id="namespace-df0e5f"></a>• [`namespace`](#namespace-df0e5f) - Optional String<br>Namespace. 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
|
|
147
|
-
|
|
148
|
-
<a id="active-service-policies-policies-tenant"></a>• [`tenant`](#active-service-policies-policies-tenant) - Optional String<br>Tenant. 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
|
|
142
|
+
<a id="objref-460dca"></a>Uses standard [Object Reference](#common-object-reference) fields (name, namespace, tenant).
|
|
149
143
|
|
|
150
144
|
#### Advertise Custom
|
|
151
145
|
|
|
@@ -183,13 +177,7 @@ An [`advertise_on_public`](#public-618a99) block (within [`advertise_custom.adve
|
|
|
183
177
|
|
|
184
178
|
#### Advertise Custom Advertise Where Advertise On Public Public IP
|
|
185
179
|
|
|
186
|
-
|
|
187
|
-
|
|
188
|
-
<a id="name-4126f8"></a>• [`name`](#name-4126f8) - Optional String<br>Name. 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
|
|
189
|
-
|
|
190
|
-
<a id="namespace-edf1ff"></a>• [`namespace`](#namespace-edf1ff) - Optional String<br>Namespace. 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
|
|
191
|
-
|
|
192
|
-
<a id="tenant-ac4633"></a>• [`tenant`](#tenant-ac4633) - Optional String<br>Tenant. 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
|
|
180
|
+
<a id="deep-032ffb"></a>Deeply nested **IP** block collapsed for readability.
|
|
193
181
|
|
|
194
182
|
#### Advertise Custom Advertise Where Site
|
|
195
183
|
|
|
@@ -203,13 +191,7 @@ A [`site`](#advertise-custom-advertise-where-site) block (within [`advertise_cus
|
|
|
203
191
|
|
|
204
192
|
#### Advertise Custom Advertise Where Site Site
|
|
205
193
|
|
|
206
|
-
|
|
207
|
-
|
|
208
|
-
<a id="name-201d26"></a>• [`name`](#name-201d26) - Optional String<br>Name. 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
|
|
209
|
-
|
|
210
|
-
<a id="namespace-c3f40d"></a>• [`namespace`](#namespace-c3f40d) - Optional String<br>Namespace. 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
|
|
211
|
-
|
|
212
|
-
<a id="tenant-8a632a"></a>• [`tenant`](#tenant-8a632a) - Optional String<br>Tenant. 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
|
|
194
|
+
<a id="objref-7ecf1d"></a>Uses standard [Object Reference](#common-object-reference) fields (name, namespace, tenant).
|
|
213
195
|
|
|
214
196
|
#### Advertise Custom Advertise Where Virtual Network
|
|
215
197
|
|
|
@@ -227,13 +209,7 @@ A [`virtual_network`](#network-a20be3) block (within [`advertise_custom.advertis
|
|
|
227
209
|
|
|
228
210
|
#### Advertise Custom Advertise Where Virtual Network Virtual Network
|
|
229
211
|
|
|
230
|
-
|
|
231
|
-
|
|
232
|
-
<a id="name-5596bc"></a>• [`name`](#name-5596bc) - Optional String<br>Name. 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
|
|
233
|
-
|
|
234
|
-
<a id="namespace-030577"></a>• [`namespace`](#namespace-030577) - Optional String<br>Namespace. 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
|
|
235
|
-
|
|
236
|
-
<a id="tenant-72f925"></a>• [`tenant`](#tenant-72f925) - Optional String<br>Tenant. 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
|
|
212
|
+
<a id="deep-802ee3"></a>Deeply nested **Network** block collapsed for readability.
|
|
237
213
|
|
|
238
214
|
#### Advertise Custom Advertise Where Virtual Site
|
|
239
215
|
|
|
@@ -245,33 +221,15 @@ A [`virtual_site`](#site-5d39fd) block (within [`advertise_custom.advertise_wher
|
|
|
245
221
|
|
|
246
222
|
#### Advertise Custom Advertise Where Virtual Site Virtual Site
|
|
247
223
|
|
|
248
|
-
|
|
249
|
-
|
|
250
|
-
<a id="name-b7ccc7"></a>• [`name`](#name-b7ccc7) - Optional String<br>Name. 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
|
|
251
|
-
|
|
252
|
-
<a id="namespace-a4ffcf"></a>• [`namespace`](#namespace-a4ffcf) - Optional String<br>Namespace. 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
|
|
253
|
-
|
|
254
|
-
<a id="tenant-637b28"></a>• [`tenant`](#tenant-637b28) - Optional String<br>Tenant. 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
|
|
224
|
+
<a id="deep-22557e"></a>Deeply nested **Site** block collapsed for readability.
|
|
255
225
|
|
|
256
226
|
#### Advertise Custom Advertise Where Virtual Site With VIP
|
|
257
227
|
|
|
258
|
-
|
|
259
|
-
|
|
260
|
-
<a id="vip-ip-4850ab"></a>• [`ip`](#vip-ip-4850ab) - Optional String<br>IP Address. Use given IP address as VIP on the site
|
|
261
|
-
|
|
262
|
-
<a id="network-8b2765"></a>• [`network`](#network-8b2765) - Optional String Defaults to `SITE_NETWORK_SPECIFIED_VIP_OUTSIDE`<br>Possible values are `SITE_NETWORK_SPECIFIED_VIP_OUTSIDE`, `SITE_NETWORK_SPECIFIED_VIP_INSIDE`<br>[Enum: SITE_NETWORK_SPECIFIED_VIP_OUTSIDE|SITE_NETWORK_SPECIFIED_VIP_INSIDE] Site Network. This defines network types to be used on virtual-site with specified VIP All outside networks. All inside networks
|
|
263
|
-
|
|
264
|
-
<a id="site-ac753e"></a>• [`virtual_site`](#site-ac753e) - Optional Block<br>Object reference. This type establishes a direct reference from one object(the referrer) to another(the referred). Such a reference is in form of tenant/namespace/name<br>See [Virtual Site](#site-ac753e) below.
|
|
228
|
+
<a id="deep-7807f9"></a>Deeply nested **VIP** block collapsed for readability.
|
|
265
229
|
|
|
266
230
|
#### Advertise Custom Advertise Where Virtual Site With VIP Virtual Site
|
|
267
231
|
|
|
268
|
-
|
|
269
|
-
|
|
270
|
-
<a id="name-5f7f0d"></a>• [`name`](#name-5f7f0d) - Optional String<br>Name. 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
|
|
271
|
-
|
|
272
|
-
<a id="namespace-414bc8"></a>• [`namespace`](#namespace-414bc8) - Optional String<br>Namespace. 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
|
|
273
|
-
|
|
274
|
-
<a id="tenant-130ed4"></a>• [`tenant`](#tenant-130ed4) - Optional String<br>Tenant. 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
|
|
232
|
+
<a id="deep-60188a"></a>Deeply nested **Site** block collapsed for readability.
|
|
275
233
|
|
|
276
234
|
#### Advertise Custom Advertise Where Vk8s Service
|
|
277
235
|
|
|
@@ -283,23 +241,11 @@ A [`vk8s_service`](#service-1fdc7a) block (within [`advertise_custom.advertise_w
|
|
|
283
241
|
|
|
284
242
|
#### Advertise Custom Advertise Where Vk8s Service Site
|
|
285
243
|
|
|
286
|
-
|
|
287
|
-
|
|
288
|
-
<a id="name-950776"></a>• [`name`](#name-950776) - Optional String<br>Name. 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
|
|
289
|
-
|
|
290
|
-
<a id="namespace-1faf25"></a>• [`namespace`](#namespace-1faf25) - Optional String<br>Namespace. 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
|
|
291
|
-
|
|
292
|
-
<a id="tenant-98cf6a"></a>• [`tenant`](#tenant-98cf6a) - Optional String<br>Tenant. 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
|
|
244
|
+
<a id="objref-ec8d32"></a>Uses standard [Object Reference](#common-object-reference) fields (name, namespace, tenant).
|
|
293
245
|
|
|
294
246
|
#### Advertise Custom Advertise Where Vk8s Service Virtual Site
|
|
295
247
|
|
|
296
|
-
|
|
297
|
-
|
|
298
|
-
<a id="name-1cf7c0"></a>• [`name`](#name-1cf7c0) - Optional String<br>Name. 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
|
|
299
|
-
|
|
300
|
-
<a id="namespace-3dbb7e"></a>• [`namespace`](#namespace-3dbb7e) - Optional String<br>Namespace. 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
|
|
301
|
-
|
|
302
|
-
<a id="tenant-38ddda"></a>• [`tenant`](#tenant-38ddda) - Optional String<br>Tenant. 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
|
|
248
|
+
<a id="deep-e5d00e"></a>Deeply nested **Site** block collapsed for readability.
|
|
303
249
|
|
|
304
250
|
#### Advertise On Public
|
|
305
251
|
|
|
@@ -309,13 +255,7 @@ An [`advertise_on_public`](#advertise-on-public) block supports the following:
|
|
|
309
255
|
|
|
310
256
|
#### Advertise On Public Public IP
|
|
311
257
|
|
|
312
|
-
|
|
313
|
-
|
|
314
|
-
<a id="advertise-on-public-public-ip-name"></a>• [`name`](#advertise-on-public-public-ip-name) - Optional String<br>Name. 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
|
|
315
|
-
|
|
316
|
-
<a id="advertise-on-public-public-ip-namespace"></a>• [`namespace`](#advertise-on-public-public-ip-namespace) - Optional String<br>Namespace. 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
|
|
317
|
-
|
|
318
|
-
<a id="advertise-on-public-public-ip-tenant"></a>• [`tenant`](#advertise-on-public-public-ip-tenant) - Optional String<br>Tenant. 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
|
|
258
|
+
<a id="objref-5f3bb5"></a>Uses standard [Object Reference](#common-object-reference) fields (name, namespace, tenant).
|
|
319
259
|
|
|
320
260
|
#### Origin Pools Weights
|
|
321
261
|
|
|
@@ -333,23 +273,11 @@ An [`origin_pools_weights`](#origin-pools-weights) block supports the following:
|
|
|
333
273
|
|
|
334
274
|
#### Origin Pools Weights Cluster
|
|
335
275
|
|
|
336
|
-
|
|
337
|
-
|
|
338
|
-
<a id="origin-pools-weights-cluster-name"></a>• [`name`](#origin-pools-weights-cluster-name) - Optional String<br>Name. 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
|
|
339
|
-
|
|
340
|
-
<a id="origin-pools-weights-cluster-namespace"></a>• [`namespace`](#origin-pools-weights-cluster-namespace) - Optional String<br>Namespace. 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
|
|
341
|
-
|
|
342
|
-
<a id="origin-pools-weights-cluster-tenant"></a>• [`tenant`](#origin-pools-weights-cluster-tenant) - Optional String<br>Tenant. 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
|
|
276
|
+
<a id="objref-b05bd6"></a>Uses standard [Object Reference](#common-object-reference) fields (name, namespace, tenant).
|
|
343
277
|
|
|
344
278
|
#### Origin Pools Weights Pool
|
|
345
279
|
|
|
346
|
-
|
|
347
|
-
|
|
348
|
-
<a id="origin-pools-weights-pool-name"></a>• [`name`](#origin-pools-weights-pool-name) - Optional String<br>Name. 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
|
|
349
|
-
|
|
350
|
-
<a id="origin-pools-weights-pool-namespace"></a>• [`namespace`](#origin-pools-weights-pool-namespace) - Optional String<br>Namespace. 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
|
|
351
|
-
|
|
352
|
-
<a id="origin-pools-weights-pool-tenant"></a>• [`tenant`](#origin-pools-weights-pool-tenant) - Optional String<br>Tenant. 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
|
|
280
|
+
<a id="objref-e7b2da"></a>Uses standard [Object Reference](#common-object-reference) fields (name, namespace, tenant).
|
|
353
281
|
|
|
354
282
|
#### Timeouts
|
|
355
283
|
|
|
@@ -385,13 +313,7 @@ A [`tls_cert_params`](#tls-tcp-tls-cert-params) block (within [`tls_tcp`](#tls-t
|
|
|
385
313
|
|
|
386
314
|
#### TLS TCP TLS Cert Params Certificates
|
|
387
315
|
|
|
388
|
-
|
|
389
|
-
|
|
390
|
-
<a id="name-e9b502"></a>• [`name`](#name-e9b502) - Optional String<br>Name. 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
|
|
391
|
-
|
|
392
|
-
<a id="namespace-19bb2b"></a>• [`namespace`](#namespace-19bb2b) - Optional String<br>Namespace. 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
|
|
393
|
-
|
|
394
|
-
<a id="tenant-6b64b3"></a>• [`tenant`](#tenant-6b64b3) - Optional String<br>Tenant. 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
|
|
316
|
+
<a id="objref-7e0c2d"></a>Uses standard [Object Reference](#common-object-reference) fields (name, namespace, tenant).
|
|
395
317
|
|
|
396
318
|
#### TLS TCP TLS Cert Params TLS Config
|
|
397
319
|
|
|
@@ -407,13 +329,7 @@ A [`tls_config`](#tls-tcp-tls-cert-params-tls-config) block (within [`tls_tcp.tl
|
|
|
407
329
|
|
|
408
330
|
#### TLS TCP TLS Cert Params TLS Config Custom Security
|
|
409
331
|
|
|
410
|
-
|
|
411
|
-
|
|
412
|
-
<a id="suites-e0ab0f"></a>• [`cipher_suites`](#suites-e0ab0f) - Optional List<br>Cipher Suites. The TLS listener will only support the specified cipher list
|
|
413
|
-
|
|
414
|
-
<a id="version-f5b7a8"></a>• [`max_version`](#version-f5b7a8) - Optional String Defaults to `TLS_AUTO`<br>Possible values are `TLS_AUTO`, `TLSv1_0`, `TLSv1_1`, `TLSv1_2`, `TLSv1_3`<br>[Enum: TLS_AUTO|TLSv1_0|TLSv1_1|TLSv1_2|TLSv1_3] TLS Protocol. TlsProtocol is enumeration of supported TLS versions F5 Distributed Cloud will choose the optimal TLS version
|
|
415
|
-
|
|
416
|
-
<a id="version-df2e0f"></a>• [`min_version`](#version-df2e0f) - Optional String Defaults to `TLS_AUTO`<br>Possible values are `TLS_AUTO`, `TLSv1_0`, `TLSv1_1`, `TLSv1_2`, `TLSv1_3`<br>[Enum: TLS_AUTO|TLSv1_0|TLSv1_1|TLSv1_2|TLSv1_3] TLS Protocol. TlsProtocol is enumeration of supported TLS versions F5 Distributed Cloud will choose the optimal TLS version
|
|
332
|
+
<a id="deep-124b53"></a>Deeply nested **Security** block collapsed for readability.
|
|
417
333
|
|
|
418
334
|
#### TLS TCP TLS Cert Params Use mTLS
|
|
419
335
|
|
|
@@ -435,29 +351,15 @@ An [`use_mtls`](#tls-tcp-tls-cert-params-use-mtls) block (within [`tls_tcp.tls_c
|
|
|
435
351
|
|
|
436
352
|
#### TLS TCP TLS Cert Params Use mTLS CRL
|
|
437
353
|
|
|
438
|
-
|
|
439
|
-
|
|
440
|
-
<a id="name-bc9a84"></a>• [`name`](#name-bc9a84) - Optional String<br>Name. 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
|
|
441
|
-
|
|
442
|
-
<a id="namespace-eda25e"></a>• [`namespace`](#namespace-eda25e) - Optional String<br>Namespace. 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
|
|
443
|
-
|
|
444
|
-
<a id="tenant-e6ad1f"></a>• [`tenant`](#tenant-e6ad1f) - Optional String<br>Tenant. 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
|
|
354
|
+
<a id="deep-b2118e"></a>Deeply nested **CRL** block collapsed for readability.
|
|
445
355
|
|
|
446
356
|
#### TLS TCP TLS Cert Params Use mTLS Trusted CA
|
|
447
357
|
|
|
448
|
-
|
|
449
|
-
|
|
450
|
-
<a id="name-4dc4bb"></a>• [`name`](#name-4dc4bb) - Optional String<br>Name. 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
|
|
451
|
-
|
|
452
|
-
<a id="namespace-4a81e5"></a>• [`namespace`](#namespace-4a81e5) - Optional String<br>Namespace. 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
|
|
453
|
-
|
|
454
|
-
<a id="tenant-0f92ae"></a>• [`tenant`](#tenant-0f92ae) - Optional String<br>Tenant. 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
|
|
358
|
+
<a id="deep-1980d6"></a>Deeply nested **CA** block collapsed for readability.
|
|
455
359
|
|
|
456
360
|
#### TLS TCP TLS Cert Params Use mTLS Xfcc Options
|
|
457
361
|
|
|
458
|
-
|
|
459
|
-
|
|
460
|
-
<a id="elements-c613bc"></a>• [`xfcc_header_elements`](#elements-c613bc) - Optional List Defaults to `XFCC_NONE`<br>Possible values are `XFCC_NONE`, `XFCC_CERT`, `XFCC_CHAIN`, `XFCC_SUBJECT`, `XFCC_URI`, `XFCC_DNS`<br>[Enum: XFCC_NONE|XFCC_CERT|XFCC_CHAIN|XFCC_SUBJECT|XFCC_URI|XFCC_DNS] XFCC Header Elements. X-Forwarded-Client-Cert header elements to be added to requests
|
|
362
|
+
<a id="deep-1bac64"></a>Deeply nested **Options** block collapsed for readability.
|
|
461
363
|
|
|
462
364
|
#### TLS TCP TLS Parameters
|
|
463
365
|
|
|
@@ -489,35 +391,19 @@ A [`tls_certificates`](#tls-tcp-tls-parameters-tls-certificates) block (within [
|
|
|
489
391
|
|
|
490
392
|
#### TLS TCP TLS Parameters TLS Certificates Custom Hash Algorithms
|
|
491
393
|
|
|
492
|
-
|
|
493
|
-
|
|
494
|
-
<a id="algorithms-2a046f"></a>• [`hash_algorithms`](#algorithms-2a046f) - Optional List Defaults to `INVALID_HASH_ALGORITHM`<br>Possible values are `INVALID_HASH_ALGORITHM`, `SHA256`, `SHA1`<br>[Enum: INVALID_HASH_ALGORITHM|SHA256|SHA1] Hash Algorithms. Ordered list of hash algorithms to be used
|
|
394
|
+
<a id="deep-714aaa"></a>Deeply nested **Algorithms** block collapsed for readability.
|
|
495
395
|
|
|
496
396
|
#### TLS TCP TLS Parameters TLS Certificates Private Key
|
|
497
397
|
|
|
498
|
-
|
|
499
|
-
|
|
500
|
-
<a id="info-a21c19"></a>• [`blindfold_secret_info`](#info-a21c19) - Optional Block<br>Blindfold Secret. BlindfoldSecretInfoType specifies information about the Secret managed by F5XC Secret Management<br>See [Blindfold Secret Info](#info-a21c19) below.
|
|
501
|
-
|
|
502
|
-
<a id="info-58d186"></a>• [`clear_secret_info`](#info-58d186) - Optional Block<br>In-Clear Secret. ClearSecretInfoType specifies information about the Secret that is not encrypted<br>See [Clear Secret Info](#info-58d186) below.
|
|
398
|
+
<a id="deep-966381"></a>Deeply nested **Key** block collapsed for readability.
|
|
503
399
|
|
|
504
400
|
#### TLS TCP TLS Parameters TLS Certificates Private Key Blindfold Secret Info
|
|
505
401
|
|
|
506
|
-
|
|
507
|
-
|
|
508
|
-
<a id="provider-5f8f5b"></a>• [`decryption_provider`](#provider-5f8f5b) - Optional String<br>Decryption Provider. Name of the Secret Management Access object that contains information about the backend Secret Management service
|
|
509
|
-
|
|
510
|
-
<a id="location-8a9dd4"></a>• [`location`](#location-8a9dd4) - Optional String<br>Location. 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
|
|
511
|
-
|
|
512
|
-
<a id="provider-fcca21"></a>• [`store_provider`](#provider-fcca21) - Optional String<br>Store Provider. 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:///
|
|
402
|
+
<a id="deep-fcac6a"></a>Deeply nested **Info** block collapsed for readability.
|
|
513
403
|
|
|
514
404
|
#### TLS TCP TLS Parameters TLS Certificates Private Key Clear Secret Info
|
|
515
405
|
|
|
516
|
-
|
|
517
|
-
|
|
518
|
-
<a id="ref-2a4095"></a>• [`provider_ref`](#ref-2a4095) - Optional String<br>Provider. 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:///
|
|
519
|
-
|
|
520
|
-
<a id="url-7c0786"></a>• [`url`](#url-7c0786) - Optional String<br>URL. 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
|
|
406
|
+
<a id="deep-710771"></a>Deeply nested **Info** block collapsed for readability.
|
|
521
407
|
|
|
522
408
|
#### TLS TCP TLS Parameters TLS Config
|
|
523
409
|
|
|
@@ -533,13 +419,7 @@ A [`tls_config`](#tls-tcp-tls-parameters-tls-config) block (within [`tls_tcp.tls
|
|
|
533
419
|
|
|
534
420
|
#### TLS TCP TLS Parameters TLS Config Custom Security
|
|
535
421
|
|
|
536
|
-
|
|
537
|
-
|
|
538
|
-
<a id="suites-4a5055"></a>• [`cipher_suites`](#suites-4a5055) - Optional List<br>Cipher Suites. The TLS listener will only support the specified cipher list
|
|
539
|
-
|
|
540
|
-
<a id="version-7b5818"></a>• [`max_version`](#version-7b5818) - Optional String Defaults to `TLS_AUTO`<br>Possible values are `TLS_AUTO`, `TLSv1_0`, `TLSv1_1`, `TLSv1_2`, `TLSv1_3`<br>[Enum: TLS_AUTO|TLSv1_0|TLSv1_1|TLSv1_2|TLSv1_3] TLS Protocol. TlsProtocol is enumeration of supported TLS versions F5 Distributed Cloud will choose the optimal TLS version
|
|
541
|
-
|
|
542
|
-
<a id="version-615f2b"></a>• [`min_version`](#version-615f2b) - Optional String Defaults to `TLS_AUTO`<br>Possible values are `TLS_AUTO`, `TLSv1_0`, `TLSv1_1`, `TLSv1_2`, `TLSv1_3`<br>[Enum: TLS_AUTO|TLSv1_0|TLSv1_1|TLSv1_2|TLSv1_3] TLS Protocol. TlsProtocol is enumeration of supported TLS versions F5 Distributed Cloud will choose the optimal TLS version
|
|
422
|
+
<a id="deep-f58168"></a>Deeply nested **Security** block collapsed for readability.
|
|
543
423
|
|
|
544
424
|
#### TLS TCP TLS Parameters Use mTLS
|
|
545
425
|
|
|
@@ -561,29 +441,15 @@ An [`use_mtls`](#tls-tcp-tls-parameters-use-mtls) block (within [`tls_tcp.tls_pa
|
|
|
561
441
|
|
|
562
442
|
#### TLS TCP TLS Parameters Use mTLS CRL
|
|
563
443
|
|
|
564
|
-
|
|
565
|
-
|
|
566
|
-
<a id="name-90c648"></a>• [`name`](#name-90c648) - Optional String<br>Name. 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
|
|
567
|
-
|
|
568
|
-
<a id="namespace-66647e"></a>• [`namespace`](#namespace-66647e) - Optional String<br>Namespace. 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
|
|
569
|
-
|
|
570
|
-
<a id="tenant-b6dafd"></a>• [`tenant`](#tenant-b6dafd) - Optional String<br>Tenant. 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
|
|
444
|
+
<a id="objref-f09ed0"></a>Uses standard [Object Reference](#common-object-reference) fields (name, namespace, tenant).
|
|
571
445
|
|
|
572
446
|
#### TLS TCP TLS Parameters Use mTLS Trusted CA
|
|
573
447
|
|
|
574
|
-
|
|
575
|
-
|
|
576
|
-
<a id="name-d0b9dd"></a>• [`name`](#name-d0b9dd) - Optional String<br>Name. 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
|
|
577
|
-
|
|
578
|
-
<a id="namespace-d9cefe"></a>• [`namespace`](#namespace-d9cefe) - Optional String<br>Namespace. 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
|
|
579
|
-
|
|
580
|
-
<a id="tenant-f4ddde"></a>• [`tenant`](#tenant-f4ddde) - Optional String<br>Tenant. 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
|
|
448
|
+
<a id="deep-6a94df"></a>Deeply nested **CA** block collapsed for readability.
|
|
581
449
|
|
|
582
450
|
#### TLS TCP TLS Parameters Use mTLS Xfcc Options
|
|
583
451
|
|
|
584
|
-
|
|
585
|
-
|
|
586
|
-
<a id="elements-58540b"></a>• [`xfcc_header_elements`](#elements-58540b) - Optional List Defaults to `XFCC_NONE`<br>Possible values are `XFCC_NONE`, `XFCC_CERT`, `XFCC_CHAIN`, `XFCC_SUBJECT`, `XFCC_URI`, `XFCC_DNS`<br>[Enum: XFCC_NONE|XFCC_CERT|XFCC_CHAIN|XFCC_SUBJECT|XFCC_URI|XFCC_DNS] XFCC Header Elements. X-Forwarded-Client-Cert header elements to be added to requests
|
|
452
|
+
<a id="deep-10758e"></a>Deeply nested **Options** block collapsed for readability.
|
|
587
453
|
|
|
588
454
|
#### TLS TCP Auto Cert
|
|
589
455
|
|
|
@@ -609,13 +475,7 @@ A [`tls_config`](#tls-tcp-auto-cert-tls-config) block (within [`tls_tcp_auto_cer
|
|
|
609
475
|
|
|
610
476
|
#### TLS TCP Auto Cert TLS Config Custom Security
|
|
611
477
|
|
|
612
|
-
|
|
613
|
-
|
|
614
|
-
<a id="suites-673b61"></a>• [`cipher_suites`](#suites-673b61) - Optional List<br>Cipher Suites. The TLS listener will only support the specified cipher list
|
|
615
|
-
|
|
616
|
-
<a id="version-b3c8dc"></a>• [`max_version`](#version-b3c8dc) - Optional String Defaults to `TLS_AUTO`<br>Possible values are `TLS_AUTO`, `TLSv1_0`, `TLSv1_1`, `TLSv1_2`, `TLSv1_3`<br>[Enum: TLS_AUTO|TLSv1_0|TLSv1_1|TLSv1_2|TLSv1_3] TLS Protocol. TlsProtocol is enumeration of supported TLS versions F5 Distributed Cloud will choose the optimal TLS version
|
|
617
|
-
|
|
618
|
-
<a id="version-434218"></a>• [`min_version`](#version-434218) - Optional String Defaults to `TLS_AUTO`<br>Possible values are `TLS_AUTO`, `TLSv1_0`, `TLSv1_1`, `TLSv1_2`, `TLSv1_3`<br>[Enum: TLS_AUTO|TLSv1_0|TLSv1_1|TLSv1_2|TLSv1_3] TLS Protocol. TlsProtocol is enumeration of supported TLS versions F5 Distributed Cloud will choose the optimal TLS version
|
|
478
|
+
<a id="deep-7c4185"></a>Deeply nested **Security** block collapsed for readability.
|
|
619
479
|
|
|
620
480
|
#### TLS TCP Auto Cert Use mTLS
|
|
621
481
|
|
|
@@ -637,29 +497,98 @@ An [`use_mtls`](#tls-tcp-auto-cert-use-mtls) block (within [`tls_tcp_auto_cert`]
|
|
|
637
497
|
|
|
638
498
|
#### TLS TCP Auto Cert Use mTLS CRL
|
|
639
499
|
|
|
640
|
-
|
|
641
|
-
|
|
642
|
-
<a id="tls-tcp-auto-cert-use-mtls-crl-name"></a>• [`name`](#tls-tcp-auto-cert-use-mtls-crl-name) - Optional String<br>Name. 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
|
|
643
|
-
|
|
644
|
-
<a id="namespace-eacebb"></a>• [`namespace`](#namespace-eacebb) - Optional String<br>Namespace. 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
|
|
645
|
-
|
|
646
|
-
<a id="tls-tcp-auto-cert-use-mtls-crl-tenant"></a>• [`tenant`](#tls-tcp-auto-cert-use-mtls-crl-tenant) - Optional String<br>Tenant. 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
|
|
500
|
+
<a id="objref-9e3ef2"></a>Uses standard [Object Reference](#common-object-reference) fields (name, namespace, tenant).
|
|
647
501
|
|
|
648
502
|
#### TLS TCP Auto Cert Use mTLS Trusted CA
|
|
649
503
|
|
|
650
|
-
|
|
651
|
-
|
|
652
|
-
<a id="name-0415f6"></a>• [`name`](#name-0415f6) - Optional String<br>Name. 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
|
|
653
|
-
|
|
654
|
-
<a id="namespace-ac72fe"></a>• [`namespace`](#namespace-ac72fe) - Optional String<br>Namespace. 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
|
|
655
|
-
|
|
656
|
-
<a id="tenant-fa0d7e"></a>• [`tenant`](#tenant-fa0d7e) - Optional String<br>Tenant. 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
|
|
504
|
+
<a id="deep-bafeed"></a>Deeply nested **CA** block collapsed for readability.
|
|
657
505
|
|
|
658
506
|
#### TLS TCP Auto Cert Use mTLS Xfcc Options
|
|
659
507
|
|
|
660
|
-
|
|
508
|
+
<a id="deep-dfa8f5"></a>Deeply nested **Options** block collapsed for readability.
|
|
509
|
+
|
|
510
|
+
---
|
|
661
511
|
|
|
662
|
-
|
|
512
|
+
## Common Types
|
|
513
|
+
|
|
514
|
+
The following type definitions are used throughout this resource. See the full definition here rather than repeated inline.
|
|
515
|
+
|
|
516
|
+
### Object Reference {#common-object-reference}
|
|
517
|
+
|
|
518
|
+
Object references establish a direct reference from one configuration object to another in F5 Distributed Cloud. References use the format `tenant/namespace/name`.
|
|
519
|
+
|
|
520
|
+
| Field | Type | Description |
|
|
521
|
+
| ----- | ---- | ----------- |
|
|
522
|
+
| `name` | String | Name of the referenced object |
|
|
523
|
+
| `namespace` | String | Namespace containing the referenced object |
|
|
524
|
+
| `tenant` | String | Tenant of the referenced object (system-managed) |
|
|
525
|
+
|
|
526
|
+
### Transformers {#common-transformers}
|
|
527
|
+
|
|
528
|
+
Transformers apply transformations to input values before matching. Multiple transformers can be applied in order.
|
|
529
|
+
|
|
530
|
+
| Value | Description |
|
|
531
|
+
| ----- | ----------- |
|
|
532
|
+
| `LOWER_CASE` | Convert to lowercase |
|
|
533
|
+
| `UPPER_CASE` | Convert to uppercase |
|
|
534
|
+
| `BASE64_DECODE` | Decode base64 content |
|
|
535
|
+
| `NORMALIZE_PATH` | Normalize URL path |
|
|
536
|
+
| `REMOVE_WHITESPACE` | Remove whitespace characters |
|
|
537
|
+
| `URL_DECODE` | Decode URL-encoded characters |
|
|
538
|
+
| `TRIM_LEFT` | Trim leading whitespace |
|
|
539
|
+
| `TRIM_RIGHT` | Trim trailing whitespace |
|
|
540
|
+
| `TRIM` | Trim both leading and trailing whitespace |
|
|
541
|
+
|
|
542
|
+
### HTTP Methods {#common-http-methods}
|
|
543
|
+
|
|
544
|
+
HTTP methods used for request matching.
|
|
545
|
+
|
|
546
|
+
| Value | Description |
|
|
547
|
+
| ----- | ----------- |
|
|
548
|
+
| `ANY` | Match any HTTP method |
|
|
549
|
+
| `GET` | HTTP GET request |
|
|
550
|
+
| `HEAD` | HTTP HEAD request |
|
|
551
|
+
| `POST` | HTTP POST request |
|
|
552
|
+
| `PUT` | HTTP PUT request |
|
|
553
|
+
| `DELETE` | HTTP DELETE request |
|
|
554
|
+
| `CONNECT` | HTTP CONNECT request |
|
|
555
|
+
| `OPTIONS` | HTTP OPTIONS request |
|
|
556
|
+
| `TRACE` | HTTP TRACE request |
|
|
557
|
+
| `PATCH` | HTTP PATCH request |
|
|
558
|
+
| `COPY` | HTTP COPY request (WebDAV) |
|
|
559
|
+
|
|
560
|
+
### TLS Fingerprints {#common-tls-fingerprints}
|
|
561
|
+
|
|
562
|
+
TLS fingerprint categories for malicious client detection.
|
|
563
|
+
|
|
564
|
+
| Value | Description |
|
|
565
|
+
| ----- | ----------- |
|
|
566
|
+
| `TLS_FINGERPRINT_NONE` | No fingerprint matching |
|
|
567
|
+
| `ANY_MALICIOUS_FINGERPRINT` | Match any known malicious fingerprint |
|
|
568
|
+
| `ADWARE` | Adware-associated fingerprints |
|
|
569
|
+
| `DRIDEX` | Dridex malware fingerprints |
|
|
570
|
+
| `GOOTKIT` | Gootkit malware fingerprints |
|
|
571
|
+
| `RANSOMWARE` | Ransomware-associated fingerprints |
|
|
572
|
+
| `TRICKBOT` | Trickbot malware fingerprints |
|
|
573
|
+
|
|
574
|
+
### IP Threat Categories {#common-ip-threat-categories}
|
|
575
|
+
|
|
576
|
+
IP address threat categories for security filtering.
|
|
577
|
+
|
|
578
|
+
| Value | Description |
|
|
579
|
+
| ----- | ----------- |
|
|
580
|
+
| `SPAM_SOURCES` | Known spam sources |
|
|
581
|
+
| `WINDOWS_EXPLOITS` | Windows exploit sources |
|
|
582
|
+
| `WEB_ATTACKS` | Web attack sources |
|
|
583
|
+
| `BOTNETS` | Known botnet IPs |
|
|
584
|
+
| `SCANNERS` | Network scanner IPs |
|
|
585
|
+
| `REPUTATION` | Poor reputation IPs |
|
|
586
|
+
| `PHISHING` | Phishing-related IPs |
|
|
587
|
+
| `PROXY` | Anonymous proxy IPs |
|
|
588
|
+
| `MOBILE_THREATS` | Mobile threat sources |
|
|
589
|
+
| `TOR_PROXY` | Tor exit nodes |
|
|
590
|
+
| `DENIAL_OF_SERVICE` | DoS attack sources |
|
|
591
|
+
| `NETWORK` | Known bad network ranges |
|
|
663
592
|
|
|
664
593
|
## Import
|
|
665
594
|
|