@robinmordasiewicz/f5xc-terraform-mcp 3.10.1 → 3.10.3
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/discovery.md +2 -2
- package/dist/docs/data-sources/irule.md +2 -2
- package/dist/docs/data-sources/network_policy.md +2 -2
- package/dist/docs/data-sources/policer.md +2 -2
- package/dist/docs/data-sources/site.md +2 -2
- package/dist/docs/data-sources/workload.md +2 -2
- package/dist/docs/resources/advertise_policy.md +10 -10
- package/dist/docs/resources/alert_policy.md +9 -9
- package/dist/docs/resources/alert_receiver.md +4 -4
- package/dist/docs/resources/api_definition.md +2 -2
- package/dist/docs/resources/api_testing.md +6 -6
- package/dist/docs/resources/apm.md +8 -8
- package/dist/docs/resources/app_firewall.md +19 -19
- package/dist/docs/resources/app_setting.md +5 -5
- package/dist/docs/resources/app_type.md +3 -3
- package/dist/docs/resources/aws_tgw_site.md +50 -50
- package/dist/docs/resources/aws_vpc_site.md +66 -66
- package/dist/docs/resources/azure_vnet_site.md +93 -93
- package/dist/docs/resources/bgp.md +6 -6
- package/dist/docs/resources/bgp_routing_policy.md +7 -7
- package/dist/docs/resources/cdn_cache_rule.md +2 -2
- package/dist/docs/resources/cdn_loadbalancer.md +122 -122
- package/dist/docs/resources/cloud_connect.md +4 -4
- package/dist/docs/resources/cloud_credentials.md +2 -2
- package/dist/docs/resources/cloud_link.md +3 -3
- package/dist/docs/resources/cluster.md +18 -18
- package/dist/docs/resources/dc_cluster_group.md +4 -4
- package/dist/docs/resources/discovery.md +259 -8
- package/dist/docs/resources/dns_domain.md +2 -2
- package/dist/docs/resources/endpoint.md +5 -5
- package/dist/docs/resources/enhanced_firewall_policy.md +15 -15
- package/dist/docs/resources/external_connector.md +7 -7
- package/dist/docs/resources/fast_acl.md +2 -2
- package/dist/docs/resources/fast_acl_rule.md +2 -2
- package/dist/docs/resources/fleet.md +25 -25
- package/dist/docs/resources/forward_proxy_policy.md +15 -15
- package/dist/docs/resources/forwarding_class.md +5 -5
- package/dist/docs/resources/gcp_vpc_site.md +37 -37
- package/dist/docs/resources/global_log_receiver.md +104 -104
- package/dist/docs/resources/healthcheck.md +2 -2
- package/dist/docs/resources/http_loadbalancer.md +287 -287
- package/dist/docs/resources/irule.md +7 -5
- package/dist/docs/resources/log_receiver.md +104 -104
- package/dist/docs/resources/malicious_user_mitigation.md +6 -6
- package/dist/docs/resources/nat_policy.md +10 -10
- package/dist/docs/resources/network_connector.md +9 -9
- package/dist/docs/resources/network_firewall.md +3 -3
- package/dist/docs/resources/network_interface.md +28 -28
- package/dist/docs/resources/network_policy.md +210 -37
- package/dist/docs/resources/network_policy_view.md +16 -16
- package/dist/docs/resources/nfv_service.md +26 -26
- package/dist/docs/resources/origin_pool.md +48 -48
- package/dist/docs/resources/policer.md +50 -10
- package/dist/docs/resources/policy_based_routing.md +8 -8
- package/dist/docs/resources/protocol_inspection.md +4 -4
- package/dist/docs/resources/proxy.md +23 -23
- package/dist/docs/resources/rate_limiter.md +1 -1
- package/dist/docs/resources/rate_limiter_policy.md +8 -8
- package/dist/docs/resources/route.md +36 -36
- package/dist/docs/resources/secret_management_access.md +8 -8
- package/dist/docs/resources/securemesh_site.md +97 -97
- package/dist/docs/resources/segment.md +4 -4
- package/dist/docs/resources/service_policy.md +44 -44
- package/dist/docs/resources/service_policy_rule.md +37 -37
- package/dist/docs/resources/site.md +241 -613
- package/dist/docs/resources/site_mesh_group.md +8 -8
- package/dist/docs/resources/subnet.md +5 -5
- package/dist/docs/resources/tcp_loadbalancer.md +37 -37
- package/dist/docs/resources/tunnel.md +4 -4
- package/dist/docs/resources/udp_loadbalancer.md +9 -9
- package/dist/docs/resources/user_identification.md +10 -10
- package/dist/docs/resources/virtual_host.md +42 -42
- package/dist/docs/resources/virtual_network.md +4 -4
- package/dist/docs/resources/voltstack_site.md +59 -59
- package/dist/docs/resources/waf_exclusion_policy.md +5 -5
- package/dist/docs/resources/workload.md +9 -2951
- package/dist/metadata/resource-metadata.json +379 -613
- package/dist/metadata/validation-patterns.json +1 -1
- package/dist/tools/auth.js +38 -15
- package/dist/tools/auth.js.map +1 -1
- package/dist/tools/discover.d.ts.map +1 -1
- package/dist/tools/discover.js +36 -0
- package/dist/tools/discover.js.map +1 -1
- package/package.json +1 -1
|
@@ -198,20 +198,20 @@ resource "f5xc_http_loadbalancer" "example" {
|
|
|
198
198
|
|
|
199
199
|
-> **One of the following:**
|
|
200
200
|
• <a id="active-service-policies"></a>[`active_service_policies`](#active-service-policies) - Optional Block<br>Service Policy List. List of service policies<br>See [Active Service Policies](#active-service-policies) below for details.
|
|
201
|
-
<br><br>• <a id="no-service-policies"></a>[`no_service_policies`](#no-service-policies) - Optional Block<br>
|
|
201
|
+
<br><br>• <a id="no-service-policies"></a>[`no_service_policies`](#no-service-policies) - Optional Block<br>Enable this option
|
|
202
202
|
|
|
203
203
|
<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
|
|
204
204
|
|
|
205
205
|
-> **One of the following:**
|
|
206
206
|
• <a id="advertise-custom"></a>[`advertise_custom`](#advertise-custom) - Optional Block<br>Defines a way to advertise a VIP on specific sites<br>See [Advertise Custom](#advertise-custom) below for details.
|
|
207
207
|
<br><br>• <a id="advertise-on-public"></a>[`advertise_on_public`](#advertise-on-public) - Optional Block<br>Defines a way to advertise a load balancer on public. If optional public_ip is provided, it will only be advertised on RE sites where that public_ip is available<br>See [Advertise On Public](#advertise-on-public) below for details.
|
|
208
|
-
<br><br>• <a id="advertise-on-public-default-vip"></a>[`advertise_on_public_default_vip`](#advertise-on-public-default-vip) - Optional Block<br>
|
|
208
|
+
<br><br>• <a id="advertise-on-public-default-vip"></a>[`advertise_on_public_default_vip`](#advertise-on-public-default-vip) - Optional Block<br>Enable this option
|
|
209
209
|
|
|
210
210
|
<a id="api-protection-rules"></a>• [`api_protection_rules`](#api-protection-rules) - Optional Block<br>API Protection Rules. API Protection Rules<br>See [API Protection Rules](#api-protection-rules) below for details.
|
|
211
211
|
|
|
212
212
|
-> **One of the following:**
|
|
213
213
|
• <a id="api-rate-limit"></a>[`api_rate_limit`](#api-rate-limit) - Optional Block<br>APIRateLimit
|
|
214
|
-
<br><br>• <a id="disable-rate-limit"></a>[`disable_rate_limit`](#disable-rate-limit) - Optional Block<br>
|
|
214
|
+
<br><br>• <a id="disable-rate-limit"></a>[`disable_rate_limit`](#disable-rate-limit) - Optional Block<br>Enable this option
|
|
215
215
|
|
|
216
216
|
-> **One of the following:**
|
|
217
217
|
• <a id="api-specification"></a>[`api_specification`](#api-specification) - Optional Block<br>Settings for API specification (API definition, OpenAPI validation, etc.)
|
|
@@ -235,17 +235,17 @@ resource "f5xc_http_loadbalancer" "example" {
|
|
|
235
235
|
• <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
|
|
236
236
|
<br><br>• <a id="enable-challenge"></a>[`enable_challenge`](#enable-challenge) - Optional Block<br>Configure auto mitigation i.e risk based challenges for malicious users
|
|
237
237
|
<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
|
|
238
|
-
<br><br>• <a id="no-challenge"></a>[`no_challenge`](#no-challenge) - Optional Block<br>
|
|
238
|
+
<br><br>• <a id="no-challenge"></a>[`no_challenge`](#no-challenge) - Optional Block<br>Enable this option
|
|
239
239
|
|
|
240
240
|
-> **One of the following:**
|
|
241
241
|
• <a id="client-side-defense"></a>[`client_side_defense`](#client-side-defense) - Optional Block<br>Defines various configuration OPTIONS for Client-Side Defense Policy
|
|
242
242
|
|
|
243
243
|
-> **One of the following:**
|
|
244
244
|
• <a id="cookie-stickiness"></a>[`cookie_stickiness`](#cookie-stickiness) - Optional Block<br>Two types of cookie affinity: 1. Passive. Takes a cookie that's present in the cookies header and hashes on its value. 2. Generated. Generates and sets a cookie with an expiration (TTL) on the first request from the client in its response to the client, based on the endpoint the request gets
|
|
245
|
-
<br><br>• <a id="least-active"></a>[`least_active`](#least-active) - Optional Block<br>
|
|
246
|
-
<br><br>• <a id="random"></a>[`random`](#random) - Optional Block<br>
|
|
245
|
+
<br><br>• <a id="least-active"></a>[`least_active`](#least-active) - Optional Block<br>Enable this option
|
|
246
|
+
<br><br>• <a id="random"></a>[`random`](#random) - Optional Block<br>Enable this option
|
|
247
247
|
<br><br>• <a id="ring-hash"></a>[`ring_hash`](#ring-hash) - Optional Block<br>Hash Policy List. List of hash policy rules
|
|
248
|
-
<br><br>• <a id="round-robin"></a>[`round_robin`](#round-robin) - Optional Block<br>
|
|
248
|
+
<br><br>• <a id="round-robin"></a>[`round_robin`](#round-robin) - Optional Block<br>Enable this option
|
|
249
249
|
|
|
250
250
|
<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
|
|
251
251
|
|
|
@@ -263,39 +263,39 @@ resource "f5xc_http_loadbalancer" "example" {
|
|
|
263
263
|
<a id="default-route-pools"></a>• [`default_route_pools`](#default-route-pools) - Optional Block<br>Origin Pools used when no route is specified (default route)
|
|
264
264
|
|
|
265
265
|
-> **One of the following:**
|
|
266
|
-
• <a id="default-sensitive-data-policy"></a>[`default_sensitive_data_policy`](#default-sensitive-data-policy) - Optional Block<br>
|
|
266
|
+
• <a id="default-sensitive-data-policy"></a>[`default_sensitive_data_policy`](#default-sensitive-data-policy) - Optional Block<br>Enable this option
|
|
267
267
|
|
|
268
|
-
<a id="disable-api-definition"></a>• [`disable_api_definition`](#disable-api-definition) - Optional Block<br>
|
|
268
|
+
<a id="disable-api-definition"></a>• [`disable_api_definition`](#disable-api-definition) - Optional Block<br>Enable this option
|
|
269
269
|
|
|
270
270
|
-> **One of the following:**
|
|
271
|
-
• <a id="disable-api-discovery"></a>[`disable_api_discovery`](#disable-api-discovery) - Optional Block<br>
|
|
271
|
+
• <a id="disable-api-discovery"></a>[`disable_api_discovery`](#disable-api-discovery) - Optional Block<br>Enable this option
|
|
272
272
|
|
|
273
|
-
<a id="disable-api-testing"></a>• [`disable_api_testing`](#disable-api-testing) - Optional Block<br>
|
|
273
|
+
<a id="disable-api-testing"></a>• [`disable_api_testing`](#disable-api-testing) - Optional Block<br>Enable this option
|
|
274
274
|
|
|
275
|
-
<a id="disable-bot-defense"></a>• [`disable_bot_defense`](#disable-bot-defense) - Optional Block<br>
|
|
275
|
+
<a id="disable-bot-defense"></a>• [`disable_bot_defense`](#disable-bot-defense) - Optional Block<br>Enable this option
|
|
276
276
|
|
|
277
|
-
<a id="disable-caching"></a>• [`disable_caching`](#disable-caching) - Optional Block<br>
|
|
277
|
+
<a id="disable-caching"></a>• [`disable_caching`](#disable-caching) - Optional Block<br>Enable this option
|
|
278
278
|
|
|
279
|
-
<a id="disable-client-side-defense"></a>• [`disable_client_side_defense`](#disable-client-side-defense) - Optional Block<br>
|
|
279
|
+
<a id="disable-client-side-defense"></a>• [`disable_client_side_defense`](#disable-client-side-defense) - Optional Block<br>Enable this option
|
|
280
280
|
|
|
281
281
|
-> **One of the following:**
|
|
282
|
-
• <a id="disable-ip-reputation"></a>[`disable_ip_reputation`](#disable-ip-reputation) - Optional Block<br>
|
|
282
|
+
• <a id="disable-ip-reputation"></a>[`disable_ip_reputation`](#disable-ip-reputation) - Optional Block<br>Enable this option
|
|
283
283
|
|
|
284
284
|
-> **One of the following:**
|
|
285
|
-
• <a id="disable-malicious-user-detection"></a>[`disable_malicious_user_detection`](#disable-malicious-user-detection) - Optional Block<br>
|
|
285
|
+
• <a id="disable-malicious-user-detection"></a>[`disable_malicious_user_detection`](#disable-malicious-user-detection) - Optional Block<br>Enable this option
|
|
286
286
|
|
|
287
287
|
-> **One of the following:**
|
|
288
|
-
• <a id="disable-malware-protection"></a>[`disable_malware_protection`](#disable-malware-protection) - Optional Block<br>
|
|
288
|
+
• <a id="disable-malware-protection"></a>[`disable_malware_protection`](#disable-malware-protection) - Optional Block<br>Enable this option
|
|
289
289
|
|
|
290
290
|
-> **One of the following:**
|
|
291
|
-
• <a id="disable-threat-mesh"></a>[`disable_threat_mesh`](#disable-threat-mesh) - Optional Block<br>
|
|
291
|
+
• <a id="disable-threat-mesh"></a>[`disable_threat_mesh`](#disable-threat-mesh) - Optional Block<br>Enable this option
|
|
292
292
|
|
|
293
293
|
-> **One of the following:**
|
|
294
|
-
• <a id="disable-trust-client-ip-headers"></a>[`disable_trust_client_ip_headers`](#disable-trust-client-ip-headers) - Optional Block<br>
|
|
294
|
+
• <a id="disable-trust-client-ip-headers"></a>[`disable_trust_client_ip_headers`](#disable-trust-client-ip-headers) - Optional Block<br>Enable this option
|
|
295
295
|
|
|
296
|
-
<a id="disable-waf"></a>• [`disable_waf`](#disable-waf) - Optional Block<br>
|
|
296
|
+
<a id="disable-waf"></a>• [`disable_waf`](#disable-waf) - Optional Block<br>Enable this option
|
|
297
297
|
|
|
298
|
-
<a id="do-not-advertise"></a>• [`do_not_advertise`](#do-not-advertise) - Optional Block<br>
|
|
298
|
+
<a id="do-not-advertise"></a>• [`do_not_advertise`](#do-not-advertise) - Optional Block<br>Enable this option
|
|
299
299
|
|
|
300
300
|
<a id="domains"></a>• [`domains`](#domains) - Optional List<br>List of Domains (host/authority header) that will be matched to load balancer. Supported Domains and search order: 1. Exact Domain names: `www.example.com.` 2
|
|
301
301
|
|
|
@@ -303,9 +303,9 @@ resource "f5xc_http_loadbalancer" "example" {
|
|
|
303
303
|
|
|
304
304
|
<a id="enable-ip-reputation"></a>• [`enable_ip_reputation`](#enable-ip-reputation) - Optional Block<br>IP Threat Category List. List of IP threat categories
|
|
305
305
|
|
|
306
|
-
<a id="enable-malicious-user-detection"></a>• [`enable_malicious_user_detection`](#enable-malicious-user-detection) - Optional Block<br>
|
|
306
|
+
<a id="enable-malicious-user-detection"></a>• [`enable_malicious_user_detection`](#enable-malicious-user-detection) - Optional Block<br>Enable this option
|
|
307
307
|
|
|
308
|
-
<a id="enable-threat-mesh"></a>• [`enable_threat_mesh`](#enable-threat-mesh) - Optional Block<br>
|
|
308
|
+
<a id="enable-threat-mesh"></a>• [`enable_threat_mesh`](#enable-threat-mesh) - Optional Block<br>Enable this option
|
|
309
309
|
|
|
310
310
|
<a id="enable-trust-client-ip-headers"></a>• [`enable_trust_client_ip_headers`](#enable-trust-client-ip-headers) - Optional Block<br>Trust Client IP Headers List. List of Client IP Headers
|
|
311
311
|
|
|
@@ -320,8 +320,8 @@ resource "f5xc_http_loadbalancer" "example" {
|
|
|
320
320
|
<a id="jwt-validation"></a>• [`jwt_validation`](#jwt-validation) - Optional Block<br>JWT Validation stops JWT replay attacks and JWT tampering by cryptographically verifying incoming JWTs before they are passed to your API origin. JWT Validation will also stop requests with expired tokens or tokens that are not yet valid
|
|
321
321
|
|
|
322
322
|
-> **One of the following:**
|
|
323
|
-
• <a id="l7-ddos-action-block"></a>[`l7_ddos_action_block`](#l7-ddos-action-block) - Optional Block<br>
|
|
324
|
-
<br><br>• <a id="l7-ddos-action-default"></a>[`l7_ddos_action_default`](#l7-ddos-action-default) - Optional Block<br>
|
|
323
|
+
• <a id="l7-ddos-action-block"></a>[`l7_ddos_action_block`](#l7-ddos-action-block) - Optional Block<br>Enable this option
|
|
324
|
+
<br><br>• <a id="l7-ddos-action-default"></a>[`l7_ddos_action_default`](#l7-ddos-action-default) - Optional Block<br>Enable this option
|
|
325
325
|
|
|
326
326
|
<a id="l7-ddos-action-js-challenge"></a>• [`l7_ddos_action_js_challenge`](#l7-ddos-action-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
|
|
327
327
|
|
|
@@ -332,7 +332,7 @@ resource "f5xc_http_loadbalancer" "example" {
|
|
|
332
332
|
<a id="more-option"></a>• [`more_option`](#more-option) - Optional Block<br>Defines various OPTIONS to define a route
|
|
333
333
|
|
|
334
334
|
-> **One of the following:**
|
|
335
|
-
• <a id="multi-lb-app"></a>[`multi_lb_app`](#multi-lb-app) - Optional Block<br>
|
|
335
|
+
• <a id="multi-lb-app"></a>[`multi_lb_app`](#multi-lb-app) - Optional Block<br>Enable this option
|
|
336
336
|
<br><br>• <a id="single-lb-app"></a>[`single_lb_app`](#single-lb-app) - Optional Block<br>Specific settings for Machine learning analysis on this HTTP LB, independently from other LBs
|
|
337
337
|
|
|
338
338
|
<a id="origin-server-subset-rule-list"></a>• [`origin_server_subset_rule_list`](#origin-server-subset-rule-list) - Optional Block<br>Origin Server Subset Rule List Type. List of Origin Pools
|
|
@@ -349,21 +349,21 @@ resource "f5xc_http_loadbalancer" "example" {
|
|
|
349
349
|
|
|
350
350
|
<a id="sensitive-data-policy"></a>• [`sensitive_data_policy`](#sensitive-data-policy) - Optional Block<br>Sensitive Data Discovery. Settings for data type policy
|
|
351
351
|
|
|
352
|
-
<a id="service-policies-from-namespace"></a>• [`service_policies_from_namespace`](#service-policies-from-namespace) - Optional Block<br>
|
|
352
|
+
<a id="service-policies-from-namespace"></a>• [`service_policies_from_namespace`](#service-policies-from-namespace) - Optional Block<br>Enable this option
|
|
353
353
|
|
|
354
354
|
-> **One of the following:**
|
|
355
355
|
• <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
|
|
356
356
|
|
|
357
|
-
<a id="source-ip-stickiness"></a>• [`source_ip_stickiness`](#source-ip-stickiness) - Optional Block<br>
|
|
357
|
+
<a id="source-ip-stickiness"></a>• [`source_ip_stickiness`](#source-ip-stickiness) - Optional Block<br>Enable this option
|
|
358
358
|
|
|
359
|
-
<a id="system-default-timeouts"></a>• [`system_default_timeouts`](#system-default-timeouts) - Optional Block<br>
|
|
359
|
+
<a id="system-default-timeouts"></a>• [`system_default_timeouts`](#system-default-timeouts) - Optional Block<br>Enable this option
|
|
360
360
|
|
|
361
361
|
<a id="timeouts"></a>• [`timeouts`](#timeouts) - Optional Block
|
|
362
362
|
|
|
363
363
|
<a id="trusted-clients"></a>• [`trusted_clients`](#trusted-clients) - Optional Block<br>Define rules to skip processing of one or more features such as WAF, Bot Defense etc
|
|
364
364
|
|
|
365
365
|
-> **One of the following:**
|
|
366
|
-
• <a id="user-id-client-ip"></a>[`user_id_client_ip`](#user-id-client-ip) - Optional Block<br>
|
|
366
|
+
• <a id="user-id-client-ip"></a>[`user_id_client_ip`](#user-id-client-ip) - Optional Block<br>Enable this option
|
|
367
367
|
<br><br>• <a id="user-identification"></a>[`user_identification`](#user-identification) - Optional Block<br>Type establishes a direct reference from one object(the referrer) to another(the referred). Such a reference is in form of tenant/namespace/name
|
|
368
368
|
|
|
369
369
|
<a id="waf-exclusion"></a>• [`waf_exclusion`](#waf-exclusion) - Optional Block<br>WAF Exclusion
|
|
@@ -410,7 +410,7 @@ An [`advertise_where`](#advertise-custom-advertise-where) block (within [`advert
|
|
|
410
410
|
|
|
411
411
|
<a id="advertise-custom-advertise-where-site"></a>• [`site`](#advertise-custom-advertise-where-site) - Optional Block<br>Defines a reference to a CE site along with network type and an optional IP address where a load balancer could be advertised<br>See [Site](#advertise-custom-advertise-where-site) below.
|
|
412
412
|
|
|
413
|
-
<a id="port-b19c4f"></a>• [`use_default_port`](#port-b19c4f) - Optional Block<br>
|
|
413
|
+
<a id="port-b19c4f"></a>• [`use_default_port`](#port-b19c4f) - Optional Block<br>Enable this option
|
|
414
414
|
|
|
415
415
|
<a id="network-a20be3"></a>• [`virtual_network`](#network-a20be3) - Optional Block<br>Parameters to advertise on a given virtual network<br>See [Virtual Network](#network-a20be3) below.
|
|
416
416
|
|
|
@@ -454,9 +454,9 @@ A [`site`](#site-7ecf1d) block (within [`advertise_custom.advertise_where.site`]
|
|
|
454
454
|
|
|
455
455
|
A [`virtual_network`](#network-a20be3) block (within [`advertise_custom.advertise_where`](#advertise-custom-advertise-where)) supports the following:
|
|
456
456
|
|
|
457
|
-
<a id="vip-26d874"></a>• [`default_v6_vip`](#vip-26d874) - Optional Block<br>
|
|
457
|
+
<a id="vip-26d874"></a>• [`default_v6_vip`](#vip-26d874) - Optional Block<br>Enable this option
|
|
458
458
|
|
|
459
|
-
<a id="vip-c51931"></a>• [`default_vip`](#vip-c51931) - Optional Block<br>
|
|
459
|
+
<a id="vip-c51931"></a>• [`default_vip`](#vip-c51931) - Optional Block<br>Enable this option
|
|
460
460
|
|
|
461
461
|
<a id="vip-bb67d7"></a>• [`specific_v6_vip`](#vip-bb67d7) - Optional String<br>Use given IPv6 address as VIP on virtual Network
|
|
462
462
|
|
|
@@ -540,7 +540,7 @@ An [`api_endpoint_rules`](#api-protection-rules-api-endpoint-rules) block (withi
|
|
|
540
540
|
|
|
541
541
|
<a id="action-389797"></a>• [`action`](#action-389797) - Optional Block<br>The action to take if the input request matches the rule<br>See [Action](#action-389797) below.
|
|
542
542
|
|
|
543
|
-
<a id="domain-c69c3a"></a>• [`any_domain`](#domain-c69c3a) - Optional Block<br>
|
|
543
|
+
<a id="domain-c69c3a"></a>• [`any_domain`](#domain-c69c3a) - Optional Block<br>Enable this option
|
|
544
544
|
|
|
545
545
|
<a id="method-361974"></a>• [`api_endpoint_method`](#method-361974) - Optional Block<br>HTTP method matcher specifies a list of methods to match an input HTTP method. The match is considered successful if the input method is a member of the list. The result of the match based on the method list is inverted if invert_matcher is true<br>See [API Endpoint Method](#method-361974) below.
|
|
546
546
|
|
|
@@ -558,9 +558,9 @@ An [`api_endpoint_rules`](#api-protection-rules-api-endpoint-rules) block (withi
|
|
|
558
558
|
|
|
559
559
|
An [`action`](#action-389797) block (within [`api_protection_rules.api_endpoint_rules`](#api-protection-rules-api-endpoint-rules)) supports the following:
|
|
560
560
|
|
|
561
|
-
<a id="allow-9ca9d1"></a>• [`allow`](#allow-9ca9d1) - Optional Block<br>
|
|
561
|
+
<a id="allow-9ca9d1"></a>• [`allow`](#allow-9ca9d1) - Optional Block<br>Enable this option
|
|
562
562
|
|
|
563
|
-
<a id="deny-ec80de"></a>• [`deny`](#deny-ec80de) - Optional Block<br>
|
|
563
|
+
<a id="deny-ec80de"></a>• [`deny`](#deny-ec80de) - Optional Block<br>Enable this option
|
|
564
564
|
|
|
565
565
|
#### API Protection Rules API Endpoint Rules API Endpoint Method
|
|
566
566
|
|
|
@@ -656,7 +656,7 @@ An [`api_groups_rules`](#api-protection-rules-api-groups-rules) block (within [`
|
|
|
656
656
|
|
|
657
657
|
<a id="action-fa62d7"></a>• [`action`](#action-fa62d7) - Optional Block<br>The action to take if the input request matches the rule<br>See [Action](#action-fa62d7) below.
|
|
658
658
|
|
|
659
|
-
<a id="domain-b1276e"></a>• [`any_domain`](#domain-b1276e) - Optional Block<br>
|
|
659
|
+
<a id="domain-b1276e"></a>• [`any_domain`](#domain-b1276e) - Optional Block<br>Enable this option
|
|
660
660
|
|
|
661
661
|
<a id="group-a8b675"></a>• [`api_group`](#group-a8b675) - Optional String<br>API groups derived from API Definition swaggers. For example oas-all-operations including all paths and methods from the swaggers, oas-base-URLs covering all requests under base-paths from the swaggers. Custom groups can be created if user tags paths or operations with 'x-F5 Distributed
|
|
662
662
|
|
|
@@ -674,9 +674,9 @@ An [`api_groups_rules`](#api-protection-rules-api-groups-rules) block (within [`
|
|
|
674
674
|
|
|
675
675
|
An [`action`](#action-fa62d7) block (within [`api_protection_rules.api_groups_rules`](#api-protection-rules-api-groups-rules)) supports the following:
|
|
676
676
|
|
|
677
|
-
<a id="allow-eba8d3"></a>• [`allow`](#allow-eba8d3) - Optional Block<br>
|
|
677
|
+
<a id="allow-eba8d3"></a>• [`allow`](#allow-eba8d3) - Optional Block<br>Enable this option
|
|
678
678
|
|
|
679
|
-
<a id="deny-99c219"></a>• [`deny`](#deny-99c219) - Optional Block<br>
|
|
679
|
+
<a id="deny-99c219"></a>• [`deny`](#deny-99c219) - Optional Block<br>Enable this option
|
|
680
680
|
|
|
681
681
|
#### API Protection Rules API Groups Rules Client Matcher
|
|
682
682
|
|
|
@@ -774,7 +774,7 @@ An [`api_rate_limit`](#api-rate-limit) block supports the following:
|
|
|
774
774
|
|
|
775
775
|
<a id="api-rate-limit-ip-allowed-list"></a>• [`ip_allowed_list`](#api-rate-limit-ip-allowed-list) - Optional Block<br>List of IPv4 prefixes that represent an endpoint<br>See [IP Allowed List](#api-rate-limit-ip-allowed-list) below.
|
|
776
776
|
|
|
777
|
-
<a id="api-rate-limit-no-ip-allowed-list"></a>• [`no_ip_allowed_list`](#api-rate-limit-no-ip-allowed-list) - Optional Block<br>
|
|
777
|
+
<a id="api-rate-limit-no-ip-allowed-list"></a>• [`no_ip_allowed_list`](#api-rate-limit-no-ip-allowed-list) - Optional Block<br>Enable this option
|
|
778
778
|
|
|
779
779
|
<a id="api-rate-limit-server-url-rules"></a>• [`server_url_rules`](#api-rate-limit-server-url-rules) - Optional Block<br>Set of rules for entire domain or base path that contain multiple endpoints. Order is matter as it uses first match policy. For matching also specific endpoints you can use the API endpoint rules set bellow<br>See [Server URL Rules](#api-rate-limit-server-url-rules) below.
|
|
780
780
|
|
|
@@ -782,7 +782,7 @@ An [`api_rate_limit`](#api-rate-limit) block supports the following:
|
|
|
782
782
|
|
|
783
783
|
An [`api_endpoint_rules`](#api-rate-limit-api-endpoint-rules) block (within [`api_rate_limit`](#api-rate-limit)) supports the following:
|
|
784
784
|
|
|
785
|
-
<a id="domain-cf087c"></a>• [`any_domain`](#domain-cf087c) - Optional Block<br>
|
|
785
|
+
<a id="domain-cf087c"></a>• [`any_domain`](#domain-cf087c) - Optional Block<br>Enable this option
|
|
786
786
|
|
|
787
787
|
<a id="method-1e49b0"></a>• [`api_endpoint_method`](#method-1e49b0) - Optional Block<br>HTTP method matcher specifies a list of methods to match an input HTTP method. The match is considered successful if the input method is a member of the list. The result of the match based on the method list is inverted if invert_matcher is true<br>See [API Endpoint Method](#method-1e49b0) below.
|
|
788
788
|
|
|
@@ -1004,7 +1004,7 @@ An [`ip_allowed_list`](#api-rate-limit-ip-allowed-list) block (within [`api_rate
|
|
|
1004
1004
|
|
|
1005
1005
|
A [`server_url_rules`](#api-rate-limit-server-url-rules) block (within [`api_rate_limit`](#api-rate-limit)) supports the following:
|
|
1006
1006
|
|
|
1007
|
-
<a id="domain-0747c9"></a>• [`any_domain`](#domain-0747c9) - Optional Block<br>
|
|
1007
|
+
<a id="domain-0747c9"></a>• [`any_domain`](#domain-0747c9) - Optional Block<br>Enable this option
|
|
1008
1008
|
|
|
1009
1009
|
<a id="group-15c11a"></a>• [`api_group`](#group-15c11a) - Optional String<br>API groups derived from API Definition swaggers. For example oas-all-operations including all paths and methods from the swaggers, oas-base-URLs covering all requests under base-paths from the swaggers. Custom groups can be created if user tags paths or operations with 'x-F5 Distributed
|
|
1010
1010
|
|
|
@@ -1118,7 +1118,7 @@ An [`api_specification`](#api-specification) block supports the following:
|
|
|
1118
1118
|
|
|
1119
1119
|
<a id="list-23b577"></a>• [`validation_custom_list`](#list-23b577) - Optional Block<br>Define API groups, base paths, or API endpoints and their OpenAPI validation modes. Any other API-endpoint not listed will act according to 'Fall Through Mode'<br>See [Validation Custom List](#list-23b577) below.
|
|
1120
1120
|
|
|
1121
|
-
<a id="api-specification-validation-disabled"></a>• [`validation_disabled`](#api-specification-validation-disabled) - Optional Block<br>
|
|
1121
|
+
<a id="api-specification-validation-disabled"></a>• [`validation_disabled`](#api-specification-validation-disabled) - Optional Block<br>Enable this option
|
|
1122
1122
|
|
|
1123
1123
|
#### API Specification API Definition
|
|
1124
1124
|
|
|
@@ -1164,13 +1164,13 @@ A [`validation_all_spec_endpoints`](#endpoints-4158a4) block (within [`api_speci
|
|
|
1164
1164
|
|
|
1165
1165
|
A [`settings`](#settings-a83a93) block (within [`api_specification.validation_all_spec_endpoints`](#endpoints-4158a4)) supports the following:
|
|
1166
1166
|
|
|
1167
|
-
<a id="validation-462f95"></a>• [`oversized_body_fail_validation`](#validation-462f95) - Optional Block<br>
|
|
1167
|
+
<a id="validation-462f95"></a>• [`oversized_body_fail_validation`](#validation-462f95) - Optional Block<br>Enable this option
|
|
1168
1168
|
|
|
1169
|
-
<a id="validation-7ffaab"></a>• [`oversized_body_skip_validation`](#validation-7ffaab) - Optional Block<br>
|
|
1169
|
+
<a id="validation-7ffaab"></a>• [`oversized_body_skip_validation`](#validation-7ffaab) - Optional Block<br>Enable this option
|
|
1170
1170
|
|
|
1171
1171
|
<a id="custom-8254df"></a>• [`property_validation_settings_custom`](#custom-8254df) - Optional Block<br>Validation Property Settings. Custom property validation settings<br>See [Property Validation Settings Custom](#custom-8254df) below.
|
|
1172
1172
|
|
|
1173
|
-
<a id="default-f746bd"></a>• [`property_validation_settings_default`](#default-f746bd) - Optional Block<br>
|
|
1173
|
+
<a id="default-f746bd"></a>• [`property_validation_settings_default`](#default-f746bd) - Optional Block<br>Enable this option
|
|
1174
1174
|
|
|
1175
1175
|
#### API Specification Validation All Spec Endpoints Settings Property Validation Settings Custom
|
|
1176
1176
|
|
|
@@ -1250,13 +1250,13 @@ A [`validation_custom_list`](#list-23b577) block (within [`api_specification`](#
|
|
|
1250
1250
|
|
|
1251
1251
|
A [`settings`](#settings-940e64) block (within [`api_specification.validation_custom_list`](#list-23b577)) supports the following:
|
|
1252
1252
|
|
|
1253
|
-
<a id="validation-cfaf7f"></a>• [`oversized_body_fail_validation`](#validation-cfaf7f) - Optional Block<br>
|
|
1253
|
+
<a id="validation-cfaf7f"></a>• [`oversized_body_fail_validation`](#validation-cfaf7f) - Optional Block<br>Enable this option
|
|
1254
1254
|
|
|
1255
|
-
<a id="validation-0639fa"></a>• [`oversized_body_skip_validation`](#validation-0639fa) - Optional Block<br>
|
|
1255
|
+
<a id="validation-0639fa"></a>• [`oversized_body_skip_validation`](#validation-0639fa) - Optional Block<br>Enable this option
|
|
1256
1256
|
|
|
1257
1257
|
<a id="custom-8e6ea6"></a>• [`property_validation_settings_custom`](#custom-8e6ea6) - Optional Block<br>Validation Property Settings. Custom property validation settings<br>See [Property Validation Settings Custom](#custom-8e6ea6) below.
|
|
1258
1258
|
|
|
1259
|
-
<a id="default-baec50"></a>• [`property_validation_settings_default`](#default-baec50) - Optional Block<br>
|
|
1259
|
+
<a id="default-baec50"></a>• [`property_validation_settings_default`](#default-baec50) - Optional Block<br>Enable this option
|
|
1260
1260
|
|
|
1261
1261
|
#### API Specification Validation Custom List Settings Property Validation Settings Custom
|
|
1262
1262
|
|
|
@@ -1274,11 +1274,11 @@ An [`api_testing`](#api-testing) block supports the following:
|
|
|
1274
1274
|
|
|
1275
1275
|
<a id="api-testing-domains"></a>• [`domains`](#api-testing-domains) - Optional Block<br>Add and configure testing domains and credentials<br>See [Domains](#api-testing-domains) below.
|
|
1276
1276
|
|
|
1277
|
-
<a id="api-testing-every-day"></a>• [`every_day`](#api-testing-every-day) - Optional Block<br>
|
|
1277
|
+
<a id="api-testing-every-day"></a>• [`every_day`](#api-testing-every-day) - Optional Block<br>Enable this option
|
|
1278
1278
|
|
|
1279
|
-
<a id="api-testing-every-month"></a>• [`every_month`](#api-testing-every-month) - Optional Block<br>
|
|
1279
|
+
<a id="api-testing-every-month"></a>• [`every_month`](#api-testing-every-month) - Optional Block<br>Enable this option
|
|
1280
1280
|
|
|
1281
|
-
<a id="api-testing-every-week"></a>• [`every_week`](#api-testing-every-week) - Optional Block<br>
|
|
1281
|
+
<a id="api-testing-every-week"></a>• [`every_week`](#api-testing-every-week) - Optional Block<br>Enable this option
|
|
1282
1282
|
|
|
1283
1283
|
#### API Testing Domains
|
|
1284
1284
|
|
|
@@ -1294,7 +1294,7 @@ A [`domains`](#api-testing-domains) block (within [`api_testing`](#api-testing))
|
|
|
1294
1294
|
|
|
1295
1295
|
A [`credentials`](#api-testing-domains-credentials) block (within [`api_testing.domains`](#api-testing-domains)) supports the following:
|
|
1296
1296
|
|
|
1297
|
-
<a id="api-testing-domains-credentials-admin"></a>• [`admin`](#api-testing-domains-credentials-admin) - Optional Block<br>
|
|
1297
|
+
<a id="api-testing-domains-credentials-admin"></a>• [`admin`](#api-testing-domains-credentials-admin) - Optional Block<br>Enable this option
|
|
1298
1298
|
|
|
1299
1299
|
<a id="api-testing-domains-credentials-api-key"></a>• [`api_key`](#api-testing-domains-credentials-api-key) - Optional Block<br>API Key<br>See [API Key](#api-testing-domains-credentials-api-key) below.
|
|
1300
1300
|
|
|
@@ -1306,7 +1306,7 @@ A [`credentials`](#api-testing-domains-credentials) block (within [`api_testing.
|
|
|
1306
1306
|
|
|
1307
1307
|
<a id="endpoint-08dc4d"></a>• [`login_endpoint`](#endpoint-08dc4d) - Optional Block<br>Login Endpoint<br>See [Login Endpoint](#endpoint-08dc4d) below.
|
|
1308
1308
|
|
|
1309
|
-
<a id="standard-8b74a1"></a>• [`standard`](#standard-8b74a1) - Optional Block<br>
|
|
1309
|
+
<a id="standard-8b74a1"></a>• [`standard`](#standard-8b74a1) - Optional Block<br>Enable this option
|
|
1310
1310
|
|
|
1311
1311
|
#### API Testing Domains Credentials API Key
|
|
1312
1312
|
|
|
@@ -1420,7 +1420,7 @@ A [`blocked_clients`](#blocked-clients) block supports the following:
|
|
|
1420
1420
|
|
|
1421
1421
|
<a id="blocked-clients-as-number"></a>• [`as_number`](#blocked-clients-as-number) - Optional Number<br>RFC 6793 defined 4-byte AS number
|
|
1422
1422
|
|
|
1423
|
-
<a id="blocked-clients-bot-skip-processing"></a>• [`bot_skip_processing`](#blocked-clients-bot-skip-processing) - Optional Block<br>
|
|
1423
|
+
<a id="blocked-clients-bot-skip-processing"></a>• [`bot_skip_processing`](#blocked-clients-bot-skip-processing) - Optional Block<br>Enable this option
|
|
1424
1424
|
|
|
1425
1425
|
<a id="blocked-clients-expiration-timestamp"></a>• [`expiration_timestamp`](#blocked-clients-expiration-timestamp) - Optional String<br>Specifies expiration_timestamp the RFC 3339 format timestamp at which the containing rule is considered to be logically expired. The rule continues to exist in the configuration but is not applied anymore
|
|
1426
1426
|
|
|
@@ -1432,11 +1432,11 @@ A [`blocked_clients`](#blocked-clients) block supports the following:
|
|
|
1432
1432
|
|
|
1433
1433
|
<a id="blocked-clients-metadata"></a>• [`metadata`](#blocked-clients-metadata) - Optional Block<br>MessageMetaType is metadata (common attributes) of a message that only certain messages have. This information is propagated to the metadata of a child object that gets created from the containing message during view processing. The information in this type can be specified by user during create<br>See [Metadata](#blocked-clients-metadata) below.
|
|
1434
1434
|
|
|
1435
|
-
<a id="blocked-clients-skip-processing"></a>• [`skip_processing`](#blocked-clients-skip-processing) - Optional Block<br>
|
|
1435
|
+
<a id="blocked-clients-skip-processing"></a>• [`skip_processing`](#blocked-clients-skip-processing) - Optional Block<br>Enable this option
|
|
1436
1436
|
|
|
1437
1437
|
<a id="blocked-clients-user-identifier"></a>• [`user_identifier`](#blocked-clients-user-identifier) - Optional String<br>Identify user based on user identifier. User identifier value needs to be copied from security event
|
|
1438
1438
|
|
|
1439
|
-
<a id="blocked-clients-waf-skip-processing"></a>• [`waf_skip_processing`](#blocked-clients-waf-skip-processing) - Optional Block<br>
|
|
1439
|
+
<a id="blocked-clients-waf-skip-processing"></a>• [`waf_skip_processing`](#blocked-clients-waf-skip-processing) - Optional Block<br>Enable this option
|
|
1440
1440
|
|
|
1441
1441
|
#### Blocked Clients HTTP Header
|
|
1442
1442
|
|
|
@@ -1470,9 +1470,9 @@ A [`metadata`](#blocked-clients-metadata) block (within [`blocked_clients`](#blo
|
|
|
1470
1470
|
|
|
1471
1471
|
A [`bot_defense`](#bot-defense) block supports the following:
|
|
1472
1472
|
|
|
1473
|
-
<a id="bot-defense-disable-cors-support"></a>• [`disable_cors_support`](#bot-defense-disable-cors-support) - Optional Block<br>
|
|
1473
|
+
<a id="bot-defense-disable-cors-support"></a>• [`disable_cors_support`](#bot-defense-disable-cors-support) - Optional Block<br>Enable this option
|
|
1474
1474
|
|
|
1475
|
-
<a id="bot-defense-enable-cors-support"></a>• [`enable_cors_support`](#bot-defense-enable-cors-support) - Optional Block<br>
|
|
1475
|
+
<a id="bot-defense-enable-cors-support"></a>• [`enable_cors_support`](#bot-defense-enable-cors-support) - Optional Block<br>Enable this option
|
|
1476
1476
|
|
|
1477
1477
|
<a id="bot-defense-policy"></a>• [`policy`](#bot-defense-policy) - Optional Block<br>Defines various configuration OPTIONS for Bot Defense policy<br>See [Policy](#bot-defense-policy) below.
|
|
1478
1478
|
|
|
@@ -1484,9 +1484,9 @@ A [`bot_defense`](#bot-defense) block supports the following:
|
|
|
1484
1484
|
|
|
1485
1485
|
A [`policy`](#bot-defense-policy) block (within [`bot_defense`](#bot-defense)) supports the following:
|
|
1486
1486
|
|
|
1487
|
-
<a id="bot-defense-policy-disable-js-insert"></a>• [`disable_js_insert`](#bot-defense-policy-disable-js-insert) - Optional Block<br>
|
|
1487
|
+
<a id="bot-defense-policy-disable-js-insert"></a>• [`disable_js_insert`](#bot-defense-policy-disable-js-insert) - Optional Block<br>Enable this option
|
|
1488
1488
|
|
|
1489
|
-
<a id="bot-defense-policy-disable-mobile-sdk"></a>• [`disable_mobile_sdk`](#bot-defense-policy-disable-mobile-sdk) - Optional Block<br>
|
|
1489
|
+
<a id="bot-defense-policy-disable-mobile-sdk"></a>• [`disable_mobile_sdk`](#bot-defense-policy-disable-mobile-sdk) - Optional Block<br>Enable this option
|
|
1490
1490
|
|
|
1491
1491
|
<a id="bot-defense-policy-javascript-mode"></a>• [`javascript_mode`](#bot-defense-policy-javascript-mode) - Optional String Defaults to `ASYNC_JS_NO_CACHING`<br>Possible values are `ASYNC_JS_NO_CACHING`, `ASYNC_JS_CACHING`, `SYNC_JS_NO_CACHING`, `SYNC_JS_CACHING`<br>[Enum: ASYNC_JS_NO_CACHING|ASYNC_JS_CACHING|SYNC_JS_NO_CACHING|SYNC_JS_CACHING] Web Client JavaScript Mode. Bot Defense JavaScript for telemetry collection is requested asynchronously, and it is non-cacheable Bot Defense JavaScript for telemetry collection is requested asynchronously, and it is cacheable Bot Defense JavaScript for telemetry collection is requested
|
|
1492
1492
|
|
|
@@ -1556,7 +1556,7 @@ A [`js_insertion_rules`](#bot-defense-policy-js-insertion-rules) block (within [
|
|
|
1556
1556
|
|
|
1557
1557
|
A [`rules`](#rules-15d983) block (within [`bot_defense.policy.js_insertion_rules`](#bot-defense-policy-js-insertion-rules)) supports the following:
|
|
1558
1558
|
|
|
1559
|
-
<a id="domain-f27f00"></a>• [`any_domain`](#domain-f27f00) - Optional Block<br>
|
|
1559
|
+
<a id="domain-f27f00"></a>• [`any_domain`](#domain-f27f00) - Optional Block<br>Enable this option
|
|
1560
1560
|
|
|
1561
1561
|
<a id="domain-834b0f"></a>• [`domain`](#domain-834b0f) - Optional Block<br>Domains. Domains names<br>See [Domain](#domain-834b0f) below.
|
|
1562
1562
|
|
|
@@ -1600,9 +1600,9 @@ A [`mobile_sdk_config`](#bot-defense-policy-mobile-sdk-config) block (within [`b
|
|
|
1600
1600
|
|
|
1601
1601
|
A [`protected_app_endpoints`](#endpoints-01a2f3) block (within [`bot_defense.policy`](#bot-defense-policy)) supports the following:
|
|
1602
1602
|
|
|
1603
|
-
<a id="bots-cfdb6f"></a>• [`allow_good_bots`](#bots-cfdb6f) - Optional Block<br>
|
|
1603
|
+
<a id="bots-cfdb6f"></a>• [`allow_good_bots`](#bots-cfdb6f) - Optional Block<br>Enable this option
|
|
1604
1604
|
|
|
1605
|
-
<a id="domain-f4f253"></a>• [`any_domain`](#domain-f4f253) - Optional Block<br>
|
|
1605
|
+
<a id="domain-f4f253"></a>• [`any_domain`](#domain-f4f253) - Optional Block<br>Enable this option
|
|
1606
1606
|
|
|
1607
1607
|
<a id="domain-18bf1a"></a>• [`domain`](#domain-18bf1a) - Optional Block<br>Domains. Domains names<br>See [Domain](#domain-18bf1a) below.
|
|
1608
1608
|
|
|
@@ -1614,11 +1614,11 @@ A [`protected_app_endpoints`](#endpoints-01a2f3) block (within [`bot_defense.pol
|
|
|
1614
1614
|
|
|
1615
1615
|
<a id="metadata-c93137"></a>• [`metadata`](#metadata-c93137) - Optional Block<br>MessageMetaType is metadata (common attributes) of a message that only certain messages have. This information is propagated to the metadata of a child object that gets created from the containing message during view processing. The information in this type can be specified by user during create<br>See [Metadata](#metadata-c93137) below.
|
|
1616
1616
|
|
|
1617
|
-
<a id="bots-5c9c05"></a>• [`mitigate_good_bots`](#bots-5c9c05) - Optional Block<br>
|
|
1617
|
+
<a id="bots-5c9c05"></a>• [`mitigate_good_bots`](#bots-5c9c05) - Optional Block<br>Enable this option
|
|
1618
1618
|
|
|
1619
1619
|
<a id="mitigation-cc96eb"></a>• [`mitigation`](#mitigation-cc96eb) - Optional Block<br>Modify Bot Defense behavior for a matching request<br>See [Mitigation](#mitigation-cc96eb) below.
|
|
1620
1620
|
|
|
1621
|
-
<a id="mobile-2839a0"></a>• [`mobile`](#mobile-2839a0) - Optional Block<br>
|
|
1621
|
+
<a id="mobile-2839a0"></a>• [`mobile`](#mobile-2839a0) - Optional Block<br>Enable this option
|
|
1622
1622
|
|
|
1623
1623
|
<a id="path-d5ee15"></a>• [`path`](#path-d5ee15) - Optional Block<br>Path match of the URI can be either be, Prefix match or exact match or regular expression match<br>See [Path](#path-d5ee15) below.
|
|
1624
1624
|
|
|
@@ -1626,9 +1626,9 @@ A [`protected_app_endpoints`](#endpoints-01a2f3) block (within [`bot_defense.pol
|
|
|
1626
1626
|
|
|
1627
1627
|
<a id="params-8f5791"></a>• [`query_params`](#params-8f5791) - Optional Block<br>List of predicates for all query parameters that need to be matched. The criteria for matching each query parameter are described in individual instances of QueryParameterMatcherType. The actual query parameter values are extracted from the request API as a list of strings for each query<br>See [Query Params](#params-8f5791) below.
|
|
1628
1628
|
|
|
1629
|
-
<a id="label-a84f6e"></a>• [`undefined_flow_label`](#label-a84f6e) - Optional Block<br>
|
|
1629
|
+
<a id="label-a84f6e"></a>• [`undefined_flow_label`](#label-a84f6e) - Optional Block<br>Enable this option
|
|
1630
1630
|
|
|
1631
|
-
<a id="web-a33d3d"></a>• [`web`](#web-a33d3d) - Optional Block<br>
|
|
1631
|
+
<a id="web-a33d3d"></a>• [`web`](#web-a33d3d) - Optional Block<br>Enable this option
|
|
1632
1632
|
|
|
1633
1633
|
<a id="mobile-0ffdfb"></a>• [`web_mobile`](#mobile-0ffdfb) - Optional Block<br>Web and Mobile traffic type. Web and Mobile traffic type<br>See [Web Mobile](#mobile-0ffdfb) below.
|
|
1634
1634
|
|
|
@@ -1694,9 +1694,9 @@ A [`domain`](#domain-18bf1a) block (within [`bot_defense.policy.protected_app_en
|
|
|
1694
1694
|
|
|
1695
1695
|
A [`headers`](#headers-986193) block (within [`bot_defense.policy.protected_app_endpoints`](#endpoints-01a2f3)) supports the following:
|
|
1696
1696
|
|
|
1697
|
-
<a id="present-2e9857"></a>• [`check_not_present`](#present-2e9857) - Optional Block<br>
|
|
1697
|
+
<a id="present-2e9857"></a>• [`check_not_present`](#present-2e9857) - Optional Block<br>Enable this option
|
|
1698
1698
|
|
|
1699
|
-
<a id="present-3a1075"></a>• [`check_present`](#present-3a1075) - Optional Block<br>
|
|
1699
|
+
<a id="present-3a1075"></a>• [`check_present`](#present-3a1075) - Optional Block<br>Enable this option
|
|
1700
1700
|
|
|
1701
1701
|
<a id="matcher-66fb69"></a>• [`invert_matcher`](#matcher-66fb69) - Optional Bool<br>Invert Header Matcher. Invert the match result
|
|
1702
1702
|
|
|
@@ -1768,9 +1768,9 @@ A [`path`](#path-d5ee15) block (within [`bot_defense.policy.protected_app_endpoi
|
|
|
1768
1768
|
|
|
1769
1769
|
A [`bot_defense_advanced`](#bot-defense-advanced) block supports the following:
|
|
1770
1770
|
|
|
1771
|
-
<a id="bot-defense-advanced-disable-js-insert"></a>• [`disable_js_insert`](#bot-defense-advanced-disable-js-insert) - Optional Block<br>
|
|
1771
|
+
<a id="bot-defense-advanced-disable-js-insert"></a>• [`disable_js_insert`](#bot-defense-advanced-disable-js-insert) - Optional Block<br>Enable this option
|
|
1772
1772
|
|
|
1773
|
-
<a id="bot-defense-advanced-disable-mobile-sdk"></a>• [`disable_mobile_sdk`](#bot-defense-advanced-disable-mobile-sdk) - Optional Block<br>
|
|
1773
|
+
<a id="bot-defense-advanced-disable-mobile-sdk"></a>• [`disable_mobile_sdk`](#bot-defense-advanced-disable-mobile-sdk) - Optional Block<br>Enable this option
|
|
1774
1774
|
|
|
1775
1775
|
<a id="pages-27f3ea"></a>• [`js_insert_all_pages`](#pages-27f3ea) - Optional Block<br>Insert Bot Defense JavaScript in all pages<br>See [Js Insert All Pages](#pages-27f3ea) below.
|
|
1776
1776
|
|
|
@@ -1838,7 +1838,7 @@ A [`js_insertion_rules`](#bot-defense-advanced-js-insertion-rules) block (within
|
|
|
1838
1838
|
|
|
1839
1839
|
A [`rules`](#rules-24e5a0) block (within [`bot_defense_advanced.js_insertion_rules`](#bot-defense-advanced-js-insertion-rules)) supports the following:
|
|
1840
1840
|
|
|
1841
|
-
<a id="domain-bd13eb"></a>• [`any_domain`](#domain-bd13eb) - Optional Block<br>
|
|
1841
|
+
<a id="domain-bd13eb"></a>• [`any_domain`](#domain-bd13eb) - Optional Block<br>Enable this option
|
|
1842
1842
|
|
|
1843
1843
|
<a id="domain-ff2f2e"></a>• [`domain`](#domain-ff2f2e) - Optional Block<br>Domains. Domains names<br>See [Domain](#domain-ff2f2e) below.
|
|
1844
1844
|
|
|
@@ -1920,7 +1920,7 @@ A [`custom_cache_rule`](#caching-policy-custom-cache-rule) block (within [`cachi
|
|
|
1920
1920
|
|
|
1921
1921
|
A [`default_cache_action`](#caching-policy-default-cache-action) block (within [`caching_policy`](#caching-policy)) supports the following:
|
|
1922
1922
|
|
|
1923
|
-
<a id="disabled-39759c"></a>• [`cache_disabled`](#disabled-39759c) - Optional Block<br>
|
|
1923
|
+
<a id="disabled-39759c"></a>• [`cache_disabled`](#disabled-39759c) - Optional Block<br>Enable this option
|
|
1924
1924
|
|
|
1925
1925
|
<a id="default-2899d2"></a>• [`cache_ttl_default`](#default-2899d2) - Optional String<br>Use Cache TTL Provided by Origin, and set a contigency TTL value in case one is not provided
|
|
1926
1926
|
|
|
@@ -1944,9 +1944,9 @@ A [`client_side_defense`](#client-side-defense) block supports the following:
|
|
|
1944
1944
|
|
|
1945
1945
|
A [`policy`](#client-side-defense-policy) block (within [`client_side_defense`](#client-side-defense)) supports the following:
|
|
1946
1946
|
|
|
1947
|
-
<a id="insert-683e69"></a>• [`disable_js_insert`](#insert-683e69) - Optional Block<br>
|
|
1947
|
+
<a id="insert-683e69"></a>• [`disable_js_insert`](#insert-683e69) - Optional Block<br>Enable this option
|
|
1948
1948
|
|
|
1949
|
-
<a id="pages-38bd1c"></a>• [`js_insert_all_pages`](#pages-38bd1c) - Optional Block<br>
|
|
1949
|
+
<a id="pages-38bd1c"></a>• [`js_insert_all_pages`](#pages-38bd1c) - Optional Block<br>Enable this option
|
|
1950
1950
|
|
|
1951
1951
|
<a id="except-7bfe85"></a>• [`js_insert_all_pages_except`](#except-7bfe85) - Optional Block<br>Insert Client-Side Defense JavaScript in all pages with the exceptions<br>See [Js Insert All Pages Except](#except-7bfe85) below.
|
|
1952
1952
|
|
|
@@ -2016,25 +2016,25 @@ A [`js_insertion_rules`](#rules-ad3671) block (within [`client_side_defense.poli
|
|
|
2016
2016
|
|
|
2017
2017
|
A [`cookie_stickiness`](#cookie-stickiness) block supports the following:
|
|
2018
2018
|
|
|
2019
|
-
<a id="cookie-stickiness-add-httponly"></a>• [`add_httponly`](#cookie-stickiness-add-httponly) - Optional Block<br>
|
|
2019
|
+
<a id="cookie-stickiness-add-httponly"></a>• [`add_httponly`](#cookie-stickiness-add-httponly) - Optional Block<br>Enable this option
|
|
2020
2020
|
|
|
2021
|
-
<a id="cookie-stickiness-add-secure"></a>• [`add_secure`](#cookie-stickiness-add-secure) - Optional Block<br>
|
|
2021
|
+
<a id="cookie-stickiness-add-secure"></a>• [`add_secure`](#cookie-stickiness-add-secure) - Optional Block<br>Enable this option
|
|
2022
2022
|
|
|
2023
|
-
<a id="cookie-stickiness-ignore-httponly"></a>• [`ignore_httponly`](#cookie-stickiness-ignore-httponly) - Optional Block<br>
|
|
2023
|
+
<a id="cookie-stickiness-ignore-httponly"></a>• [`ignore_httponly`](#cookie-stickiness-ignore-httponly) - Optional Block<br>Enable this option
|
|
2024
2024
|
|
|
2025
|
-
<a id="cookie-stickiness-ignore-samesite"></a>• [`ignore_samesite`](#cookie-stickiness-ignore-samesite) - Optional Block<br>
|
|
2025
|
+
<a id="cookie-stickiness-ignore-samesite"></a>• [`ignore_samesite`](#cookie-stickiness-ignore-samesite) - Optional Block<br>Enable this option
|
|
2026
2026
|
|
|
2027
|
-
<a id="cookie-stickiness-ignore-secure"></a>• [`ignore_secure`](#cookie-stickiness-ignore-secure) - Optional Block<br>
|
|
2027
|
+
<a id="cookie-stickiness-ignore-secure"></a>• [`ignore_secure`](#cookie-stickiness-ignore-secure) - Optional Block<br>Enable this option
|
|
2028
2028
|
|
|
2029
2029
|
<a id="cookie-stickiness-name"></a>• [`name`](#cookie-stickiness-name) - Optional String<br>The name of the cookie that will be used to obtain the hash key. If the cookie is not present and TTL below is not set, no hash will be produced
|
|
2030
2030
|
|
|
2031
2031
|
<a id="cookie-stickiness-path"></a>• [`path`](#cookie-stickiness-path) - Optional String<br>The name of the path for the cookie. If no path is specified here, no path will be set for the cookie
|
|
2032
2032
|
|
|
2033
|
-
<a id="cookie-stickiness-samesite-lax"></a>• [`samesite_lax`](#cookie-stickiness-samesite-lax) - Optional Block<br>
|
|
2033
|
+
<a id="cookie-stickiness-samesite-lax"></a>• [`samesite_lax`](#cookie-stickiness-samesite-lax) - Optional Block<br>Enable this option
|
|
2034
2034
|
|
|
2035
|
-
<a id="cookie-stickiness-samesite-none"></a>• [`samesite_none`](#cookie-stickiness-samesite-none) - Optional Block<br>
|
|
2035
|
+
<a id="cookie-stickiness-samesite-none"></a>• [`samesite_none`](#cookie-stickiness-samesite-none) - Optional Block<br>Enable this option
|
|
2036
2036
|
|
|
2037
|
-
<a id="cookie-stickiness-samesite-strict"></a>• [`samesite_strict`](#cookie-stickiness-samesite-strict) - Optional Block<br>
|
|
2037
|
+
<a id="cookie-stickiness-samesite-strict"></a>• [`samesite_strict`](#cookie-stickiness-samesite-strict) - Optional Block<br>Enable this option
|
|
2038
2038
|
|
|
2039
2039
|
<a id="cookie-stickiness-ttl"></a>• [`ttl`](#cookie-stickiness-ttl) - Optional Number<br>If specified, a cookie with the TTL will be generated if the cookie is not present. If the TTL is present and zero, the generated cookie will be a session cookie. TTL value is in milliseconds
|
|
2040
2040
|
|
|
@@ -2062,11 +2062,11 @@ A [`cors_policy`](#cors-policy) block supports the following:
|
|
|
2062
2062
|
|
|
2063
2063
|
A [`csrf_policy`](#csrf-policy) block supports the following:
|
|
2064
2064
|
|
|
2065
|
-
<a id="csrf-policy-all-load-balancer-domains"></a>• [`all_load_balancer_domains`](#csrf-policy-all-load-balancer-domains) - Optional Block<br>
|
|
2065
|
+
<a id="csrf-policy-all-load-balancer-domains"></a>• [`all_load_balancer_domains`](#csrf-policy-all-load-balancer-domains) - Optional Block<br>Enable this option
|
|
2066
2066
|
|
|
2067
2067
|
<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.
|
|
2068
2068
|
|
|
2069
|
-
<a id="csrf-policy-disabled"></a>• [`disabled`](#csrf-policy-disabled) - Optional Block<br>
|
|
2069
|
+
<a id="csrf-policy-disabled"></a>• [`disabled`](#csrf-policy-disabled) - Optional Block<br>Enable this option
|
|
2070
2070
|
|
|
2071
2071
|
#### CSRF Policy Custom Domain List
|
|
2072
2072
|
|
|
@@ -2078,9 +2078,9 @@ A [`custom_domain_list`](#csrf-policy-custom-domain-list) block (within [`csrf_p
|
|
|
2078
2078
|
|
|
2079
2079
|
A [`data_guard_rules`](#data-guard-rules) block supports the following:
|
|
2080
2080
|
|
|
2081
|
-
<a id="data-guard-rules-any-domain"></a>• [`any_domain`](#data-guard-rules-any-domain) - Optional Block<br>
|
|
2081
|
+
<a id="data-guard-rules-any-domain"></a>• [`any_domain`](#data-guard-rules-any-domain) - Optional Block<br>Enable this option
|
|
2082
2082
|
|
|
2083
|
-
<a id="data-guard-rules-apply-data-guard"></a>• [`apply_data_guard`](#data-guard-rules-apply-data-guard) - Optional Block<br>
|
|
2083
|
+
<a id="data-guard-rules-apply-data-guard"></a>• [`apply_data_guard`](#data-guard-rules-apply-data-guard) - Optional Block<br>Enable this option
|
|
2084
2084
|
|
|
2085
2085
|
<a id="data-guard-rules-exact-value"></a>• [`exact_value`](#data-guard-rules-exact-value) - Optional String<br>Exact domain name
|
|
2086
2086
|
|
|
@@ -2088,7 +2088,7 @@ A [`data_guard_rules`](#data-guard-rules) block supports the following:
|
|
|
2088
2088
|
|
|
2089
2089
|
<a id="data-guard-rules-path"></a>• [`path`](#data-guard-rules-path) - Optional Block<br>Path match of the URI can be either be, Prefix match or exact match or regular expression match<br>See [Path](#data-guard-rules-path) below.
|
|
2090
2090
|
|
|
2091
|
-
<a id="data-guard-rules-skip-data-guard"></a>• [`skip_data_guard`](#data-guard-rules-skip-data-guard) - Optional Block<br>
|
|
2091
|
+
<a id="data-guard-rules-skip-data-guard"></a>• [`skip_data_guard`](#data-guard-rules-skip-data-guard) - Optional Block<br>Enable this option
|
|
2092
2092
|
|
|
2093
2093
|
<a id="data-guard-rules-suffix-value"></a>• [`suffix_value`](#data-guard-rules-suffix-value) - Optional String<br>Suffix of domain name e.g 'xyz.com' will match '*.xyz.com' and 'xyz.com'
|
|
2094
2094
|
|
|
@@ -2114,7 +2114,7 @@ A [`path`](#data-guard-rules-path) block (within [`data_guard_rules`](#data-guar
|
|
|
2114
2114
|
|
|
2115
2115
|
A [`ddos_mitigation_rules`](#ddos-mitigation-rules) block supports the following:
|
|
2116
2116
|
|
|
2117
|
-
<a id="ddos-mitigation-rules-block"></a>• [`block`](#ddos-mitigation-rules-block) - Optional Block<br>
|
|
2117
|
+
<a id="ddos-mitigation-rules-block"></a>• [`block`](#ddos-mitigation-rules-block) - Optional Block<br>Enable this option
|
|
2118
2118
|
|
|
2119
2119
|
<a id="source-02aa55"></a>• [`ddos_client_source`](#source-02aa55) - Optional Block<br>DDOS Client Source Choice. DDOS Mitigation sources to be blocked<br>See [DDOS Client Source](#source-02aa55) below.
|
|
2120
2120
|
|
|
@@ -2170,7 +2170,7 @@ A [`default_pool`](#default-pool) block supports the following:
|
|
|
2170
2170
|
|
|
2171
2171
|
<a id="default-pool-advanced-options"></a>• [`advanced_options`](#default-pool-advanced-options) - Optional Block<br>Configure Advanced OPTIONS for origin pool<br>See [Advanced Options](#default-pool-advanced-options) below.
|
|
2172
2172
|
|
|
2173
|
-
<a id="default-pool-automatic-port"></a>• [`automatic_port`](#default-pool-automatic-port) - Optional Block<br>
|
|
2173
|
+
<a id="default-pool-automatic-port"></a>• [`automatic_port`](#default-pool-automatic-port) - Optional Block<br>Enable this option
|
|
2174
2174
|
|
|
2175
2175
|
<a id="default-pool-endpoint-selection"></a>• [`endpoint_selection`](#default-pool-endpoint-selection) - Optional String Defaults to `DISTRIBUTED`<br>Possible values are `DISTRIBUTED`, `LOCAL_ONLY`, `LOCAL_PREFERRED`<br>[Enum: DISTRIBUTED|LOCAL_ONLY|LOCAL_PREFERRED] Policy for selection of endpoints from local site/remote site/both Consider both remote and local endpoints for load balancing LOCAL_ONLY: Consider only local endpoints for load balancing Enable this policy to load balance ONLY among locally discovered endpoints Prefer the local endpoints for
|
|
2176
2176
|
|
|
@@ -2178,17 +2178,17 @@ A [`default_pool`](#default-pool) block supports the following:
|
|
|
2178
2178
|
|
|
2179
2179
|
<a id="default-pool-healthcheck"></a>• [`healthcheck`](#default-pool-healthcheck) - Optional Block<br>Reference to healthcheck configuration objects<br>See [Healthcheck](#default-pool-healthcheck) below.
|
|
2180
2180
|
|
|
2181
|
-
<a id="default-pool-lb-port"></a>• [`lb_port`](#default-pool-lb-port) - Optional Block<br>
|
|
2181
|
+
<a id="default-pool-lb-port"></a>• [`lb_port`](#default-pool-lb-port) - Optional Block<br>Enable this option
|
|
2182
2182
|
|
|
2183
2183
|
<a id="default-pool-loadbalancer-algorithm"></a>• [`loadbalancer_algorithm`](#default-pool-loadbalancer-algorithm) - Optional String Defaults to `ROUND_ROBIN`<br>Possible values are `ROUND_ROBIN`, `LEAST_REQUEST`, `RING_HASH`, `RANDOM`, `LB_OVERRIDE`<br>[Enum: ROUND_ROBIN|LEAST_REQUEST|RING_HASH|RANDOM|LB_OVERRIDE] Different load balancing algorithms supported When a connection to a endpoint in an upstream cluster is required, the load balancer uses loadbalancer_algorithm to determine which host is selected. - ROUND_ROBIN: ROUND_ROBIN Policy in which each healthy/available upstream endpoint is selected in
|
|
2184
2184
|
|
|
2185
|
-
<a id="default-pool-no-tls"></a>• [`no_tls`](#default-pool-no-tls) - Optional Block<br>
|
|
2185
|
+
<a id="default-pool-no-tls"></a>• [`no_tls`](#default-pool-no-tls) - Optional Block<br>Enable this option
|
|
2186
2186
|
|
|
2187
2187
|
<a id="default-pool-origin-servers"></a>• [`origin_servers`](#default-pool-origin-servers) - Optional Block<br>List of origin servers in this pool<br>See [Origin Servers](#default-pool-origin-servers) below.
|
|
2188
2188
|
|
|
2189
2189
|
<a id="default-pool-port"></a>• [`port`](#default-pool-port) - Optional Number<br>Endpoint service is available on this port
|
|
2190
2190
|
|
|
2191
|
-
<a id="default-pool-same-as-endpoint-port"></a>• [`same_as_endpoint_port`](#default-pool-same-as-endpoint-port) - Optional Block<br>
|
|
2191
|
+
<a id="default-pool-same-as-endpoint-port"></a>• [`same_as_endpoint_port`](#default-pool-same-as-endpoint-port) - Optional Block<br>Enable this option
|
|
2192
2192
|
|
|
2193
2193
|
<a id="type-2756f7"></a>• [`upstream_conn_pool_reuse_type`](#type-2756f7) - Optional Block<br>Select upstream connection pool reuse state for every downstream connection. This configuration choice is for HTTP(S) LB only<br>See [Upstream Conn Pool Reuse Type](#type-2756f7) below.
|
|
2194
2194
|
|
|
@@ -2200,25 +2200,25 @@ A [`default_pool`](#default-pool) block supports the following:
|
|
|
2200
2200
|
|
|
2201
2201
|
An [`advanced_options`](#default-pool-advanced-options) block (within [`default_pool`](#default-pool)) supports the following:
|
|
2202
2202
|
|
|
2203
|
-
<a id="config-48f56b"></a>• [`auto_http_config`](#config-48f56b) - Optional Block<br>
|
|
2203
|
+
<a id="config-48f56b"></a>• [`auto_http_config`](#config-48f56b) - Optional Block<br>Enable this option
|
|
2204
2204
|
|
|
2205
2205
|
<a id="breaker-8f5df4"></a>• [`circuit_breaker`](#breaker-8f5df4) - Optional Block<br>CircuitBreaker provides a mechanism for watching failures in upstream connections or requests and if the failures reach a certain threshold, automatically fail subsequent requests which allows to apply back pressure on downstream quickly<br>See [Circuit Breaker](#breaker-8f5df4) below.
|
|
2206
2206
|
|
|
2207
2207
|
<a id="timeout-8cd873"></a>• [`connection_timeout`](#timeout-8cd873) - Optional Number Defaults to `2` Specified in milliseconds<br>The timeout for new network connections to endpoints in the cluster. The seconds
|
|
2208
2208
|
|
|
2209
|
-
<a id="breaker-db5d25"></a>• [`default_circuit_breaker`](#breaker-db5d25) - Optional Block<br>
|
|
2209
|
+
<a id="breaker-db5d25"></a>• [`default_circuit_breaker`](#breaker-db5d25) - Optional Block<br>Enable this option
|
|
2210
2210
|
|
|
2211
|
-
<a id="breaker-03c951"></a>• [`disable_circuit_breaker`](#breaker-03c951) - Optional Block<br>
|
|
2211
|
+
<a id="breaker-03c951"></a>• [`disable_circuit_breaker`](#breaker-03c951) - Optional Block<br>Enable this option
|
|
2212
2212
|
|
|
2213
|
-
<a id="persistance-83b4c4"></a>• [`disable_lb_source_ip_persistance`](#persistance-83b4c4) - Optional Block<br>
|
|
2213
|
+
<a id="persistance-83b4c4"></a>• [`disable_lb_source_ip_persistance`](#persistance-83b4c4) - Optional Block<br>Enable this option
|
|
2214
2214
|
|
|
2215
|
-
<a id="detection-46546c"></a>• [`disable_outlier_detection`](#detection-46546c) - Optional Block<br>
|
|
2215
|
+
<a id="detection-46546c"></a>• [`disable_outlier_detection`](#detection-46546c) - Optional Block<br>Enable this option
|
|
2216
2216
|
|
|
2217
|
-
<a id="protocol-d614b9"></a>• [`disable_proxy_protocol`](#protocol-d614b9) - Optional Block<br>
|
|
2217
|
+
<a id="protocol-d614b9"></a>• [`disable_proxy_protocol`](#protocol-d614b9) - Optional Block<br>Enable this option
|
|
2218
2218
|
|
|
2219
|
-
<a id="subsets-b0bd38"></a>• [`disable_subsets`](#subsets-b0bd38) - Optional Block<br>
|
|
2219
|
+
<a id="subsets-b0bd38"></a>• [`disable_subsets`](#subsets-b0bd38) - Optional Block<br>Enable this option
|
|
2220
2220
|
|
|
2221
|
-
<a id="persistance-d799ee"></a>• [`enable_lb_source_ip_persistance`](#persistance-d799ee) - Optional Block<br>
|
|
2221
|
+
<a id="persistance-d799ee"></a>• [`enable_lb_source_ip_persistance`](#persistance-d799ee) - Optional Block<br>Enable this option
|
|
2222
2222
|
|
|
2223
2223
|
<a id="subsets-5a741c"></a>• [`enable_subsets`](#subsets-5a741c) - Optional Block<br>Configure subset OPTIONS for origin pool<br>See [Enable Subsets](#subsets-5a741c) below.
|
|
2224
2224
|
|
|
@@ -2228,15 +2228,15 @@ An [`advanced_options`](#default-pool-advanced-options) block (within [`default_
|
|
|
2228
2228
|
|
|
2229
2229
|
<a id="timeout-3807d9"></a>• [`http_idle_timeout`](#timeout-3807d9) - Optional Number<br>The idle timeout for upstream connection pool 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
|
|
2230
2230
|
|
|
2231
|
-
<a id="threshold-4ef07a"></a>• [`no_panic_threshold`](#threshold-4ef07a) - Optional Block<br>
|
|
2231
|
+
<a id="threshold-4ef07a"></a>• [`no_panic_threshold`](#threshold-4ef07a) - Optional Block<br>Enable this option
|
|
2232
2232
|
|
|
2233
2233
|
<a id="detection-c89e70"></a>• [`outlier_detection`](#detection-c89e70) - Optional Block<br>Outlier detection and ejection is the process of dynamically determining whether some number of hosts in an upstream cluster are performing unlike the others and removing them from the healthy load balancing set. Outlier detection is a form of passive health checking. Algorithm 1<br>See [Outlier Detection](#detection-c89e70) below.
|
|
2234
2234
|
|
|
2235
2235
|
<a id="threshold-61a03f"></a>• [`panic_threshold`](#threshold-61a03f) - Optional Number<br>Configure a threshold (percentage of unhealthy endpoints) below which all endpoints will be considered for load balancing ignoring its health status
|
|
2236
2236
|
|
|
2237
|
-
<a id="protocol-v1-de8613"></a>• [`proxy_protocol_v1`](#protocol-v1-de8613) - Optional Block<br>
|
|
2237
|
+
<a id="protocol-v1-de8613"></a>• [`proxy_protocol_v1`](#protocol-v1-de8613) - Optional Block<br>Enable this option
|
|
2238
2238
|
|
|
2239
|
-
<a id="protocol-v2-5b9d69"></a>• [`proxy_protocol_v2`](#protocol-v2-5b9d69) - Optional Block<br>
|
|
2239
|
+
<a id="protocol-v2-5b9d69"></a>• [`proxy_protocol_v2`](#protocol-v2-5b9d69) - Optional Block<br>Enable this option
|
|
2240
2240
|
|
|
2241
2241
|
#### Default Pool Advanced Options Circuit Breaker
|
|
2242
2242
|
|
|
@@ -2256,13 +2256,13 @@ A [`circuit_breaker`](#breaker-8f5df4) block (within [`default_pool.advanced_opt
|
|
|
2256
2256
|
|
|
2257
2257
|
An [`enable_subsets`](#subsets-5a741c) block (within [`default_pool.advanced_options`](#default-pool-advanced-options)) supports the following:
|
|
2258
2258
|
|
|
2259
|
-
<a id="endpoint-6dd4c1"></a>• [`any_endpoint`](#endpoint-6dd4c1) - Optional Block<br>
|
|
2259
|
+
<a id="endpoint-6dd4c1"></a>• [`any_endpoint`](#endpoint-6dd4c1) - Optional Block<br>Enable this option
|
|
2260
2260
|
|
|
2261
2261
|
<a id="subset-1bf539"></a>• [`default_subset`](#subset-1bf539) - Optional Block<br>Origin Pool Default Subset. Default Subset definition<br>See [Default Subset](#subset-1bf539) below.
|
|
2262
2262
|
|
|
2263
2263
|
<a id="subsets-5171e5"></a>• [`endpoint_subsets`](#subsets-5171e5) - Optional Block<br>List of subset class. Subsets class is defined using list of keys. Every unique combination of values of these keys form a subset withing the class<br>See [Endpoint Subsets](#subsets-5171e5) below.
|
|
2264
2264
|
|
|
2265
|
-
<a id="request-26d37d"></a>• [`fail_request`](#request-26d37d) - Optional Block<br>
|
|
2265
|
+
<a id="request-26d37d"></a>• [`fail_request`](#request-26d37d) - Optional Block<br>Enable this option
|
|
2266
2266
|
|
|
2267
2267
|
#### Default Pool Advanced Options Enable Subsets Default Subset
|
|
2268
2268
|
|
|
@@ -2348,9 +2348,9 @@ A [`cbip_service`](#service-060a80) block (within [`default_pool.origin_servers`
|
|
|
2348
2348
|
|
|
2349
2349
|
A [`consul_service`](#service-799005) block (within [`default_pool.origin_servers`](#default-pool-origin-servers)) supports the following:
|
|
2350
2350
|
|
|
2351
|
-
<a id="network-654a28"></a>• [`inside_network`](#network-654a28) - Optional Block<br>
|
|
2351
|
+
<a id="network-654a28"></a>• [`inside_network`](#network-654a28) - Optional Block<br>Enable this option
|
|
2352
2352
|
|
|
2353
|
-
<a id="network-b1e5db"></a>• [`outside_network`](#network-b1e5db) - Optional Block<br>
|
|
2353
|
+
<a id="network-b1e5db"></a>• [`outside_network`](#network-b1e5db) - Optional Block<br>Enable this option
|
|
2354
2354
|
|
|
2355
2355
|
<a id="name-5d42b9"></a>• [`service_name`](#name-5d42b9) - Optional String<br>Consul service name of this origin server will be listed, including cluster-ID. The format is servicename:cluster-ID
|
|
2356
2356
|
|
|
@@ -2392,9 +2392,9 @@ A [`custom_endpoint_object`](#object-12dd7f) block (within [`default_pool.origin
|
|
|
2392
2392
|
|
|
2393
2393
|
A [`k8s_service`](#default-pool-origin-servers-k8s-service) block (within [`default_pool.origin_servers`](#default-pool-origin-servers)) supports the following:
|
|
2394
2394
|
|
|
2395
|
-
<a id="network-dfbf17"></a>• [`inside_network`](#network-dfbf17) - Optional Block<br>
|
|
2395
|
+
<a id="network-dfbf17"></a>• [`inside_network`](#network-dfbf17) - Optional Block<br>Enable this option
|
|
2396
2396
|
|
|
2397
|
-
<a id="network-d1b956"></a>• [`outside_network`](#network-d1b956) - Optional Block<br>
|
|
2397
|
+
<a id="network-d1b956"></a>• [`outside_network`](#network-d1b956) - Optional Block<br>Enable this option
|
|
2398
2398
|
|
|
2399
2399
|
<a id="protocol-ffcd27"></a>• [`protocol`](#protocol-ffcd27) - Optional String Defaults to `PROTOCOL_TCP`<br>Possible values are `PROTOCOL_TCP`, `PROTOCOL_UDP`<br>[Enum: PROTOCOL_TCP|PROTOCOL_UDP] Type of protocol - PROTOCOL_TCP: TCP - PROTOCOL_UDP: UDP
|
|
2400
2400
|
|
|
@@ -2404,7 +2404,7 @@ A [`k8s_service`](#default-pool-origin-servers-k8s-service) block (within [`defa
|
|
|
2404
2404
|
|
|
2405
2405
|
<a id="pool-0640ac"></a>• [`snat_pool`](#pool-0640ac) - Optional Block<br>SNAT Pool. SNAT Pool configuration<br>See [Snat Pool](#pool-0640ac) below.
|
|
2406
2406
|
|
|
2407
|
-
<a id="networks-03f764"></a>• [`vk8s_networks`](#networks-03f764) - Optional Block<br>
|
|
2407
|
+
<a id="networks-03f764"></a>• [`vk8s_networks`](#networks-03f764) - Optional Block<br>Enable this option
|
|
2408
2408
|
|
|
2409
2409
|
#### Default Pool Origin Servers K8S Service Site Locator
|
|
2410
2410
|
|
|
@@ -2430,11 +2430,11 @@ A [`k8s_service`](#default-pool-origin-servers-k8s-service) block (within [`defa
|
|
|
2430
2430
|
|
|
2431
2431
|
A [`private_ip`](#default-pool-origin-servers-private-ip) block (within [`default_pool.origin_servers`](#default-pool-origin-servers)) supports the following:
|
|
2432
2432
|
|
|
2433
|
-
<a id="network-704c7d"></a>• [`inside_network`](#network-704c7d) - Optional Block<br>
|
|
2433
|
+
<a id="network-704c7d"></a>• [`inside_network`](#network-704c7d) - Optional Block<br>Enable this option
|
|
2434
2434
|
|
|
2435
2435
|
<a id="ip-ip-4a696b"></a>• [`ip`](#ip-ip-4a696b) - Optional String<br>IP. Private IPv4 address
|
|
2436
2436
|
|
|
2437
|
-
<a id="network-f44165"></a>• [`outside_network`](#network-f44165) - Optional Block<br>
|
|
2437
|
+
<a id="network-f44165"></a>• [`outside_network`](#network-f44165) - Optional Block<br>Enable this option
|
|
2438
2438
|
|
|
2439
2439
|
<a id="segment-735aa1"></a>• [`segment`](#segment-735aa1) - Optional Block<br>Type establishes a direct reference from one object(the referrer) to another(the referred). Such a reference is in form of tenant/namespace/name<br>See [Segment](#segment-735aa1) below.
|
|
2440
2440
|
|
|
@@ -2478,9 +2478,9 @@ A [`private_name`](#name-966ae3) block (within [`default_pool.origin_servers`](#
|
|
|
2478
2478
|
|
|
2479
2479
|
<a id="name-8a8021"></a>• [`dns_name`](#name-8a8021) - Optional String<br>DNS Name. DNS Name
|
|
2480
2480
|
|
|
2481
|
-
<a id="network-e9e813"></a>• [`inside_network`](#network-e9e813) - Optional Block<br>
|
|
2481
|
+
<a id="network-e9e813"></a>• [`inside_network`](#network-e9e813) - Optional Block<br>Enable this option
|
|
2482
2482
|
|
|
2483
|
-
<a id="network-873dcb"></a>• [`outside_network`](#network-873dcb) - Optional Block<br>
|
|
2483
|
+
<a id="network-873dcb"></a>• [`outside_network`](#network-873dcb) - Optional Block<br>Enable this option
|
|
2484
2484
|
|
|
2485
2485
|
<a id="interval-615002"></a>• [`refresh_interval`](#interval-615002) - Optional Number<br>Interval for DNS refresh in seconds. Max value is 7 days as per `HTTPS://datatracker.ietf.org/doc/HTML/rfc8767.`
|
|
2486
2486
|
|
|
@@ -2562,31 +2562,31 @@ A [`vn_private_name`](#name-4a1747) block (within [`default_pool.origin_servers`
|
|
|
2562
2562
|
|
|
2563
2563
|
An [`upstream_conn_pool_reuse_type`](#type-2756f7) block (within [`default_pool`](#default-pool)) supports the following:
|
|
2564
2564
|
|
|
2565
|
-
<a id="reuse-6660fb"></a>• [`disable_conn_pool_reuse`](#reuse-6660fb) - Optional Block<br>
|
|
2565
|
+
<a id="reuse-6660fb"></a>• [`disable_conn_pool_reuse`](#reuse-6660fb) - Optional Block<br>Enable this option
|
|
2566
2566
|
|
|
2567
|
-
<a id="reuse-52dccb"></a>• [`enable_conn_pool_reuse`](#reuse-52dccb) - Optional Block<br>
|
|
2567
|
+
<a id="reuse-52dccb"></a>• [`enable_conn_pool_reuse`](#reuse-52dccb) - Optional Block<br>Enable this option
|
|
2568
2568
|
|
|
2569
2569
|
#### Default Pool Use TLS
|
|
2570
2570
|
|
|
2571
2571
|
An [`use_tls`](#default-pool-use-tls) block (within [`default_pool`](#default-pool)) supports the following:
|
|
2572
2572
|
|
|
2573
|
-
<a id="caching-6d4585"></a>• [`default_session_key_caching`](#caching-6d4585) - Optional Block<br>
|
|
2573
|
+
<a id="caching-6d4585"></a>• [`default_session_key_caching`](#caching-6d4585) - Optional Block<br>Enable this option
|
|
2574
2574
|
|
|
2575
|
-
<a id="caching-e75c13"></a>• [`disable_session_key_caching`](#caching-e75c13) - Optional Block<br>
|
|
2575
|
+
<a id="caching-e75c13"></a>• [`disable_session_key_caching`](#caching-e75c13) - Optional Block<br>Enable this option
|
|
2576
2576
|
|
|
2577
|
-
<a id="default-pool-use-tls-disable-sni"></a>• [`disable_sni`](#default-pool-use-tls-disable-sni) - Optional Block<br>
|
|
2577
|
+
<a id="default-pool-use-tls-disable-sni"></a>• [`disable_sni`](#default-pool-use-tls-disable-sni) - Optional Block<br>Enable this option
|
|
2578
2578
|
|
|
2579
2579
|
<a id="default-pool-use-tls-max-session-keys"></a>• [`max_session_keys`](#default-pool-use-tls-max-session-keys) - Optional Number<br>Number of session keys that are cached
|
|
2580
2580
|
|
|
2581
|
-
<a id="default-pool-use-tls-no-mtls"></a>• [`no_mtls`](#default-pool-use-tls-no-mtls) - Optional Block<br>
|
|
2581
|
+
<a id="default-pool-use-tls-no-mtls"></a>• [`no_mtls`](#default-pool-use-tls-no-mtls) - Optional Block<br>Enable this option
|
|
2582
2582
|
|
|
2583
|
-
<a id="verification-a40775"></a>• [`skip_server_verification`](#verification-a40775) - Optional Block<br>
|
|
2583
|
+
<a id="verification-a40775"></a>• [`skip_server_verification`](#verification-a40775) - Optional Block<br>Enable this option
|
|
2584
2584
|
|
|
2585
2585
|
<a id="default-pool-use-tls-sni"></a>• [`sni`](#default-pool-use-tls-sni) - Optional String<br>SNI value to be used
|
|
2586
2586
|
|
|
2587
2587
|
<a id="default-pool-use-tls-tls-config"></a>• [`tls_config`](#default-pool-use-tls-tls-config) - Optional Block<br>Defines various OPTIONS to configure TLS configuration parameters<br>See [TLS Config](#default-pool-use-tls-tls-config) below.
|
|
2588
2588
|
|
|
2589
|
-
<a id="sni-a63eaf"></a>• [`use_host_header_as_sni`](#sni-a63eaf) - Optional Block<br>
|
|
2589
|
+
<a id="sni-a63eaf"></a>• [`use_host_header_as_sni`](#sni-a63eaf) - Optional Block<br>Enable this option
|
|
2590
2590
|
|
|
2591
2591
|
<a id="default-pool-use-tls-use-mtls"></a>• [`use_mtls`](#default-pool-use-tls-use-mtls) - Optional Block<br>mTLS Certificate. mTLS Client Certificate<br>See [Use mTLS](#default-pool-use-tls-use-mtls) below.
|
|
2592
2592
|
|
|
@@ -2594,7 +2594,7 @@ An [`use_tls`](#default-pool-use-tls) block (within [`default_pool`](#default-po
|
|
|
2594
2594
|
|
|
2595
2595
|
<a id="verification-388853"></a>• [`use_server_verification`](#verification-388853) - Optional Block<br>TLS Validation Context for Origin Servers. Upstream TLS Validation Context<br>See [Use Server Verification](#verification-388853) below.
|
|
2596
2596
|
|
|
2597
|
-
<a id="trusted-ca-e7a557"></a>• [`volterra_trusted_ca`](#trusted-ca-e7a557) - Optional Block<br>
|
|
2597
|
+
<a id="trusted-ca-e7a557"></a>• [`volterra_trusted_ca`](#trusted-ca-e7a557) - Optional Block<br>Enable this option
|
|
2598
2598
|
|
|
2599
2599
|
#### Default Pool Use TLS TLS Config
|
|
2600
2600
|
|
|
@@ -2602,11 +2602,11 @@ A [`tls_config`](#default-pool-use-tls-tls-config) block (within [`default_pool.
|
|
|
2602
2602
|
|
|
2603
2603
|
<a id="security-e7acc0"></a>• [`custom_security`](#security-e7acc0) - Optional Block<br>Defines TLS protocol config including min/max versions and allowed ciphers<br>See [Custom Security](#security-e7acc0) below.
|
|
2604
2604
|
|
|
2605
|
-
<a id="security-b532bd"></a>• [`default_security`](#security-b532bd) - Optional Block<br>
|
|
2605
|
+
<a id="security-b532bd"></a>• [`default_security`](#security-b532bd) - Optional Block<br>Enable this option
|
|
2606
2606
|
|
|
2607
|
-
<a id="security-33124a"></a>• [`low_security`](#security-33124a) - Optional Block<br>
|
|
2607
|
+
<a id="security-33124a"></a>• [`low_security`](#security-33124a) - Optional Block<br>Enable this option
|
|
2608
2608
|
|
|
2609
|
-
<a id="security-ea8e0f"></a>• [`medium_security`](#security-ea8e0f) - Optional Block<br>
|
|
2609
|
+
<a id="security-ea8e0f"></a>• [`medium_security`](#security-ea8e0f) - Optional Block<br>Enable this option
|
|
2610
2610
|
|
|
2611
2611
|
#### Default Pool Use TLS TLS Config Custom Security
|
|
2612
2612
|
|
|
@@ -2754,13 +2754,13 @@ An [`enable_api_discovery`](#enable-api-discovery) block supports the following:
|
|
|
2754
2754
|
|
|
2755
2755
|
<a id="discovery-54db29"></a>• [`custom_api_auth_discovery`](#discovery-54db29) - Optional Block<br>API Discovery Advanced Settings. API Discovery Advanced settings<br>See [Custom API Auth Discovery](#discovery-54db29) below.
|
|
2756
2756
|
|
|
2757
|
-
<a id="discovery-29517f"></a>• [`default_api_auth_discovery`](#discovery-29517f) - Optional Block<br>
|
|
2757
|
+
<a id="discovery-29517f"></a>• [`default_api_auth_discovery`](#discovery-29517f) - Optional Block<br>Enable this option
|
|
2758
2758
|
|
|
2759
|
-
<a id="traffic-90c445"></a>• [`disable_learn_from_redirect_traffic`](#traffic-90c445) - Optional Block<br>
|
|
2759
|
+
<a id="traffic-90c445"></a>• [`disable_learn_from_redirect_traffic`](#traffic-90c445) - Optional Block<br>Enable this option
|
|
2760
2760
|
|
|
2761
2761
|
<a id="settings-c31c55"></a>• [`discovered_api_settings`](#settings-c31c55) - Optional Block<br>Discovered API Settings. Configure Discovered API Settings<br>See [Discovered API Settings](#settings-c31c55) below.
|
|
2762
2762
|
|
|
2763
|
-
<a id="traffic-074877"></a>• [`enable_learn_from_redirect_traffic`](#traffic-074877) - Optional Block<br>
|
|
2763
|
+
<a id="traffic-074877"></a>• [`enable_learn_from_redirect_traffic`](#traffic-074877) - Optional Block<br>Enable this option
|
|
2764
2764
|
|
|
2765
2765
|
#### Enable API Discovery API Crawler
|
|
2766
2766
|
|
|
@@ -2768,7 +2768,7 @@ An [`api_crawler`](#enable-api-discovery-api-crawler) block (within [`enable_api
|
|
|
2768
2768
|
|
|
2769
2769
|
<a id="config-1070d6"></a>• [`api_crawler_config`](#config-1070d6) - Optional Block<br>Crawler Configure<br>See [API Crawler Config](#config-1070d6) below.
|
|
2770
2770
|
|
|
2771
|
-
<a id="crawler-167f20"></a>• [`disable_api_crawler`](#crawler-167f20) - Optional Block<br>
|
|
2771
|
+
<a id="crawler-167f20"></a>• [`disable_api_crawler`](#crawler-167f20) - Optional Block<br>Enable this option
|
|
2772
2772
|
|
|
2773
2773
|
#### Enable API Discovery API Crawler API Crawler Config
|
|
2774
2774
|
|
|
@@ -2832,11 +2832,11 @@ An [`enable_challenge`](#enable-challenge) block supports the following:
|
|
|
2832
2832
|
|
|
2833
2833
|
<a id="parameters-13a9c7"></a>• [`captcha_challenge_parameters`](#parameters-13a9c7) - 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 Parameters](#parameters-13a9c7) below.
|
|
2834
2834
|
|
|
2835
|
-
<a id="parameters-247f74"></a>• [`default_captcha_challenge_parameters`](#parameters-247f74) - Optional Block<br>
|
|
2835
|
+
<a id="parameters-247f74"></a>• [`default_captcha_challenge_parameters`](#parameters-247f74) - Optional Block<br>Enable this option
|
|
2836
2836
|
|
|
2837
|
-
<a id="parameters-e2729d"></a>• [`default_js_challenge_parameters`](#parameters-e2729d) - Optional Block<br>
|
|
2837
|
+
<a id="parameters-e2729d"></a>• [`default_js_challenge_parameters`](#parameters-e2729d) - Optional Block<br>Enable this option
|
|
2838
2838
|
|
|
2839
|
-
<a id="settings-f4fda5"></a>• [`default_mitigation_settings`](#settings-f4fda5) - Optional Block<br>
|
|
2839
|
+
<a id="settings-f4fda5"></a>• [`default_mitigation_settings`](#settings-f4fda5) - Optional Block<br>Enable this option
|
|
2840
2840
|
|
|
2841
2841
|
<a id="parameters-6f7506"></a>• [`js_challenge_parameters`](#parameters-6f7506) - 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 Parameters](#parameters-6f7506) below.
|
|
2842
2842
|
|
|
@@ -2886,7 +2886,7 @@ An [`enable_trust_client_ip_headers`](#enable-trust-client-ip-headers) block sup
|
|
|
2886
2886
|
|
|
2887
2887
|
A [`graphql_rules`](#graphql-rules) block supports the following:
|
|
2888
2888
|
|
|
2889
|
-
<a id="graphql-rules-any-domain"></a>• [`any_domain`](#graphql-rules-any-domain) - Optional Block<br>
|
|
2889
|
+
<a id="graphql-rules-any-domain"></a>• [`any_domain`](#graphql-rules-any-domain) - Optional Block<br>Enable this option
|
|
2890
2890
|
|
|
2891
2891
|
<a id="graphql-rules-exact-path"></a>• [`exact_path`](#graphql-rules-exact-path) - Optional String Defaults to `/GraphQL`<br>Specifies the exact path to GraphQL endpoint
|
|
2892
2892
|
|
|
@@ -2896,9 +2896,9 @@ A [`graphql_rules`](#graphql-rules) block supports the following:
|
|
|
2896
2896
|
|
|
2897
2897
|
<a id="graphql-rules-metadata"></a>• [`metadata`](#graphql-rules-metadata) - Optional Block<br>MessageMetaType is metadata (common attributes) of a message that only certain messages have. This information is propagated to the metadata of a child object that gets created from the containing message during view processing. The information in this type can be specified by user during create<br>See [Metadata](#graphql-rules-metadata) below.
|
|
2898
2898
|
|
|
2899
|
-
<a id="graphql-rules-method-get"></a>• [`method_get`](#graphql-rules-method-get) - Optional Block<br>
|
|
2899
|
+
<a id="graphql-rules-method-get"></a>• [`method_get`](#graphql-rules-method-get) - Optional Block<br>Enable this option
|
|
2900
2900
|
|
|
2901
|
-
<a id="graphql-rules-method-post"></a>• [`method_post`](#graphql-rules-method-post) - Optional Block<br>
|
|
2901
|
+
<a id="graphql-rules-method-post"></a>• [`method_post`](#graphql-rules-method-post) - Optional Block<br>Enable this option
|
|
2902
2902
|
|
|
2903
2903
|
<a id="graphql-rules-suffix-value"></a>• [`suffix_value`](#graphql-rules-suffix-value) - Optional String<br>Suffix of domain name e.g 'xyz.com' will match '*.xyz.com' and 'xyz.com'
|
|
2904
2904
|
|
|
@@ -2906,9 +2906,9 @@ A [`graphql_rules`](#graphql-rules) block supports the following:
|
|
|
2906
2906
|
|
|
2907
2907
|
A [`graphql_settings`](#graphql-rules-graphql-settings) block (within [`graphql_rules`](#graphql-rules)) supports the following:
|
|
2908
2908
|
|
|
2909
|
-
<a id="introspection-492a5f"></a>• [`disable_introspection`](#introspection-492a5f) - Optional Block<br>
|
|
2909
|
+
<a id="introspection-492a5f"></a>• [`disable_introspection`](#introspection-492a5f) - Optional Block<br>Enable this option
|
|
2910
2910
|
|
|
2911
|
-
<a id="introspection-762fd0"></a>• [`enable_introspection`](#introspection-762fd0) - Optional Block<br>
|
|
2911
|
+
<a id="introspection-762fd0"></a>• [`enable_introspection`](#introspection-762fd0) - Optional Block<br>Enable this option
|
|
2912
2912
|
|
|
2913
2913
|
<a id="queries-f5cdb7"></a>• [`max_batched_queries`](#queries-f5cdb7) - Optional Number<br>Specify maximum number of queries in a single batched request
|
|
2914
2914
|
|
|
@@ -2946,21 +2946,21 @@ A [`https`](#https) block supports the following:
|
|
|
2946
2946
|
|
|
2947
2947
|
<a id="https-connection-idle-timeout"></a>• [`connection_idle_timeout`](#https-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
|
|
2948
2948
|
|
|
2949
|
-
<a id="https-default-header"></a>• [`default_header`](#https-default-header) - Optional Block<br>
|
|
2949
|
+
<a id="https-default-header"></a>• [`default_header`](#https-default-header) - Optional Block<br>Enable this option
|
|
2950
2950
|
|
|
2951
|
-
<a id="https-default-loadbalancer"></a>• [`default_loadbalancer`](#https-default-loadbalancer) - Optional Block<br>
|
|
2951
|
+
<a id="https-default-loadbalancer"></a>• [`default_loadbalancer`](#https-default-loadbalancer) - Optional Block<br>Enable this option
|
|
2952
2952
|
|
|
2953
|
-
<a id="https-disable-path-normalize"></a>• [`disable_path_normalize`](#https-disable-path-normalize) - Optional Block<br>
|
|
2953
|
+
<a id="https-disable-path-normalize"></a>• [`disable_path_normalize`](#https-disable-path-normalize) - Optional Block<br>Enable this option
|
|
2954
2954
|
|
|
2955
|
-
<a id="https-enable-path-normalize"></a>• [`enable_path_normalize`](#https-enable-path-normalize) - Optional Block<br>
|
|
2955
|
+
<a id="https-enable-path-normalize"></a>• [`enable_path_normalize`](#https-enable-path-normalize) - Optional Block<br>Enable this option
|
|
2956
2956
|
|
|
2957
2957
|
<a id="https-http-protocol-options"></a>• [`http_protocol_options`](#https-http-protocol-options) - Optional Block<br>HTTP protocol configuration OPTIONS for downstream connections<br>See [HTTP Protocol Options](#https-http-protocol-options) below.
|
|
2958
2958
|
|
|
2959
2959
|
<a id="https-http-redirect"></a>• [`http_redirect`](#https-http-redirect) - Optional Bool<br>HTTP Redirect to HTTPS. Redirect HTTP traffic to HTTPS
|
|
2960
2960
|
|
|
2961
|
-
<a id="https-non-default-loadbalancer"></a>• [`non_default_loadbalancer`](#https-non-default-loadbalancer) - Optional Block<br>
|
|
2961
|
+
<a id="https-non-default-loadbalancer"></a>• [`non_default_loadbalancer`](#https-non-default-loadbalancer) - Optional Block<br>Enable this option
|
|
2962
2962
|
|
|
2963
|
-
<a id="https-pass-through"></a>• [`pass_through`](#https-pass-through) - Optional Block<br>
|
|
2963
|
+
<a id="https-pass-through"></a>• [`pass_through`](#https-pass-through) - Optional Block<br>Enable this option
|
|
2964
2964
|
|
|
2965
2965
|
<a id="https-port"></a>• [`port`](#https-port) - Optional Number<br>HTTPS port to Listen
|
|
2966
2966
|
|
|
@@ -2976,9 +2976,9 @@ A [`https`](#https) block supports the following:
|
|
|
2976
2976
|
|
|
2977
2977
|
A [`coalescing_options`](#https-coalescing-options) block (within [`https`](#https)) supports the following:
|
|
2978
2978
|
|
|
2979
|
-
<a id="coalescing-f90c69"></a>• [`default_coalescing`](#coalescing-f90c69) - Optional Block<br>
|
|
2979
|
+
<a id="coalescing-f90c69"></a>• [`default_coalescing`](#coalescing-f90c69) - Optional Block<br>Enable this option
|
|
2980
2980
|
|
|
2981
|
-
<a id="coalescing-c5278e"></a>• [`strict_coalescing`](#coalescing-c5278e) - Optional Block<br>
|
|
2981
|
+
<a id="coalescing-c5278e"></a>• [`strict_coalescing`](#coalescing-c5278e) - Optional Block<br>Enable this option
|
|
2982
2982
|
|
|
2983
2983
|
#### HTTPS HTTP Protocol Options
|
|
2984
2984
|
|
|
@@ -2986,9 +2986,9 @@ A [`http_protocol_options`](#https-http-protocol-options) block (within [`https`
|
|
|
2986
2986
|
|
|
2987
2987
|
<a id="only-46f3ca"></a>• [`http_protocol_enable_v1_only`](#only-46f3ca) - Optional Block<br>HTTP/1.1 Protocol OPTIONS for downstream connections<br>See [HTTP Protocol Enable V1 Only](#only-46f3ca) below.
|
|
2988
2988
|
|
|
2989
|
-
<a id="v1-v2-6f8b9b"></a>• [`http_protocol_enable_v1_v2`](#v1-v2-6f8b9b) - Optional Block<br>
|
|
2989
|
+
<a id="v1-v2-6f8b9b"></a>• [`http_protocol_enable_v1_v2`](#v1-v2-6f8b9b) - Optional Block<br>Enable this option
|
|
2990
2990
|
|
|
2991
|
-
<a id="only-5cefb3"></a>• [`http_protocol_enable_v2_only`](#only-5cefb3) - Optional Block<br>
|
|
2991
|
+
<a id="only-5cefb3"></a>• [`http_protocol_enable_v2_only`](#only-5cefb3) - Optional Block<br>Enable this option
|
|
2992
2992
|
|
|
2993
2993
|
#### HTTPS HTTP Protocol Options HTTP Protocol Enable V1 Only
|
|
2994
2994
|
|
|
@@ -3004,7 +3004,7 @@ A [`tls_cert_params`](#https-tls-cert-params) block (within [`https`](#https)) s
|
|
|
3004
3004
|
|
|
3005
3005
|
<a id="https-tls-cert-params-certificates"></a>• [`certificates`](#https-tls-cert-params-certificates) - Optional Block<br>Select one or more certificates with any domain names<br>See [Certificates](#https-tls-cert-params-certificates) below.
|
|
3006
3006
|
|
|
3007
|
-
<a id="https-tls-cert-params-no-mtls"></a>• [`no_mtls`](#https-tls-cert-params-no-mtls) - Optional Block<br>
|
|
3007
|
+
<a id="https-tls-cert-params-no-mtls"></a>• [`no_mtls`](#https-tls-cert-params-no-mtls) - Optional Block<br>Enable this option
|
|
3008
3008
|
|
|
3009
3009
|
<a id="https-tls-cert-params-tls-config"></a>• [`tls_config`](#https-tls-cert-params-tls-config) - Optional Block<br>Defines various OPTIONS to configure TLS configuration parameters<br>See [TLS Config](#https-tls-cert-params-tls-config) below.
|
|
3010
3010
|
|
|
@@ -3026,11 +3026,11 @@ A [`tls_config`](#https-tls-cert-params-tls-config) block (within [`https.tls_ce
|
|
|
3026
3026
|
|
|
3027
3027
|
<a id="security-6452ce"></a>• [`custom_security`](#security-6452ce) - Optional Block<br>Defines TLS protocol config including min/max versions and allowed ciphers<br>See [Custom Security](#security-6452ce) below.
|
|
3028
3028
|
|
|
3029
|
-
<a id="security-b6db5a"></a>• [`default_security`](#security-b6db5a) - Optional Block<br>
|
|
3029
|
+
<a id="security-b6db5a"></a>• [`default_security`](#security-b6db5a) - Optional Block<br>Enable this option
|
|
3030
3030
|
|
|
3031
|
-
<a id="security-cbe12e"></a>• [`low_security`](#security-cbe12e) - Optional Block<br>
|
|
3031
|
+
<a id="security-cbe12e"></a>• [`low_security`](#security-cbe12e) - Optional Block<br>Enable this option
|
|
3032
3032
|
|
|
3033
|
-
<a id="security-e410e3"></a>• [`medium_security`](#security-e410e3) - Optional Block<br>
|
|
3033
|
+
<a id="security-e410e3"></a>• [`medium_security`](#security-e410e3) - Optional Block<br>Enable this option
|
|
3034
3034
|
|
|
3035
3035
|
#### HTTPS TLS Cert Params TLS Config Custom Security
|
|
3036
3036
|
|
|
@@ -3044,13 +3044,13 @@ An [`use_mtls`](#https-tls-cert-params-use-mtls) block (within [`https.tls_cert_
|
|
|
3044
3044
|
|
|
3045
3045
|
<a id="https-tls-cert-params-use-mtls-crl"></a>• [`crl`](#https-tls-cert-params-use-mtls-crl) - Optional Block<br>Type establishes a direct reference from one object(the referrer) to another(the referred). Such a reference is in form of tenant/namespace/name<br>See [CRL](#https-tls-cert-params-use-mtls-crl) below.
|
|
3046
3046
|
|
|
3047
|
-
<a id="https-tls-cert-params-use-mtls-no-crl"></a>• [`no_crl`](#https-tls-cert-params-use-mtls-no-crl) - Optional Block<br>
|
|
3047
|
+
<a id="https-tls-cert-params-use-mtls-no-crl"></a>• [`no_crl`](#https-tls-cert-params-use-mtls-no-crl) - Optional Block<br>Enable this option
|
|
3048
3048
|
|
|
3049
3049
|
<a id="trusted-ca-2ba851"></a>• [`trusted_ca`](#trusted-ca-2ba851) - Optional Block<br>Type establishes a direct reference from one object(the referrer) to another(the referred). Such a reference is in form of tenant/namespace/name<br>See [Trusted CA](#trusted-ca-2ba851) below.
|
|
3050
3050
|
|
|
3051
3051
|
<a id="url-2b1433"></a>• [`trusted_ca_url`](#url-2b1433) - Optional String<br>Upload a Root CA Certificate specifically for this Load Balancer
|
|
3052
3052
|
|
|
3053
|
-
<a id="disabled-bc6638"></a>• [`xfcc_disabled`](#disabled-bc6638) - Optional Block<br>
|
|
3053
|
+
<a id="disabled-bc6638"></a>• [`xfcc_disabled`](#disabled-bc6638) - Optional Block<br>Enable this option
|
|
3054
3054
|
|
|
3055
3055
|
<a id="options-8f161e"></a>• [`xfcc_options`](#options-8f161e) - Optional Block<br>X-Forwarded-Client-Cert header elements to be added to requests<br>See [Xfcc Options](#options-8f161e) below.
|
|
3056
3056
|
|
|
@@ -3076,7 +3076,7 @@ A [`crl`](#https-tls-cert-params-use-mtls-crl) block (within [`https.tls_cert_pa
|
|
|
3076
3076
|
|
|
3077
3077
|
A [`tls_parameters`](#https-tls-parameters) block (within [`https`](#https)) supports the following:
|
|
3078
3078
|
|
|
3079
|
-
<a id="https-tls-parameters-no-mtls"></a>• [`no_mtls`](#https-tls-parameters-no-mtls) - Optional Block<br>
|
|
3079
|
+
<a id="https-tls-parameters-no-mtls"></a>• [`no_mtls`](#https-tls-parameters-no-mtls) - Optional Block<br>Enable this option
|
|
3080
3080
|
|
|
3081
3081
|
<a id="https-tls-parameters-tls-certificates"></a>• [`tls_certificates`](#https-tls-parameters-tls-certificates) - Optional Block<br>Users can add one or more certificates that share the same set of domains. For example, domain.com and \*.domain.com - but use different signature algorithms<br>See [TLS Certificates](#https-tls-parameters-tls-certificates) below.
|
|
3082
3082
|
|
|
@@ -3094,11 +3094,11 @@ A [`tls_certificates`](#https-tls-parameters-tls-certificates) block (within [`h
|
|
|
3094
3094
|
|
|
3095
3095
|
<a id="spec-77c99c"></a>• [`description_spec`](#spec-77c99c) - Optional String<br>Description. Description for the certificate
|
|
3096
3096
|
|
|
3097
|
-
<a id="stapling-fd931a"></a>• [`disable_ocsp_stapling`](#stapling-fd931a) - Optional Block<br>
|
|
3097
|
+
<a id="stapling-fd931a"></a>• [`disable_ocsp_stapling`](#stapling-fd931a) - Optional Block<br>Enable this option
|
|
3098
3098
|
|
|
3099
3099
|
<a id="key-372460"></a>• [`private_key`](#key-372460) - Optional Block<br>SecretType is used in an object to indicate a sensitive/confidential field<br>See [Private Key](#key-372460) below.
|
|
3100
3100
|
|
|
3101
|
-
<a id="defaults-2777d9"></a>• [`use_system_defaults`](#defaults-2777d9) - Optional Block<br>
|
|
3101
|
+
<a id="defaults-2777d9"></a>• [`use_system_defaults`](#defaults-2777d9) - Optional Block<br>Enable this option
|
|
3102
3102
|
|
|
3103
3103
|
#### HTTPS TLS Parameters TLS Certificates Custom Hash Algorithms
|
|
3104
3104
|
|
|
@@ -3126,11 +3126,11 @@ A [`tls_config`](#https-tls-parameters-tls-config) block (within [`https.tls_par
|
|
|
3126
3126
|
|
|
3127
3127
|
<a id="security-775274"></a>• [`custom_security`](#security-775274) - Optional Block<br>Defines TLS protocol config including min/max versions and allowed ciphers<br>See [Custom Security](#security-775274) below.
|
|
3128
3128
|
|
|
3129
|
-
<a id="security-fd7aef"></a>• [`default_security`](#security-fd7aef) - Optional Block<br>
|
|
3129
|
+
<a id="security-fd7aef"></a>• [`default_security`](#security-fd7aef) - Optional Block<br>Enable this option
|
|
3130
3130
|
|
|
3131
|
-
<a id="security-c7d5df"></a>• [`low_security`](#security-c7d5df) - Optional Block<br>
|
|
3131
|
+
<a id="security-c7d5df"></a>• [`low_security`](#security-c7d5df) - Optional Block<br>Enable this option
|
|
3132
3132
|
|
|
3133
|
-
<a id="security-3f26ed"></a>• [`medium_security`](#security-3f26ed) - Optional Block<br>
|
|
3133
|
+
<a id="security-3f26ed"></a>• [`medium_security`](#security-3f26ed) - Optional Block<br>Enable this option
|
|
3134
3134
|
|
|
3135
3135
|
#### HTTPS TLS Parameters TLS Config Custom Security
|
|
3136
3136
|
|
|
@@ -3150,13 +3150,13 @@ An [`use_mtls`](#https-tls-parameters-use-mtls) block (within [`https.tls_parame
|
|
|
3150
3150
|
|
|
3151
3151
|
<a id="https-tls-parameters-use-mtls-crl"></a>• [`crl`](#https-tls-parameters-use-mtls-crl) - Optional Block<br>Type establishes a direct reference from one object(the referrer) to another(the referred). Such a reference is in form of tenant/namespace/name<br>See [CRL](#https-tls-parameters-use-mtls-crl) below.
|
|
3152
3152
|
|
|
3153
|
-
<a id="https-tls-parameters-use-mtls-no-crl"></a>• [`no_crl`](#https-tls-parameters-use-mtls-no-crl) - Optional Block<br>
|
|
3153
|
+
<a id="https-tls-parameters-use-mtls-no-crl"></a>• [`no_crl`](#https-tls-parameters-use-mtls-no-crl) - Optional Block<br>Enable this option
|
|
3154
3154
|
|
|
3155
3155
|
<a id="trusted-ca-264d37"></a>• [`trusted_ca`](#trusted-ca-264d37) - Optional Block<br>Type establishes a direct reference from one object(the referrer) to another(the referred). Such a reference is in form of tenant/namespace/name<br>See [Trusted CA](#trusted-ca-264d37) below.
|
|
3156
3156
|
|
|
3157
3157
|
<a id="url-bc2530"></a>• [`trusted_ca_url`](#url-bc2530) - Optional String<br>Upload a Root CA Certificate specifically for this Load Balancer
|
|
3158
3158
|
|
|
3159
|
-
<a id="disabled-5c360d"></a>• [`xfcc_disabled`](#disabled-5c360d) - Optional Block<br>
|
|
3159
|
+
<a id="disabled-5c360d"></a>• [`xfcc_disabled`](#disabled-5c360d) - Optional Block<br>Enable this option
|
|
3160
3160
|
|
|
3161
3161
|
<a id="options-4d1e53"></a>• [`xfcc_options`](#options-4d1e53) - Optional Block<br>X-Forwarded-Client-Cert header elements to be added to requests<br>See [Xfcc Options](#options-4d1e53) below.
|
|
3162
3162
|
|
|
@@ -3198,23 +3198,23 @@ A [`https_auto_cert`](#https-auto-cert) block supports the following:
|
|
|
3198
3198
|
|
|
3199
3199
|
<a id="https-auto-cert-connection-idle-timeout"></a>• [`connection_idle_timeout`](#https-auto-cert-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
|
|
3200
3200
|
|
|
3201
|
-
<a id="https-auto-cert-default-header"></a>• [`default_header`](#https-auto-cert-default-header) - Optional Block<br>
|
|
3201
|
+
<a id="https-auto-cert-default-header"></a>• [`default_header`](#https-auto-cert-default-header) - Optional Block<br>Enable this option
|
|
3202
3202
|
|
|
3203
|
-
<a id="https-auto-cert-default-loadbalancer"></a>• [`default_loadbalancer`](#https-auto-cert-default-loadbalancer) - Optional Block<br>
|
|
3203
|
+
<a id="https-auto-cert-default-loadbalancer"></a>• [`default_loadbalancer`](#https-auto-cert-default-loadbalancer) - Optional Block<br>Enable this option
|
|
3204
3204
|
|
|
3205
|
-
<a id="https-auto-cert-disable-path-normalize"></a>• [`disable_path_normalize`](#https-auto-cert-disable-path-normalize) - Optional Block<br>
|
|
3205
|
+
<a id="https-auto-cert-disable-path-normalize"></a>• [`disable_path_normalize`](#https-auto-cert-disable-path-normalize) - Optional Block<br>Enable this option
|
|
3206
3206
|
|
|
3207
|
-
<a id="https-auto-cert-enable-path-normalize"></a>• [`enable_path_normalize`](#https-auto-cert-enable-path-normalize) - Optional Block<br>
|
|
3207
|
+
<a id="https-auto-cert-enable-path-normalize"></a>• [`enable_path_normalize`](#https-auto-cert-enable-path-normalize) - Optional Block<br>Enable this option
|
|
3208
3208
|
|
|
3209
3209
|
<a id="https-auto-cert-http-protocol-options"></a>• [`http_protocol_options`](#https-auto-cert-http-protocol-options) - Optional Block<br>HTTP protocol configuration OPTIONS for downstream connections<br>See [HTTP Protocol Options](#https-auto-cert-http-protocol-options) below.
|
|
3210
3210
|
|
|
3211
3211
|
<a id="https-auto-cert-http-redirect"></a>• [`http_redirect`](#https-auto-cert-http-redirect) - Optional Bool<br>HTTP Redirect to HTTPS. Redirect HTTP traffic to HTTPS
|
|
3212
3212
|
|
|
3213
|
-
<a id="https-auto-cert-no-mtls"></a>• [`no_mtls`](#https-auto-cert-no-mtls) - Optional Block<br>
|
|
3213
|
+
<a id="https-auto-cert-no-mtls"></a>• [`no_mtls`](#https-auto-cert-no-mtls) - Optional Block<br>Enable this option
|
|
3214
3214
|
|
|
3215
|
-
<a id="loadbalancer-eb605c"></a>• [`non_default_loadbalancer`](#loadbalancer-eb605c) - Optional Block<br>
|
|
3215
|
+
<a id="loadbalancer-eb605c"></a>• [`non_default_loadbalancer`](#loadbalancer-eb605c) - Optional Block<br>Enable this option
|
|
3216
3216
|
|
|
3217
|
-
<a id="https-auto-cert-pass-through"></a>• [`pass_through`](#https-auto-cert-pass-through) - Optional Block<br>
|
|
3217
|
+
<a id="https-auto-cert-pass-through"></a>• [`pass_through`](#https-auto-cert-pass-through) - Optional Block<br>Enable this option
|
|
3218
3218
|
|
|
3219
3219
|
<a id="https-auto-cert-port"></a>• [`port`](#https-auto-cert-port) - Optional Number<br>HTTPS port to Listen
|
|
3220
3220
|
|
|
@@ -3230,9 +3230,9 @@ A [`https_auto_cert`](#https-auto-cert) block supports the following:
|
|
|
3230
3230
|
|
|
3231
3231
|
A [`coalescing_options`](#https-auto-cert-coalescing-options) block (within [`https_auto_cert`](#https-auto-cert)) supports the following:
|
|
3232
3232
|
|
|
3233
|
-
<a id="coalescing-3c2270"></a>• [`default_coalescing`](#coalescing-3c2270) - Optional Block<br>
|
|
3233
|
+
<a id="coalescing-3c2270"></a>• [`default_coalescing`](#coalescing-3c2270) - Optional Block<br>Enable this option
|
|
3234
3234
|
|
|
3235
|
-
<a id="coalescing-010f02"></a>• [`strict_coalescing`](#coalescing-010f02) - Optional Block<br>
|
|
3235
|
+
<a id="coalescing-010f02"></a>• [`strict_coalescing`](#coalescing-010f02) - Optional Block<br>Enable this option
|
|
3236
3236
|
|
|
3237
3237
|
#### HTTPS Auto Cert HTTP Protocol Options
|
|
3238
3238
|
|
|
@@ -3240,9 +3240,9 @@ A [`http_protocol_options`](#https-auto-cert-http-protocol-options) block (withi
|
|
|
3240
3240
|
|
|
3241
3241
|
<a id="only-d515de"></a>• [`http_protocol_enable_v1_only`](#only-d515de) - Optional Block<br>HTTP/1.1 Protocol OPTIONS for downstream connections<br>See [HTTP Protocol Enable V1 Only](#only-d515de) below.
|
|
3242
3242
|
|
|
3243
|
-
<a id="v1-v2-9e0811"></a>• [`http_protocol_enable_v1_v2`](#v1-v2-9e0811) - Optional Block<br>
|
|
3243
|
+
<a id="v1-v2-9e0811"></a>• [`http_protocol_enable_v1_v2`](#v1-v2-9e0811) - Optional Block<br>Enable this option
|
|
3244
3244
|
|
|
3245
|
-
<a id="only-65e5e2"></a>• [`http_protocol_enable_v2_only`](#only-65e5e2) - Optional Block<br>
|
|
3245
|
+
<a id="only-65e5e2"></a>• [`http_protocol_enable_v2_only`](#only-65e5e2) - Optional Block<br>Enable this option
|
|
3246
3246
|
|
|
3247
3247
|
#### HTTPS Auto Cert HTTP Protocol Options HTTP Protocol Enable V1 Only
|
|
3248
3248
|
|
|
@@ -3258,11 +3258,11 @@ A [`tls_config`](#https-auto-cert-tls-config) block (within [`https_auto_cert`](
|
|
|
3258
3258
|
|
|
3259
3259
|
<a id="security-7a53da"></a>• [`custom_security`](#security-7a53da) - Optional Block<br>Defines TLS protocol config including min/max versions and allowed ciphers<br>See [Custom Security](#security-7a53da) below.
|
|
3260
3260
|
|
|
3261
|
-
<a id="security-121c52"></a>• [`default_security`](#security-121c52) - Optional Block<br>
|
|
3261
|
+
<a id="security-121c52"></a>• [`default_security`](#security-121c52) - Optional Block<br>Enable this option
|
|
3262
3262
|
|
|
3263
|
-
<a id="https-auto-cert-tls-config-low-security"></a>• [`low_security`](#https-auto-cert-tls-config-low-security) - Optional Block<br>
|
|
3263
|
+
<a id="https-auto-cert-tls-config-low-security"></a>• [`low_security`](#https-auto-cert-tls-config-low-security) - Optional Block<br>Enable this option
|
|
3264
3264
|
|
|
3265
|
-
<a id="security-5e1ea1"></a>• [`medium_security`](#security-5e1ea1) - Optional Block<br>
|
|
3265
|
+
<a id="security-5e1ea1"></a>• [`medium_security`](#security-5e1ea1) - Optional Block<br>Enable this option
|
|
3266
3266
|
|
|
3267
3267
|
#### HTTPS Auto Cert TLS Config Custom Security
|
|
3268
3268
|
|
|
@@ -3282,13 +3282,13 @@ An [`use_mtls`](#https-auto-cert-use-mtls) block (within [`https_auto_cert`](#ht
|
|
|
3282
3282
|
|
|
3283
3283
|
<a id="https-auto-cert-use-mtls-crl"></a>• [`crl`](#https-auto-cert-use-mtls-crl) - Optional Block<br>Type establishes a direct reference from one object(the referrer) to another(the referred). Such a reference is in form of tenant/namespace/name<br>See [CRL](#https-auto-cert-use-mtls-crl) below.
|
|
3284
3284
|
|
|
3285
|
-
<a id="https-auto-cert-use-mtls-no-crl"></a>• [`no_crl`](#https-auto-cert-use-mtls-no-crl) - Optional Block<br>
|
|
3285
|
+
<a id="https-auto-cert-use-mtls-no-crl"></a>• [`no_crl`](#https-auto-cert-use-mtls-no-crl) - Optional Block<br>Enable this option
|
|
3286
3286
|
|
|
3287
3287
|
<a id="https-auto-cert-use-mtls-trusted-ca"></a>• [`trusted_ca`](#https-auto-cert-use-mtls-trusted-ca) - Optional Block<br>Type establishes a direct reference from one object(the referrer) to another(the referred). Such a reference is in form of tenant/namespace/name<br>See [Trusted CA](#https-auto-cert-use-mtls-trusted-ca) below.
|
|
3288
3288
|
|
|
3289
3289
|
<a id="https-auto-cert-use-mtls-trusted-ca-url"></a>• [`trusted_ca_url`](#https-auto-cert-use-mtls-trusted-ca-url) - Optional String<br>Upload a Root CA Certificate specifically for this Load Balancer
|
|
3290
3290
|
|
|
3291
|
-
<a id="https-auto-cert-use-mtls-xfcc-disabled"></a>• [`xfcc_disabled`](#https-auto-cert-use-mtls-xfcc-disabled) - Optional Block<br>
|
|
3291
|
+
<a id="https-auto-cert-use-mtls-xfcc-disabled"></a>• [`xfcc_disabled`](#https-auto-cert-use-mtls-xfcc-disabled) - Optional Block<br>Enable this option
|
|
3292
3292
|
|
|
3293
3293
|
<a id="https-auto-cert-use-mtls-xfcc-options"></a>• [`xfcc_options`](#https-auto-cert-use-mtls-xfcc-options) - Optional Block<br>X-Forwarded-Client-Cert header elements to be added to requests<br>See [Xfcc Options](#https-auto-cert-use-mtls-xfcc-options) below.
|
|
3294
3294
|
|
|
@@ -3348,9 +3348,9 @@ A [`jwt_validation`](#jwt-validation) block supports the following:
|
|
|
3348
3348
|
|
|
3349
3349
|
An [`action`](#jwt-validation-action) block (within [`jwt_validation`](#jwt-validation)) supports the following:
|
|
3350
3350
|
|
|
3351
|
-
<a id="jwt-validation-action-block"></a>• [`block`](#jwt-validation-action-block) - Optional Block<br>
|
|
3351
|
+
<a id="jwt-validation-action-block"></a>• [`block`](#jwt-validation-action-block) - Optional Block<br>Enable this option
|
|
3352
3352
|
|
|
3353
|
-
<a id="jwt-validation-action-report"></a>• [`report`](#jwt-validation-action-report) - Optional Block<br>
|
|
3353
|
+
<a id="jwt-validation-action-report"></a>• [`report`](#jwt-validation-action-report) - Optional Block<br>Enable this option
|
|
3354
3354
|
|
|
3355
3355
|
#### JWT Validation Jwks Config
|
|
3356
3356
|
|
|
@@ -3370,15 +3370,15 @@ A [`reserved_claims`](#jwt-validation-reserved-claims) block (within [`jwt_valid
|
|
|
3370
3370
|
|
|
3371
3371
|
<a id="jwt-validation-reserved-claims-audience"></a>• [`audience`](#jwt-validation-reserved-claims-audience) - Optional Block<br>Audiences<br>See [Audience](#jwt-validation-reserved-claims-audience) below.
|
|
3372
3372
|
|
|
3373
|
-
<a id="disable-dcfb50"></a>• [`audience_disable`](#disable-dcfb50) - Optional Block<br>
|
|
3373
|
+
<a id="disable-dcfb50"></a>• [`audience_disable`](#disable-dcfb50) - Optional Block<br>Enable this option
|
|
3374
3374
|
|
|
3375
3375
|
<a id="jwt-validation-reserved-claims-issuer"></a>• [`issuer`](#jwt-validation-reserved-claims-issuer) - Optional String<br>Exact Match
|
|
3376
3376
|
|
|
3377
|
-
<a id="disable-c89c1c"></a>• [`issuer_disable`](#disable-c89c1c) - Optional Block<br>
|
|
3377
|
+
<a id="disable-c89c1c"></a>• [`issuer_disable`](#disable-c89c1c) - Optional Block<br>Enable this option
|
|
3378
3378
|
|
|
3379
|
-
<a id="disable-5d3cb1"></a>• [`validate_period_disable`](#disable-5d3cb1) - Optional Block<br>
|
|
3379
|
+
<a id="disable-5d3cb1"></a>• [`validate_period_disable`](#disable-5d3cb1) - Optional Block<br>Enable this option
|
|
3380
3380
|
|
|
3381
|
-
<a id="enable-66243b"></a>• [`validate_period_enable`](#enable-66243b) - Optional Block<br>
|
|
3381
|
+
<a id="enable-66243b"></a>• [`validate_period_enable`](#enable-66243b) - Optional Block<br>Enable this option
|
|
3382
3382
|
|
|
3383
3383
|
#### JWT Validation Reserved Claims Audience
|
|
3384
3384
|
|
|
@@ -3390,7 +3390,7 @@ An [`audience`](#jwt-validation-reserved-claims-audience) block (within [`jwt_va
|
|
|
3390
3390
|
|
|
3391
3391
|
A [`target`](#jwt-validation-target) block (within [`jwt_validation`](#jwt-validation)) supports the following:
|
|
3392
3392
|
|
|
3393
|
-
<a id="jwt-validation-target-all-endpoint"></a>• [`all_endpoint`](#jwt-validation-target-all-endpoint) - Optional Block<br>
|
|
3393
|
+
<a id="jwt-validation-target-all-endpoint"></a>• [`all_endpoint`](#jwt-validation-target-all-endpoint) - Optional Block<br>Enable this option
|
|
3394
3394
|
|
|
3395
3395
|
<a id="jwt-validation-target-api-groups"></a>• [`api_groups`](#jwt-validation-target-api-groups) - Optional Block<br>API Groups<br>See [API Groups](#jwt-validation-target-api-groups) below.
|
|
3396
3396
|
|
|
@@ -3412,7 +3412,7 @@ A [`base_paths`](#jwt-validation-target-base-paths) block (within [`jwt_validati
|
|
|
3412
3412
|
|
|
3413
3413
|
A [`token_location`](#jwt-validation-token-location) block (within [`jwt_validation`](#jwt-validation)) supports the following:
|
|
3414
3414
|
|
|
3415
|
-
<a id="token-e5c0e3"></a>• [`bearer_token`](#token-e5c0e3) - Optional Block<br>
|
|
3415
|
+
<a id="token-e5c0e3"></a>• [`bearer_token`](#token-e5c0e3) - Optional Block<br>Enable this option
|
|
3416
3416
|
|
|
3417
3417
|
#### L7 DDOS Action Js Challenge
|
|
3418
3418
|
|
|
@@ -3432,15 +3432,15 @@ A [`l7_ddos_protection`](#l7-ddos-protection) block supports the following:
|
|
|
3432
3432
|
|
|
3433
3433
|
<a id="challenge-1070c2"></a>• [`clientside_action_js_challenge`](#challenge-1070c2) - 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 [Clientside Action Js Challenge](#challenge-1070c2) below.
|
|
3434
3434
|
|
|
3435
|
-
<a id="none-88961b"></a>• [`clientside_action_none`](#none-88961b) - Optional Block<br>
|
|
3435
|
+
<a id="none-88961b"></a>• [`clientside_action_none`](#none-88961b) - Optional Block<br>Enable this option
|
|
3436
3436
|
|
|
3437
3437
|
<a id="l7-ddos-protection-ddos-policy-custom"></a>• [`ddos_policy_custom`](#l7-ddos-protection-ddos-policy-custom) - Optional Block<br>Type establishes a direct reference from one object(the referrer) to another(the referred). Such a reference is in form of tenant/namespace/name<br>See [DDOS Policy Custom](#l7-ddos-protection-ddos-policy-custom) below.
|
|
3438
3438
|
|
|
3439
|
-
<a id="l7-ddos-protection-ddos-policy-none"></a>• [`ddos_policy_none`](#l7-ddos-protection-ddos-policy-none) - Optional Block<br>
|
|
3439
|
+
<a id="l7-ddos-protection-ddos-policy-none"></a>• [`ddos_policy_none`](#l7-ddos-protection-ddos-policy-none) - Optional Block<br>Enable this option
|
|
3440
3440
|
|
|
3441
|
-
<a id="threshold-332758"></a>• [`default_rps_threshold`](#threshold-332758) - Optional Block<br>
|
|
3441
|
+
<a id="threshold-332758"></a>• [`default_rps_threshold`](#threshold-332758) - Optional Block<br>Enable this option
|
|
3442
3442
|
|
|
3443
|
-
<a id="l7-ddos-protection-mitigation-block"></a>• [`mitigation_block`](#l7-ddos-protection-mitigation-block) - Optional Block<br>
|
|
3443
|
+
<a id="l7-ddos-protection-mitigation-block"></a>• [`mitigation_block`](#l7-ddos-protection-mitigation-block) - Optional Block<br>Enable this option
|
|
3444
3444
|
|
|
3445
3445
|
<a id="challenge-62fb67"></a>• [`mitigation_captcha_challenge`](#challenge-62fb67) - 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 [Mitigation Captcha Challenge](#challenge-62fb67) below.
|
|
3446
3446
|
|
|
@@ -3518,15 +3518,15 @@ A [`malware_protection_rules`](#rules-b2bf3e) block (within [`malware_protection
|
|
|
3518
3518
|
|
|
3519
3519
|
An [`action`](#action-f0dc04) block (within [`malware_protection_settings.malware_protection_rules`](#rules-b2bf3e)) supports the following:
|
|
3520
3520
|
|
|
3521
|
-
<a id="block-97253f"></a>• [`block`](#block-97253f) - Optional Block<br>
|
|
3521
|
+
<a id="block-97253f"></a>• [`block`](#block-97253f) - Optional Block<br>Enable this option
|
|
3522
3522
|
|
|
3523
|
-
<a id="report-055d2b"></a>• [`report`](#report-055d2b) - Optional Block<br>
|
|
3523
|
+
<a id="report-055d2b"></a>• [`report`](#report-055d2b) - Optional Block<br>Enable this option
|
|
3524
3524
|
|
|
3525
3525
|
#### Malware Protection Settings Malware Protection Rules Domain
|
|
3526
3526
|
|
|
3527
3527
|
A [`domain`](#domain-7b5aea) block (within [`malware_protection_settings.malware_protection_rules`](#rules-b2bf3e)) supports the following:
|
|
3528
3528
|
|
|
3529
|
-
<a id="domain-5794b8"></a>• [`any_domain`](#domain-5794b8) - Optional Block<br>
|
|
3529
|
+
<a id="domain-5794b8"></a>• [`any_domain`](#domain-5794b8) - Optional Block<br>Enable this option
|
|
3530
3530
|
|
|
3531
3531
|
<a id="domain-168628"></a>• [`domain`](#domain-168628) - Optional Block<br>Domains. Domains names<br>See [Domain](#domain-168628) below.
|
|
3532
3532
|
|
|
@@ -3564,9 +3564,9 @@ A [`more_option`](#more-option) block supports the following:
|
|
|
3564
3564
|
|
|
3565
3565
|
<a id="more-option-disable-default-error-pages"></a>• [`disable_default_error_pages`](#more-option-disable-default-error-pages) - Optional Bool<br>Disable the use of default F5XC error pages
|
|
3566
3566
|
|
|
3567
|
-
<a id="more-option-disable-path-normalize"></a>• [`disable_path_normalize`](#more-option-disable-path-normalize) - Optional Block<br>
|
|
3567
|
+
<a id="more-option-disable-path-normalize"></a>• [`disable_path_normalize`](#more-option-disable-path-normalize) - Optional Block<br>Enable this option
|
|
3568
3568
|
|
|
3569
|
-
<a id="more-option-enable-path-normalize"></a>• [`enable_path_normalize`](#more-option-enable-path-normalize) - Optional Block<br>
|
|
3569
|
+
<a id="more-option-enable-path-normalize"></a>• [`enable_path_normalize`](#more-option-enable-path-normalize) - Optional Block<br>Enable this option
|
|
3570
3570
|
|
|
3571
3571
|
<a id="more-option-idle-timeout"></a>• [`idle_timeout`](#more-option-idle-timeout) - Optional Number<br>The amount of time that a stream can exist without upstream or downstream activity, in milliseconds. The stream is terminated with a HTTP 504 (Gateway Timeout) error code if no upstream response header has been received, otherwise the stream is reset
|
|
3572
3572
|
|
|
@@ -3664,31 +3664,31 @@ A [`response_cookies_to_add`](#more-option-response-cookies-to-add) block (withi
|
|
|
3664
3664
|
|
|
3665
3665
|
<a id="expiry-5d54ee"></a>• [`add_expiry`](#expiry-5d54ee) - Optional String<br>Add expiry attribute
|
|
3666
3666
|
|
|
3667
|
-
<a id="httponly-8439bf"></a>• [`add_httponly`](#httponly-8439bf) - Optional Block<br>
|
|
3667
|
+
<a id="httponly-8439bf"></a>• [`add_httponly`](#httponly-8439bf) - Optional Block<br>Enable this option
|
|
3668
3668
|
|
|
3669
|
-
<a id="partitioned-781e49"></a>• [`add_partitioned`](#partitioned-781e49) - Optional Block<br>
|
|
3669
|
+
<a id="partitioned-781e49"></a>• [`add_partitioned`](#partitioned-781e49) - Optional Block<br>Enable this option
|
|
3670
3670
|
|
|
3671
3671
|
<a id="path-e18695"></a>• [`add_path`](#path-e18695) - Optional String<br>Add path attribute
|
|
3672
3672
|
|
|
3673
|
-
<a id="secure-e3baa0"></a>• [`add_secure`](#secure-e3baa0) - Optional Block<br>
|
|
3673
|
+
<a id="secure-e3baa0"></a>• [`add_secure`](#secure-e3baa0) - Optional Block<br>Enable this option
|
|
3674
3674
|
|
|
3675
|
-
<a id="domain-6328c3"></a>• [`ignore_domain`](#domain-6328c3) - Optional Block<br>
|
|
3675
|
+
<a id="domain-6328c3"></a>• [`ignore_domain`](#domain-6328c3) - Optional Block<br>Enable this option
|
|
3676
3676
|
|
|
3677
|
-
<a id="expiry-49396f"></a>• [`ignore_expiry`](#expiry-49396f) - Optional Block<br>
|
|
3677
|
+
<a id="expiry-49396f"></a>• [`ignore_expiry`](#expiry-49396f) - Optional Block<br>Enable this option
|
|
3678
3678
|
|
|
3679
|
-
<a id="httponly-6fac42"></a>• [`ignore_httponly`](#httponly-6fac42) - Optional Block<br>
|
|
3679
|
+
<a id="httponly-6fac42"></a>• [`ignore_httponly`](#httponly-6fac42) - Optional Block<br>Enable this option
|
|
3680
3680
|
|
|
3681
|
-
<a id="age-d6a859"></a>• [`ignore_max_age`](#age-d6a859) - Optional Block<br>
|
|
3681
|
+
<a id="age-d6a859"></a>• [`ignore_max_age`](#age-d6a859) - Optional Block<br>Enable this option
|
|
3682
3682
|
|
|
3683
|
-
<a id="partitioned-f4bce0"></a>• [`ignore_partitioned`](#partitioned-f4bce0) - Optional Block<br>
|
|
3683
|
+
<a id="partitioned-f4bce0"></a>• [`ignore_partitioned`](#partitioned-f4bce0) - Optional Block<br>Enable this option
|
|
3684
3684
|
|
|
3685
|
-
<a id="path-f6b7e0"></a>• [`ignore_path`](#path-f6b7e0) - Optional Block<br>
|
|
3685
|
+
<a id="path-f6b7e0"></a>• [`ignore_path`](#path-f6b7e0) - Optional Block<br>Enable this option
|
|
3686
3686
|
|
|
3687
|
-
<a id="samesite-aceec3"></a>• [`ignore_samesite`](#samesite-aceec3) - Optional Block<br>
|
|
3687
|
+
<a id="samesite-aceec3"></a>• [`ignore_samesite`](#samesite-aceec3) - Optional Block<br>Enable this option
|
|
3688
3688
|
|
|
3689
|
-
<a id="secure-fe1099"></a>• [`ignore_secure`](#secure-fe1099) - Optional Block<br>
|
|
3689
|
+
<a id="secure-fe1099"></a>• [`ignore_secure`](#secure-fe1099) - Optional Block<br>Enable this option
|
|
3690
3690
|
|
|
3691
|
-
<a id="value-bbe342"></a>• [`ignore_value`](#value-bbe342) - Optional Block<br>
|
|
3691
|
+
<a id="value-bbe342"></a>• [`ignore_value`](#value-bbe342) - Optional Block<br>Enable this option
|
|
3692
3692
|
|
|
3693
3693
|
<a id="value-cb17ee"></a>• [`max_age_value`](#value-cb17ee) - Optional Number<br>Add max age attribute
|
|
3694
3694
|
|
|
@@ -3696,11 +3696,11 @@ A [`response_cookies_to_add`](#more-option-response-cookies-to-add) block (withi
|
|
|
3696
3696
|
|
|
3697
3697
|
<a id="overwrite-16498a"></a>• [`overwrite`](#overwrite-16498a) - Optional Bool Defaults to `do`<br>Should the value be overwritten? If true, the value is overwritten to existing values. not overwrite
|
|
3698
3698
|
|
|
3699
|
-
<a id="lax-9d99f8"></a>• [`samesite_lax`](#lax-9d99f8) - Optional Block<br>
|
|
3699
|
+
<a id="lax-9d99f8"></a>• [`samesite_lax`](#lax-9d99f8) - Optional Block<br>Enable this option
|
|
3700
3700
|
|
|
3701
|
-
<a id="none-4de9cb"></a>• [`samesite_none`](#none-4de9cb) - Optional Block<br>
|
|
3701
|
+
<a id="none-4de9cb"></a>• [`samesite_none`](#none-4de9cb) - Optional Block<br>Enable this option
|
|
3702
3702
|
|
|
3703
|
-
<a id="strict-d87273"></a>• [`samesite_strict`](#strict-d87273) - Optional Block<br>
|
|
3703
|
+
<a id="strict-d87273"></a>• [`samesite_strict`](#strict-d87273) - Optional Block<br>Enable this option
|
|
3704
3704
|
|
|
3705
3705
|
<a id="value-3191e4"></a>• [`secret_value`](#value-3191e4) - Optional Block<br>SecretType is used in an object to indicate a sensitive/confidential field<br>See [Secret Value](#value-3191e4) below.
|
|
3706
3706
|
|
|
@@ -3788,25 +3788,25 @@ An [`origin_server_subset_rule_list`](#origin-server-subset-rule-list) block sup
|
|
|
3788
3788
|
|
|
3789
3789
|
A [`policy_based_challenge`](#policy-based-challenge) block supports the following:
|
|
3790
3790
|
|
|
3791
|
-
<a id="challenge-a53c7e"></a>• [`always_enable_captcha_challenge`](#challenge-a53c7e) - Optional Block<br>
|
|
3791
|
+
<a id="challenge-a53c7e"></a>• [`always_enable_captcha_challenge`](#challenge-a53c7e) - Optional Block<br>Enable this option
|
|
3792
3792
|
|
|
3793
|
-
<a id="challenge-3ba035"></a>• [`always_enable_js_challenge`](#challenge-3ba035) - Optional Block<br>
|
|
3793
|
+
<a id="challenge-3ba035"></a>• [`always_enable_js_challenge`](#challenge-3ba035) - Optional Block<br>Enable this option
|
|
3794
3794
|
|
|
3795
3795
|
<a id="parameters-699e87"></a>• [`captcha_challenge_parameters`](#parameters-699e87) - 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 Parameters](#parameters-699e87) below.
|
|
3796
3796
|
|
|
3797
|
-
<a id="parameters-1afe14"></a>• [`default_captcha_challenge_parameters`](#parameters-1afe14) - Optional Block<br>
|
|
3797
|
+
<a id="parameters-1afe14"></a>• [`default_captcha_challenge_parameters`](#parameters-1afe14) - Optional Block<br>Enable this option
|
|
3798
3798
|
|
|
3799
|
-
<a id="parameters-d11492"></a>• [`default_js_challenge_parameters`](#parameters-d11492) - Optional Block<br>
|
|
3799
|
+
<a id="parameters-d11492"></a>• [`default_js_challenge_parameters`](#parameters-d11492) - Optional Block<br>Enable this option
|
|
3800
3800
|
|
|
3801
|
-
<a id="settings-3c8e74"></a>• [`default_mitigation_settings`](#settings-3c8e74) - Optional Block<br>
|
|
3801
|
+
<a id="settings-3c8e74"></a>• [`default_mitigation_settings`](#settings-3c8e74) - Optional Block<br>Enable this option
|
|
3802
3802
|
|
|
3803
|
-
<a id="parameters-f17f1a"></a>• [`default_temporary_blocking_parameters`](#parameters-f17f1a) - Optional Block<br>
|
|
3803
|
+
<a id="parameters-f17f1a"></a>• [`default_temporary_blocking_parameters`](#parameters-f17f1a) - Optional Block<br>Enable this option
|
|
3804
3804
|
|
|
3805
3805
|
<a id="parameters-65055e"></a>• [`js_challenge_parameters`](#parameters-65055e) - 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 Parameters](#parameters-65055e) below.
|
|
3806
3806
|
|
|
3807
3807
|
<a id="mitigation-d19aea"></a>• [`malicious_user_mitigation`](#mitigation-d19aea) - Optional Block<br>Type establishes a direct reference from one object(the referrer) to another(the referred). Such a reference is in form of tenant/namespace/name<br>See [Malicious User Mitigation](#mitigation-d19aea) below.
|
|
3808
3808
|
|
|
3809
|
-
<a id="policy-based-challenge-no-challenge"></a>• [`no_challenge`](#policy-based-challenge-no-challenge) - Optional Block<br>
|
|
3809
|
+
<a id="policy-based-challenge-no-challenge"></a>• [`no_challenge`](#policy-based-challenge-no-challenge) - Optional Block<br>Enable this option
|
|
3810
3810
|
|
|
3811
3811
|
<a id="policy-based-challenge-rule-list"></a>• [`rule_list`](#policy-based-challenge-rule-list) - Optional Block<br>List of challenge rules to be used in policy based challenge<br>See [Rule List](#policy-based-challenge-rule-list) below.
|
|
3812
3812
|
|
|
@@ -3866,11 +3866,11 @@ A [`metadata`](#metadata-72ce94) block (within [`policy_based_challenge.rule_lis
|
|
|
3866
3866
|
|
|
3867
3867
|
A [`spec`](#spec-fbd0f9) block (within [`policy_based_challenge.rule_list.rules`](#policy-based-challenge-rule-list-rules)) supports the following:
|
|
3868
3868
|
|
|
3869
|
-
<a id="asn-cae05d"></a>• [`any_asn`](#asn-cae05d) - Optional Block<br>
|
|
3869
|
+
<a id="asn-cae05d"></a>• [`any_asn`](#asn-cae05d) - Optional Block<br>Enable this option
|
|
3870
3870
|
|
|
3871
|
-
<a id="client-df7cdb"></a>• [`any_client`](#client-df7cdb) - Optional Block<br>
|
|
3871
|
+
<a id="client-df7cdb"></a>• [`any_client`](#client-df7cdb) - Optional Block<br>Enable this option
|
|
3872
3872
|
|
|
3873
|
-
<a id="any-ip-6a2554"></a>• [`any_ip`](#any-ip-6a2554) - Optional Block<br>
|
|
3873
|
+
<a id="any-ip-6a2554"></a>• [`any_ip`](#any-ip-6a2554) - Optional Block<br>Enable this option
|
|
3874
3874
|
|
|
3875
3875
|
<a id="matchers-86dff2"></a>• [`arg_matchers`](#matchers-86dff2) - Optional Block<br>List of predicates for all POST args that need to be matched. The criteria for matching each arg are described in individual instances of ArgMatcherType. The actual arg values are extracted from the request API as a list of strings for each arg selector name<br>See [Arg Matchers](#matchers-86dff2) below.
|
|
3876
3876
|
|
|
@@ -3884,13 +3884,13 @@ A [`spec`](#spec-fbd0f9) block (within [`policy_based_challenge.rule_list.rules`
|
|
|
3884
3884
|
|
|
3885
3885
|
<a id="matchers-cb349b"></a>• [`cookie_matchers`](#matchers-cb349b) - Optional Block<br>List of predicates for all cookies that need to be matched. The criteria for matching each cookie is described in individual instances of CookieMatcherType. The actual cookie values are extracted from the request API as a list of strings for each cookie name<br>See [Cookie Matchers](#matchers-cb349b) below.
|
|
3886
3886
|
|
|
3887
|
-
<a id="challenge-fbd9a1"></a>• [`disable_challenge`](#challenge-fbd9a1) - Optional Block<br>
|
|
3887
|
+
<a id="challenge-fbd9a1"></a>• [`disable_challenge`](#challenge-fbd9a1) - Optional Block<br>Enable this option
|
|
3888
3888
|
|
|
3889
3889
|
<a id="matcher-888f5a"></a>• [`domain_matcher`](#matcher-888f5a) - Optional Block<br>Matcher specifies multiple criteria for matching an input string. The match is considered successful if any of the criteria are satisfied. The set of supported match criteria includes a list of exact values and a list of regular expressions<br>See [Domain Matcher](#matcher-888f5a) below.
|
|
3890
3890
|
|
|
3891
|
-
<a id="challenge-e0353b"></a>• [`enable_captcha_challenge`](#challenge-e0353b) - Optional Block<br>
|
|
3891
|
+
<a id="challenge-e0353b"></a>• [`enable_captcha_challenge`](#challenge-e0353b) - Optional Block<br>Enable this option
|
|
3892
3892
|
|
|
3893
|
-
<a id="challenge-3644c3"></a>• [`enable_javascript_challenge`](#challenge-3644c3) - Optional Block<br>
|
|
3893
|
+
<a id="challenge-3644c3"></a>• [`enable_javascript_challenge`](#challenge-3644c3) - Optional Block<br>Enable this option
|
|
3894
3894
|
|
|
3895
3895
|
<a id="timestamp-6d26e1"></a>• [`expiration_timestamp`](#timestamp-6d26e1) - Optional String<br>Specifies expiration_timestamp the RFC 3339 format timestamp at which the containing rule is considered to be logically expired. The rule continues to exist in the configuration but is not applied anymore
|
|
3896
3896
|
|
|
@@ -3998,31 +3998,31 @@ A [`temporary_user_blocking`](#blocking-9fdca7) block (within [`policy_based_cha
|
|
|
3998
3998
|
|
|
3999
3999
|
A [`protected_cookies`](#protected-cookies) block supports the following:
|
|
4000
4000
|
|
|
4001
|
-
<a id="protected-cookies-add-httponly"></a>• [`add_httponly`](#protected-cookies-add-httponly) - Optional Block<br>
|
|
4001
|
+
<a id="protected-cookies-add-httponly"></a>• [`add_httponly`](#protected-cookies-add-httponly) - Optional Block<br>Enable this option
|
|
4002
4002
|
|
|
4003
|
-
<a id="protected-cookies-add-secure"></a>• [`add_secure`](#protected-cookies-add-secure) - Optional Block<br>
|
|
4003
|
+
<a id="protected-cookies-add-secure"></a>• [`add_secure`](#protected-cookies-add-secure) - Optional Block<br>Enable this option
|
|
4004
4004
|
|
|
4005
|
-
<a id="protection-51c741"></a>• [`disable_tampering_protection`](#protection-51c741) - Optional Block<br>
|
|
4005
|
+
<a id="protection-51c741"></a>• [`disable_tampering_protection`](#protection-51c741) - Optional Block<br>Enable this option
|
|
4006
4006
|
|
|
4007
|
-
<a id="protection-d59c9f"></a>• [`enable_tampering_protection`](#protection-d59c9f) - Optional Block<br>
|
|
4007
|
+
<a id="protection-d59c9f"></a>• [`enable_tampering_protection`](#protection-d59c9f) - Optional Block<br>Enable this option
|
|
4008
4008
|
|
|
4009
|
-
<a id="protected-cookies-ignore-httponly"></a>• [`ignore_httponly`](#protected-cookies-ignore-httponly) - Optional Block<br>
|
|
4009
|
+
<a id="protected-cookies-ignore-httponly"></a>• [`ignore_httponly`](#protected-cookies-ignore-httponly) - Optional Block<br>Enable this option
|
|
4010
4010
|
|
|
4011
|
-
<a id="protected-cookies-ignore-max-age"></a>• [`ignore_max_age`](#protected-cookies-ignore-max-age) - Optional Block<br>
|
|
4011
|
+
<a id="protected-cookies-ignore-max-age"></a>• [`ignore_max_age`](#protected-cookies-ignore-max-age) - Optional Block<br>Enable this option
|
|
4012
4012
|
|
|
4013
|
-
<a id="protected-cookies-ignore-samesite"></a>• [`ignore_samesite`](#protected-cookies-ignore-samesite) - Optional Block<br>
|
|
4013
|
+
<a id="protected-cookies-ignore-samesite"></a>• [`ignore_samesite`](#protected-cookies-ignore-samesite) - Optional Block<br>Enable this option
|
|
4014
4014
|
|
|
4015
|
-
<a id="protected-cookies-ignore-secure"></a>• [`ignore_secure`](#protected-cookies-ignore-secure) - Optional Block<br>
|
|
4015
|
+
<a id="protected-cookies-ignore-secure"></a>• [`ignore_secure`](#protected-cookies-ignore-secure) - Optional Block<br>Enable this option
|
|
4016
4016
|
|
|
4017
4017
|
<a id="protected-cookies-max-age-value"></a>• [`max_age_value`](#protected-cookies-max-age-value) - Optional Number<br>Add max age attribute
|
|
4018
4018
|
|
|
4019
4019
|
<a id="protected-cookies-name"></a>• [`name`](#protected-cookies-name) - Optional String<br>Cookie Name. Name of the Cookie
|
|
4020
4020
|
|
|
4021
|
-
<a id="protected-cookies-samesite-lax"></a>• [`samesite_lax`](#protected-cookies-samesite-lax) - Optional Block<br>
|
|
4021
|
+
<a id="protected-cookies-samesite-lax"></a>• [`samesite_lax`](#protected-cookies-samesite-lax) - Optional Block<br>Enable this option
|
|
4022
4022
|
|
|
4023
|
-
<a id="protected-cookies-samesite-none"></a>• [`samesite_none`](#protected-cookies-samesite-none) - Optional Block<br>
|
|
4023
|
+
<a id="protected-cookies-samesite-none"></a>• [`samesite_none`](#protected-cookies-samesite-none) - Optional Block<br>Enable this option
|
|
4024
4024
|
|
|
4025
|
-
<a id="protected-cookies-samesite-strict"></a>• [`samesite_strict`](#protected-cookies-samesite-strict) - Optional Block<br>
|
|
4025
|
+
<a id="protected-cookies-samesite-strict"></a>• [`samesite_strict`](#protected-cookies-samesite-strict) - Optional Block<br>Enable this option
|
|
4026
4026
|
|
|
4027
4027
|
#### Rate Limit
|
|
4028
4028
|
|
|
@@ -4032,9 +4032,9 @@ A [`rate_limit`](#rate-limit) block supports the following:
|
|
|
4032
4032
|
|
|
4033
4033
|
<a id="rate-limit-ip-allowed-list"></a>• [`ip_allowed_list`](#rate-limit-ip-allowed-list) - Optional Block<br>List of IPv4 prefixes that represent an endpoint<br>See [IP Allowed List](#rate-limit-ip-allowed-list) below.
|
|
4034
4034
|
|
|
4035
|
-
<a id="rate-limit-no-ip-allowed-list"></a>• [`no_ip_allowed_list`](#rate-limit-no-ip-allowed-list) - Optional Block<br>
|
|
4035
|
+
<a id="rate-limit-no-ip-allowed-list"></a>• [`no_ip_allowed_list`](#rate-limit-no-ip-allowed-list) - Optional Block<br>Enable this option
|
|
4036
4036
|
|
|
4037
|
-
<a id="rate-limit-no-policies"></a>• [`no_policies`](#rate-limit-no-policies) - Optional Block<br>
|
|
4037
|
+
<a id="rate-limit-no-policies"></a>• [`no_policies`](#rate-limit-no-policies) - Optional Block<br>Enable this option
|
|
4038
4038
|
|
|
4039
4039
|
<a id="rate-limit-policies"></a>• [`policies`](#rate-limit-policies) - Optional Block<br>List of rate limiter policies to be applied<br>See [Policies](#rate-limit-policies) below.
|
|
4040
4040
|
|
|
@@ -4080,7 +4080,7 @@ A [`rate_limiter`](#rate-limit-rate-limiter) block (within [`rate_limit`](#rate-
|
|
|
4080
4080
|
|
|
4081
4081
|
<a id="multiplier-1bc2e7"></a>• [`burst_multiplier`](#multiplier-1bc2e7) - Optional Number<br>The maximum burst of requests to accommodate, expressed as a multiple of the rate
|
|
4082
4082
|
|
|
4083
|
-
<a id="rate-limit-rate-limiter-disabled"></a>• [`disabled`](#rate-limit-rate-limiter-disabled) - Optional Block<br>
|
|
4083
|
+
<a id="rate-limit-rate-limiter-disabled"></a>• [`disabled`](#rate-limit-rate-limiter-disabled) - Optional Block<br>Enable this option
|
|
4084
4084
|
|
|
4085
4085
|
<a id="rate-limit-rate-limiter-leaky-bucket"></a>• [`leaky_bucket`](#rate-limit-rate-limiter-leaky-bucket) - Optional Block<br>Leaky-Bucket is the default rate limiter algorithm for F5
|
|
4086
4086
|
|
|
@@ -4142,25 +4142,25 @@ A [`hash_policy`](#ring-hash-hash-policy) block (within [`ring_hash`](#ring-hash
|
|
|
4142
4142
|
|
|
4143
4143
|
A [`cookie`](#ring-hash-hash-policy-cookie) block (within [`ring_hash.hash_policy`](#ring-hash-hash-policy)) supports the following:
|
|
4144
4144
|
|
|
4145
|
-
<a id="httponly-54c45b"></a>• [`add_httponly`](#httponly-54c45b) - Optional Block<br>
|
|
4145
|
+
<a id="httponly-54c45b"></a>• [`add_httponly`](#httponly-54c45b) - Optional Block<br>Enable this option
|
|
4146
4146
|
|
|
4147
|
-
<a id="ring-hash-hash-policy-cookie-add-secure"></a>• [`add_secure`](#ring-hash-hash-policy-cookie-add-secure) - Optional Block<br>
|
|
4147
|
+
<a id="ring-hash-hash-policy-cookie-add-secure"></a>• [`add_secure`](#ring-hash-hash-policy-cookie-add-secure) - Optional Block<br>Enable this option
|
|
4148
4148
|
|
|
4149
|
-
<a id="httponly-7f2aea"></a>• [`ignore_httponly`](#httponly-7f2aea) - Optional Block<br>
|
|
4149
|
+
<a id="httponly-7f2aea"></a>• [`ignore_httponly`](#httponly-7f2aea) - Optional Block<br>Enable this option
|
|
4150
4150
|
|
|
4151
|
-
<a id="samesite-106140"></a>• [`ignore_samesite`](#samesite-106140) - Optional Block<br>
|
|
4151
|
+
<a id="samesite-106140"></a>• [`ignore_samesite`](#samesite-106140) - Optional Block<br>Enable this option
|
|
4152
4152
|
|
|
4153
|
-
<a id="secure-febf51"></a>• [`ignore_secure`](#secure-febf51) - Optional Block<br>
|
|
4153
|
+
<a id="secure-febf51"></a>• [`ignore_secure`](#secure-febf51) - Optional Block<br>Enable this option
|
|
4154
4154
|
|
|
4155
4155
|
<a id="ring-hash-hash-policy-cookie-name"></a>• [`name`](#ring-hash-hash-policy-cookie-name) - Optional String<br>The name of the cookie that will be used to obtain the hash key. If the cookie is not present and TTL below is not set, no hash will be produced
|
|
4156
4156
|
|
|
4157
4157
|
<a id="ring-hash-hash-policy-cookie-path"></a>• [`path`](#ring-hash-hash-policy-cookie-path) - Optional String<br>The name of the path for the cookie. If no path is specified here, no path will be set for the cookie
|
|
4158
4158
|
|
|
4159
|
-
<a id="lax-749b7e"></a>• [`samesite_lax`](#lax-749b7e) - Optional Block<br>
|
|
4159
|
+
<a id="lax-749b7e"></a>• [`samesite_lax`](#lax-749b7e) - Optional Block<br>Enable this option
|
|
4160
4160
|
|
|
4161
|
-
<a id="none-5bbed3"></a>• [`samesite_none`](#none-5bbed3) - Optional Block<br>
|
|
4161
|
+
<a id="none-5bbed3"></a>• [`samesite_none`](#none-5bbed3) - Optional Block<br>Enable this option
|
|
4162
4162
|
|
|
4163
|
-
<a id="strict-3e550d"></a>• [`samesite_strict`](#strict-3e550d) - Optional Block<br>
|
|
4163
|
+
<a id="strict-3e550d"></a>• [`samesite_strict`](#strict-3e550d) - Optional Block<br>Enable this option
|
|
4164
4164
|
|
|
4165
4165
|
<a id="ring-hash-hash-policy-cookie-ttl"></a>• [`ttl`](#ring-hash-hash-policy-cookie-ttl) - Optional Number<br>If specified, a cookie with the TTL will be generated if the cookie is not present. If the TTL is present and zero, the generated cookie will be a session cookie. TTL value is in milliseconds
|
|
4166
4166
|
|
|
@@ -4224,7 +4224,7 @@ A [`headers`](#routes-direct-response-route-headers) block (within [`routes.dire
|
|
|
4224
4224
|
|
|
4225
4225
|
An [`incoming_port`](#port-9bcff1) block (within [`routes.direct_response_route`](#routes-direct-response-route)) supports the following:
|
|
4226
4226
|
|
|
4227
|
-
<a id="match-ba3425"></a>• [`no_port_match`](#match-ba3425) - Optional Block<br>
|
|
4227
|
+
<a id="match-ba3425"></a>• [`no_port_match`](#match-ba3425) - Optional Block<br>Enable this option
|
|
4228
4228
|
|
|
4229
4229
|
<a id="port-9debaf"></a>• [`port`](#port-9debaf) - Optional Number<br>Exact Port to match
|
|
4230
4230
|
|
|
@@ -4280,7 +4280,7 @@ A [`headers`](#routes-redirect-route-headers) block (within [`routes.redirect_ro
|
|
|
4280
4280
|
|
|
4281
4281
|
An [`incoming_port`](#routes-redirect-route-incoming-port) block (within [`routes.redirect_route`](#routes-redirect-route)) supports the following:
|
|
4282
4282
|
|
|
4283
|
-
<a id="match-56f681"></a>• [`no_port_match`](#match-56f681) - Optional Block<br>
|
|
4283
|
+
<a id="match-56f681"></a>• [`no_port_match`](#match-56f681) - Optional Block<br>Enable this option
|
|
4284
4284
|
|
|
4285
4285
|
<a id="port-02a88d"></a>• [`port`](#port-02a88d) - Optional Number<br>Exact Port to match
|
|
4286
4286
|
|
|
@@ -4308,13 +4308,13 @@ A [`route_redirect`](#routes-redirect-route-route-redirect) block (within [`rout
|
|
|
4308
4308
|
|
|
4309
4309
|
<a id="redirect-f23979"></a>• [`proto_redirect`](#redirect-f23979) - Optional String<br>Swap protocol part of incoming URL in redirect URL The protocol can be swapped with either HTTP or HTTPS When incoming-proto option is specified, swapping of protocol is not done
|
|
4310
4310
|
|
|
4311
|
-
<a id="params-0941dc"></a>• [`remove_all_params`](#params-0941dc) - Optional Block<br>
|
|
4311
|
+
<a id="params-0941dc"></a>• [`remove_all_params`](#params-0941dc) - Optional Block<br>Enable this option
|
|
4312
4312
|
|
|
4313
4313
|
<a id="params-94a828"></a>• [`replace_params`](#params-94a828) - Optional String
|
|
4314
4314
|
|
|
4315
4315
|
<a id="code-d55c43"></a>• [`response_code`](#code-d55c43) - Optional Number<br>The HTTP status code to use in the redirect response
|
|
4316
4316
|
|
|
4317
|
-
<a id="params-f96588"></a>• [`retain_all_params`](#params-f96588) - Optional Block<br>
|
|
4317
|
+
<a id="params-f96588"></a>• [`retain_all_params`](#params-f96588) - Optional Block<br>Enable this option
|
|
4318
4318
|
|
|
4319
4319
|
#### Routes Simple Route
|
|
4320
4320
|
|
|
@@ -4322,9 +4322,9 @@ A [`simple_route`](#routes-simple-route) block (within [`routes`](#routes)) supp
|
|
|
4322
4322
|
|
|
4323
4323
|
<a id="routes-simple-route-advanced-options"></a>• [`advanced_options`](#routes-simple-route-advanced-options) - Optional Block<br>Configure advanced OPTIONS for route like path rewrite, hash policy, etc<br>See [Advanced Options](#routes-simple-route-advanced-options) below.
|
|
4324
4324
|
|
|
4325
|
-
<a id="routes-simple-route-auto-host-rewrite"></a>• [`auto_host_rewrite`](#routes-simple-route-auto-host-rewrite) - Optional Block<br>
|
|
4325
|
+
<a id="routes-simple-route-auto-host-rewrite"></a>• [`auto_host_rewrite`](#routes-simple-route-auto-host-rewrite) - Optional Block<br>Enable this option
|
|
4326
4326
|
|
|
4327
|
-
<a id="rewrite-706535"></a>• [`disable_host_rewrite`](#rewrite-706535) - Optional Block<br>
|
|
4327
|
+
<a id="rewrite-706535"></a>• [`disable_host_rewrite`](#rewrite-706535) - Optional Block<br>Enable this option
|
|
4328
4328
|
|
|
4329
4329
|
<a id="routes-simple-route-headers"></a>• [`headers`](#routes-simple-route-headers) - Optional Block<br>Headers. List of (key, value) headers<br>See [Headers](#routes-simple-route-headers) below.
|
|
4330
4330
|
|
|
@@ -4350,43 +4350,43 @@ An [`advanced_options`](#routes-simple-route-advanced-options) block (within [`r
|
|
|
4350
4350
|
|
|
4351
4351
|
<a id="policy-23a3f6"></a>• [`buffer_policy`](#policy-23a3f6) - 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](#policy-23a3f6) below.
|
|
4352
4352
|
|
|
4353
|
-
<a id="buffering-44c193"></a>• [`common_buffering`](#buffering-44c193) - Optional Block<br>
|
|
4353
|
+
<a id="buffering-44c193"></a>• [`common_buffering`](#buffering-44c193) - Optional Block<br>Enable this option
|
|
4354
4354
|
|
|
4355
|
-
<a id="policy-b912b0"></a>• [`common_hash_policy`](#policy-b912b0) - Optional Block<br>
|
|
4355
|
+
<a id="policy-b912b0"></a>• [`common_hash_policy`](#policy-b912b0) - Optional Block<br>Enable this option
|
|
4356
4356
|
|
|
4357
4357
|
<a id="policy-ba853e"></a>• [`cors_policy`](#policy-ba853e) - 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](#policy-ba853e) below.
|
|
4358
4358
|
|
|
4359
4359
|
<a id="policy-7816d7"></a>• [`csrf_policy`](#policy-7816d7) - 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](#policy-7816d7) below.
|
|
4360
4360
|
|
|
4361
|
-
<a id="policy-70b68a"></a>• [`default_retry_policy`](#policy-70b68a) - Optional Block<br>
|
|
4361
|
+
<a id="policy-70b68a"></a>• [`default_retry_policy`](#policy-70b68a) - Optional Block<br>Enable this option
|
|
4362
4362
|
|
|
4363
4363
|
<a id="add-11129b"></a>• [`disable_location_add`](#add-11129b) - Optional Bool<br>Disables append of x-F5 Distributed Cloud-location = `<RE-site-name>` at route level, if it is configured at virtual-host level. This configuration is ignored on CE sites
|
|
4364
4364
|
|
|
4365
|
-
<a id="mirroring-e37294"></a>• [`disable_mirroring`](#mirroring-e37294) - Optional Block<br>
|
|
4365
|
+
<a id="mirroring-e37294"></a>• [`disable_mirroring`](#mirroring-e37294) - Optional Block<br>Enable this option
|
|
4366
4366
|
|
|
4367
|
-
<a id="rewrite-8c52ee"></a>• [`disable_prefix_rewrite`](#rewrite-8c52ee) - Optional Block<br>
|
|
4367
|
+
<a id="rewrite-8c52ee"></a>• [`disable_prefix_rewrite`](#rewrite-8c52ee) - Optional Block<br>Enable this option
|
|
4368
4368
|
|
|
4369
|
-
<a id="spdy-c4a11a"></a>• [`disable_spdy`](#spdy-c4a11a) - Optional Block<br>
|
|
4369
|
+
<a id="spdy-c4a11a"></a>• [`disable_spdy`](#spdy-c4a11a) - Optional Block<br>Enable this option
|
|
4370
4370
|
|
|
4371
|
-
<a id="waf-afaac0"></a>• [`disable_waf`](#waf-afaac0) - Optional Block<br>
|
|
4371
|
+
<a id="waf-afaac0"></a>• [`disable_waf`](#waf-afaac0) - Optional Block<br>Enable this option
|
|
4372
4372
|
|
|
4373
|
-
<a id="config-b3faa9"></a>• [`disable_web_socket_config`](#config-b3faa9) - Optional Block<br>
|
|
4373
|
+
<a id="config-b3faa9"></a>• [`disable_web_socket_config`](#config-b3faa9) - Optional Block<br>Enable this option
|
|
4374
4374
|
|
|
4375
|
-
<a id="cluster-f8e26f"></a>• [`do_not_retract_cluster`](#cluster-f8e26f) - Optional Block<br>
|
|
4375
|
+
<a id="cluster-f8e26f"></a>• [`do_not_retract_cluster`](#cluster-f8e26f) - Optional Block<br>Enable this option
|
|
4376
4376
|
|
|
4377
|
-
<a id="spdy-676c6f"></a>• [`enable_spdy`](#spdy-676c6f) - Optional Block<br>
|
|
4377
|
+
<a id="spdy-676c6f"></a>• [`enable_spdy`](#spdy-676c6f) - Optional Block<br>Enable this option
|
|
4378
4378
|
|
|
4379
4379
|
<a id="subsets-b6a9d9"></a>• [`endpoint_subsets`](#subsets-b6a9d9) - Optional Block<br>Upstream origin pool may be configured to divide its origin servers into subsets based on metadata attached to the origin servers. Routes may then specify the metadata that a endpoint must match in order to be selected by the load balancer For origin servers which are discovered in K8S or Consul
|
|
4380
4380
|
|
|
4381
|
-
<a id="injection-46208e"></a>• [`inherited_bot_defense_javascript_injection`](#injection-46208e) - Optional Block<br>
|
|
4381
|
+
<a id="injection-46208e"></a>• [`inherited_bot_defense_javascript_injection`](#injection-46208e) - Optional Block<br>Enable this option
|
|
4382
4382
|
|
|
4383
|
-
<a id="waf-0043f0"></a>• [`inherited_waf`](#waf-0043f0) - Optional Block<br>
|
|
4383
|
+
<a id="waf-0043f0"></a>• [`inherited_waf`](#waf-0043f0) - Optional Block<br>Enable this option
|
|
4384
4384
|
|
|
4385
|
-
<a id="exclusion-0ba7d9"></a>• [`inherited_waf_exclusion`](#exclusion-0ba7d9) - Optional Block<br>
|
|
4385
|
+
<a id="exclusion-0ba7d9"></a>• [`inherited_waf_exclusion`](#exclusion-0ba7d9) - Optional Block<br>Enable this option
|
|
4386
4386
|
|
|
4387
4387
|
<a id="policy-f5e84d"></a>• [`mirror_policy`](#policy-f5e84d) - Optional Block<br>MirrorPolicy is used for shadowing traffic from one origin pool to another. The approach used is 'fire and forget', meaning it will not wait for the shadow origin pool to respond before returning the response from the primary origin pool. All normal statistics are collected for the shadow origin<br>See [Mirror Policy](#policy-f5e84d) below.
|
|
4388
4388
|
|
|
4389
|
-
<a id="policy-ad7b2b"></a>• [`no_retry_policy`](#policy-ad7b2b) - Optional Block<br>
|
|
4389
|
+
<a id="policy-ad7b2b"></a>• [`no_retry_policy`](#policy-ad7b2b) - Optional Block<br>Enable this option
|
|
4390
4390
|
|
|
4391
4391
|
<a id="rewrite-ffbe86"></a>• [`prefix_rewrite`](#rewrite-ffbe86) - Optional String<br>prefix_rewrite indicates that during forwarding, the matched prefix (or path) should be swapped with its value. When using regex path matching, the entire path (not including the query string) will be swapped with this value
|
|
4392
4392
|
|
|
@@ -4410,7 +4410,7 @@ An [`advanced_options`](#routes-simple-route-advanced-options) block (within [`r
|
|
|
4410
4410
|
|
|
4411
4411
|
<a id="remove-5c99fb"></a>• [`response_headers_to_remove`](#remove-5c99fb) - Optional List<br>List of keys of Headers to be removed from the HTTP response being sent towards downstream
|
|
4412
4412
|
|
|
4413
|
-
<a id="cluster-3cb556"></a>• [`retract_cluster`](#cluster-3cb556) - Optional Block<br>
|
|
4413
|
+
<a id="cluster-3cb556"></a>• [`retract_cluster`](#cluster-3cb556) - Optional Block<br>Enable this option
|
|
4414
4414
|
|
|
4415
4415
|
<a id="policy-e40fa6"></a>• [`retry_policy`](#policy-e40fa6) - Optional Block<br>Retry policy configuration for route destination<br>See [Retry Policy](#policy-e40fa6) below.
|
|
4416
4416
|
|
|
@@ -4476,11 +4476,11 @@ A [`cors_policy`](#policy-ba853e) block (within [`routes.simple_route.advanced_o
|
|
|
4476
4476
|
|
|
4477
4477
|
A [`csrf_policy`](#policy-7816d7) block (within [`routes.simple_route.advanced_options`](#routes-simple-route-advanced-options)) supports the following:
|
|
4478
4478
|
|
|
4479
|
-
<a id="domains-b58044"></a>• [`all_load_balancer_domains`](#domains-b58044) - Optional Block<br>
|
|
4479
|
+
<a id="domains-b58044"></a>• [`all_load_balancer_domains`](#domains-b58044) - Optional Block<br>Enable this option
|
|
4480
4480
|
|
|
4481
4481
|
<a id="list-c11aec"></a>• [`custom_domain_list`](#list-c11aec) - Optional Block<br>List of domain names used for Host header matching<br>See [Custom Domain List](#list-c11aec) below.
|
|
4482
4482
|
|
|
4483
|
-
<a id="disabled-ac6077"></a>• [`disabled`](#disabled-ac6077) - Optional Block<br>
|
|
4483
|
+
<a id="disabled-ac6077"></a>• [`disabled`](#disabled-ac6077) - Optional Block<br>Enable this option
|
|
4484
4484
|
|
|
4485
4485
|
#### Routes Simple Route Advanced Options CSRF Policy Custom Domain List
|
|
4486
4486
|
|
|
@@ -4630,7 +4630,7 @@ A [`headers`](#routes-simple-route-headers) block (within [`routes.simple_route`
|
|
|
4630
4630
|
|
|
4631
4631
|
An [`incoming_port`](#routes-simple-route-incoming-port) block (within [`routes.simple_route`](#routes-simple-route)) supports the following:
|
|
4632
4632
|
|
|
4633
|
-
<a id="match-80b1e5"></a>• [`no_port_match`](#match-80b1e5) - Optional Block<br>
|
|
4633
|
+
<a id="match-80b1e5"></a>• [`no_port_match`](#match-80b1e5) - Optional Block<br>Enable this option
|
|
4634
4634
|
|
|
4635
4635
|
<a id="routes-simple-route-incoming-port-port"></a>• [`port`](#routes-simple-route-incoming-port-port) - Optional Number<br>Exact Port to match
|
|
4636
4636
|
|
|
@@ -4684,11 +4684,11 @@ A [`path`](#routes-simple-route-path) block (within [`routes.simple_route`](#rou
|
|
|
4684
4684
|
|
|
4685
4685
|
A [`query_params`](#routes-simple-route-query-params) block (within [`routes.simple_route`](#routes-simple-route)) supports the following:
|
|
4686
4686
|
|
|
4687
|
-
<a id="params-aa1f17"></a>• [`remove_all_params`](#params-aa1f17) - Optional Block<br>
|
|
4687
|
+
<a id="params-aa1f17"></a>• [`remove_all_params`](#params-aa1f17) - Optional Block<br>Enable this option
|
|
4688
4688
|
|
|
4689
4689
|
<a id="params-c3e5f1"></a>• [`replace_params`](#params-c3e5f1) - Optional String
|
|
4690
4690
|
|
|
4691
|
-
<a id="params-bd2237"></a>• [`retain_all_params`](#params-bd2237) - Optional Block<br>
|
|
4691
|
+
<a id="params-bd2237"></a>• [`retain_all_params`](#params-bd2237) - Optional Block<br>Enable this option
|
|
4692
4692
|
|
|
4693
4693
|
#### Sensitive Data Disclosure Rules
|
|
4694
4694
|
|
|
@@ -4728,13 +4728,13 @@ A [`sensitive_data_policy_ref`](#ref-55b260) block (within [`sensitive_data_poli
|
|
|
4728
4728
|
|
|
4729
4729
|
A [`single_lb_app`](#single-lb-app) block supports the following:
|
|
4730
4730
|
|
|
4731
|
-
<a id="single-lb-app-disable-discovery"></a>• [`disable_discovery`](#single-lb-app-disable-discovery) - Optional Block<br>
|
|
4731
|
+
<a id="single-lb-app-disable-discovery"></a>• [`disable_discovery`](#single-lb-app-disable-discovery) - Optional Block<br>Enable this option
|
|
4732
4732
|
|
|
4733
|
-
<a id="detection-d482d0"></a>• [`disable_malicious_user_detection`](#detection-d482d0) - Optional Block<br>
|
|
4733
|
+
<a id="detection-d482d0"></a>• [`disable_malicious_user_detection`](#detection-d482d0) - Optional Block<br>Enable this option
|
|
4734
4734
|
|
|
4735
4735
|
<a id="single-lb-app-enable-discovery"></a>• [`enable_discovery`](#single-lb-app-enable-discovery) - Optional Block<br>Specifies the settings used for API discovery<br>See [Enable Discovery](#single-lb-app-enable-discovery) below.
|
|
4736
4736
|
|
|
4737
|
-
<a id="detection-280554"></a>• [`enable_malicious_user_detection`](#detection-280554) - Optional Block<br>
|
|
4737
|
+
<a id="detection-280554"></a>• [`enable_malicious_user_detection`](#detection-280554) - Optional Block<br>Enable this option
|
|
4738
4738
|
|
|
4739
4739
|
#### Single LB App Enable Discovery
|
|
4740
4740
|
|
|
@@ -4746,13 +4746,13 @@ An [`enable_discovery`](#single-lb-app-enable-discovery) block (within [`single_
|
|
|
4746
4746
|
|
|
4747
4747
|
<a id="discovery-3993cd"></a>• [`custom_api_auth_discovery`](#discovery-3993cd) - Optional Block<br>API Discovery Advanced Settings. API Discovery Advanced settings<br>See [Custom API Auth Discovery](#discovery-3993cd) below.
|
|
4748
4748
|
|
|
4749
|
-
<a id="discovery-e02c6d"></a>• [`default_api_auth_discovery`](#discovery-e02c6d) - Optional Block<br>
|
|
4749
|
+
<a id="discovery-e02c6d"></a>• [`default_api_auth_discovery`](#discovery-e02c6d) - Optional Block<br>Enable this option
|
|
4750
4750
|
|
|
4751
|
-
<a id="traffic-7e1631"></a>• [`disable_learn_from_redirect_traffic`](#traffic-7e1631) - Optional Block<br>
|
|
4751
|
+
<a id="traffic-7e1631"></a>• [`disable_learn_from_redirect_traffic`](#traffic-7e1631) - Optional Block<br>Enable this option
|
|
4752
4752
|
|
|
4753
4753
|
<a id="settings-e36cc7"></a>• [`discovered_api_settings`](#settings-e36cc7) - Optional Block<br>Discovered API Settings. Configure Discovered API Settings<br>See [Discovered API Settings](#settings-e36cc7) below.
|
|
4754
4754
|
|
|
4755
|
-
<a id="traffic-ebfb24"></a>• [`enable_learn_from_redirect_traffic`](#traffic-ebfb24) - Optional Block<br>
|
|
4755
|
+
<a id="traffic-ebfb24"></a>• [`enable_learn_from_redirect_traffic`](#traffic-ebfb24) - Optional Block<br>Enable this option
|
|
4756
4756
|
|
|
4757
4757
|
#### Single LB App Enable Discovery API Crawler
|
|
4758
4758
|
|
|
@@ -4760,7 +4760,7 @@ An [`api_crawler`](#crawler-cb748a) block (within [`single_lb_app.enable_discove
|
|
|
4760
4760
|
|
|
4761
4761
|
<a id="config-3110d5"></a>• [`api_crawler_config`](#config-3110d5) - Optional Block<br>Crawler Configure<br>See [API Crawler Config](#config-3110d5) below.
|
|
4762
4762
|
|
|
4763
|
-
<a id="crawler-f73dfe"></a>• [`disable_api_crawler`](#crawler-f73dfe) - Optional Block<br>
|
|
4763
|
+
<a id="crawler-f73dfe"></a>• [`disable_api_crawler`](#crawler-f73dfe) - Optional Block<br>Enable this option
|
|
4764
4764
|
|
|
4765
4765
|
#### Single LB App Enable Discovery API Crawler API Crawler Config
|
|
4766
4766
|
|
|
@@ -4818,7 +4818,7 @@ An [`api_crawler`](#crawler-cb748a) block (within [`single_lb_app.enable_discove
|
|
|
4818
4818
|
|
|
4819
4819
|
A [`slow_ddos_mitigation`](#slow-ddos-mitigation) block supports the following:
|
|
4820
4820
|
|
|
4821
|
-
<a id="timeout-81071e"></a>• [`disable_request_timeout`](#timeout-81071e) - Optional Block<br>
|
|
4821
|
+
<a id="timeout-81071e"></a>• [`disable_request_timeout`](#timeout-81071e) - Optional Block<br>Enable this option
|
|
4822
4822
|
|
|
4823
4823
|
<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
|
|
4824
4824
|
|
|
@@ -4844,7 +4844,7 @@ A [`trusted_clients`](#trusted-clients) block supports the following:
|
|
|
4844
4844
|
|
|
4845
4845
|
<a id="trusted-clients-as-number"></a>• [`as_number`](#trusted-clients-as-number) - Optional Number<br>RFC 6793 defined 4-byte AS number
|
|
4846
4846
|
|
|
4847
|
-
<a id="trusted-clients-bot-skip-processing"></a>• [`bot_skip_processing`](#trusted-clients-bot-skip-processing) - Optional Block<br>
|
|
4847
|
+
<a id="trusted-clients-bot-skip-processing"></a>• [`bot_skip_processing`](#trusted-clients-bot-skip-processing) - Optional Block<br>Enable this option
|
|
4848
4848
|
|
|
4849
4849
|
<a id="trusted-clients-expiration-timestamp"></a>• [`expiration_timestamp`](#trusted-clients-expiration-timestamp) - Optional String<br>Specifies expiration_timestamp the RFC 3339 format timestamp at which the containing rule is considered to be logically expired. The rule continues to exist in the configuration but is not applied anymore
|
|
4850
4850
|
|
|
@@ -4856,11 +4856,11 @@ A [`trusted_clients`](#trusted-clients) block supports the following:
|
|
|
4856
4856
|
|
|
4857
4857
|
<a id="trusted-clients-metadata"></a>• [`metadata`](#trusted-clients-metadata) - Optional Block<br>MessageMetaType is metadata (common attributes) of a message that only certain messages have. This information is propagated to the metadata of a child object that gets created from the containing message during view processing. The information in this type can be specified by user during create<br>See [Metadata](#trusted-clients-metadata) below.
|
|
4858
4858
|
|
|
4859
|
-
<a id="trusted-clients-skip-processing"></a>• [`skip_processing`](#trusted-clients-skip-processing) - Optional Block<br>
|
|
4859
|
+
<a id="trusted-clients-skip-processing"></a>• [`skip_processing`](#trusted-clients-skip-processing) - Optional Block<br>Enable this option
|
|
4860
4860
|
|
|
4861
4861
|
<a id="trusted-clients-user-identifier"></a>• [`user_identifier`](#trusted-clients-user-identifier) - Optional String<br>Identify user based on user identifier. User identifier value needs to be copied from security event
|
|
4862
4862
|
|
|
4863
|
-
<a id="trusted-clients-waf-skip-processing"></a>• [`waf_skip_processing`](#trusted-clients-waf-skip-processing) - Optional Block<br>
|
|
4863
|
+
<a id="trusted-clients-waf-skip-processing"></a>• [`waf_skip_processing`](#trusted-clients-waf-skip-processing) - Optional Block<br>Enable this option
|
|
4864
4864
|
|
|
4865
4865
|
#### Trusted Clients HTTP Header
|
|
4866
4866
|
|
|
@@ -4918,9 +4918,9 @@ A [`waf_exclusion_inline_rules`](#rules-6d8efc) block (within [`waf_exclusion`](
|
|
|
4918
4918
|
|
|
4919
4919
|
A [`rules`](#rules-28cf34) block (within [`waf_exclusion.waf_exclusion_inline_rules`](#rules-6d8efc)) supports the following:
|
|
4920
4920
|
|
|
4921
|
-
<a id="domain-3f85e2"></a>• [`any_domain`](#domain-3f85e2) - Optional Block<br>
|
|
4921
|
+
<a id="domain-3f85e2"></a>• [`any_domain`](#domain-3f85e2) - Optional Block<br>Enable this option
|
|
4922
4922
|
|
|
4923
|
-
<a id="path-f75bfe"></a>• [`any_path`](#path-f75bfe) - Optional Block<br>
|
|
4923
|
+
<a id="path-f75bfe"></a>• [`any_path`](#path-f75bfe) - Optional Block<br>Enable this option
|
|
4924
4924
|
|
|
4925
4925
|
<a id="control-0cb52d"></a>• [`app_firewall_detection_control`](#control-0cb52d) - Optional Block<br>Define the list of Signature IDs, Violations, Attack Types and Bot Names that should be excluded from triggering on the defined match criteria<br>See [App Firewall Detection Control](#control-0cb52d) below.
|
|
4926
4926
|
|
|
@@ -4938,7 +4938,7 @@ A [`rules`](#rules-28cf34) block (within [`waf_exclusion.waf_exclusion_inline_ru
|
|
|
4938
4938
|
|
|
4939
4939
|
<a id="value-6f2f58"></a>• [`suffix_value`](#value-6f2f58) - Optional String<br>Suffix of domain name e.g 'xyz.com' will match '*.xyz.com' and 'xyz.com'
|
|
4940
4940
|
|
|
4941
|
-
<a id="processing-8c8391"></a>• [`waf_skip_processing`](#processing-8c8391) - Optional Block<br>
|
|
4941
|
+
<a id="processing-8c8391"></a>• [`waf_skip_processing`](#processing-8c8391) - Optional Block<br>Enable this option
|
|
4942
4942
|
|
|
4943
4943
|
#### WAF Exclusion WAF Exclusion Inline Rules Rules App Firewall Detection Control
|
|
4944
4944
|
|