@robinmordasiewicz/f5xc-terraform-mcp 2.3.0 → 2.4.4
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/README.md +98 -15
- package/dist/docs/data-sources/addon_subscription.md +51 -0
- package/dist/docs/data-sources/address_allocator.md +51 -0
- package/dist/docs/data-sources/advertise_policy.md +51 -0
- package/dist/docs/data-sources/alert_policy.md +51 -0
- package/dist/docs/data-sources/alert_receiver.md +62 -0
- package/dist/docs/data-sources/allowed_tenant.md +51 -0
- package/dist/docs/data-sources/api_crawler.md +51 -0
- package/dist/docs/data-sources/api_credential.md +51 -0
- package/dist/docs/data-sources/api_definition.md +51 -0
- package/dist/docs/data-sources/api_discovery.md +51 -0
- package/dist/docs/data-sources/api_testing.md +51 -0
- package/dist/docs/data-sources/apm.md +51 -0
- package/dist/docs/data-sources/app_api_group.md +51 -0
- package/dist/docs/data-sources/app_firewall.md +62 -0
- package/dist/docs/data-sources/app_setting.md +51 -0
- package/dist/docs/data-sources/app_type.md +51 -0
- package/dist/docs/data-sources/authentication.md +51 -0
- package/dist/docs/data-sources/aws_tgw_site.md +51 -0
- package/dist/docs/data-sources/aws_vpc_site.md +68 -0
- package/dist/docs/data-sources/azure_vnet_site.md +68 -0
- package/dist/docs/data-sources/bgp.md +51 -0
- package/dist/docs/data-sources/bgp_asn_set.md +51 -0
- package/dist/docs/data-sources/bgp_routing_policy.md +51 -0
- package/dist/docs/data-sources/bigip_irule.md +51 -0
- package/dist/docs/data-sources/bot_defense_app_infrastructure.md +51 -0
- package/dist/docs/data-sources/cdn_cache_rule.md +51 -0
- package/dist/docs/data-sources/cdn_loadbalancer.md +51 -0
- package/dist/docs/data-sources/certificate.md +66 -0
- package/dist/docs/data-sources/certificate_chain.md +51 -0
- package/dist/docs/data-sources/child_tenant.md +51 -0
- package/dist/docs/data-sources/child_tenant_manager.md +51 -0
- package/dist/docs/data-sources/cloud_connect.md +51 -0
- package/dist/docs/data-sources/cloud_credentials.md +62 -0
- package/dist/docs/data-sources/cloud_elastic_ip.md +51 -0
- package/dist/docs/data-sources/cloud_link.md +51 -0
- package/dist/docs/data-sources/cluster.md +51 -0
- package/dist/docs/data-sources/cminstance.md +51 -0
- package/dist/docs/data-sources/code_base_integration.md +51 -0
- package/dist/docs/data-sources/contact.md +51 -0
- package/dist/docs/data-sources/container_registry.md +51 -0
- package/dist/docs/data-sources/crl.md +51 -0
- package/dist/docs/data-sources/customer_support.md +51 -0
- package/dist/docs/data-sources/data_group.md +51 -0
- package/dist/docs/data-sources/data_type.md +51 -0
- package/dist/docs/data-sources/dc_cluster_group.md +51 -0
- package/dist/docs/data-sources/discovery.md +51 -0
- package/dist/docs/data-sources/dns_compliance_checks.md +51 -0
- package/dist/docs/data-sources/dns_domain.md +51 -0
- package/dist/docs/data-sources/dns_lb_health_check.md +51 -0
- package/dist/docs/data-sources/dns_lb_pool.md +51 -0
- package/dist/docs/data-sources/dns_load_balancer.md +51 -0
- package/dist/docs/data-sources/dns_zone.md +62 -0
- package/dist/docs/data-sources/endpoint.md +51 -0
- package/dist/docs/data-sources/enhanced_firewall_policy.md +51 -0
- package/dist/docs/data-sources/external_connector.md +51 -0
- package/dist/docs/data-sources/fast_acl.md +51 -0
- package/dist/docs/data-sources/fast_acl_rule.md +51 -0
- package/dist/docs/data-sources/filter_set.md +51 -0
- package/dist/docs/data-sources/fleet.md +51 -0
- package/dist/docs/data-sources/forward_proxy_policy.md +51 -0
- package/dist/docs/data-sources/forwarding_class.md +51 -0
- package/dist/docs/data-sources/gcp_vpc_site.md +68 -0
- package/dist/docs/data-sources/geo_location_set.md +51 -0
- package/dist/docs/data-sources/global_log_receiver.md +51 -0
- package/dist/docs/data-sources/healthcheck.md +62 -0
- package/dist/docs/data-sources/http_loadbalancer.md +60 -0
- package/dist/docs/data-sources/ike1.md +51 -0
- package/dist/docs/data-sources/ike2.md +51 -0
- package/dist/docs/data-sources/ike_phase1_profile.md +51 -0
- package/dist/docs/data-sources/ike_phase2_profile.md +51 -0
- package/dist/docs/data-sources/infraprotect_asn.md +51 -0
- package/dist/docs/data-sources/infraprotect_asn_prefix.md +51 -0
- package/dist/docs/data-sources/infraprotect_deny_list_rule.md +51 -0
- package/dist/docs/data-sources/infraprotect_firewall_rule.md +51 -0
- package/dist/docs/data-sources/infraprotect_firewall_rule_group.md +51 -0
- package/dist/docs/data-sources/infraprotect_internet_prefix_advertisement.md +51 -0
- package/dist/docs/data-sources/infraprotect_tunnel.md +51 -0
- package/dist/docs/data-sources/ip_prefix_set.md +51 -0
- package/dist/docs/data-sources/irule.md +51 -0
- package/dist/docs/data-sources/k8s_cluster.md +51 -0
- package/dist/docs/data-sources/k8s_cluster_role.md +51 -0
- package/dist/docs/data-sources/k8s_cluster_role_binding.md +51 -0
- package/dist/docs/data-sources/k8s_pod_security_admission.md +51 -0
- package/dist/docs/data-sources/k8s_pod_security_policy.md +51 -0
- package/dist/docs/data-sources/log_receiver.md +62 -0
- package/dist/docs/data-sources/malicious_user_mitigation.md +51 -0
- package/dist/docs/data-sources/managed_tenant.md +51 -0
- package/dist/docs/data-sources/namespace.md +58 -0
- package/dist/docs/data-sources/nat_policy.md +51 -0
- package/dist/docs/data-sources/network_connector.md +51 -0
- package/dist/docs/data-sources/network_firewall.md +51 -0
- package/dist/docs/data-sources/network_interface.md +51 -0
- package/dist/docs/data-sources/network_policy.md +51 -0
- package/dist/docs/data-sources/network_policy_rule.md +51 -0
- package/dist/docs/data-sources/network_policy_view.md +51 -0
- package/dist/docs/data-sources/nfv_service.md +51 -0
- package/dist/docs/data-sources/oidc_provider.md +51 -0
- package/dist/docs/data-sources/origin_pool.md +65 -0
- package/dist/docs/data-sources/policer.md +51 -0
- package/dist/docs/data-sources/policy_based_routing.md +51 -0
- package/dist/docs/data-sources/protocol_inspection.md +51 -0
- package/dist/docs/data-sources/protocol_policer.md +51 -0
- package/dist/docs/data-sources/proxy.md +51 -0
- package/dist/docs/data-sources/quota.md +51 -0
- package/dist/docs/data-sources/rate_limiter.md +64 -0
- package/dist/docs/data-sources/rate_limiter_policy.md +51 -0
- package/dist/docs/data-sources/registration.md +51 -0
- package/dist/docs/data-sources/report_config.md +51 -0
- package/dist/docs/data-sources/role.md +51 -0
- package/dist/docs/data-sources/route.md +51 -0
- package/dist/docs/data-sources/secret_management_access.md +51 -0
- package/dist/docs/data-sources/secret_policy.md +51 -0
- package/dist/docs/data-sources/secret_policy_rule.md +51 -0
- package/dist/docs/data-sources/securemesh_site.md +51 -0
- package/dist/docs/data-sources/securemesh_site_v2.md +51 -0
- package/dist/docs/data-sources/segment.md +51 -0
- package/dist/docs/data-sources/sensitive_data_policy.md +51 -0
- package/dist/docs/data-sources/service_policy.md +64 -0
- package/dist/docs/data-sources/service_policy_rule.md +51 -0
- package/dist/docs/data-sources/site_mesh_group.md +51 -0
- package/dist/docs/data-sources/srv6_network_slice.md +51 -0
- package/dist/docs/data-sources/subnet.md +51 -0
- package/dist/docs/data-sources/tcp_loadbalancer.md +51 -0
- package/dist/docs/data-sources/tenant_configuration.md +51 -0
- package/dist/docs/data-sources/tenant_profile.md +51 -0
- package/dist/docs/data-sources/ticket_tracking_system.md +51 -0
- package/dist/docs/data-sources/token.md +51 -0
- package/dist/docs/data-sources/tpm_api_key.md +51 -0
- package/dist/docs/data-sources/tpm_category.md +51 -0
- package/dist/docs/data-sources/tpm_manager.md +51 -0
- package/dist/docs/data-sources/trusted_ca_list.md +51 -0
- package/dist/docs/data-sources/tunnel.md +51 -0
- package/dist/docs/data-sources/udp_loadbalancer.md +51 -0
- package/dist/docs/data-sources/usb_policy.md +51 -0
- package/dist/docs/data-sources/user_identification.md +51 -0
- package/dist/docs/data-sources/virtual_host.md +51 -0
- package/dist/docs/data-sources/virtual_k8s.md +51 -0
- package/dist/docs/data-sources/virtual_network.md +51 -0
- package/dist/docs/data-sources/virtual_site.md +68 -0
- package/dist/docs/data-sources/voltshare_admin_policy.md +51 -0
- package/dist/docs/data-sources/voltstack_site.md +51 -0
- package/dist/docs/data-sources/waf_exclusion_policy.md +51 -0
- package/dist/docs/data-sources/workload.md +51 -0
- package/dist/docs/data-sources/workload_flavor.md +51 -0
- package/dist/docs/functions/blindfold.md +133 -0
- package/dist/docs/functions/blindfold_file.md +154 -0
- package/dist/docs/guides/authentication.md +389 -0
- package/dist/docs/guides/blindfold.md +509 -0
- package/dist/docs/guides/http-loadbalancer.md +274 -0
- package/dist/docs/resources/addon_subscription.md +136 -0
- package/dist/docs/resources/address_allocator.md +106 -0
- package/dist/docs/resources/advertise_policy.md +318 -0
- package/dist/docs/resources/alert_policy.md +242 -0
- package/dist/docs/resources/alert_receiver.md +394 -0
- package/dist/docs/resources/allowed_tenant.md +104 -0
- package/dist/docs/resources/api_crawler.md +142 -0
- package/dist/docs/resources/api_credential.md +101 -0
- package/dist/docs/resources/api_definition.md +127 -0
- package/dist/docs/resources/api_discovery.md +100 -0
- package/dist/docs/resources/api_testing.md +273 -0
- package/dist/docs/resources/apm.md +946 -0
- package/dist/docs/resources/app_api_group.md +161 -0
- package/dist/docs/resources/app_firewall.md +282 -0
- package/dist/docs/resources/app_setting.md +228 -0
- package/dist/docs/resources/app_type.md +124 -0
- package/dist/docs/resources/authentication.md +228 -0
- package/dist/docs/resources/aws_tgw_site.md +948 -0
- package/dist/docs/resources/aws_vpc_site.md +1262 -0
- package/dist/docs/resources/azure_vnet_site.md +2316 -0
- package/dist/docs/resources/bgp.md +341 -0
- package/dist/docs/resources/bgp_asn_set.md +86 -0
- package/dist/docs/resources/bgp_routing_policy.md +166 -0
- package/dist/docs/resources/bigip_irule.md +90 -0
- package/dist/docs/resources/bot_defense_app_infrastructure.md +166 -0
- package/dist/docs/resources/cdn_cache_rule.md +278 -0
- package/dist/docs/resources/cdn_loadbalancer.md +3800 -0
- package/dist/docs/resources/certificate.md +146 -0
- package/dist/docs/resources/certificate_chain.md +86 -0
- package/dist/docs/resources/child_tenant.md +166 -0
- package/dist/docs/resources/child_tenant_manager.md +130 -0
- package/dist/docs/resources/cloud_connect.md +260 -0
- package/dist/docs/resources/cloud_credentials.md +264 -0
- package/dist/docs/resources/cloud_elastic_ip.md +108 -0
- package/dist/docs/resources/cloud_link.md +252 -0
- package/dist/docs/resources/cluster.md +408 -0
- package/dist/docs/resources/cminstance.md +166 -0
- package/dist/docs/resources/code_base_integration.md +360 -0
- package/dist/docs/resources/contact.md +104 -0
- package/dist/docs/resources/container_registry.md +132 -0
- package/dist/docs/resources/crl.md +106 -0
- package/dist/docs/resources/customer_support.md +170 -0
- package/dist/docs/resources/data_group.md +121 -0
- package/dist/docs/resources/data_type.md +188 -0
- package/dist/docs/resources/dc_cluster_group.md +108 -0
- package/dist/docs/resources/discovery.md +443 -0
- package/dist/docs/resources/dns_compliance_checks.md +90 -0
- package/dist/docs/resources/dns_domain.md +94 -0
- package/dist/docs/resources/dns_lb_health_check.md +166 -0
- package/dist/docs/resources/dns_lb_pool.md +233 -0
- package/dist/docs/resources/dns_load_balancer.md +254 -0
- package/dist/docs/resources/dns_zone.md +988 -0
- package/dist/docs/resources/endpoint.md +234 -0
- package/dist/docs/resources/enhanced_firewall_policy.md +327 -0
- package/dist/docs/resources/external_connector.md +246 -0
- package/dist/docs/resources/fast_acl.md +376 -0
- package/dist/docs/resources/fast_acl_rule.md +192 -0
- package/dist/docs/resources/filter_set.md +142 -0
- package/dist/docs/resources/fleet.md +1267 -0
- package/dist/docs/resources/forward_proxy_policy.md +408 -0
- package/dist/docs/resources/forwarding_class.md +133 -0
- package/dist/docs/resources/gcp_vpc_site.md +1170 -0
- package/dist/docs/resources/geo_location_set.md +97 -0
- package/dist/docs/resources/global_log_receiver.md +1085 -0
- package/dist/docs/resources/healthcheck.md +148 -0
- package/dist/docs/resources/http_loadbalancer.md +7118 -0
- package/dist/docs/resources/ike1.md +133 -0
- package/dist/docs/resources/ike2.md +127 -0
- package/dist/docs/resources/ike_phase1_profile.md +141 -0
- package/dist/docs/resources/ike_phase2_profile.md +131 -0
- package/dist/docs/resources/infraprotect_asn.md +100 -0
- package/dist/docs/resources/infraprotect_asn_prefix.md +104 -0
- package/dist/docs/resources/infraprotect_deny_list_rule.md +108 -0
- package/dist/docs/resources/infraprotect_firewall_rule.md +205 -0
- package/dist/docs/resources/infraprotect_firewall_rule_group.md +86 -0
- package/dist/docs/resources/infraprotect_internet_prefix_advertisement.md +108 -0
- package/dist/docs/resources/infraprotect_tunnel.md +228 -0
- package/dist/docs/resources/ip_prefix_set.md +97 -0
- package/dist/docs/resources/irule.md +88 -0
- package/dist/docs/resources/k8s_cluster.md +291 -0
- package/dist/docs/resources/k8s_cluster_role.md +143 -0
- package/dist/docs/resources/k8s_cluster_role_binding.md +130 -0
- package/dist/docs/resources/k8s_pod_security_admission.md +116 -0
- package/dist/docs/resources/k8s_pod_security_policy.md +258 -0
- package/dist/docs/resources/log_receiver.md +183 -0
- package/dist/docs/resources/malicious_user_mitigation.md +132 -0
- package/dist/docs/resources/managed_tenant.md +116 -0
- package/dist/docs/resources/namespace.md +87 -0
- package/dist/docs/resources/nat_policy.md +408 -0
- package/dist/docs/resources/network_connector.md +252 -0
- package/dist/docs/resources/network_firewall.md +178 -0
- package/dist/docs/resources/network_interface.md +439 -0
- package/dist/docs/resources/network_policy.md +347 -0
- package/dist/docs/resources/network_policy_rule.md +157 -0
- package/dist/docs/resources/network_policy_view.md +330 -0
- package/dist/docs/resources/nfv_service.md +992 -0
- package/dist/docs/resources/oidc_provider.md +208 -0
- package/dist/docs/resources/origin_pool.md +801 -0
- package/dist/docs/resources/policer.md +97 -0
- package/dist/docs/resources/policy_based_routing.md +330 -0
- package/dist/docs/resources/protocol_inspection.md +130 -0
- package/dist/docs/resources/protocol_policer.md +146 -0
- package/dist/docs/resources/proxy.md +1181 -0
- package/dist/docs/resources/quota.md +104 -0
- package/dist/docs/resources/rate_limiter.md +155 -0
- package/dist/docs/resources/rate_limiter_policy.md +296 -0
- package/dist/docs/resources/registration.md +406 -0
- package/dist/docs/resources/report_config.md +160 -0
- package/dist/docs/resources/role.md +100 -0
- package/dist/docs/resources/route.md +724 -0
- package/dist/docs/resources/secret_management_access.md +498 -0
- package/dist/docs/resources/secret_policy.md +157 -0
- package/dist/docs/resources/secret_policy_rule.md +115 -0
- package/dist/docs/resources/securemesh_site.md +940 -0
- package/dist/docs/resources/securemesh_site_v2.md +2942 -0
- package/dist/docs/resources/segment.md +97 -0
- package/dist/docs/resources/sensitive_data_policy.md +116 -0
- package/dist/docs/resources/service_policy.md +795 -0
- package/dist/docs/resources/service_policy_rule.md +609 -0
- package/dist/docs/resources/site_mesh_group.md +163 -0
- package/dist/docs/resources/srv6_network_slice.md +92 -0
- package/dist/docs/resources/subnet.md +155 -0
- package/dist/docs/resources/tcp_loadbalancer.md +671 -0
- package/dist/docs/resources/tenant_configuration.md +136 -0
- package/dist/docs/resources/tenant_profile.md +156 -0
- package/dist/docs/resources/ticket_tracking_system.md +112 -0
- package/dist/docs/resources/token.md +87 -0
- package/dist/docs/resources/tpm_api_key.md +108 -0
- package/dist/docs/resources/tpm_category.md +108 -0
- package/dist/docs/resources/tpm_manager.md +84 -0
- package/dist/docs/resources/trusted_ca_list.md +89 -0
- package/dist/docs/resources/tunnel.md +250 -0
- package/dist/docs/resources/udp_loadbalancer.md +336 -0
- package/dist/docs/resources/usb_policy.md +108 -0
- package/dist/docs/resources/user_identification.md +126 -0
- package/dist/docs/resources/virtual_host.md +934 -0
- package/dist/docs/resources/virtual_k8s.md +132 -0
- package/dist/docs/resources/virtual_network.md +149 -0
- package/dist/docs/resources/virtual_site.md +102 -0
- package/dist/docs/resources/voltshare_admin_policy.md +196 -0
- package/dist/docs/resources/voltstack_site.md +2259 -0
- package/dist/docs/resources/waf_exclusion_policy.md +182 -0
- package/dist/docs/resources/workload.md +6021 -0
- package/dist/docs/resources/workload_flavor.md +90 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0000.public.ves.io.schema.ai_assistant.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0001.public.ves.io.schema.api_sec.api_crawler.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0002.public.ves.io.schema.views.api_definition.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0003.public.ves.io.schema.api_sec.api_discovery.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0004.public.ves.io.schema.api_group.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0005.public.ves.io.schema.api_group_element.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0006.public.ves.io.schema.api_sec.api_testing.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0007.public.ves.io.schema.api_credential.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0008.public.ves.io.schema.pbac.addon_service.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0009.public.ves.io.schema.pbac.addon_subscription.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0010.public.ves.io.schema.address_allocator.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0011.public.ves.io.schema.advertise_policy.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0012.public.ves.io.schema.alert_policy.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0013.public.ves.io.schema.alert_receiver.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0014.public.ves.io.schema.alert.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0015.public.ves.io.schema.tenant_management.allowed_tenant.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0016.public.ves.io.schema.views.app_api_group.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0017.public.ves.io.schema.app_setting.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0018.public.ves.io.schema.app_type.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0019.public.ves.io.schema.app_firewall.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0020.public.ves.io.schema.app_security.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0021.public.ves.io.schema.api_sec.rule_suggestion.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0022.public.ves.io.schema.shape.device_id.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0023.public.ves.io.schema.authentication.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0024.public.ves.io.schema.ai_data.bfdp.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0025.public.ves.io.schema.ai_data.bfdp.subscription.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0026.public.ves.io.schema.bgp.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0027.public.ves.io.schema.bgp_asn_set.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0028.public.ves.io.schema.operate.bgp.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0029.public.ves.io.schema.bgp_routing_policy.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0030.public.ves.io.schema.bigip.apm.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0031.public.ves.io.schema.bigip_irule.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0032.public.ves.io.schema.views.bigip_virtual_server.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0033.public.ves.io.schema.shape.brmalerts.alert_gen_policy.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0034.public.ves.io.schema.shape.brmalerts.alert_template.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0035.public.ves.io.schema.views.bot_defense_app_infrastructure.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0036.public.ves.io.schema.shape.bot_defense.threat_intelligence.bot_detection_rule.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0037.public.ves.io.schema.shape.bot_defense.threat_intelligence.bot_detection_update.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0038.public.ves.io.schema.shape.bot_defense.bot_endpoint_policy.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0039.public.ves.io.schema.shape.bot_defense.bot_infrastructure.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0040.public.ves.io.schema.shape.bot_defense.bot_allowlist_policy.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0041.public.ves.io.schema.shape.bot_defense.bot_network_policy.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0042.public.ves.io.schema.views.cdn_loadbalancer.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0043.public.ves.io.schema.cdn_cache_rule.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0044.public.ves.io.schema.crl.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0045.public.ves.io.schema.operate.crl.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0046.public.ves.io.schema.pbac.catalog.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0047.public.ves.io.schema.cminstance.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0048.public.ves.io.schema.certificate.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0049.public.ves.io.schema.certificate_chain.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0050.public.ves.io.schema.certified_hardware.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0051.public.ves.io.schema.tenant_management.child_tenant.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0052.public.ves.io.schema.tenant_management.child_tenant_manager.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0053.public.ves.io.schema.shape.client_side_defense.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0054.public.ves.io.schema.shape.client_side_defense.allowed_domain.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0055.public.ves.io.schema.shape.client_side_defense.protected_domain.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0056.public.ves.io.schema.shape.client_side_defense.mitigated_domain.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0057.public.ves.io.schema.shape.client_side_defense.subscription.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0058.public.ves.io.schema.cloud_connect.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0059.public.ves.io.schema.cloud_credentials.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0060.public.ves.io.schema.cloud_elastic_ip.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0061.public.ves.io.schema.cloud_region.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0062.public.ves.io.schema.cloud_link.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0063.public.ves.io.schema.cluster.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0064.public.ves.io.schema.api_sec.code_base_integration.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0065.public.ves.io.schema.views.aws_tgw_site.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0066.public.ves.io.schema.views.aws_vpc_site.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0067.public.ves.io.schema.views.voltstack_site.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0068.public.ves.io.schema.views.azure_vnet_site.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0069.public.ves.io.schema.dns_compliance_checks.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0071.public.ves.io.schema.views.forward_proxy_policy.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0072.public.ves.io.schema.views.gcp_vpc_site.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0073.public.ves.io.schema.views.http_loadbalancer.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0074.public.ves.io.schema.views.network_policy_view.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0075.public.ves.io.schema.protocol_inspection.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0076.public.ves.io.schema.views.securemesh_site.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0077.public.ves.io.schema.views.securemesh_site_v2.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0078.public.ves.io.schema.views.tcp_loadbalancer.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0079.public.ves.io.schema.views.udp_loadbalancer.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0080.public.ves.io.schema.bigcne.irule.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0081.public.ves.io.schema.graph.connectivity.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0082.public.ves.io.schema.contact.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0083.public.ves.io.schema.container_registry.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0084.public.ves.io.schema.customer_support.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0085.public.ves.io.schema.dc_cluster_group.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0086.public.ves.io.schema.dns_domain.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0087.public.ves.io.schema.dns_load_balancer.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0088.public.ves.io.schema.dns_lb_health_check.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0089.public.ves.io.schema.dns_lb_pool.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0090.public.ves.io.schema.observability.synthetic_monitor.v1_dns_monitor.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0091.public.ves.io.schema.dns_zone.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0092.public.ves.io.schema.shape.data_delivery.receiver.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0093.public.ves.io.schema.shape.data_delivery.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0094.public.ves.io.schema.bigcne.data_group.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0095.public.ves.io.schema.shape.data_delivery.subscription.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0096.public.ves.io.schema.data_type.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0097.public.ves.io.schema.operate.debug.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0098.public.ves.io.schema.operate.dhcp.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0100.public.ves.io.schema.discovered_service.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0101.public.ves.io.schema.discovery.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0102.public.ves.io.schema.endpoint.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0103.public.ves.io.schema.enhanced_firewall_policy.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0104.public.ves.io.schema.views.external_connector.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0105.public.ves.io.schema.dns_zone.rrset.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0106.public.ves.io.schema.dns_zone.subscription.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0107.public.ves.io.schema.malware_protection.subscription.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0108.public.ves.io.schema.secret_management.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0109.public.ves.io.schema.voltshare.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0110.public.ves.io.schema.maintenance_status.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0111.public.ves.io.schema.fast_acl.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0112.public.ves.io.schema.fast_acl_rule.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0113.public.ves.io.schema.filter_set.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0114.public.ves.io.schema.fleet.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0115.public.ves.io.schema.flow_anomaly.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0116.public.ves.io.schema.operate.flow.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0117.public.ves.io.schema.flow.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0118.public.ves.io.schema.forwarding_class.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0119.public.ves.io.schema.data_privacy.geo_config.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0120.public.ves.io.schema.geo_location_set.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0121.public.ves.io.schema.gia.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0122.public.ves.io.schema.global_log_receiver.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0123.public.ves.io.schema.observability.synthetic_monitor.v1_http_monitor.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0124.public.ves.io.schema.healthcheck.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0125.public.ves.io.schema.ike1.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0126.public.ves.io.schema.views.ike_phase1_profile.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0127.public.ves.io.schema.ike2.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0128.public.ves.io.schema.views.ike_phase2_profile.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0129.public.ves.io.schema.ip_prefix_set.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0130.public.ves.io.schema.implicit_label.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0131.public.ves.io.schema.infraprotect.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0132.public.ves.io.schema.infraprotect_asn.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0133.public.ves.io.schema.infraprotect_asn_prefix.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0134.public.ves.io.schema.infraprotect_deny_list_rule.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0135.public.ves.io.schema.infraprotect_firewall_rule.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0136.public.ves.io.schema.infraprotect_firewall_rule_group.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0137.public.ves.io.schema.infraprotect_firewall_ruleset.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0138.public.ves.io.schema.infraprotect_information.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0139.public.ves.io.schema.infraprotect_internet_prefix_advertisement.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0140.public.ves.io.schema.usage.invoice.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0141.public.ves.io.schema.k8s_cluster.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0142.public.ves.io.schema.k8s_cluster_role.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0143.public.ves.io.schema.k8s_cluster_role_binding.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0144.public.ves.io.schema.k8s_pod_security_admission.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0145.public.ves.io.schema.k8s_pod_security_policy.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0146.public.ves.io.schema.known_label.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0147.public.ves.io.schema.known_label_key.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0148.public.ves.io.schema.data_privacy.lma_region.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0149.public.ves.io.schema.operate.lte.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0150.public.ves.io.schema.log_receiver.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0151.public.ves.io.schema.log.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0152.public.ves.io.schema.malicious_user_mitigation.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0153.public.ves.io.schema.tenant_management.managed_tenant.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0154.public.ves.io.schema.shape.mobile_app_shield.subscription.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0155.public.ves.io.schema.shape.mobile_integrator.subscription.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0156.public.ves.io.schema.shape.bot_defense.mobile_sdk.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0157.public.ves.io.schema.shape.bot_defense.mobile_base_config.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0158.public.ves.io.schema.module_management.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0159.public.ves.io.schema.nat_policy.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0160.public.ves.io.schema.nfv_service.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0161.public.ves.io.schema.nginx.one.nginx_csg.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0162.public.ves.io.schema.nginx.one.nginx_instance.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0163.public.ves.io.schema.nginx.one.nginx_server.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0164.public.ves.io.schema.nginx.one.subscription.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0165.public.ves.io.schema.nginx.one.nginx_service_discovery.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0166.public.ves.io.schema.namespace.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0167.public.ves.io.schema.namespace_role.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0168.public.ves.io.schema.pbac.navigation_tile.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0169.public.ves.io.schema.network_connector.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0170.public.ves.io.schema.network_firewall.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0171.public.ves.io.schema.network_interface.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0172.public.ves.io.schema.network_policy.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0173.public.ves.io.schema.network_policy_rule.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0174.public.ves.io.schema.network_policy_set.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0175.public.ves.io.schema.observability.subscription.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0176.public.ves.io.schema.marketplace.aws_account.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0177.public.ves.io.schema.views.origin_pool.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0178.public.ves.io.schema.billing.payment_method.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0179.public.ves.io.schema.operate.ping.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0180.public.ves.io.schema.pbac.plan.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0181.public.ves.io.schema.billing.plan_transition.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0182.public.ves.io.schema.policer.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0183.public.ves.io.schema.views.policy_based_routing.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0184.public.ves.io.schema.shape.bot_defense.protected_application.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0185.public.ves.io.schema.protocol_policer.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0186.public.ves.io.schema.views.proxy.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0187.public.ves.io.schema.public_ip.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0188.public.ves.io.schema.quota.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0189.public.ves.io.schema.rbac_policy.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0190.public.ves.io.schema.rate_limiter.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0191.public.ves.io.schema.views.rate_limiter_policy.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0192.public.ves.io.schema.registration.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0193.public.ves.io.schema.report.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0194.public.ves.io.schema.report_config.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0195.public.ves.io.schema.role.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0196.public.ves.io.schema.trusted_ca_list.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0197.public.ves.io.schema.route.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0198.public.ves.io.schema.operate.route.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0199.public.ves.io.schema.srv6_network_slice.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0200.public.ves.io.schema.oidc_provider.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0201.public.ves.io.schema.secret_management_access.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0202.public.ves.io.schema.secret_policy.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0203.public.ves.io.schema.secret_policy_rule.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0204.public.ves.io.schema.segment.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0205.public.ves.io.schema.segment_connection.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0206.public.ves.io.schema.sensitive_data_policy.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0207.public.ves.io.schema.graph.service.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0208.public.ves.io.schema.service_policy.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0209.public.ves.io.schema.service_policy_rule.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0210.public.ves.io.schema.service_policy_set.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0211.public.ves.io.schema.shape_bot_defense_instance.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0212.public.ves.io.schema.shape.bot_defense.reporting.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0213.public.ves.io.schema.shape.bot_defense.subscription.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0214.public.ves.io.schema.shape.recognize.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0215.public.ves.io.schema.shape.safeap.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0216.public.ves.io.schema.shape.safe.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0217.public.ves.io.schema.signup.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0218.public.ves.io.schema.site.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0219.public.ves.io.schema.graph.site.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0220.public.ves.io.schema.site_mesh_group.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0221.public.ves.io.schema.status_at_site.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0222.public.ves.io.schema.stored_object.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0223.public.ves.io.schema.subnet.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0224.public.ves.io.schema.usage.subscription.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0225.public.ves.io.schema.subscription.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0226.public.ves.io.schema.observability.synthetic_monitor.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0227.public.ves.io.schema.scim.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0228.public.ves.io.schema.tpm_api_key.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0229.public.ves.io.schema.tpm_category.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0230.public.ves.io.schema.tpm_manager.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0231.public.ves.io.schema.tpm_provision.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0232.public.ves.io.schema.operate.tcpdump.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0233.public.ves.io.schema.tenant.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0234.public.ves.io.schema.views.tenant_configuration.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0235.public.ves.io.schema.tenant_management.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0236.public.ves.io.schema.tenant_management.tenant_profile.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0237.public.ves.io.schema.views.third_party_application.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0238.public.ves.io.schema.ticket_management.ticket_tracking_system.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0239.public.ves.io.schema.token.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0240.public.ves.io.schema.topology.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0241.public.ves.io.schema.operate.traceroute.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0242.public.ves.io.schema.tunnel.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0243.public.ves.io.schema.infraprotect_tunnel.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0244.public.ves.io.schema.operate.usb.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0245.public.ves.io.schema.usb_policy.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0246.public.ves.io.schema.ui.static_component.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0247.public.ves.io.schema.upgrade_status.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0248.public.ves.io.schema.virtual_appliance.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0249.public.ves.io.schema.usage.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0250.public.ves.io.schema.usage.plan.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0251.public.ves.io.schema.user.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0252.public.ves.io.schema.user_group.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0253.public.ves.io.schema.user_identification.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0254.public.ves.io.schema.user.setting.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0255.public.ves.io.schema.views.view_internal.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0256.public.ves.io.schema.views.terraform_parameters.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0257.public.ves.io.schema.virtual_host.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0258.public.ves.io.schema.virtual_k8s.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0259.public.ves.io.schema.virtual_network.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0260.public.ves.io.schema.virtual_site.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0261.public.ves.io.schema.voltshare_admin_policy.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0262.public.ves.io.schema.waf.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0263.public.ves.io.schema.waf_exclusion_policy.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0264.public.ves.io.schema.waf_signatures_changelog.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0265.public.ves.io.schema.operate.wifi.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0266.public.ves.io.schema.was.user_token.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0267.public.ves.io.schema.views.workload.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0268.public.ves.io.schema.workload_flavor.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0269.public.ves.io.schema.marketplace.xc_saas.ves-swagger.json +1 -0
- package/dist/docs/specifications/api/docs-cloud-f5-com.0270.public.ves.io.schema.graph.l3l4.ves-swagger.json +1 -0
- package/dist/index.d.ts +5 -1
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +26 -22
- package/dist/index.js.map +1 -1
- package/dist/services/api-specs.d.ts.map +1 -1
- package/dist/services/api-specs.js +15 -3
- package/dist/services/api-specs.js.map +1 -1
- package/dist/services/documentation.d.ts.map +1 -1
- package/dist/services/documentation.js +25 -9
- package/dist/services/documentation.js.map +1 -1
- package/package.json +6 -3
|
@@ -0,0 +1,934 @@
|
|
|
1
|
+
---
|
|
2
|
+
page_title: "f5xc_virtual_host Resource - terraform-provider-f5xc"
|
|
3
|
+
subcategory: "Load Balancing"
|
|
4
|
+
description: |-
|
|
5
|
+
[Namespace: required] Manages virtual host in a given namespace. in F5 Distributed Cloud.
|
|
6
|
+
---
|
|
7
|
+
|
|
8
|
+
# f5xc_virtual_host (Resource)
|
|
9
|
+
|
|
10
|
+
[Namespace: required] Manages virtual host in a given namespace. in F5 Distributed Cloud.
|
|
11
|
+
|
|
12
|
+
~> **Note** Please refer to [Virtual Host API docs](https://docs.cloud.f5.com/docs-v2/api/virtual-host) to learn more.
|
|
13
|
+
|
|
14
|
+
## Example Usage
|
|
15
|
+
|
|
16
|
+
```terraform
|
|
17
|
+
# Virtual Host Resource Example
|
|
18
|
+
# [Namespace: required] Manages virtual host in a given namespace. in F5 Distributed Cloud.
|
|
19
|
+
|
|
20
|
+
# Basic Virtual Host configuration
|
|
21
|
+
resource "f5xc_virtual_host" "example" {
|
|
22
|
+
name = "example-virtual-host"
|
|
23
|
+
namespace = "staging"
|
|
24
|
+
|
|
25
|
+
labels = {
|
|
26
|
+
environment = "production"
|
|
27
|
+
managed_by = "terraform"
|
|
28
|
+
}
|
|
29
|
+
|
|
30
|
+
annotations = {
|
|
31
|
+
"owner" = "platform-team"
|
|
32
|
+
}
|
|
33
|
+
|
|
34
|
+
# Resource-specific configuration
|
|
35
|
+
# Advertise Policies. Advertise Policy allows you to define...
|
|
36
|
+
advertise_policies {
|
|
37
|
+
# Configure advertise_policies settings
|
|
38
|
+
}
|
|
39
|
+
# [OneOf: authentication, no_authentication; Default: no_au...
|
|
40
|
+
authentication {
|
|
41
|
+
# Configure authentication settings
|
|
42
|
+
}
|
|
43
|
+
# Reference to Authentication Object. Reference to Authenti...
|
|
44
|
+
auth_config {
|
|
45
|
+
# Configure auth_config settings
|
|
46
|
+
}
|
|
47
|
+
}
|
|
48
|
+
```
|
|
49
|
+
|
|
50
|
+
<!-- schema generated by tfplugindocs -->
|
|
51
|
+
## Argument Reference
|
|
52
|
+
|
|
53
|
+
### Metadata Argument Reference
|
|
54
|
+
|
|
55
|
+
<a id="name"></a>• [`name`](#name) - Required String<br>Name of the Virtual Host. Must be unique within the namespace
|
|
56
|
+
|
|
57
|
+
<a id="namespace"></a>• [`namespace`](#namespace) - Required String<br>Namespace where the Virtual Host will be created
|
|
58
|
+
|
|
59
|
+
<a id="annotations"></a>• [`annotations`](#annotations) - Optional Map<br>Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata
|
|
60
|
+
|
|
61
|
+
<a id="description"></a>• [`description`](#description) - Optional String<br>Human readable description for the object
|
|
62
|
+
|
|
63
|
+
<a id="disable"></a>• [`disable`](#disable) - Optional Bool<br>A value of true will administratively disable the object
|
|
64
|
+
|
|
65
|
+
<a id="labels"></a>• [`labels`](#labels) - Optional Map<br>Labels is a user defined key value map that can be attached to resources for organization and filtering
|
|
66
|
+
|
|
67
|
+
### Spec Argument Reference
|
|
68
|
+
|
|
69
|
+
<a id="add-location"></a>• [`add_location`](#add-location) - Optional Bool<br>Add Location. Appends header x-volterra-location = `<RE-site-name>` in responses. This configuration is ignored on CE sites
|
|
70
|
+
|
|
71
|
+
<a id="advertise-policies"></a>• [`advertise_policies`](#advertise-policies) - Optional Block<br>Advertise Policies. Advertise Policy allows you to define networks or sites where you want a VIP for this virtual host to be advertised. Each Policy rule can have different parameters, like TLS configuration, ports, optionally IP address to be used for VIP. If advertise policy is not specified then no VIP is assigned for this virtual host<br>See [Advertise Policies](#advertise-policies) below for details.
|
|
72
|
+
|
|
73
|
+
-> **One of the following:**
|
|
74
|
+
• <a id="append-server-name"></a>[`append_server_name`](#append-server-name) - Optional String<br>Append Server Name if absent. Specifies the value to be used for Server header if it is not already present. If Server Header is already present it is not overwritten. It is just passed
|
|
75
|
+
<br><br>• <a id="default-header"></a>[`default_header`](#default-header) - Optional Block<br>Enable this option
|
|
76
|
+
<br><br>• <a id="pass-through"></a>[`pass_through`](#pass-through) - Optional Block<br>Enable this option
|
|
77
|
+
|
|
78
|
+
-> **One of the following:**
|
|
79
|
+
• <a id="authentication"></a>[`authentication`](#authentication) - Optional Block<br>Authentication Details. Authentication related information. This allows to configure the URL to redirect after the authentication Authentication Object Reference, configuration of cookie params etc<br>See [Authentication](#authentication) below for details.
|
|
80
|
+
|
|
81
|
+
<a id="buffer-policy"></a>• [`buffer_policy`](#buffer-policy) - Optional Block<br>Buffer Configuration. Some upstream applications are not capable of handling streamed data. This config enables buffering the entire request before sending to upstream application. We can specify the maximum buffer size and buffer interval with this config. Buffering can be enabled and disabled at VirtualHost and Route levels Route level buffer configuration takes precedence<br>See [Buffer Policy](#buffer-policy) below for details.
|
|
82
|
+
|
|
83
|
+
-> **One of the following:**
|
|
84
|
+
• <a id="captcha-challenge"></a>[`captcha_challenge`](#captcha-challenge) - Optional Block<br>Captcha Challenge Parameters. Enables loadbalancer to perform captcha challenge Captcha challenge will be based on Google Recaptcha. With this feature enabled, only clients that pass the captcha challenge will be allowed to complete the HTTP request. When loadbalancer is configured to do Captcha Challenge, it will redirect the browser to an HTML page on every new HTTP request. This HTML page will have captcha challenge embedded in it. Client will be allowed to make the request only if the captcha challenge is successful. Loadbalancer will tag response header with a cookie to avoid Captcha challenge for subsequent requests. CAPTCHA is mainly used as a security check to ensure only human users can pass through. Generally, computers or bots are not capable of solving a captcha. You can enable either Javascript challenge or Captcha challenge on a virtual host<br>See [Captcha Challenge](#captcha-challenge) below for details.
|
|
85
|
+
<br><br>• <a id="js-challenge"></a>[`js_challenge`](#js-challenge) - Optional Block<br>Javascript Challenge Parameters. Enables loadbalancer to perform client browser compatibility test by redirecting to a page with Javascript. With this feature enabled, only clients that are capable of executing Javascript(mostly browsers) will be allowed to complete the HTTP request. When loadbalancer is configured to do Javascript Challenge, it will redirect the browser to an HTML page on every new HTTP request. This HTML page will have Javascript embedded in it. Loadbalancer chooses a set of random numbers for every new client and sends these numbers along with an encrypted answer with the request such that it embed these numbers as input in the Javascript. Javascript will run on the requestor browser and perform a complex Math operation. Script will submit the answer to loadbalancer. Loadbalancer will validate the answer by comparing the calculated answer with the decrypted answer (which was encrypted when it was sent back as reply) and allow the request to the upstream server only if the answer is correct. Loadbalancer will tag response header with a cookie to avoid Javascript challenge for subsequent requests. Javascript challenge serves following purposes \* Validate that the request is coming via a browser that is capable for running Javascript \* Force the browser to run a complex operation, f(X), that requires it to spend a large number of CPU cycles. This is to slow down a potential DOS attacker by making it difficult to launch a large request flood without having to spend even larger CPU cost at their end. You can enable either Javascript challenge or Captcha challenge on a virtual host<br>See [Js Challenge](#js-challenge) below for details.
|
|
86
|
+
|
|
87
|
+
<a id="coalescing-options"></a>• [`coalescing_options`](#coalescing-options) - Optional Block<br>TLS Coalescing Options. TLS connection coalescing configuration (not compatible with mTLS)<br>See [Coalescing Options](#coalescing-options) below for details.
|
|
88
|
+
|
|
89
|
+
<a id="compression-params"></a>• [`compression_params`](#compression-params) - Optional Block<br>Compression Parameters. Enables loadbalancer to compress dispatched data from an upstream service upon client request. The content is compressed and then sent to the client with the appropriate headers if either response and request allow. Only GZIP compression is supported. By default compression will be skipped when: A request does NOT contain accept-encoding header. A request includes accept-encoding header, but it does not contain “gzip” or “*”. A request includes accept-encoding with “gzip” or “*” with the weight “q=0”. Note that the “gzip” will have a higher weight then “*”. For example, if accept-encoding is “gzip;q=0,*;q=1”, the filter will not compress. But if the header is set to “*;q=0,gzip;q=1”, the filter will compress. A request whose accept-encoding header includes “identity”. A response contains a content-encoding header. A response contains a cache-control header whose value includes “no-transform”. A response contains a transfer-encoding header whose value includes “gzip”. A response does not contain a content-type value that matches one of the selected mime-types, which default to application/javascript, application/JSON, application/xhtml+XML, image/svg+XML, text/CSS, text/HTML, text/plain, text/XML. Neither content-length nor transfer-encoding headers are present in the response. Response size is smaller than 30 bytes (only applicable when transfer-encoding is not chunked). When compression is applied: The content-length is removed from response headers. Response headers contain “transfer-encoding: chunked” and do not contain “content-encoding” header. The “vary: accept-encoding” header is inserted on every response. GZIP Compression Level: A value which is optimal balance between speed of compression and amount of compression is chosen<br>See [Compression Params](#compression-params) below for details.
|
|
90
|
+
|
|
91
|
+
<a id="connection-idle-timeout"></a>• [`connection_idle_timeout`](#connection-idle-timeout) - Optional Number Defaults to `2` Specified in milliseconds<br>Connection Idle Timeout. The idle timeout for downstream connections. The idle timeout is defined as the period in which there are no active requests. When the idle timeout is reached the connection will be closed. Note that request based timeouts mean that HTTP/2 PINGs will not keep the connection alive. The minutes
|
|
92
|
+
|
|
93
|
+
<a id="cors-policy"></a>• [`cors_policy`](#cors-policy) - Optional Block<br>CORS Policy. Cross-Origin Resource Sharing requests configuration specified at Virtual-host or Route level. Route level configuration takes precedence. An example of an Cross origin HTTP request GET /resources/public-data/ HTTP/1.1 Host: bar.other User-Agent: Mozilla/5.0 (Macintosh; U; Intel Mac OS X 10.5; en-US; rv:1.9.1b3pre) Gecko/20081130 Minefield/3.1b3pre Accept: text/HTML,application/xhtml+XML,application/XML;q=0.9,*/*;q=0.8 Accept-Language: en-us,en;q=0.5 Accept-Encoding: gzip,deflate Accept-Charset: ISO-8859-1,utf-8;q=0.7,*;q=0.7 Connection: keep-alive Referrer: `HTTP://foo.example/examples/access-control/simpleXSInvocation.HTML` Origin: `HTTP://foo.example` HTTP/1.1 200 OK Date: Mon, 01 Dec 2008 00:23:53 GMT Server: Apache/2.0.61 Access-Control-Allow-Origin: \* Keep-Alive: timeout=2, max=100 Connection: Keep-Alive Transfer-Encoding: chunked Content-Type: application/XML An example for cross origin HTTP OPTIONS request with Access-Control-Request-* header OPTIONS /resources/post-here/ HTTP/1.1 Host: bar.other User-Agent: Mozilla/5.0 (Macintosh; U; Intel Mac OS X 10.5; en-US; rv:1.9.1b3pre) Gecko/20081130 Minefield/3.1b3pre Accept: text/HTML,application/xhtml+XML,application/XML;q=0.9,*/*;q=0.8 Accept-Language: en-us,en;q=0.5 Accept-Encoding: gzip,deflate Accept-Charset: ISO-8859-1,utf-8;q=0.7,*;q=0.7 Connection: keep-alive Origin: `HTTP://foo.example` Access-Control-Request-Method: POST Access-Control-Request-Headers: X-PINGOTHER, Content-Type HTTP/1.1 204 No Content Date: Mon, 01 Dec 2008 01:15:39 GMT Server: Apache/2.0.61 (Unix) Access-Control-Allow-Origin: `HTTP://foo.example` Access-Control-Allow-Methods: POST, GET, OPTIONS Access-Control-Allow-Headers: X-PINGOTHER, Content-Type Access-Control-Max-Age: 86400 Vary: Accept-Encoding, Origin Keep-Alive: timeout=2, max=100 Connection: Keep-Alive<br>See [CORS Policy](#cors-policy) below for details.
|
|
94
|
+
|
|
95
|
+
<a id="csrf-policy"></a>• [`csrf_policy`](#csrf-policy) - Optional Block<br>CSRF Policy. To mitigate CSRF attack , the policy checks where a request is coming from to determine if the request's origin is the same as its detination.The policy relies on two pieces of information used in determining if a request originated from the same host. 1. The origin that caused the user agent to issue the request (source origin). 2. The origin that the request is going to (target origin). When the policy evaluating a request, it ensures both pieces of information are present and compare their values. If the source origin is missing or origins do not match the request is rejected. The exception to this being if the source-origin has been added to they policy as valid. Because CSRF attacks specifically target state-changing requests, the policy only acts on the HTTP requests that have state-changing method (PUT,POST, etc.)<br>See [CSRF Policy](#csrf-policy) below for details.
|
|
96
|
+
|
|
97
|
+
<a id="custom-errors"></a>• [`custom_errors`](#custom-errors) - Optional Block<br>Custom Error Responses. Map of integer error codes as keys and string values that can be used to provide custom HTTP pages for each error code. Key of the map can be either response code class or HTTP Error code. Response code classes for key is configured as follows 3 -- for 3xx response code class 4 -- for 4xx response code class 5 -- for 5xx response code class Value is the uri_ref. Currently supported URL schemes is string:///. For string:/// scheme, message needs to be encoded in Base64 format. You can specify this message as base64 encoded plain text message e.g. 'Access Denied' or it can be HTML paragraph or a body string encoded as base64 string E.g. '`<p>` Access Denied `</p>`'. Base64 encoded string for this HTML is 'PHA+IEFjY2VzcyBEZW5pZWQgPC9wPg==' Specific response code takes preference when both response code and response code class matches for a request. The configured custom errors are only applicable for loadbalancer generated errors. Errors returned from upstream server is propagated as is. F5XC provides default error pages for the errors generated by the loadbalancer. Content of these pages are not editable. User has an option to disable the use of default F5XC error pages
|
|
98
|
+
|
|
99
|
+
-> **One of the following:**
|
|
100
|
+
• <a id="default-loadbalancer"></a>[`default_loadbalancer`](#default-loadbalancer) - Optional Block<br>Enable this option
|
|
101
|
+
|
|
102
|
+
<a id="disable-default-error-pages"></a>• [`disable_default_error_pages`](#disable-default-error-pages) - Optional Bool<br>Disable default error pages. An option to specify whether to disable using default F5XC error pages
|
|
103
|
+
|
|
104
|
+
<a id="disable-dns-resolve"></a>• [`disable_dns_resolve`](#disable-dns-resolve) - Optional Bool<br>Disable DNS resolution. Disable DNS resolution for domains specified in the virtual host When the virtual host is configured as Dynamive Resolve Proxy (DRP), disable DNS resolution for domains configured. This configuration is suitable for HTTP CONNECT proxy
|
|
105
|
+
|
|
106
|
+
-> **One of the following:**
|
|
107
|
+
• <a id="disable-path-normalize"></a>[`disable_path_normalize`](#disable-path-normalize) - Optional Block<br>Enable this option
|
|
108
|
+
|
|
109
|
+
<a id="domains"></a>• [`domains`](#domains) - Optional List<br>Domains. A list of Domains (host/authority header) that will be matched to this Virtual Host. Wildcard hosts are supported in the suffix or prefix form Supported Domains and search order: 1. Exact Domain names: `www.foo.com.` 2. Domains starting with a Wildcard: \*.foo.com. Not supported Domains: - Just a Wildcard: \* - A Wildcard and TLD with no root Domain: \*.com. - A Wildcard not matching a whole DNS label. e.g. \*.foo.com and \*.bar.foo.com are valid Wildcards however \*bar.foo.com, \*-bar.foo.com, and bar*.foo.com are all invalid. Additional notes: A Wildcard will not match empty string. e.g. \*.foo.com will match bar.foo.com and baz-bar.foo.com but not .foo.com. The longest Wildcards match first. Only a single virtual host in the entire route configuration can match on \*. Also a Domain must be unique across all virtual hosts within an advertise policy. Domains are also used for SNI matching if the virtual host proxy type is TCP_PROXY_WITH_SNI/HTTPS_PROXY Domains also indicate the list of names for which DNS resolution will be automatically resolved to IP addresses by the system
|
|
110
|
+
|
|
111
|
+
<a id="dynamic-reverse-proxy"></a>• [`dynamic_reverse_proxy`](#dynamic-reverse-proxy) - Optional Block<br>Dynamic Reverse Proxy Type. In this mode of proxy, virtual host will resolve the destination endpoint dynamically. The dynamic resolution is done using a predefined field in the request. This predefined field depends on the ProxyType configured on the Virtual Host. For HTTP traffic, i.e. with ProxyType as HTTP_PROXY or HTTPS_PROXY, virtual host will use the 'HOST' HTTP header from the request and perform DNS resolution to select destination endpoint. For TCP traffic with SNI, (If the ProxyType is TCP_PROXY_WITH_SNI), virtual host will perform DNS resolution using the SNI. The DNS resolution is performed in the virtual network specified in outside_network_type or outside_network In both modes of operation(either using Host header or SNI), the DNS resolution could return multiple addresses. First IPv4 address from such returned list is used as endpoint for the request. The DNS response is cached for 60s by default<br>See [Dynamic Reverse Proxy](#dynamic-reverse-proxy) below for details.
|
|
112
|
+
|
|
113
|
+
<a id="enable-path-normalize"></a>• [`enable_path_normalize`](#enable-path-normalize) - Optional Block<br>Enable this option
|
|
114
|
+
|
|
115
|
+
<a id="http-protocol-options"></a>• [`http_protocol_options`](#http-protocol-options) - Optional Block<br>HTTP Protocol Configuration Options. HTTP protocol configuration options for downstream connections<br>See [HTTP Protocol Options](#http-protocol-options) below for details.
|
|
116
|
+
|
|
117
|
+
<a id="idle-timeout"></a>• [`idle_timeout`](#idle-timeout) - Optional Number<br>Idle timeout (in milliseconds). Idle timeout is the amount of time that the loadbalancer will allow a stream to exist with no upstream or downstream activity. Idle timeout and Proxy Type: HTTP_PROXY, HTTPS_PROXY: Idle timer is started when the first byte is received on the connection. Each time an encode/decode event for headers or data is processed for the stream, the timer will be reset. If the timeout fires, the stream is terminated with a 504 (Gateway Timeout) error code if no upstream response header has been received, otherwise a stream reset occurs. The default idle timeout is 30 seconds TCP PROXY, TCP_PROXY_WITH_SNI, SMA_PROXY: The idle timeout is defined as the period in which there are no bytes sent or received on either the upstream or downstream connection. The default idle timeout is 1 hour. UDP PROXY: The idle timeout for sessions. Idle timeout is defined as the period in which there are no datagrams sent or received on the session. The default if not specified is 1 minute
|
|
118
|
+
|
|
119
|
+
<a id="max-request-header-size"></a>• [`max_request_header_size`](#max-request-header-size) - Optional Number<br>Maximum Request Header Size (KiB). The maximum request header size in KiB for incoming connections. If un-configured, the default max request headers allowed is 60 KiB. Requests that exceed this limit will receive a 431 response. The max configurable limit is 96 KiB, based on current implementation constraints. Note: a. This configuration parameter is applicable only for HTTP_PROXY and HTTPS_PROXY b. When multiple HTTP_PROXY virtual hosts share the same advertise policy, the effective 'maximum request header size' for such virtual hosts is the highest value configured on any of the virtual hosts
|
|
120
|
+
|
|
121
|
+
<a id="no-authentication"></a>• [`no_authentication`](#no-authentication) - Optional Block<br>Enable this option
|
|
122
|
+
|
|
123
|
+
<a id="no-challenge"></a>• [`no_challenge`](#no-challenge) - Optional Block<br>Enable this option
|
|
124
|
+
|
|
125
|
+
<a id="non-default-loadbalancer"></a>• [`non_default_loadbalancer`](#non-default-loadbalancer) - Optional Block<br>Enable this option
|
|
126
|
+
|
|
127
|
+
<a id="proxy"></a>• [`proxy`](#proxy) - Optional String Defaults to `HTTP_PROXY`<br>Possible values are `UDP_PROXY`, `SMA_PROXY`, `DNS_PROXY`, `ZTNA_PROXY`, `UZTNA_PROXY`<br>[Enum: UDP_PROXY|SMA_PROXY|DNS_PROXY|ZTNA_PROXY|UZTNA_PROXY] Type of Proxy. ProxyType tells the type of proxy to install for the virtual host. Only the following combination of VirtualHosts within same AdvertisePolicy is permitted (None of them should have '*' in domains when used with other VirtualHosts in same AdvertisePolicy) 1. Multiple TCP_PROXY_WITH_SNI and multiple HTTPS_PROXY 2. Multiple HTTP_PROXY 3. Multiple HTTPS_PROXY 4. Multiple TCP_PROXY_WITH_SNI HTTPS_PROXY without TLS parameters is not permitted HTTP_PROXY/HTTPS_PROXY/TCP_PROXY_WITH_SNI/SMA_PROXY with empty domains is not permitted TCP_PROXY_WITH_SNI/SMA_PROXY should not have '*' in domains - HTTP_PROXY: HTTP_PROXY Install HTTP proxy. HTTP Proxy is the default proxy installed. - TCP_PROXY: TCP_PROXY Install TCP proxy - TCP_PROXY_WITH_SNI: TCP_PROXY_WITH_SNI Install TCP proxy with SNI Routing - TLS_TCP_PROXY: TCP_PROXY Install TCP proxy - TLS_TCP_PROXY_WITH_SNI: TCP_PROXY_WITH_SNI Install TCP proxy with SNI Routing - HTTPS_PROXY: HTTPS_PROXY Install HTTPS proxy - UDP_PROXY: UDP_PROXY Install UDP proxy - SMA_PROXY: SMA_PROXY Install Secret Management Access proxy - DNS_PROXY: DNS_PROXY Install DNS proxy - ZTNA_PROXY: ZTNA_PROXY Install ZTNA proxy.This is going to be deprecated with UZTNA_PROXY. - UZTNA_PROXY: UZTNA_PROXY Install UZTNA proxy
|
|
128
|
+
|
|
129
|
+
<a id="rate-limiter-allowed-prefixes"></a>• [`rate_limiter_allowed_prefixes`](#rate-limiter-allowed-prefixes) - Optional Block<br>Rate Limiter Allowed Prefixes. References to ip_prefix_set objects. Requests from source IP addresses that are covered by one of the allowed IP Prefixes are not subjected to rate limiting<br>See [Rate Limiter Allowed Prefixes](#rate-limiter-allowed-prefixes) below for details.
|
|
130
|
+
|
|
131
|
+
<a id="request-cookies-to-add"></a>• [`request_cookies_to_add`](#request-cookies-to-add) - Optional Block<br>Add Cookies in Cookie Header. Cookies are key-value pairs to be added to HTTP request being routed towards upstream. Cookies specified at this level are applied after cookies from matched Route are applied<br>See [Request Cookies To Add](#request-cookies-to-add) below for details.
|
|
132
|
+
|
|
133
|
+
<a id="request-cookies-to-remove"></a>• [`request_cookies_to_remove`](#request-cookies-to-remove) - Optional List<br>Remove Cookies from Cookie Header. List of keys of Cookies to be removed from the HTTP request being sent towards upstream
|
|
134
|
+
|
|
135
|
+
<a id="request-headers-to-add"></a>• [`request_headers_to_add`](#request-headers-to-add) - Optional Block<br>Add Request Headers. Headers are key-value pairs to be added to HTTP request being routed towards upstream. Headers specified at this level are applied after headers from matched Route are applied<br>See [Request Headers To Add](#request-headers-to-add) below for details.
|
|
136
|
+
|
|
137
|
+
<a id="request-headers-to-remove"></a>• [`request_headers_to_remove`](#request-headers-to-remove) - Optional List<br>Remove Request Headers. List of keys of Headers to be removed from the HTTP request being sent towards upstream
|
|
138
|
+
|
|
139
|
+
<a id="response-cookies-to-add"></a>• [`response_cookies_to_add`](#response-cookies-to-add) - Optional Block<br>Add Set-Cookie Headers. Cookies are name-value pairs along with optional attribute parameters to be added to HTTP response being sent towards downstream. Cookies specified at this level are applied after cookies from matched Route are applied<br>See [Response Cookies To Add](#response-cookies-to-add) below for details.
|
|
140
|
+
|
|
141
|
+
<a id="response-cookies-to-remove"></a>• [`response_cookies_to_remove`](#response-cookies-to-remove) - Optional List<br>Remove Cookies from Set-Cookie Headers. List of name of Cookies to be removed from the HTTP response being sent towards downstream. Entire set-cookie header will be removed
|
|
142
|
+
|
|
143
|
+
<a id="response-headers-to-add"></a>• [`response_headers_to_add`](#response-headers-to-add) - Optional Block<br>Add Response Headers. Headers are key-value pairs to be added to HTTP response being sent towards downstream. Headers specified at this level are applied after headers from matched Route are applied
|
|
144
|
+
|
|
145
|
+
<a id="response-headers-to-remove"></a>• [`response_headers_to_remove`](#response-headers-to-remove) - Optional List<br>Remove Response Headers. List of keys of Headers to be removed from the HTTP response being sent towards downstream
|
|
146
|
+
|
|
147
|
+
<a id="retry-policy"></a>• [`retry_policy`](#retry-policy) - Optional Block<br>Retry Policy. Retry policy configuration for route destination
|
|
148
|
+
|
|
149
|
+
<a id="routes"></a>• [`routes`](#routes) - Optional Block<br>Routes. The list of routes that will be matched, in order, for incoming requests. The first route that matches will be used. Currently route object is redundant in case of TCP proxy but required. For TCP_PROXY/TCP_PROXY_WITH_SNI/SMA_PROXY VirtualHosts, the route object only specifies the cluster/weighted-cluster as route destination without any match condition. In other words, match condition in route object is ignored for TCP_PROXY/TCP_PROXY_WITH_SNI/SMA_PROXY VirtualHosts. Routes used for TCP_PROXY/TCP_PROXY_WITH_SNI/SMA_PROXY VirtualHosts cannot have DirectResponse or Redirect as actions
|
|
150
|
+
|
|
151
|
+
<a id="sensitive-data-policy"></a>• [`sensitive_data_policy`](#sensitive-data-policy) - Optional Block<br>Sensitive Data Discovery. References to sensitive_data_policy objects
|
|
152
|
+
|
|
153
|
+
<a id="server-name"></a>• [`server_name`](#server-name) - Optional String<br>Server Name. Specifies the value to be used for Server header inserted in responses. This will overwrite existing values if any for Server Header
|
|
154
|
+
|
|
155
|
+
<a id="slow-ddos-mitigation"></a>• [`slow_ddos_mitigation`](#slow-ddos-mitigation) - Optional Block<br>Slow DDOS Mitigation. 'Slow and low' attacks tie up server resources, leaving none available for servicing requests from actual users
|
|
156
|
+
|
|
157
|
+
<a id="timeouts"></a>• [`timeouts`](#timeouts) - Optional Block
|
|
158
|
+
|
|
159
|
+
-> **One of the following:**
|
|
160
|
+
• <a id="tls-cert-params"></a>[`tls_cert_params`](#tls-cert-params) - Optional Block<br>Certificate Parameters. Certificate Parameters for authentication, TLS ciphers, and trust store
|
|
161
|
+
<br><br>• <a id="tls-parameters"></a>[`tls_parameters`](#tls-parameters) - Optional Block<br>Downstream TLS Parameters. TLS configuration for downstream connections
|
|
162
|
+
|
|
163
|
+
<a id="user-identification"></a>• [`user_identification`](#user-identification) - Optional Block<br>User Identification Policy. A reference to user_identification object. The rules in the user_identification object are evaluated to determine the user identifier to be rate limited
|
|
164
|
+
|
|
165
|
+
<a id="waf-type"></a>• [`waf_type`](#waf-type) - Optional Block<br>WAF Instance. WAF instance will be pointing to an app_firewall object
|
|
166
|
+
|
|
167
|
+
### Attributes Reference
|
|
168
|
+
|
|
169
|
+
In addition to all arguments above, the following attributes are exported:
|
|
170
|
+
|
|
171
|
+
<a id="id"></a>• [`id`](#id) - Optional String<br>Unique identifier for the resource
|
|
172
|
+
|
|
173
|
+
---
|
|
174
|
+
|
|
175
|
+
#### Advertise Policies
|
|
176
|
+
|
|
177
|
+
An [`advertise_policies`](#advertise-policies) block supports the following:
|
|
178
|
+
|
|
179
|
+
<a id="advertise-policies-kind"></a>• [`kind`](#advertise-policies-kind) - Optional String<br>Kind. When a configuration object(e.g. virtual_host) refers to another(e.g route) then kind will hold the referred object's kind (e.g. 'route')
|
|
180
|
+
|
|
181
|
+
<a id="advertise-policies-name"></a>• [`name`](#advertise-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
|
|
182
|
+
|
|
183
|
+
<a id="advertise-policies-namespace"></a>• [`namespace`](#advertise-policies-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
|
|
184
|
+
|
|
185
|
+
<a id="advertise-policies-tenant"></a>• [`tenant`](#advertise-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
|
|
186
|
+
|
|
187
|
+
<a id="advertise-policies-uid"></a>• [`uid`](#advertise-policies-uid) - Optional String<br>UID. When a configuration object(e.g. virtual_host) refers to another(e.g route) then uid will hold the referred object's(e.g. route's) uid
|
|
188
|
+
|
|
189
|
+
#### Authentication
|
|
190
|
+
|
|
191
|
+
An [`authentication`](#authentication) block supports the following:
|
|
192
|
+
|
|
193
|
+
<a id="authentication-auth-config"></a>• [`auth_config`](#authentication-auth-config) - Optional Block<br>Reference to Authentication Object. Reference to Authentication Config Object<br>See [Auth Config](#authentication-auth-config) below.
|
|
194
|
+
|
|
195
|
+
<a id="authentication-cookie-params"></a>• [`cookie_params`](#authentication-cookie-params) - Optional Block<br>Cookie Parameters. Specifies different cookie related config parameters for authentication<br>See [Cookie Params](#authentication-cookie-params) below.
|
|
196
|
+
|
|
197
|
+
<a id="authentication-redirect-dynamic"></a>• [`redirect_dynamic`](#authentication-redirect-dynamic) - Optional Block<br>Enable this option
|
|
198
|
+
|
|
199
|
+
<a id="authentication-redirect-url"></a>• [`redirect_url`](#authentication-redirect-url) - Optional String<br>Configure Redirect URL. user can provide a URL for e.g `HTTPS://abc.xyz.com` where user gets redirected. This URL configured here must match with the redirect URL configured with the OIDC provider
|
|
200
|
+
|
|
201
|
+
<a id="authentication-use-auth-object-config"></a>• [`use_auth_object_config`](#authentication-use-auth-object-config) - Optional Block<br>Enable this option
|
|
202
|
+
|
|
203
|
+
#### Authentication Auth Config
|
|
204
|
+
|
|
205
|
+
An [`auth_config`](#authentication-auth-config) block (within [`authentication`](#authentication)) supports the following:
|
|
206
|
+
|
|
207
|
+
<a id="authentication-auth-config-kind"></a>• [`kind`](#authentication-auth-config-kind) - Optional String<br>Kind. When a configuration object(e.g. virtual_host) refers to another(e.g route) then kind will hold the referred object's kind (e.g. 'route')
|
|
208
|
+
|
|
209
|
+
<a id="authentication-auth-config-name"></a>• [`name`](#authentication-auth-config-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
|
|
210
|
+
|
|
211
|
+
<a id="authentication-auth-config-namespace"></a>• [`namespace`](#authentication-auth-config-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
|
|
212
|
+
|
|
213
|
+
<a id="authentication-auth-config-tenant"></a>• [`tenant`](#authentication-auth-config-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
|
|
214
|
+
|
|
215
|
+
<a id="authentication-auth-config-uid"></a>• [`uid`](#authentication-auth-config-uid) - Optional String<br>UID. When a configuration object(e.g. virtual_host) refers to another(e.g route) then uid will hold the referred object's(e.g. route's) uid
|
|
216
|
+
|
|
217
|
+
#### Authentication Cookie Params
|
|
218
|
+
|
|
219
|
+
A [`cookie_params`](#authentication-cookie-params) block (within [`authentication`](#authentication)) supports the following:
|
|
220
|
+
|
|
221
|
+
<a id="authentication-cookie-params-auth-hmac"></a>• [`auth_hmac`](#authentication-cookie-params-auth-hmac) - Optional Block<br>HMAC Key Pair. HMAC primary and secondary keys to be used for hashing the Cookie. Each key also have an associated expiry timestamp, beyond which key is invalid<br>See [Auth HMAC](#authentication-cookie-params-auth-hmac) below.
|
|
222
|
+
|
|
223
|
+
<a id="authentication-cookie-params-cookie-expiry"></a>• [`cookie_expiry`](#authentication-cookie-params-cookie-expiry) - Optional Number<br>Cookie Expiry duration. specifies in seconds max duration of the allocated cookie. This maps to “Max-Age” attribute in the session cookie. This will act as an expiry duration on the client side after which client will not be setting the cookie as part of the request. Default cookie expiry is 3600 seconds
|
|
224
|
+
|
|
225
|
+
<a id="authentication-cookie-params-cookie-refresh-interval"></a>• [`cookie_refresh_interval`](#authentication-cookie-params-cookie-refresh-interval) - Optional Number<br>Cookie Refresh Interval. Specifies in seconds refresh interval for session cookie. This is used to keep the active user active and reduce RE-login. When an incoming cookie's session expiry is still valid, and time to expire falls behind this interval, RE-issue a cookie with new expiry and with the same original session expiry. Default refresh interval is 3000 seconds
|
|
226
|
+
|
|
227
|
+
<a id="authentication-cookie-params-kms-key-hmac"></a>• [`kms_key_hmac`](#authentication-cookie-params-kms-key-hmac) - Optional Block<br>KMS Key Reference. Reference to KMS Key Object
|
|
228
|
+
|
|
229
|
+
<a id="authentication-cookie-params-session-expiry"></a>• [`session_expiry`](#authentication-cookie-params-session-expiry) - Optional Number<br>Session Expiry duration. specifies in seconds max lifetime of an authenticated session after which the user will be forced to login again. Default session expiry is 86400 seconds(24 hours)
|
|
230
|
+
|
|
231
|
+
#### Authentication Cookie Params Auth HMAC
|
|
232
|
+
|
|
233
|
+
An [`auth_hmac`](#authentication-cookie-params-auth-hmac) block (within [`authentication.cookie_params`](#authentication-cookie-params)) supports the following:
|
|
234
|
+
|
|
235
|
+
<a id="authentication-cookie-params-auth-hmac-prim-key"></a>• [`prim_key`](#authentication-cookie-params-auth-hmac-prim-key) - Optional Block<br>Secret. SecretType is used in an object to indicate a sensitive/confidential field<br>See [Prim Key](#authentication-cookie-params-auth-hmac-prim-key) below.
|
|
236
|
+
|
|
237
|
+
<a id="authentication-cookie-params-auth-hmac-prim-key-expiry"></a>• [`prim_key_expiry`](#authentication-cookie-params-auth-hmac-prim-key-expiry) - Optional String<br>HMAC Primary Key Expiry. Primary HMAC Key Expiry time
|
|
238
|
+
|
|
239
|
+
<a id="authentication-cookie-params-auth-hmac-sec-key"></a>• [`sec_key`](#authentication-cookie-params-auth-hmac-sec-key) - Optional Block<br>Secret. SecretType is used in an object to indicate a sensitive/confidential field<br>See [Sec Key](#authentication-cookie-params-auth-hmac-sec-key) below.
|
|
240
|
+
|
|
241
|
+
<a id="authentication-cookie-params-auth-hmac-sec-key-expiry"></a>• [`sec_key_expiry`](#authentication-cookie-params-auth-hmac-sec-key-expiry) - Optional String<br>HMAC Secondary Key Expiry. Secondary HMAC Key Expiry time
|
|
242
|
+
|
|
243
|
+
#### Authentication Cookie Params Auth HMAC Prim Key
|
|
244
|
+
|
|
245
|
+
A [`prim_key`](#authentication-cookie-params-auth-hmac-prim-key) block (within [`authentication.cookie_params.auth_hmac`](#authentication-cookie-params-auth-hmac)) supports the following:
|
|
246
|
+
|
|
247
|
+
<a id="authentication-cookie-params-auth-hmac-prim-key-blindfold-secret-info"></a>• [`blindfold_secret_info`](#authentication-cookie-params-auth-hmac-prim-key-blindfold-secret-info) - Optional Block<br>Blindfold Secret. BlindfoldSecretInfoType specifies information about the Secret managed by F5XC Secret Management<br>See [Blindfold Secret Info](#authentication-cookie-params-auth-hmac-prim-key-blindfold-secret-info) below.
|
|
248
|
+
|
|
249
|
+
<a id="authentication-cookie-params-auth-hmac-prim-key-clear-secret-info"></a>• [`clear_secret_info`](#authentication-cookie-params-auth-hmac-prim-key-clear-secret-info) - Optional Block<br>In-Clear Secret. ClearSecretInfoType specifies information about the Secret that is not encrypted<br>See [Clear Secret Info](#authentication-cookie-params-auth-hmac-prim-key-clear-secret-info) below.
|
|
250
|
+
|
|
251
|
+
#### Authentication Cookie Params Auth HMAC Prim Key Blindfold Secret Info
|
|
252
|
+
|
|
253
|
+
A [`blindfold_secret_info`](#authentication-cookie-params-auth-hmac-prim-key-blindfold-secret-info) block (within [`authentication.cookie_params.auth_hmac.prim_key`](#authentication-cookie-params-auth-hmac-prim-key)) supports the following:
|
|
254
|
+
|
|
255
|
+
<a id="authentication-cookie-params-auth-hmac-prim-key-blindfold-secret-info-decryption-provider"></a>• [`decryption_provider`](#authentication-cookie-params-auth-hmac-prim-key-blindfold-secret-info-decryption-provider) - Optional String<br>Decryption Provider. Name of the Secret Management Access object that contains information about the backend Secret Management service
|
|
256
|
+
|
|
257
|
+
<a id="authentication-cookie-params-auth-hmac-prim-key-blindfold-secret-info-location"></a>• [`location`](#authentication-cookie-params-auth-hmac-prim-key-blindfold-secret-info-location) - 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
|
|
258
|
+
|
|
259
|
+
<a id="authentication-cookie-params-auth-hmac-prim-key-blindfold-secret-info-store-provider"></a>• [`store_provider`](#authentication-cookie-params-auth-hmac-prim-key-blindfold-secret-info-store-provider) - 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:///
|
|
260
|
+
|
|
261
|
+
#### Authentication Cookie Params Auth HMAC Prim Key Clear Secret Info
|
|
262
|
+
|
|
263
|
+
A [`clear_secret_info`](#authentication-cookie-params-auth-hmac-prim-key-clear-secret-info) block (within [`authentication.cookie_params.auth_hmac.prim_key`](#authentication-cookie-params-auth-hmac-prim-key)) supports the following:
|
|
264
|
+
|
|
265
|
+
<a id="authentication-cookie-params-auth-hmac-prim-key-clear-secret-info-provider-ref"></a>• [`provider_ref`](#authentication-cookie-params-auth-hmac-prim-key-clear-secret-info-provider-ref) - 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:///
|
|
266
|
+
|
|
267
|
+
<a id="authentication-cookie-params-auth-hmac-prim-key-clear-secret-info-url"></a>• [`url`](#authentication-cookie-params-auth-hmac-prim-key-clear-secret-info-url) - 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
|
|
268
|
+
|
|
269
|
+
#### Authentication Cookie Params Auth HMAC Sec Key
|
|
270
|
+
|
|
271
|
+
A [`sec_key`](#authentication-cookie-params-auth-hmac-sec-key) block (within [`authentication.cookie_params.auth_hmac`](#authentication-cookie-params-auth-hmac)) supports the following:
|
|
272
|
+
|
|
273
|
+
<a id="authentication-cookie-params-auth-hmac-sec-key-blindfold-secret-info"></a>• [`blindfold_secret_info`](#authentication-cookie-params-auth-hmac-sec-key-blindfold-secret-info) - Optional Block<br>Blindfold Secret. BlindfoldSecretInfoType specifies information about the Secret managed by F5XC Secret Management<br>See [Blindfold Secret Info](#authentication-cookie-params-auth-hmac-sec-key-blindfold-secret-info) below.
|
|
274
|
+
|
|
275
|
+
<a id="authentication-cookie-params-auth-hmac-sec-key-clear-secret-info"></a>• [`clear_secret_info`](#authentication-cookie-params-auth-hmac-sec-key-clear-secret-info) - Optional Block<br>In-Clear Secret. ClearSecretInfoType specifies information about the Secret that is not encrypted<br>See [Clear Secret Info](#authentication-cookie-params-auth-hmac-sec-key-clear-secret-info) below.
|
|
276
|
+
|
|
277
|
+
#### Authentication Cookie Params Auth HMAC Sec Key Blindfold Secret Info
|
|
278
|
+
|
|
279
|
+
A [`blindfold_secret_info`](#authentication-cookie-params-auth-hmac-sec-key-blindfold-secret-info) block (within [`authentication.cookie_params.auth_hmac.sec_key`](#authentication-cookie-params-auth-hmac-sec-key)) supports the following:
|
|
280
|
+
|
|
281
|
+
<a id="authentication-cookie-params-auth-hmac-sec-key-blindfold-secret-info-decryption-provider"></a>• [`decryption_provider`](#authentication-cookie-params-auth-hmac-sec-key-blindfold-secret-info-decryption-provider) - Optional String<br>Decryption Provider. Name of the Secret Management Access object that contains information about the backend Secret Management service
|
|
282
|
+
|
|
283
|
+
<a id="authentication-cookie-params-auth-hmac-sec-key-blindfold-secret-info-location"></a>• [`location`](#authentication-cookie-params-auth-hmac-sec-key-blindfold-secret-info-location) - 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
|
|
284
|
+
|
|
285
|
+
<a id="authentication-cookie-params-auth-hmac-sec-key-blindfold-secret-info-store-provider"></a>• [`store_provider`](#authentication-cookie-params-auth-hmac-sec-key-blindfold-secret-info-store-provider) - 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:///
|
|
286
|
+
|
|
287
|
+
#### Authentication Cookie Params Auth HMAC Sec Key Clear Secret Info
|
|
288
|
+
|
|
289
|
+
A [`clear_secret_info`](#authentication-cookie-params-auth-hmac-sec-key-clear-secret-info) block (within [`authentication.cookie_params.auth_hmac.sec_key`](#authentication-cookie-params-auth-hmac-sec-key)) supports the following:
|
|
290
|
+
|
|
291
|
+
<a id="authentication-cookie-params-auth-hmac-sec-key-clear-secret-info-provider-ref"></a>• [`provider_ref`](#authentication-cookie-params-auth-hmac-sec-key-clear-secret-info-provider-ref) - 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:///
|
|
292
|
+
|
|
293
|
+
<a id="authentication-cookie-params-auth-hmac-sec-key-clear-secret-info-url"></a>• [`url`](#authentication-cookie-params-auth-hmac-sec-key-clear-secret-info-url) - 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
|
|
294
|
+
|
|
295
|
+
#### Buffer Policy
|
|
296
|
+
|
|
297
|
+
A [`buffer_policy`](#buffer-policy) block supports the following:
|
|
298
|
+
|
|
299
|
+
<a id="buffer-policy-disabled"></a>• [`disabled`](#buffer-policy-disabled) - Optional Bool<br>Disable. Disable buffering for a particular route. This is useful when virtual-host has buffering, but we need to disable it on a specific route. The value of this field is ignored for virtual-host
|
|
300
|
+
|
|
301
|
+
<a id="buffer-policy-max-request-bytes"></a>• [`max_request_bytes`](#buffer-policy-max-request-bytes) - Optional Number<br>Max Request Bytes. The maximum request size that the filter will buffer before the connection manager will stop buffering and return a RequestEntityTooLarge (413) response
|
|
302
|
+
|
|
303
|
+
#### Captcha Challenge
|
|
304
|
+
|
|
305
|
+
A [`captcha_challenge`](#captcha-challenge) block supports the following:
|
|
306
|
+
|
|
307
|
+
<a id="captcha-challenge-cookie-expiry"></a>• [`cookie_expiry`](#captcha-challenge-cookie-expiry) - Optional Number<br>Cookie Expiration Period. Cookie expiration period, in seconds. An expired cookie causes the loadbalancer to issue a new challenge
|
|
308
|
+
|
|
309
|
+
<a id="captcha-challenge-custom-page"></a>• [`custom_page`](#captcha-challenge-custom-page) - Optional String<br>Custom message for Captcha Challenge. Custom message is of type uri_ref. Currently supported URL schemes is string:///. For string:/// scheme, message needs to be encoded in Base64 format. You can specify this message as base64 encoded plain text message e.g. 'Please Wait.' or it can be HTML paragraph or a body string encoded as base64 string E.g. '`<p>` Please Wait `</p>`'. Base64 encoded string for this HTML is 'PHA+IFBsZWFzZSBXYWl0IDwvcD4='
|
|
310
|
+
|
|
311
|
+
#### Coalescing Options
|
|
312
|
+
|
|
313
|
+
A [`coalescing_options`](#coalescing-options) block supports the following:
|
|
314
|
+
|
|
315
|
+
<a id="coalescing-options-default-coalescing"></a>• [`default_coalescing`](#coalescing-options-default-coalescing) - Optional Block<br>Enable this option
|
|
316
|
+
|
|
317
|
+
<a id="coalescing-options-strict-coalescing"></a>• [`strict_coalescing`](#coalescing-options-strict-coalescing) - Optional Block<br>Enable this option
|
|
318
|
+
|
|
319
|
+
#### Compression Params
|
|
320
|
+
|
|
321
|
+
A [`compression_params`](#compression-params) block supports the following:
|
|
322
|
+
|
|
323
|
+
<a id="compression-params-content-length"></a>• [`content_length`](#compression-params-content-length) - Optional Number Defaults to `30`<br>Content Length. Minimum response length, in bytes, which will trigger compression. The
|
|
324
|
+
|
|
325
|
+
<a id="compression-params-content-type"></a>• [`content_type`](#compression-params-content-type) - Optional List<br>Content Type. Set of strings that allows specifying which mime-types yield compression When this field is not defined, compression will be applied to the following mime-types: 'application/javascript' 'application/JSON', 'application/xhtml+XML' 'image/svg+XML' 'text/CSS' 'text/HTML' 'text/plain' 'text/XML'
|
|
326
|
+
|
|
327
|
+
<a id="compression-params-disable-on-etag-header"></a>• [`disable_on_etag_header`](#compression-params-disable-on-etag-header) - Optional Bool<br>Disable On Etag Header. If true, disables compression when the response contains an etag header. When it is false, weak etags will be preserved and the ones that require strong validation will be removed
|
|
328
|
+
|
|
329
|
+
<a id="compression-params-remove-accept-encoding-header"></a>• [`remove_accept_encoding_header`](#compression-params-remove-accept-encoding-header) - Optional Bool<br>Remove Accept-Encoding Header. If true, removes accept-encoding from the request headers before dispatching it to the upstream so that responses do not get compressed before reaching the filter
|
|
330
|
+
|
|
331
|
+
#### CORS Policy
|
|
332
|
+
|
|
333
|
+
A [`cors_policy`](#cors-policy) block supports the following:
|
|
334
|
+
|
|
335
|
+
<a id="cors-policy-allow-credentials"></a>• [`allow_credentials`](#cors-policy-allow-credentials) - Optional Bool<br>Allow Credentials. Specifies whether the resource allows credentials
|
|
336
|
+
|
|
337
|
+
<a id="cors-policy-allow-headers"></a>• [`allow_headers`](#cors-policy-allow-headers) - Optional String<br>Allow Headers. Specifies the content for the access-control-allow-headers header
|
|
338
|
+
|
|
339
|
+
<a id="cors-policy-allow-methods"></a>• [`allow_methods`](#cors-policy-allow-methods) - Optional String<br>Allow Methods. Specifies the content for the access-control-allow-methods header
|
|
340
|
+
|
|
341
|
+
<a id="cors-policy-allow-origin"></a>• [`allow_origin`](#cors-policy-allow-origin) - Optional List<br>Allow Origin. Specifies the origins that will be allowed to do CORS requests. An origin is allowed if either allow_origin or allow_origin_regex match
|
|
342
|
+
|
|
343
|
+
<a id="cors-policy-allow-origin-regex"></a>• [`allow_origin_regex`](#cors-policy-allow-origin-regex) - Optional List<br>Allow Origin Regex. Specifies regex patterns that match allowed origins. An origin is allowed if either allow_origin or allow_origin_regex match
|
|
344
|
+
|
|
345
|
+
<a id="cors-policy-disabled"></a>• [`disabled`](#cors-policy-disabled) - Optional Bool<br>Disabled. Disable the CorsPolicy for a particular route. This is useful when virtual-host has CorsPolicy, but we need to disable it on a specific route. The value of this field is ignored for virtual-host
|
|
346
|
+
|
|
347
|
+
<a id="cors-policy-expose-headers"></a>• [`expose_headers`](#cors-policy-expose-headers) - Optional String<br>Expose Headers. Specifies the content for the access-control-expose-headers header
|
|
348
|
+
|
|
349
|
+
<a id="cors-policy-maximum-age"></a>• [`maximum_age`](#cors-policy-maximum-age) - Optional Number<br>Maximum Age. Specifies the content for the access-control-max-age header in seconds. This indicates the maximum number of seconds the results can be cached A value of -1 will disable caching. Maximum permitted value is 86400 seconds (24 hours)
|
|
350
|
+
|
|
351
|
+
#### CSRF Policy
|
|
352
|
+
|
|
353
|
+
A [`csrf_policy`](#csrf-policy) block supports the following:
|
|
354
|
+
|
|
355
|
+
<a id="csrf-policy-all-load-balancer-domains"></a>• [`all_load_balancer_domains`](#csrf-policy-all-load-balancer-domains) - Optional Block<br>Enable this option
|
|
356
|
+
|
|
357
|
+
<a id="csrf-policy-custom-domain-list"></a>• [`custom_domain_list`](#csrf-policy-custom-domain-list) - Optional Block<br>Domain name list. List of domain names used for Host header matching<br>See [Custom Domain List](#csrf-policy-custom-domain-list) below.
|
|
358
|
+
|
|
359
|
+
<a id="csrf-policy-disabled"></a>• [`disabled`](#csrf-policy-disabled) - Optional Block<br>Enable this option
|
|
360
|
+
|
|
361
|
+
#### CSRF Policy Custom Domain List
|
|
362
|
+
|
|
363
|
+
A [`custom_domain_list`](#csrf-policy-custom-domain-list) block (within [`csrf_policy`](#csrf-policy)) supports the following:
|
|
364
|
+
|
|
365
|
+
<a id="csrf-policy-custom-domain-list-domains"></a>• [`domains`](#csrf-policy-custom-domain-list-domains) - Optional List<br>Domain names. A list of domain names that will be matched to loadbalancer. These domains are not used for SNI match. Wildcard names are supported in the suffix or prefix form
|
|
366
|
+
|
|
367
|
+
#### Dynamic Reverse Proxy
|
|
368
|
+
|
|
369
|
+
A [`dynamic_reverse_proxy`](#dynamic-reverse-proxy) block supports the following:
|
|
370
|
+
|
|
371
|
+
<a id="dynamic-reverse-proxy-connection-timeout"></a>• [`connection_timeout`](#dynamic-reverse-proxy-connection-timeout) - Optional Number Defaults to `2000` Specified in milliseconds<br>Connection Timeout. The timeout for new network connections to upstream server. The (2 seconds)
|
|
372
|
+
|
|
373
|
+
<a id="dynamic-reverse-proxy-resolution-network"></a>• [`resolution_network`](#dynamic-reverse-proxy-resolution-network) - Optional Block<br>Resolution Network. Reference to virtual network where the endpoint is resolved. Reference is valid only when the network type is VIRTUAL_NETWORK_PER_SITE or VIRTUAL_NETWORK_GLOBAL. It is ignored for all other network types<br>See [Resolution Network](#dynamic-reverse-proxy-resolution-network) below.
|
|
374
|
+
|
|
375
|
+
<a id="dynamic-reverse-proxy-resolution-network-type"></a>• [`resolution_network_type`](#dynamic-reverse-proxy-resolution-network-type) - Optional String Defaults to `VIRTUAL_NETWORK_SITE_LOCAL`<br>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`<br>[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 Type. 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 every site. Two virtual networks of this type on different sites are neither related nor connected. Constraints: There can be atmost one virtual network of this type in a given site. This network type is supported on CE sites. This network is created automatically and present on all sites Virtual-network of type VIRTUAL_NETWORK_SITE_LOCAL_INSIDE is a private network inside site. It is a secure network and is not connected to public network. Virtual-network of this type is local to every site. Two virtual networks of this type on different sites are neither related nor connected. Constraints: There can be atmost one virtual network of this type in a given site. This network type is supported on CE sites. This network is created during provisioning of site User defined per-site virtual network. Scope of this virtual network is limited to the site. This is not yet supported Virtual-network of type VIRTUAL_NETWORK_PUBLIC directly conects to the public internet. Virtual-network of this type is local to every site. Two virtual networks of this type on different sites are neither related nor connected. Constraints: There can be atmost one virtual network of this type in a given site. This network type is supported on RE sites only It is an internally created by the system. They must not be created by user Virtual Neworks with global scope across different sites in F5XC domain. An example global virtual-network called 'AIN Network' is created for every tenant. for volterra fabric Constraints: It is currently only supported as internally created by the system. vK8s service network for a given tenant. Used to advertise a virtual host only to vk8s pods for that tenant Constraints: It is an internally created by the system. Must not be created by user VER internal network for the site. It can only be used for virtual hosts with SMA_PROXY type proxy Constraints: It is an internally created by the system. Must not be created by user Virtual-network of type VIRTUAL_NETWORK_SITE_LOCAL_INSIDE_OUTSIDE represents both VIRTUAL_NETWORK_SITE_LOCAL and VIRTUAL_NETWORK_SITE_LOCAL_INSIDE Constraints: This network type is only meaningful in an advertise policy When virtual-network of type VIRTUAL_NETWORK_IP_AUTO is selected for an endpoint, VER will try to determine the network based on the provided IP address Constraints: This network type is only meaningful in an endpoint VoltADN Private Network is used on volterra RE(s) to connect to customer private networks This network is created by opening a support ticket This network is per site srv6 network VER IP Fabric network for the site. This Virtual network type is used for exposing virtual host on IP Fabric network on the VER site or for endpoint in IP Fabric network Constraints: It is an internally created by the system. Must not be created by user Network internally created for a segment Constraints: It is an internally created by the system. Must not be created by user
|
|
376
|
+
|
|
377
|
+
<a id="dynamic-reverse-proxy-resolve-endpoint-dynamically"></a>• [`resolve_endpoint_dynamically`](#dynamic-reverse-proxy-resolve-endpoint-dynamically) - Optional Bool<br>Dynamic Endpoint Resolution. x-example : true In this mode of proxy, virtual host will resolve the destination endpoint dynamically. The dynamic resolution is done using a predefined field in the request. This predefined field depends on the ProxyType configured on the Virtual Host. For HTTP traffic, i.e. with ProxyType as HTTP_PROXY or HTTPS_PROXY, virtual host will use the 'HOST' HTTP header from the request and perform DNS resolution to select destination endpoint. For TCP traffic with SNI, (If the ProxyType is TCP_PROXY_WITH_SNI), virtual host will perform DNS resolution using the SNI. The DNS resolution is performed in the virtual network specified in outside_network_type or outside_network In both modes of operation(either using Host header or SNI), the DNS resolution could return multiple addresses. First IPv4 address from such returned list is used as endpoint for the request. The DNS response is cached for 60s by default
|
|
378
|
+
|
|
379
|
+
#### Dynamic Reverse Proxy Resolution Network
|
|
380
|
+
|
|
381
|
+
A [`resolution_network`](#dynamic-reverse-proxy-resolution-network) block (within [`dynamic_reverse_proxy`](#dynamic-reverse-proxy)) supports the following:
|
|
382
|
+
|
|
383
|
+
<a id="dynamic-reverse-proxy-resolution-network-kind"></a>• [`kind`](#dynamic-reverse-proxy-resolution-network-kind) - Optional String<br>Kind. When a configuration object(e.g. virtual_host) refers to another(e.g route) then kind will hold the referred object's kind (e.g. 'route')
|
|
384
|
+
|
|
385
|
+
<a id="dynamic-reverse-proxy-resolution-network-name"></a>• [`name`](#dynamic-reverse-proxy-resolution-network-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
|
|
386
|
+
|
|
387
|
+
<a id="dynamic-reverse-proxy-resolution-network-namespace"></a>• [`namespace`](#dynamic-reverse-proxy-resolution-network-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
|
|
388
|
+
|
|
389
|
+
<a id="dynamic-reverse-proxy-resolution-network-tenant"></a>• [`tenant`](#dynamic-reverse-proxy-resolution-network-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
|
|
390
|
+
|
|
391
|
+
<a id="dynamic-reverse-proxy-resolution-network-uid"></a>• [`uid`](#dynamic-reverse-proxy-resolution-network-uid) - Optional String<br>UID. When a configuration object(e.g. virtual_host) refers to another(e.g route) then uid will hold the referred object's(e.g. route's) uid
|
|
392
|
+
|
|
393
|
+
#### HTTP Protocol Options
|
|
394
|
+
|
|
395
|
+
A [`http_protocol_options`](#http-protocol-options) block supports the following:
|
|
396
|
+
|
|
397
|
+
<a id="http-protocol-options-http-protocol-enable-v1-only"></a>• [`http_protocol_enable_v1_only`](#http-protocol-options-http-protocol-enable-v1-only) - Optional Block<br>HTTP/1.1 Protocol Options. HTTP/1.1 Protocol options for downstream connections<br>See [HTTP Protocol Enable V1 Only](#http-protocol-options-http-protocol-enable-v1-only) below.
|
|
398
|
+
|
|
399
|
+
<a id="http-protocol-options-http-protocol-enable-v1-v2"></a>• [`http_protocol_enable_v1_v2`](#http-protocol-options-http-protocol-enable-v1-v2) - Optional Block<br>Enable this option
|
|
400
|
+
|
|
401
|
+
<a id="http-protocol-options-http-protocol-enable-v2-only"></a>• [`http_protocol_enable_v2_only`](#http-protocol-options-http-protocol-enable-v2-only) - Optional Block<br>Enable this option
|
|
402
|
+
|
|
403
|
+
#### HTTP Protocol Options HTTP Protocol Enable V1 Only
|
|
404
|
+
|
|
405
|
+
A [`http_protocol_enable_v1_only`](#http-protocol-options-http-protocol-enable-v1-only) block (within [`http_protocol_options`](#http-protocol-options)) supports the following:
|
|
406
|
+
|
|
407
|
+
<a id="http-protocol-options-http-protocol-enable-v1-only-header-transformation"></a>• [`header_transformation`](#http-protocol-options-http-protocol-enable-v1-only-header-transformation) - Optional Block<br>Header Transformation. Header Transformation options for HTTP/1.1 request/response headers<br>See [Header Transformation](#http-protocol-options-http-protocol-enable-v1-only-header-transformation) below.
|
|
408
|
+
|
|
409
|
+
#### HTTP Protocol Options HTTP Protocol Enable V1 Only Header Transformation
|
|
410
|
+
|
|
411
|
+
A [`header_transformation`](#http-protocol-options-http-protocol-enable-v1-only-header-transformation) block (within [`http_protocol_options.http_protocol_enable_v1_only`](#http-protocol-options-http-protocol-enable-v1-only)) supports the following:
|
|
412
|
+
|
|
413
|
+
<a id="http-protocol-options-http-protocol-enable-v1-only-header-transformation-default-header-transformation"></a>• [`default_header_transformation`](#http-protocol-options-http-protocol-enable-v1-only-header-transformation-default-header-transformation) - Optional Block<br>Enable this option
|
|
414
|
+
|
|
415
|
+
<a id="http-protocol-options-http-protocol-enable-v1-only-header-transformation-legacy-header-transformation"></a>• [`legacy_header_transformation`](#http-protocol-options-http-protocol-enable-v1-only-header-transformation-legacy-header-transformation) - Optional Block<br>Enable this option
|
|
416
|
+
|
|
417
|
+
<a id="http-protocol-options-http-protocol-enable-v1-only-header-transformation-preserve-case-header-transformation"></a>• [`preserve_case_header_transformation`](#http-protocol-options-http-protocol-enable-v1-only-header-transformation-preserve-case-header-transformation) - Optional Block<br>Enable this option
|
|
418
|
+
|
|
419
|
+
<a id="http-protocol-options-http-protocol-enable-v1-only-header-transformation-proper-case-header-transformation"></a>• [`proper_case_header_transformation`](#http-protocol-options-http-protocol-enable-v1-only-header-transformation-proper-case-header-transformation) - Optional Block<br>Enable this option
|
|
420
|
+
|
|
421
|
+
#### Js Challenge
|
|
422
|
+
|
|
423
|
+
A [`js_challenge`](#js-challenge) block supports the following:
|
|
424
|
+
|
|
425
|
+
<a id="js-challenge-cookie-expiry"></a>• [`cookie_expiry`](#js-challenge-cookie-expiry) - Optional Number<br>Cookie Expiration Period. Cookie expiration period, in seconds. An expired cookie causes the loadbalancer to issue a new challenge
|
|
426
|
+
|
|
427
|
+
<a id="js-challenge-custom-page"></a>• [`custom_page`](#js-challenge-custom-page) - Optional String<br>Custom Message for Javascript Challenge. Custom message is of type uri_ref. Currently supported URL schemes is string:///. For string:/// scheme, message needs to be encoded in Base64 format. You can specify this message as base64 encoded plain text message e.g. 'Please Wait.' or it can be HTML paragraph or a body string encoded as base64 string E.g. '`<p>` Please Wait `</p>`'. Base64 encoded string for this HTML is 'PHA+IFBsZWFzZSBXYWl0IDwvcD4='
|
|
428
|
+
|
|
429
|
+
<a id="js-challenge-js-script-delay"></a>• [`js_script_delay`](#js-challenge-js-script-delay) - Optional Number<br>Javascript Delay. Delay introduced by Javascript, in milliseconds
|
|
430
|
+
|
|
431
|
+
#### Rate Limiter Allowed Prefixes
|
|
432
|
+
|
|
433
|
+
A [`rate_limiter_allowed_prefixes`](#rate-limiter-allowed-prefixes) block supports the following:
|
|
434
|
+
|
|
435
|
+
<a id="rate-limiter-allowed-prefixes-kind"></a>• [`kind`](#rate-limiter-allowed-prefixes-kind) - Optional String<br>Kind. When a configuration object(e.g. virtual_host) refers to another(e.g route) then kind will hold the referred object's kind (e.g. 'route')
|
|
436
|
+
|
|
437
|
+
<a id="rate-limiter-allowed-prefixes-name"></a>• [`name`](#rate-limiter-allowed-prefixes-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
|
|
438
|
+
|
|
439
|
+
<a id="rate-limiter-allowed-prefixes-namespace"></a>• [`namespace`](#rate-limiter-allowed-prefixes-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
|
|
440
|
+
|
|
441
|
+
<a id="rate-limiter-allowed-prefixes-tenant"></a>• [`tenant`](#rate-limiter-allowed-prefixes-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
|
|
442
|
+
|
|
443
|
+
<a id="rate-limiter-allowed-prefixes-uid"></a>• [`uid`](#rate-limiter-allowed-prefixes-uid) - Optional String<br>UID. When a configuration object(e.g. virtual_host) refers to another(e.g route) then uid will hold the referred object's(e.g. route's) uid
|
|
444
|
+
|
|
445
|
+
#### Request Cookies To Add
|
|
446
|
+
|
|
447
|
+
A [`request_cookies_to_add`](#request-cookies-to-add) block supports the following:
|
|
448
|
+
|
|
449
|
+
<a id="request-cookies-to-add-name"></a>• [`name`](#request-cookies-to-add-name) - Optional String<br>Name. Name of the cookie in Cookie header
|
|
450
|
+
|
|
451
|
+
<a id="request-cookies-to-add-overwrite"></a>• [`overwrite`](#request-cookies-to-add-overwrite) - Optional Bool Defaults to `do`<br>Overwrite. Should the value be overwritten? If true, the value is overwritten to existing values. not overwrite
|
|
452
|
+
|
|
453
|
+
<a id="request-cookies-to-add-secret-value"></a>• [`secret_value`](#request-cookies-to-add-secret-value) - Optional Block<br>Secret. SecretType is used in an object to indicate a sensitive/confidential field<br>See [Secret Value](#request-cookies-to-add-secret-value) below.
|
|
454
|
+
|
|
455
|
+
<a id="request-cookies-to-add-value"></a>• [`value`](#request-cookies-to-add-value) - Optional String<br>Value. Value of the Cookie header
|
|
456
|
+
|
|
457
|
+
#### Request Cookies To Add Secret Value
|
|
458
|
+
|
|
459
|
+
A [`secret_value`](#request-cookies-to-add-secret-value) block (within [`request_cookies_to_add`](#request-cookies-to-add)) supports the following:
|
|
460
|
+
|
|
461
|
+
<a id="request-cookies-to-add-secret-value-blindfold-secret-info"></a>• [`blindfold_secret_info`](#request-cookies-to-add-secret-value-blindfold-secret-info) - Optional Block<br>Blindfold Secret. BlindfoldSecretInfoType specifies information about the Secret managed by F5XC Secret Management<br>See [Blindfold Secret Info](#request-cookies-to-add-secret-value-blindfold-secret-info) below.
|
|
462
|
+
|
|
463
|
+
<a id="request-cookies-to-add-secret-value-clear-secret-info"></a>• [`clear_secret_info`](#request-cookies-to-add-secret-value-clear-secret-info) - Optional Block<br>In-Clear Secret. ClearSecretInfoType specifies information about the Secret that is not encrypted<br>See [Clear Secret Info](#request-cookies-to-add-secret-value-clear-secret-info) below.
|
|
464
|
+
|
|
465
|
+
#### Request Cookies To Add Secret Value Blindfold Secret Info
|
|
466
|
+
|
|
467
|
+
A [`blindfold_secret_info`](#request-cookies-to-add-secret-value-blindfold-secret-info) block (within [`request_cookies_to_add.secret_value`](#request-cookies-to-add-secret-value)) supports the following:
|
|
468
|
+
|
|
469
|
+
<a id="request-cookies-to-add-secret-value-blindfold-secret-info-decryption-provider"></a>• [`decryption_provider`](#request-cookies-to-add-secret-value-blindfold-secret-info-decryption-provider) - Optional String<br>Decryption Provider. Name of the Secret Management Access object that contains information about the backend Secret Management service
|
|
470
|
+
|
|
471
|
+
<a id="request-cookies-to-add-secret-value-blindfold-secret-info-location"></a>• [`location`](#request-cookies-to-add-secret-value-blindfold-secret-info-location) - 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
|
|
472
|
+
|
|
473
|
+
<a id="request-cookies-to-add-secret-value-blindfold-secret-info-store-provider"></a>• [`store_provider`](#request-cookies-to-add-secret-value-blindfold-secret-info-store-provider) - 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:///
|
|
474
|
+
|
|
475
|
+
#### Request Cookies To Add Secret Value Clear Secret Info
|
|
476
|
+
|
|
477
|
+
A [`clear_secret_info`](#request-cookies-to-add-secret-value-clear-secret-info) block (within [`request_cookies_to_add.secret_value`](#request-cookies-to-add-secret-value)) supports the following:
|
|
478
|
+
|
|
479
|
+
<a id="request-cookies-to-add-secret-value-clear-secret-info-provider-ref"></a>• [`provider_ref`](#request-cookies-to-add-secret-value-clear-secret-info-provider-ref) - 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:///
|
|
480
|
+
|
|
481
|
+
<a id="request-cookies-to-add-secret-value-clear-secret-info-url"></a>• [`url`](#request-cookies-to-add-secret-value-clear-secret-info-url) - 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
|
|
482
|
+
|
|
483
|
+
#### Request Headers To Add
|
|
484
|
+
|
|
485
|
+
A [`request_headers_to_add`](#request-headers-to-add) block supports the following:
|
|
486
|
+
|
|
487
|
+
<a id="request-headers-to-add-append"></a>• [`append`](#request-headers-to-add-append) - Optional Bool Defaults to `do`<br>Append. Should the value be appended? If true, the value is appended to existing values. not append
|
|
488
|
+
|
|
489
|
+
<a id="request-headers-to-add-name"></a>• [`name`](#request-headers-to-add-name) - Optional String<br>Name. Name of the HTTP header
|
|
490
|
+
|
|
491
|
+
<a id="request-headers-to-add-secret-value"></a>• [`secret_value`](#request-headers-to-add-secret-value) - Optional Block<br>Secret. SecretType is used in an object to indicate a sensitive/confidential field<br>See [Secret Value](#request-headers-to-add-secret-value) below.
|
|
492
|
+
|
|
493
|
+
<a id="request-headers-to-add-value"></a>• [`value`](#request-headers-to-add-value) - Optional String<br>Value. Value of the HTTP header
|
|
494
|
+
|
|
495
|
+
#### Request Headers To Add Secret Value
|
|
496
|
+
|
|
497
|
+
A [`secret_value`](#request-headers-to-add-secret-value) block (within [`request_headers_to_add`](#request-headers-to-add)) supports the following:
|
|
498
|
+
|
|
499
|
+
<a id="request-headers-to-add-secret-value-blindfold-secret-info"></a>• [`blindfold_secret_info`](#request-headers-to-add-secret-value-blindfold-secret-info) - Optional Block<br>Blindfold Secret. BlindfoldSecretInfoType specifies information about the Secret managed by F5XC Secret Management<br>See [Blindfold Secret Info](#request-headers-to-add-secret-value-blindfold-secret-info) below.
|
|
500
|
+
|
|
501
|
+
<a id="request-headers-to-add-secret-value-clear-secret-info"></a>• [`clear_secret_info`](#request-headers-to-add-secret-value-clear-secret-info) - Optional Block<br>In-Clear Secret. ClearSecretInfoType specifies information about the Secret that is not encrypted<br>See [Clear Secret Info](#request-headers-to-add-secret-value-clear-secret-info) below.
|
|
502
|
+
|
|
503
|
+
#### Request Headers To Add Secret Value Blindfold Secret Info
|
|
504
|
+
|
|
505
|
+
A [`blindfold_secret_info`](#request-headers-to-add-secret-value-blindfold-secret-info) block (within [`request_headers_to_add.secret_value`](#request-headers-to-add-secret-value)) supports the following:
|
|
506
|
+
|
|
507
|
+
<a id="request-headers-to-add-secret-value-blindfold-secret-info-decryption-provider"></a>• [`decryption_provider`](#request-headers-to-add-secret-value-blindfold-secret-info-decryption-provider) - Optional String<br>Decryption Provider. Name of the Secret Management Access object that contains information about the backend Secret Management service
|
|
508
|
+
|
|
509
|
+
<a id="request-headers-to-add-secret-value-blindfold-secret-info-location"></a>• [`location`](#request-headers-to-add-secret-value-blindfold-secret-info-location) - 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
|
|
510
|
+
|
|
511
|
+
<a id="request-headers-to-add-secret-value-blindfold-secret-info-store-provider"></a>• [`store_provider`](#request-headers-to-add-secret-value-blindfold-secret-info-store-provider) - 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:///
|
|
512
|
+
|
|
513
|
+
#### Request Headers To Add Secret Value Clear Secret Info
|
|
514
|
+
|
|
515
|
+
A [`clear_secret_info`](#request-headers-to-add-secret-value-clear-secret-info) block (within [`request_headers_to_add.secret_value`](#request-headers-to-add-secret-value)) supports the following:
|
|
516
|
+
|
|
517
|
+
<a id="request-headers-to-add-secret-value-clear-secret-info-provider-ref"></a>• [`provider_ref`](#request-headers-to-add-secret-value-clear-secret-info-provider-ref) - 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:///
|
|
518
|
+
|
|
519
|
+
<a id="request-headers-to-add-secret-value-clear-secret-info-url"></a>• [`url`](#request-headers-to-add-secret-value-clear-secret-info-url) - 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
|
|
520
|
+
|
|
521
|
+
#### Response Cookies To Add
|
|
522
|
+
|
|
523
|
+
A [`response_cookies_to_add`](#response-cookies-to-add) block supports the following:
|
|
524
|
+
|
|
525
|
+
<a id="response-cookies-to-add-add-domain"></a>• [`add_domain`](#response-cookies-to-add-add-domain) - Optional String<br>Add Domain. Add domain attribute
|
|
526
|
+
|
|
527
|
+
<a id="response-cookies-to-add-add-expiry"></a>• [`add_expiry`](#response-cookies-to-add-add-expiry) - Optional String<br>Add expiry. Add expiry attribute
|
|
528
|
+
|
|
529
|
+
<a id="response-cookies-to-add-add-httponly"></a>• [`add_httponly`](#response-cookies-to-add-add-httponly) - Optional Block<br>Enable this option
|
|
530
|
+
|
|
531
|
+
<a id="response-cookies-to-add-add-partitioned"></a>• [`add_partitioned`](#response-cookies-to-add-add-partitioned) - Optional Block<br>Enable this option
|
|
532
|
+
|
|
533
|
+
<a id="response-cookies-to-add-add-path"></a>• [`add_path`](#response-cookies-to-add-add-path) - Optional String<br>Add path. Add path attribute
|
|
534
|
+
|
|
535
|
+
<a id="response-cookies-to-add-add-secure"></a>• [`add_secure`](#response-cookies-to-add-add-secure) - Optional Block<br>Enable this option
|
|
536
|
+
|
|
537
|
+
<a id="response-cookies-to-add-ignore-domain"></a>• [`ignore_domain`](#response-cookies-to-add-ignore-domain) - Optional Block<br>Enable this option
|
|
538
|
+
|
|
539
|
+
<a id="response-cookies-to-add-ignore-expiry"></a>• [`ignore_expiry`](#response-cookies-to-add-ignore-expiry) - Optional Block<br>Enable this option
|
|
540
|
+
|
|
541
|
+
<a id="response-cookies-to-add-ignore-httponly"></a>• [`ignore_httponly`](#response-cookies-to-add-ignore-httponly) - Optional Block<br>Enable this option
|
|
542
|
+
|
|
543
|
+
<a id="response-cookies-to-add-ignore-max-age"></a>• [`ignore_max_age`](#response-cookies-to-add-ignore-max-age) - Optional Block<br>Enable this option
|
|
544
|
+
|
|
545
|
+
<a id="response-cookies-to-add-ignore-partitioned"></a>• [`ignore_partitioned`](#response-cookies-to-add-ignore-partitioned) - Optional Block<br>Enable this option
|
|
546
|
+
|
|
547
|
+
<a id="response-cookies-to-add-ignore-path"></a>• [`ignore_path`](#response-cookies-to-add-ignore-path) - Optional Block<br>Enable this option
|
|
548
|
+
|
|
549
|
+
<a id="response-cookies-to-add-ignore-samesite"></a>• [`ignore_samesite`](#response-cookies-to-add-ignore-samesite) - Optional Block<br>Enable this option
|
|
550
|
+
|
|
551
|
+
<a id="response-cookies-to-add-ignore-secure"></a>• [`ignore_secure`](#response-cookies-to-add-ignore-secure) - Optional Block<br>Enable this option
|
|
552
|
+
|
|
553
|
+
<a id="response-cookies-to-add-ignore-value"></a>• [`ignore_value`](#response-cookies-to-add-ignore-value) - Optional Block<br>Enable this option
|
|
554
|
+
|
|
555
|
+
<a id="response-cookies-to-add-max-age-value"></a>• [`max_age_value`](#response-cookies-to-add-max-age-value) - Optional Number<br>Add Max Age. Add max age attribute
|
|
556
|
+
|
|
557
|
+
<a id="response-cookies-to-add-name"></a>• [`name`](#response-cookies-to-add-name) - Optional String<br>Name. Name of the cookie in Cookie header
|
|
558
|
+
|
|
559
|
+
<a id="response-cookies-to-add-overwrite"></a>• [`overwrite`](#response-cookies-to-add-overwrite) - Optional Bool Defaults to `do`<br>Overwrite. Should the value be overwritten? If true, the value is overwritten to existing values. not overwrite
|
|
560
|
+
|
|
561
|
+
<a id="response-cookies-to-add-samesite-lax"></a>• [`samesite_lax`](#response-cookies-to-add-samesite-lax) - Optional Block<br>Enable this option
|
|
562
|
+
|
|
563
|
+
<a id="response-cookies-to-add-samesite-none"></a>• [`samesite_none`](#response-cookies-to-add-samesite-none) - Optional Block<br>Enable this option
|
|
564
|
+
|
|
565
|
+
<a id="response-cookies-to-add-samesite-strict"></a>• [`samesite_strict`](#response-cookies-to-add-samesite-strict) - Optional Block<br>Enable this option
|
|
566
|
+
|
|
567
|
+
<a id="response-cookies-to-add-secret-value"></a>• [`secret_value`](#response-cookies-to-add-secret-value) - Optional Block<br>Secret. SecretType is used in an object to indicate a sensitive/confidential field<br>See [Secret Value](#response-cookies-to-add-secret-value) below.
|
|
568
|
+
|
|
569
|
+
<a id="response-cookies-to-add-value"></a>• [`value`](#response-cookies-to-add-value) - Optional String<br>Value. Value of the Cookie header
|
|
570
|
+
|
|
571
|
+
#### Response Cookies To Add Secret Value
|
|
572
|
+
|
|
573
|
+
A [`secret_value`](#response-cookies-to-add-secret-value) block (within [`response_cookies_to_add`](#response-cookies-to-add)) supports the following:
|
|
574
|
+
|
|
575
|
+
<a id="response-cookies-to-add-secret-value-blindfold-secret-info"></a>• [`blindfold_secret_info`](#response-cookies-to-add-secret-value-blindfold-secret-info) - Optional Block<br>Blindfold Secret. BlindfoldSecretInfoType specifies information about the Secret managed by F5XC Secret Management<br>See [Blindfold Secret Info](#response-cookies-to-add-secret-value-blindfold-secret-info) below.
|
|
576
|
+
|
|
577
|
+
<a id="response-cookies-to-add-secret-value-clear-secret-info"></a>• [`clear_secret_info`](#response-cookies-to-add-secret-value-clear-secret-info) - Optional Block<br>In-Clear Secret. ClearSecretInfoType specifies information about the Secret that is not encrypted<br>See [Clear Secret Info](#response-cookies-to-add-secret-value-clear-secret-info) below.
|
|
578
|
+
|
|
579
|
+
#### Response Cookies To Add Secret Value Blindfold Secret Info
|
|
580
|
+
|
|
581
|
+
A [`blindfold_secret_info`](#response-cookies-to-add-secret-value-blindfold-secret-info) block (within [`response_cookies_to_add.secret_value`](#response-cookies-to-add-secret-value)) supports the following:
|
|
582
|
+
|
|
583
|
+
<a id="response-cookies-to-add-secret-value-blindfold-secret-info-decryption-provider"></a>• [`decryption_provider`](#response-cookies-to-add-secret-value-blindfold-secret-info-decryption-provider) - Optional String<br>Decryption Provider. Name of the Secret Management Access object that contains information about the backend Secret Management service
|
|
584
|
+
|
|
585
|
+
<a id="response-cookies-to-add-secret-value-blindfold-secret-info-location"></a>• [`location`](#response-cookies-to-add-secret-value-blindfold-secret-info-location) - 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
|
|
586
|
+
|
|
587
|
+
<a id="response-cookies-to-add-secret-value-blindfold-secret-info-store-provider"></a>• [`store_provider`](#response-cookies-to-add-secret-value-blindfold-secret-info-store-provider) - 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:///
|
|
588
|
+
|
|
589
|
+
#### Response Cookies To Add Secret Value Clear Secret Info
|
|
590
|
+
|
|
591
|
+
A [`clear_secret_info`](#response-cookies-to-add-secret-value-clear-secret-info) block (within [`response_cookies_to_add.secret_value`](#response-cookies-to-add-secret-value)) supports the following:
|
|
592
|
+
|
|
593
|
+
<a id="response-cookies-to-add-secret-value-clear-secret-info-provider-ref"></a>• [`provider_ref`](#response-cookies-to-add-secret-value-clear-secret-info-provider-ref) - 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:///
|
|
594
|
+
|
|
595
|
+
<a id="response-cookies-to-add-secret-value-clear-secret-info-url"></a>• [`url`](#response-cookies-to-add-secret-value-clear-secret-info-url) - 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
|
|
596
|
+
|
|
597
|
+
#### Response Headers To Add
|
|
598
|
+
|
|
599
|
+
A [`response_headers_to_add`](#response-headers-to-add) block supports the following:
|
|
600
|
+
|
|
601
|
+
<a id="response-headers-to-add-append"></a>• [`append`](#response-headers-to-add-append) - Optional Bool Defaults to `do`<br>Append. Should the value be appended? If true, the value is appended to existing values. not append
|
|
602
|
+
|
|
603
|
+
<a id="response-headers-to-add-name"></a>• [`name`](#response-headers-to-add-name) - Optional String<br>Name. Name of the HTTP header
|
|
604
|
+
|
|
605
|
+
<a id="response-headers-to-add-secret-value"></a>• [`secret_value`](#response-headers-to-add-secret-value) - Optional Block<br>Secret. SecretType is used in an object to indicate a sensitive/confidential field<br>See [Secret Value](#response-headers-to-add-secret-value) below.
|
|
606
|
+
|
|
607
|
+
<a id="response-headers-to-add-value"></a>• [`value`](#response-headers-to-add-value) - Optional String<br>Value. Value of the HTTP header
|
|
608
|
+
|
|
609
|
+
#### Response Headers To Add Secret Value
|
|
610
|
+
|
|
611
|
+
A [`secret_value`](#response-headers-to-add-secret-value) block (within [`response_headers_to_add`](#response-headers-to-add)) supports the following:
|
|
612
|
+
|
|
613
|
+
<a id="response-headers-to-add-secret-value-blindfold-secret-info"></a>• [`blindfold_secret_info`](#response-headers-to-add-secret-value-blindfold-secret-info) - Optional Block<br>Blindfold Secret. BlindfoldSecretInfoType specifies information about the Secret managed by F5XC Secret Management<br>See [Blindfold Secret Info](#response-headers-to-add-secret-value-blindfold-secret-info) below.
|
|
614
|
+
|
|
615
|
+
<a id="response-headers-to-add-secret-value-clear-secret-info"></a>• [`clear_secret_info`](#response-headers-to-add-secret-value-clear-secret-info) - Optional Block<br>In-Clear Secret. ClearSecretInfoType specifies information about the Secret that is not encrypted<br>See [Clear Secret Info](#response-headers-to-add-secret-value-clear-secret-info) below.
|
|
616
|
+
|
|
617
|
+
#### Response Headers To Add Secret Value Blindfold Secret Info
|
|
618
|
+
|
|
619
|
+
A [`blindfold_secret_info`](#response-headers-to-add-secret-value-blindfold-secret-info) block (within [`response_headers_to_add.secret_value`](#response-headers-to-add-secret-value)) supports the following:
|
|
620
|
+
|
|
621
|
+
<a id="response-headers-to-add-secret-value-blindfold-secret-info-decryption-provider"></a>• [`decryption_provider`](#response-headers-to-add-secret-value-blindfold-secret-info-decryption-provider) - Optional String<br>Decryption Provider. Name of the Secret Management Access object that contains information about the backend Secret Management service
|
|
622
|
+
|
|
623
|
+
<a id="response-headers-to-add-secret-value-blindfold-secret-info-location"></a>• [`location`](#response-headers-to-add-secret-value-blindfold-secret-info-location) - 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
|
|
624
|
+
|
|
625
|
+
<a id="response-headers-to-add-secret-value-blindfold-secret-info-store-provider"></a>• [`store_provider`](#response-headers-to-add-secret-value-blindfold-secret-info-store-provider) - 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:///
|
|
626
|
+
|
|
627
|
+
#### Response Headers To Add Secret Value Clear Secret Info
|
|
628
|
+
|
|
629
|
+
A [`clear_secret_info`](#response-headers-to-add-secret-value-clear-secret-info) block (within [`response_headers_to_add.secret_value`](#response-headers-to-add-secret-value)) supports the following:
|
|
630
|
+
|
|
631
|
+
<a id="response-headers-to-add-secret-value-clear-secret-info-provider-ref"></a>• [`provider_ref`](#response-headers-to-add-secret-value-clear-secret-info-provider-ref) - 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:///
|
|
632
|
+
|
|
633
|
+
<a id="response-headers-to-add-secret-value-clear-secret-info-url"></a>• [`url`](#response-headers-to-add-secret-value-clear-secret-info-url) - 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
|
|
634
|
+
|
|
635
|
+
#### Retry Policy
|
|
636
|
+
|
|
637
|
+
A [`retry_policy`](#retry-policy) block supports the following:
|
|
638
|
+
|
|
639
|
+
<a id="retry-policy-back-off"></a>• [`back_off`](#retry-policy-back-off) - Optional Block<br>Retry BackOff Interval. Specifies parameters that control retry back off<br>See [Back Off](#retry-policy-back-off) below.
|
|
640
|
+
|
|
641
|
+
<a id="retry-policy-num-retries"></a>• [`num_retries`](#retry-policy-num-retries) - Optional Number Defaults to `1`<br>Number of Retries. Specifies the allowed number of retries. Retries can be done any number of times. An exponential back-off algorithm is used between each retry
|
|
642
|
+
|
|
643
|
+
<a id="retry-policy-per-try-timeout"></a>• [`per_try_timeout`](#retry-policy-per-try-timeout) - Optional Number<br>Per Try Timeout. Specifies a non-zero timeout per retry attempt. In milliseconds
|
|
644
|
+
|
|
645
|
+
<a id="retry-policy-retriable-status-codes"></a>• [`retriable_status_codes`](#retry-policy-retriable-status-codes) - Optional List<br>Status Code to Retry. HTTP status codes that should trigger a retry in addition to those specified by retry_on
|
|
646
|
+
|
|
647
|
+
<a id="retry-policy-retry-condition"></a>• [`retry_condition`](#retry-policy-retry-condition) - Optional List<br>Retry Condition. Specifies the conditions under which retry takes place. Retries can be on different types of condition depending on application requirements. For example, network failure, all 5xx response codes, idempotent 4xx response codes, etc The possible values are '5xx' : Retry will be done if the upstream server responds with any 5xx response code, or does not respond at all (disconnect/reset/read timeout). 'gateway-error' : Retry will be done only if the upstream server responds with 502, 503 or 504 responses (Included in 5xx) 'connect-failure' : Retry will be done if the request fails because of a connection failure to the upstream server (connect timeout, etc.). (Included in 5xx) 'refused-stream' : Retry is done if the upstream server resets the stream with a REFUSED_STREAM error code (Included in 5xx) 'retriable-4xx' : Retry is done if the upstream server responds with a retriable 4xx response code. The only response code in this category is HTTP CONFLICT (409) 'retriable-status-codes' : Retry is done if the upstream server responds with any response code matching one defined in retriable_status_codes field 'reset' : Retry is done if the upstream server does not respond at all (disconnect/reset/read timeout.)
|
|
648
|
+
|
|
649
|
+
#### Retry Policy Back Off
|
|
650
|
+
|
|
651
|
+
A [`back_off`](#retry-policy-back-off) block (within [`retry_policy`](#retry-policy)) supports the following:
|
|
652
|
+
|
|
653
|
+
<a id="retry-policy-back-off-base-interval"></a>• [`base_interval`](#retry-policy-back-off-base-interval) - Optional Number<br>Base Retry Interval. Specifies the base interval between retries in milliseconds
|
|
654
|
+
|
|
655
|
+
<a id="retry-policy-back-off-max-interval"></a>• [`max_interval`](#retry-policy-back-off-max-interval) - Optional Number Defaults to `10`<br>Maximum Retry Interval. Specifies the maximum interval between retries in milliseconds. This parameter is optional, but must be greater than or equal to the base_interval if set. The times the base_interval
|
|
656
|
+
|
|
657
|
+
#### Routes
|
|
658
|
+
|
|
659
|
+
A [`routes`](#routes) block supports the following:
|
|
660
|
+
|
|
661
|
+
<a id="routes-kind"></a>• [`kind`](#routes-kind) - Optional String<br>Kind. When a configuration object(e.g. virtual_host) refers to another(e.g route) then kind will hold the referred object's kind (e.g. 'route')
|
|
662
|
+
|
|
663
|
+
<a id="routes-name"></a>• [`name`](#routes-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
|
|
664
|
+
|
|
665
|
+
<a id="routes-namespace"></a>• [`namespace`](#routes-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
|
|
666
|
+
|
|
667
|
+
<a id="routes-tenant"></a>• [`tenant`](#routes-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
|
|
668
|
+
|
|
669
|
+
<a id="routes-uid"></a>• [`uid`](#routes-uid) - Optional String<br>UID. When a configuration object(e.g. virtual_host) refers to another(e.g route) then uid will hold the referred object's(e.g. route's) uid
|
|
670
|
+
|
|
671
|
+
#### Sensitive Data Policy
|
|
672
|
+
|
|
673
|
+
A [`sensitive_data_policy`](#sensitive-data-policy) block supports the following:
|
|
674
|
+
|
|
675
|
+
<a id="sensitive-data-policy-kind"></a>• [`kind`](#sensitive-data-policy-kind) - Optional String<br>Kind. When a configuration object(e.g. virtual_host) refers to another(e.g route) then kind will hold the referred object's kind (e.g. 'route')
|
|
676
|
+
|
|
677
|
+
<a id="sensitive-data-policy-name"></a>• [`name`](#sensitive-data-policy-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
|
|
678
|
+
|
|
679
|
+
<a id="sensitive-data-policy-namespace"></a>• [`namespace`](#sensitive-data-policy-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
|
|
680
|
+
|
|
681
|
+
<a id="sensitive-data-policy-tenant"></a>• [`tenant`](#sensitive-data-policy-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
|
|
682
|
+
|
|
683
|
+
<a id="sensitive-data-policy-uid"></a>• [`uid`](#sensitive-data-policy-uid) - Optional String<br>UID. When a configuration object(e.g. virtual_host) refers to another(e.g route) then uid will hold the referred object's(e.g. route's) uid
|
|
684
|
+
|
|
685
|
+
#### Slow DDOS Mitigation
|
|
686
|
+
|
|
687
|
+
A [`slow_ddos_mitigation`](#slow-ddos-mitigation) block supports the following:
|
|
688
|
+
|
|
689
|
+
<a id="slow-ddos-mitigation-disable-request-timeout"></a>• [`disable_request_timeout`](#slow-ddos-mitigation-disable-request-timeout) - Optional Block<br>Enable this option
|
|
690
|
+
|
|
691
|
+
<a id="slow-ddos-mitigation-request-headers-timeout"></a>• [`request_headers_timeout`](#slow-ddos-mitigation-request-headers-timeout) - Optional Number Defaults to `10000`<br>Request Headers Timeout. The amount of time the client has to send only the headers on the request stream before the stream is cancelled. The milliseconds. This setting provides protection against Slowloris attacks
|
|
692
|
+
|
|
693
|
+
<a id="slow-ddos-mitigation-request-timeout"></a>• [`request_timeout`](#slow-ddos-mitigation-request-timeout) - Optional Number<br>Custom Timeout
|
|
694
|
+
|
|
695
|
+
#### Timeouts
|
|
696
|
+
|
|
697
|
+
A [`timeouts`](#timeouts) block supports the following:
|
|
698
|
+
|
|
699
|
+
<a id="timeouts-create"></a>• [`create`](#timeouts-create) - Optional String (Defaults to `10 minutes`)<br>Used when creating the resource
|
|
700
|
+
|
|
701
|
+
<a id="timeouts-delete"></a>• [`delete`](#timeouts-delete) - Optional String (Defaults to `10 minutes`)<br>Used when deleting the resource
|
|
702
|
+
|
|
703
|
+
<a id="timeouts-read"></a>• [`read`](#timeouts-read) - Optional String (Defaults to `5 minutes`)<br>Used when retrieving the resource
|
|
704
|
+
|
|
705
|
+
<a id="timeouts-update"></a>• [`update`](#timeouts-update) - Optional String (Defaults to `10 minutes`)<br>Used when updating the resource
|
|
706
|
+
|
|
707
|
+
#### TLS Cert Params
|
|
708
|
+
|
|
709
|
+
A [`tls_cert_params`](#tls-cert-params) block supports the following:
|
|
710
|
+
|
|
711
|
+
<a id="tls-cert-params-certificates"></a>• [`certificates`](#tls-cert-params-certificates) - Optional Block<br>Certificates. Set of certificates<br>See [Certificates](#tls-cert-params-certificates) below.
|
|
712
|
+
|
|
713
|
+
<a id="tls-cert-params-cipher-suites"></a>• [`cipher_suites`](#tls-cert-params-cipher-suites) - Optional List<br>Cipher Suites. The following list specifies the supported cipher suite TLS_AES_128_GCM_SHA256 TLS_AES_256_GCM_SHA384 TLS_CHACHA20_POLY1305_SHA256 TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256 TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384 TLS_ECDHE_ECDSA_WITH_CHACHA20_POLY1305_SHA256 TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256 TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384 TLS_ECDHE_RSA_WITH_CHACHA20_POLY1305_SHA256 TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA TLS_RSA_WITH_AES_128_CBC_SHA TLS_RSA_WITH_AES_128_GCM_SHA256 TLS_RSA_WITH_AES_256_CBC_SHA TLS_RSA_WITH_AES_256_GCM_SHA384 If not specified, the default list: TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256 TLS_ECDHE_ECDSA_WITH_CHACHA20_POLY1305_SHA256 TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256 TLS_ECDHE_RSA_WITH_CHACHA20_POLY1305_SHA256 TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384 TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384 will be used
|
|
714
|
+
|
|
715
|
+
<a id="tls-cert-params-client-certificate-optional"></a>• [`client_certificate_optional`](#tls-cert-params-client-certificate-optional) - Optional Block<br>Enable this option
|
|
716
|
+
|
|
717
|
+
<a id="tls-cert-params-client-certificate-required"></a>• [`client_certificate_required`](#tls-cert-params-client-certificate-required) - Optional Block<br>Enable this option
|
|
718
|
+
|
|
719
|
+
<a id="tls-cert-params-maximum-protocol-version"></a>• [`maximum_protocol_version`](#tls-cert-params-maximum-protocol-version) - 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
|
|
720
|
+
|
|
721
|
+
<a id="tls-cert-params-minimum-protocol-version"></a>• [`minimum_protocol_version`](#tls-cert-params-minimum-protocol-version) - 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
|
|
722
|
+
|
|
723
|
+
<a id="tls-cert-params-no-client-certificate"></a>• [`no_client_certificate`](#tls-cert-params-no-client-certificate) - Optional Block<br>Enable this option
|
|
724
|
+
|
|
725
|
+
<a id="tls-cert-params-validation-params"></a>• [`validation_params`](#tls-cert-params-validation-params) - Optional Block<br>TLS Certificate Validation Parameters. This includes URL for a trust store, whether SAN verification is required and list of Subject Alt Names for verification<br>See [Validation Params](#tls-cert-params-validation-params) below.
|
|
726
|
+
|
|
727
|
+
<a id="tls-cert-params-xfcc-header-elements"></a>• [`xfcc_header_elements`](#tls-cert-params-xfcc-header-elements) - 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. X-Forwarded-Client-Cert header elements to be set in an mTLS enabled connections. If none are defined, the header will not be added
|
|
728
|
+
|
|
729
|
+
#### TLS Cert Params Certificates
|
|
730
|
+
|
|
731
|
+
A [`certificates`](#tls-cert-params-certificates) block (within [`tls_cert_params`](#tls-cert-params)) supports the following:
|
|
732
|
+
|
|
733
|
+
<a id="tls-cert-params-certificates-kind"></a>• [`kind`](#tls-cert-params-certificates-kind) - Optional String<br>Kind. When a configuration object(e.g. virtual_host) refers to another(e.g route) then kind will hold the referred object's kind (e.g. 'route')
|
|
734
|
+
|
|
735
|
+
<a id="tls-cert-params-certificates-name"></a>• [`name`](#tls-cert-params-certificates-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
|
|
736
|
+
|
|
737
|
+
<a id="tls-cert-params-certificates-namespace"></a>• [`namespace`](#tls-cert-params-certificates-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
|
|
738
|
+
|
|
739
|
+
<a id="tls-cert-params-certificates-tenant"></a>• [`tenant`](#tls-cert-params-certificates-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
|
|
740
|
+
|
|
741
|
+
<a id="tls-cert-params-certificates-uid"></a>• [`uid`](#tls-cert-params-certificates-uid) - Optional String<br>UID. When a configuration object(e.g. virtual_host) refers to another(e.g route) then uid will hold the referred object's(e.g. route's) uid
|
|
742
|
+
|
|
743
|
+
#### TLS Cert Params Validation Params
|
|
744
|
+
|
|
745
|
+
A [`validation_params`](#tls-cert-params-validation-params) block (within [`tls_cert_params`](#tls-cert-params)) supports the following:
|
|
746
|
+
|
|
747
|
+
<a id="tls-cert-params-validation-params-skip-hostname-verification"></a>• [`skip_hostname_verification`](#tls-cert-params-validation-params-skip-hostname-verification) - Optional Bool<br>Skip verification of hostname. When True, skip verification of hostname i.e. CN/Subject Alt Name of certificate is not matched to the connecting hostname
|
|
748
|
+
|
|
749
|
+
<a id="tls-cert-params-validation-params-trusted-ca"></a>• [`trusted_ca`](#tls-cert-params-validation-params-trusted-ca) - Optional Block<br>Root CA Certificate Reference. Reference to Root CA Certificate<br>See [Trusted CA](#tls-cert-params-validation-params-trusted-ca) below.
|
|
750
|
+
|
|
751
|
+
<a id="tls-cert-params-validation-params-trusted-ca-url"></a>• [`trusted_ca_url`](#tls-cert-params-validation-params-trusted-ca-url) - Optional String<br>Inline Root CA Certificate (legacy). Inline Root CA Certificate
|
|
752
|
+
|
|
753
|
+
<a id="tls-cert-params-validation-params-verify-subject-alt-names"></a>• [`verify_subject_alt_names`](#tls-cert-params-validation-params-verify-subject-alt-names) - Optional List<br>List of SANs for matching. List of acceptable Subject Alt Names/CN in the peer's certificate. When skip_hostname_verification is false and verify_subject_alt_names is empty, the hostname of the peer will be used for matching against SAN/CN of peer's certificate
|
|
754
|
+
|
|
755
|
+
#### TLS Cert Params Validation Params Trusted CA
|
|
756
|
+
|
|
757
|
+
A [`trusted_ca`](#tls-cert-params-validation-params-trusted-ca) block (within [`tls_cert_params.validation_params`](#tls-cert-params-validation-params)) supports the following:
|
|
758
|
+
|
|
759
|
+
<a id="tls-cert-params-validation-params-trusted-ca-trusted-ca-list"></a>• [`trusted_ca_list`](#tls-cert-params-validation-params-trusted-ca-trusted-ca-list) - Optional Block<br>Root CA Certificate Reference. Reference to Root CA Certificate<br>See [Trusted CA List](#tls-cert-params-validation-params-trusted-ca-trusted-ca-list) below.
|
|
760
|
+
|
|
761
|
+
#### TLS Cert Params Validation Params Trusted CA Trusted CA List
|
|
762
|
+
|
|
763
|
+
A [`trusted_ca_list`](#tls-cert-params-validation-params-trusted-ca-trusted-ca-list) block (within [`tls_cert_params.validation_params.trusted_ca`](#tls-cert-params-validation-params-trusted-ca)) supports the following:
|
|
764
|
+
|
|
765
|
+
<a id="tls-cert-params-validation-params-trusted-ca-trusted-ca-list-kind"></a>• [`kind`](#tls-cert-params-validation-params-trusted-ca-trusted-ca-list-kind) - Optional String<br>Kind. When a configuration object(e.g. virtual_host) refers to another(e.g route) then kind will hold the referred object's kind (e.g. 'route')
|
|
766
|
+
|
|
767
|
+
<a id="tls-cert-params-validation-params-trusted-ca-trusted-ca-list-name"></a>• [`name`](#tls-cert-params-validation-params-trusted-ca-trusted-ca-list-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
|
|
768
|
+
|
|
769
|
+
<a id="tls-cert-params-validation-params-trusted-ca-trusted-ca-list-namespace"></a>• [`namespace`](#tls-cert-params-validation-params-trusted-ca-trusted-ca-list-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
|
|
770
|
+
|
|
771
|
+
<a id="tls-cert-params-validation-params-trusted-ca-trusted-ca-list-tenant"></a>• [`tenant`](#tls-cert-params-validation-params-trusted-ca-trusted-ca-list-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
|
|
772
|
+
|
|
773
|
+
<a id="tls-cert-params-validation-params-trusted-ca-trusted-ca-list-uid"></a>• [`uid`](#tls-cert-params-validation-params-trusted-ca-trusted-ca-list-uid) - Optional String<br>UID. When a configuration object(e.g. virtual_host) refers to another(e.g route) then uid will hold the referred object's(e.g. route's) uid
|
|
774
|
+
|
|
775
|
+
#### TLS Parameters
|
|
776
|
+
|
|
777
|
+
A [`tls_parameters`](#tls-parameters) block supports the following:
|
|
778
|
+
|
|
779
|
+
<a id="tls-parameters-client-certificate-optional"></a>• [`client_certificate_optional`](#tls-parameters-client-certificate-optional) - Optional Block<br>Enable this option
|
|
780
|
+
|
|
781
|
+
<a id="tls-parameters-client-certificate-required"></a>• [`client_certificate_required`](#tls-parameters-client-certificate-required) - Optional Block<br>Enable this option
|
|
782
|
+
|
|
783
|
+
<a id="tls-parameters-common-params"></a>• [`common_params`](#tls-parameters-common-params) - Optional Block<br>TLS Parameters. Information of different aspects for TLS authentication related to ciphers, certificates and trust store<br>See [Common Params](#tls-parameters-common-params) below.
|
|
784
|
+
|
|
785
|
+
<a id="tls-parameters-no-client-certificate"></a>• [`no_client_certificate`](#tls-parameters-no-client-certificate) - Optional Block<br>Enable this option
|
|
786
|
+
|
|
787
|
+
<a id="tls-parameters-xfcc-header-elements"></a>• [`xfcc_header_elements`](#tls-parameters-xfcc-header-elements) - 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. X-Forwarded-Client-Cert header elements to be set in an mTLS enabled connections. If none are defined, the header will not be added
|
|
788
|
+
|
|
789
|
+
#### TLS Parameters Common Params
|
|
790
|
+
|
|
791
|
+
A [`common_params`](#tls-parameters-common-params) block (within [`tls_parameters`](#tls-parameters)) supports the following:
|
|
792
|
+
|
|
793
|
+
<a id="tls-parameters-common-params-cipher-suites"></a>• [`cipher_suites`](#tls-parameters-common-params-cipher-suites) - Optional List<br>Cipher Suites. The following list specifies the supported cipher suite TLS_AES_128_GCM_SHA256 TLS_AES_256_GCM_SHA384 TLS_CHACHA20_POLY1305_SHA256 TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256 TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384 TLS_ECDHE_ECDSA_WITH_CHACHA20_POLY1305_SHA256 TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256 TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384 TLS_ECDHE_RSA_WITH_CHACHA20_POLY1305_SHA256 TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA TLS_RSA_WITH_AES_128_CBC_SHA TLS_RSA_WITH_AES_128_GCM_SHA256 TLS_RSA_WITH_AES_256_CBC_SHA TLS_RSA_WITH_AES_256_GCM_SHA384 If not specified, the default list: TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256 TLS_ECDHE_ECDSA_WITH_CHACHA20_POLY1305_SHA256 TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256 TLS_ECDHE_RSA_WITH_CHACHA20_POLY1305_SHA256 TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384 TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384 will be used
|
|
794
|
+
|
|
795
|
+
<a id="tls-parameters-common-params-maximum-protocol-version"></a>• [`maximum_protocol_version`](#tls-parameters-common-params-maximum-protocol-version) - 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
|
|
796
|
+
|
|
797
|
+
<a id="tls-parameters-common-params-minimum-protocol-version"></a>• [`minimum_protocol_version`](#tls-parameters-common-params-minimum-protocol-version) - 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
|
|
798
|
+
|
|
799
|
+
<a id="tls-parameters-common-params-tls-certificates"></a>• [`tls_certificates`](#tls-parameters-common-params-tls-certificates) - Optional Block<br>TLS Certificates. Set of TLS certificates<br>See [TLS Certificates](#tls-parameters-common-params-tls-certificates) below.
|
|
800
|
+
|
|
801
|
+
<a id="tls-parameters-common-params-validation-params"></a>• [`validation_params`](#tls-parameters-common-params-validation-params) - Optional Block<br>TLS Certificate Validation Parameters. This includes URL for a trust store, whether SAN verification is required and list of Subject Alt Names for verification<br>See [Validation Params](#tls-parameters-common-params-validation-params) below.
|
|
802
|
+
|
|
803
|
+
#### TLS Parameters Common Params TLS Certificates
|
|
804
|
+
|
|
805
|
+
A [`tls_certificates`](#tls-parameters-common-params-tls-certificates) block (within [`tls_parameters.common_params`](#tls-parameters-common-params)) supports the following:
|
|
806
|
+
|
|
807
|
+
<a id="tls-parameters-common-params-tls-certificates-certificate-url"></a>• [`certificate_url`](#tls-parameters-common-params-tls-certificates-certificate-url) - Optional String<br>Certificate. TLS certificate. Certificate or certificate chain in PEM format including the PEM headers
|
|
808
|
+
|
|
809
|
+
<a id="tls-parameters-common-params-tls-certificates-custom-hash-algorithms"></a>• [`custom_hash_algorithms`](#tls-parameters-common-params-tls-certificates-custom-hash-algorithms) - Optional Block<br>Hash Algorithms. Specifies the hash algorithms to be used<br>See [Custom Hash Algorithms](#tls-parameters-common-params-tls-certificates-custom-hash-algorithms) below.
|
|
810
|
+
|
|
811
|
+
<a id="tls-parameters-common-params-tls-certificates-description-spec"></a>• [`description_spec`](#tls-parameters-common-params-tls-certificates-description-spec) - Optional String<br>Description. Description for the certificate
|
|
812
|
+
|
|
813
|
+
<a id="tls-parameters-common-params-tls-certificates-disable-ocsp-stapling"></a>• [`disable_ocsp_stapling`](#tls-parameters-common-params-tls-certificates-disable-ocsp-stapling) - Optional Block<br>Enable this option
|
|
814
|
+
|
|
815
|
+
<a id="tls-parameters-common-params-tls-certificates-private-key"></a>• [`private_key`](#tls-parameters-common-params-tls-certificates-private-key) - Optional Block<br>Secret. SecretType is used in an object to indicate a sensitive/confidential field<br>See [Private Key](#tls-parameters-common-params-tls-certificates-private-key) below.
|
|
816
|
+
|
|
817
|
+
<a id="tls-parameters-common-params-tls-certificates-use-system-defaults"></a>• [`use_system_defaults`](#tls-parameters-common-params-tls-certificates-use-system-defaults) - Optional Block<br>Enable this option
|
|
818
|
+
|
|
819
|
+
#### TLS Parameters Common Params TLS Certificates Custom Hash Algorithms
|
|
820
|
+
|
|
821
|
+
A [`custom_hash_algorithms`](#tls-parameters-common-params-tls-certificates-custom-hash-algorithms) block (within [`tls_parameters.common_params.tls_certificates`](#tls-parameters-common-params-tls-certificates)) supports the following:
|
|
822
|
+
|
|
823
|
+
<a id="tls-parameters-common-params-tls-certificates-custom-hash-algorithms-hash-algorithms"></a>• [`hash_algorithms`](#tls-parameters-common-params-tls-certificates-custom-hash-algorithms-hash-algorithms) - 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
|
|
824
|
+
|
|
825
|
+
#### TLS Parameters Common Params TLS Certificates Private Key
|
|
826
|
+
|
|
827
|
+
A [`private_key`](#tls-parameters-common-params-tls-certificates-private-key) block (within [`tls_parameters.common_params.tls_certificates`](#tls-parameters-common-params-tls-certificates)) supports the following:
|
|
828
|
+
|
|
829
|
+
<a id="tls-parameters-common-params-tls-certificates-private-key-blindfold-secret-info"></a>• [`blindfold_secret_info`](#tls-parameters-common-params-tls-certificates-private-key-blindfold-secret-info) - Optional Block<br>Blindfold Secret. BlindfoldSecretInfoType specifies information about the Secret managed by F5XC Secret Management<br>See [Blindfold Secret Info](#tls-parameters-common-params-tls-certificates-private-key-blindfold-secret-info) below.
|
|
830
|
+
|
|
831
|
+
<a id="tls-parameters-common-params-tls-certificates-private-key-clear-secret-info"></a>• [`clear_secret_info`](#tls-parameters-common-params-tls-certificates-private-key-clear-secret-info) - Optional Block<br>In-Clear Secret. ClearSecretInfoType specifies information about the Secret that is not encrypted<br>See [Clear Secret Info](#tls-parameters-common-params-tls-certificates-private-key-clear-secret-info) below.
|
|
832
|
+
|
|
833
|
+
#### TLS Parameters Common Params TLS Certificates Private Key Blindfold Secret Info
|
|
834
|
+
|
|
835
|
+
A [`blindfold_secret_info`](#tls-parameters-common-params-tls-certificates-private-key-blindfold-secret-info) block (within [`tls_parameters.common_params.tls_certificates.private_key`](#tls-parameters-common-params-tls-certificates-private-key)) supports the following:
|
|
836
|
+
|
|
837
|
+
<a id="tls-parameters-common-params-tls-certificates-private-key-blindfold-secret-info-decryption-provider"></a>• [`decryption_provider`](#tls-parameters-common-params-tls-certificates-private-key-blindfold-secret-info-decryption-provider) - Optional String<br>Decryption Provider. Name of the Secret Management Access object that contains information about the backend Secret Management service
|
|
838
|
+
|
|
839
|
+
<a id="tls-parameters-common-params-tls-certificates-private-key-blindfold-secret-info-location"></a>• [`location`](#tls-parameters-common-params-tls-certificates-private-key-blindfold-secret-info-location) - 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
|
|
840
|
+
|
|
841
|
+
<a id="tls-parameters-common-params-tls-certificates-private-key-blindfold-secret-info-store-provider"></a>• [`store_provider`](#tls-parameters-common-params-tls-certificates-private-key-blindfold-secret-info-store-provider) - 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:///
|
|
842
|
+
|
|
843
|
+
#### TLS Parameters Common Params TLS Certificates Private Key Clear Secret Info
|
|
844
|
+
|
|
845
|
+
A [`clear_secret_info`](#tls-parameters-common-params-tls-certificates-private-key-clear-secret-info) block (within [`tls_parameters.common_params.tls_certificates.private_key`](#tls-parameters-common-params-tls-certificates-private-key)) supports the following:
|
|
846
|
+
|
|
847
|
+
<a id="tls-parameters-common-params-tls-certificates-private-key-clear-secret-info-provider-ref"></a>• [`provider_ref`](#tls-parameters-common-params-tls-certificates-private-key-clear-secret-info-provider-ref) - 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:///
|
|
848
|
+
|
|
849
|
+
<a id="tls-parameters-common-params-tls-certificates-private-key-clear-secret-info-url"></a>• [`url`](#tls-parameters-common-params-tls-certificates-private-key-clear-secret-info-url) - 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
|
|
850
|
+
|
|
851
|
+
#### TLS Parameters Common Params Validation Params
|
|
852
|
+
|
|
853
|
+
A [`validation_params`](#tls-parameters-common-params-validation-params) block (within [`tls_parameters.common_params`](#tls-parameters-common-params)) supports the following:
|
|
854
|
+
|
|
855
|
+
<a id="tls-parameters-common-params-validation-params-skip-hostname-verification"></a>• [`skip_hostname_verification`](#tls-parameters-common-params-validation-params-skip-hostname-verification) - Optional Bool<br>Skip verification of hostname. When True, skip verification of hostname i.e. CN/Subject Alt Name of certificate is not matched to the connecting hostname
|
|
856
|
+
|
|
857
|
+
<a id="tls-parameters-common-params-validation-params-trusted-ca"></a>• [`trusted_ca`](#tls-parameters-common-params-validation-params-trusted-ca) - Optional Block<br>Root CA Certificate Reference. Reference to Root CA Certificate<br>See [Trusted CA](#tls-parameters-common-params-validation-params-trusted-ca) below.
|
|
858
|
+
|
|
859
|
+
<a id="tls-parameters-common-params-validation-params-trusted-ca-url"></a>• [`trusted_ca_url`](#tls-parameters-common-params-validation-params-trusted-ca-url) - Optional String<br>Inline Root CA Certificate (legacy). Inline Root CA Certificate
|
|
860
|
+
|
|
861
|
+
<a id="tls-parameters-common-params-validation-params-verify-subject-alt-names"></a>• [`verify_subject_alt_names`](#tls-parameters-common-params-validation-params-verify-subject-alt-names) - Optional List<br>List of SANs for matching. List of acceptable Subject Alt Names/CN in the peer's certificate. When skip_hostname_verification is false and verify_subject_alt_names is empty, the hostname of the peer will be used for matching against SAN/CN of peer's certificate
|
|
862
|
+
|
|
863
|
+
#### TLS Parameters Common Params Validation Params Trusted CA
|
|
864
|
+
|
|
865
|
+
A [`trusted_ca`](#tls-parameters-common-params-validation-params-trusted-ca) block (within [`tls_parameters.common_params.validation_params`](#tls-parameters-common-params-validation-params)) supports the following:
|
|
866
|
+
|
|
867
|
+
<a id="tls-parameters-common-params-validation-params-trusted-ca-trusted-ca-list"></a>• [`trusted_ca_list`](#tls-parameters-common-params-validation-params-trusted-ca-trusted-ca-list) - Optional Block<br>Root CA Certificate Reference. Reference to Root CA Certificate<br>See [Trusted CA List](#tls-parameters-common-params-validation-params-trusted-ca-trusted-ca-list) below.
|
|
868
|
+
|
|
869
|
+
#### TLS Parameters Common Params Validation Params Trusted CA Trusted CA List
|
|
870
|
+
|
|
871
|
+
A [`trusted_ca_list`](#tls-parameters-common-params-validation-params-trusted-ca-trusted-ca-list) block (within [`tls_parameters.common_params.validation_params.trusted_ca`](#tls-parameters-common-params-validation-params-trusted-ca)) supports the following:
|
|
872
|
+
|
|
873
|
+
<a id="tls-parameters-common-params-validation-params-trusted-ca-trusted-ca-list-kind"></a>• [`kind`](#tls-parameters-common-params-validation-params-trusted-ca-trusted-ca-list-kind) - Optional String<br>Kind. When a configuration object(e.g. virtual_host) refers to another(e.g route) then kind will hold the referred object's kind (e.g. 'route')
|
|
874
|
+
|
|
875
|
+
<a id="tls-parameters-common-params-validation-params-trusted-ca-trusted-ca-list-name"></a>• [`name`](#tls-parameters-common-params-validation-params-trusted-ca-trusted-ca-list-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
|
|
876
|
+
|
|
877
|
+
<a id="tls-parameters-common-params-validation-params-trusted-ca-trusted-ca-list-namespace"></a>• [`namespace`](#tls-parameters-common-params-validation-params-trusted-ca-trusted-ca-list-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
|
|
878
|
+
|
|
879
|
+
<a id="tls-parameters-common-params-validation-params-trusted-ca-trusted-ca-list-tenant"></a>• [`tenant`](#tls-parameters-common-params-validation-params-trusted-ca-trusted-ca-list-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
|
|
880
|
+
|
|
881
|
+
<a id="tls-parameters-common-params-validation-params-trusted-ca-trusted-ca-list-uid"></a>• [`uid`](#tls-parameters-common-params-validation-params-trusted-ca-trusted-ca-list-uid) - Optional String<br>UID. When a configuration object(e.g. virtual_host) refers to another(e.g route) then uid will hold the referred object's(e.g. route's) uid
|
|
882
|
+
|
|
883
|
+
#### User Identification
|
|
884
|
+
|
|
885
|
+
An [`user_identification`](#user-identification) block supports the following:
|
|
886
|
+
|
|
887
|
+
<a id="user-identification-kind"></a>• [`kind`](#user-identification-kind) - Optional String<br>Kind. When a configuration object(e.g. virtual_host) refers to another(e.g route) then kind will hold the referred object's kind (e.g. 'route')
|
|
888
|
+
|
|
889
|
+
<a id="user-identification-name"></a>• [`name`](#user-identification-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
|
|
890
|
+
|
|
891
|
+
<a id="user-identification-namespace"></a>• [`namespace`](#user-identification-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
|
|
892
|
+
|
|
893
|
+
<a id="user-identification-tenant"></a>• [`tenant`](#user-identification-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
|
|
894
|
+
|
|
895
|
+
<a id="user-identification-uid"></a>• [`uid`](#user-identification-uid) - Optional String<br>UID. When a configuration object(e.g. virtual_host) refers to another(e.g route) then uid will hold the referred object's(e.g. route's) uid
|
|
896
|
+
|
|
897
|
+
#### WAF Type
|
|
898
|
+
|
|
899
|
+
A [`waf_type`](#waf-type) block supports the following:
|
|
900
|
+
|
|
901
|
+
<a id="waf-type-app-firewall"></a>• [`app_firewall`](#waf-type-app-firewall) - Optional Block<br>App Firewall Reference. A list of references to the app_firewall configuration objects<br>See [App Firewall](#waf-type-app-firewall) below.
|
|
902
|
+
|
|
903
|
+
<a id="waf-type-disable-waf"></a>• [`disable_waf`](#waf-type-disable-waf) - Optional Block<br>Enable this option
|
|
904
|
+
|
|
905
|
+
<a id="waf-type-inherit-waf"></a>• [`inherit_waf`](#waf-type-inherit-waf) - Optional Block<br>Enable this option
|
|
906
|
+
|
|
907
|
+
#### WAF Type App Firewall
|
|
908
|
+
|
|
909
|
+
An [`app_firewall`](#waf-type-app-firewall) block (within [`waf_type`](#waf-type)) supports the following:
|
|
910
|
+
|
|
911
|
+
<a id="waf-type-app-firewall-app-firewall"></a>• [`app_firewall`](#waf-type-app-firewall-app-firewall) - Optional Block<br>Application Firewall. References to an Application Firewall configuration object<br>See [App Firewall](#waf-type-app-firewall-app-firewall) below.
|
|
912
|
+
|
|
913
|
+
#### WAF Type App Firewall App Firewall
|
|
914
|
+
|
|
915
|
+
An [`app_firewall`](#waf-type-app-firewall-app-firewall) block (within [`waf_type.app_firewall`](#waf-type-app-firewall)) supports the following:
|
|
916
|
+
|
|
917
|
+
<a id="waf-type-app-firewall-app-firewall-kind"></a>• [`kind`](#waf-type-app-firewall-app-firewall-kind) - Optional String<br>Kind. When a configuration object(e.g. virtual_host) refers to another(e.g route) then kind will hold the referred object's kind (e.g. 'route')
|
|
918
|
+
|
|
919
|
+
<a id="waf-type-app-firewall-app-firewall-name"></a>• [`name`](#waf-type-app-firewall-app-firewall-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
|
|
920
|
+
|
|
921
|
+
<a id="waf-type-app-firewall-app-firewall-namespace"></a>• [`namespace`](#waf-type-app-firewall-app-firewall-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
|
|
922
|
+
|
|
923
|
+
<a id="waf-type-app-firewall-app-firewall-tenant"></a>• [`tenant`](#waf-type-app-firewall-app-firewall-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
|
|
924
|
+
|
|
925
|
+
<a id="waf-type-app-firewall-app-firewall-uid"></a>• [`uid`](#waf-type-app-firewall-app-firewall-uid) - Optional String<br>UID. When a configuration object(e.g. virtual_host) refers to another(e.g route) then uid will hold the referred object's(e.g. route's) uid
|
|
926
|
+
|
|
927
|
+
## Import
|
|
928
|
+
|
|
929
|
+
Import is supported using the following syntax:
|
|
930
|
+
|
|
931
|
+
```shell
|
|
932
|
+
# Import using namespace/name format
|
|
933
|
+
terraform import f5xc_virtual_host.example system/example
|
|
934
|
+
```
|