@robinmordasiewicz/f5xc-terraform-mcp 2.4.6 → 2.4.7
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/docs/resources/addon_subscription.md +5 -5
- package/dist/docs/resources/address_allocator.md +3 -3
- package/dist/docs/resources/advertise_policy.md +39 -39
- package/dist/docs/resources/alert_policy.md +6 -6
- package/dist/docs/resources/alert_receiver.md +57 -57
- package/dist/docs/resources/api_crawler.md +9 -9
- package/dist/docs/resources/api_testing.md +40 -40
- package/dist/docs/resources/apm.md +320 -320
- package/dist/docs/resources/app_api_group.md +10 -10
- package/dist/docs/resources/app_firewall.md +36 -36
- package/dist/docs/resources/app_setting.md +46 -46
- package/dist/docs/resources/app_type.md +3 -3
- package/dist/docs/resources/authentication.md +30 -30
- package/dist/docs/resources/aws_tgw_site.md +184 -184
- package/dist/docs/resources/aws_vpc_site.md +296 -296
- package/dist/docs/resources/azure_vnet_site.md +677 -677
- package/dist/docs/resources/bgp.md +20 -20
- package/dist/docs/resources/bgp_routing_policy.md +4 -4
- package/dist/docs/resources/cdn_cache_rule.md +68 -68
- package/dist/docs/resources/cdn_loadbalancer.md +1166 -1166
- package/dist/docs/resources/certificate.md +4 -4
- package/dist/docs/resources/child_tenant.md +2 -2
- package/dist/docs/resources/cloud_connect.md +33 -33
- package/dist/docs/resources/cloud_credentials.md +37 -37
- package/dist/docs/resources/cloud_link.md +16 -16
- package/dist/docs/resources/cluster.md +68 -68
- package/dist/docs/resources/cminstance.md +6 -6
- package/dist/docs/resources/code_base_integration.md +82 -82
- package/dist/docs/resources/container_registry.md +2 -2
- package/dist/docs/resources/data_type.md +12 -12
- package/dist/docs/resources/discovery.md +71 -71
- package/dist/docs/resources/dns_lb_health_check.md +5 -5
- package/dist/docs/resources/dns_load_balancer.md +25 -25
- package/dist/docs/resources/dns_zone.md +144 -144
- package/dist/docs/resources/endpoint.md +1 -1
- package/dist/docs/resources/enhanced_firewall_policy.md +33 -33
- package/dist/docs/resources/external_connector.md +32 -32
- package/dist/docs/resources/fast_acl.md +59 -59
- package/dist/docs/resources/fast_acl_rule.md +2 -2
- package/dist/docs/resources/filter_set.md +3 -3
- package/dist/docs/resources/fleet.md +359 -359
- package/dist/docs/resources/forward_proxy_policy.md +18 -18
- package/dist/docs/resources/gcp_vpc_site.md +280 -280
- package/dist/docs/resources/geo_location_set.md +1 -1
- package/dist/docs/resources/global_log_receiver.md +216 -216
- package/dist/docs/resources/healthcheck.md +2 -2
- package/dist/docs/resources/http_loadbalancer.md +2190 -2190
- package/dist/docs/resources/infraprotect_tunnel.md +9 -9
- package/dist/docs/resources/k8s_cluster.md +39 -39
- package/dist/docs/resources/k8s_cluster_role.md +10 -10
- package/dist/docs/resources/k8s_pod_security_policy.md +9 -9
- package/dist/docs/resources/log_receiver.md +11 -11
- package/dist/docs/resources/malicious_user_mitigation.md +4 -4
- package/dist/docs/resources/managed_tenant.md +2 -2
- package/dist/docs/resources/nat_policy.md +22 -22
- package/dist/docs/resources/network_connector.md +37 -37
- package/dist/docs/resources/network_firewall.md +15 -15
- package/dist/docs/resources/network_interface.md +78 -78
- package/dist/docs/resources/network_policy.md +21 -21
- package/dist/docs/resources/network_policy_view.md +7 -7
- package/dist/docs/resources/nfv_service.md +306 -306
- package/dist/docs/resources/oidc_provider.md +1 -1
- package/dist/docs/resources/origin_pool.md +151 -151
- package/dist/docs/resources/policy_based_routing.md +71 -71
- package/dist/docs/resources/protocol_inspection.md +8 -8
- package/dist/docs/resources/proxy.md +401 -401
- package/dist/docs/resources/rate_limiter_policy.md +4 -4
- package/dist/docs/resources/registration.md +1 -1
- package/dist/docs/resources/route.md +155 -155
- package/dist/docs/resources/secret_management_access.md +103 -103
- package/dist/docs/resources/secret_policy.md +7 -7
- package/dist/docs/resources/securemesh_site.md +274 -274
- package/dist/docs/resources/securemesh_site_v2.md +940 -940
- package/dist/docs/resources/sensitive_data_policy.md +3 -3
- package/dist/docs/resources/service_policy.md +154 -154
- package/dist/docs/resources/service_policy_rule.md +51 -51
- package/dist/docs/resources/subnet.md +7 -7
- package/dist/docs/resources/tcp_loadbalancer.md +138 -138
- package/dist/docs/resources/tenant_configuration.md +1 -1
- package/dist/docs/resources/ticket_tracking_system.md +2 -2
- package/dist/docs/resources/tunnel.md +16 -16
- package/dist/docs/resources/udp_loadbalancer.md +56 -56
- package/dist/docs/resources/virtual_host.md +146 -146
- package/dist/docs/resources/virtual_network.md +7 -7
- package/dist/docs/resources/voltshare_admin_policy.md +22 -22
- package/dist/docs/resources/voltstack_site.md +778 -778
- package/dist/docs/resources/waf_exclusion_policy.md +22 -22
- package/dist/docs/resources/workload.md +2226 -2226
- package/package.json +1 -1
|
@@ -167,19 +167,19 @@ An [`advanced_options`](#advanced-options) block supports the following:
|
|
|
167
167
|
|
|
168
168
|
<a id="advanced-options-connection-timeout"></a>• [`connection_timeout`](#advanced-options-connection-timeout) - Optional Number Defaults to `2` Specified in milliseconds<br>Connection Timeout. The timeout for new network connections to endpoints in the cluster. The seconds
|
|
169
169
|
|
|
170
|
-
<a id="
|
|
170
|
+
<a id="breaker-c470cf"></a>• [`default_circuit_breaker`](#breaker-c470cf) - Optional Block<br>Enable this option
|
|
171
171
|
|
|
172
|
-
<a id="
|
|
172
|
+
<a id="breaker-222fdc"></a>• [`disable_circuit_breaker`](#breaker-222fdc) - Optional Block<br>Enable this option
|
|
173
173
|
|
|
174
|
-
<a id="
|
|
174
|
+
<a id="persistance-1139ff"></a>• [`disable_lb_source_ip_persistance`](#persistance-1139ff) - Optional Block<br>Enable this option
|
|
175
175
|
|
|
176
|
-
<a id="
|
|
176
|
+
<a id="detection-c26369"></a>• [`disable_outlier_detection`](#detection-c26369) - Optional Block<br>Enable this option
|
|
177
177
|
|
|
178
178
|
<a id="advanced-options-disable-proxy-protocol"></a>• [`disable_proxy_protocol`](#advanced-options-disable-proxy-protocol) - Optional Block<br>Enable this option
|
|
179
179
|
|
|
180
180
|
<a id="advanced-options-disable-subsets"></a>• [`disable_subsets`](#advanced-options-disable-subsets) - Optional Block<br>Enable this option
|
|
181
181
|
|
|
182
|
-
<a id="
|
|
182
|
+
<a id="persistance-62e70d"></a>• [`enable_lb_source_ip_persistance`](#persistance-62e70d) - Optional Block<br>Enable this option
|
|
183
183
|
|
|
184
184
|
<a id="advanced-options-enable-subsets"></a>• [`enable_subsets`](#advanced-options-enable-subsets) - Optional Block<br>Origin Pool Subset Options. Configure subset options for origin pool<br>See [Enable Subsets](#advanced-options-enable-subsets) below.
|
|
185
185
|
|
|
@@ -203,57 +203,57 @@ An [`advanced_options`](#advanced-options) block supports the following:
|
|
|
203
203
|
|
|
204
204
|
A [`circuit_breaker`](#advanced-options-circuit-breaker) block (within [`advanced_options`](#advanced-options)) supports the following:
|
|
205
205
|
|
|
206
|
-
<a id="
|
|
206
|
+
<a id="limit-2f511c"></a>• [`connection_limit`](#limit-2f511c) - Optional Number<br>Connection Limit. The maximum number of connections that loadbalancer will establish to all hosts in an upstream cluster. In practice this is only applicable to TCP and HTTP/1.1 clusters since HTTP/2 uses a single connection to each host. Remove endpoint out of load balancing decision, if number of connections reach connection limit
|
|
207
207
|
|
|
208
|
-
<a id="
|
|
208
|
+
<a id="requests-f8e924"></a>• [`max_requests`](#requests-f8e924) - Optional Number<br>Maximum Request Count. The maximum number of requests that can be outstanding to all hosts in a cluster at any given time. In practice this is applicable to HTTP/2 clusters since HTTP/1.1 clusters are governed by the maximum connections (connection_limit). Remove endpoint out of load balancing decision, if requests exceed this count
|
|
209
209
|
|
|
210
|
-
<a id="
|
|
210
|
+
<a id="requests-51e30f"></a>• [`pending_requests`](#requests-51e30f) - Optional Number<br>Pending Requests. The maximum number of requests that will be queued while waiting for a ready connection pool connection. Since HTTP/2 requests are sent over a single connection, this circuit breaker only comes into play as the initial connection is created, as requests will be multiplexed immediately afterwards. For HTTP/1.1, requests are added to the list of pending requests whenever there aren’t enough upstream connections available to immediately dispatch the request, so this circuit breaker will remain in play for the lifetime of the process. Remove endpoint out of load balancing decision, if pending request reach pending_request
|
|
211
211
|
|
|
212
|
-
<a id="
|
|
212
|
+
<a id="priority-0e16c5"></a>• [`priority`](#priority-0e16c5) - Optional String Defaults to `DEFAULT`<br>Possible values are `DEFAULT`, `HIGH`<br>[Enum: DEFAULT|HIGH] Routing Priority. Priority routing for each request. Different connection pools are used based on the priority selected for the request. Also, circuit-breaker configuration at destination cluster is chosen based on selected priority. Default routing mechanism High-Priority routing mechanism
|
|
213
213
|
|
|
214
|
-
<a id="
|
|
214
|
+
<a id="retries-18e401"></a>• [`retries`](#retries-18e401) - Optional Number<br>Retry Count. The maximum number of retries that can be outstanding to all hosts in a cluster at any given time. Remove endpoint out of load balancing decision, if retries for request exceed this count
|
|
215
215
|
|
|
216
216
|
#### Advanced Options Enable Subsets
|
|
217
217
|
|
|
218
218
|
An [`enable_subsets`](#advanced-options-enable-subsets) block (within [`advanced_options`](#advanced-options)) supports the following:
|
|
219
219
|
|
|
220
|
-
<a id="
|
|
220
|
+
<a id="endpoint-0fc3f9"></a>• [`any_endpoint`](#endpoint-0fc3f9) - Optional Block<br>Enable this option
|
|
221
221
|
|
|
222
|
-
<a id="
|
|
222
|
+
<a id="subset-276c69"></a>• [`default_subset`](#subset-276c69) - Optional Block<br>Origin Pool Default Subset. Default Subset definition<br>See [Default Subset](#subset-276c69) below.
|
|
223
223
|
|
|
224
|
-
<a id="
|
|
224
|
+
<a id="subsets-25c75e"></a>• [`endpoint_subsets`](#subsets-25c75e) - Optional Block<br>Origin Server Subsets Classes. List of subset class. Subsets class is defined using list of keys. Every unique combination of values of these keys form a subset withing the class<br>See [Endpoint Subsets](#subsets-25c75e) below.
|
|
225
225
|
|
|
226
|
-
<a id="
|
|
226
|
+
<a id="request-49c0b8"></a>• [`fail_request`](#request-49c0b8) - Optional Block<br>Enable this option
|
|
227
227
|
|
|
228
228
|
#### Advanced Options Enable Subsets Default Subset
|
|
229
229
|
|
|
230
|
-
A [`default_subset`](#
|
|
230
|
+
A [`default_subset`](#subset-276c69) block (within [`advanced_options.enable_subsets`](#advanced-options-enable-subsets)) supports the following:
|
|
231
231
|
|
|
232
|
-
<a id="
|
|
232
|
+
<a id="subset-4951d9"></a>• [`default_subset`](#subset-4951d9) - Optional Block<br>Default Subset for Origin Pool. List of key-value pairs that define default subset. which gets used when route specifies no metadata or no subset matching the metadata exists
|
|
233
233
|
|
|
234
234
|
#### Advanced Options Enable Subsets Endpoint Subsets
|
|
235
235
|
|
|
236
|
-
An [`endpoint_subsets`](#
|
|
236
|
+
An [`endpoint_subsets`](#subsets-25c75e) block (within [`advanced_options.enable_subsets`](#advanced-options-enable-subsets)) supports the following:
|
|
237
237
|
|
|
238
|
-
<a id="
|
|
238
|
+
<a id="keys-3828db"></a>• [`keys`](#keys-3828db) - Optional List<br>Keys. List of keys that define a cluster subset class
|
|
239
239
|
|
|
240
240
|
#### Advanced Options Http1 Config
|
|
241
241
|
|
|
242
242
|
A [`http1_config`](#advanced-options-http1-config) block (within [`advanced_options`](#advanced-options)) supports the following:
|
|
243
243
|
|
|
244
|
-
<a id="
|
|
244
|
+
<a id="transformation-1e4851"></a>• [`header_transformation`](#transformation-1e4851) - Optional Block<br>Header Transformation. Header Transformation options for HTTP/1.1 request/response headers<br>See [Header Transformation](#transformation-1e4851) below.
|
|
245
245
|
|
|
246
246
|
#### Advanced Options Http1 Config Header Transformation
|
|
247
247
|
|
|
248
|
-
A [`header_transformation`](#
|
|
248
|
+
A [`header_transformation`](#transformation-1e4851) block (within [`advanced_options.http1_config`](#advanced-options-http1-config)) supports the following:
|
|
249
249
|
|
|
250
|
-
<a id="
|
|
250
|
+
<a id="transformation-6fa15c"></a>• [`default_header_transformation`](#transformation-6fa15c) - Optional Block<br>Enable this option
|
|
251
251
|
|
|
252
|
-
<a id="
|
|
252
|
+
<a id="transformation-c4c936"></a>• [`legacy_header_transformation`](#transformation-c4c936) - Optional Block<br>Enable this option
|
|
253
253
|
|
|
254
|
-
<a id="
|
|
254
|
+
<a id="transformation-923ab8"></a>• [`preserve_case_header_transformation`](#transformation-923ab8) - Optional Block<br>Enable this option
|
|
255
255
|
|
|
256
|
-
<a id="
|
|
256
|
+
<a id="transformation-1ce9d5"></a>• [`proper_case_header_transformation`](#transformation-1ce9d5) - Optional Block<br>Enable this option
|
|
257
257
|
|
|
258
258
|
#### Advanced Options Http2 Options
|
|
259
259
|
|
|
@@ -265,15 +265,15 @@ A [`http2_options`](#advanced-options-http2-options) block (within [`advanced_op
|
|
|
265
265
|
|
|
266
266
|
An [`outlier_detection`](#advanced-options-outlier-detection) block (within [`advanced_options`](#advanced-options)) supports the following:
|
|
267
267
|
|
|
268
|
-
<a id="
|
|
268
|
+
<a id="time-3534e9"></a>• [`base_ejection_time`](#time-3534e9) - Optional Number Defaults to `30000ms` Specified in milliseconds<br>Base Ejection Time. The base time that a host is ejected for. The real time is equal to the base time multiplied by the number of times the host has been ejected. This causes hosts to get ejected for longer periods if they continue to fail
|
|
269
269
|
|
|
270
|
-
<a id="
|
|
270
|
+
<a id="5xx-ff28ef"></a>• [`consecutive_5xx`](#5xx-ff28ef) - Optional Number Defaults to `5`<br>Consecutive 5xx Count. If an upstream endpoint returns some number of consecutive 5xx, it will be ejected. Note that in this case a 5xx means an actual 5xx respond code, or an event that would cause the HTTP router to return one on the upstream’s behalf(reset, connection failure, etc.) consecutive_5xx indicates the number of consecutive 5xx responses required before a consecutive 5xx ejection occurs
|
|
271
271
|
|
|
272
|
-
<a id="
|
|
272
|
+
<a id="failure-fbd9bf"></a>• [`consecutive_gateway_failure`](#failure-fbd9bf) - Optional Number Defaults to `5`<br>Consecutive Gateway Failure. If an upstream endpoint returns some number of consecutive “gateway errors” (502, 503 or 504 status code), it will be ejected. Note that this includes events that would cause the HTTP router to return one of these status codes on the upstream’s behalf (reset, connection failure, etc.). consecutive_gateway_failure indicates the number of consecutive gateway failures before a consecutive gateway failure ejection occurs
|
|
273
273
|
|
|
274
|
-
<a id="
|
|
274
|
+
<a id="interval-5cb76c"></a>• [`interval`](#interval-5cb76c) - Optional Number Defaults to `10000ms` Specified in milliseconds<br>Interval. The time interval between ejection analysis sweeps. This can result in both new ejections as well as endpoints being returned to service
|
|
275
275
|
|
|
276
|
-
<a id="
|
|
276
|
+
<a id="percent-6b6ee2"></a>• [`max_ejection_percent`](#percent-6b6ee2) - Optional Number Defaults to `10%`<br>Max Ejection Percentage. The maximum % of an upstream cluster that can be ejected due to outlier detection. but will eject at least one host regardless of the value
|
|
277
277
|
|
|
278
278
|
#### Healthcheck
|
|
279
279
|
|
|
@@ -315,87 +315,87 @@ An [`origin_servers`](#origin-servers) block supports the following:
|
|
|
315
315
|
|
|
316
316
|
A [`cbip_service`](#origin-servers-cbip-service) block (within [`origin_servers`](#origin-servers)) supports the following:
|
|
317
317
|
|
|
318
|
-
<a id="
|
|
318
|
+
<a id="name-d75410"></a>• [`service_name`](#name-d75410) - Optional String<br>Service Name. Name of the discovered Classic BIG-IP virtual server to be used as origin
|
|
319
319
|
|
|
320
320
|
#### Origin Servers Consul Service
|
|
321
321
|
|
|
322
322
|
A [`consul_service`](#origin-servers-consul-service) block (within [`origin_servers`](#origin-servers)) supports the following:
|
|
323
323
|
|
|
324
|
-
<a id="
|
|
324
|
+
<a id="network-5b2697"></a>• [`inside_network`](#network-5b2697) - Optional Block<br>Enable this option
|
|
325
325
|
|
|
326
|
-
<a id="
|
|
326
|
+
<a id="network-844fc7"></a>• [`outside_network`](#network-844fc7) - Optional Block<br>Enable this option
|
|
327
327
|
|
|
328
|
-
<a id="
|
|
328
|
+
<a id="name-e2ff9a"></a>• [`service_name`](#name-e2ff9a) - Optional String<br>Service Name. Consul service name of this origin server will be listed, including cluster-ID. The format is servicename:cluster-ID
|
|
329
329
|
|
|
330
|
-
<a id="
|
|
330
|
+
<a id="locator-0ecb39"></a>• [`site_locator`](#locator-0ecb39) - Optional Block<br>Site or Virtual Site. This message defines a reference to a site or virtual site object<br>See [Site Locator](#locator-0ecb39) below.
|
|
331
331
|
|
|
332
332
|
<a id="origin-servers-consul-service-snat-pool"></a>• [`snat_pool`](#origin-servers-consul-service-snat-pool) - Optional Block<br>Snat Pool. Snat Pool configuration<br>See [Snat Pool](#origin-servers-consul-service-snat-pool) below.
|
|
333
333
|
|
|
334
334
|
#### Origin Servers Consul Service Site Locator
|
|
335
335
|
|
|
336
|
-
A [`site_locator`](#
|
|
336
|
+
A [`site_locator`](#locator-0ecb39) block (within [`origin_servers.consul_service`](#origin-servers-consul-service)) supports the following:
|
|
337
337
|
|
|
338
|
-
<a id="
|
|
338
|
+
<a id="site-a096eb"></a>• [`site`](#site-a096eb) - 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-a096eb) below.
|
|
339
339
|
|
|
340
|
-
<a id="
|
|
340
|
+
<a id="site-faf4b5"></a>• [`virtual_site`](#site-faf4b5) - 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-faf4b5) below.
|
|
341
341
|
|
|
342
342
|
#### Origin Servers Consul Service Site Locator Site
|
|
343
343
|
|
|
344
|
-
A [`site`](#
|
|
344
|
+
A [`site`](#site-a096eb) block (within [`origin_servers.consul_service.site_locator`](#locator-0ecb39)) supports the following:
|
|
345
345
|
|
|
346
|
-
<a id="
|
|
346
|
+
<a id="name-8a907a"></a>• [`name`](#name-8a907a) - 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
|
|
347
347
|
|
|
348
|
-
<a id="
|
|
348
|
+
<a id="namespace-933dcd"></a>• [`namespace`](#namespace-933dcd) - 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
|
|
349
349
|
|
|
350
|
-
<a id="
|
|
350
|
+
<a id="tenant-c92ea9"></a>• [`tenant`](#tenant-c92ea9) - 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
|
|
351
351
|
|
|
352
352
|
#### Origin Servers Consul Service Site Locator Virtual Site
|
|
353
353
|
|
|
354
|
-
A [`virtual_site`](#
|
|
354
|
+
A [`virtual_site`](#site-faf4b5) block (within [`origin_servers.consul_service.site_locator`](#locator-0ecb39)) supports the following:
|
|
355
355
|
|
|
356
|
-
<a id="
|
|
356
|
+
<a id="name-012b0c"></a>• [`name`](#name-012b0c) - 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
|
|
357
357
|
|
|
358
|
-
<a id="
|
|
358
|
+
<a id="namespace-5cf80b"></a>• [`namespace`](#namespace-5cf80b) - 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
|
|
359
359
|
|
|
360
|
-
<a id="
|
|
360
|
+
<a id="tenant-1ef7ff"></a>• [`tenant`](#tenant-1ef7ff) - 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
|
|
361
361
|
|
|
362
362
|
#### Origin Servers Consul Service Snat Pool
|
|
363
363
|
|
|
364
364
|
A [`snat_pool`](#origin-servers-consul-service-snat-pool) block (within [`origin_servers.consul_service`](#origin-servers-consul-service)) supports the following:
|
|
365
365
|
|
|
366
|
-
<a id="
|
|
366
|
+
<a id="pool-8eb799"></a>• [`no_snat_pool`](#pool-8eb799) - Optional Block<br>Enable this option
|
|
367
367
|
|
|
368
|
-
<a id="
|
|
368
|
+
<a id="pool-fc27df"></a>• [`snat_pool`](#pool-fc27df) - Optional Block<br>IPv4 Prefix List. List of IPv4 prefixes that represent an endpoint<br>See [Snat Pool](#pool-fc27df) below.
|
|
369
369
|
|
|
370
370
|
#### Origin Servers Consul Service Snat Pool Snat Pool
|
|
371
371
|
|
|
372
|
-
A [`snat_pool`](#
|
|
372
|
+
A [`snat_pool`](#pool-fc27df) block (within [`origin_servers.consul_service.snat_pool`](#origin-servers-consul-service-snat-pool)) supports the following:
|
|
373
373
|
|
|
374
|
-
<a id="
|
|
374
|
+
<a id="prefixes-5cbcd5"></a>• [`prefixes`](#prefixes-5cbcd5) - Optional List<br>IPv4 Prefix List. List of IPv4 prefixes that represent an endpoint
|
|
375
375
|
|
|
376
376
|
#### Origin Servers Custom Endpoint Object
|
|
377
377
|
|
|
378
378
|
A [`custom_endpoint_object`](#origin-servers-custom-endpoint-object) block (within [`origin_servers`](#origin-servers)) supports the following:
|
|
379
379
|
|
|
380
|
-
<a id="
|
|
380
|
+
<a id="endpoint-6a2e33"></a>• [`endpoint`](#endpoint-6a2e33) - 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 [Endpoint](#endpoint-6a2e33) below.
|
|
381
381
|
|
|
382
382
|
#### Origin Servers Custom Endpoint Object Endpoint
|
|
383
383
|
|
|
384
|
-
An [`endpoint`](#
|
|
384
|
+
An [`endpoint`](#endpoint-6a2e33) block (within [`origin_servers.custom_endpoint_object`](#origin-servers-custom-endpoint-object)) supports the following:
|
|
385
385
|
|
|
386
|
-
<a id="
|
|
386
|
+
<a id="name-33e632"></a>• [`name`](#name-33e632) - 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
|
|
387
387
|
|
|
388
|
-
<a id="
|
|
388
|
+
<a id="namespace-ea699e"></a>• [`namespace`](#namespace-ea699e) - 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
|
|
389
389
|
|
|
390
|
-
<a id="
|
|
390
|
+
<a id="tenant-45ea6c"></a>• [`tenant`](#tenant-45ea6c) - 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
|
|
391
391
|
|
|
392
392
|
#### Origin Servers K8S Service
|
|
393
393
|
|
|
394
394
|
A [`k8s_service`](#origin-servers-k8s-service) block (within [`origin_servers`](#origin-servers)) supports the following:
|
|
395
395
|
|
|
396
|
-
<a id="
|
|
396
|
+
<a id="network-698e40"></a>• [`inside_network`](#network-698e40) - Optional Block<br>Enable this option
|
|
397
397
|
|
|
398
|
-
<a id="
|
|
398
|
+
<a id="network-4852ec"></a>• [`outside_network`](#network-4852ec) - Optional Block<br>Enable this option
|
|
399
399
|
|
|
400
400
|
<a id="origin-servers-k8s-service-protocol"></a>• [`protocol`](#origin-servers-k8s-service-protocol) - Optional String Defaults to `PROTOCOL_TCP`<br>Possible values are `PROTOCOL_TCP`, `PROTOCOL_UDP`<br>[Enum: PROTOCOL_TCP|PROTOCOL_UDP] Protocol Type. Type of protocol - PROTOCOL_TCP: TCP - PROTOCOL_UDP: UDP
|
|
401
401
|
|
|
@@ -405,59 +405,59 @@ A [`k8s_service`](#origin-servers-k8s-service) block (within [`origin_servers`](
|
|
|
405
405
|
|
|
406
406
|
<a id="origin-servers-k8s-service-snat-pool"></a>• [`snat_pool`](#origin-servers-k8s-service-snat-pool) - Optional Block<br>Snat Pool. Snat Pool configuration<br>See [Snat Pool](#origin-servers-k8s-service-snat-pool) below.
|
|
407
407
|
|
|
408
|
-
<a id="
|
|
408
|
+
<a id="networks-d41308"></a>• [`vk8s_networks`](#networks-d41308) - Optional Block<br>Enable this option
|
|
409
409
|
|
|
410
410
|
#### Origin Servers K8S Service Site Locator
|
|
411
411
|
|
|
412
412
|
A [`site_locator`](#origin-servers-k8s-service-site-locator) block (within [`origin_servers.k8s_service`](#origin-servers-k8s-service)) supports the following:
|
|
413
413
|
|
|
414
|
-
<a id="
|
|
414
|
+
<a id="site-e35217"></a>• [`site`](#site-e35217) - 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-e35217) below.
|
|
415
415
|
|
|
416
|
-
<a id="
|
|
416
|
+
<a id="site-0ef9ba"></a>• [`virtual_site`](#site-0ef9ba) - 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-0ef9ba) below.
|
|
417
417
|
|
|
418
418
|
#### Origin Servers K8S Service Site Locator Site
|
|
419
419
|
|
|
420
|
-
A [`site`](#
|
|
420
|
+
A [`site`](#site-e35217) block (within [`origin_servers.k8s_service.site_locator`](#origin-servers-k8s-service-site-locator)) supports the following:
|
|
421
421
|
|
|
422
|
-
<a id="
|
|
422
|
+
<a id="name-b0bc0e"></a>• [`name`](#name-b0bc0e) - 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
|
|
423
423
|
|
|
424
|
-
<a id="
|
|
424
|
+
<a id="namespace-bc6979"></a>• [`namespace`](#namespace-bc6979) - 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
|
|
425
425
|
|
|
426
|
-
<a id="
|
|
426
|
+
<a id="tenant-097ea8"></a>• [`tenant`](#tenant-097ea8) - 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
|
|
427
427
|
|
|
428
428
|
#### Origin Servers K8S Service Site Locator Virtual Site
|
|
429
429
|
|
|
430
|
-
A [`virtual_site`](#
|
|
430
|
+
A [`virtual_site`](#site-0ef9ba) block (within [`origin_servers.k8s_service.site_locator`](#origin-servers-k8s-service-site-locator)) supports the following:
|
|
431
431
|
|
|
432
|
-
<a id="
|
|
432
|
+
<a id="name-36f81a"></a>• [`name`](#name-36f81a) - 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
|
|
433
433
|
|
|
434
|
-
<a id="
|
|
434
|
+
<a id="namespace-13f85f"></a>• [`namespace`](#namespace-13f85f) - 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
|
|
435
435
|
|
|
436
|
-
<a id="
|
|
436
|
+
<a id="tenant-3746a4"></a>• [`tenant`](#tenant-3746a4) - 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
|
|
437
437
|
|
|
438
438
|
#### Origin Servers K8S Service Snat Pool
|
|
439
439
|
|
|
440
440
|
A [`snat_pool`](#origin-servers-k8s-service-snat-pool) block (within [`origin_servers.k8s_service`](#origin-servers-k8s-service)) supports the following:
|
|
441
441
|
|
|
442
|
-
<a id="
|
|
442
|
+
<a id="pool-57d5fe"></a>• [`no_snat_pool`](#pool-57d5fe) - Optional Block<br>Enable this option
|
|
443
443
|
|
|
444
|
-
<a id="
|
|
444
|
+
<a id="pool-8c0889"></a>• [`snat_pool`](#pool-8c0889) - Optional Block<br>IPv4 Prefix List. List of IPv4 prefixes that represent an endpoint<br>See [Snat Pool](#pool-8c0889) below.
|
|
445
445
|
|
|
446
446
|
#### Origin Servers K8S Service Snat Pool Snat Pool
|
|
447
447
|
|
|
448
|
-
A [`snat_pool`](#
|
|
448
|
+
A [`snat_pool`](#pool-8c0889) block (within [`origin_servers.k8s_service.snat_pool`](#origin-servers-k8s-service-snat-pool)) supports the following:
|
|
449
449
|
|
|
450
|
-
<a id="
|
|
450
|
+
<a id="prefixes-3a9bbf"></a>• [`prefixes`](#prefixes-3a9bbf) - Optional List<br>IPv4 Prefix List. List of IPv4 prefixes that represent an endpoint
|
|
451
451
|
|
|
452
452
|
#### Origin Servers Private IP
|
|
453
453
|
|
|
454
454
|
A [`private_ip`](#origin-servers-private-ip) block (within [`origin_servers`](#origin-servers)) supports the following:
|
|
455
455
|
|
|
456
|
-
<a id="
|
|
456
|
+
<a id="network-340769"></a>• [`inside_network`](#network-340769) - Optional Block<br>Enable this option
|
|
457
457
|
|
|
458
458
|
<a id="origin-servers-private-ip-ip"></a>• [`ip`](#origin-servers-private-ip-ip) - Optional String<br>IP. Private IPv4 address
|
|
459
459
|
|
|
460
|
-
<a id="
|
|
460
|
+
<a id="network-4b8cd1"></a>• [`outside_network`](#network-4b8cd1) - Optional Block<br>Enable this option
|
|
461
461
|
|
|
462
462
|
<a id="origin-servers-private-ip-segment"></a>• [`segment`](#origin-servers-private-ip-segment) - 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 [Segment](#origin-servers-private-ip-segment) below.
|
|
463
463
|
|
|
@@ -471,51 +471,51 @@ A [`segment`](#origin-servers-private-ip-segment) block (within [`origin_servers
|
|
|
471
471
|
|
|
472
472
|
<a id="origin-servers-private-ip-segment-name"></a>• [`name`](#origin-servers-private-ip-segment-name) - Optional String<br>Name. When a configuration object(e.g. virtual_host) refers to another(e.g route) then name will hold the referred object's(e.g. route's) name
|
|
473
473
|
|
|
474
|
-
<a id="
|
|
474
|
+
<a id="namespace-a2f7e0"></a>• [`namespace`](#namespace-a2f7e0) - 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
|
|
475
475
|
|
|
476
|
-
<a id="
|
|
476
|
+
<a id="tenant-4d8d8b"></a>• [`tenant`](#tenant-4d8d8b) - 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
|
|
477
477
|
|
|
478
478
|
#### Origin Servers Private IP Site Locator
|
|
479
479
|
|
|
480
480
|
A [`site_locator`](#origin-servers-private-ip-site-locator) block (within [`origin_servers.private_ip`](#origin-servers-private-ip)) supports the following:
|
|
481
481
|
|
|
482
|
-
<a id="
|
|
482
|
+
<a id="site-9000e8"></a>• [`site`](#site-9000e8) - 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-9000e8) below.
|
|
483
483
|
|
|
484
|
-
<a id="
|
|
484
|
+
<a id="site-5bd329"></a>• [`virtual_site`](#site-5bd329) - 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-5bd329) below.
|
|
485
485
|
|
|
486
486
|
#### Origin Servers Private IP Site Locator Site
|
|
487
487
|
|
|
488
|
-
A [`site`](#
|
|
488
|
+
A [`site`](#site-9000e8) block (within [`origin_servers.private_ip.site_locator`](#origin-servers-private-ip-site-locator)) supports the following:
|
|
489
489
|
|
|
490
|
-
<a id="
|
|
490
|
+
<a id="name-dc4f48"></a>• [`name`](#name-dc4f48) - 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
|
|
491
491
|
|
|
492
|
-
<a id="
|
|
492
|
+
<a id="namespace-43a893"></a>• [`namespace`](#namespace-43a893) - 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
|
|
493
493
|
|
|
494
|
-
<a id="
|
|
494
|
+
<a id="tenant-ae5087"></a>• [`tenant`](#tenant-ae5087) - 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
|
|
495
495
|
|
|
496
496
|
#### Origin Servers Private IP Site Locator Virtual Site
|
|
497
497
|
|
|
498
|
-
A [`virtual_site`](#
|
|
498
|
+
A [`virtual_site`](#site-5bd329) block (within [`origin_servers.private_ip.site_locator`](#origin-servers-private-ip-site-locator)) supports the following:
|
|
499
499
|
|
|
500
|
-
<a id="
|
|
500
|
+
<a id="name-ee8828"></a>• [`name`](#name-ee8828) - 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
|
|
501
501
|
|
|
502
|
-
<a id="
|
|
502
|
+
<a id="namespace-2b7ae1"></a>• [`namespace`](#namespace-2b7ae1) - 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
|
|
503
503
|
|
|
504
|
-
<a id="
|
|
504
|
+
<a id="tenant-756ab7"></a>• [`tenant`](#tenant-756ab7) - 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
|
|
505
505
|
|
|
506
506
|
#### Origin Servers Private IP Snat Pool
|
|
507
507
|
|
|
508
508
|
A [`snat_pool`](#origin-servers-private-ip-snat-pool) block (within [`origin_servers.private_ip`](#origin-servers-private-ip)) supports the following:
|
|
509
509
|
|
|
510
|
-
<a id="
|
|
510
|
+
<a id="pool-c826de"></a>• [`no_snat_pool`](#pool-c826de) - Optional Block<br>Enable this option
|
|
511
511
|
|
|
512
|
-
<a id="
|
|
512
|
+
<a id="pool-cc6a33"></a>• [`snat_pool`](#pool-cc6a33) - Optional Block<br>IPv4 Prefix List. List of IPv4 prefixes that represent an endpoint<br>See [Snat Pool](#pool-cc6a33) below.
|
|
513
513
|
|
|
514
514
|
#### Origin Servers Private IP Snat Pool Snat Pool
|
|
515
515
|
|
|
516
|
-
A [`snat_pool`](#
|
|
516
|
+
A [`snat_pool`](#pool-cc6a33) block (within [`origin_servers.private_ip.snat_pool`](#origin-servers-private-ip-snat-pool)) supports the following:
|
|
517
517
|
|
|
518
|
-
<a id="
|
|
518
|
+
<a id="prefixes-44db1f"></a>• [`prefixes`](#prefixes-44db1f) - Optional List<br>IPv4 Prefix List. List of IPv4 prefixes that represent an endpoint
|
|
519
519
|
|
|
520
520
|
#### Origin Servers Private Name
|
|
521
521
|
|
|
@@ -523,15 +523,15 @@ A [`private_name`](#origin-servers-private-name) block (within [`origin_servers`
|
|
|
523
523
|
|
|
524
524
|
<a id="origin-servers-private-name-dns-name"></a>• [`dns_name`](#origin-servers-private-name-dns-name) - Optional String<br>DNS Name. DNS Name
|
|
525
525
|
|
|
526
|
-
<a id="
|
|
526
|
+
<a id="network-1921f3"></a>• [`inside_network`](#network-1921f3) - Optional Block<br>Enable this option
|
|
527
527
|
|
|
528
|
-
<a id="
|
|
528
|
+
<a id="network-a1ed83"></a>• [`outside_network`](#network-a1ed83) - Optional Block<br>Enable this option
|
|
529
529
|
|
|
530
|
-
<a id="
|
|
530
|
+
<a id="interval-4bd915"></a>• [`refresh_interval`](#interval-4bd915) - Optional Number<br>DNS Refresh Interval. Interval for DNS refresh in seconds. Max value is 7 days as per `HTTPS://datatracker.ietf.org/doc/HTML/rfc8767`
|
|
531
531
|
|
|
532
532
|
<a id="origin-servers-private-name-segment"></a>• [`segment`](#origin-servers-private-name-segment) - 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 [Segment](#origin-servers-private-name-segment) below.
|
|
533
533
|
|
|
534
|
-
<a id="
|
|
534
|
+
<a id="locator-0c95f1"></a>• [`site_locator`](#locator-0c95f1) - Optional Block<br>Site or Virtual Site. This message defines a reference to a site or virtual site object<br>See [Site Locator](#locator-0c95f1) below.
|
|
535
535
|
|
|
536
536
|
<a id="origin-servers-private-name-snat-pool"></a>• [`snat_pool`](#origin-servers-private-name-snat-pool) - Optional Block<br>Snat Pool. Snat Pool configuration<br>See [Snat Pool](#origin-servers-private-name-snat-pool) below.
|
|
537
537
|
|
|
@@ -539,53 +539,53 @@ A [`private_name`](#origin-servers-private-name) block (within [`origin_servers`
|
|
|
539
539
|
|
|
540
540
|
A [`segment`](#origin-servers-private-name-segment) block (within [`origin_servers.private_name`](#origin-servers-private-name)) supports the following:
|
|
541
541
|
|
|
542
|
-
<a id="
|
|
542
|
+
<a id="name-6839c1"></a>• [`name`](#name-6839c1) - 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
|
|
543
543
|
|
|
544
|
-
<a id="
|
|
544
|
+
<a id="namespace-217e43"></a>• [`namespace`](#namespace-217e43) - 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
|
|
545
545
|
|
|
546
|
-
<a id="
|
|
546
|
+
<a id="tenant-522e3c"></a>• [`tenant`](#tenant-522e3c) - 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
|
|
547
547
|
|
|
548
548
|
#### Origin Servers Private Name Site Locator
|
|
549
549
|
|
|
550
|
-
A [`site_locator`](#
|
|
550
|
+
A [`site_locator`](#locator-0c95f1) block (within [`origin_servers.private_name`](#origin-servers-private-name)) supports the following:
|
|
551
551
|
|
|
552
|
-
<a id="
|
|
552
|
+
<a id="site-771c33"></a>• [`site`](#site-771c33) - 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-771c33) below.
|
|
553
553
|
|
|
554
|
-
<a id="
|
|
554
|
+
<a id="site-cf2f53"></a>• [`virtual_site`](#site-cf2f53) - 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-cf2f53) below.
|
|
555
555
|
|
|
556
556
|
#### Origin Servers Private Name Site Locator Site
|
|
557
557
|
|
|
558
|
-
A [`site`](#
|
|
558
|
+
A [`site`](#site-771c33) block (within [`origin_servers.private_name.site_locator`](#locator-0c95f1)) supports the following:
|
|
559
559
|
|
|
560
|
-
<a id="
|
|
560
|
+
<a id="name-5e7e2b"></a>• [`name`](#name-5e7e2b) - 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
|
|
561
561
|
|
|
562
|
-
<a id="
|
|
562
|
+
<a id="namespace-a2ea97"></a>• [`namespace`](#namespace-a2ea97) - 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
|
|
563
563
|
|
|
564
|
-
<a id="
|
|
564
|
+
<a id="tenant-33ad25"></a>• [`tenant`](#tenant-33ad25) - 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
|
|
565
565
|
|
|
566
566
|
#### Origin Servers Private Name Site Locator Virtual Site
|
|
567
567
|
|
|
568
|
-
A [`virtual_site`](#
|
|
568
|
+
A [`virtual_site`](#site-cf2f53) block (within [`origin_servers.private_name.site_locator`](#locator-0c95f1)) supports the following:
|
|
569
569
|
|
|
570
|
-
<a id="
|
|
570
|
+
<a id="name-ebea38"></a>• [`name`](#name-ebea38) - 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
|
|
571
571
|
|
|
572
|
-
<a id="
|
|
572
|
+
<a id="namespace-acc320"></a>• [`namespace`](#namespace-acc320) - 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
|
|
573
573
|
|
|
574
|
-
<a id="
|
|
574
|
+
<a id="tenant-5aa9b8"></a>• [`tenant`](#tenant-5aa9b8) - 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
|
|
575
575
|
|
|
576
576
|
#### Origin Servers Private Name Snat Pool
|
|
577
577
|
|
|
578
578
|
A [`snat_pool`](#origin-servers-private-name-snat-pool) block (within [`origin_servers.private_name`](#origin-servers-private-name)) supports the following:
|
|
579
579
|
|
|
580
|
-
<a id="
|
|
580
|
+
<a id="pool-569cef"></a>• [`no_snat_pool`](#pool-569cef) - Optional Block<br>Enable this option
|
|
581
581
|
|
|
582
|
-
<a id="
|
|
582
|
+
<a id="pool-b6c3f7"></a>• [`snat_pool`](#pool-b6c3f7) - Optional Block<br>IPv4 Prefix List. List of IPv4 prefixes that represent an endpoint<br>See [Snat Pool](#pool-b6c3f7) below.
|
|
583
583
|
|
|
584
584
|
#### Origin Servers Private Name Snat Pool Snat Pool
|
|
585
585
|
|
|
586
|
-
A [`snat_pool`](#
|
|
586
|
+
A [`snat_pool`](#pool-b6c3f7) block (within [`origin_servers.private_name.snat_pool`](#origin-servers-private-name-snat-pool)) supports the following:
|
|
587
587
|
|
|
588
|
-
<a id="
|
|
588
|
+
<a id="prefixes-5e0cb5"></a>• [`prefixes`](#prefixes-5e0cb5) - Optional List<br>IPv4 Prefix List. List of IPv4 prefixes that represent an endpoint
|
|
589
589
|
|
|
590
590
|
#### Origin Servers Public IP
|
|
591
591
|
|
|
@@ -599,7 +599,7 @@ A [`public_name`](#origin-servers-public-name) block (within [`origin_servers`](
|
|
|
599
599
|
|
|
600
600
|
<a id="origin-servers-public-name-dns-name"></a>• [`dns_name`](#origin-servers-public-name-dns-name) - Optional String<br>DNS Name. DNS Name
|
|
601
601
|
|
|
602
|
-
<a id="
|
|
602
|
+
<a id="interval-b4ce5c"></a>• [`refresh_interval`](#interval-b4ce5c) - Optional Number<br>DNS Refresh Interval. Interval for DNS refresh in seconds. Max value is 7 days as per `HTTPS://datatracker.ietf.org/doc/HTML/rfc8767`
|
|
603
603
|
|
|
604
604
|
#### Origin Servers Vn Private IP
|
|
605
605
|
|
|
@@ -607,17 +607,17 @@ A [`vn_private_ip`](#origin-servers-vn-private-ip) block (within [`origin_server
|
|
|
607
607
|
|
|
608
608
|
<a id="origin-servers-vn-private-ip-ip"></a>• [`ip`](#origin-servers-vn-private-ip-ip) - Optional String<br>IPv4. IPv4 address
|
|
609
609
|
|
|
610
|
-
<a id="
|
|
610
|
+
<a id="network-e703ab"></a>• [`virtual_network`](#network-e703ab) - 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 Network](#network-e703ab) below.
|
|
611
611
|
|
|
612
612
|
#### Origin Servers Vn Private IP Virtual Network
|
|
613
613
|
|
|
614
|
-
A [`virtual_network`](#
|
|
614
|
+
A [`virtual_network`](#network-e703ab) block (within [`origin_servers.vn_private_ip`](#origin-servers-vn-private-ip)) supports the following:
|
|
615
615
|
|
|
616
|
-
<a id="
|
|
616
|
+
<a id="name-6c5e61"></a>• [`name`](#name-6c5e61) - 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
|
|
617
617
|
|
|
618
|
-
<a id="
|
|
618
|
+
<a id="namespace-fd2396"></a>• [`namespace`](#namespace-fd2396) - 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
|
|
619
619
|
|
|
620
|
-
<a id="
|
|
620
|
+
<a id="tenant-550f0b"></a>• [`tenant`](#tenant-550f0b) - 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
|
|
621
621
|
|
|
622
622
|
#### Origin Servers Vn Private Name
|
|
623
623
|
|
|
@@ -625,17 +625,17 @@ A [`vn_private_name`](#origin-servers-vn-private-name) block (within [`origin_se
|
|
|
625
625
|
|
|
626
626
|
<a id="origin-servers-vn-private-name-dns-name"></a>• [`dns_name`](#origin-servers-vn-private-name-dns-name) - Optional String<br>DNS Name. DNS Name
|
|
627
627
|
|
|
628
|
-
<a id="
|
|
628
|
+
<a id="network-ff3b00"></a>• [`private_network`](#network-ff3b00) - 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 [Private Network](#network-ff3b00) below.
|
|
629
629
|
|
|
630
630
|
#### Origin Servers Vn Private Name Private Network
|
|
631
631
|
|
|
632
|
-
A [`private_network`](#
|
|
632
|
+
A [`private_network`](#network-ff3b00) block (within [`origin_servers.vn_private_name`](#origin-servers-vn-private-name)) supports the following:
|
|
633
633
|
|
|
634
|
-
<a id="
|
|
634
|
+
<a id="name-6e42c8"></a>• [`name`](#name-6e42c8) - 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
|
|
635
635
|
|
|
636
|
-
<a id="
|
|
636
|
+
<a id="namespace-145fbd"></a>• [`namespace`](#namespace-145fbd) - 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
|
|
637
637
|
|
|
638
|
-
<a id="
|
|
638
|
+
<a id="tenant-e702ea"></a>• [`tenant`](#tenant-e702ea) - 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
|
|
639
639
|
|
|
640
640
|
#### Timeouts
|
|
641
641
|
|
|
@@ -653,9 +653,9 @@ A [`timeouts`](#timeouts) block supports the following:
|
|
|
653
653
|
|
|
654
654
|
An [`upstream_conn_pool_reuse_type`](#upstream-conn-pool-reuse-type) block supports the following:
|
|
655
655
|
|
|
656
|
-
<a id="
|
|
656
|
+
<a id="reuse-008a14"></a>• [`disable_conn_pool_reuse`](#reuse-008a14) - Optional Block<br>Enable this option
|
|
657
657
|
|
|
658
|
-
<a id="
|
|
658
|
+
<a id="reuse-ad4462"></a>• [`enable_conn_pool_reuse`](#reuse-ad4462) - Optional Block<br>Enable this option
|
|
659
659
|
|
|
660
660
|
#### Use TLS
|
|
661
661
|
|
|
@@ -703,11 +703,11 @@ A [`tls_config`](#use-tls-tls-config) block (within [`use_tls`](#use-tls)) suppo
|
|
|
703
703
|
|
|
704
704
|
A [`custom_security`](#use-tls-tls-config-custom-security) block (within [`use_tls.tls_config`](#use-tls-tls-config)) supports the following:
|
|
705
705
|
|
|
706
|
-
<a id="
|
|
706
|
+
<a id="suites-2d975b"></a>• [`cipher_suites`](#suites-2d975b) - Optional List<br>Cipher Suites. The TLS listener will only support the specified cipher list
|
|
707
707
|
|
|
708
|
-
<a id="
|
|
708
|
+
<a id="version-11230d"></a>• [`max_version`](#version-11230d) - Optional String Defaults to `TLS_AUTO`<br>Possible values are `TLS_AUTO`, `TLSv1_0`, `TLSv1_1`, `TLSv1_2`, `TLSv1_3`<br>[Enum: TLS_AUTO|TLSv1_0|TLSv1_1|TLSv1_2|TLSv1_3] TLS Protocol. TlsProtocol is enumeration of supported TLS versions F5 Distributed Cloud will choose the optimal TLS version
|
|
709
709
|
|
|
710
|
-
<a id="
|
|
710
|
+
<a id="version-a76fa4"></a>• [`min_version`](#version-a76fa4) - Optional String Defaults to `TLS_AUTO`<br>Possible values are `TLS_AUTO`, `TLSv1_0`, `TLSv1_1`, `TLSv1_2`, `TLSv1_3`<br>[Enum: TLS_AUTO|TLSv1_0|TLSv1_1|TLSv1_2|TLSv1_3] TLS Protocol. TlsProtocol is enumeration of supported TLS versions F5 Distributed Cloud will choose the optimal TLS version
|
|
711
711
|
|
|
712
712
|
#### Use TLS Use mTLS
|
|
713
713
|
|
|
@@ -719,49 +719,49 @@ An [`use_mtls`](#use-tls-use-mtls) block (within [`use_tls`](#use-tls)) supports
|
|
|
719
719
|
|
|
720
720
|
A [`tls_certificates`](#use-tls-use-mtls-tls-certificates) block (within [`use_tls.use_mtls`](#use-tls-use-mtls)) supports the following:
|
|
721
721
|
|
|
722
|
-
<a id="
|
|
722
|
+
<a id="url-26c7eb"></a>• [`certificate_url`](#url-26c7eb) - Optional String<br>Certificate. TLS certificate. Certificate or certificate chain in PEM format including the PEM headers
|
|
723
723
|
|
|
724
|
-
<a id="
|
|
724
|
+
<a id="algorithms-d28b5f"></a>• [`custom_hash_algorithms`](#algorithms-d28b5f) - Optional Block<br>Hash Algorithms. Specifies the hash algorithms to be used<br>See [Custom Hash Algorithms](#algorithms-d28b5f) below.
|
|
725
725
|
|
|
726
|
-
<a id="
|
|
726
|
+
<a id="spec-ad9c6c"></a>• [`description_spec`](#spec-ad9c6c) - Optional String<br>Description. Description for the certificate
|
|
727
727
|
|
|
728
|
-
<a id="
|
|
728
|
+
<a id="stapling-242d9f"></a>• [`disable_ocsp_stapling`](#stapling-242d9f) - Optional Block<br>Enable this option
|
|
729
729
|
|
|
730
|
-
<a id="
|
|
730
|
+
<a id="key-dc1b14"></a>• [`private_key`](#key-dc1b14) - Optional Block<br>Secret. SecretType is used in an object to indicate a sensitive/confidential field<br>See [Private Key](#key-dc1b14) below.
|
|
731
731
|
|
|
732
|
-
<a id="
|
|
732
|
+
<a id="defaults-413d06"></a>• [`use_system_defaults`](#defaults-413d06) - Optional Block<br>Enable this option
|
|
733
733
|
|
|
734
734
|
#### Use TLS Use mTLS TLS Certificates Custom Hash Algorithms
|
|
735
735
|
|
|
736
|
-
A [`custom_hash_algorithms`](#
|
|
736
|
+
A [`custom_hash_algorithms`](#algorithms-d28b5f) block (within [`use_tls.use_mtls.tls_certificates`](#use-tls-use-mtls-tls-certificates)) supports the following:
|
|
737
737
|
|
|
738
|
-
<a id="
|
|
738
|
+
<a id="algorithms-84374d"></a>• [`hash_algorithms`](#algorithms-84374d) - 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
|
|
739
739
|
|
|
740
740
|
#### Use TLS Use mTLS TLS Certificates Private Key
|
|
741
741
|
|
|
742
|
-
A [`private_key`](#
|
|
742
|
+
A [`private_key`](#key-dc1b14) block (within [`use_tls.use_mtls.tls_certificates`](#use-tls-use-mtls-tls-certificates)) supports the following:
|
|
743
743
|
|
|
744
|
-
<a id="
|
|
744
|
+
<a id="info-1c2679"></a>• [`blindfold_secret_info`](#info-1c2679) - Optional Block<br>Blindfold Secret. BlindfoldSecretInfoType specifies information about the Secret managed by F5XC Secret Management<br>See [Blindfold Secret Info](#info-1c2679) below.
|
|
745
745
|
|
|
746
|
-
<a id="
|
|
746
|
+
<a id="info-c1bbfc"></a>• [`clear_secret_info`](#info-c1bbfc) - Optional Block<br>In-Clear Secret. ClearSecretInfoType specifies information about the Secret that is not encrypted<br>See [Clear Secret Info](#info-c1bbfc) below.
|
|
747
747
|
|
|
748
748
|
#### Use TLS Use mTLS TLS Certificates Private Key Blindfold Secret Info
|
|
749
749
|
|
|
750
|
-
A [`blindfold_secret_info`](#
|
|
750
|
+
A [`blindfold_secret_info`](#info-1c2679) block (within [`use_tls.use_mtls.tls_certificates.private_key`](#key-dc1b14)) supports the following:
|
|
751
751
|
|
|
752
|
-
<a id="
|
|
752
|
+
<a id="provider-cb3258"></a>• [`decryption_provider`](#provider-cb3258) - Optional String<br>Decryption Provider. Name of the Secret Management Access object that contains information about the backend Secret Management service
|
|
753
753
|
|
|
754
|
-
<a id="
|
|
754
|
+
<a id="location-67e6a9"></a>• [`location`](#location-67e6a9) - Optional String<br>Location. Location is the uri_ref. It could be in URL format for string:/// Or it could be a path if the store provider is an HTTP/HTTPS location
|
|
755
755
|
|
|
756
|
-
<a id="
|
|
756
|
+
<a id="provider-52f8e6"></a>• [`store_provider`](#provider-52f8e6) - Optional String<br>Store Provider. Name of the Secret Management Access object that contains information about the store to get encrypted bytes This field needs to be provided only if the URL scheme is not string:///
|
|
757
757
|
|
|
758
758
|
#### Use TLS Use mTLS TLS Certificates Private Key Clear Secret Info
|
|
759
759
|
|
|
760
|
-
A [`clear_secret_info`](#
|
|
760
|
+
A [`clear_secret_info`](#info-c1bbfc) block (within [`use_tls.use_mtls.tls_certificates.private_key`](#key-dc1b14)) supports the following:
|
|
761
761
|
|
|
762
|
-
<a id="
|
|
762
|
+
<a id="ref-83c284"></a>• [`provider_ref`](#ref-83c284) - Optional String<br>Provider. Name of the Secret Management Access object that contains information about the store to get encrypted bytes This field needs to be provided only if the URL scheme is not string:///
|
|
763
763
|
|
|
764
|
-
<a id="
|
|
764
|
+
<a id="url-b3c802"></a>• [`url`](#url-b3c802) - Optional String<br>URL. URL of the secret. Currently supported URL schemes is string:///. For string:/// scheme, Secret needs to be encoded Base64 format. When asked for this secret, caller will get Secret bytes after Base64 decoding
|
|
765
765
|
|
|
766
766
|
#### Use TLS Use mTLS Obj
|
|
767
767
|
|
|
@@ -777,19 +777,19 @@ An [`use_mtls_obj`](#use-tls-use-mtls-obj) block (within [`use_tls`](#use-tls))
|
|
|
777
777
|
|
|
778
778
|
An [`use_server_verification`](#use-tls-use-server-verification) block (within [`use_tls`](#use-tls)) supports the following:
|
|
779
779
|
|
|
780
|
-
<a id="
|
|
780
|
+
<a id="trusted-ca-965dea"></a>• [`trusted_ca`](#trusted-ca-965dea) - 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 [Trusted CA](#trusted-ca-965dea) below.
|
|
781
781
|
|
|
782
|
-
<a id="
|
|
782
|
+
<a id="url-21c5a6"></a>• [`trusted_ca_url`](#url-21c5a6) - Optional String<br>Inline Root CA Certificate (legacy). Upload a Root CA Certificate specifically for this Origin Pool for verification of server's certificate
|
|
783
783
|
|
|
784
784
|
#### Use TLS Use Server Verification Trusted CA
|
|
785
785
|
|
|
786
|
-
A [`trusted_ca`](#
|
|
786
|
+
A [`trusted_ca`](#trusted-ca-965dea) block (within [`use_tls.use_server_verification`](#use-tls-use-server-verification)) supports the following:
|
|
787
787
|
|
|
788
|
-
<a id="
|
|
788
|
+
<a id="name-3590a2"></a>• [`name`](#name-3590a2) - 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
|
|
789
789
|
|
|
790
|
-
<a id="
|
|
790
|
+
<a id="namespace-ac41ae"></a>• [`namespace`](#namespace-ac41ae) - 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
|
|
791
791
|
|
|
792
|
-
<a id="
|
|
792
|
+
<a id="tenant-892ff9"></a>• [`tenant`](#tenant-892ff9) - 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
|
|
793
793
|
|
|
794
794
|
## Import
|
|
795
795
|
|