@robinmordasiewicz/f5xc-terraform-mcp 3.5.1 → 3.6.1

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.
Files changed (111) hide show
  1. package/README.md +104 -283
  2. package/dist/docs/data-sources/bgp.md +2 -2
  3. package/dist/docs/data-sources/discovery.md +2 -2
  4. package/dist/docs/data-sources/fast_acl.md +2 -2
  5. package/dist/docs/data-sources/fast_acl_rule.md +2 -2
  6. package/dist/docs/data-sources/irule.md +2 -2
  7. package/dist/docs/data-sources/log_receiver.md +2 -2
  8. package/dist/docs/data-sources/network_policy.md +2 -2
  9. package/dist/docs/data-sources/route.md +2 -2
  10. package/dist/docs/data-sources/site.md +2 -2
  11. package/dist/docs/resources/address_allocator.md +7 -7
  12. package/dist/docs/resources/advertise_policy.md +57 -57
  13. package/dist/docs/resources/alert_policy.md +40 -40
  14. package/dist/docs/resources/alert_receiver.md +57 -57
  15. package/dist/docs/resources/api_crawler.md +13 -13
  16. package/dist/docs/resources/api_definition.md +11 -11
  17. package/dist/docs/resources/api_discovery.md +4 -4
  18. package/dist/docs/resources/api_testing.md +27 -27
  19. package/dist/docs/resources/apm.md +40 -40
  20. package/dist/docs/resources/app_api_group.md +20 -20
  21. package/dist/docs/resources/app_firewall.md +50 -50
  22. package/dist/docs/resources/app_setting.md +19 -19
  23. package/dist/docs/resources/app_type.md +7 -7
  24. package/dist/docs/resources/authentication.md +29 -29
  25. package/dist/docs/resources/aws_tgw_site.md +140 -140
  26. package/dist/docs/resources/aws_vpc_site.md +174 -174
  27. package/dist/docs/resources/azure_vnet_site.md +245 -245
  28. package/dist/docs/resources/bgp.md +37 -205
  29. package/dist/docs/resources/bgp_asn_set.md +1 -1
  30. package/dist/docs/resources/bgp_routing_policy.md +19 -19
  31. package/dist/docs/resources/bot_defense_app_infrastructure.md +12 -12
  32. package/dist/docs/resources/cdn_cache_rule.md +5 -5
  33. package/dist/docs/resources/cdn_loadbalancer.md +418 -418
  34. package/dist/docs/resources/certificate.md +1 -1
  35. package/dist/docs/resources/certificate_chain.md +1 -1
  36. package/dist/docs/resources/cloud_connect.md +28 -28
  37. package/dist/docs/resources/cloud_credentials.md +35 -35
  38. package/dist/docs/resources/cloud_elastic_ip.md +8 -8
  39. package/dist/docs/resources/cloud_link.md +36 -36
  40. package/dist/docs/resources/cluster.md +86 -86
  41. package/dist/docs/resources/cminstance.md +22 -22
  42. package/dist/docs/resources/code_base_integration.md +24 -24
  43. package/dist/docs/resources/container_registry.md +13 -13
  44. package/dist/docs/resources/crl.md +1 -1
  45. package/dist/docs/resources/data_type.md +16 -16
  46. package/dist/docs/resources/dc_cluster_group.md +4 -4
  47. package/dist/docs/resources/discovery.md +8 -259
  48. package/dist/docs/resources/dns_compliance_checks.md +1 -1
  49. package/dist/docs/resources/dns_domain.md +3 -3
  50. package/dist/docs/resources/endpoint.md +44 -44
  51. package/dist/docs/resources/enhanced_firewall_policy.md +51 -51
  52. package/dist/docs/resources/external_connector.md +42 -42
  53. package/dist/docs/resources/fast_acl.md +60 -166
  54. package/dist/docs/resources/fast_acl_rule.md +28 -28
  55. package/dist/docs/resources/filter_set.md +10 -10
  56. package/dist/docs/resources/fleet.md +160 -160
  57. package/dist/docs/resources/forward_proxy_policy.md +82 -82
  58. package/dist/docs/resources/forwarding_class.md +14 -14
  59. package/dist/docs/resources/gcp_vpc_site.md +152 -152
  60. package/dist/docs/resources/global_log_receiver.md +238 -238
  61. package/dist/docs/resources/healthcheck.md +17 -17
  62. package/dist/docs/resources/http_loadbalancer.md +1003 -1003
  63. package/dist/docs/resources/irule.md +5 -7
  64. package/dist/docs/resources/log_receiver.md +825 -44
  65. package/dist/docs/resources/malicious_user_mitigation.md +10 -10
  66. package/dist/docs/resources/nat_policy.md +86 -86
  67. package/dist/docs/resources/network_connector.md +31 -31
  68. package/dist/docs/resources/network_firewall.md +22 -22
  69. package/dist/docs/resources/network_interface.md +77 -77
  70. package/dist/docs/resources/network_policy.md +38 -217
  71. package/dist/docs/resources/network_policy_rule.md +21 -21
  72. package/dist/docs/resources/network_policy_view.md +65 -65
  73. package/dist/docs/resources/nfv_service.md +76 -76
  74. package/dist/docs/resources/nginx_service_discovery.md +10 -10
  75. package/dist/docs/resources/origin_pool.md +166 -166
  76. package/dist/docs/resources/policer.md +4 -4
  77. package/dist/docs/resources/policy_based_routing.md +28 -28
  78. package/dist/docs/resources/protocol_inspection.md +12 -12
  79. package/dist/docs/resources/protocol_policer.md +14 -14
  80. package/dist/docs/resources/proxy.md +111 -111
  81. package/dist/docs/resources/rate_limiter.md +15 -15
  82. package/dist/docs/resources/rate_limiter_policy.md +56 -56
  83. package/dist/docs/resources/route.md +183 -183
  84. package/dist/docs/resources/secret_management_access.md +68 -68
  85. package/dist/docs/resources/securemesh_site.md +1619 -258
  86. package/dist/docs/resources/segment.md +4 -4
  87. package/dist/docs/resources/sensitive_data_policy.md +9 -9
  88. package/dist/docs/resources/service_policy.md +175 -175
  89. package/dist/docs/resources/service_policy_rule.md +142 -142
  90. package/dist/docs/resources/site.md +381 -303
  91. package/dist/docs/resources/site_mesh_group.md +18 -18
  92. package/dist/docs/resources/subnet.md +17 -17
  93. package/dist/docs/resources/tcp_loadbalancer.md +130 -130
  94. package/dist/docs/resources/tenant_configuration.md +10 -10
  95. package/dist/docs/resources/trusted_ca_list.md +1 -1
  96. package/dist/docs/resources/tunnel.md +36 -36
  97. package/dist/docs/resources/udp_loadbalancer.md +59 -59
  98. package/dist/docs/resources/usb_policy.md +6 -6
  99. package/dist/docs/resources/user_identification.md +16 -16
  100. package/dist/docs/resources/virtual_host.md +225 -225
  101. package/dist/docs/resources/virtual_network.md +14 -14
  102. package/dist/docs/resources/virtual_site.md +3 -3
  103. package/dist/docs/resources/voltstack_site.md +141 -141
  104. package/dist/docs/resources/waf_exclusion_policy.md +17 -17
  105. package/dist/docs/resources/workload.md +327 -327
  106. package/dist/docs/resources/workload_flavor.md +3 -3
  107. package/dist/metadata/resource-metadata.json +1484 -942
  108. package/dist/types.d.ts +11 -0
  109. package/dist/types.d.ts.map +1 -1
  110. package/dist/types.js.map +1 -1
  111. package/package.json +1 -1
@@ -56,30 +56,30 @@ resource "f5xc_proxy" "example" {
56
56
  ### Spec Argument Reference
57
57
 
58
58
  -> **One of the following:**
59
- &#x2022; <a id="active-forward-proxy-policies"></a>[`active_forward_proxy_policies`](#active-forward-proxy-policies) - Optional Block<br>Active Forward Proxy Policies Type. Ordered List of Forward Proxy Policies active<br>See [Active Forward Proxy Policies](#active-forward-proxy-policies) below for details.
59
+ &#x2022; <a id="active-forward-proxy-policies"></a>[`active_forward_proxy_policies`](#active-forward-proxy-policies) - Optional Block<br>Ordered List of Forward Proxy Policies active<br>See [Active Forward Proxy Policies](#active-forward-proxy-policies) below for details.
60
60
 
61
- <a id="connection-timeout"></a>&#x2022; [`connection_timeout`](#connection-timeout) - Optional Number Defaults to `2000` Specified in milliseconds<br>Connection Timeout. The timeout for new network connections to upstream server. The (2 seconds)
61
+ <a id="connection-timeout"></a>&#x2022; [`connection_timeout`](#connection-timeout) - Optional Number Defaults to `2000` Specified in milliseconds<br>The timeout for new network connections to upstream server. The (2 seconds)
62
62
 
63
63
  -> **One of the following:**
64
- &#x2022; <a id="do-not-advertise"></a>[`do_not_advertise`](#do-not-advertise) - Optional Block<br>Enable this option
65
- <br><br>&#x2022; <a id="site-virtual-sites"></a>[`site_virtual_sites`](#site-virtual-sites) - Optional Block<br>Advertise Site or Virtual Site. This defines a way to advertise a VIP on specific sites
64
+ &#x2022; <a id="do-not-advertise"></a>[`do_not_advertise`](#do-not-advertise) - Optional Block<br>Can be used for messages where no values are needed
65
+ <br><br>&#x2022; <a id="site-virtual-sites"></a>[`site_virtual_sites`](#site-virtual-sites) - Optional Block<br>Defines a way to advertise a VIP on specific sites
66
66
 
67
67
  -> **One of the following:**
68
68
  &#x2022; <a id="dynamic-proxy"></a>[`dynamic_proxy`](#dynamic-proxy) - Optional Block<br>DynamicProxyType<br>See [Dynamic Proxy](#dynamic-proxy) below for details.
69
69
  <br><br>&#x2022; <a id="http-proxy"></a>[`http_proxy`](#http-proxy) - Optional Block<br>HTTP Connect Proxy. Parameters for HTTP Connect Proxy
70
70
 
71
- <a id="no-forward-proxy-policy"></a>&#x2022; [`no_forward_proxy_policy`](#no-forward-proxy-policy) - Optional Block<br>Enable this option
71
+ <a id="no-forward-proxy-policy"></a>&#x2022; [`no_forward_proxy_policy`](#no-forward-proxy-policy) - Optional Block<br>Can be used for messages where no values are needed
72
72
 
73
73
  -> **One of the following:**
74
- &#x2022; <a id="no-interception"></a>[`no_interception`](#no-interception) - Optional Block<br>Enable this option
74
+ &#x2022; <a id="no-interception"></a>[`no_interception`](#no-interception) - Optional Block<br>Can be used for messages where no values are needed
75
75
 
76
76
  -> **One of the following:**
77
- &#x2022; <a id="site-local-inside-network"></a>[`site_local_inside_network`](#site-local-inside-network) - Optional Block<br>Enable this option
78
- <br><br>&#x2022; <a id="site-local-network"></a>[`site_local_network`](#site-local-network) - Optional Block<br>Enable this option
77
+ &#x2022; <a id="site-local-inside-network"></a>[`site_local_inside_network`](#site-local-inside-network) - Optional Block<br>Can be used for messages where no values are needed
78
+ <br><br>&#x2022; <a id="site-local-network"></a>[`site_local_network`](#site-local-network) - Optional Block<br>Can be used for messages where no values are needed
79
79
 
80
80
  <a id="timeouts"></a>&#x2022; [`timeouts`](#timeouts) - Optional Block
81
81
 
82
- <a id="tls-intercept"></a>&#x2022; [`tls_intercept`](#tls-intercept) - Optional Block<br>Configuration for TLS interception. Configuration to enable TLS interception
82
+ <a id="tls-intercept"></a>&#x2022; [`tls_intercept`](#tls-intercept) - Optional Block<br>Configuration to enable TLS interception
83
83
 
84
84
  ### Attributes Reference
85
85
 
@@ -93,27 +93,27 @@ In addition to all arguments above, the following attributes are exported:
93
93
 
94
94
  An [`active_forward_proxy_policies`](#active-forward-proxy-policies) block supports the following:
95
95
 
96
- <a id="policies-42e2f7"></a>&#x2022; [`forward_proxy_policies`](#policies-42e2f7) - Optional Block<br>Forward Proxy Policies. Ordered List of Forward Proxy Policies active<br>See [Forward Proxy Policies](#policies-42e2f7) below.
96
+ <a id="policies-42e2f7"></a>&#x2022; [`forward_proxy_policies`](#policies-42e2f7) - Optional Block<br>Ordered List of Forward Proxy Policies active<br>See [Forward Proxy Policies](#policies-42e2f7) below.
97
97
 
98
98
  #### Active Forward Proxy Policies Forward Proxy Policies
99
99
 
100
100
  A [`forward_proxy_policies`](#policies-42e2f7) block (within [`active_forward_proxy_policies`](#active-forward-proxy-policies)) supports the following:
101
101
 
102
- <a id="name-c2d06e"></a>&#x2022; [`name`](#name-c2d06e) - Optional String<br>Name. When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object's(e.g. Route's) name
102
+ <a id="name-c2d06e"></a>&#x2022; [`name`](#name-c2d06e) - Optional String<br>When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object's(e.g. Route's) name
103
103
 
104
- <a id="namespace-63e125"></a>&#x2022; [`namespace`](#namespace-63e125) - Optional String<br>Namespace. When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object's(e.g. Route's) namespace
104
+ <a id="namespace-63e125"></a>&#x2022; [`namespace`](#namespace-63e125) - Optional String<br>When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object's(e.g. Route's) namespace
105
105
 
106
- <a id="tenant-e68ab4"></a>&#x2022; [`tenant`](#tenant-e68ab4) - Optional String<br>Tenant. When a configuration object(e.g. Virtual_host) refers to another(e.g route) then tenant will hold the referred object's(e.g. Route's) tenant
106
+ <a id="tenant-e68ab4"></a>&#x2022; [`tenant`](#tenant-e68ab4) - Optional String<br>When a configuration object(e.g. Virtual_host) refers to another(e.g route) then tenant will hold the referred object's(e.g. Route's) tenant
107
107
 
108
108
  #### Dynamic Proxy
109
109
 
110
110
  A [`dynamic_proxy`](#dynamic-proxy) block supports the following:
111
111
 
112
- <a id="dynamic-proxy-disable-dns-masquerade"></a>&#x2022; [`disable_dns_masquerade`](#dynamic-proxy-disable-dns-masquerade) - Optional Block<br>Enable this option
112
+ <a id="dynamic-proxy-disable-dns-masquerade"></a>&#x2022; [`disable_dns_masquerade`](#dynamic-proxy-disable-dns-masquerade) - Optional Block<br>Can be used for messages where no values are needed
113
113
 
114
- <a id="dynamic-proxy-domains"></a>&#x2022; [`domains`](#dynamic-proxy-domains) - Optional List<br>Domains. A list of Domains to be proxied. Wildcard hosts are supported in the suffix or prefix form Supported Domains and search order: 1. Exact Domain names: `www.example.com.` 2. Domains starting with a Wildcard: \*.example.com. Not supported Domains: - Just a Wildcard: \* - A Wildcard and TLD with no root Domain: \*.com. - A Wildcard not matching a whole DNS label. E.g. \*.example.com and \*.bar.example.com are valid Wildcards however \*bar.example.com, \*-bar.example.com, and bar*.example.com are all invalid. Additional notes: A Wildcard will not match empty string. E.g. \*.example.com will match bar.example.com and baz-bar.example.com but not .example.com. The longest Wildcards match first. Only a single virtual host in the entire route configuration can match on \*. Also a Domain must be unique across all virtual hosts within an advertise policy
114
+ <a id="dynamic-proxy-domains"></a>&#x2022; [`domains`](#dynamic-proxy-domains) - Optional List<br>List of Domains to be proxied. Wildcard hosts are supported in the suffix or prefix form Supported Domains and search order: 1. Exact Domain names: `www.example.com.` 2
115
115
 
116
- <a id="dynamic-proxy-enable-dns-masquerade"></a>&#x2022; [`enable_dns_masquerade`](#dynamic-proxy-enable-dns-masquerade) - Optional Block<br>Enable this option
116
+ <a id="dynamic-proxy-enable-dns-masquerade"></a>&#x2022; [`enable_dns_masquerade`](#dynamic-proxy-enable-dns-masquerade) - Optional Block<br>Can be used for messages where no values are needed
117
117
 
118
118
  <a id="dynamic-proxy-http-proxy"></a>&#x2022; [`http_proxy`](#dynamic-proxy-http-proxy) - Optional Block<br>Dynamic HTTP Proxy Type. Parameters for dynamic HTTP proxy<br>See [HTTP Proxy](#dynamic-proxy-http-proxy) below.
119
119
 
@@ -125,43 +125,43 @@ A [`dynamic_proxy`](#dynamic-proxy) block supports the following:
125
125
 
126
126
  A [`http_proxy`](#dynamic-proxy-http-proxy) block (within [`dynamic_proxy`](#dynamic-proxy)) supports the following:
127
127
 
128
- <a id="dynamic-proxy-http-proxy-more-option"></a>&#x2022; [`more_option`](#dynamic-proxy-http-proxy-more-option) - Optional Block<br>Advanced OPTIONS. This defines various OPTIONS to define a route<br>See [More Option](#dynamic-proxy-http-proxy-more-option) below.
128
+ <a id="dynamic-proxy-http-proxy-more-option"></a>&#x2022; [`more_option`](#dynamic-proxy-http-proxy-more-option) - Optional Block<br>Defines various OPTIONS to define a route<br>See [More Option](#dynamic-proxy-http-proxy-more-option) below.
129
129
 
130
130
  #### Dynamic Proxy HTTP Proxy More Option
131
131
 
132
132
  A [`more_option`](#dynamic-proxy-http-proxy-more-option) block (within [`dynamic_proxy.http_proxy`](#dynamic-proxy-http-proxy)) supports the following:
133
133
 
134
- <a id="policy-dc12bf"></a>&#x2022; [`buffer_policy`](#policy-dc12bf) - Optional Block<br>Buffer Configuration. Some upstream applications are not capable of handling streamed data. This config enables buffering the entire request before sending to upstream application. We can specify the maximum buffer size and buffer interval with this config. Buffering can be enabled and disabled at VirtualHost and Route levels Route level buffer configuration takes precedence<br>See [Buffer Policy](#policy-dc12bf) below.
134
+ <a id="policy-dc12bf"></a>&#x2022; [`buffer_policy`](#policy-dc12bf) - 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-dc12bf) below.
135
135
 
136
- <a id="params-c9d1d2"></a>&#x2022; [`compression_params`](#params-c9d1d2) - Optional Block<br>Compression Parameters. Enables loadbalancer to compress dispatched data from an upstream service upon client request. The content is compressed and then sent to the client with the appropriate headers if either response and request allow. Only GZIP compression is supported. By default compression will be skipped when: A request does NOT contain accept-encoding header. A request includes accept-encoding header, but it does not contain “gzip” or “*”. A request includes accept-encoding with “gzip” or “*” with the weight “q=0”. Note that the “gzip” will have a higher weight then “*”. For example, if accept-encoding is “gzip;q=0,*;q=1”, the filter will not compress. But if the header is set to “*;q=0,gzip;q=1”, the filter will compress. A request whose accept-encoding header includes “identity”. A response contains a content-encoding header. A response contains a cache-control header whose value includes “no-transform”. A response contains a transfer-encoding header whose value includes “gzip”. A response does not contain a content-type value that matches one of the selected mime-types, which default to application/javascript, application/JSON, application/xhtml+XML, image/svg+XML, text/CSS, text/HTML, text/plain, text/XML. Neither content-length nor transfer-encoding headers are present in the response. Response size is smaller than 30 bytes (only applicable when transfer-encoding is not chunked). When compression is applied: The content-length is removed from response headers. Response headers contain “transfer-encoding: chunked” and do not contain “content-encoding” header. The “vary: accept-encoding” header is inserted on every response. GZIP Compression Level: A value which is optimal balance between speed of compression and amount of compression is chosen<br>See [Compression Params](#params-c9d1d2) below.
136
+ <a id="params-c9d1d2"></a>&#x2022; [`compression_params`](#params-c9d1d2) - Optional Block<br>Enables loadbalancer to compress dispatched data from an upstream service upon client request. The content is compressed and then sent to the client with the appropriate headers if either response and request allow. Only GZIP compression is supported<br>See [Compression Params](#params-c9d1d2) below.
137
137
 
138
- <a id="errors-be4463"></a>&#x2022; [`custom_errors`](#errors-be4463) - Optional Block<br>Custom Error Responses. Map of integer error codes as keys and string values that can be used to provide custom HTTP pages for each error code. Key of the map can be either response code class or HTTP Error code. Response code classes for key is configured as follows 3 -- for 3xx response code class 4 -- for 4xx response code class 5 -- for 5xx response code class Value of the map is string which represents custom HTTP responses. Specific response code takes preference when both response code and response code class matches for a request
138
+ <a id="errors-be4463"></a>&#x2022; [`custom_errors`](#errors-be4463) - Optional Block<br>Map of integer error codes as keys and string values that can be used to provide custom HTTP pages for each error code. Key of the map can be either response code class or HTTP Error code. Response code classes for key is configured as follows 3 -- for 3xx response code class 4 -- for 4xx
139
139
 
140
- <a id="pages-241bd8"></a>&#x2022; [`disable_default_error_pages`](#pages-241bd8) - Optional Bool<br>Disable Default Error Pages. Disable the use of default F5XC error pages
140
+ <a id="pages-241bd8"></a>&#x2022; [`disable_default_error_pages`](#pages-241bd8) - Optional Bool<br>Disable the use of default F5XC error pages
141
141
 
142
- <a id="normalize-343080"></a>&#x2022; [`disable_path_normalize`](#normalize-343080) - Optional Block<br>Enable this option
142
+ <a id="normalize-343080"></a>&#x2022; [`disable_path_normalize`](#normalize-343080) - Optional Block<br>Can be used for messages where no values are needed
143
143
 
144
- <a id="normalize-19a976"></a>&#x2022; [`enable_path_normalize`](#normalize-19a976) - Optional Block<br>Enable this option
144
+ <a id="normalize-19a976"></a>&#x2022; [`enable_path_normalize`](#normalize-19a976) - Optional Block<br>Can be used for messages where no values are needed
145
145
 
146
- <a id="timeout-14c486"></a>&#x2022; [`idle_timeout`](#timeout-14c486) - Optional Number<br>Idle Timeout. 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
146
+ <a id="timeout-14c486"></a>&#x2022; [`idle_timeout`](#timeout-14c486) - 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
147
147
 
148
- <a id="size-302702"></a>&#x2022; [`max_request_header_size`](#size-302702) - Optional Number<br>Maximum Request Header Size. The maximum request header size for downstream connections, in KiB. A HTTP 431 (Request Header Fields Too Large) error code is sent for requests that exceed this size. If multiple load balancers share the same advertise_policy, the highest value configured across all such load balancers is used for all the load balancers in question
148
+ <a id="size-302702"></a>&#x2022; [`max_request_header_size`](#size-302702) - Optional Number<br>The maximum request header size for downstream connections, in KiB. A HTTP 431 (Request Header Fields Too Large) error code is sent for requests that exceed this size. If multiple load balancers share the same advertise_policy, the highest value configured across all such load balancers is used
149
149
 
150
- <a id="add-a872f8"></a>&#x2022; [`request_cookies_to_add`](#add-a872f8) - Optional Block<br>Add Cookies in Cookie Header. Cookies are key-value pairs to be added to HTTP request being routed towards upstream. Cookies specified at this level are applied after cookies from matched Route are applied<br>See [Request Cookies To Add](#add-a872f8) below.
150
+ <a id="add-a872f8"></a>&#x2022; [`request_cookies_to_add`](#add-a872f8) - Optional Block<br>Cookies are key-value pairs to be added to HTTP request being routed towards upstream. Cookies specified at this level are applied after cookies from matched Route are applied<br>See [Request Cookies To Add](#add-a872f8) below.
151
151
 
152
- <a id="remove-411cd3"></a>&#x2022; [`request_cookies_to_remove`](#remove-411cd3) - Optional List<br>Remove Cookies from Cookie Header. List of keys of Cookies to be removed from the HTTP request being sent towards upstream
152
+ <a id="remove-411cd3"></a>&#x2022; [`request_cookies_to_remove`](#remove-411cd3) - Optional List<br>List of keys of Cookies to be removed from the HTTP request being sent towards upstream
153
153
 
154
- <a id="add-3661bf"></a>&#x2022; [`request_headers_to_add`](#add-3661bf) - Optional Block<br>Add Request Headers. Headers are key-value pairs to be added to HTTP request being routed towards upstream. Headers specified at this level are applied after headers from matched Route are applied<br>See [Request Headers To Add](#add-3661bf) below.
154
+ <a id="add-3661bf"></a>&#x2022; [`request_headers_to_add`](#add-3661bf) - Optional Block<br>Headers are key-value pairs to be added to HTTP request being routed towards upstream. Headers specified at this level are applied after headers from matched Route are applied<br>See [Request Headers To Add](#add-3661bf) below.
155
155
 
156
- <a id="remove-031e38"></a>&#x2022; [`request_headers_to_remove`](#remove-031e38) - Optional List<br>Remove Request Headers. List of keys of Headers to be removed from the HTTP request being sent towards upstream
156
+ <a id="remove-031e38"></a>&#x2022; [`request_headers_to_remove`](#remove-031e38) - Optional List<br>List of keys of Headers to be removed from the HTTP request being sent towards upstream
157
157
 
158
- <a id="add-9ca95a"></a>&#x2022; [`response_cookies_to_add`](#add-9ca95a) - Optional Block<br>Add Set-Cookie Headers. Cookies are name-value pairs along with optional attribute parameters to be added to HTTP response being sent towards downstream. Cookies specified at this level are applied after cookies from matched Route are applied<br>See [Response Cookies To Add](#add-9ca95a) below.
158
+ <a id="add-9ca95a"></a>&#x2022; [`response_cookies_to_add`](#add-9ca95a) - Optional Block<br>Cookies are name-value pairs along with optional attribute parameters to be added to HTTP response being sent towards downstream. Cookies specified at this level are applied after cookies from matched Route are applied<br>See [Response Cookies To Add](#add-9ca95a) below.
159
159
 
160
- <a id="remove-09fdc6"></a>&#x2022; [`response_cookies_to_remove`](#remove-09fdc6) - Optional List<br>Remove Cookies from Set-Cookie Headers. List of name of Cookies to be removed from the HTTP response being sent towards downstream. Entire set-cookie header will be removed
160
+ <a id="remove-09fdc6"></a>&#x2022; [`response_cookies_to_remove`](#remove-09fdc6) - Optional List<br>List of name of Cookies to be removed from the HTTP response being sent towards downstream. Entire set-cookie header will be removed
161
161
 
162
- <a id="add-91639a"></a>&#x2022; [`response_headers_to_add`](#add-91639a) - Optional Block<br>Add Response Headers. Headers are key-value pairs to be added to HTTP response being sent towards downstream. Headers specified at this level are applied after headers from matched Route are applied<br>See [Response Headers To Add](#add-91639a) below.
162
+ <a id="add-91639a"></a>&#x2022; [`response_headers_to_add`](#add-91639a) - Optional Block<br>Headers are key-value pairs to be added to HTTP response being sent towards downstream. Headers specified at this level are applied after headers from matched Route are applied<br>See [Response Headers To Add](#add-91639a) below.
163
163
 
164
- <a id="remove-8ec5bc"></a>&#x2022; [`response_headers_to_remove`](#remove-8ec5bc) - Optional List<br>Remove Response Headers. List of keys of Headers to be removed from the HTTP response being sent towards downstream
164
+ <a id="remove-8ec5bc"></a>&#x2022; [`response_headers_to_remove`](#remove-8ec5bc) - Optional List<br>List of keys of Headers to be removed from the HTTP response being sent towards downstream
165
165
 
166
166
  #### Dynamic Proxy HTTP Proxy More Option Buffer Policy
167
167
 
@@ -239,7 +239,7 @@ A [`more_option`](#dynamic-proxy-http-proxy-more-option) block (within [`dynamic
239
239
 
240
240
  A [`https_proxy`](#dynamic-proxy-https-proxy) block (within [`dynamic_proxy`](#dynamic-proxy)) supports the following:
241
241
 
242
- <a id="dynamic-proxy-https-proxy-more-option"></a>&#x2022; [`more_option`](#dynamic-proxy-https-proxy-more-option) - Optional Block<br>Advanced OPTIONS. This defines various OPTIONS to define a route<br>See [More Option](#dynamic-proxy-https-proxy-more-option) below.
242
+ <a id="dynamic-proxy-https-proxy-more-option"></a>&#x2022; [`more_option`](#dynamic-proxy-https-proxy-more-option) - Optional Block<br>Defines various OPTIONS to define a route<br>See [More Option](#dynamic-proxy-https-proxy-more-option) below.
243
243
 
244
244
  <a id="dynamic-proxy-https-proxy-tls-params"></a>&#x2022; [`tls_params`](#dynamic-proxy-https-proxy-tls-params) - Optional Block<br>Inline TLS Parameters. Inline TLS parameters<br>See [TLS Params](#dynamic-proxy-https-proxy-tls-params) below.
245
245
 
@@ -247,37 +247,37 @@ A [`https_proxy`](#dynamic-proxy-https-proxy) block (within [`dynamic_proxy`](#d
247
247
 
248
248
  A [`more_option`](#dynamic-proxy-https-proxy-more-option) block (within [`dynamic_proxy.https_proxy`](#dynamic-proxy-https-proxy)) supports the following:
249
249
 
250
- <a id="policy-5af133"></a>&#x2022; [`buffer_policy`](#policy-5af133) - Optional Block<br>Buffer Configuration. Some upstream applications are not capable of handling streamed data. This config enables buffering the entire request before sending to upstream application. We can specify the maximum buffer size and buffer interval with this config. Buffering can be enabled and disabled at VirtualHost and Route levels Route level buffer configuration takes precedence<br>See [Buffer Policy](#policy-5af133) below.
250
+ <a id="policy-5af133"></a>&#x2022; [`buffer_policy`](#policy-5af133) - 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-5af133) below.
251
251
 
252
- <a id="params-013546"></a>&#x2022; [`compression_params`](#params-013546) - Optional Block<br>Compression Parameters. Enables loadbalancer to compress dispatched data from an upstream service upon client request. The content is compressed and then sent to the client with the appropriate headers if either response and request allow. Only GZIP compression is supported. By default compression will be skipped when: A request does NOT contain accept-encoding header. A request includes accept-encoding header, but it does not contain “gzip” or “*”. A request includes accept-encoding with “gzip” or “*” with the weight “q=0”. Note that the “gzip” will have a higher weight then “*”. For example, if accept-encoding is “gzip;q=0,*;q=1”, the filter will not compress. But if the header is set to “*;q=0,gzip;q=1”, the filter will compress. A request whose accept-encoding header includes “identity”. A response contains a content-encoding header. A response contains a cache-control header whose value includes “no-transform”. A response contains a transfer-encoding header whose value includes “gzip”. A response does not contain a content-type value that matches one of the selected mime-types, which default to application/javascript, application/JSON, application/xhtml+XML, image/svg+XML, text/CSS, text/HTML, text/plain, text/XML. Neither content-length nor transfer-encoding headers are present in the response. Response size is smaller than 30 bytes (only applicable when transfer-encoding is not chunked). When compression is applied: The content-length is removed from response headers. Response headers contain “transfer-encoding: chunked” and do not contain “content-encoding” header. The “vary: accept-encoding” header is inserted on every response. GZIP Compression Level: A value which is optimal balance between speed of compression and amount of compression is chosen<br>See [Compression Params](#params-013546) below.
252
+ <a id="params-013546"></a>&#x2022; [`compression_params`](#params-013546) - Optional Block<br>Enables loadbalancer to compress dispatched data from an upstream service upon client request. The content is compressed and then sent to the client with the appropriate headers if either response and request allow. Only GZIP compression is supported<br>See [Compression Params](#params-013546) below.
253
253
 
254
- <a id="errors-01c21a"></a>&#x2022; [`custom_errors`](#errors-01c21a) - Optional Block<br>Custom Error Responses. Map of integer error codes as keys and string values that can be used to provide custom HTTP pages for each error code. Key of the map can be either response code class or HTTP Error code. Response code classes for key is configured as follows 3 -- for 3xx response code class 4 -- for 4xx response code class 5 -- for 5xx response code class Value of the map is string which represents custom HTTP responses. Specific response code takes preference when both response code and response code class matches for a request
254
+ <a id="errors-01c21a"></a>&#x2022; [`custom_errors`](#errors-01c21a) - Optional Block<br>Map of integer error codes as keys and string values that can be used to provide custom HTTP pages for each error code. Key of the map can be either response code class or HTTP Error code. Response code classes for key is configured as follows 3 -- for 3xx response code class 4 -- for 4xx
255
255
 
256
- <a id="pages-9edd65"></a>&#x2022; [`disable_default_error_pages`](#pages-9edd65) - Optional Bool<br>Disable Default Error Pages. Disable the use of default F5XC error pages
256
+ <a id="pages-9edd65"></a>&#x2022; [`disable_default_error_pages`](#pages-9edd65) - Optional Bool<br>Disable the use of default F5XC error pages
257
257
 
258
- <a id="normalize-780e38"></a>&#x2022; [`disable_path_normalize`](#normalize-780e38) - Optional Block<br>Enable this option
258
+ <a id="normalize-780e38"></a>&#x2022; [`disable_path_normalize`](#normalize-780e38) - Optional Block<br>Can be used for messages where no values are needed
259
259
 
260
- <a id="normalize-a240ab"></a>&#x2022; [`enable_path_normalize`](#normalize-a240ab) - Optional Block<br>Enable this option
260
+ <a id="normalize-a240ab"></a>&#x2022; [`enable_path_normalize`](#normalize-a240ab) - Optional Block<br>Can be used for messages where no values are needed
261
261
 
262
- <a id="timeout-1062ad"></a>&#x2022; [`idle_timeout`](#timeout-1062ad) - Optional Number<br>Idle Timeout. 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
262
+ <a id="timeout-1062ad"></a>&#x2022; [`idle_timeout`](#timeout-1062ad) - 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
263
263
 
264
- <a id="size-620c3f"></a>&#x2022; [`max_request_header_size`](#size-620c3f) - Optional Number<br>Maximum Request Header Size. The maximum request header size for downstream connections, in KiB. A HTTP 431 (Request Header Fields Too Large) error code is sent for requests that exceed this size. If multiple load balancers share the same advertise_policy, the highest value configured across all such load balancers is used for all the load balancers in question
264
+ <a id="size-620c3f"></a>&#x2022; [`max_request_header_size`](#size-620c3f) - Optional Number<br>The maximum request header size for downstream connections, in KiB. A HTTP 431 (Request Header Fields Too Large) error code is sent for requests that exceed this size. If multiple load balancers share the same advertise_policy, the highest value configured across all such load balancers is used
265
265
 
266
- <a id="add-1b5bcd"></a>&#x2022; [`request_cookies_to_add`](#add-1b5bcd) - Optional Block<br>Add Cookies in Cookie Header. Cookies are key-value pairs to be added to HTTP request being routed towards upstream. Cookies specified at this level are applied after cookies from matched Route are applied<br>See [Request Cookies To Add](#add-1b5bcd) below.
266
+ <a id="add-1b5bcd"></a>&#x2022; [`request_cookies_to_add`](#add-1b5bcd) - Optional Block<br>Cookies are key-value pairs to be added to HTTP request being routed towards upstream. Cookies specified at this level are applied after cookies from matched Route are applied<br>See [Request Cookies To Add](#add-1b5bcd) below.
267
267
 
268
- <a id="remove-cfd658"></a>&#x2022; [`request_cookies_to_remove`](#remove-cfd658) - Optional List<br>Remove Cookies from Cookie Header. List of keys of Cookies to be removed from the HTTP request being sent towards upstream
268
+ <a id="remove-cfd658"></a>&#x2022; [`request_cookies_to_remove`](#remove-cfd658) - Optional List<br>List of keys of Cookies to be removed from the HTTP request being sent towards upstream
269
269
 
270
- <a id="add-0332ff"></a>&#x2022; [`request_headers_to_add`](#add-0332ff) - Optional Block<br>Add Request Headers. Headers are key-value pairs to be added to HTTP request being routed towards upstream. Headers specified at this level are applied after headers from matched Route are applied<br>See [Request Headers To Add](#add-0332ff) below.
270
+ <a id="add-0332ff"></a>&#x2022; [`request_headers_to_add`](#add-0332ff) - Optional Block<br>Headers are key-value pairs to be added to HTTP request being routed towards upstream. Headers specified at this level are applied after headers from matched Route are applied<br>See [Request Headers To Add](#add-0332ff) below.
271
271
 
272
- <a id="remove-606625"></a>&#x2022; [`request_headers_to_remove`](#remove-606625) - Optional List<br>Remove Request Headers. List of keys of Headers to be removed from the HTTP request being sent towards upstream
272
+ <a id="remove-606625"></a>&#x2022; [`request_headers_to_remove`](#remove-606625) - Optional List<br>List of keys of Headers to be removed from the HTTP request being sent towards upstream
273
273
 
274
- <a id="add-dd9473"></a>&#x2022; [`response_cookies_to_add`](#add-dd9473) - Optional Block<br>Add Set-Cookie Headers. Cookies are name-value pairs along with optional attribute parameters to be added to HTTP response being sent towards downstream. Cookies specified at this level are applied after cookies from matched Route are applied<br>See [Response Cookies To Add](#add-dd9473) below.
274
+ <a id="add-dd9473"></a>&#x2022; [`response_cookies_to_add`](#add-dd9473) - Optional Block<br>Cookies are name-value pairs along with optional attribute parameters to be added to HTTP response being sent towards downstream. Cookies specified at this level are applied after cookies from matched Route are applied<br>See [Response Cookies To Add](#add-dd9473) below.
275
275
 
276
- <a id="remove-5d52c7"></a>&#x2022; [`response_cookies_to_remove`](#remove-5d52c7) - Optional List<br>Remove Cookies from Set-Cookie Headers. List of name of Cookies to be removed from the HTTP response being sent towards downstream. Entire set-cookie header will be removed
276
+ <a id="remove-5d52c7"></a>&#x2022; [`response_cookies_to_remove`](#remove-5d52c7) - Optional List<br>List of name of Cookies to be removed from the HTTP response being sent towards downstream. Entire set-cookie header will be removed
277
277
 
278
- <a id="add-db908d"></a>&#x2022; [`response_headers_to_add`](#add-db908d) - Optional Block<br>Add Response Headers. Headers are key-value pairs to be added to HTTP response being sent towards downstream. Headers specified at this level are applied after headers from matched Route are applied<br>See [Response Headers To Add](#add-db908d) below.
278
+ <a id="add-db908d"></a>&#x2022; [`response_headers_to_add`](#add-db908d) - Optional Block<br>Headers are key-value pairs to be added to HTTP response being sent towards downstream. Headers specified at this level are applied after headers from matched Route are applied<br>See [Response Headers To Add](#add-db908d) below.
279
279
 
280
- <a id="remove-27e742"></a>&#x2022; [`response_headers_to_remove`](#remove-27e742) - Optional List<br>Remove Response Headers. List of keys of Headers to be removed from the HTTP response being sent towards downstream
280
+ <a id="remove-27e742"></a>&#x2022; [`response_headers_to_remove`](#remove-27e742) - Optional List<br>List of keys of Headers to be removed from the HTTP response being sent towards downstream
281
281
 
282
282
  #### Dynamic Proxy HTTPS Proxy More Option Buffer Policy
283
283
 
@@ -355,13 +355,13 @@ A [`more_option`](#dynamic-proxy-https-proxy-more-option) block (within [`dynami
355
355
 
356
356
  A [`tls_params`](#dynamic-proxy-https-proxy-tls-params) block (within [`dynamic_proxy.https_proxy`](#dynamic-proxy-https-proxy)) supports the following:
357
357
 
358
- <a id="mtls-1872dc"></a>&#x2022; [`no_mtls`](#mtls-1872dc) - Optional Block<br>Enable this option
358
+ <a id="mtls-1872dc"></a>&#x2022; [`no_mtls`](#mtls-1872dc) - Optional Block<br>Can be used for messages where no values are needed
359
359
 
360
- <a id="certificates-6f0e81"></a>&#x2022; [`tls_certificates`](#certificates-6f0e81) - Optional Block<br>TLS Certificates. 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](#certificates-6f0e81) below.
360
+ <a id="certificates-6f0e81"></a>&#x2022; [`tls_certificates`](#certificates-6f0e81) - 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](#certificates-6f0e81) below.
361
361
 
362
- <a id="config-116b33"></a>&#x2022; [`tls_config`](#config-116b33) - Optional Block<br>TLS Config. This defines various OPTIONS to configure TLS configuration parameters<br>See [TLS Config](#config-116b33) below.
362
+ <a id="config-116b33"></a>&#x2022; [`tls_config`](#config-116b33) - Optional Block<br>Defines various OPTIONS to configure TLS configuration parameters<br>See [TLS Config](#config-116b33) below.
363
363
 
364
- <a id="mtls-7179b9"></a>&#x2022; [`use_mtls`](#mtls-7179b9) - Optional Block<br>Clients TLS validation context. Validation context for downstream client TLS connections<br>See [Use mTLS](#mtls-7179b9) below.
364
+ <a id="mtls-7179b9"></a>&#x2022; [`use_mtls`](#mtls-7179b9) - Optional Block<br>Validation context for downstream client TLS connections<br>See [Use mTLS](#mtls-7179b9) below.
365
365
 
366
366
  #### Dynamic Proxy HTTPS Proxy TLS Params TLS Certificates
367
367
 
@@ -411,71 +411,71 @@ A [`tls_params`](#dynamic-proxy-https-proxy-tls-params) block (within [`dynamic_
411
411
 
412
412
  A [`sni_proxy`](#dynamic-proxy-sni-proxy) block (within [`dynamic_proxy`](#dynamic-proxy)) supports the following:
413
413
 
414
- <a id="dynamic-proxy-sni-proxy-idle-timeout"></a>&#x2022; [`idle_timeout`](#dynamic-proxy-sni-proxy-idle-timeout) - Optional Number<br>Idle Timeout. The amount of time that a stream can exist without upstream or downstream activity, in milliseconds
414
+ <a id="dynamic-proxy-sni-proxy-idle-timeout"></a>&#x2022; [`idle_timeout`](#dynamic-proxy-sni-proxy-idle-timeout) - Optional Number<br>The amount of time that a stream can exist without upstream or downstream activity, in milliseconds
415
415
 
416
416
  #### HTTP Proxy
417
417
 
418
418
  A [`http_proxy`](#http-proxy) block supports the following:
419
419
 
420
- <a id="http-proxy-enable-http"></a>&#x2022; [`enable_http`](#http-proxy-enable-http) - Optional Block<br>Enable this option
420
+ <a id="http-proxy-enable-http"></a>&#x2022; [`enable_http`](#http-proxy-enable-http) - Optional Block<br>Can be used for messages where no values are needed
421
421
 
422
- <a id="http-proxy-more-option"></a>&#x2022; [`more_option`](#http-proxy-more-option) - Optional Block<br>Advanced OPTIONS. This defines various OPTIONS to define a route<br>See [More Option](#http-proxy-more-option) below.
422
+ <a id="http-proxy-more-option"></a>&#x2022; [`more_option`](#http-proxy-more-option) - Optional Block<br>Defines various OPTIONS to define a route<br>See [More Option](#http-proxy-more-option) below.
423
423
 
424
424
  #### HTTP Proxy More Option
425
425
 
426
426
  A [`more_option`](#http-proxy-more-option) block (within [`http_proxy`](#http-proxy)) supports the following:
427
427
 
428
- <a id="http-proxy-more-option-buffer-policy"></a>&#x2022; [`buffer_policy`](#http-proxy-more-option-buffer-policy) - Optional Block<br>Buffer Configuration. Some upstream applications are not capable of handling streamed data. This config enables buffering the entire request before sending to upstream application. We can specify the maximum buffer size and buffer interval with this config. Buffering can be enabled and disabled at VirtualHost and Route levels Route level buffer configuration takes precedence<br>See [Buffer Policy](#http-proxy-more-option-buffer-policy) below.
428
+ <a id="http-proxy-more-option-buffer-policy"></a>&#x2022; [`buffer_policy`](#http-proxy-more-option-buffer-policy) - Optional Block<br>Some upstream applications are not capable of handling streamed data. This config enables buffering the entire request before sending to upstream application. We can specify the maximum buffer size and buffer interval with this config<br>See [Buffer Policy](#http-proxy-more-option-buffer-policy) below.
429
429
 
430
- <a id="params-c32856"></a>&#x2022; [`compression_params`](#params-c32856) - Optional Block<br>Compression Parameters. Enables loadbalancer to compress dispatched data from an upstream service upon client request. The content is compressed and then sent to the client with the appropriate headers if either response and request allow. Only GZIP compression is supported. By default compression will be skipped when: A request does NOT contain accept-encoding header. A request includes accept-encoding header, but it does not contain “gzip” or “*”. A request includes accept-encoding with “gzip” or “*” with the weight “q=0”. Note that the “gzip” will have a higher weight then “*”. For example, if accept-encoding is “gzip;q=0,*;q=1”, the filter will not compress. But if the header is set to “*;q=0,gzip;q=1”, the filter will compress. A request whose accept-encoding header includes “identity”. A response contains a content-encoding header. A response contains a cache-control header whose value includes “no-transform”. A response contains a transfer-encoding header whose value includes “gzip”. A response does not contain a content-type value that matches one of the selected mime-types, which default to application/javascript, application/JSON, application/xhtml+XML, image/svg+XML, text/CSS, text/HTML, text/plain, text/XML. Neither content-length nor transfer-encoding headers are present in the response. Response size is smaller than 30 bytes (only applicable when transfer-encoding is not chunked). When compression is applied: The content-length is removed from response headers. Response headers contain “transfer-encoding: chunked” and do not contain “content-encoding” header. The “vary: accept-encoding” header is inserted on every response. GZIP Compression Level: A value which is optimal balance between speed of compression and amount of compression is chosen<br>See [Compression Params](#params-c32856) below.
430
+ <a id="params-c32856"></a>&#x2022; [`compression_params`](#params-c32856) - Optional Block<br>Enables loadbalancer to compress dispatched data from an upstream service upon client request. The content is compressed and then sent to the client with the appropriate headers if either response and request allow. Only GZIP compression is supported<br>See [Compression Params](#params-c32856) below.
431
431
 
432
- <a id="http-proxy-more-option-custom-errors"></a>&#x2022; [`custom_errors`](#http-proxy-more-option-custom-errors) - Optional Block<br>Custom Error Responses. Map of integer error codes as keys and string values that can be used to provide custom HTTP pages for each error code. Key of the map can be either response code class or HTTP Error code. Response code classes for key is configured as follows 3 -- for 3xx response code class 4 -- for 4xx response code class 5 -- for 5xx response code class Value of the map is string which represents custom HTTP responses. Specific response code takes preference when both response code and response code class matches for a request
432
+ <a id="http-proxy-more-option-custom-errors"></a>&#x2022; [`custom_errors`](#http-proxy-more-option-custom-errors) - Optional Block<br>Map of integer error codes as keys and string values that can be used to provide custom HTTP pages for each error code. Key of the map can be either response code class or HTTP Error code. Response code classes for key is configured as follows 3 -- for 3xx response code class 4 -- for 4xx
433
433
 
434
- <a id="pages-159caf"></a>&#x2022; [`disable_default_error_pages`](#pages-159caf) - Optional Bool<br>Disable Default Error Pages. Disable the use of default F5XC error pages
434
+ <a id="pages-159caf"></a>&#x2022; [`disable_default_error_pages`](#pages-159caf) - Optional Bool<br>Disable the use of default F5XC error pages
435
435
 
436
- <a id="normalize-3090b6"></a>&#x2022; [`disable_path_normalize`](#normalize-3090b6) - Optional Block<br>Enable this option
436
+ <a id="normalize-3090b6"></a>&#x2022; [`disable_path_normalize`](#normalize-3090b6) - Optional Block<br>Can be used for messages where no values are needed
437
437
 
438
- <a id="normalize-8562f8"></a>&#x2022; [`enable_path_normalize`](#normalize-8562f8) - Optional Block<br>Enable this option
438
+ <a id="normalize-8562f8"></a>&#x2022; [`enable_path_normalize`](#normalize-8562f8) - Optional Block<br>Can be used for messages where no values are needed
439
439
 
440
- <a id="http-proxy-more-option-idle-timeout"></a>&#x2022; [`idle_timeout`](#http-proxy-more-option-idle-timeout) - Optional Number<br>Idle Timeout. 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
440
+ <a id="http-proxy-more-option-idle-timeout"></a>&#x2022; [`idle_timeout`](#http-proxy-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
441
441
 
442
- <a id="size-c24d2e"></a>&#x2022; [`max_request_header_size`](#size-c24d2e) - Optional Number<br>Maximum Request Header Size. The maximum request header size for downstream connections, in KiB. A HTTP 431 (Request Header Fields Too Large) error code is sent for requests that exceed this size. If multiple load balancers share the same advertise_policy, the highest value configured across all such load balancers is used for all the load balancers in question
442
+ <a id="size-c24d2e"></a>&#x2022; [`max_request_header_size`](#size-c24d2e) - Optional Number<br>The maximum request header size for downstream connections, in KiB. A HTTP 431 (Request Header Fields Too Large) error code is sent for requests that exceed this size. If multiple load balancers share the same advertise_policy, the highest value configured across all such load balancers is used
443
443
 
444
- <a id="add-19fe20"></a>&#x2022; [`request_cookies_to_add`](#add-19fe20) - Optional Block<br>Add Cookies in Cookie Header. Cookies are key-value pairs to be added to HTTP request being routed towards upstream. Cookies specified at this level are applied after cookies from matched Route are applied<br>See [Request Cookies To Add](#add-19fe20) below.
444
+ <a id="add-19fe20"></a>&#x2022; [`request_cookies_to_add`](#add-19fe20) - Optional Block<br>Cookies are key-value pairs to be added to HTTP request being routed towards upstream. Cookies specified at this level are applied after cookies from matched Route are applied<br>See [Request Cookies To Add](#add-19fe20) below.
445
445
 
446
- <a id="remove-14fff8"></a>&#x2022; [`request_cookies_to_remove`](#remove-14fff8) - Optional List<br>Remove Cookies from Cookie Header. List of keys of Cookies to be removed from the HTTP request being sent towards upstream
446
+ <a id="remove-14fff8"></a>&#x2022; [`request_cookies_to_remove`](#remove-14fff8) - Optional List<br>List of keys of Cookies to be removed from the HTTP request being sent towards upstream
447
447
 
448
- <a id="add-1a07e4"></a>&#x2022; [`request_headers_to_add`](#add-1a07e4) - Optional Block<br>Add Request Headers. Headers are key-value pairs to be added to HTTP request being routed towards upstream. Headers specified at this level are applied after headers from matched Route are applied<br>See [Request Headers To Add](#add-1a07e4) below.
448
+ <a id="add-1a07e4"></a>&#x2022; [`request_headers_to_add`](#add-1a07e4) - Optional Block<br>Headers are key-value pairs to be added to HTTP request being routed towards upstream. Headers specified at this level are applied after headers from matched Route are applied<br>See [Request Headers To Add](#add-1a07e4) below.
449
449
 
450
- <a id="remove-58b55a"></a>&#x2022; [`request_headers_to_remove`](#remove-58b55a) - Optional List<br>Remove Request Headers. List of keys of Headers to be removed from the HTTP request being sent towards upstream
450
+ <a id="remove-58b55a"></a>&#x2022; [`request_headers_to_remove`](#remove-58b55a) - Optional List<br>List of keys of Headers to be removed from the HTTP request being sent towards upstream
451
451
 
452
- <a id="add-9fc6d2"></a>&#x2022; [`response_cookies_to_add`](#add-9fc6d2) - Optional Block<br>Add Set-Cookie Headers. Cookies are name-value pairs along with optional attribute parameters to be added to HTTP response being sent towards downstream. Cookies specified at this level are applied after cookies from matched Route are applied<br>See [Response Cookies To Add](#add-9fc6d2) below.
452
+ <a id="add-9fc6d2"></a>&#x2022; [`response_cookies_to_add`](#add-9fc6d2) - Optional Block<br>Cookies are name-value pairs along with optional attribute parameters to be added to HTTP response being sent towards downstream. Cookies specified at this level are applied after cookies from matched Route are applied<br>See [Response Cookies To Add](#add-9fc6d2) below.
453
453
 
454
- <a id="remove-c6e6e0"></a>&#x2022; [`response_cookies_to_remove`](#remove-c6e6e0) - Optional List<br>Remove Cookies from Set-Cookie Headers. List of name of Cookies to be removed from the HTTP response being sent towards downstream. Entire set-cookie header will be removed
454
+ <a id="remove-c6e6e0"></a>&#x2022; [`response_cookies_to_remove`](#remove-c6e6e0) - Optional List<br>List of name of Cookies to be removed from the HTTP response being sent towards downstream. Entire set-cookie header will be removed
455
455
 
456
- <a id="add-3fc2d5"></a>&#x2022; [`response_headers_to_add`](#add-3fc2d5) - Optional Block<br>Add Response Headers. Headers are key-value pairs to be added to HTTP response being sent towards downstream. Headers specified at this level are applied after headers from matched Route are applied<br>See [Response Headers To Add](#add-3fc2d5) below.
456
+ <a id="add-3fc2d5"></a>&#x2022; [`response_headers_to_add`](#add-3fc2d5) - Optional Block<br>Headers are key-value pairs to be added to HTTP response being sent towards downstream. Headers specified at this level are applied after headers from matched Route are applied<br>See [Response Headers To Add](#add-3fc2d5) below.
457
457
 
458
- <a id="remove-738a4c"></a>&#x2022; [`response_headers_to_remove`](#remove-738a4c) - Optional List<br>Remove Response Headers. List of keys of Headers to be removed from the HTTP response being sent towards downstream
458
+ <a id="remove-738a4c"></a>&#x2022; [`response_headers_to_remove`](#remove-738a4c) - Optional List<br>List of keys of Headers to be removed from the HTTP response being sent towards downstream
459
459
 
460
460
  #### HTTP Proxy More Option Buffer Policy
461
461
 
462
462
  A [`buffer_policy`](#http-proxy-more-option-buffer-policy) block (within [`http_proxy.more_option`](#http-proxy-more-option)) supports the following:
463
463
 
464
- <a id="disabled-107694"></a>&#x2022; [`disabled`](#disabled-107694) - Optional Bool<br>Disable. Disable buffering for a particular route. This is useful when virtual-host has buffering, but we need to disable it on a specific route. The value of this field is ignored for virtual-host
464
+ <a id="disabled-107694"></a>&#x2022; [`disabled`](#disabled-107694) - Optional Bool<br>Disable buffering for a particular route. This is useful when virtual-host has buffering, but we need to disable it on a specific route. The value of this field is ignored for virtual-host
465
465
 
466
- <a id="bytes-b00d03"></a>&#x2022; [`max_request_bytes`](#bytes-b00d03) - Optional Number<br>Max Request Bytes. The maximum request size that the filter will buffer before the connection manager will stop buffering and return a RequestEntityTooLarge (413) response
466
+ <a id="bytes-b00d03"></a>&#x2022; [`max_request_bytes`](#bytes-b00d03) - Optional Number<br>The maximum request size that the filter will buffer before the connection manager will stop buffering and return a RequestEntityTooLarge (413) response
467
467
 
468
468
  #### HTTP Proxy More Option Compression Params
469
469
 
470
470
  A [`compression_params`](#params-c32856) block (within [`http_proxy.more_option`](#http-proxy-more-option)) supports the following:
471
471
 
472
- <a id="length-c8573b"></a>&#x2022; [`content_length`](#length-c8573b) - Optional Number Defaults to `30`<br>Content Length. Minimum response length, in bytes, which will trigger compression. The
472
+ <a id="length-c8573b"></a>&#x2022; [`content_length`](#length-c8573b) - Optional Number Defaults to `30`<br>Minimum response length, in bytes, which will trigger compression. The
473
473
 
474
- <a id="type-794ba2"></a>&#x2022; [`content_type`](#type-794ba2) - Optional List<br>Content Type. Set of strings that allows specifying which mime-types yield compression When this field is not defined, compression will be applied to the following mime-types: 'application/javascript' 'application/JSON', 'application/xhtml+XML' 'image/svg+XML' 'text/CSS' 'text/HTML' 'text/plain' 'text/XML'
474
+ <a id="type-794ba2"></a>&#x2022; [`content_type`](#type-794ba2) - Optional List<br>Set of strings that allows specifying which mime-types yield compression When this field is not defined, compression will be applied to the following mime-types: 'application/javascript' 'application/JSON', 'application/xhtml+XML' 'image/svg+XML' 'text/CSS' 'text/HTML' 'text/plain' 'text/XML'
475
475
 
476
- <a id="header-2ffee9"></a>&#x2022; [`disable_on_etag_header`](#header-2ffee9) - Optional Bool<br>Disable On Etag Header. If true, disables compression when the response contains an etag header. When it is false, weak etags will be preserved and the ones that require strong validation will be removed
476
+ <a id="header-2ffee9"></a>&#x2022; [`disable_on_etag_header`](#header-2ffee9) - Optional Bool<br>If true, disables compression when the response contains an etag header. When it is false, weak etags will be preserved and the ones that require strong validation will be removed
477
477
 
478
- <a id="header-925ccf"></a>&#x2022; [`remove_accept_encoding_header`](#header-925ccf) - Optional Bool<br>Remove Accept-Encoding Header. If true, removes accept-encoding from the request headers before dispatching it to the upstream so that responses do not GET compressed before reaching the filter
478
+ <a id="header-925ccf"></a>&#x2022; [`remove_accept_encoding_header`](#header-925ccf) - Optional Bool<br>If true, removes accept-encoding from the request headers before dispatching it to the upstream so that responses do not GET compressed before reaching the filter
479
479
 
480
480
  #### HTTP Proxy More Option Request Cookies To Add
481
481
 
@@ -545,47 +545,47 @@ A [`compression_params`](#params-c32856) block (within [`http_proxy.more_option`
545
545
 
546
546
  A [`site_virtual_sites`](#site-virtual-sites) block supports the following:
547
547
 
548
- <a id="site-virtual-sites-advertise-where"></a>&#x2022; [`advertise_where`](#site-virtual-sites-advertise-where) - Optional Block<br>List of Sites to Advertise. Where should this load balancer be available<br>See [Advertise Where](#site-virtual-sites-advertise-where) below.
548
+ <a id="site-virtual-sites-advertise-where"></a>&#x2022; [`advertise_where`](#site-virtual-sites-advertise-where) - Optional Block<br>Where should this load balancer be available<br>See [Advertise Where](#site-virtual-sites-advertise-where) below.
549
549
 
550
550
  #### Site Virtual Sites Advertise Where
551
551
 
552
552
  An [`advertise_where`](#site-virtual-sites-advertise-where) block (within [`site_virtual_sites`](#site-virtual-sites)) supports the following:
553
553
 
554
- <a id="site-virtual-sites-advertise-where-port"></a>&#x2022; [`port`](#site-virtual-sites-advertise-where-port) - Optional Number<br>TCP Listen Port. TCP port to Listen
554
+ <a id="site-virtual-sites-advertise-where-port"></a>&#x2022; [`port`](#site-virtual-sites-advertise-where-port) - Optional Number<br>TCP port to Listen
555
555
 
556
- <a id="site-virtual-sites-advertise-where-site"></a>&#x2022; [`site`](#site-virtual-sites-advertise-where-site) - Optional Block<br>Site. This 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](#site-virtual-sites-advertise-where-site) below.
556
+ <a id="site-virtual-sites-advertise-where-site"></a>&#x2022; [`site`](#site-virtual-sites-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](#site-virtual-sites-advertise-where-site) below.
557
557
 
558
- <a id="port-7cb8fb"></a>&#x2022; [`use_default_port`](#port-7cb8fb) - Optional Block<br>Enable this option
558
+ <a id="port-7cb8fb"></a>&#x2022; [`use_default_port`](#port-7cb8fb) - Optional Block<br>Can be used for messages where no values are needed
559
559
 
560
- <a id="site-7107b1"></a>&#x2022; [`virtual_site`](#site-7107b1) - Optional Block<br>Virtual Site. This defines a reference to a customer site virtual site along with network type where a load balancer could be advertised<br>See [Virtual Site](#site-7107b1) below.
560
+ <a id="site-7107b1"></a>&#x2022; [`virtual_site`](#site-7107b1) - Optional Block<br>Defines a reference to a customer site virtual site along with network type where a load balancer could be advertised<br>See [Virtual Site](#site-7107b1) below.
561
561
 
562
562
  #### Site Virtual Sites Advertise Where Site
563
563
 
564
564
  A [`site`](#site-virtual-sites-advertise-where-site) block (within [`site_virtual_sites.advertise_where`](#site-virtual-sites-advertise-where)) supports the following:
565
565
 
566
- <a id="site-ip-4eb476"></a>&#x2022; [`ip`](#site-ip-4eb476) - Optional String<br>IP Address. Use given IP address as VIP on the site
566
+ <a id="site-ip-4eb476"></a>&#x2022; [`ip`](#site-ip-4eb476) - Optional String<br>Use given IP address as VIP on the site
567
567
 
568
- <a id="network-647eba"></a>&#x2022; [`network`](#network-647eba) - Optional String Defaults to `SITE_NETWORK_INSIDE_AND_OUTSIDE`<br>Possible values are `SITE_NETWORK_INSIDE_AND_OUTSIDE`, `SITE_NETWORK_INSIDE`, `SITE_NETWORK_OUTSIDE`, `SITE_NETWORK_SERVICE`, `SITE_NETWORK_OUTSIDE_WITH_INTERNET_VIP`, `SITE_NETWORK_INSIDE_AND_OUTSIDE_WITH_INTERNET_VIP`, `SITE_NETWORK_IP_FABRIC`<br>[Enum: SITE_NETWORK_INSIDE_AND_OUTSIDE|SITE_NETWORK_INSIDE|SITE_NETWORK_OUTSIDE|SITE_NETWORK_SERVICE|SITE_NETWORK_OUTSIDE_WITH_INTERNET_VIP|SITE_NETWORK_INSIDE_AND_OUTSIDE_WITH_INTERNET_VIP|SITE_NETWORK_IP_FABRIC] Site Network. This defines network types to be used on site All inside and outside networks. All inside and outside networks with internet VIP support. All inside networks. All outside networks. All outside networks with internet VIP support. VK8s service network. - SITE_NETWORK_IP_FABRIC: VER IP Fabric network for the site This Virtual network type is used for exposing virtual host on IP Fabric network on the VER site or for endpoint in IP Fabric network
568
+ <a id="network-647eba"></a>&#x2022; [`network`](#network-647eba) - Optional String Defaults to `SITE_NETWORK_INSIDE_AND_OUTSIDE`<br>Possible values are `SITE_NETWORK_INSIDE_AND_OUTSIDE`, `SITE_NETWORK_INSIDE`, `SITE_NETWORK_OUTSIDE`, `SITE_NETWORK_SERVICE`, `SITE_NETWORK_OUTSIDE_WITH_INTERNET_VIP`, `SITE_NETWORK_INSIDE_AND_OUTSIDE_WITH_INTERNET_VIP`, `SITE_NETWORK_IP_FABRIC`<br>[Enum: SITE_NETWORK_INSIDE_AND_OUTSIDE|SITE_NETWORK_INSIDE|SITE_NETWORK_OUTSIDE|SITE_NETWORK_SERVICE|SITE_NETWORK_OUTSIDE_WITH_INTERNET_VIP|SITE_NETWORK_INSIDE_AND_OUTSIDE_WITH_INTERNET_VIP|SITE_NETWORK_IP_FABRIC] Defines network types to be used on site All inside and outside networks. All inside and outside networks with internet VIP support. All inside networks
569
569
 
570
- <a id="site-91e167"></a>&#x2022; [`site`](#site-91e167) - Optional Block<br>Object reference. This type establishes a direct reference from one object(the referrer) to another(the referred). Such a reference is in form of tenant/namespace/name<br>See [Site](#site-91e167) below.
570
+ <a id="site-91e167"></a>&#x2022; [`site`](#site-91e167) - 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 [Site](#site-91e167) below.
571
571
 
572
572
  #### Site Virtual Sites Advertise Where Site Site
573
573
 
574
574
  A [`site`](#site-91e167) block (within [`site_virtual_sites.advertise_where.site`](#site-virtual-sites-advertise-where-site)) supports the following:
575
575
 
576
- <a id="name-e8af64"></a>&#x2022; [`name`](#name-e8af64) - Optional String<br>Name. When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object's(e.g. Route's) name
576
+ <a id="name-e8af64"></a>&#x2022; [`name`](#name-e8af64) - Optional String<br>When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object's(e.g. Route's) name
577
577
 
578
- <a id="namespace-81a6ad"></a>&#x2022; [`namespace`](#namespace-81a6ad) - Optional String<br>Namespace. When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object's(e.g. Route's) namespace
578
+ <a id="namespace-81a6ad"></a>&#x2022; [`namespace`](#namespace-81a6ad) - Optional String<br>When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object's(e.g. Route's) namespace
579
579
 
580
- <a id="tenant-d56172"></a>&#x2022; [`tenant`](#tenant-d56172) - Optional String<br>Tenant. When a configuration object(e.g. Virtual_host) refers to another(e.g route) then tenant will hold the referred object's(e.g. Route's) tenant
580
+ <a id="tenant-d56172"></a>&#x2022; [`tenant`](#tenant-d56172) - Optional String<br>When a configuration object(e.g. Virtual_host) refers to another(e.g route) then tenant will hold the referred object's(e.g. Route's) tenant
581
581
 
582
582
  #### Site Virtual Sites Advertise Where Virtual Site
583
583
 
584
584
  A [`virtual_site`](#site-7107b1) block (within [`site_virtual_sites.advertise_where`](#site-virtual-sites-advertise-where)) supports the following:
585
585
 
586
- <a id="network-31ecf8"></a>&#x2022; [`network`](#network-31ecf8) - Optional String Defaults to `SITE_NETWORK_INSIDE_AND_OUTSIDE`<br>Possible values are `SITE_NETWORK_INSIDE_AND_OUTSIDE`, `SITE_NETWORK_INSIDE`, `SITE_NETWORK_OUTSIDE`, `SITE_NETWORK_SERVICE`, `SITE_NETWORK_OUTSIDE_WITH_INTERNET_VIP`, `SITE_NETWORK_INSIDE_AND_OUTSIDE_WITH_INTERNET_VIP`, `SITE_NETWORK_IP_FABRIC`<br>[Enum: SITE_NETWORK_INSIDE_AND_OUTSIDE|SITE_NETWORK_INSIDE|SITE_NETWORK_OUTSIDE|SITE_NETWORK_SERVICE|SITE_NETWORK_OUTSIDE_WITH_INTERNET_VIP|SITE_NETWORK_INSIDE_AND_OUTSIDE_WITH_INTERNET_VIP|SITE_NETWORK_IP_FABRIC] Site Network. This defines network types to be used on site All inside and outside networks. All inside and outside networks with internet VIP support. All inside networks. All outside networks. All outside networks with internet VIP support. VK8s service network. - SITE_NETWORK_IP_FABRIC: VER IP Fabric network for the site This Virtual network type is used for exposing virtual host on IP Fabric network on the VER site or for endpoint in IP Fabric network
586
+ <a id="network-31ecf8"></a>&#x2022; [`network`](#network-31ecf8) - Optional String Defaults to `SITE_NETWORK_INSIDE_AND_OUTSIDE`<br>Possible values are `SITE_NETWORK_INSIDE_AND_OUTSIDE`, `SITE_NETWORK_INSIDE`, `SITE_NETWORK_OUTSIDE`, `SITE_NETWORK_SERVICE`, `SITE_NETWORK_OUTSIDE_WITH_INTERNET_VIP`, `SITE_NETWORK_INSIDE_AND_OUTSIDE_WITH_INTERNET_VIP`, `SITE_NETWORK_IP_FABRIC`<br>[Enum: SITE_NETWORK_INSIDE_AND_OUTSIDE|SITE_NETWORK_INSIDE|SITE_NETWORK_OUTSIDE|SITE_NETWORK_SERVICE|SITE_NETWORK_OUTSIDE_WITH_INTERNET_VIP|SITE_NETWORK_INSIDE_AND_OUTSIDE_WITH_INTERNET_VIP|SITE_NETWORK_IP_FABRIC] Defines network types to be used on site All inside and outside networks. All inside and outside networks with internet VIP support. All inside networks
587
587
 
588
- <a id="site-ba773e"></a>&#x2022; [`virtual_site`](#site-ba773e) - Optional Block<br>Object reference. This type establishes a direct reference from one object(the referrer) to another(the referred). Such a reference is in form of tenant/namespace/name<br>See [Virtual Site](#site-ba773e) below.
588
+ <a id="site-ba773e"></a>&#x2022; [`virtual_site`](#site-ba773e) - 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 [Virtual Site](#site-ba773e) below.
589
589
 
590
590
  #### Site Virtual Sites Advertise Where Virtual Site Virtual Site
591
591
 
@@ -609,45 +609,45 @@ A [`tls_intercept`](#tls-intercept) block supports the following:
609
609
 
610
610
  <a id="tls-intercept-custom-certificate"></a>&#x2022; [`custom_certificate`](#tls-intercept-custom-certificate) - Optional Block<br>TLS Certificate. Handle to fetch certificate and key<br>See [Custom Certificate](#tls-intercept-custom-certificate) below.
611
611
 
612
- <a id="tls-intercept-enable-for-all-domains"></a>&#x2022; [`enable_for_all_domains`](#tls-intercept-enable-for-all-domains) - Optional Block<br>Enable this option
612
+ <a id="tls-intercept-enable-for-all-domains"></a>&#x2022; [`enable_for_all_domains`](#tls-intercept-enable-for-all-domains) - Optional Block<br>Can be used for messages where no values are needed
613
613
 
614
- <a id="tls-intercept-policy"></a>&#x2022; [`policy`](#tls-intercept-policy) - Optional Block<br>TLS Interception Policy. Policy to enable or disable TLS interception<br>See [Policy](#tls-intercept-policy) below.
614
+ <a id="tls-intercept-policy"></a>&#x2022; [`policy`](#tls-intercept-policy) - Optional Block<br>Policy to enable or disable TLS interception<br>See [Policy](#tls-intercept-policy) below.
615
615
 
616
- <a id="tls-intercept-trusted-ca-url"></a>&#x2022; [`trusted_ca_url`](#tls-intercept-trusted-ca-url) - Optional String<br>Custom Root CA Certificate. Custom Root CA Certificate for validating upstream server certificate
616
+ <a id="tls-intercept-trusted-ca-url"></a>&#x2022; [`trusted_ca_url`](#tls-intercept-trusted-ca-url) - Optional String<br>Custom Root CA Certificate for validating upstream server certificate
617
617
 
618
- <a id="tls-intercept-volterra-certificate"></a>&#x2022; [`volterra_certificate`](#tls-intercept-volterra-certificate) - Optional Block<br>Enable this option
618
+ <a id="tls-intercept-volterra-certificate"></a>&#x2022; [`volterra_certificate`](#tls-intercept-volterra-certificate) - Optional Block<br>Can be used for messages where no values are needed
619
619
 
620
- <a id="tls-intercept-volterra-trusted-ca"></a>&#x2022; [`volterra_trusted_ca`](#tls-intercept-volterra-trusted-ca) - Optional Block<br>Enable this option
620
+ <a id="tls-intercept-volterra-trusted-ca"></a>&#x2022; [`volterra_trusted_ca`](#tls-intercept-volterra-trusted-ca) - Optional Block<br>Can be used for messages where no values are needed
621
621
 
622
622
  #### TLS Intercept Custom Certificate
623
623
 
624
624
  A [`custom_certificate`](#tls-intercept-custom-certificate) block (within [`tls_intercept`](#tls-intercept)) supports the following:
625
625
 
626
- <a id="url-b70ccd"></a>&#x2022; [`certificate_url`](#url-b70ccd) - Optional String<br>Certificate. TLS certificate. Certificate or certificate chain in PEM format including the PEM headers
626
+ <a id="url-b70ccd"></a>&#x2022; [`certificate_url`](#url-b70ccd) - Optional String<br>TLS certificate. Certificate or certificate chain in PEM format including the PEM headers
627
627
 
628
- <a id="algorithms-04b03c"></a>&#x2022; [`custom_hash_algorithms`](#algorithms-04b03c) - Optional Block<br>Hash Algorithms. Specifies the hash algorithms to be used<br>See [Custom Hash Algorithms](#algorithms-04b03c) below.
628
+ <a id="algorithms-04b03c"></a>&#x2022; [`custom_hash_algorithms`](#algorithms-04b03c) - Optional Block<br>Specifies the hash algorithms to be used<br>See [Custom Hash Algorithms](#algorithms-04b03c) below.
629
629
 
630
630
  <a id="spec-309e16"></a>&#x2022; [`description_spec`](#spec-309e16) - Optional String<br>Description. Description for the certificate
631
631
 
632
- <a id="stapling-e452bc"></a>&#x2022; [`disable_ocsp_stapling`](#stapling-e452bc) - Optional Block<br>Enable this option
632
+ <a id="stapling-e452bc"></a>&#x2022; [`disable_ocsp_stapling`](#stapling-e452bc) - Optional Block<br>Can be used for messages where no values are needed
633
633
 
634
- <a id="key-64ce0d"></a>&#x2022; [`private_key`](#key-64ce0d) - Optional Block<br>Secret. SecretType is used in an object to indicate a sensitive/confidential field<br>See [Private Key](#key-64ce0d) below.
634
+ <a id="key-64ce0d"></a>&#x2022; [`private_key`](#key-64ce0d) - Optional Block<br>SecretType is used in an object to indicate a sensitive/confidential field<br>See [Private Key](#key-64ce0d) below.
635
635
 
636
- <a id="defaults-a85c93"></a>&#x2022; [`use_system_defaults`](#defaults-a85c93) - Optional Block<br>Enable this option
636
+ <a id="defaults-a85c93"></a>&#x2022; [`use_system_defaults`](#defaults-a85c93) - Optional Block<br>Can be used for messages where no values are needed
637
637
 
638
638
  #### TLS Intercept Custom Certificate Custom Hash Algorithms
639
639
 
640
640
  A [`custom_hash_algorithms`](#algorithms-04b03c) block (within [`tls_intercept.custom_certificate`](#tls-intercept-custom-certificate)) supports the following:
641
641
 
642
- <a id="algorithms-bb1c8a"></a>&#x2022; [`hash_algorithms`](#algorithms-bb1c8a) - Optional List Defaults to `INVALID_HASH_ALGORITHM`<br>Possible values are `INVALID_HASH_ALGORITHM`, `SHA256`, `SHA1`<br>[Enum: INVALID_HASH_ALGORITHM|SHA256|SHA1] Hash Algorithms. Ordered list of hash algorithms to be used
642
+ <a id="algorithms-bb1c8a"></a>&#x2022; [`hash_algorithms`](#algorithms-bb1c8a) - Optional List Defaults to `INVALID_HASH_ALGORITHM`<br>Possible values are `INVALID_HASH_ALGORITHM`, `SHA256`, `SHA1`<br>[Enum: INVALID_HASH_ALGORITHM|SHA256|SHA1] Ordered list of hash algorithms to be used
643
643
 
644
644
  #### TLS Intercept Custom Certificate Private Key
645
645
 
646
646
  A [`private_key`](#key-64ce0d) block (within [`tls_intercept.custom_certificate`](#tls-intercept-custom-certificate)) supports the following:
647
647
 
648
- <a id="info-678e4d"></a>&#x2022; [`blindfold_secret_info`](#info-678e4d) - Optional Block<br>Blindfold Secret. BlindfoldSecretInfoType specifies information about the Secret managed by F5XC Secret Management<br>See [Blindfold Secret Info](#info-678e4d) below.
648
+ <a id="info-678e4d"></a>&#x2022; [`blindfold_secret_info`](#info-678e4d) - Optional Block<br>BlindfoldSecretInfoType specifies information about the Secret managed by F5XC Secret Management<br>See [Blindfold Secret Info](#info-678e4d) below.
649
649
 
650
- <a id="info-cd6226"></a>&#x2022; [`clear_secret_info`](#info-cd6226) - Optional Block<br>In-Clear Secret. ClearSecretInfoType specifies information about the Secret that is not encrypted<br>See [Clear Secret Info](#info-cd6226) below.
650
+ <a id="info-cd6226"></a>&#x2022; [`clear_secret_info`](#info-cd6226) - Optional Block<br>ClearSecretInfoType specifies information about the Secret that is not encrypted<br>See [Clear Secret Info](#info-cd6226) below.
651
651
 
652
652
  #### TLS Intercept Custom Certificate Private Key Blindfold Secret Info
653
653
 
@@ -661,27 +661,27 @@ A [`private_key`](#key-64ce0d) block (within [`tls_intercept.custom_certificate`
661
661
 
662
662
  A [`policy`](#tls-intercept-policy) block (within [`tls_intercept`](#tls-intercept)) supports the following:
663
663
 
664
- <a id="tls-intercept-policy-interception-rules"></a>&#x2022; [`interception_rules`](#tls-intercept-policy-interception-rules) - Optional Block<br>TLS Interception Rules. List of ordered rules to enable or disable for TLS interception<br>See [Interception Rules](#tls-intercept-policy-interception-rules) below.
664
+ <a id="tls-intercept-policy-interception-rules"></a>&#x2022; [`interception_rules`](#tls-intercept-policy-interception-rules) - Optional Block<br>List of ordered rules to enable or disable for TLS interception<br>See [Interception Rules](#tls-intercept-policy-interception-rules) below.
665
665
 
666
666
  #### TLS Intercept Policy Interception Rules
667
667
 
668
668
  An [`interception_rules`](#tls-intercept-policy-interception-rules) block (within [`tls_intercept.policy`](#tls-intercept-policy)) supports the following:
669
669
 
670
- <a id="interception-f6b646"></a>&#x2022; [`disable_interception`](#interception-f6b646) - Optional Block<br>Enable this option
670
+ <a id="interception-f6b646"></a>&#x2022; [`disable_interception`](#interception-f6b646) - Optional Block<br>Can be used for messages where no values are needed
671
671
 
672
672
  <a id="match-42a3da"></a>&#x2022; [`domain_match`](#match-42a3da) - Optional Block<br>Domains. Domains names<br>See [Domain Match](#match-42a3da) below.
673
673
 
674
- <a id="interception-e82eca"></a>&#x2022; [`enable_interception`](#interception-e82eca) - Optional Block<br>Enable this option
674
+ <a id="interception-e82eca"></a>&#x2022; [`enable_interception`](#interception-e82eca) - Optional Block<br>Can be used for messages where no values are needed
675
675
 
676
676
  #### TLS Intercept Policy Interception Rules Domain Match
677
677
 
678
678
  A [`domain_match`](#match-42a3da) block (within [`tls_intercept.policy.interception_rules`](#tls-intercept-policy-interception-rules)) supports the following:
679
679
 
680
- <a id="value-5de498"></a>&#x2022; [`exact_value`](#value-5de498) - Optional String<br>Exact Value. Exact domain name
680
+ <a id="value-5de498"></a>&#x2022; [`exact_value`](#value-5de498) - Optional String<br>Exact domain name
681
681
 
682
- <a id="value-7aa963"></a>&#x2022; [`regex_value`](#value-7aa963) - Optional String<br>Regex Values of Domains. Regular Expression value for the domain name
682
+ <a id="value-7aa963"></a>&#x2022; [`regex_value`](#value-7aa963) - Optional String<br>Regular Expression value for the domain name
683
683
 
684
- <a id="value-5d0d1d"></a>&#x2022; [`suffix_value`](#value-5d0d1d) - Optional String<br>Suffix Value. Suffix of domain name e.g 'xyz.com' will match '*.xyz.com' and 'xyz.com'
684
+ <a id="value-5d0d1d"></a>&#x2022; [`suffix_value`](#value-5d0d1d) - Optional String<br>Suffix of domain name e.g 'xyz.com' will match '*.xyz.com' and 'xyz.com'
685
685
 
686
686
  ---
687
687