@robinmordasiewicz/f5xc-terraform-mcp 3.3.0 → 3.4.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/docs/data-sources/bgp.md +2 -2
- package/dist/docs/data-sources/certificate.md +2 -2
- package/dist/docs/data-sources/discovery.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/site.md +2 -2
- package/dist/docs/data-sources/workload.md +2 -2
- package/dist/docs/resources/bgp.md +70 -4
- package/dist/docs/resources/certificate.md +4 -56
- package/dist/docs/resources/cloud_connect.md +2 -2
- package/dist/docs/resources/discovery.md +8 -259
- package/dist/docs/resources/log_receiver.md +44 -825
- package/dist/docs/resources/network_policy.md +217 -38
- package/dist/docs/resources/securemesh_site.md +1614 -253
- package/dist/docs/resources/site.md +1262 -257
- package/dist/docs/resources/workload.md +2951 -9
- package/dist/docs/specifications/api/CHANGELOG.md +4 -4
- package/dist/docs/specifications/api/README.md +1 -1
- package/dist/docs/specifications/api/domains/admin_console_and_ui.json +25 -25
- package/dist/docs/specifications/api/domains/ai_services.json +21 -21
- package/dist/docs/specifications/api/domains/api.json +173 -173
- package/dist/docs/specifications/api/domains/authentication.json +45 -45
- package/dist/docs/specifications/api/domains/bigip.json +94 -94
- package/dist/docs/specifications/api/domains/billing_and_usage.json +63 -63
- package/dist/docs/specifications/api/domains/blindfold.json +109 -109
- package/dist/docs/specifications/api/domains/bot_and_threat_defense.json +65 -65
- package/dist/docs/specifications/api/domains/cdn.json +177 -177
- package/dist/docs/specifications/api/domains/ce_management.json +76 -76
- package/dist/docs/specifications/api/domains/certificates.json +75 -75
- package/dist/docs/specifications/api/domains/cloud_infrastructure.json +112 -112
- package/dist/docs/specifications/api/domains/container_services.json +91 -91
- package/dist/docs/specifications/api/domains/data_and_privacy_security.json +66 -66
- package/dist/docs/specifications/api/domains/data_intelligence.json +62 -62
- package/dist/docs/specifications/api/domains/ddos.json +154 -154
- package/dist/docs/specifications/api/domains/dns.json +148 -148
- package/dist/docs/specifications/api/domains/managed_kubernetes.json +85 -85
- package/dist/docs/specifications/api/domains/marketplace.json +103 -103
- package/dist/docs/specifications/api/domains/network.json +230 -230
- package/dist/docs/specifications/api/domains/network_security.json +187 -187
- package/dist/docs/specifications/api/domains/nginx_one.json +62 -62
- package/dist/docs/specifications/api/domains/object_storage.json +12 -12
- package/dist/docs/specifications/api/domains/observability.json +102 -102
- package/dist/docs/specifications/api/domains/rate_limiting.json +52 -52
- package/dist/docs/specifications/api/domains/secops_and_incident_response.json +36 -36
- package/dist/docs/specifications/api/domains/service_mesh.json +119 -119
- package/dist/docs/specifications/api/domains/shape.json +313 -313
- package/dist/docs/specifications/api/domains/sites.json +349 -349
- package/dist/docs/specifications/api/domains/statistics.json +225 -225
- package/dist/docs/specifications/api/domains/support.json +108 -108
- package/dist/docs/specifications/api/domains/telemetry_and_insights.json +72 -72
- package/dist/docs/specifications/api/domains/tenant_and_identity.json +268 -268
- package/dist/docs/specifications/api/domains/threat_campaign.json +66 -66
- package/dist/docs/specifications/api/domains/users.json +66 -66
- package/dist/docs/specifications/api/domains/virtual.json +244 -244
- package/dist/docs/specifications/api/domains/vpm_and_node_management.json +1 -1
- package/dist/docs/specifications/api/domains/waf.json +139 -139
- package/dist/docs/specifications/api/index.json +12 -12
- package/dist/docs/specifications/api/openapi.json +2600 -2600
- package/dist/docs/specifications/api/openapi.yaml +2600 -2600
- package/package.json +1 -1
|
@@ -2,12 +2,12 @@
|
|
|
2
2
|
page_title: "f5xc_discovery Resource - terraform-provider-f5xc"
|
|
3
3
|
subcategory: "Applications"
|
|
4
4
|
description: |-
|
|
5
|
-
Manages
|
|
5
|
+
Manages API discovery creates a new object in the storage backend for metadata.namespace. in F5 Distributed Cloud.
|
|
6
6
|
---
|
|
7
7
|
|
|
8
8
|
# f5xc_discovery (Resource)
|
|
9
9
|
|
|
10
|
-
Manages
|
|
10
|
+
Manages API discovery creates a new object in the storage backend for metadata.namespace. in F5 Distributed Cloud.
|
|
11
11
|
|
|
12
12
|
~> **Note** For more information about this resource, please refer to the [F5 XC API Documentation](https://docs.cloud.f5.com/docs/api/).
|
|
13
13
|
|
|
@@ -15,7 +15,7 @@ Manages a Discovery resource in F5 Distributed Cloud for api to create discovery
|
|
|
15
15
|
|
|
16
16
|
```terraform
|
|
17
17
|
# Discovery Resource Example
|
|
18
|
-
# Manages
|
|
18
|
+
# Manages API discovery creates a new object in the storage backend for metadata.namespace. in F5 Distributed Cloud.
|
|
19
19
|
|
|
20
20
|
# Basic Discovery configuration
|
|
21
21
|
resource "f5xc_discovery" "example" {
|
|
@@ -78,19 +78,10 @@ resource "f5xc_discovery" "example" {
|
|
|
78
78
|
|
|
79
79
|
### Spec Argument Reference
|
|
80
80
|
|
|
81
|
-
|
|
82
|
-
• <a id="cluster-id"></a>[`cluster_id`](#cluster-id) - Optional String<br>Discovery cluster Identifier. Specify identifier for discovery cluster. This identifier can be specified in endpoint object to discover only from this discovery object
|
|
83
|
-
|
|
84
|
-
-> **One of the following:**
|
|
85
|
-
• <a id="discovery-consul"></a>[`discovery_consul`](#discovery-consul) - Optional Block<br>Consul Discovery Configuration. Discovery configuration for Hashicorp Consul<br>See [Discovery Consul](#discovery-consul) below for details.
|
|
86
|
-
<br><br>• <a id="discovery-k8s"></a>[`discovery_k8s`](#discovery-k8s) - Optional Block<br>K8S Discovery Configuration. Discovery configuration for K8S<br>See [Discovery K8S](#discovery-k8s) below for details.
|
|
87
|
-
|
|
88
|
-
<a id="no-cluster-id"></a>• [`no_cluster_id`](#no-cluster-id) - Optional Block<br>Enable this option
|
|
81
|
+
<a id="custom-auth-types"></a>• [`custom_auth_types`](#custom-auth-types) - Optional Block<br>Custom Authentication Types. Select your custom authentication types to be detected in the API discovery<br>See [Custom Auth Types](#custom-auth-types) below for details.
|
|
89
82
|
|
|
90
83
|
<a id="timeouts"></a>• [`timeouts`](#timeouts) - Optional Block<br>See [Timeouts](#timeouts) below for details.
|
|
91
84
|
|
|
92
|
-
<a id="where"></a>• [`where`](#where) - Optional Block<br>Network or Site Reference. NetworkSiteRefSelector defines a union of reference to site or reference to virtual_network or reference to virtual_site It is used to determine virtual network using following rules \* Direct reference to virtual_network object \* Site local network when refering to site object \* All site local networks for sites selected by refering to virtual_site object<br>See [Where](#where) below for details.
|
|
93
|
-
|
|
94
85
|
### Attributes Reference
|
|
95
86
|
|
|
96
87
|
In addition to all arguments above, the following attributes are exported:
|
|
@@ -99,173 +90,13 @@ In addition to all arguments above, the following attributes are exported:
|
|
|
99
90
|
|
|
100
91
|
---
|
|
101
92
|
|
|
102
|
-
####
|
|
103
|
-
|
|
104
|
-
A [`discovery_consul`](#discovery-consul) block supports the following:
|
|
105
|
-
|
|
106
|
-
<a id="discovery-consul-access-info"></a>• [`access_info`](#discovery-consul-access-info) - Optional Block<br>Hashicorp Consul Parameters. Hashicorp Consul API server information<br>See [Access Info](#discovery-consul-access-info) below.
|
|
107
|
-
|
|
108
|
-
<a id="discovery-consul-publish-info"></a>• [`publish_info`](#discovery-consul-publish-info) - Optional Block<br>VIP Publish Configuration. Consul Configuration to publish VIPs<br>See [Publish Info](#discovery-consul-publish-info) below.
|
|
109
|
-
|
|
110
|
-
#### Discovery Consul Access Info
|
|
111
|
-
|
|
112
|
-
An [`access_info`](#discovery-consul-access-info) block (within [`discovery_consul`](#discovery-consul)) supports the following:
|
|
113
|
-
|
|
114
|
-
<a id="info-c7c3de"></a>• [`connection_info`](#info-c7c3de) - Optional Block<br>REST API Config. Configuration details to access discovery service REST API<br>See [Connection Info](#info-c7c3de) below.
|
|
115
|
-
|
|
116
|
-
<a id="info-28e890"></a>• [`http_basic_auth_info`](#info-28e890) - Optional Block<br>Hashicorp Consul Credentials. Authentication parameters to access Hashicorp Consul<br>See [HTTP Basic Auth Info](#info-28e890) below.
|
|
117
|
-
|
|
118
|
-
#### Discovery Consul Access Info Connection Info
|
|
119
|
-
|
|
120
|
-
A [`connection_info`](#info-c7c3de) block (within [`discovery_consul.access_info`](#discovery-consul-access-info)) supports the following:
|
|
121
|
-
|
|
122
|
-
<a id="server-db3eac"></a>• [`api_server`](#server-db3eac) - Optional String<br>API Server and Port. API server must be a fully qualified domain string and port specified as host:port pair
|
|
123
|
-
|
|
124
|
-
<a id="info-72d38f"></a>• [`tls_info`](#info-72d38f) - Optional Block<br>Client TLS Config. TLS config for client of discovery service<br>See [TLS Info](#info-72d38f) below.
|
|
125
|
-
|
|
126
|
-
#### Discovery Consul Access Info Connection Info TLS Info
|
|
127
|
-
|
|
128
|
-
<a id="deep-2a9ae1"></a>Deeply nested **Info** block collapsed for readability.
|
|
129
|
-
|
|
130
|
-
#### Discovery Consul Access Info Connection Info TLS Info Key URL
|
|
131
|
-
|
|
132
|
-
<a id="deep-9298be"></a>Deeply nested **URL** block collapsed for readability.
|
|
133
|
-
|
|
134
|
-
#### Discovery Consul Access Info Connection Info TLS Info Key URL Blindfold Secret Info
|
|
135
|
-
|
|
136
|
-
<a id="deep-14dd70"></a>Deeply nested **Info** block collapsed for readability.
|
|
137
|
-
|
|
138
|
-
#### Discovery Consul Access Info Connection Info TLS Info Key URL Clear Secret Info
|
|
139
|
-
|
|
140
|
-
<a id="deep-ed594e"></a>Deeply nested **Info** block collapsed for readability.
|
|
141
|
-
|
|
142
|
-
#### Discovery Consul Access Info HTTP Basic Auth Info
|
|
143
|
-
|
|
144
|
-
<a id="deep-bbf940"></a>Deeply nested **Info** block collapsed for readability.
|
|
145
|
-
|
|
146
|
-
#### Discovery Consul Access Info HTTP Basic Auth Info Passwd URL
|
|
147
|
-
|
|
148
|
-
<a id="deep-ee109b"></a>Deeply nested **URL** block collapsed for readability.
|
|
149
|
-
|
|
150
|
-
#### Discovery Consul Access Info HTTP Basic Auth Info Passwd URL Blindfold Secret Info
|
|
151
|
-
|
|
152
|
-
<a id="deep-6be94c"></a>Deeply nested **Info** block collapsed for readability.
|
|
153
|
-
|
|
154
|
-
#### Discovery Consul Access Info HTTP Basic Auth Info Passwd URL Clear Secret Info
|
|
155
|
-
|
|
156
|
-
<a id="deep-82d259"></a>Deeply nested **Info** block collapsed for readability.
|
|
157
|
-
|
|
158
|
-
#### Discovery Consul Publish Info
|
|
159
|
-
|
|
160
|
-
A [`publish_info`](#discovery-consul-publish-info) block (within [`discovery_consul`](#discovery-consul)) supports the following:
|
|
161
|
-
|
|
162
|
-
<a id="discovery-consul-publish-info-disable"></a>• [`disable`](#discovery-consul-publish-info-disable) - Optional Block<br>Enable this option
|
|
163
|
-
|
|
164
|
-
<a id="discovery-consul-publish-info-publish"></a>• [`publish`](#discovery-consul-publish-info-publish) - Optional Block<br>Enable this option
|
|
165
|
-
|
|
166
|
-
#### Discovery K8S
|
|
167
|
-
|
|
168
|
-
A [`discovery_k8s`](#discovery-k8s) block supports the following:
|
|
169
|
-
|
|
170
|
-
<a id="discovery-k8s-access-info"></a>• [`access_info`](#discovery-k8s-access-info) - Optional Block<br>K8S API Server. K8S API server access<br>See [Access Info](#discovery-k8s-access-info) below.
|
|
171
|
-
|
|
172
|
-
<a id="discovery-k8s-default-all"></a>• [`default_all`](#discovery-k8s-default-all) - Optional Block<br>Enable this option
|
|
173
|
-
|
|
174
|
-
<a id="discovery-k8s-namespace-mapping"></a>• [`namespace_mapping`](#discovery-k8s-namespace-mapping) - Optional Block<br>K8S Namespace Mapping. Select the mapping between K8S namespaces from which services will be discovered and App Namespace to which the discovered services will be shared<br>See [Namespace Mapping](#discovery-k8s-namespace-mapping) below.
|
|
175
|
-
|
|
176
|
-
<a id="discovery-k8s-publish-info"></a>• [`publish_info`](#discovery-k8s-publish-info) - Optional Block<br>VIP Publish Configurations. K8S Configuration to publish VIPs<br>See [Publish Info](#discovery-k8s-publish-info) below.
|
|
177
|
-
|
|
178
|
-
#### Discovery K8S Access Info
|
|
179
|
-
|
|
180
|
-
An [`access_info`](#discovery-k8s-access-info) block (within [`discovery_k8s`](#discovery-k8s)) supports the following:
|
|
181
|
-
|
|
182
|
-
<a id="info-731c25"></a>• [`connection_info`](#info-731c25) - Optional Block<br>REST API Config. Configuration details to access discovery service REST API<br>See [Connection Info](#info-731c25) below.
|
|
183
|
-
|
|
184
|
-
<a id="discovery-k8s-access-info-isolated"></a>• [`isolated`](#discovery-k8s-access-info-isolated) - Optional Block<br>Enable this option
|
|
185
|
-
|
|
186
|
-
<a id="url-d50898"></a>• [`kubeconfig_url`](#url-d50898) - Optional Block<br>Secret. SecretType is used in an object to indicate a sensitive/confidential field<br>See [Kubeconfig URL](#url-d50898) below.
|
|
187
|
-
|
|
188
|
-
<a id="discovery-k8s-access-info-reachable"></a>• [`reachable`](#discovery-k8s-access-info-reachable) - Optional Block<br>Enable this option
|
|
189
|
-
|
|
190
|
-
#### Discovery K8S Access Info Connection Info
|
|
191
|
-
|
|
192
|
-
A [`connection_info`](#info-731c25) block (within [`discovery_k8s.access_info`](#discovery-k8s-access-info)) supports the following:
|
|
193
|
-
|
|
194
|
-
<a id="server-c32428"></a>• [`api_server`](#server-c32428) - Optional String<br>API Server and Port. API server must be a fully qualified domain string and port specified as host:port pair
|
|
195
|
-
|
|
196
|
-
<a id="info-16e7c5"></a>• [`tls_info`](#info-16e7c5) - Optional Block<br>Client TLS Config. TLS config for client of discovery service<br>See [TLS Info](#info-16e7c5) below.
|
|
197
|
-
|
|
198
|
-
#### Discovery K8S Access Info Connection Info TLS Info
|
|
199
|
-
|
|
200
|
-
<a id="deep-4a5283"></a>Deeply nested **Info** block collapsed for readability.
|
|
201
|
-
|
|
202
|
-
#### Discovery K8S Access Info Connection Info TLS Info Key URL
|
|
203
|
-
|
|
204
|
-
<a id="deep-a976c1"></a>Deeply nested **URL** block collapsed for readability.
|
|
205
|
-
|
|
206
|
-
#### Discovery K8S Access Info Connection Info TLS Info Key URL Blindfold Secret Info
|
|
207
|
-
|
|
208
|
-
<a id="deep-c49615"></a>Deeply nested **Info** block collapsed for readability.
|
|
209
|
-
|
|
210
|
-
#### Discovery K8S Access Info Connection Info TLS Info Key URL Clear Secret Info
|
|
211
|
-
|
|
212
|
-
<a id="deep-b39c26"></a>Deeply nested **Info** block collapsed for readability.
|
|
213
|
-
|
|
214
|
-
#### Discovery K8S Access Info Kubeconfig URL
|
|
215
|
-
|
|
216
|
-
A [`kubeconfig_url`](#url-d50898) block (within [`discovery_k8s.access_info`](#discovery-k8s-access-info)) supports the following:
|
|
217
|
-
|
|
218
|
-
<a id="info-fef53c"></a>• [`blindfold_secret_info`](#info-fef53c) - Optional Block<br>Blindfold Secret. BlindfoldSecretInfoType specifies information about the Secret managed by F5XC Secret Management<br>See [Blindfold Secret Info](#info-fef53c) below.
|
|
219
|
-
|
|
220
|
-
<a id="info-ba8969"></a>• [`clear_secret_info`](#info-ba8969) - Optional Block<br>In-Clear Secret. ClearSecretInfoType specifies information about the Secret that is not encrypted<br>See [Clear Secret Info](#info-ba8969) below.
|
|
93
|
+
#### Custom Auth Types
|
|
221
94
|
|
|
222
|
-
|
|
95
|
+
A [`custom_auth_types`](#custom-auth-types) block supports the following:
|
|
223
96
|
|
|
224
|
-
<a id="
|
|
97
|
+
<a id="custom-auth-types-parameter-name"></a>• [`parameter_name`](#custom-auth-types-parameter-name) - Optional String<br>Parameter Name. The authentication parameter name
|
|
225
98
|
|
|
226
|
-
|
|
227
|
-
|
|
228
|
-
<a id="deep-4a4f8b"></a>Deeply nested **Info** block collapsed for readability.
|
|
229
|
-
|
|
230
|
-
#### Discovery K8S Namespace Mapping
|
|
231
|
-
|
|
232
|
-
A [`namespace_mapping`](#discovery-k8s-namespace-mapping) block (within [`discovery_k8s`](#discovery-k8s)) supports the following:
|
|
233
|
-
|
|
234
|
-
<a id="discovery-k8s-namespace-mapping-items"></a>• [`items`](#discovery-k8s-namespace-mapping-items) - Optional Block<br>Regex Matching. Map K8S namespace(s) to App Namespaces. In Shared Configuration, Discovered Services can only be mapped to a single App Namespace, which is determined by the first matched regex<br>See [Items](#discovery-k8s-namespace-mapping-items) below.
|
|
235
|
-
|
|
236
|
-
#### Discovery K8S Namespace Mapping Items
|
|
237
|
-
|
|
238
|
-
An [`items`](#discovery-k8s-namespace-mapping-items) block (within [`discovery_k8s.namespace_mapping`](#discovery-k8s-namespace-mapping)) supports the following:
|
|
239
|
-
|
|
240
|
-
<a id="namespace-b6599c"></a>• [`namespace`](#namespace-b6599c) - Optional String<br>F5XC Application Namespaces. Select a namespace
|
|
241
|
-
|
|
242
|
-
<a id="regex-0aa709"></a>• [`namespace_regex`](#regex-0aa709) - Optional String<br>K8S Namespaces. The regex here will be used to match K8S namespace(s)
|
|
243
|
-
|
|
244
|
-
#### Discovery K8S Publish Info
|
|
245
|
-
|
|
246
|
-
A [`publish_info`](#discovery-k8s-publish-info) block (within [`discovery_k8s`](#discovery-k8s)) supports the following:
|
|
247
|
-
|
|
248
|
-
<a id="discovery-k8s-publish-info-disable"></a>• [`disable`](#discovery-k8s-publish-info-disable) - Optional Block<br>Enable this option
|
|
249
|
-
|
|
250
|
-
<a id="delegation-53a235"></a>• [`dns_delegation`](#delegation-53a235) - Optional Block<br>K8SDelegationType<br>See [DNS Delegation](#delegation-53a235) below.
|
|
251
|
-
|
|
252
|
-
<a id="discovery-k8s-publish-info-publish"></a>• [`publish`](#discovery-k8s-publish-info-publish) - Optional Block<br>K8SPublishType<br>See [Publish](#discovery-k8s-publish-info-publish) below.
|
|
253
|
-
|
|
254
|
-
<a id="fqdns-f85bbe"></a>• [`publish_fqdns`](#fqdns-f85bbe) - Optional Block<br>Enable this option
|
|
255
|
-
|
|
256
|
-
#### Discovery K8S Publish Info DNS Delegation
|
|
257
|
-
|
|
258
|
-
A [`dns_delegation`](#delegation-53a235) block (within [`discovery_k8s.publish_info`](#discovery-k8s-publish-info)) supports the following:
|
|
259
|
-
|
|
260
|
-
<a id="mode-f08507"></a>• [`dns_mode`](#mode-f08507) - Optional String Defaults to `CORE_DNS`<br>Possible values are `CORE_DNS`, `KUBE_DNS`<br>[Enum: CORE_DNS|KUBE_DNS] DNS Mode. Two modes are possible CoreDNS: Whether external K8S cluster is running core-DNS KubeDNS: External K8S cluster is running kube-DNS
|
|
261
|
-
|
|
262
|
-
<a id="subdomain-f4f8f0"></a>• [`subdomain`](#subdomain-f4f8f0) - Optional String<br>Subdomain. The DNS subdomain for which F5XC will respond to DNS queries
|
|
263
|
-
|
|
264
|
-
#### Discovery K8S Publish Info Publish
|
|
265
|
-
|
|
266
|
-
A [`publish`](#discovery-k8s-publish-info-publish) block (within [`discovery_k8s.publish_info`](#discovery-k8s-publish-info)) supports the following:
|
|
267
|
-
|
|
268
|
-
<a id="namespace-a13be9"></a>• [`namespace`](#namespace-a13be9) - Optional String<br>Default Namespace. The namespace where the service/endpoints need to be created if it's not included in the domain. The external K8S administrator needs to ensure that the namespace exists
|
|
99
|
+
<a id="custom-auth-types-parameter-type"></a>• [`parameter_type`](#custom-auth-types-parameter-type) - Optional String Defaults to `QUERY_PARAMETER`<br>Possible values are `QUERY_PARAMETER`, `HEADER`, `COOKIE`<br>[Enum: QUERY_PARAMETER|HEADER|COOKIE] Authentication Parameter Type. Enumeration for authentication parameter types
|
|
269
100
|
|
|
270
101
|
#### Timeouts
|
|
271
102
|
|
|
@@ -279,88 +110,6 @@ A [`timeouts`](#timeouts) block supports the following:
|
|
|
279
110
|
|
|
280
111
|
<a id="timeouts-update"></a>• [`update`](#timeouts-update) - Optional String (Defaults to `10 minutes`)<br>Used when updating the resource
|
|
281
112
|
|
|
282
|
-
#### Where
|
|
283
|
-
|
|
284
|
-
A [`where`](#where) block supports the following:
|
|
285
|
-
|
|
286
|
-
<a id="where-site"></a>• [`site`](#where-site) - Optional Block<br>Site Reference. This specifies a direct reference to a site configuration object<br>See [Site](#where-site) below.
|
|
287
|
-
|
|
288
|
-
<a id="where-virtual-network"></a>• [`virtual_network`](#where-virtual-network) - Optional Block<br>Network Reference. This specifies a direct reference to a network configuration object<br>See [Virtual Network](#where-virtual-network) below.
|
|
289
|
-
|
|
290
|
-
<a id="where-virtual-site"></a>• [`virtual_site`](#where-virtual-site) - Optional Block<br>Virtual Site. A reference to virtual_site object<br>See [Virtual Site](#where-virtual-site) below.
|
|
291
|
-
|
|
292
|
-
#### Where Site
|
|
293
|
-
|
|
294
|
-
A [`site`](#where-site) block (within [`where`](#where)) supports the following:
|
|
295
|
-
|
|
296
|
-
<a id="where-site-disable-internet-vip"></a>• [`disable_internet_vip`](#where-site-disable-internet-vip) - Optional Block<br>Enable this option
|
|
297
|
-
|
|
298
|
-
<a id="where-site-enable-internet-vip"></a>• [`enable_internet_vip`](#where-site-enable-internet-vip) - Optional Block<br>Enable this option
|
|
299
|
-
|
|
300
|
-
<a id="where-site-network-type"></a>• [`network_type`](#where-site-network-type) - Optional String Defaults to `VIRTUAL_NETWORK_SITE_LOCAL`<br>Possible values are `VIRTUAL_NETWORK_SITE_LOCAL`, `VIRTUAL_NETWORK_SITE_LOCAL_INSIDE`, `VIRTUAL_NETWORK_PER_SITE`, `VIRTUAL_NETWORK_PUBLIC`, `VIRTUAL_NETWORK_GLOBAL`, `VIRTUAL_NETWORK_SITE_SERVICE`, `VIRTUAL_NETWORK_VER_INTERNAL`, `VIRTUAL_NETWORK_SITE_LOCAL_INSIDE_OUTSIDE`, `VIRTUAL_NETWORK_IP_AUTO`, `VIRTUAL_NETWORK_VOLTADN_PRIVATE_NETWORK`, `VIRTUAL_NETWORK_SRV6_NETWORK`, `VIRTUAL_NETWORK_IP_FABRIC`, `VIRTUAL_NETWORK_SEGMENT`<br>[Enum: VIRTUAL_NETWORK_SITE_LOCAL|VIRTUAL_NETWORK_SITE_LOCAL_INSIDE|VIRTUAL_NETWORK_PER_SITE|VIRTUAL_NETWORK_PUBLIC|VIRTUAL_NETWORK_GLOBAL|VIRTUAL_NETWORK_SITE_SERVICE|VIRTUAL_NETWORK_VER_INTERNAL|VIRTUAL_NETWORK_SITE_LOCAL_INSIDE_OUTSIDE|VIRTUAL_NETWORK_IP_AUTO|VIRTUAL_NETWORK_VOLTADN_PRIVATE_NETWORK|VIRTUAL_NETWORK_SRV6_NETWORK|VIRTUAL_NETWORK_IP_FABRIC|VIRTUAL_NETWORK_SEGMENT] Virtual Network Type. Different types of virtual networks understood by the system Virtual-network of type VIRTUAL_NETWORK_SITE_LOCAL provides connectivity to public (outside) network. This is an insecure network and is connected to public internet via NAT Gateways/firwalls Virtual-network of this type is local to every site. Two virtual networks of this type on different sites are neither related nor connected. Constraints: There can be atmost one virtual network of this type in a given site. This network type is supported on CE sites. This network is created automatically and present on all sites Virtual-network of type VIRTUAL_NETWORK_SITE_LOCAL_INSIDE is a private network inside site. It is a secure network and is not connected to public network. Virtual-network of this type is local to every site. Two virtual networks of this type on different sites are neither related nor connected. Constraints: There can be atmost one virtual network of this type in a given site. This network type is supported on CE sites. This network is created during provisioning of site User defined per-site virtual network. Scope of this virtual network is limited to the site. This is not yet supported Virtual-network of type VIRTUAL_NETWORK_PUBLIC directly conects to the public internet. Virtual-network of this type is local to every site. Two virtual networks of this type on different sites are neither related nor connected. Constraints: There can be atmost one virtual network of this type in a given site. This network type is supported on RE sites only It is an internally created by the system. They must not be created by user Virtual Neworks with global scope across different sites in F5XC domain. An example global virtual-network called 'AIN Network' is created for every tenant. For F5 Distributed Cloud fabric Constraints: It is currently only supported as internally created by the system. VK8s service network for a given tenant. Used to advertise a virtual host only to vk8s pods for that tenant Constraints: It is an internally created by the system. Must not be created by user VER internal network for the site. It can only be used for virtual hosts with SMA_PROXY type proxy Constraints: It is an internally created by the system. Must not be created by user Virtual-network of type VIRTUAL_NETWORK_SITE_LOCAL_INSIDE_OUTSIDE represents both VIRTUAL_NETWORK_SITE_LOCAL and VIRTUAL_NETWORK_SITE_LOCAL_INSIDE Constraints: This network type is only meaningful in an advertise policy When virtual-network of type VIRTUAL_NETWORK_IP_AUTO is selected for an endpoint, VER will try to determine the network based on the provided IP address Constraints: This network type is only meaningful in an endpoint VoltADN Private Network is used on F5 Distributed Cloud RE(s) to connect to customer private networks This network is created by opening a support ticket This network is per site srv6 network VER IP Fabric network for the site. This Virtual network type is used for exposing virtual host on IP Fabric network on the VER site or for endpoint in IP Fabric network Constraints: It is an internally created by the system. Must not be created by user Network internally created for a segment Constraints: It is an internally created by the system. Must not be created by user
|
|
301
|
-
|
|
302
|
-
<a id="where-site-ref"></a>• [`ref`](#where-site-ref) - Optional Block<br>Reference. A site direct reference<br>See [Ref](#where-site-ref) below.
|
|
303
|
-
|
|
304
|
-
#### Where Site Ref
|
|
305
|
-
|
|
306
|
-
A [`ref`](#where-site-ref) block (within [`where.site`](#where-site)) supports the following:
|
|
307
|
-
|
|
308
|
-
<a id="where-site-ref-kind"></a>• [`kind`](#where-site-ref-kind) - Optional String<br>Kind. When a configuration object(e.g. Virtual_host) refers to another(e.g route) then kind will hold the referred object's kind (e.g. 'route')
|
|
309
|
-
|
|
310
|
-
<a id="where-site-ref-name"></a>• [`name`](#where-site-ref-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
|
|
311
|
-
|
|
312
|
-
<a id="where-site-ref-namespace"></a>• [`namespace`](#where-site-ref-namespace) - 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
|
|
313
|
-
|
|
314
|
-
<a id="where-site-ref-tenant"></a>• [`tenant`](#where-site-ref-tenant) - 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
|
|
315
|
-
|
|
316
|
-
<a id="where-site-ref-uid"></a>• [`uid`](#where-site-ref-uid) - Optional String<br>UID. When a configuration object(e.g. Virtual_host) refers to another(e.g route) then uid will hold the referred object's(e.g. Route's) uid
|
|
317
|
-
|
|
318
|
-
#### Where Virtual Network
|
|
319
|
-
|
|
320
|
-
A [`virtual_network`](#where-virtual-network) block (within [`where`](#where)) supports the following:
|
|
321
|
-
|
|
322
|
-
<a id="where-virtual-network-ref"></a>• [`ref`](#where-virtual-network-ref) - Optional Block<br>Reference. A virtual network direct reference<br>See [Ref](#where-virtual-network-ref) below.
|
|
323
|
-
|
|
324
|
-
#### Where Virtual Network Ref
|
|
325
|
-
|
|
326
|
-
A [`ref`](#where-virtual-network-ref) block (within [`where.virtual_network`](#where-virtual-network)) supports the following:
|
|
327
|
-
|
|
328
|
-
<a id="where-virtual-network-ref-kind"></a>• [`kind`](#where-virtual-network-ref-kind) - Optional String<br>Kind. When a configuration object(e.g. Virtual_host) refers to another(e.g route) then kind will hold the referred object's kind (e.g. 'route')
|
|
329
|
-
|
|
330
|
-
<a id="where-virtual-network-ref-name"></a>• [`name`](#where-virtual-network-ref-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
|
|
331
|
-
|
|
332
|
-
<a id="where-virtual-network-ref-namespace"></a>• [`namespace`](#where-virtual-network-ref-namespace) - 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
|
|
333
|
-
|
|
334
|
-
<a id="where-virtual-network-ref-tenant"></a>• [`tenant`](#where-virtual-network-ref-tenant) - 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
|
|
335
|
-
|
|
336
|
-
<a id="where-virtual-network-ref-uid"></a>• [`uid`](#where-virtual-network-ref-uid) - Optional String<br>UID. When a configuration object(e.g. Virtual_host) refers to another(e.g route) then uid will hold the referred object's(e.g. Route's) uid
|
|
337
|
-
|
|
338
|
-
#### Where Virtual Site
|
|
339
|
-
|
|
340
|
-
A [`virtual_site`](#where-virtual-site) block (within [`where`](#where)) supports the following:
|
|
341
|
-
|
|
342
|
-
<a id="where-virtual-site-disable-internet-vip"></a>• [`disable_internet_vip`](#where-virtual-site-disable-internet-vip) - Optional Block<br>Enable this option
|
|
343
|
-
|
|
344
|
-
<a id="where-virtual-site-enable-internet-vip"></a>• [`enable_internet_vip`](#where-virtual-site-enable-internet-vip) - Optional Block<br>Enable this option
|
|
345
|
-
|
|
346
|
-
<a id="where-virtual-site-network-type"></a>• [`network_type`](#where-virtual-site-network-type) - Optional String Defaults to `VIRTUAL_NETWORK_SITE_LOCAL`<br>Possible values are `VIRTUAL_NETWORK_SITE_LOCAL`, `VIRTUAL_NETWORK_SITE_LOCAL_INSIDE`, `VIRTUAL_NETWORK_PER_SITE`, `VIRTUAL_NETWORK_PUBLIC`, `VIRTUAL_NETWORK_GLOBAL`, `VIRTUAL_NETWORK_SITE_SERVICE`, `VIRTUAL_NETWORK_VER_INTERNAL`, `VIRTUAL_NETWORK_SITE_LOCAL_INSIDE_OUTSIDE`, `VIRTUAL_NETWORK_IP_AUTO`, `VIRTUAL_NETWORK_VOLTADN_PRIVATE_NETWORK`, `VIRTUAL_NETWORK_SRV6_NETWORK`, `VIRTUAL_NETWORK_IP_FABRIC`, `VIRTUAL_NETWORK_SEGMENT`<br>[Enum: VIRTUAL_NETWORK_SITE_LOCAL|VIRTUAL_NETWORK_SITE_LOCAL_INSIDE|VIRTUAL_NETWORK_PER_SITE|VIRTUAL_NETWORK_PUBLIC|VIRTUAL_NETWORK_GLOBAL|VIRTUAL_NETWORK_SITE_SERVICE|VIRTUAL_NETWORK_VER_INTERNAL|VIRTUAL_NETWORK_SITE_LOCAL_INSIDE_OUTSIDE|VIRTUAL_NETWORK_IP_AUTO|VIRTUAL_NETWORK_VOLTADN_PRIVATE_NETWORK|VIRTUAL_NETWORK_SRV6_NETWORK|VIRTUAL_NETWORK_IP_FABRIC|VIRTUAL_NETWORK_SEGMENT] Virtual Network Type. Different types of virtual networks understood by the system Virtual-network of type VIRTUAL_NETWORK_SITE_LOCAL provides connectivity to public (outside) network. This is an insecure network and is connected to public internet via NAT Gateways/firwalls Virtual-network of this type is local to every site. Two virtual networks of this type on different sites are neither related nor connected. Constraints: There can be atmost one virtual network of this type in a given site. This network type is supported on CE sites. This network is created automatically and present on all sites Virtual-network of type VIRTUAL_NETWORK_SITE_LOCAL_INSIDE is a private network inside site. It is a secure network and is not connected to public network. Virtual-network of this type is local to every site. Two virtual networks of this type on different sites are neither related nor connected. Constraints: There can be atmost one virtual network of this type in a given site. This network type is supported on CE sites. This network is created during provisioning of site User defined per-site virtual network. Scope of this virtual network is limited to the site. This is not yet supported Virtual-network of type VIRTUAL_NETWORK_PUBLIC directly conects to the public internet. Virtual-network of this type is local to every site. Two virtual networks of this type on different sites are neither related nor connected. Constraints: There can be atmost one virtual network of this type in a given site. This network type is supported on RE sites only It is an internally created by the system. They must not be created by user Virtual Neworks with global scope across different sites in F5XC domain. An example global virtual-network called 'AIN Network' is created for every tenant. For F5 Distributed Cloud fabric Constraints: It is currently only supported as internally created by the system. VK8s service network for a given tenant. Used to advertise a virtual host only to vk8s pods for that tenant Constraints: It is an internally created by the system. Must not be created by user VER internal network for the site. It can only be used for virtual hosts with SMA_PROXY type proxy Constraints: It is an internally created by the system. Must not be created by user Virtual-network of type VIRTUAL_NETWORK_SITE_LOCAL_INSIDE_OUTSIDE represents both VIRTUAL_NETWORK_SITE_LOCAL and VIRTUAL_NETWORK_SITE_LOCAL_INSIDE Constraints: This network type is only meaningful in an advertise policy When virtual-network of type VIRTUAL_NETWORK_IP_AUTO is selected for an endpoint, VER will try to determine the network based on the provided IP address Constraints: This network type is only meaningful in an endpoint VoltADN Private Network is used on F5 Distributed Cloud RE(s) to connect to customer private networks This network is created by opening a support ticket This network is per site srv6 network VER IP Fabric network for the site. This Virtual network type is used for exposing virtual host on IP Fabric network on the VER site or for endpoint in IP Fabric network Constraints: It is an internally created by the system. Must not be created by user Network internally created for a segment Constraints: It is an internally created by the system. Must not be created by user
|
|
347
|
-
|
|
348
|
-
<a id="where-virtual-site-ref"></a>• [`ref`](#where-virtual-site-ref) - Optional Block<br>Reference. A virtual_site direct reference<br>See [Ref](#where-virtual-site-ref) below.
|
|
349
|
-
|
|
350
|
-
#### Where Virtual Site Ref
|
|
351
|
-
|
|
352
|
-
A [`ref`](#where-virtual-site-ref) block (within [`where.virtual_site`](#where-virtual-site)) supports the following:
|
|
353
|
-
|
|
354
|
-
<a id="where-virtual-site-ref-kind"></a>• [`kind`](#where-virtual-site-ref-kind) - Optional String<br>Kind. When a configuration object(e.g. Virtual_host) refers to another(e.g route) then kind will hold the referred object's kind (e.g. 'route')
|
|
355
|
-
|
|
356
|
-
<a id="where-virtual-site-ref-name"></a>• [`name`](#where-virtual-site-ref-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
|
|
357
|
-
|
|
358
|
-
<a id="where-virtual-site-ref-namespace"></a>• [`namespace`](#where-virtual-site-ref-namespace) - 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
|
-
|
|
360
|
-
<a id="where-virtual-site-ref-tenant"></a>• [`tenant`](#where-virtual-site-ref-tenant) - 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
|
-
|
|
362
|
-
<a id="where-virtual-site-ref-uid"></a>• [`uid`](#where-virtual-site-ref-uid) - Optional String<br>UID. When a configuration object(e.g. Virtual_host) refers to another(e.g route) then uid will hold the referred object's(e.g. Route's) uid
|
|
363
|
-
|
|
364
113
|
---
|
|
365
114
|
|
|
366
115
|
## Common Types
|