@robinmordasiewicz/f5xc-terraform-mcp 3.12.3 → 3.13.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (15) hide show
  1. package/dist/docs/data-sources/discovery.md +2 -2
  2. package/dist/docs/data-sources/fast_acl.md +2 -2
  3. package/dist/docs/data-sources/irule.md +2 -2
  4. package/dist/docs/data-sources/network_policy.md +2 -2
  5. package/dist/docs/data-sources/site.md +2 -2
  6. package/dist/docs/data-sources/workload.md +2 -2
  7. package/dist/docs/resources/discovery.md +259 -8
  8. package/dist/docs/resources/fast_acl.md +60 -166
  9. package/dist/docs/resources/irule.md +5 -7
  10. package/dist/docs/resources/network_policy.md +217 -38
  11. package/dist/docs/resources/site.md +12 -897
  12. package/dist/docs/resources/workload.md +2951 -9
  13. package/dist/metadata/resource-metadata.json +145 -492
  14. package/manifest.json +1 -1
  15. package/package.json +1 -1
package/dist/docs/data-sources/discovery.md CHANGED
@@ -2,12 +2,12 @@
2
2
  page_title: "f5xc_discovery Data Source - terraform-provider-f5xc"
3
3
  subcategory: "Applications"
4
4
  description: |-
5
- Manages API discovery creates a new object in the storage backend for metadata.namespace. in F5 Distributed Cloud.
5
+ Manages a Discovery resource in F5 Distributed Cloud for api to create discovery object for a site or virtual site in system namespace. configuration.
6
6
  ---
7
7
 
8
8
  # f5xc_discovery (Data Source)
9
9
 
10
- Manages API discovery creates a new object in the storage backend for metadata.namespace. in F5 Distributed Cloud.
10
+ Manages a Discovery resource in F5 Distributed Cloud for api to create discovery object for a site or virtual site in system namespace. configuration.
11
11
 
12
12
  ~> **Note** For more information about this data source, please refer to the [F5 XC API Documentation](https://docs.cloud.f5.com/docs/api/).
13
13
 
package/dist/docs/data-sources/fast_acl.md CHANGED
@@ -2,12 +2,12 @@
2
2
  page_title: "f5xc_fast_acl Data Source - terraform-provider-f5xc"
3
3
  subcategory: "Security"
4
4
  description: |-
5
- Manages object, object contains rules to protect site from denial of service It has destination{destination IP, destination port) and references to. in F5 Distributed Cloud.
5
+ Manages new Fast ACL rule, has specification to match source IP, source port and action to apply. in F5 Distributed Cloud.
6
6
  ---
7
7
 
8
8
  # f5xc_fast_acl (Data Source)
9
9
 
10
- Manages object, object contains rules to protect site from denial of service It has destination{destination IP, destination port) and references to. in F5 Distributed Cloud.
10
+ Manages new Fast ACL rule, has specification to match source IP, source port and action to apply. in F5 Distributed Cloud.
11
11
 
12
12
  ~> **Note** For more information about this data source, please refer to the [F5 XC API Documentation](https://docs.cloud.f5.com/docs/api/).
13
13
 
package/dist/docs/data-sources/irule.md CHANGED
@@ -2,12 +2,12 @@
2
2
  page_title: "f5xc_irule Data Source - terraform-provider-f5xc"
3
3
  subcategory: "BIG-IP Integration"
4
4
  description: |-
5
- Manages a Irule resource in F5 Distributed Cloud for desired state for big-ip irule service. configuration.
5
+ Manages iRule in a given namespace. If one already exists it will give an error. in F5 Distributed Cloud.
6
6
  ---
7
7
 
8
8
  # f5xc_irule (Data Source)
9
9
 
10
- Manages a Irule resource in F5 Distributed Cloud for desired state for big-ip irule service. configuration.
10
+ Manages iRule in a given namespace. If one already exists it will give an error. in F5 Distributed Cloud.
11
11
 
12
12
  ~> **Note** For more information about this data source, please refer to the [F5 XC API Documentation](https://docs.cloud.f5.com/docs/api/).
13
13
 
package/dist/docs/data-sources/network_policy.md CHANGED
@@ -2,12 +2,12 @@
2
2
  page_title: "f5xc_network_policy Data Source - terraform-provider-f5xc"
3
3
  subcategory: "Security"
4
4
  description: |-
5
- Manages network policy rule with configured parameters in specified namespace. in F5 Distributed Cloud.
5
+ Manages new network policy with configured parameters in specified namespace. in F5 Distributed Cloud.
6
6
  ---
7
7
 
8
8
  # f5xc_network_policy (Data Source)
9
9
 
10
- Manages network policy rule with configured parameters in specified namespace. in F5 Distributed Cloud.
10
+ Manages new network policy with configured parameters in specified namespace. in F5 Distributed Cloud.
11
11
 
12
12
  ~> **Note** For more information about this data source, please refer to the [F5 XC API Documentation](https://docs.cloud.f5.com/docs/api/).
13
13
 
package/dist/docs/data-sources/site.md CHANGED
@@ -2,12 +2,12 @@
2
2
  page_title: "f5xc_site Data Source - terraform-provider-f5xc"
3
3
  subcategory: "Uncategorized"
4
4
  description: |-
5
- Manages a Site resource in F5 Distributed Cloud for aws vpc site specification. configuration.
5
+ Manages virtual site object in given namespace. in F5 Distributed Cloud.
6
6
  ---
7
7
 
8
8
  # f5xc_site (Data Source)
9
9
 
10
- Manages a Site resource in F5 Distributed Cloud for aws vpc site specification. configuration.
10
+ Manages virtual site object in given namespace. in F5 Distributed Cloud.
11
11
 
12
12
  ~> **Note** For more information about this data source, please refer to the [F5 XC API Documentation](https://docs.cloud.f5.com/docs/api/).
13
13
 
package/dist/docs/data-sources/workload.md CHANGED
@@ -2,12 +2,12 @@
2
2
  page_title: "f5xc_workload Data Source - terraform-provider-f5xc"
3
3
  subcategory: "Kubernetes"
4
4
  description: |-
5
- Manages workload_flavor. in F5 Distributed Cloud.
5
+ Manages a Workload resource in F5 Distributed Cloud for workload. configuration.
6
6
  ---
7
7
 
8
8
  # f5xc_workload (Data Source)
9
9
 
10
- Manages workload_flavor. in F5 Distributed Cloud.
10
+ Manages a Workload resource in F5 Distributed Cloud for workload. configuration.
11
11
 
12
12
  ~> **Note** For more information about this data source, please refer to the [F5 XC API Documentation](https://docs.cloud.f5.com/docs/api/).
13
13
 
package/dist/docs/resources/discovery.md CHANGED
@@ -2,12 +2,12 @@
2
2
  page_title: "f5xc_discovery Resource - terraform-provider-f5xc"
3
3
  subcategory: "Applications"
4
4
  description: |-
5
- Manages API discovery creates a new object in the storage backend for metadata.namespace. in F5 Distributed Cloud.
5
+ Manages a Discovery resource in F5 Distributed Cloud for api to create discovery object for a site or virtual site in system namespace. configuration.
6
6
  ---
7
7
 
8
8
  # f5xc_discovery (Resource)
9
9
 
10
- Manages API discovery creates a new object in the storage backend for metadata.namespace. in F5 Distributed Cloud.
10
+ Manages a Discovery resource in F5 Distributed Cloud for api to create discovery object for a site or virtual site in system namespace. configuration.
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 API discovery creates a new object in the storage backend for metadata.n
15
15
 
16
16
  ```terraform
17
17
  # Discovery Resource Example
18
- # Manages API discovery creates a new object in the storage backend for metadata.namespace. in F5 Distributed Cloud.
18
+ # Manages a Discovery resource in F5 Distributed Cloud for api to create discovery object for a site or virtual site in system namespace. configuration.
19
19
 
20
20
  # Basic Discovery configuration
21
21
  resource "f5xc_discovery" "example" {
@@ -78,10 +78,19 @@ resource "f5xc_discovery" "example" {
78
78
 
79
79
  ### Spec Argument Reference
80
80
 
81
- <a id="custom-auth-types"></a>&#x2022; [`custom_auth_types`](#custom-auth-types) - Optional Block<br>Select your custom authentication types to be detected in the API discovery<br>See [Custom Auth Types](#custom-auth-types) below for details.
81
+ -> **One of the following:**
82
+ &#x2022; <a id="cluster-id"></a>[`cluster_id`](#cluster-id) - Optional String<br>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
+ &#x2022; <a id="discovery-consul"></a>[`discovery_consul`](#discovery-consul) - Optional Block<br>Discovery configuration for Hashicorp Consul<br>See [Discovery Consul](#discovery-consul) below for details.
86
+ <br><br>&#x2022; <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>&#x2022; [`no_cluster_id`](#no-cluster-id) - Optional Block<br>Enable this option
82
89
 
83
90
  <a id="timeouts"></a>&#x2022; [`timeouts`](#timeouts) - Optional Block<br>See [Timeouts](#timeouts) below for details.
84
91
 
92
+ <a id="where"></a>&#x2022; [`where`](#where) - Optional Block<br>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<br>See [Where](#where) below for details.
93
+
85
94
  ### Attributes Reference
86
95
 
87
96
  In addition to all arguments above, the following attributes are exported:
@@ -90,13 +99,173 @@ In addition to all arguments above, the following attributes are exported:
90
99
 
91
100
  ---
92
101
 
93
- #### Custom Auth Types
102
+ #### Discovery Consul
103
+
104
+ A [`discovery_consul`](#discovery-consul) block supports the following:
105
+
106
+ <a id="discovery-consul-access-info"></a>&#x2022; [`access_info`](#discovery-consul-access-info) - Optional Block<br>Hashicorp Consul API server information<br>See [Access Info](#discovery-consul-access-info) below.
107
+
108
+ <a id="discovery-consul-publish-info"></a>&#x2022; [`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>&#x2022; [`connection_info`](#info-c7c3de) - Optional Block<br>Configuration details to access discovery service REST API<br>See [Connection Info](#info-c7c3de) below.
115
+
116
+ <a id="info-28e890"></a>&#x2022; [`http_basic_auth_info`](#info-28e890) - Optional Block<br>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>&#x2022; [`api_server`](#server-db3eac) - Optional String<br>API server must be a fully qualified domain string and port specified as host:port pair
123
+
124
+ <a id="info-72d38f"></a>&#x2022; [`tls_info`](#info-72d38f) - Optional Block<br>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>&#x2022; [`disable`](#discovery-consul-publish-info-disable) - Optional Block<br>Enable this option
163
+
164
+ <a id="discovery-consul-publish-info-publish"></a>&#x2022; [`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>&#x2022; [`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>&#x2022; [`default_all`](#discovery-k8s-default-all) - Optional Block<br>Enable this option
173
+
174
+ <a id="discovery-k8s-namespace-mapping"></a>&#x2022; [`namespace_mapping`](#discovery-k8s-namespace-mapping) - Optional Block<br>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>&#x2022; [`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>&#x2022; [`connection_info`](#info-731c25) - Optional Block<br>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>&#x2022; [`isolated`](#discovery-k8s-access-info-isolated) - Optional Block<br>Enable this option
185
+
186
+ <a id="url-d50898"></a>&#x2022; [`kubeconfig_url`](#url-d50898) - Optional Block<br>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>&#x2022; [`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>&#x2022; [`api_server`](#server-c32428) - Optional String<br>API server must be a fully qualified domain string and port specified as host:port pair
195
+
196
+ <a id="info-16e7c5"></a>&#x2022; [`tls_info`](#info-16e7c5) - Optional Block<br>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>&#x2022; [`blindfold_secret_info`](#info-fef53c) - Optional Block<br>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>&#x2022; [`clear_secret_info`](#info-ba8969) - Optional Block<br>ClearSecretInfoType specifies information about the Secret that is not encrypted<br>See [Clear Secret Info](#info-ba8969) below.
94
221
 
95
- A [`custom_auth_types`](#custom-auth-types) block supports the following:
222
+ #### Discovery K8S Access Info Kubeconfig URL Blindfold Secret Info
96
223
 
97
- <a id="custom-auth-types-parameter-name"></a>&#x2022; [`parameter_name`](#custom-auth-types-parameter-name) - Optional String<br>The authentication parameter name
224
+ <a id="deep-faaa11"></a>Deeply nested **Info** block collapsed for readability.
98
225
 
99
- <a id="custom-auth-types-parameter-type"></a>&#x2022; [`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] Enumeration for authentication parameter types
226
+ #### Discovery K8S Access Info Kubeconfig URL Clear Secret Info
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>&#x2022; [`items`](#discovery-k8s-namespace-mapping-items) - Optional Block<br>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>&#x2022; [`namespace`](#namespace-b6599c) - Optional String<br>F5XC Application Namespaces. Select a namespace
241
+
242
+ <a id="regex-0aa709"></a>&#x2022; [`namespace_regex`](#regex-0aa709) - Optional String<br>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>&#x2022; [`disable`](#discovery-k8s-publish-info-disable) - Optional Block<br>Enable this option
249
+
250
+ <a id="delegation-53a235"></a>&#x2022; [`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>&#x2022; [`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>&#x2022; [`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>&#x2022; [`dns_mode`](#mode-f08507) - Optional String Defaults to `CORE_DNS`<br>Possible values are `CORE_DNS`, `KUBE_DNS`<br>[Enum: CORE_DNS|KUBE_DNS] 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>&#x2022; [`subdomain`](#subdomain-f4f8f0) - Optional String<br>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>&#x2022; [`namespace`](#namespace-a13be9) - Optional String<br>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
100
269
 
101
270
  #### Timeouts
102
271
 
@@ -110,6 +279,88 @@ A [`timeouts`](#timeouts) block supports the following:
110
279
 
111
280
  <a id="timeouts-update"></a>&#x2022; [`update`](#timeouts-update) - Optional String (Defaults to `10 minutes`)<br>Used when updating the resource
112
281
 
282
+ #### Where
283
+
284
+ A [`where`](#where) block supports the following:
285
+
286
+ <a id="where-site"></a>&#x2022; [`site`](#where-site) - Optional Block<br>Specifies a direct reference to a site configuration object<br>See [Site](#where-site) below.
287
+
288
+ <a id="where-virtual-network"></a>&#x2022; [`virtual_network`](#where-virtual-network) - Optional Block<br>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>&#x2022; [`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>&#x2022; [`disable_internet_vip`](#where-site-disable-internet-vip) - Optional Block<br>Enable this option
297
+
298
+ <a id="where-site-enable-internet-vip"></a>&#x2022; [`enable_internet_vip`](#where-site-enable-internet-vip) - Optional Block<br>Enable this option
299
+
300
+ <a id="where-site-network-type"></a>&#x2022; [`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] 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
301
+
302
+ <a id="where-site-ref"></a>&#x2022; [`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>&#x2022; [`kind`](#where-site-ref-kind) - Optional String<br>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>&#x2022; [`name`](#where-site-ref-name) - Optional String<br>When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object's(e.g. Route's) name
311
+
312
+ <a id="where-site-ref-namespace"></a>&#x2022; [`namespace`](#where-site-ref-namespace) - Optional String<br>When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object's(e.g. Route's) namespace
313
+
314
+ <a id="where-site-ref-tenant"></a>&#x2022; [`tenant`](#where-site-ref-tenant) - Optional String<br>When a configuration object(e.g. Virtual_host) refers to another(e.g route) then tenant will hold the referred object's(e.g. Route's) tenant
315
+
316
+ <a id="where-site-ref-uid"></a>&#x2022; [`uid`](#where-site-ref-uid) - Optional String<br>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>&#x2022; [`ref`](#where-virtual-network-ref) - Optional Block<br>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>&#x2022; [`kind`](#where-virtual-network-ref-kind) - Optional String<br>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>&#x2022; [`name`](#where-virtual-network-ref-name) - Optional String<br>When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object's(e.g. Route's) name
331
+
332
+ <a id="where-virtual-network-ref-namespace"></a>&#x2022; [`namespace`](#where-virtual-network-ref-namespace) - Optional String<br>When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object's(e.g. Route's) namespace
333
+
334
+ <a id="where-virtual-network-ref-tenant"></a>&#x2022; [`tenant`](#where-virtual-network-ref-tenant) - Optional String<br>When a configuration object(e.g. Virtual_host) refers to another(e.g route) then tenant will hold the referred object's(e.g. Route's) tenant
335
+
336
+ <a id="where-virtual-network-ref-uid"></a>&#x2022; [`uid`](#where-virtual-network-ref-uid) - Optional String<br>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>&#x2022; [`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>&#x2022; [`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>&#x2022; [`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] 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
347
+
348
+ <a id="where-virtual-site-ref"></a>&#x2022; [`ref`](#where-virtual-site-ref) - Optional Block<br>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>&#x2022; [`kind`](#where-virtual-site-ref-kind) - Optional String<br>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>&#x2022; [`name`](#where-virtual-site-ref-name) - Optional String<br>When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object's(e.g. Route's) name
357
+
358
+ <a id="where-virtual-site-ref-namespace"></a>&#x2022; [`namespace`](#where-virtual-site-ref-namespace) - Optional String<br>When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object's(e.g. Route's) namespace
359
+
360
+ <a id="where-virtual-site-ref-tenant"></a>&#x2022; [`tenant`](#where-virtual-site-ref-tenant) - Optional String<br>When a configuration object(e.g. Virtual_host) refers to another(e.g route) then tenant will hold the referred object's(e.g. Route's) tenant
361
+
362
+ <a id="where-virtual-site-ref-uid"></a>&#x2022; [`uid`](#where-virtual-site-ref-uid) - Optional String<br>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
+
113
364
  ---
114
365
 
115
366
  ## Common Types