@robinmordasiewicz/f5xc-terraform-mcp 3.5.1 → 3.6.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/docs/data-sources/bgp.md +2 -2
- package/dist/docs/data-sources/discovery.md +2 -2
- package/dist/docs/data-sources/fast_acl.md +2 -2
- package/dist/docs/data-sources/fast_acl_rule.md +2 -2
- package/dist/docs/data-sources/irule.md +2 -2
- package/dist/docs/data-sources/log_receiver.md +2 -2
- package/dist/docs/data-sources/network_policy.md +2 -2
- package/dist/docs/data-sources/route.md +2 -2
- package/dist/docs/data-sources/site.md +2 -2
- package/dist/docs/resources/address_allocator.md +7 -7
- package/dist/docs/resources/advertise_policy.md +57 -57
- package/dist/docs/resources/alert_policy.md +40 -40
- package/dist/docs/resources/alert_receiver.md +57 -57
- package/dist/docs/resources/api_crawler.md +13 -13
- package/dist/docs/resources/api_definition.md +11 -11
- package/dist/docs/resources/api_discovery.md +4 -4
- package/dist/docs/resources/api_testing.md +27 -27
- package/dist/docs/resources/apm.md +40 -40
- package/dist/docs/resources/app_api_group.md +20 -20
- package/dist/docs/resources/app_firewall.md +50 -50
- package/dist/docs/resources/app_setting.md +19 -19
- package/dist/docs/resources/app_type.md +7 -7
- package/dist/docs/resources/authentication.md +29 -29
- package/dist/docs/resources/aws_tgw_site.md +140 -140
- package/dist/docs/resources/aws_vpc_site.md +174 -174
- package/dist/docs/resources/azure_vnet_site.md +245 -245
- package/dist/docs/resources/bgp.md +37 -205
- package/dist/docs/resources/bgp_asn_set.md +1 -1
- package/dist/docs/resources/bgp_routing_policy.md +19 -19
- package/dist/docs/resources/bot_defense_app_infrastructure.md +12 -12
- package/dist/docs/resources/cdn_cache_rule.md +5 -5
- package/dist/docs/resources/cdn_loadbalancer.md +418 -418
- package/dist/docs/resources/certificate.md +1 -1
- package/dist/docs/resources/certificate_chain.md +1 -1
- package/dist/docs/resources/cloud_connect.md +28 -28
- package/dist/docs/resources/cloud_credentials.md +35 -35
- package/dist/docs/resources/cloud_elastic_ip.md +8 -8
- package/dist/docs/resources/cloud_link.md +36 -36
- package/dist/docs/resources/cluster.md +86 -86
- package/dist/docs/resources/cminstance.md +22 -22
- package/dist/docs/resources/code_base_integration.md +24 -24
- package/dist/docs/resources/container_registry.md +13 -13
- package/dist/docs/resources/crl.md +1 -1
- package/dist/docs/resources/data_type.md +16 -16
- package/dist/docs/resources/dc_cluster_group.md +4 -4
- package/dist/docs/resources/discovery.md +8 -259
- package/dist/docs/resources/dns_compliance_checks.md +1 -1
- package/dist/docs/resources/dns_domain.md +3 -3
- package/dist/docs/resources/endpoint.md +44 -44
- package/dist/docs/resources/enhanced_firewall_policy.md +51 -51
- package/dist/docs/resources/external_connector.md +42 -42
- package/dist/docs/resources/fast_acl.md +60 -166
- package/dist/docs/resources/fast_acl_rule.md +28 -28
- package/dist/docs/resources/filter_set.md +10 -10
- package/dist/docs/resources/fleet.md +160 -160
- package/dist/docs/resources/forward_proxy_policy.md +82 -82
- package/dist/docs/resources/forwarding_class.md +14 -14
- package/dist/docs/resources/gcp_vpc_site.md +152 -152
- package/dist/docs/resources/global_log_receiver.md +238 -238
- package/dist/docs/resources/healthcheck.md +17 -17
- package/dist/docs/resources/http_loadbalancer.md +1003 -1003
- package/dist/docs/resources/irule.md +5 -7
- package/dist/docs/resources/log_receiver.md +825 -44
- package/dist/docs/resources/malicious_user_mitigation.md +10 -10
- package/dist/docs/resources/nat_policy.md +86 -86
- package/dist/docs/resources/network_connector.md +31 -31
- package/dist/docs/resources/network_firewall.md +22 -22
- package/dist/docs/resources/network_interface.md +77 -77
- package/dist/docs/resources/network_policy.md +38 -217
- package/dist/docs/resources/network_policy_rule.md +21 -21
- package/dist/docs/resources/network_policy_view.md +65 -65
- package/dist/docs/resources/nfv_service.md +76 -76
- package/dist/docs/resources/nginx_service_discovery.md +10 -10
- package/dist/docs/resources/origin_pool.md +166 -166
- package/dist/docs/resources/policer.md +4 -4
- package/dist/docs/resources/policy_based_routing.md +28 -28
- package/dist/docs/resources/protocol_inspection.md +12 -12
- package/dist/docs/resources/protocol_policer.md +14 -14
- package/dist/docs/resources/proxy.md +111 -111
- package/dist/docs/resources/rate_limiter.md +15 -15
- package/dist/docs/resources/rate_limiter_policy.md +56 -56
- package/dist/docs/resources/route.md +183 -183
- package/dist/docs/resources/secret_management_access.md +68 -68
- package/dist/docs/resources/securemesh_site.md +1619 -258
- package/dist/docs/resources/segment.md +4 -4
- package/dist/docs/resources/sensitive_data_policy.md +9 -9
- package/dist/docs/resources/service_policy.md +175 -175
- package/dist/docs/resources/service_policy_rule.md +142 -142
- package/dist/docs/resources/site.md +381 -303
- package/dist/docs/resources/site_mesh_group.md +18 -18
- package/dist/docs/resources/subnet.md +17 -17
- package/dist/docs/resources/tcp_loadbalancer.md +130 -130
- package/dist/docs/resources/tenant_configuration.md +10 -10
- package/dist/docs/resources/trusted_ca_list.md +1 -1
- package/dist/docs/resources/tunnel.md +36 -36
- package/dist/docs/resources/udp_loadbalancer.md +59 -59
- package/dist/docs/resources/usb_policy.md +6 -6
- package/dist/docs/resources/user_identification.md +16 -16
- package/dist/docs/resources/virtual_host.md +225 -225
- package/dist/docs/resources/virtual_network.md +14 -14
- package/dist/docs/resources/virtual_site.md +3 -3
- package/dist/docs/resources/voltstack_site.md +141 -141
- package/dist/docs/resources/waf_exclusion_policy.md +17 -17
- package/dist/docs/resources/workload.md +327 -327
- package/dist/docs/resources/workload_flavor.md +3 -3
- package/dist/metadata/resource-metadata.json +1484 -942
- package/dist/types.d.ts +11 -0
- package/dist/types.d.ts.map +1 -1
- package/dist/types.js.map +1 -1
- package/package.json +1 -1
|
@@ -32,7 +32,7 @@ resource "f5xc_virtual_host" "example" {
|
|
|
32
32
|
}
|
|
33
33
|
|
|
34
34
|
# Resource-specific configuration
|
|
35
|
-
# Advertise
|
|
35
|
+
# Advertise Policy allows you to define networks or sites w...
|
|
36
36
|
advertise_policies {
|
|
37
37
|
# Configure advertise_policies settings
|
|
38
38
|
}
|
|
@@ -40,7 +40,7 @@ resource "f5xc_virtual_host" "example" {
|
|
|
40
40
|
authentication {
|
|
41
41
|
# Configure authentication settings
|
|
42
42
|
}
|
|
43
|
-
# Reference to Authentication Object.
|
|
43
|
+
# Reference to Authentication Config Object .
|
|
44
44
|
auth_config {
|
|
45
45
|
# Configure auth_config settings
|
|
46
46
|
}
|
|
@@ -68,101 +68,101 @@ resource "f5xc_virtual_host" "example" {
|
|
|
68
68
|
|
|
69
69
|
<a id="add-location"></a>• [`add_location`](#add-location) - Optional Bool<br>Add Location. X-example: true Appends header x-F5 Distributed Cloud-location = `<RE-site-name>` in responses. This configuration is ignored on CE sites
|
|
70
70
|
|
|
71
|
-
<a id="advertise-policies"></a>• [`advertise_policies`](#advertise-policies) - Optional Block<br>Advertise
|
|
71
|
+
<a id="advertise-policies"></a>• [`advertise_policies`](#advertise-policies) - Optional Block<br>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<br>See [Advertise Policies](#advertise-policies) below for details.
|
|
72
72
|
|
|
73
73
|
-> **One of the following:**
|
|
74
|
-
• <a id="append-server-name"></a>[`append_server_name`](#append-server-name) - Optional String<br>
|
|
75
|
-
<br><br>• <a id="default-header"></a>[`default_header`](#default-header) - Optional Block<br>
|
|
76
|
-
<br><br>• <a id="pass-through"></a>[`pass_through`](#pass-through) - Optional Block<br>
|
|
74
|
+
• <a id="append-server-name"></a>[`append_server_name`](#append-server-name) - Optional String<br>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>Can be used for messages where no values are needed
|
|
76
|
+
<br><br>• <a id="pass-through"></a>[`pass_through`](#pass-through) - Optional Block<br>Can be used for messages where no values are needed
|
|
77
77
|
|
|
78
78
|
-> **One of the following:**
|
|
79
|
-
• <a id="authentication"></a>[`authentication`](#authentication) - Optional Block<br>Authentication
|
|
79
|
+
• <a id="authentication"></a>[`authentication`](#authentication) - Optional Block<br>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
80
|
|
|
81
|
-
<a id="buffer-policy"></a>• [`buffer_policy`](#buffer-policy) - Optional Block<br>
|
|
81
|
+
<a id="buffer-policy"></a>• [`buffer_policy`](#buffer-policy) - Optional Block<br>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<br>See [Buffer Policy](#buffer-policy) below for details.
|
|
82
82
|
|
|
83
83
|
-> **One of the following:**
|
|
84
|
-
• <a id="captcha-challenge"></a>[`captcha_challenge`](#captcha-challenge) - Optional Block<br>
|
|
85
|
-
<br><br>• <a id="js-challenge"></a>[`js_challenge`](#js-challenge) - Optional Block<br>
|
|
84
|
+
• <a id="captcha-challenge"></a>[`captcha_challenge`](#captcha-challenge) - Optional Block<br>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<br>See [Captcha Challenge](#captcha-challenge) below for details.
|
|
85
|
+
<br><br>• <a id="js-challenge"></a>[`js_challenge`](#js-challenge) - Optional Block<br>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<br>See [Js Challenge](#js-challenge) below for details.
|
|
86
86
|
|
|
87
|
-
<a id="coalescing-options"></a>• [`coalescing_options`](#coalescing-options) - Optional Block<br>TLS
|
|
87
|
+
<a id="coalescing-options"></a>• [`coalescing_options`](#coalescing-options) - Optional Block<br>TLS connection coalescing configuration (not compatible with mTLS)<br>See [Coalescing Options](#coalescing-options) below for details.
|
|
88
88
|
|
|
89
|
-
<a id="compression-params"></a>• [`compression_params`](#compression-params) - Optional Block<br>
|
|
89
|
+
<a id="compression-params"></a>• [`compression_params`](#compression-params) - Optional Block<br>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<br>See [Compression Params](#compression-params) below for details.
|
|
90
90
|
|
|
91
|
-
<a id="connection-idle-timeout"></a>• [`connection_idle_timeout`](#connection-idle-timeout) - Optional Number
|
|
91
|
+
<a id="connection-idle-timeout"></a>• [`connection_idle_timeout`](#connection-idle-timeout) - Optional Number<br>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
|
|
92
92
|
|
|
93
|
-
<a id="cors-policy"></a>• [`cors_policy`](#cors-policy) - Optional Block<br>
|
|
93
|
+
<a id="cors-policy"></a>• [`cors_policy`](#cors-policy) - Optional Block<br>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<br>See [CORS Policy](#cors-policy) below for details.
|
|
94
94
|
|
|
95
|
-
<a id="csrf-policy"></a>• [`csrf_policy`](#csrf-policy) - Optional Block<br>
|
|
95
|
+
<a id="csrf-policy"></a>• [`csrf_policy`](#csrf-policy) - Optional Block<br>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<br>See [CSRF Policy](#csrf-policy) below for details.
|
|
96
96
|
|
|
97
|
-
<a id="custom-errors"></a>• [`custom_errors`](#custom-errors) - Optional Block<br>
|
|
97
|
+
<a id="custom-errors"></a>• [`custom_errors`](#custom-errors) - Optional Block<br>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
|
|
98
98
|
|
|
99
99
|
-> **One of the following:**
|
|
100
|
-
• <a id="default-loadbalancer"></a>[`default_loadbalancer`](#default-loadbalancer) - Optional Block<br>
|
|
100
|
+
• <a id="default-loadbalancer"></a>[`default_loadbalancer`](#default-loadbalancer) - Optional Block<br>Can be used for messages where no values are needed
|
|
101
101
|
|
|
102
|
-
<a id="disable-default-error-pages"></a>• [`disable_default_error_pages`](#disable-default-error-pages) - Optional Bool<br>
|
|
102
|
+
<a id="disable-default-error-pages"></a>• [`disable_default_error_pages`](#disable-default-error-pages) - Optional Bool<br>Option to specify whether to disable using default F5XC error pages
|
|
103
103
|
|
|
104
|
-
<a id="disable-dns-resolve"></a>• [`disable_dns_resolve`](#disable-dns-resolve) - Optional Bool<br>Disable DNS resolution
|
|
104
|
+
<a id="disable-dns-resolve"></a>• [`disable_dns_resolve`](#disable-dns-resolve) - Optional Bool<br>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
105
|
|
|
106
106
|
-> **One of the following:**
|
|
107
|
-
• <a id="disable-path-normalize"></a>[`disable_path_normalize`](#disable-path-normalize) - Optional Block<br>
|
|
107
|
+
• <a id="disable-path-normalize"></a>[`disable_path_normalize`](#disable-path-normalize) - Optional Block<br>Can be used for messages where no values are needed
|
|
108
108
|
|
|
109
|
-
<a id="domains"></a>• [`domains`](#domains) - Optional List<br>
|
|
109
|
+
<a id="domains"></a>• [`domains`](#domains) - Optional List<br>List of domain names matched to this virtual host for routing incoming requests. Supports wildcard patterns like \*.example.com for subdomain matching
|
|
110
110
|
|
|
111
|
-
<a id="dynamic-reverse-proxy"></a>• [`dynamic_reverse_proxy`](#dynamic-reverse-proxy) - Optional Block<br>
|
|
111
|
+
<a id="dynamic-reverse-proxy"></a>• [`dynamic_reverse_proxy`](#dynamic-reverse-proxy) - Optional Block<br>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<br>See [Dynamic Reverse Proxy](#dynamic-reverse-proxy) below for details.
|
|
112
112
|
|
|
113
|
-
<a id="enable-path-normalize"></a>• [`enable_path_normalize`](#enable-path-normalize) - Optional Block<br>
|
|
113
|
+
<a id="enable-path-normalize"></a>• [`enable_path_normalize`](#enable-path-normalize) - Optional Block<br>Can be used for messages where no values are needed
|
|
114
114
|
|
|
115
|
-
<a id="http-protocol-options"></a>• [`http_protocol_options`](#http-protocol-options) - Optional Block<br>HTTP
|
|
115
|
+
<a id="http-protocol-options"></a>• [`http_protocol_options`](#http-protocol-options) - Optional Block<br>HTTP protocol configuration OPTIONS for downstream connections<br>See [HTTP Protocol Options](#http-protocol-options) below for details.
|
|
116
116
|
|
|
117
|
-
<a id="idle-timeout"></a>• [`idle_timeout`](#idle-timeout) - Optional Number<br>Idle timeout
|
|
117
|
+
<a id="idle-timeout"></a>• [`idle_timeout`](#idle-timeout) - Optional Number<br>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
|
|
118
118
|
|
|
119
|
-
<a id="max-request-header-size"></a>• [`max_request_header_size`](#max-request-header-size) - Optional Number<br>
|
|
119
|
+
<a id="max-request-header-size"></a>• [`max_request_header_size`](#max-request-header-size) - Optional Number<br>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
|
|
120
120
|
|
|
121
|
-
<a id="no-authentication"></a>• [`no_authentication`](#no-authentication) - Optional Block<br>
|
|
121
|
+
<a id="no-authentication"></a>• [`no_authentication`](#no-authentication) - Optional Block<br>Can be used for messages where no values are needed
|
|
122
122
|
|
|
123
|
-
<a id="no-challenge"></a>• [`no_challenge`](#no-challenge) - Optional Block<br>
|
|
123
|
+
<a id="no-challenge"></a>• [`no_challenge`](#no-challenge) - Optional Block<br>Can be used for messages where no values are needed
|
|
124
124
|
|
|
125
|
-
<a id="non-default-loadbalancer"></a>• [`non_default_loadbalancer`](#non-default-loadbalancer) - Optional Block<br>
|
|
125
|
+
<a id="non-default-loadbalancer"></a>• [`non_default_loadbalancer`](#non-default-loadbalancer) - Optional Block<br>Can be used for messages where no values are needed
|
|
126
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]
|
|
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] 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
|
|
128
128
|
|
|
129
|
-
<a id="rate-limiter-allowed-prefixes"></a>• [`rate_limiter_allowed_prefixes`](#rate-limiter-allowed-prefixes) - Optional Block<br>
|
|
129
|
+
<a id="rate-limiter-allowed-prefixes"></a>• [`rate_limiter_allowed_prefixes`](#rate-limiter-allowed-prefixes) - Optional Block<br>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
130
|
|
|
131
|
-
<a id="request-cookies-to-add"></a>• [`request_cookies_to_add`](#request-cookies-to-add) - Optional Block<br>
|
|
131
|
+
<a id="request-cookies-to-add"></a>• [`request_cookies_to_add`](#request-cookies-to-add) - Optional Block<br>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
132
|
|
|
133
|
-
<a id="request-cookies-to-remove"></a>• [`request_cookies_to_remove`](#request-cookies-to-remove) - Optional List<br>
|
|
133
|
+
<a id="request-cookies-to-remove"></a>• [`request_cookies_to_remove`](#request-cookies-to-remove) - Optional List<br>List of keys of Cookies to be removed from the HTTP request being sent towards upstream
|
|
134
134
|
|
|
135
|
-
<a id="request-headers-to-add"></a>• [`request_headers_to_add`](#request-headers-to-add) - Optional Block<br>
|
|
135
|
+
<a id="request-headers-to-add"></a>• [`request_headers_to_add`](#request-headers-to-add) - Optional Block<br>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
136
|
|
|
137
|
-
<a id="request-headers-to-remove"></a>• [`request_headers_to_remove`](#request-headers-to-remove) - Optional List<br>
|
|
137
|
+
<a id="request-headers-to-remove"></a>• [`request_headers_to_remove`](#request-headers-to-remove) - Optional List<br>List of keys of Headers to be removed from the HTTP request being sent towards upstream
|
|
138
138
|
|
|
139
|
-
<a id="response-cookies-to-add"></a>• [`response_cookies_to_add`](#response-cookies-to-add) - Optional Block<br>
|
|
139
|
+
<a id="response-cookies-to-add"></a>• [`response_cookies_to_add`](#response-cookies-to-add) - Optional Block<br>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
140
|
|
|
141
|
-
<a id="response-cookies-to-remove"></a>• [`response_cookies_to_remove`](#response-cookies-to-remove) - Optional List<br>
|
|
141
|
+
<a id="response-cookies-to-remove"></a>• [`response_cookies_to_remove`](#response-cookies-to-remove) - Optional List<br>List of name of Cookies to be removed from the HTTP response being sent towards downstream. Entire set-cookie header will be removed
|
|
142
142
|
|
|
143
|
-
<a id="response-headers-to-add"></a>• [`response_headers_to_add`](#response-headers-to-add) - Optional Block<br>
|
|
143
|
+
<a id="response-headers-to-add"></a>• [`response_headers_to_add`](#response-headers-to-add) - Optional Block<br>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
144
|
|
|
145
|
-
<a id="response-headers-to-remove"></a>• [`response_headers_to_remove`](#response-headers-to-remove) - Optional List<br>
|
|
145
|
+
<a id="response-headers-to-remove"></a>• [`response_headers_to_remove`](#response-headers-to-remove) - Optional List<br>List of keys of Headers to be removed from the HTTP response being sent towards downstream
|
|
146
146
|
|
|
147
|
-
<a id="retry-policy"></a>• [`retry_policy`](#retry-policy) - Optional Block<br>Retry
|
|
147
|
+
<a id="retry-policy"></a>• [`retry_policy`](#retry-policy) - Optional Block<br>Retry policy configuration for route destination
|
|
148
148
|
|
|
149
|
-
<a id="routes"></a>• [`routes`](#routes) - Optional Block<br>
|
|
149
|
+
<a id="routes"></a>• [`routes`](#routes) - Optional Block<br>HTTP routing rules that match incoming requests based on path, headers, or query parameters and forward them to appropriate backend origin pools
|
|
150
150
|
|
|
151
|
-
<a id="sensitive-data-policy"></a>• [`sensitive_data_policy`](#sensitive-data-policy) - Optional Block<br>
|
|
151
|
+
<a id="sensitive-data-policy"></a>• [`sensitive_data_policy`](#sensitive-data-policy) - Optional Block<br>Policy configuration for this feature
|
|
152
152
|
|
|
153
|
-
<a id="server-name"></a>• [`server_name`](#server-name) - Optional String<br>
|
|
153
|
+
<a id="server-name"></a>• [`server_name`](#server-name) - Optional String<br>Specifies the value to be used for Server header inserted in responses. This will overwrite existing values if any for Server Header
|
|
154
154
|
|
|
155
|
-
<a id="slow-ddos-mitigation"></a>• [`slow_ddos_mitigation`](#slow-ddos-mitigation) - Optional Block<br>
|
|
155
|
+
<a id="slow-ddos-mitigation"></a>• [`slow_ddos_mitigation`](#slow-ddos-mitigation) - Optional Block<br>'Slow and low' attacks tie up server resources, leaving none available for servicing requests from actual users
|
|
156
156
|
|
|
157
157
|
<a id="timeouts"></a>• [`timeouts`](#timeouts) - Optional Block
|
|
158
158
|
|
|
159
159
|
-> **One of the following:**
|
|
160
|
-
• <a id="tls-cert-params"></a>[`tls_cert_params`](#tls-cert-params) - Optional Block<br>Certificate Parameters
|
|
161
|
-
<br><br>• <a id="tls-parameters"></a>[`tls_parameters`](#tls-parameters) - Optional Block<br>
|
|
160
|
+
• <a id="tls-cert-params"></a>[`tls_cert_params`](#tls-cert-params) - Optional Block<br>Certificate Parameters for authentication, TLS ciphers, and trust store
|
|
161
|
+
<br><br>• <a id="tls-parameters"></a>[`tls_parameters`](#tls-parameters) - Optional Block<br>TLS configuration for downstream connections
|
|
162
162
|
|
|
163
|
-
<a id="user-identification"></a>• [`user_identification`](#user-identification) - Optional Block<br>
|
|
163
|
+
<a id="user-identification"></a>• [`user_identification`](#user-identification) - Optional Block<br>Reference to user_identification object. The rules in the user_identification object are evaluated to determine the user identifier to be rate limited
|
|
164
164
|
|
|
165
|
-
<a id="waf-type"></a>• [`waf_type`](#waf-type) - Optional Block<br>WAF
|
|
165
|
+
<a id="waf-type"></a>• [`waf_type`](#waf-type) - Optional Block<br>WAF instance will be pointing to an app_firewall object
|
|
166
166
|
|
|
167
167
|
### Attributes Reference
|
|
168
168
|
|
|
@@ -176,77 +176,77 @@ In addition to all arguments above, the following attributes are exported:
|
|
|
176
176
|
|
|
177
177
|
An [`advertise_policies`](#advertise-policies) block supports the following:
|
|
178
178
|
|
|
179
|
-
<a id="advertise-policies-kind"></a>• [`kind`](#advertise-policies-kind) - Optional String<br>
|
|
179
|
+
<a id="advertise-policies-kind"></a>• [`kind`](#advertise-policies-kind) - Optional String<br>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
180
|
|
|
181
|
-
<a id="advertise-policies-name"></a>• [`name`](#advertise-policies-name) - Optional String<br>
|
|
181
|
+
<a id="advertise-policies-name"></a>• [`name`](#advertise-policies-name) - Optional String<br>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
182
|
|
|
183
|
-
<a id="advertise-policies-namespace"></a>• [`namespace`](#advertise-policies-namespace) - Optional String<br>
|
|
183
|
+
<a id="advertise-policies-namespace"></a>• [`namespace`](#advertise-policies-namespace) - Optional String<br>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
184
|
|
|
185
|
-
<a id="advertise-policies-tenant"></a>• [`tenant`](#advertise-policies-tenant) - Optional String<br>
|
|
185
|
+
<a id="advertise-policies-tenant"></a>• [`tenant`](#advertise-policies-tenant) - Optional String<br>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
186
|
|
|
187
|
-
<a id="advertise-policies-uid"></a>• [`uid`](#advertise-policies-uid) - Optional String<br>
|
|
187
|
+
<a id="advertise-policies-uid"></a>• [`uid`](#advertise-policies-uid) - Optional String<br>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
188
|
|
|
189
189
|
#### Authentication
|
|
190
190
|
|
|
191
191
|
An [`authentication`](#authentication) block supports the following:
|
|
192
192
|
|
|
193
|
-
<a id="authentication-auth-config"></a>• [`auth_config`](#authentication-auth-config) - Optional Block<br>Reference to Authentication
|
|
193
|
+
<a id="authentication-auth-config"></a>• [`auth_config`](#authentication-auth-config) - Optional Block<br>Reference to Authentication Config Object<br>See [Auth Config](#authentication-auth-config) below.
|
|
194
194
|
|
|
195
|
-
<a id="authentication-cookie-params"></a>• [`cookie_params`](#authentication-cookie-params) - Optional Block<br>
|
|
195
|
+
<a id="authentication-cookie-params"></a>• [`cookie_params`](#authentication-cookie-params) - Optional Block<br>Specifies different cookie related config parameters for authentication<br>See [Cookie Params](#authentication-cookie-params) below.
|
|
196
196
|
|
|
197
|
-
<a id="authentication-redirect-dynamic"></a>• [`redirect_dynamic`](#authentication-redirect-dynamic) - Optional Block<br>
|
|
197
|
+
<a id="authentication-redirect-dynamic"></a>• [`redirect_dynamic`](#authentication-redirect-dynamic) - Optional Block<br>Can be used for messages where no values are needed
|
|
198
198
|
|
|
199
|
-
<a id="authentication-redirect-url"></a>• [`redirect_url`](#authentication-redirect-url) - Optional String<br>
|
|
199
|
+
<a id="authentication-redirect-url"></a>• [`redirect_url`](#authentication-redirect-url) - Optional String<br>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
200
|
|
|
201
|
-
<a id="authentication-use-auth-object-config"></a>• [`use_auth_object_config`](#authentication-use-auth-object-config) - Optional Block<br>
|
|
201
|
+
<a id="authentication-use-auth-object-config"></a>• [`use_auth_object_config`](#authentication-use-auth-object-config) - Optional Block<br>Can be used for messages where no values are needed
|
|
202
202
|
|
|
203
203
|
#### Authentication Auth Config
|
|
204
204
|
|
|
205
205
|
An [`auth_config`](#authentication-auth-config) block (within [`authentication`](#authentication)) supports the following:
|
|
206
206
|
|
|
207
|
-
<a id="authentication-auth-config-kind"></a>• [`kind`](#authentication-auth-config-kind) - Optional String<br>
|
|
207
|
+
<a id="authentication-auth-config-kind"></a>• [`kind`](#authentication-auth-config-kind) - Optional String<br>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
208
|
|
|
209
|
-
<a id="authentication-auth-config-name"></a>• [`name`](#authentication-auth-config-name) - Optional String<br>
|
|
209
|
+
<a id="authentication-auth-config-name"></a>• [`name`](#authentication-auth-config-name) - Optional String<br>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
210
|
|
|
211
|
-
<a id="authentication-auth-config-namespace"></a>• [`namespace`](#authentication-auth-config-namespace) - Optional String<br>
|
|
211
|
+
<a id="authentication-auth-config-namespace"></a>• [`namespace`](#authentication-auth-config-namespace) - Optional String<br>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
212
|
|
|
213
|
-
<a id="authentication-auth-config-tenant"></a>• [`tenant`](#authentication-auth-config-tenant) - Optional String<br>
|
|
213
|
+
<a id="authentication-auth-config-tenant"></a>• [`tenant`](#authentication-auth-config-tenant) - Optional String<br>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
214
|
|
|
215
|
-
<a id="authentication-auth-config-uid"></a>• [`uid`](#authentication-auth-config-uid) - Optional String<br>
|
|
215
|
+
<a id="authentication-auth-config-uid"></a>• [`uid`](#authentication-auth-config-uid) - Optional String<br>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
216
|
|
|
217
217
|
#### Authentication Cookie Params
|
|
218
218
|
|
|
219
219
|
A [`cookie_params`](#authentication-cookie-params) block (within [`authentication`](#authentication)) supports the following:
|
|
220
220
|
|
|
221
|
-
<a id="authentication-cookie-params-auth-hmac"></a>• [`auth_hmac`](#authentication-cookie-params-auth-hmac) - Optional Block<br>HMAC
|
|
221
|
+
<a id="authentication-cookie-params-auth-hmac"></a>• [`auth_hmac`](#authentication-cookie-params-auth-hmac) - Optional Block<br>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
222
|
|
|
223
|
-
<a id="expiry-adfc80"></a>• [`cookie_expiry`](#expiry-adfc80) - Optional Number<br>
|
|
223
|
+
<a id="expiry-adfc80"></a>• [`cookie_expiry`](#expiry-adfc80) - Optional Number<br>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
|
|
224
224
|
|
|
225
|
-
<a id="interval-13cbce"></a>• [`cookie_refresh_interval`](#interval-13cbce) - Optional Number<br>
|
|
225
|
+
<a id="interval-13cbce"></a>• [`cookie_refresh_interval`](#interval-13cbce) - Optional Number<br>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
|
|
226
226
|
|
|
227
227
|
<a id="hmac-2097df"></a>• [`kms_key_hmac`](#hmac-2097df) - Optional Block<br>KMS Key Reference. Reference to KMS Key Object
|
|
228
228
|
|
|
229
|
-
<a id="expiry-0b152c"></a>• [`session_expiry`](#expiry-0b152c) - Optional Number<br>
|
|
229
|
+
<a id="expiry-0b152c"></a>• [`session_expiry`](#expiry-0b152c) - Optional Number<br>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
230
|
|
|
231
231
|
#### Authentication Cookie Params Auth HMAC
|
|
232
232
|
|
|
233
233
|
An [`auth_hmac`](#authentication-cookie-params-auth-hmac) block (within [`authentication.cookie_params`](#authentication-cookie-params)) supports the following:
|
|
234
234
|
|
|
235
|
-
<a id="key-cec38f"></a>• [`prim_key`](#key-cec38f) - Optional Block<br>
|
|
235
|
+
<a id="key-cec38f"></a>• [`prim_key`](#key-cec38f) - Optional Block<br>SecretType is used in an object to indicate a sensitive/confidential field<br>See [Prim Key](#key-cec38f) below.
|
|
236
236
|
|
|
237
|
-
<a id="expiry-982334"></a>• [`prim_key_expiry`](#expiry-982334) - Optional String<br>
|
|
237
|
+
<a id="expiry-982334"></a>• [`prim_key_expiry`](#expiry-982334) - Optional String<br>Primary HMAC Key Expiry time
|
|
238
238
|
|
|
239
|
-
<a id="key-f289cf"></a>• [`sec_key`](#key-f289cf) - Optional Block<br>
|
|
239
|
+
<a id="key-f289cf"></a>• [`sec_key`](#key-f289cf) - Optional Block<br>SecretType is used in an object to indicate a sensitive/confidential field<br>See [Sec Key](#key-f289cf) below.
|
|
240
240
|
|
|
241
|
-
<a id="expiry-6c8703"></a>• [`sec_key_expiry`](#expiry-6c8703) - Optional String<br>
|
|
241
|
+
<a id="expiry-6c8703"></a>• [`sec_key_expiry`](#expiry-6c8703) - Optional String<br>Secondary HMAC Key Expiry time
|
|
242
242
|
|
|
243
243
|
#### Authentication Cookie Params Auth HMAC Prim Key
|
|
244
244
|
|
|
245
245
|
A [`prim_key`](#key-cec38f) block (within [`authentication.cookie_params.auth_hmac`](#authentication-cookie-params-auth-hmac)) supports the following:
|
|
246
246
|
|
|
247
|
-
<a id="info-51af12"></a>• [`blindfold_secret_info`](#info-51af12) - Optional Block<br>
|
|
247
|
+
<a id="info-51af12"></a>• [`blindfold_secret_info`](#info-51af12) - Optional Block<br>BlindfoldSecretInfoType specifies information about the Secret managed by F5XC Secret Management<br>See [Blindfold Secret Info](#info-51af12) below.
|
|
248
248
|
|
|
249
|
-
<a id="info-fb9b06"></a>• [`clear_secret_info`](#info-fb9b06) - Optional Block<br>
|
|
249
|
+
<a id="info-fb9b06"></a>• [`clear_secret_info`](#info-fb9b06) - Optional Block<br>ClearSecretInfoType specifies information about the Secret that is not encrypted<br>See [Clear Secret Info](#info-fb9b06) below.
|
|
250
250
|
|
|
251
251
|
#### Authentication Cookie Params Auth HMAC Prim Key Blindfold Secret Info
|
|
252
252
|
|
|
@@ -260,9 +260,9 @@ A [`prim_key`](#key-cec38f) block (within [`authentication.cookie_params.auth_hm
|
|
|
260
260
|
|
|
261
261
|
A [`sec_key`](#key-f289cf) block (within [`authentication.cookie_params.auth_hmac`](#authentication-cookie-params-auth-hmac)) supports the following:
|
|
262
262
|
|
|
263
|
-
<a id="info-07eb40"></a>• [`blindfold_secret_info`](#info-07eb40) - Optional Block<br>
|
|
263
|
+
<a id="info-07eb40"></a>• [`blindfold_secret_info`](#info-07eb40) - Optional Block<br>BlindfoldSecretInfoType specifies information about the Secret managed by F5XC Secret Management<br>See [Blindfold Secret Info](#info-07eb40) below.
|
|
264
264
|
|
|
265
|
-
<a id="info-f63518"></a>• [`clear_secret_info`](#info-f63518) - Optional Block<br>
|
|
265
|
+
<a id="info-f63518"></a>• [`clear_secret_info`](#info-f63518) - Optional Block<br>ClearSecretInfoType specifies information about the Secret that is not encrypted<br>See [Clear Secret Info](#info-f63518) below.
|
|
266
266
|
|
|
267
267
|
#### Authentication Cookie Params Auth HMAC Sec Key Blindfold Secret Info
|
|
268
268
|
|
|
@@ -276,109 +276,109 @@ A [`sec_key`](#key-f289cf) block (within [`authentication.cookie_params.auth_hma
|
|
|
276
276
|
|
|
277
277
|
A [`buffer_policy`](#buffer-policy) block supports the following:
|
|
278
278
|
|
|
279
|
-
<a id="buffer-policy-disabled"></a>• [`disabled`](#buffer-policy-disabled) - Optional Bool<br>Disable
|
|
279
|
+
<a id="buffer-policy-disabled"></a>• [`disabled`](#buffer-policy-disabled) - Optional Bool<br>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
|
|
280
280
|
|
|
281
|
-
<a id="buffer-policy-max-request-bytes"></a>• [`max_request_bytes`](#buffer-policy-max-request-bytes) - Optional Number<br>
|
|
281
|
+
<a id="buffer-policy-max-request-bytes"></a>• [`max_request_bytes`](#buffer-policy-max-request-bytes) - Optional Number<br>The maximum request size that the filter will buffer before the connection manager will stop buffering and return a RequestEntityTooLarge (413) response
|
|
282
282
|
|
|
283
283
|
#### Captcha Challenge
|
|
284
284
|
|
|
285
285
|
A [`captcha_challenge`](#captcha-challenge) block supports the following:
|
|
286
286
|
|
|
287
|
-
<a id="captcha-challenge-cookie-expiry"></a>• [`cookie_expiry`](#captcha-challenge-cookie-expiry) - Optional Number<br>Cookie
|
|
287
|
+
<a id="captcha-challenge-cookie-expiry"></a>• [`cookie_expiry`](#captcha-challenge-cookie-expiry) - Optional Number<br>Cookie expiration period, in seconds. An expired cookie causes the loadbalancer to issue a new challenge
|
|
288
288
|
|
|
289
|
-
<a id="captcha-challenge-custom-page"></a>• [`custom_page`](#captcha-challenge-custom-page) - Optional String<br>Custom message
|
|
289
|
+
<a id="captcha-challenge-custom-page"></a>• [`custom_page`](#captcha-challenge-custom-page) - Optional String<br>Custom message is of type uri_ref. Currently supported URL schemes is string:///. For string:/// scheme, message needs to be encoded in Base64 format
|
|
290
290
|
|
|
291
291
|
#### Coalescing Options
|
|
292
292
|
|
|
293
293
|
A [`coalescing_options`](#coalescing-options) block supports the following:
|
|
294
294
|
|
|
295
|
-
<a id="coalescing-options-default-coalescing"></a>• [`default_coalescing`](#coalescing-options-default-coalescing) - Optional Block<br>
|
|
295
|
+
<a id="coalescing-options-default-coalescing"></a>• [`default_coalescing`](#coalescing-options-default-coalescing) - Optional Block<br>Can be used for messages where no values are needed
|
|
296
296
|
|
|
297
|
-
<a id="coalescing-options-strict-coalescing"></a>• [`strict_coalescing`](#coalescing-options-strict-coalescing) - Optional Block<br>
|
|
297
|
+
<a id="coalescing-options-strict-coalescing"></a>• [`strict_coalescing`](#coalescing-options-strict-coalescing) - Optional Block<br>Can be used for messages where no values are needed
|
|
298
298
|
|
|
299
299
|
#### Compression Params
|
|
300
300
|
|
|
301
301
|
A [`compression_params`](#compression-params) block supports the following:
|
|
302
302
|
|
|
303
|
-
<a id="compression-params-content-length"></a>• [`content_length`](#compression-params-content-length) - Optional Number Defaults to `30`<br>
|
|
303
|
+
<a id="compression-params-content-length"></a>• [`content_length`](#compression-params-content-length) - Optional Number Defaults to `30`<br>Minimum response length, in bytes, which will trigger compression. The
|
|
304
304
|
|
|
305
|
-
<a id="compression-params-content-type"></a>• [`content_type`](#compression-params-content-type) - Optional List<br>
|
|
305
|
+
<a id="compression-params-content-type"></a>• [`content_type`](#compression-params-content-type) - Optional List<br>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'
|
|
306
306
|
|
|
307
|
-
<a id="header-37dbb1"></a>• [`disable_on_etag_header`](#header-37dbb1) - Optional Bool<br>
|
|
307
|
+
<a id="header-37dbb1"></a>• [`disable_on_etag_header`](#header-37dbb1) - Optional Bool<br>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
|
|
308
308
|
|
|
309
|
-
<a id="header-c186ee"></a>• [`remove_accept_encoding_header`](#header-c186ee) - Optional Bool<br>
|
|
309
|
+
<a id="header-c186ee"></a>• [`remove_accept_encoding_header`](#header-c186ee) - Optional Bool<br>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
|
|
310
310
|
|
|
311
311
|
#### CORS Policy
|
|
312
312
|
|
|
313
313
|
A [`cors_policy`](#cors-policy) block supports the following:
|
|
314
314
|
|
|
315
|
-
<a id="cors-policy-allow-credentials"></a>• [`allow_credentials`](#cors-policy-allow-credentials) - Optional Bool<br>
|
|
315
|
+
<a id="cors-policy-allow-credentials"></a>• [`allow_credentials`](#cors-policy-allow-credentials) - Optional Bool<br>Specifies whether the resource allows credentials
|
|
316
316
|
|
|
317
|
-
<a id="cors-policy-allow-headers"></a>• [`allow_headers`](#cors-policy-allow-headers) - Optional String<br>
|
|
317
|
+
<a id="cors-policy-allow-headers"></a>• [`allow_headers`](#cors-policy-allow-headers) - Optional String<br>Specifies the content for the access-control-allow-headers header
|
|
318
318
|
|
|
319
|
-
<a id="cors-policy-allow-methods"></a>• [`allow_methods`](#cors-policy-allow-methods) - Optional String<br>
|
|
319
|
+
<a id="cors-policy-allow-methods"></a>• [`allow_methods`](#cors-policy-allow-methods) - Optional String<br>Specifies the content for the access-control-allow-methods header
|
|
320
320
|
|
|
321
|
-
<a id="cors-policy-allow-origin"></a>• [`allow_origin`](#cors-policy-allow-origin) - Optional List<br>
|
|
321
|
+
<a id="cors-policy-allow-origin"></a>• [`allow_origin`](#cors-policy-allow-origin) - Optional List<br>Specifies the origins that will be allowed to do CORS requests. An origin is allowed if either allow_origin or allow_origin_regex match
|
|
322
322
|
|
|
323
|
-
<a id="cors-policy-allow-origin-regex"></a>• [`allow_origin_regex`](#cors-policy-allow-origin-regex) - Optional List<br>
|
|
323
|
+
<a id="cors-policy-allow-origin-regex"></a>• [`allow_origin_regex`](#cors-policy-allow-origin-regex) - Optional List<br>Specifies regex patterns that match allowed origins. An origin is allowed if either allow_origin or allow_origin_regex match
|
|
324
324
|
|
|
325
|
-
<a id="cors-policy-disabled"></a>• [`disabled`](#cors-policy-disabled) - Optional Bool<br>
|
|
325
|
+
<a id="cors-policy-disabled"></a>• [`disabled`](#cors-policy-disabled) - Optional Bool<br>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
|
|
326
326
|
|
|
327
|
-
<a id="cors-policy-expose-headers"></a>• [`expose_headers`](#cors-policy-expose-headers) - Optional String<br>
|
|
327
|
+
<a id="cors-policy-expose-headers"></a>• [`expose_headers`](#cors-policy-expose-headers) - Optional String<br>Specifies the content for the access-control-expose-headers header
|
|
328
328
|
|
|
329
|
-
<a id="cors-policy-maximum-age"></a>• [`maximum_age`](#cors-policy-maximum-age) - Optional Number<br>
|
|
329
|
+
<a id="cors-policy-maximum-age"></a>• [`maximum_age`](#cors-policy-maximum-age) - Optional Number<br>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)
|
|
330
330
|
|
|
331
331
|
#### CSRF Policy
|
|
332
332
|
|
|
333
333
|
A [`csrf_policy`](#csrf-policy) block supports the following:
|
|
334
334
|
|
|
335
|
-
<a id="csrf-policy-all-load-balancer-domains"></a>• [`all_load_balancer_domains`](#csrf-policy-all-load-balancer-domains) - Optional Block<br>
|
|
335
|
+
<a id="csrf-policy-all-load-balancer-domains"></a>• [`all_load_balancer_domains`](#csrf-policy-all-load-balancer-domains) - Optional Block<br>Can be used for messages where no values are needed
|
|
336
336
|
|
|
337
|
-
<a id="csrf-policy-custom-domain-list"></a>• [`custom_domain_list`](#csrf-policy-custom-domain-list) - Optional Block<br>
|
|
337
|
+
<a id="csrf-policy-custom-domain-list"></a>• [`custom_domain_list`](#csrf-policy-custom-domain-list) - Optional Block<br>List of domain names used for Host header matching<br>See [Custom Domain List](#csrf-policy-custom-domain-list) below.
|
|
338
338
|
|
|
339
|
-
<a id="csrf-policy-disabled"></a>• [`disabled`](#csrf-policy-disabled) - Optional Block<br>
|
|
339
|
+
<a id="csrf-policy-disabled"></a>• [`disabled`](#csrf-policy-disabled) - Optional Block<br>Can be used for messages where no values are needed
|
|
340
340
|
|
|
341
341
|
#### CSRF Policy Custom Domain List
|
|
342
342
|
|
|
343
343
|
A [`custom_domain_list`](#csrf-policy-custom-domain-list) block (within [`csrf_policy`](#csrf-policy)) supports the following:
|
|
344
344
|
|
|
345
|
-
<a id="csrf-policy-custom-domain-list-domains"></a>• [`domains`](#csrf-policy-custom-domain-list-domains) - Optional List<br>
|
|
345
|
+
<a id="csrf-policy-custom-domain-list-domains"></a>• [`domains`](#csrf-policy-custom-domain-list-domains) - Optional List<br>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
|
|
346
346
|
|
|
347
347
|
#### Dynamic Reverse Proxy
|
|
348
348
|
|
|
349
349
|
A [`dynamic_reverse_proxy`](#dynamic-reverse-proxy) block supports the following:
|
|
350
350
|
|
|
351
|
-
<a id="timeout-627d8e"></a>• [`connection_timeout`](#timeout-627d8e) - Optional Number Defaults to `2000` Specified in milliseconds<br>
|
|
351
|
+
<a id="timeout-627d8e"></a>• [`connection_timeout`](#timeout-627d8e) - Optional Number Defaults to `2000` Specified in milliseconds<br>The timeout for new network connections to upstream server. The (2 seconds)
|
|
352
352
|
|
|
353
|
-
<a id="network-fd11f9"></a>• [`resolution_network`](#network-fd11f9) - Optional Block<br>
|
|
353
|
+
<a id="network-fd11f9"></a>• [`resolution_network`](#network-fd11f9) - Optional Block<br>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](#network-fd11f9) below.
|
|
354
354
|
|
|
355
|
-
<a id="type-42c5dd"></a>• [`resolution_network_type`](#type-42c5dd) - 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]
|
|
355
|
+
<a id="type-42c5dd"></a>• [`resolution_network_type`](#type-42c5dd) - 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] 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
|
|
356
356
|
|
|
357
|
-
<a id="dynamically-2caac9"></a>• [`resolve_endpoint_dynamically`](#dynamically-2caac9) - Optional Bool<br>
|
|
357
|
+
<a id="dynamically-2caac9"></a>• [`resolve_endpoint_dynamically`](#dynamically-2caac9) - Optional Bool<br>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
|
|
358
358
|
|
|
359
359
|
#### Dynamic Reverse Proxy Resolution Network
|
|
360
360
|
|
|
361
361
|
A [`resolution_network`](#network-fd11f9) block (within [`dynamic_reverse_proxy`](#dynamic-reverse-proxy)) supports the following:
|
|
362
362
|
|
|
363
|
-
<a id="kind-b4600a"></a>• [`kind`](#kind-b4600a) - Optional String<br>
|
|
363
|
+
<a id="kind-b4600a"></a>• [`kind`](#kind-b4600a) - Optional String<br>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')
|
|
364
364
|
|
|
365
|
-
<a id="name-30f08c"></a>• [`name`](#name-30f08c) - Optional String<br>
|
|
365
|
+
<a id="name-30f08c"></a>• [`name`](#name-30f08c) - Optional String<br>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
|
|
366
366
|
|
|
367
|
-
<a id="namespace-8df863"></a>• [`namespace`](#namespace-8df863) - Optional String<br>
|
|
367
|
+
<a id="namespace-8df863"></a>• [`namespace`](#namespace-8df863) - Optional String<br>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
|
|
368
368
|
|
|
369
|
-
<a id="tenant-ab33db"></a>• [`tenant`](#tenant-ab33db) - Optional String<br>
|
|
369
|
+
<a id="tenant-ab33db"></a>• [`tenant`](#tenant-ab33db) - Optional String<br>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
|
|
370
370
|
|
|
371
|
-
<a id="uid-2ee5fb"></a>• [`uid`](#uid-2ee5fb) - Optional String<br>
|
|
371
|
+
<a id="uid-2ee5fb"></a>• [`uid`](#uid-2ee5fb) - Optional String<br>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
|
|
372
372
|
|
|
373
373
|
#### HTTP Protocol Options
|
|
374
374
|
|
|
375
375
|
A [`http_protocol_options`](#http-protocol-options) block supports the following:
|
|
376
376
|
|
|
377
|
-
<a id="only-d91b7d"></a>• [`http_protocol_enable_v1_only`](#only-d91b7d) - Optional Block<br>HTTP/1.1 Protocol OPTIONS
|
|
377
|
+
<a id="only-d91b7d"></a>• [`http_protocol_enable_v1_only`](#only-d91b7d) - Optional Block<br>HTTP/1.1 Protocol OPTIONS for downstream connections<br>See [HTTP Protocol Enable V1 Only](#only-d91b7d) below.
|
|
378
378
|
|
|
379
|
-
<a id="v1-v2-79c7b6"></a>• [`http_protocol_enable_v1_v2`](#v1-v2-79c7b6) - Optional Block<br>
|
|
379
|
+
<a id="v1-v2-79c7b6"></a>• [`http_protocol_enable_v1_v2`](#v1-v2-79c7b6) - Optional Block<br>Can be used for messages where no values are needed
|
|
380
380
|
|
|
381
|
-
<a id="only-e64b55"></a>• [`http_protocol_enable_v2_only`](#only-e64b55) - Optional Block<br>
|
|
381
|
+
<a id="only-e64b55"></a>• [`http_protocol_enable_v2_only`](#only-e64b55) - Optional Block<br>Can be used for messages where no values are needed
|
|
382
382
|
|
|
383
383
|
#### HTTP Protocol Options HTTP Protocol Enable V1 Only
|
|
384
384
|
|
|
@@ -392,45 +392,45 @@ A [`http_protocol_options`](#http-protocol-options) block supports the following
|
|
|
392
392
|
|
|
393
393
|
A [`js_challenge`](#js-challenge) block supports the following:
|
|
394
394
|
|
|
395
|
-
<a id="js-challenge-cookie-expiry"></a>• [`cookie_expiry`](#js-challenge-cookie-expiry) - Optional Number<br>Cookie
|
|
395
|
+
<a id="js-challenge-cookie-expiry"></a>• [`cookie_expiry`](#js-challenge-cookie-expiry) - Optional Number<br>Cookie expiration period, in seconds. An expired cookie causes the loadbalancer to issue a new challenge
|
|
396
396
|
|
|
397
|
-
<a id="js-challenge-custom-page"></a>• [`custom_page`](#js-challenge-custom-page) - Optional String<br>Custom
|
|
397
|
+
<a id="js-challenge-custom-page"></a>• [`custom_page`](#js-challenge-custom-page) - Optional String<br>Custom message is of type uri_ref. Currently supported URL schemes is string:///. For string:/// scheme, message needs to be encoded in Base64 format
|
|
398
398
|
|
|
399
|
-
<a id="js-challenge-js-script-delay"></a>• [`js_script_delay`](#js-challenge-js-script-delay) - Optional Number<br>
|
|
399
|
+
<a id="js-challenge-js-script-delay"></a>• [`js_script_delay`](#js-challenge-js-script-delay) - Optional Number<br>Delay introduced by Javascript, in milliseconds
|
|
400
400
|
|
|
401
401
|
#### Rate Limiter Allowed Prefixes
|
|
402
402
|
|
|
403
403
|
A [`rate_limiter_allowed_prefixes`](#rate-limiter-allowed-prefixes) block supports the following:
|
|
404
404
|
|
|
405
|
-
<a id="rate-limiter-allowed-prefixes-kind"></a>• [`kind`](#rate-limiter-allowed-prefixes-kind) - Optional String<br>
|
|
405
|
+
<a id="rate-limiter-allowed-prefixes-kind"></a>• [`kind`](#rate-limiter-allowed-prefixes-kind) - Optional String<br>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')
|
|
406
406
|
|
|
407
|
-
<a id="rate-limiter-allowed-prefixes-name"></a>• [`name`](#rate-limiter-allowed-prefixes-name) - Optional String<br>
|
|
407
|
+
<a id="rate-limiter-allowed-prefixes-name"></a>• [`name`](#rate-limiter-allowed-prefixes-name) - Optional String<br>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
|
|
408
408
|
|
|
409
|
-
<a id="rate-limiter-allowed-prefixes-namespace"></a>• [`namespace`](#rate-limiter-allowed-prefixes-namespace) - Optional String<br>
|
|
409
|
+
<a id="rate-limiter-allowed-prefixes-namespace"></a>• [`namespace`](#rate-limiter-allowed-prefixes-namespace) - Optional String<br>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
|
|
410
410
|
|
|
411
|
-
<a id="rate-limiter-allowed-prefixes-tenant"></a>• [`tenant`](#rate-limiter-allowed-prefixes-tenant) - Optional String<br>
|
|
411
|
+
<a id="rate-limiter-allowed-prefixes-tenant"></a>• [`tenant`](#rate-limiter-allowed-prefixes-tenant) - Optional String<br>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
|
|
412
412
|
|
|
413
|
-
<a id="rate-limiter-allowed-prefixes-uid"></a>• [`uid`](#rate-limiter-allowed-prefixes-uid) - Optional String<br>
|
|
413
|
+
<a id="rate-limiter-allowed-prefixes-uid"></a>• [`uid`](#rate-limiter-allowed-prefixes-uid) - Optional String<br>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
|
|
414
414
|
|
|
415
415
|
#### Request Cookies To Add
|
|
416
416
|
|
|
417
417
|
A [`request_cookies_to_add`](#request-cookies-to-add) block supports the following:
|
|
418
418
|
|
|
419
|
-
<a id="request-cookies-to-add-name"></a>• [`name`](#request-cookies-to-add-name) - Optional String<br>Name
|
|
419
|
+
<a id="request-cookies-to-add-name"></a>• [`name`](#request-cookies-to-add-name) - Optional String<br>Name of the cookie in Cookie header
|
|
420
420
|
|
|
421
|
-
<a id="request-cookies-to-add-overwrite"></a>• [`overwrite`](#request-cookies-to-add-overwrite) - Optional Bool Defaults to `do`<br>
|
|
421
|
+
<a id="request-cookies-to-add-overwrite"></a>• [`overwrite`](#request-cookies-to-add-overwrite) - Optional Bool Defaults to `do`<br>Should the value be overwritten? If true, the value is overwritten to existing values. not overwrite
|
|
422
422
|
|
|
423
|
-
<a id="request-cookies-to-add-secret-value"></a>• [`secret_value`](#request-cookies-to-add-secret-value) - Optional Block<br>
|
|
423
|
+
<a id="request-cookies-to-add-secret-value"></a>• [`secret_value`](#request-cookies-to-add-secret-value) - Optional Block<br>SecretType is used in an object to indicate a sensitive/confidential field<br>See [Secret Value](#request-cookies-to-add-secret-value) below.
|
|
424
424
|
|
|
425
|
-
<a id="request-cookies-to-add-value"></a>• [`value`](#request-cookies-to-add-value) - Optional String<br>Value
|
|
425
|
+
<a id="request-cookies-to-add-value"></a>• [`value`](#request-cookies-to-add-value) - Optional String<br>Value of the Cookie header
|
|
426
426
|
|
|
427
427
|
#### Request Cookies To Add Secret Value
|
|
428
428
|
|
|
429
429
|
A [`secret_value`](#request-cookies-to-add-secret-value) block (within [`request_cookies_to_add`](#request-cookies-to-add)) supports the following:
|
|
430
430
|
|
|
431
|
-
<a id="info-f95f6c"></a>• [`blindfold_secret_info`](#info-f95f6c) - Optional Block<br>
|
|
431
|
+
<a id="info-f95f6c"></a>• [`blindfold_secret_info`](#info-f95f6c) - Optional Block<br>BlindfoldSecretInfoType specifies information about the Secret managed by F5XC Secret Management<br>See [Blindfold Secret Info](#info-f95f6c) below.
|
|
432
432
|
|
|
433
|
-
<a id="info-fcb5d1"></a>• [`clear_secret_info`](#info-fcb5d1) - Optional Block<br>
|
|
433
|
+
<a id="info-fcb5d1"></a>• [`clear_secret_info`](#info-fcb5d1) - Optional Block<br>ClearSecretInfoType specifies information about the Secret that is not encrypted<br>See [Clear Secret Info](#info-fcb5d1) below.
|
|
434
434
|
|
|
435
435
|
#### Request Cookies To Add Secret Value Blindfold Secret Info
|
|
436
436
|
|
|
@@ -444,21 +444,21 @@ A [`secret_value`](#request-cookies-to-add-secret-value) block (within [`request
|
|
|
444
444
|
|
|
445
445
|
A [`request_headers_to_add`](#request-headers-to-add) block supports the following:
|
|
446
446
|
|
|
447
|
-
<a id="request-headers-to-add-append"></a>• [`append`](#request-headers-to-add-append) - Optional Bool Defaults to `do`<br>
|
|
447
|
+
<a id="request-headers-to-add-append"></a>• [`append`](#request-headers-to-add-append) - Optional Bool Defaults to `do`<br>Should the value be appended? If true, the value is appended to existing values. not append
|
|
448
448
|
|
|
449
449
|
<a id="request-headers-to-add-name"></a>• [`name`](#request-headers-to-add-name) - Optional String<br>Name. Name of the HTTP header
|
|
450
450
|
|
|
451
|
-
<a id="request-headers-to-add-secret-value"></a>• [`secret_value`](#request-headers-to-add-secret-value) - Optional Block<br>
|
|
451
|
+
<a id="request-headers-to-add-secret-value"></a>• [`secret_value`](#request-headers-to-add-secret-value) - Optional Block<br>SecretType is used in an object to indicate a sensitive/confidential field<br>See [Secret Value](#request-headers-to-add-secret-value) below.
|
|
452
452
|
|
|
453
|
-
<a id="request-headers-to-add-value"></a>• [`value`](#request-headers-to-add-value) - Optional String<br>Value
|
|
453
|
+
<a id="request-headers-to-add-value"></a>• [`value`](#request-headers-to-add-value) - Optional String<br>Value of the HTTP header
|
|
454
454
|
|
|
455
455
|
#### Request Headers To Add Secret Value
|
|
456
456
|
|
|
457
457
|
A [`secret_value`](#request-headers-to-add-secret-value) block (within [`request_headers_to_add`](#request-headers-to-add)) supports the following:
|
|
458
458
|
|
|
459
|
-
<a id="info-be8500"></a>• [`blindfold_secret_info`](#info-be8500) - Optional Block<br>
|
|
459
|
+
<a id="info-be8500"></a>• [`blindfold_secret_info`](#info-be8500) - Optional Block<br>BlindfoldSecretInfoType specifies information about the Secret managed by F5XC Secret Management<br>See [Blindfold Secret Info](#info-be8500) below.
|
|
460
460
|
|
|
461
|
-
<a id="info-d2833c"></a>• [`clear_secret_info`](#info-d2833c) - Optional Block<br>
|
|
461
|
+
<a id="info-d2833c"></a>• [`clear_secret_info`](#info-d2833c) - Optional Block<br>ClearSecretInfoType specifies information about the Secret that is not encrypted<br>See [Clear Secret Info](#info-d2833c) below.
|
|
462
462
|
|
|
463
463
|
#### Request Headers To Add Secret Value Blindfold Secret Info
|
|
464
464
|
|
|
@@ -472,59 +472,59 @@ A [`secret_value`](#request-headers-to-add-secret-value) block (within [`request
|
|
|
472
472
|
|
|
473
473
|
A [`response_cookies_to_add`](#response-cookies-to-add) block supports the following:
|
|
474
474
|
|
|
475
|
-
<a id="response-cookies-to-add-add-domain"></a>• [`add_domain`](#response-cookies-to-add-add-domain) - Optional String<br>Add
|
|
475
|
+
<a id="response-cookies-to-add-add-domain"></a>• [`add_domain`](#response-cookies-to-add-add-domain) - Optional String<br>Add domain attribute
|
|
476
476
|
|
|
477
|
-
<a id="response-cookies-to-add-add-expiry"></a>• [`add_expiry`](#response-cookies-to-add-add-expiry) - Optional String<br>Add expiry
|
|
477
|
+
<a id="response-cookies-to-add-add-expiry"></a>• [`add_expiry`](#response-cookies-to-add-add-expiry) - Optional String<br>Add expiry attribute
|
|
478
478
|
|
|
479
|
-
<a id="response-cookies-to-add-add-httponly"></a>• [`add_httponly`](#response-cookies-to-add-add-httponly) - Optional Block<br>
|
|
479
|
+
<a id="response-cookies-to-add-add-httponly"></a>• [`add_httponly`](#response-cookies-to-add-add-httponly) - Optional Block<br>Can be used for messages where no values are needed
|
|
480
480
|
|
|
481
|
-
<a id="response-cookies-to-add-add-partitioned"></a>• [`add_partitioned`](#response-cookies-to-add-add-partitioned) - Optional Block<br>
|
|
481
|
+
<a id="response-cookies-to-add-add-partitioned"></a>• [`add_partitioned`](#response-cookies-to-add-add-partitioned) - Optional Block<br>Can be used for messages where no values are needed
|
|
482
482
|
|
|
483
|
-
<a id="response-cookies-to-add-add-path"></a>• [`add_path`](#response-cookies-to-add-add-path) - Optional String<br>Add path
|
|
483
|
+
<a id="response-cookies-to-add-add-path"></a>• [`add_path`](#response-cookies-to-add-add-path) - Optional String<br>Add path attribute
|
|
484
484
|
|
|
485
|
-
<a id="response-cookies-to-add-add-secure"></a>• [`add_secure`](#response-cookies-to-add-add-secure) - Optional Block<br>
|
|
485
|
+
<a id="response-cookies-to-add-add-secure"></a>• [`add_secure`](#response-cookies-to-add-add-secure) - Optional Block<br>Can be used for messages where no values are needed
|
|
486
486
|
|
|
487
|
-
<a id="response-cookies-to-add-ignore-domain"></a>• [`ignore_domain`](#response-cookies-to-add-ignore-domain) - Optional Block<br>
|
|
487
|
+
<a id="response-cookies-to-add-ignore-domain"></a>• [`ignore_domain`](#response-cookies-to-add-ignore-domain) - Optional Block<br>Can be used for messages where no values are needed
|
|
488
488
|
|
|
489
|
-
<a id="response-cookies-to-add-ignore-expiry"></a>• [`ignore_expiry`](#response-cookies-to-add-ignore-expiry) - Optional Block<br>
|
|
489
|
+
<a id="response-cookies-to-add-ignore-expiry"></a>• [`ignore_expiry`](#response-cookies-to-add-ignore-expiry) - Optional Block<br>Can be used for messages where no values are needed
|
|
490
490
|
|
|
491
|
-
<a id="response-cookies-to-add-ignore-httponly"></a>• [`ignore_httponly`](#response-cookies-to-add-ignore-httponly) - Optional Block<br>
|
|
491
|
+
<a id="response-cookies-to-add-ignore-httponly"></a>• [`ignore_httponly`](#response-cookies-to-add-ignore-httponly) - Optional Block<br>Can be used for messages where no values are needed
|
|
492
492
|
|
|
493
|
-
<a id="response-cookies-to-add-ignore-max-age"></a>• [`ignore_max_age`](#response-cookies-to-add-ignore-max-age) - Optional Block<br>
|
|
493
|
+
<a id="response-cookies-to-add-ignore-max-age"></a>• [`ignore_max_age`](#response-cookies-to-add-ignore-max-age) - Optional Block<br>Can be used for messages where no values are needed
|
|
494
494
|
|
|
495
|
-
<a id="partitioned-36b0ea"></a>• [`ignore_partitioned`](#partitioned-36b0ea) - Optional Block<br>
|
|
495
|
+
<a id="partitioned-36b0ea"></a>• [`ignore_partitioned`](#partitioned-36b0ea) - Optional Block<br>Can be used for messages where no values are needed
|
|
496
496
|
|
|
497
|
-
<a id="response-cookies-to-add-ignore-path"></a>• [`ignore_path`](#response-cookies-to-add-ignore-path) - Optional Block<br>
|
|
497
|
+
<a id="response-cookies-to-add-ignore-path"></a>• [`ignore_path`](#response-cookies-to-add-ignore-path) - Optional Block<br>Can be used for messages where no values are needed
|
|
498
498
|
|
|
499
|
-
<a id="response-cookies-to-add-ignore-samesite"></a>• [`ignore_samesite`](#response-cookies-to-add-ignore-samesite) - Optional Block<br>
|
|
499
|
+
<a id="response-cookies-to-add-ignore-samesite"></a>• [`ignore_samesite`](#response-cookies-to-add-ignore-samesite) - Optional Block<br>Can be used for messages where no values are needed
|
|
500
500
|
|
|
501
|
-
<a id="response-cookies-to-add-ignore-secure"></a>• [`ignore_secure`](#response-cookies-to-add-ignore-secure) - Optional Block<br>
|
|
501
|
+
<a id="response-cookies-to-add-ignore-secure"></a>• [`ignore_secure`](#response-cookies-to-add-ignore-secure) - Optional Block<br>Can be used for messages where no values are needed
|
|
502
502
|
|
|
503
|
-
<a id="response-cookies-to-add-ignore-value"></a>• [`ignore_value`](#response-cookies-to-add-ignore-value) - Optional Block<br>
|
|
503
|
+
<a id="response-cookies-to-add-ignore-value"></a>• [`ignore_value`](#response-cookies-to-add-ignore-value) - Optional Block<br>Can be used for messages where no values are needed
|
|
504
504
|
|
|
505
|
-
<a id="response-cookies-to-add-max-age-value"></a>• [`max_age_value`](#response-cookies-to-add-max-age-value) - Optional Number<br>Add
|
|
505
|
+
<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 attribute
|
|
506
506
|
|
|
507
|
-
<a id="response-cookies-to-add-name"></a>• [`name`](#response-cookies-to-add-name) - Optional String<br>Name
|
|
507
|
+
<a id="response-cookies-to-add-name"></a>• [`name`](#response-cookies-to-add-name) - Optional String<br>Name of the cookie in Cookie header
|
|
508
508
|
|
|
509
|
-
<a id="response-cookies-to-add-overwrite"></a>• [`overwrite`](#response-cookies-to-add-overwrite) - Optional Bool Defaults to `do`<br>
|
|
509
|
+
<a id="response-cookies-to-add-overwrite"></a>• [`overwrite`](#response-cookies-to-add-overwrite) - Optional Bool Defaults to `do`<br>Should the value be overwritten? If true, the value is overwritten to existing values. not overwrite
|
|
510
510
|
|
|
511
|
-
<a id="response-cookies-to-add-samesite-lax"></a>• [`samesite_lax`](#response-cookies-to-add-samesite-lax) - Optional Block<br>
|
|
511
|
+
<a id="response-cookies-to-add-samesite-lax"></a>• [`samesite_lax`](#response-cookies-to-add-samesite-lax) - Optional Block<br>Can be used for messages where no values are needed
|
|
512
512
|
|
|
513
|
-
<a id="response-cookies-to-add-samesite-none"></a>• [`samesite_none`](#response-cookies-to-add-samesite-none) - Optional Block<br>
|
|
513
|
+
<a id="response-cookies-to-add-samesite-none"></a>• [`samesite_none`](#response-cookies-to-add-samesite-none) - Optional Block<br>Can be used for messages where no values are needed
|
|
514
514
|
|
|
515
|
-
<a id="response-cookies-to-add-samesite-strict"></a>• [`samesite_strict`](#response-cookies-to-add-samesite-strict) - Optional Block<br>
|
|
515
|
+
<a id="response-cookies-to-add-samesite-strict"></a>• [`samesite_strict`](#response-cookies-to-add-samesite-strict) - Optional Block<br>Can be used for messages where no values are needed
|
|
516
516
|
|
|
517
|
-
<a id="response-cookies-to-add-secret-value"></a>• [`secret_value`](#response-cookies-to-add-secret-value) - Optional Block<br>
|
|
517
|
+
<a id="response-cookies-to-add-secret-value"></a>• [`secret_value`](#response-cookies-to-add-secret-value) - Optional Block<br>SecretType is used in an object to indicate a sensitive/confidential field<br>See [Secret Value](#response-cookies-to-add-secret-value) below.
|
|
518
518
|
|
|
519
|
-
<a id="response-cookies-to-add-value"></a>• [`value`](#response-cookies-to-add-value) - Optional String<br>Value
|
|
519
|
+
<a id="response-cookies-to-add-value"></a>• [`value`](#response-cookies-to-add-value) - Optional String<br>Value of the Cookie header
|
|
520
520
|
|
|
521
521
|
#### Response Cookies To Add Secret Value
|
|
522
522
|
|
|
523
523
|
A [`secret_value`](#response-cookies-to-add-secret-value) block (within [`response_cookies_to_add`](#response-cookies-to-add)) supports the following:
|
|
524
524
|
|
|
525
|
-
<a id="info-85cc48"></a>• [`blindfold_secret_info`](#info-85cc48) - Optional Block<br>
|
|
525
|
+
<a id="info-85cc48"></a>• [`blindfold_secret_info`](#info-85cc48) - Optional Block<br>BlindfoldSecretInfoType specifies information about the Secret managed by F5XC Secret Management<br>See [Blindfold Secret Info](#info-85cc48) below.
|
|
526
526
|
|
|
527
|
-
<a id="info-3654fd"></a>• [`clear_secret_info`](#info-3654fd) - Optional Block<br>
|
|
527
|
+
<a id="info-3654fd"></a>• [`clear_secret_info`](#info-3654fd) - Optional Block<br>ClearSecretInfoType specifies information about the Secret that is not encrypted<br>See [Clear Secret Info](#info-3654fd) below.
|
|
528
528
|
|
|
529
529
|
#### Response Cookies To Add Secret Value Blindfold Secret Info
|
|
530
530
|
|
|
@@ -538,21 +538,21 @@ A [`secret_value`](#response-cookies-to-add-secret-value) block (within [`respon
|
|
|
538
538
|
|
|
539
539
|
A [`response_headers_to_add`](#response-headers-to-add) block supports the following:
|
|
540
540
|
|
|
541
|
-
<a id="response-headers-to-add-append"></a>• [`append`](#response-headers-to-add-append) - Optional Bool Defaults to `do`<br>
|
|
541
|
+
<a id="response-headers-to-add-append"></a>• [`append`](#response-headers-to-add-append) - Optional Bool Defaults to `do`<br>Should the value be appended? If true, the value is appended to existing values. not append
|
|
542
542
|
|
|
543
543
|
<a id="response-headers-to-add-name"></a>• [`name`](#response-headers-to-add-name) - Optional String<br>Name. Name of the HTTP header
|
|
544
544
|
|
|
545
|
-
<a id="response-headers-to-add-secret-value"></a>• [`secret_value`](#response-headers-to-add-secret-value) - Optional Block<br>
|
|
545
|
+
<a id="response-headers-to-add-secret-value"></a>• [`secret_value`](#response-headers-to-add-secret-value) - Optional Block<br>SecretType is used in an object to indicate a sensitive/confidential field<br>See [Secret Value](#response-headers-to-add-secret-value) below.
|
|
546
546
|
|
|
547
|
-
<a id="response-headers-to-add-value"></a>• [`value`](#response-headers-to-add-value) - Optional String<br>Value
|
|
547
|
+
<a id="response-headers-to-add-value"></a>• [`value`](#response-headers-to-add-value) - Optional String<br>Value of the HTTP header
|
|
548
548
|
|
|
549
549
|
#### Response Headers To Add Secret Value
|
|
550
550
|
|
|
551
551
|
A [`secret_value`](#response-headers-to-add-secret-value) block (within [`response_headers_to_add`](#response-headers-to-add)) supports the following:
|
|
552
552
|
|
|
553
|
-
<a id="info-92dea8"></a>• [`blindfold_secret_info`](#info-92dea8) - Optional Block<br>
|
|
553
|
+
<a id="info-92dea8"></a>• [`blindfold_secret_info`](#info-92dea8) - Optional Block<br>BlindfoldSecretInfoType specifies information about the Secret managed by F5XC Secret Management<br>See [Blindfold Secret Info](#info-92dea8) below.
|
|
554
554
|
|
|
555
|
-
<a id="info-52d56a"></a>• [`clear_secret_info`](#info-52d56a) - Optional Block<br>
|
|
555
|
+
<a id="info-52d56a"></a>• [`clear_secret_info`](#info-52d56a) - Optional Block<br>ClearSecretInfoType specifies information about the Secret that is not encrypted<br>See [Clear Secret Info](#info-52d56a) below.
|
|
556
556
|
|
|
557
557
|
#### Response Headers To Add Secret Value Blindfold Secret Info
|
|
558
558
|
|
|
@@ -566,61 +566,61 @@ A [`secret_value`](#response-headers-to-add-secret-value) block (within [`respon
|
|
|
566
566
|
|
|
567
567
|
A [`retry_policy`](#retry-policy) block supports the following:
|
|
568
568
|
|
|
569
|
-
<a id="retry-policy-back-off"></a>• [`back_off`](#retry-policy-back-off) - Optional Block<br>
|
|
569
|
+
<a id="retry-policy-back-off"></a>• [`back_off`](#retry-policy-back-off) - Optional Block<br>Specifies parameters that control retry back off<br>See [Back Off](#retry-policy-back-off) below.
|
|
570
570
|
|
|
571
|
-
<a id="retry-policy-num-retries"></a>• [`num_retries`](#retry-policy-num-retries) - Optional Number Defaults to `1`<br>
|
|
571
|
+
<a id="retry-policy-num-retries"></a>• [`num_retries`](#retry-policy-num-retries) - Optional Number Defaults to `1`<br>Specifies the allowed number of retries. Retries can be done any number of times. An exponential back-off algorithm is used between each retry
|
|
572
572
|
|
|
573
|
-
<a id="retry-policy-per-try-timeout"></a>• [`per_try_timeout`](#retry-policy-per-try-timeout) - Optional Number<br>
|
|
573
|
+
<a id="retry-policy-per-try-timeout"></a>• [`per_try_timeout`](#retry-policy-per-try-timeout) - Optional Number<br>Specifies a non-zero timeout per retry attempt. In milliseconds
|
|
574
574
|
|
|
575
|
-
<a id="retry-policy-retriable-status-codes"></a>• [`retriable_status_codes`](#retry-policy-retriable-status-codes) - Optional List<br>
|
|
575
|
+
<a id="retry-policy-retriable-status-codes"></a>• [`retriable_status_codes`](#retry-policy-retriable-status-codes) - Optional List<br>HTTP status codes that should trigger a retry in addition to those specified by retry_on
|
|
576
576
|
|
|
577
|
-
<a id="retry-policy-retry-condition"></a>• [`retry_condition`](#retry-policy-retry-condition) - Optional List<br>
|
|
577
|
+
<a id="retry-policy-retry-condition"></a>• [`retry_condition`](#retry-policy-retry-condition) - Optional List<br>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
|
|
578
578
|
|
|
579
579
|
#### Retry Policy Back Off
|
|
580
580
|
|
|
581
581
|
A [`back_off`](#retry-policy-back-off) block (within [`retry_policy`](#retry-policy)) supports the following:
|
|
582
582
|
|
|
583
|
-
<a id="retry-policy-back-off-base-interval"></a>• [`base_interval`](#retry-policy-back-off-base-interval) - Optional Number<br>
|
|
583
|
+
<a id="retry-policy-back-off-base-interval"></a>• [`base_interval`](#retry-policy-back-off-base-interval) - Optional Number<br>Specifies the base interval between retries in milliseconds
|
|
584
584
|
|
|
585
|
-
<a id="retry-policy-back-off-max-interval"></a>• [`max_interval`](#retry-policy-back-off-max-interval) - Optional Number Defaults to `10`<br>
|
|
585
|
+
<a id="retry-policy-back-off-max-interval"></a>• [`max_interval`](#retry-policy-back-off-max-interval) - Optional Number Defaults to `10`<br>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
|
|
586
586
|
|
|
587
587
|
#### Routes
|
|
588
588
|
|
|
589
589
|
A [`routes`](#routes) block supports the following:
|
|
590
590
|
|
|
591
|
-
<a id="routes-kind"></a>• [`kind`](#routes-kind) - Optional String<br>
|
|
591
|
+
<a id="routes-kind"></a>• [`kind`](#routes-kind) - Optional String<br>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')
|
|
592
592
|
|
|
593
|
-
<a id="routes-name"></a>• [`name`](#routes-name) - Optional String<br>
|
|
593
|
+
<a id="routes-name"></a>• [`name`](#routes-name) - Optional String<br>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
|
|
594
594
|
|
|
595
|
-
<a id="routes-namespace"></a>• [`namespace`](#routes-namespace) - Optional String<br>
|
|
595
|
+
<a id="routes-namespace"></a>• [`namespace`](#routes-namespace) - Optional String<br>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
|
|
596
596
|
|
|
597
|
-
<a id="routes-tenant"></a>• [`tenant`](#routes-tenant) - Optional String<br>
|
|
597
|
+
<a id="routes-tenant"></a>• [`tenant`](#routes-tenant) - Optional String<br>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
|
|
598
598
|
|
|
599
|
-
<a id="routes-uid"></a>• [`uid`](#routes-uid) - Optional String<br>
|
|
599
|
+
<a id="routes-uid"></a>• [`uid`](#routes-uid) - Optional String<br>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
|
|
600
600
|
|
|
601
601
|
#### Sensitive Data Policy
|
|
602
602
|
|
|
603
603
|
A [`sensitive_data_policy`](#sensitive-data-policy) block supports the following:
|
|
604
604
|
|
|
605
|
-
<a id="sensitive-data-policy-kind"></a>• [`kind`](#sensitive-data-policy-kind) - Optional String<br>
|
|
605
|
+
<a id="sensitive-data-policy-kind"></a>• [`kind`](#sensitive-data-policy-kind) - Optional String<br>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')
|
|
606
606
|
|
|
607
|
-
<a id="sensitive-data-policy-name"></a>• [`name`](#sensitive-data-policy-name) - Optional String<br>
|
|
607
|
+
<a id="sensitive-data-policy-name"></a>• [`name`](#sensitive-data-policy-name) - Optional String<br>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
|
|
608
608
|
|
|
609
|
-
<a id="sensitive-data-policy-namespace"></a>• [`namespace`](#sensitive-data-policy-namespace) - Optional String<br>
|
|
609
|
+
<a id="sensitive-data-policy-namespace"></a>• [`namespace`](#sensitive-data-policy-namespace) - Optional String<br>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
|
|
610
610
|
|
|
611
|
-
<a id="sensitive-data-policy-tenant"></a>• [`tenant`](#sensitive-data-policy-tenant) - Optional String<br>
|
|
611
|
+
<a id="sensitive-data-policy-tenant"></a>• [`tenant`](#sensitive-data-policy-tenant) - Optional String<br>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
|
|
612
612
|
|
|
613
|
-
<a id="sensitive-data-policy-uid"></a>• [`uid`](#sensitive-data-policy-uid) - Optional String<br>
|
|
613
|
+
<a id="sensitive-data-policy-uid"></a>• [`uid`](#sensitive-data-policy-uid) - Optional String<br>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
|
|
614
614
|
|
|
615
615
|
#### Slow DDOS Mitigation
|
|
616
616
|
|
|
617
617
|
A [`slow_ddos_mitigation`](#slow-ddos-mitigation) block supports the following:
|
|
618
618
|
|
|
619
|
-
<a id="timeout-81071e"></a>• [`disable_request_timeout`](#timeout-81071e) - Optional Block<br>
|
|
619
|
+
<a id="timeout-81071e"></a>• [`disable_request_timeout`](#timeout-81071e) - Optional Block<br>Can be used for messages where no values are needed
|
|
620
620
|
|
|
621
|
-
<a id="timeout-da89d3"></a>• [`request_headers_timeout`](#timeout-da89d3) - Optional Number Defaults to `10000`<br>
|
|
621
|
+
<a id="timeout-da89d3"></a>• [`request_headers_timeout`](#timeout-da89d3) - Optional Number Defaults to `10000`<br>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
|
|
622
622
|
|
|
623
|
-
<a id="slow-ddos-mitigation-request-timeout"></a>• [`request_timeout`](#slow-ddos-mitigation-request-timeout) - Optional Number
|
|
623
|
+
<a id="slow-ddos-mitigation-request-timeout"></a>• [`request_timeout`](#slow-ddos-mitigation-request-timeout) - Optional Number
|
|
624
624
|
|
|
625
625
|
#### Timeouts
|
|
626
626
|
|
|
@@ -640,47 +640,47 @@ A [`tls_cert_params`](#tls-cert-params) block supports the following:
|
|
|
640
640
|
|
|
641
641
|
<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.
|
|
642
642
|
|
|
643
|
-
<a id="tls-cert-params-cipher-suites"></a>• [`cipher_suites`](#tls-cert-params-cipher-suites) - Optional List<br>
|
|
643
|
+
<a id="tls-cert-params-cipher-suites"></a>• [`cipher_suites`](#tls-cert-params-cipher-suites) - Optional List<br>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
|
|
644
644
|
|
|
645
|
-
<a id="optional-41418d"></a>• [`client_certificate_optional`](#optional-41418d) - Optional Block<br>
|
|
645
|
+
<a id="optional-41418d"></a>• [`client_certificate_optional`](#optional-41418d) - Optional Block<br>Can be used for messages where no values are needed
|
|
646
646
|
|
|
647
|
-
<a id="required-58689a"></a>• [`client_certificate_required`](#required-58689a) - Optional Block<br>
|
|
647
|
+
<a id="required-58689a"></a>• [`client_certificate_required`](#required-58689a) - Optional Block<br>Can be used for messages where no values are needed
|
|
648
648
|
|
|
649
|
-
<a id="version-93b9ed"></a>• [`maximum_protocol_version`](#version-93b9ed) - 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]
|
|
649
|
+
<a id="version-93b9ed"></a>• [`maximum_protocol_version`](#version-93b9ed) - 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] TlsProtocol is enumeration of supported TLS versions F5 Distributed Cloud will choose the optimal TLS version
|
|
650
650
|
|
|
651
|
-
<a id="version-77eedf"></a>• [`minimum_protocol_version`](#version-77eedf) - 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]
|
|
651
|
+
<a id="version-77eedf"></a>• [`minimum_protocol_version`](#version-77eedf) - 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] TlsProtocol is enumeration of supported TLS versions F5 Distributed Cloud will choose the optimal TLS version
|
|
652
652
|
|
|
653
|
-
<a id="tls-cert-params-no-client-certificate"></a>• [`no_client_certificate`](#tls-cert-params-no-client-certificate) - Optional Block<br>
|
|
653
|
+
<a id="tls-cert-params-no-client-certificate"></a>• [`no_client_certificate`](#tls-cert-params-no-client-certificate) - Optional Block<br>Can be used for messages where no values are needed
|
|
654
654
|
|
|
655
|
-
<a id="tls-cert-params-validation-params"></a>• [`validation_params`](#tls-cert-params-validation-params) - Optional Block<br>
|
|
655
|
+
<a id="tls-cert-params-validation-params"></a>• [`validation_params`](#tls-cert-params-validation-params) - Optional Block<br>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.
|
|
656
656
|
|
|
657
|
-
<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]
|
|
657
|
+
<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] X-Forwarded-Client-Cert header elements to be set in an mTLS enabled connections. If none are defined, the header will not be added
|
|
658
658
|
|
|
659
659
|
#### TLS Cert Params Certificates
|
|
660
660
|
|
|
661
661
|
A [`certificates`](#tls-cert-params-certificates) block (within [`tls_cert_params`](#tls-cert-params)) supports the following:
|
|
662
662
|
|
|
663
|
-
<a id="tls-cert-params-certificates-kind"></a>• [`kind`](#tls-cert-params-certificates-kind) - Optional String<br>
|
|
663
|
+
<a id="tls-cert-params-certificates-kind"></a>• [`kind`](#tls-cert-params-certificates-kind) - Optional String<br>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')
|
|
664
664
|
|
|
665
|
-
<a id="tls-cert-params-certificates-name"></a>• [`name`](#tls-cert-params-certificates-name) - Optional String<br>
|
|
665
|
+
<a id="tls-cert-params-certificates-name"></a>• [`name`](#tls-cert-params-certificates-name) - Optional String<br>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
|
|
666
666
|
|
|
667
|
-
<a id="tls-cert-params-certificates-namespace"></a>• [`namespace`](#tls-cert-params-certificates-namespace) - Optional String<br>
|
|
667
|
+
<a id="tls-cert-params-certificates-namespace"></a>• [`namespace`](#tls-cert-params-certificates-namespace) - Optional String<br>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
|
|
668
668
|
|
|
669
|
-
<a id="tls-cert-params-certificates-tenant"></a>• [`tenant`](#tls-cert-params-certificates-tenant) - Optional String<br>
|
|
669
|
+
<a id="tls-cert-params-certificates-tenant"></a>• [`tenant`](#tls-cert-params-certificates-tenant) - Optional String<br>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
|
|
670
670
|
|
|
671
|
-
<a id="tls-cert-params-certificates-uid"></a>• [`uid`](#tls-cert-params-certificates-uid) - Optional String<br>
|
|
671
|
+
<a id="tls-cert-params-certificates-uid"></a>• [`uid`](#tls-cert-params-certificates-uid) - Optional String<br>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
|
|
672
672
|
|
|
673
673
|
#### TLS Cert Params Validation Params
|
|
674
674
|
|
|
675
675
|
A [`validation_params`](#tls-cert-params-validation-params) block (within [`tls_cert_params`](#tls-cert-params)) supports the following:
|
|
676
676
|
|
|
677
|
-
<a id="verification-c74b3f"></a>• [`skip_hostname_verification`](#verification-c74b3f) - Optional Bool<br>
|
|
677
|
+
<a id="verification-c74b3f"></a>• [`skip_hostname_verification`](#verification-c74b3f) - Optional Bool<br>When True, skip verification of hostname i.e. CN/Subject Alt Name of certificate is not matched to the connecting hostname
|
|
678
678
|
|
|
679
679
|
<a id="trusted-ca-f27956"></a>• [`trusted_ca`](#trusted-ca-f27956) - Optional Block<br>Root CA Certificate Reference. Reference to Root CA Certificate<br>See [Trusted CA](#trusted-ca-f27956) below.
|
|
680
680
|
|
|
681
|
-
<a id="url-948cfa"></a>• [`trusted_ca_url`](#url-948cfa) - Optional String<br>Inline Root CA Certificate
|
|
681
|
+
<a id="url-948cfa"></a>• [`trusted_ca_url`](#url-948cfa) - Optional String<br>Inline Root CA Certificate
|
|
682
682
|
|
|
683
|
-
<a id="names-e2ed6b"></a>• [`verify_subject_alt_names`](#names-e2ed6b) - Optional List<br>List of
|
|
683
|
+
<a id="names-e2ed6b"></a>• [`verify_subject_alt_names`](#names-e2ed6b) - Optional List<br>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
|
|
684
684
|
|
|
685
685
|
#### TLS Cert Params Validation Params Trusted CA
|
|
686
686
|
|
|
@@ -696,45 +696,45 @@ A [`trusted_ca`](#trusted-ca-f27956) block (within [`tls_cert_params.validation_
|
|
|
696
696
|
|
|
697
697
|
A [`tls_parameters`](#tls-parameters) block supports the following:
|
|
698
698
|
|
|
699
|
-
<a id="optional-56d793"></a>• [`client_certificate_optional`](#optional-56d793) - Optional Block<br>
|
|
699
|
+
<a id="optional-56d793"></a>• [`client_certificate_optional`](#optional-56d793) - Optional Block<br>Can be used for messages where no values are needed
|
|
700
700
|
|
|
701
|
-
<a id="required-544cf5"></a>• [`client_certificate_required`](#required-544cf5) - Optional Block<br>
|
|
701
|
+
<a id="required-544cf5"></a>• [`client_certificate_required`](#required-544cf5) - Optional Block<br>Can be used for messages where no values are needed
|
|
702
702
|
|
|
703
|
-
<a id="tls-parameters-common-params"></a>• [`common_params`](#tls-parameters-common-params) - Optional Block<br>
|
|
703
|
+
<a id="tls-parameters-common-params"></a>• [`common_params`](#tls-parameters-common-params) - Optional Block<br>Information of different aspects for TLS authentication related to ciphers, certificates and trust store<br>See [Common Params](#tls-parameters-common-params) below.
|
|
704
704
|
|
|
705
|
-
<a id="tls-parameters-no-client-certificate"></a>• [`no_client_certificate`](#tls-parameters-no-client-certificate) - Optional Block<br>
|
|
705
|
+
<a id="tls-parameters-no-client-certificate"></a>• [`no_client_certificate`](#tls-parameters-no-client-certificate) - Optional Block<br>Can be used for messages where no values are needed
|
|
706
706
|
|
|
707
|
-
<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]
|
|
707
|
+
<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] X-Forwarded-Client-Cert header elements to be set in an mTLS enabled connections. If none are defined, the header will not be added
|
|
708
708
|
|
|
709
709
|
#### TLS Parameters Common Params
|
|
710
710
|
|
|
711
711
|
A [`common_params`](#tls-parameters-common-params) block (within [`tls_parameters`](#tls-parameters)) supports the following:
|
|
712
712
|
|
|
713
|
-
<a id="suites-f69d86"></a>• [`cipher_suites`](#suites-f69d86) - Optional List<br>
|
|
713
|
+
<a id="suites-f69d86"></a>• [`cipher_suites`](#suites-f69d86) - Optional List<br>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
|
|
714
714
|
|
|
715
|
-
<a id="version-e7c6f2"></a>• [`maximum_protocol_version`](#version-e7c6f2) - 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]
|
|
715
|
+
<a id="version-e7c6f2"></a>• [`maximum_protocol_version`](#version-e7c6f2) - 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] TlsProtocol is enumeration of supported TLS versions F5 Distributed Cloud will choose the optimal TLS version
|
|
716
716
|
|
|
717
|
-
<a id="version-7d1460"></a>• [`minimum_protocol_version`](#version-7d1460) - 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]
|
|
717
|
+
<a id="version-7d1460"></a>• [`minimum_protocol_version`](#version-7d1460) - 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] TlsProtocol is enumeration of supported TLS versions F5 Distributed Cloud will choose the optimal TLS version
|
|
718
718
|
|
|
719
719
|
<a id="certificates-c9caff"></a>• [`tls_certificates`](#certificates-c9caff) - Optional Block<br>TLS Certificates. Set of TLS certificates<br>See [TLS Certificates](#certificates-c9caff) below.
|
|
720
720
|
|
|
721
|
-
<a id="params-6e95a6"></a>• [`validation_params`](#params-6e95a6) - Optional Block<br>
|
|
721
|
+
<a id="params-6e95a6"></a>• [`validation_params`](#params-6e95a6) - Optional Block<br>Includes URL for a trust store, whether SAN verification is required and list of Subject Alt Names for verification<br>See [Validation Params](#params-6e95a6) below.
|
|
722
722
|
|
|
723
723
|
#### TLS Parameters Common Params TLS Certificates
|
|
724
724
|
|
|
725
725
|
A [`tls_certificates`](#certificates-c9caff) block (within [`tls_parameters.common_params`](#tls-parameters-common-params)) supports the following:
|
|
726
726
|
|
|
727
|
-
<a id="url-323181"></a>• [`certificate_url`](#url-323181) - Optional String<br>
|
|
727
|
+
<a id="url-323181"></a>• [`certificate_url`](#url-323181) - Optional String<br>TLS certificate. Certificate or certificate chain in PEM format including the PEM headers
|
|
728
728
|
|
|
729
|
-
<a id="algorithms-eb62be"></a>• [`custom_hash_algorithms`](#algorithms-eb62be) - Optional Block<br>
|
|
729
|
+
<a id="algorithms-eb62be"></a>• [`custom_hash_algorithms`](#algorithms-eb62be) - Optional Block<br>Specifies the hash algorithms to be used<br>See [Custom Hash Algorithms](#algorithms-eb62be) below.
|
|
730
730
|
|
|
731
731
|
<a id="spec-5af02c"></a>• [`description_spec`](#spec-5af02c) - Optional String<br>Description. Description for the certificate
|
|
732
732
|
|
|
733
|
-
<a id="stapling-c091fa"></a>• [`disable_ocsp_stapling`](#stapling-c091fa) - Optional Block<br>
|
|
733
|
+
<a id="stapling-c091fa"></a>• [`disable_ocsp_stapling`](#stapling-c091fa) - Optional Block<br>Can be used for messages where no values are needed
|
|
734
734
|
|
|
735
|
-
<a id="key-da7979"></a>• [`private_key`](#key-da7979) - Optional Block<br>
|
|
735
|
+
<a id="key-da7979"></a>• [`private_key`](#key-da7979) - Optional Block<br>SecretType is used in an object to indicate a sensitive/confidential field<br>See [Private Key](#key-da7979) below.
|
|
736
736
|
|
|
737
|
-
<a id="defaults-f58bc7"></a>• [`use_system_defaults`](#defaults-f58bc7) - Optional Block<br>
|
|
737
|
+
<a id="defaults-f58bc7"></a>• [`use_system_defaults`](#defaults-f58bc7) - Optional Block<br>Can be used for messages where no values are needed
|
|
738
738
|
|
|
739
739
|
#### TLS Parameters Common Params TLS Certificates Custom Hash Algorithms
|
|
740
740
|
|
|
@@ -756,13 +756,13 @@ A [`tls_certificates`](#certificates-c9caff) block (within [`tls_parameters.comm
|
|
|
756
756
|
|
|
757
757
|
A [`validation_params`](#params-6e95a6) block (within [`tls_parameters.common_params`](#tls-parameters-common-params)) supports the following:
|
|
758
758
|
|
|
759
|
-
<a id="verification-30d13d"></a>• [`skip_hostname_verification`](#verification-30d13d) - Optional Bool<br>
|
|
759
|
+
<a id="verification-30d13d"></a>• [`skip_hostname_verification`](#verification-30d13d) - Optional Bool<br>When True, skip verification of hostname i.e. CN/Subject Alt Name of certificate is not matched to the connecting hostname
|
|
760
760
|
|
|
761
761
|
<a id="trusted-ca-39c22f"></a>• [`trusted_ca`](#trusted-ca-39c22f) - Optional Block<br>Root CA Certificate Reference. Reference to Root CA Certificate<br>See [Trusted CA](#trusted-ca-39c22f) below.
|
|
762
762
|
|
|
763
|
-
<a id="url-910417"></a>• [`trusted_ca_url`](#url-910417) - Optional String<br>Inline Root CA Certificate
|
|
763
|
+
<a id="url-910417"></a>• [`trusted_ca_url`](#url-910417) - Optional String<br>Inline Root CA Certificate
|
|
764
764
|
|
|
765
|
-
<a id="names-1c97ed"></a>• [`verify_subject_alt_names`](#names-1c97ed) - Optional List<br>List of
|
|
765
|
+
<a id="names-1c97ed"></a>• [`verify_subject_alt_names`](#names-1c97ed) - Optional List<br>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
|
|
766
766
|
|
|
767
767
|
#### TLS Parameters Common Params Validation Params Trusted CA
|
|
768
768
|
|
|
@@ -776,45 +776,45 @@ A [`validation_params`](#params-6e95a6) block (within [`tls_parameters.common_pa
|
|
|
776
776
|
|
|
777
777
|
An [`user_identification`](#user-identification) block supports the following:
|
|
778
778
|
|
|
779
|
-
<a id="user-identification-kind"></a>• [`kind`](#user-identification-kind) - Optional String<br>
|
|
779
|
+
<a id="user-identification-kind"></a>• [`kind`](#user-identification-kind) - Optional String<br>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')
|
|
780
780
|
|
|
781
|
-
<a id="user-identification-name"></a>• [`name`](#user-identification-name) - Optional String<br>
|
|
781
|
+
<a id="user-identification-name"></a>• [`name`](#user-identification-name) - Optional String<br>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
|
|
782
782
|
|
|
783
|
-
<a id="user-identification-namespace"></a>• [`namespace`](#user-identification-namespace) - Optional String<br>
|
|
783
|
+
<a id="user-identification-namespace"></a>• [`namespace`](#user-identification-namespace) - Optional String<br>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
|
|
784
784
|
|
|
785
|
-
<a id="user-identification-tenant"></a>• [`tenant`](#user-identification-tenant) - Optional String<br>
|
|
785
|
+
<a id="user-identification-tenant"></a>• [`tenant`](#user-identification-tenant) - Optional String<br>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
|
|
786
786
|
|
|
787
|
-
<a id="user-identification-uid"></a>• [`uid`](#user-identification-uid) - Optional String<br>
|
|
787
|
+
<a id="user-identification-uid"></a>• [`uid`](#user-identification-uid) - Optional String<br>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
|
|
788
788
|
|
|
789
789
|
#### WAF Type
|
|
790
790
|
|
|
791
791
|
A [`waf_type`](#waf-type) block supports the following:
|
|
792
792
|
|
|
793
|
-
<a id="waf-type-app-firewall"></a>• [`app_firewall`](#waf-type-app-firewall) - Optional Block<br>
|
|
793
|
+
<a id="waf-type-app-firewall"></a>• [`app_firewall`](#waf-type-app-firewall) - Optional Block<br>List of references to the app_firewall configuration objects<br>See [App Firewall](#waf-type-app-firewall) below.
|
|
794
794
|
|
|
795
|
-
<a id="waf-type-disable-waf"></a>• [`disable_waf`](#waf-type-disable-waf) - Optional Block<br>
|
|
795
|
+
<a id="waf-type-disable-waf"></a>• [`disable_waf`](#waf-type-disable-waf) - Optional Block<br>Can be used for messages where no values are needed
|
|
796
796
|
|
|
797
|
-
<a id="waf-type-inherit-waf"></a>• [`inherit_waf`](#waf-type-inherit-waf) - Optional Block<br>
|
|
797
|
+
<a id="waf-type-inherit-waf"></a>• [`inherit_waf`](#waf-type-inherit-waf) - Optional Block<br>Can be used for messages where no values are needed
|
|
798
798
|
|
|
799
799
|
#### WAF Type App Firewall
|
|
800
800
|
|
|
801
801
|
An [`app_firewall`](#waf-type-app-firewall) block (within [`waf_type`](#waf-type)) supports the following:
|
|
802
802
|
|
|
803
|
-
<a id="waf-type-app-firewall-app-firewall"></a>• [`app_firewall`](#waf-type-app-firewall-app-firewall) - Optional Block<br>
|
|
803
|
+
<a id="waf-type-app-firewall-app-firewall"></a>• [`app_firewall`](#waf-type-app-firewall-app-firewall) - Optional Block<br>References to an Application Firewall configuration object<br>See [App Firewall](#waf-type-app-firewall-app-firewall) below.
|
|
804
804
|
|
|
805
805
|
#### WAF Type App Firewall App Firewall
|
|
806
806
|
|
|
807
807
|
An [`app_firewall`](#waf-type-app-firewall-app-firewall) block (within [`waf_type.app_firewall`](#waf-type-app-firewall)) supports the following:
|
|
808
808
|
|
|
809
|
-
<a id="waf-type-app-firewall-app-firewall-kind"></a>• [`kind`](#waf-type-app-firewall-app-firewall-kind) - Optional String<br>
|
|
809
|
+
<a id="waf-type-app-firewall-app-firewall-kind"></a>• [`kind`](#waf-type-app-firewall-app-firewall-kind) - Optional String<br>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')
|
|
810
810
|
|
|
811
|
-
<a id="waf-type-app-firewall-app-firewall-name"></a>• [`name`](#waf-type-app-firewall-app-firewall-name) - Optional String<br>
|
|
811
|
+
<a id="waf-type-app-firewall-app-firewall-name"></a>• [`name`](#waf-type-app-firewall-app-firewall-name) - Optional String<br>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
|
|
812
812
|
|
|
813
|
-
<a id="namespace-e90470"></a>• [`namespace`](#namespace-e90470) - Optional String<br>
|
|
813
|
+
<a id="namespace-e90470"></a>• [`namespace`](#namespace-e90470) - Optional String<br>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
|
|
814
814
|
|
|
815
|
-
<a id="tenant-441c06"></a>• [`tenant`](#tenant-441c06) - Optional String<br>
|
|
815
|
+
<a id="tenant-441c06"></a>• [`tenant`](#tenant-441c06) - Optional String<br>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
|
|
816
816
|
|
|
817
|
-
<a id="waf-type-app-firewall-app-firewall-uid"></a>• [`uid`](#waf-type-app-firewall-app-firewall-uid) - Optional String<br>
|
|
817
|
+
<a id="waf-type-app-firewall-app-firewall-uid"></a>• [`uid`](#waf-type-app-firewall-app-firewall-uid) - Optional String<br>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
|
|
818
818
|
|
|
819
819
|
---
|
|
820
820
|
|