@robinmordasiewicz/f5xc-terraform-mcp 3.5.0 → 3.6.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +283 -104
- package/dist/docs/data-sources/bgp.md +2 -2
- package/dist/docs/data-sources/discovery.md +2 -2
- package/dist/docs/data-sources/fast_acl.md +2 -2
- package/dist/docs/data-sources/fast_acl_rule.md +2 -2
- package/dist/docs/data-sources/irule.md +2 -2
- package/dist/docs/data-sources/log_receiver.md +2 -2
- package/dist/docs/data-sources/network_policy.md +2 -2
- package/dist/docs/data-sources/route.md +2 -2
- package/dist/docs/data-sources/site.md +2 -2
- package/dist/docs/resources/address_allocator.md +7 -7
- package/dist/docs/resources/advertise_policy.md +57 -57
- package/dist/docs/resources/alert_policy.md +40 -40
- package/dist/docs/resources/alert_receiver.md +57 -57
- package/dist/docs/resources/api_crawler.md +13 -13
- package/dist/docs/resources/api_definition.md +11 -11
- package/dist/docs/resources/api_discovery.md +4 -4
- package/dist/docs/resources/api_testing.md +27 -27
- package/dist/docs/resources/apm.md +40 -40
- package/dist/docs/resources/app_api_group.md +20 -20
- package/dist/docs/resources/app_firewall.md +50 -50
- package/dist/docs/resources/app_setting.md +19 -19
- package/dist/docs/resources/app_type.md +7 -7
- package/dist/docs/resources/authentication.md +29 -29
- package/dist/docs/resources/aws_tgw_site.md +140 -140
- package/dist/docs/resources/aws_vpc_site.md +174 -174
- package/dist/docs/resources/azure_vnet_site.md +245 -245
- package/dist/docs/resources/bgp.md +37 -205
- package/dist/docs/resources/bgp_asn_set.md +1 -1
- package/dist/docs/resources/bgp_routing_policy.md +19 -19
- package/dist/docs/resources/bot_defense_app_infrastructure.md +12 -12
- package/dist/docs/resources/cdn_cache_rule.md +5 -5
- package/dist/docs/resources/cdn_loadbalancer.md +418 -418
- package/dist/docs/resources/certificate.md +1 -1
- package/dist/docs/resources/certificate_chain.md +1 -1
- package/dist/docs/resources/cloud_connect.md +28 -28
- package/dist/docs/resources/cloud_credentials.md +35 -35
- package/dist/docs/resources/cloud_elastic_ip.md +8 -8
- package/dist/docs/resources/cloud_link.md +36 -36
- package/dist/docs/resources/cluster.md +86 -86
- package/dist/docs/resources/cminstance.md +22 -22
- package/dist/docs/resources/code_base_integration.md +24 -24
- package/dist/docs/resources/container_registry.md +13 -13
- package/dist/docs/resources/crl.md +1 -1
- package/dist/docs/resources/data_type.md +16 -16
- package/dist/docs/resources/dc_cluster_group.md +4 -4
- package/dist/docs/resources/discovery.md +8 -259
- package/dist/docs/resources/dns_compliance_checks.md +1 -1
- package/dist/docs/resources/dns_domain.md +3 -3
- package/dist/docs/resources/endpoint.md +44 -44
- package/dist/docs/resources/enhanced_firewall_policy.md +51 -51
- package/dist/docs/resources/external_connector.md +42 -42
- package/dist/docs/resources/fast_acl.md +60 -166
- package/dist/docs/resources/fast_acl_rule.md +28 -28
- package/dist/docs/resources/filter_set.md +10 -10
- package/dist/docs/resources/fleet.md +160 -160
- package/dist/docs/resources/forward_proxy_policy.md +82 -82
- package/dist/docs/resources/forwarding_class.md +14 -14
- package/dist/docs/resources/gcp_vpc_site.md +152 -152
- package/dist/docs/resources/global_log_receiver.md +238 -238
- package/dist/docs/resources/healthcheck.md +17 -17
- package/dist/docs/resources/http_loadbalancer.md +1003 -1003
- package/dist/docs/resources/irule.md +5 -7
- package/dist/docs/resources/log_receiver.md +825 -44
- package/dist/docs/resources/malicious_user_mitigation.md +10 -10
- package/dist/docs/resources/nat_policy.md +86 -86
- package/dist/docs/resources/network_connector.md +31 -31
- package/dist/docs/resources/network_firewall.md +22 -22
- package/dist/docs/resources/network_interface.md +77 -77
- package/dist/docs/resources/network_policy.md +38 -217
- package/dist/docs/resources/network_policy_rule.md +21 -21
- package/dist/docs/resources/network_policy_view.md +65 -65
- package/dist/docs/resources/nfv_service.md +76 -76
- package/dist/docs/resources/nginx_service_discovery.md +10 -10
- package/dist/docs/resources/origin_pool.md +166 -166
- package/dist/docs/resources/policer.md +4 -4
- package/dist/docs/resources/policy_based_routing.md +28 -28
- package/dist/docs/resources/protocol_inspection.md +12 -12
- package/dist/docs/resources/protocol_policer.md +14 -14
- package/dist/docs/resources/proxy.md +111 -111
- package/dist/docs/resources/rate_limiter.md +15 -15
- package/dist/docs/resources/rate_limiter_policy.md +56 -56
- package/dist/docs/resources/route.md +183 -183
- package/dist/docs/resources/secret_management_access.md +68 -68
- package/dist/docs/resources/securemesh_site.md +1619 -258
- package/dist/docs/resources/segment.md +4 -4
- package/dist/docs/resources/sensitive_data_policy.md +9 -9
- package/dist/docs/resources/service_policy.md +175 -175
- package/dist/docs/resources/service_policy_rule.md +142 -142
- package/dist/docs/resources/site.md +381 -303
- package/dist/docs/resources/site_mesh_group.md +18 -18
- package/dist/docs/resources/subnet.md +17 -17
- package/dist/docs/resources/tcp_loadbalancer.md +130 -130
- package/dist/docs/resources/tenant_configuration.md +10 -10
- package/dist/docs/resources/trusted_ca_list.md +1 -1
- package/dist/docs/resources/tunnel.md +36 -36
- package/dist/docs/resources/udp_loadbalancer.md +59 -59
- package/dist/docs/resources/usb_policy.md +6 -6
- package/dist/docs/resources/user_identification.md +16 -16
- package/dist/docs/resources/virtual_host.md +225 -225
- package/dist/docs/resources/virtual_network.md +14 -14
- package/dist/docs/resources/virtual_site.md +3 -3
- package/dist/docs/resources/voltstack_site.md +141 -141
- package/dist/docs/resources/waf_exclusion_policy.md +17 -17
- package/dist/docs/resources/workload.md +327 -327
- package/dist/docs/resources/workload_flavor.md +3 -3
- package/dist/metadata/resource-metadata.json +1484 -942
- package/dist/types.d.ts +11 -0
- package/dist/types.d.ts.map +1 -1
- package/dist/types.js.map +1 -1
- package/package.json +1 -1
|
@@ -56,30 +56,30 @@ resource "f5xc_proxy" "example" {
|
|
|
56
56
|
### Spec Argument Reference
|
|
57
57
|
|
|
58
58
|
-> **One of the following:**
|
|
59
|
-
• <a id="active-forward-proxy-policies"></a>[`active_forward_proxy_policies`](#active-forward-proxy-policies) - Optional Block<br>
|
|
59
|
+
• <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>• [`connection_timeout`](#connection-timeout) - Optional Number Defaults to `2000` Specified in milliseconds<br>
|
|
61
|
+
<a id="connection-timeout"></a>• [`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
|
-
• <a id="do-not-advertise"></a>[`do_not_advertise`](#do-not-advertise) - Optional Block<br>
|
|
65
|
-
<br><br>• <a id="site-virtual-sites"></a>[`site_virtual_sites`](#site-virtual-sites) - Optional Block<br>
|
|
64
|
+
• <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>• <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
|
• <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>• <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>• [`no_forward_proxy_policy`](#no-forward-proxy-policy) - Optional Block<br>
|
|
71
|
+
<a id="no-forward-proxy-policy"></a>• [`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
|
-
• <a id="no-interception"></a>[`no_interception`](#no-interception) - Optional Block<br>
|
|
74
|
+
• <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
|
-
• <a id="site-local-inside-network"></a>[`site_local_inside_network`](#site-local-inside-network) - Optional Block<br>
|
|
78
|
-
<br><br>• <a id="site-local-network"></a>[`site_local_network`](#site-local-network) - Optional Block<br>
|
|
77
|
+
• <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>• <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>• [`timeouts`](#timeouts) - Optional Block
|
|
81
81
|
|
|
82
|
-
<a id="tls-intercept"></a>• [`tls_intercept`](#tls-intercept) - Optional Block<br>Configuration
|
|
82
|
+
<a id="tls-intercept"></a>• [`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>• [`forward_proxy_policies`](#policies-42e2f7) - Optional Block<br>
|
|
96
|
+
<a id="policies-42e2f7"></a>• [`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>• [`name`](#name-c2d06e) - Optional String<br>
|
|
102
|
+
<a id="name-c2d06e"></a>• [`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>• [`namespace`](#namespace-63e125) - Optional String<br>
|
|
104
|
+
<a id="namespace-63e125"></a>• [`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>• [`tenant`](#tenant-e68ab4) - Optional String<br>
|
|
106
|
+
<a id="tenant-e68ab4"></a>• [`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>• [`disable_dns_masquerade`](#dynamic-proxy-disable-dns-masquerade) - Optional Block<br>
|
|
112
|
+
<a id="dynamic-proxy-disable-dns-masquerade"></a>• [`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>• [`domains`](#dynamic-proxy-domains) - Optional List<br>
|
|
114
|
+
<a id="dynamic-proxy-domains"></a>• [`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>• [`enable_dns_masquerade`](#dynamic-proxy-enable-dns-masquerade) - Optional Block<br>
|
|
116
|
+
<a id="dynamic-proxy-enable-dns-masquerade"></a>• [`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>• [`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>• [`more_option`](#dynamic-proxy-http-proxy-more-option) - Optional Block<br>
|
|
128
|
+
<a id="dynamic-proxy-http-proxy-more-option"></a>• [`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>• [`buffer_policy`](#policy-dc12bf) - Optional Block<br>
|
|
134
|
+
<a id="policy-dc12bf"></a>• [`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>• [`compression_params`](#params-c9d1d2) - Optional Block<br>
|
|
136
|
+
<a id="params-c9d1d2"></a>• [`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>• [`custom_errors`](#errors-be4463) - Optional Block<br>
|
|
138
|
+
<a id="errors-be4463"></a>• [`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>• [`disable_default_error_pages`](#pages-241bd8) - Optional Bool<br>Disable
|
|
140
|
+
<a id="pages-241bd8"></a>• [`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>• [`disable_path_normalize`](#normalize-343080) - Optional Block<br>
|
|
142
|
+
<a id="normalize-343080"></a>• [`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>• [`enable_path_normalize`](#normalize-19a976) - Optional Block<br>
|
|
144
|
+
<a id="normalize-19a976"></a>• [`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>• [`idle_timeout`](#timeout-14c486) - Optional Number<br>
|
|
146
|
+
<a id="timeout-14c486"></a>• [`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>• [`max_request_header_size`](#size-302702) - Optional Number<br>
|
|
148
|
+
<a id="size-302702"></a>• [`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>• [`request_cookies_to_add`](#add-a872f8) - Optional Block<br>
|
|
150
|
+
<a id="add-a872f8"></a>• [`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>• [`request_cookies_to_remove`](#remove-411cd3) - Optional List<br>
|
|
152
|
+
<a id="remove-411cd3"></a>• [`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>• [`request_headers_to_add`](#add-3661bf) - Optional Block<br>
|
|
154
|
+
<a id="add-3661bf"></a>• [`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>• [`request_headers_to_remove`](#remove-031e38) - Optional List<br>
|
|
156
|
+
<a id="remove-031e38"></a>• [`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>• [`response_cookies_to_add`](#add-9ca95a) - Optional Block<br>
|
|
158
|
+
<a id="add-9ca95a"></a>• [`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>• [`response_cookies_to_remove`](#remove-09fdc6) - Optional List<br>
|
|
160
|
+
<a id="remove-09fdc6"></a>• [`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>• [`response_headers_to_add`](#add-91639a) - Optional Block<br>
|
|
162
|
+
<a id="add-91639a"></a>• [`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>• [`response_headers_to_remove`](#remove-8ec5bc) - Optional List<br>
|
|
164
|
+
<a id="remove-8ec5bc"></a>• [`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>• [`more_option`](#dynamic-proxy-https-proxy-more-option) - Optional Block<br>
|
|
242
|
+
<a id="dynamic-proxy-https-proxy-more-option"></a>• [`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>• [`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>• [`buffer_policy`](#policy-5af133) - Optional Block<br>
|
|
250
|
+
<a id="policy-5af133"></a>• [`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>• [`compression_params`](#params-013546) - Optional Block<br>
|
|
252
|
+
<a id="params-013546"></a>• [`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>• [`custom_errors`](#errors-01c21a) - Optional Block<br>
|
|
254
|
+
<a id="errors-01c21a"></a>• [`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>• [`disable_default_error_pages`](#pages-9edd65) - Optional Bool<br>Disable
|
|
256
|
+
<a id="pages-9edd65"></a>• [`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>• [`disable_path_normalize`](#normalize-780e38) - Optional Block<br>
|
|
258
|
+
<a id="normalize-780e38"></a>• [`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>• [`enable_path_normalize`](#normalize-a240ab) - Optional Block<br>
|
|
260
|
+
<a id="normalize-a240ab"></a>• [`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>• [`idle_timeout`](#timeout-1062ad) - Optional Number<br>
|
|
262
|
+
<a id="timeout-1062ad"></a>• [`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>• [`max_request_header_size`](#size-620c3f) - Optional Number<br>
|
|
264
|
+
<a id="size-620c3f"></a>• [`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>• [`request_cookies_to_add`](#add-1b5bcd) - Optional Block<br>
|
|
266
|
+
<a id="add-1b5bcd"></a>• [`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>• [`request_cookies_to_remove`](#remove-cfd658) - Optional List<br>
|
|
268
|
+
<a id="remove-cfd658"></a>• [`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>• [`request_headers_to_add`](#add-0332ff) - Optional Block<br>
|
|
270
|
+
<a id="add-0332ff"></a>• [`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>• [`request_headers_to_remove`](#remove-606625) - Optional List<br>
|
|
272
|
+
<a id="remove-606625"></a>• [`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>• [`response_cookies_to_add`](#add-dd9473) - Optional Block<br>
|
|
274
|
+
<a id="add-dd9473"></a>• [`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>• [`response_cookies_to_remove`](#remove-5d52c7) - Optional List<br>
|
|
276
|
+
<a id="remove-5d52c7"></a>• [`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>• [`response_headers_to_add`](#add-db908d) - Optional Block<br>
|
|
278
|
+
<a id="add-db908d"></a>• [`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>• [`response_headers_to_remove`](#remove-27e742) - Optional List<br>
|
|
280
|
+
<a id="remove-27e742"></a>• [`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>• [`no_mtls`](#mtls-1872dc) - Optional Block<br>
|
|
358
|
+
<a id="mtls-1872dc"></a>• [`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>• [`tls_certificates`](#certificates-6f0e81) - Optional Block<br>
|
|
360
|
+
<a id="certificates-6f0e81"></a>• [`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>• [`tls_config`](#config-116b33) - Optional Block<br>
|
|
362
|
+
<a id="config-116b33"></a>• [`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>• [`use_mtls`](#mtls-7179b9) - Optional Block<br>
|
|
364
|
+
<a id="mtls-7179b9"></a>• [`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>• [`idle_timeout`](#dynamic-proxy-sni-proxy-idle-timeout) - Optional Number<br>
|
|
414
|
+
<a id="dynamic-proxy-sni-proxy-idle-timeout"></a>• [`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>• [`enable_http`](#http-proxy-enable-http) - Optional Block<br>
|
|
420
|
+
<a id="http-proxy-enable-http"></a>• [`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>• [`more_option`](#http-proxy-more-option) - Optional Block<br>
|
|
422
|
+
<a id="http-proxy-more-option"></a>• [`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>• [`buffer_policy`](#http-proxy-more-option-buffer-policy) - Optional Block<br>
|
|
428
|
+
<a id="http-proxy-more-option-buffer-policy"></a>• [`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>• [`compression_params`](#params-c32856) - Optional Block<br>
|
|
430
|
+
<a id="params-c32856"></a>• [`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>• [`custom_errors`](#http-proxy-more-option-custom-errors) - Optional Block<br>
|
|
432
|
+
<a id="http-proxy-more-option-custom-errors"></a>• [`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>• [`disable_default_error_pages`](#pages-159caf) - Optional Bool<br>Disable
|
|
434
|
+
<a id="pages-159caf"></a>• [`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>• [`disable_path_normalize`](#normalize-3090b6) - Optional Block<br>
|
|
436
|
+
<a id="normalize-3090b6"></a>• [`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>• [`enable_path_normalize`](#normalize-8562f8) - Optional Block<br>
|
|
438
|
+
<a id="normalize-8562f8"></a>• [`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>• [`idle_timeout`](#http-proxy-more-option-idle-timeout) - Optional Number<br>
|
|
440
|
+
<a id="http-proxy-more-option-idle-timeout"></a>• [`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>• [`max_request_header_size`](#size-c24d2e) - Optional Number<br>
|
|
442
|
+
<a id="size-c24d2e"></a>• [`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>• [`request_cookies_to_add`](#add-19fe20) - Optional Block<br>
|
|
444
|
+
<a id="add-19fe20"></a>• [`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>• [`request_cookies_to_remove`](#remove-14fff8) - Optional List<br>
|
|
446
|
+
<a id="remove-14fff8"></a>• [`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>• [`request_headers_to_add`](#add-1a07e4) - Optional Block<br>
|
|
448
|
+
<a id="add-1a07e4"></a>• [`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>• [`request_headers_to_remove`](#remove-58b55a) - Optional List<br>
|
|
450
|
+
<a id="remove-58b55a"></a>• [`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>• [`response_cookies_to_add`](#add-9fc6d2) - Optional Block<br>
|
|
452
|
+
<a id="add-9fc6d2"></a>• [`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>• [`response_cookies_to_remove`](#remove-c6e6e0) - Optional List<br>
|
|
454
|
+
<a id="remove-c6e6e0"></a>• [`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>• [`response_headers_to_add`](#add-3fc2d5) - Optional Block<br>
|
|
456
|
+
<a id="add-3fc2d5"></a>• [`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>• [`response_headers_to_remove`](#remove-738a4c) - Optional List<br>
|
|
458
|
+
<a id="remove-738a4c"></a>• [`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>• [`disabled`](#disabled-107694) - Optional Bool<br>Disable
|
|
464
|
+
<a id="disabled-107694"></a>• [`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>• [`max_request_bytes`](#bytes-b00d03) - Optional Number<br>
|
|
466
|
+
<a id="bytes-b00d03"></a>• [`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>• [`content_length`](#length-c8573b) - Optional Number Defaults to `30`<br>
|
|
472
|
+
<a id="length-c8573b"></a>• [`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>• [`content_type`](#type-794ba2) - Optional List<br>
|
|
474
|
+
<a id="type-794ba2"></a>• [`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>• [`disable_on_etag_header`](#header-2ffee9) - Optional Bool<br>
|
|
476
|
+
<a id="header-2ffee9"></a>• [`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>• [`remove_accept_encoding_header`](#header-925ccf) - Optional Bool<br>
|
|
478
|
+
<a id="header-925ccf"></a>• [`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>• [`advertise_where`](#site-virtual-sites-advertise-where) - Optional Block<br>
|
|
548
|
+
<a id="site-virtual-sites-advertise-where"></a>• [`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>• [`port`](#site-virtual-sites-advertise-where-port) - Optional Number<br>TCP
|
|
554
|
+
<a id="site-virtual-sites-advertise-where-port"></a>• [`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>• [`site`](#site-virtual-sites-advertise-where-site) - Optional Block<br>
|
|
556
|
+
<a id="site-virtual-sites-advertise-where-site"></a>• [`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>• [`use_default_port`](#port-7cb8fb) - Optional Block<br>
|
|
558
|
+
<a id="port-7cb8fb"></a>• [`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>• [`virtual_site`](#site-7107b1) - Optional Block<br>
|
|
560
|
+
<a id="site-7107b1"></a>• [`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>• [`ip`](#site-ip-4eb476) - Optional String<br>
|
|
566
|
+
<a id="site-ip-4eb476"></a>• [`ip`](#site-ip-4eb476) - Optional String<br>Use given IP address as VIP on the site
|
|
567
567
|
|
|
568
|
-
<a id="network-647eba"></a>• [`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]
|
|
568
|
+
<a id="network-647eba"></a>• [`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>• [`site`](#site-91e167) - Optional Block<br>
|
|
570
|
+
<a id="site-91e167"></a>• [`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>• [`name`](#name-e8af64) - Optional String<br>
|
|
576
|
+
<a id="name-e8af64"></a>• [`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>• [`namespace`](#namespace-81a6ad) - Optional String<br>
|
|
578
|
+
<a id="namespace-81a6ad"></a>• [`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>• [`tenant`](#tenant-d56172) - Optional String<br>
|
|
580
|
+
<a id="tenant-d56172"></a>• [`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>• [`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]
|
|
586
|
+
<a id="network-31ecf8"></a>• [`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>• [`virtual_site`](#site-ba773e) - Optional Block<br>
|
|
588
|
+
<a id="site-ba773e"></a>• [`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>• [`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>• [`enable_for_all_domains`](#tls-intercept-enable-for-all-domains) - Optional Block<br>
|
|
612
|
+
<a id="tls-intercept-enable-for-all-domains"></a>• [`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>• [`policy`](#tls-intercept-policy) - Optional Block<br>
|
|
614
|
+
<a id="tls-intercept-policy"></a>• [`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>• [`trusted_ca_url`](#tls-intercept-trusted-ca-url) - Optional String<br>Custom Root CA Certificate
|
|
616
|
+
<a id="tls-intercept-trusted-ca-url"></a>• [`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>• [`volterra_certificate`](#tls-intercept-volterra-certificate) - Optional Block<br>
|
|
618
|
+
<a id="tls-intercept-volterra-certificate"></a>• [`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>• [`volterra_trusted_ca`](#tls-intercept-volterra-trusted-ca) - Optional Block<br>
|
|
620
|
+
<a id="tls-intercept-volterra-trusted-ca"></a>• [`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>• [`certificate_url`](#url-b70ccd) - Optional String<br>
|
|
626
|
+
<a id="url-b70ccd"></a>• [`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>• [`custom_hash_algorithms`](#algorithms-04b03c) - Optional Block<br>
|
|
628
|
+
<a id="algorithms-04b03c"></a>• [`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>• [`description_spec`](#spec-309e16) - Optional String<br>Description. Description for the certificate
|
|
631
631
|
|
|
632
|
-
<a id="stapling-e452bc"></a>• [`disable_ocsp_stapling`](#stapling-e452bc) - Optional Block<br>
|
|
632
|
+
<a id="stapling-e452bc"></a>• [`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>• [`private_key`](#key-64ce0d) - Optional Block<br>
|
|
634
|
+
<a id="key-64ce0d"></a>• [`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>• [`use_system_defaults`](#defaults-a85c93) - Optional Block<br>
|
|
636
|
+
<a id="defaults-a85c93"></a>• [`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>• [`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]
|
|
642
|
+
<a id="algorithms-bb1c8a"></a>• [`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>• [`blindfold_secret_info`](#info-678e4d) - Optional Block<br>
|
|
648
|
+
<a id="info-678e4d"></a>• [`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>• [`clear_secret_info`](#info-cd6226) - Optional Block<br>
|
|
650
|
+
<a id="info-cd6226"></a>• [`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>• [`interception_rules`](#tls-intercept-policy-interception-rules) - Optional Block<br>
|
|
664
|
+
<a id="tls-intercept-policy-interception-rules"></a>• [`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>• [`disable_interception`](#interception-f6b646) - Optional Block<br>
|
|
670
|
+
<a id="interception-f6b646"></a>• [`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>• [`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>• [`enable_interception`](#interception-e82eca) - Optional Block<br>
|
|
674
|
+
<a id="interception-e82eca"></a>• [`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>• [`exact_value`](#value-5de498) - Optional String<br>Exact
|
|
680
|
+
<a id="value-5de498"></a>• [`exact_value`](#value-5de498) - Optional String<br>Exact domain name
|
|
681
681
|
|
|
682
|
-
<a id="value-7aa963"></a>• [`regex_value`](#value-7aa963) - Optional String<br>
|
|
682
|
+
<a id="value-7aa963"></a>• [`regex_value`](#value-7aa963) - Optional String<br>Regular Expression value for the domain name
|
|
683
683
|
|
|
684
|
-
<a id="value-5d0d1d"></a>• [`suffix_value`](#value-5d0d1d) - Optional String<br>Suffix
|
|
684
|
+
<a id="value-5d0d1d"></a>• [`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
|
|