@robinmordasiewicz/f5xc-terraform-mcp 3.12.3 → 3.14.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.
Files changed (53) hide show
  1. package/dist/docs/data-sources/bgp.md +2 -2
  2. package/dist/docs/data-sources/network_policy.md +2 -2
  3. package/dist/docs/data-sources/site.md +2 -2
  4. package/dist/docs/resources/bgp.md +238 -4
  5. package/dist/docs/resources/network_policy.md +210 -37
  6. package/dist/docs/resources/securemesh_site.md +253 -1614
  7. package/dist/docs/resources/site.md +12 -897
  8. package/dist/docs/specifications/api/CHANGELOG.md +4 -4
  9. package/dist/docs/specifications/api/README.md +2 -2
  10. package/dist/docs/specifications/api/domains/admin_console_and_ui.json +38 -38
  11. package/dist/docs/specifications/api/domains/ai_services.json +154 -154
  12. package/dist/docs/specifications/api/domains/api.json +724 -724
  13. package/dist/docs/specifications/api/domains/authentication.json +246 -246
  14. package/dist/docs/specifications/api/domains/bigip.json +353 -353
  15. package/dist/docs/specifications/api/domains/billing_and_usage.json +312 -312
  16. package/dist/docs/specifications/api/domains/blindfold.json +444 -444
  17. package/dist/docs/specifications/api/domains/bot_and_threat_defense.json +256 -256
  18. package/dist/docs/specifications/api/domains/cdn.json +515 -515
  19. package/dist/docs/specifications/api/domains/ce_management.json +255 -255
  20. package/dist/docs/specifications/api/domains/certificates.json +283 -283
  21. package/dist/docs/specifications/api/domains/cloud_infrastructure.json +472 -472
  22. package/dist/docs/specifications/api/domains/container_services.json +260 -260
  23. package/dist/docs/specifications/api/domains/data_and_privacy_security.json +190 -190
  24. package/dist/docs/specifications/api/domains/data_intelligence.json +228 -228
  25. package/dist/docs/specifications/api/domains/ddos.json +857 -857
  26. package/dist/docs/specifications/api/domains/dns.json +707 -707
  27. package/dist/docs/specifications/api/domains/managed_kubernetes.json +345 -345
  28. package/dist/docs/specifications/api/domains/marketplace.json +466 -466
  29. package/dist/docs/specifications/api/domains/network.json +1473 -1473
  30. package/dist/docs/specifications/api/domains/network_security.json +953 -953
  31. package/dist/docs/specifications/api/domains/nginx_one.json +190 -190
  32. package/dist/docs/specifications/api/domains/object_storage.json +100 -100
  33. package/dist/docs/specifications/api/domains/observability.json +739 -739
  34. package/dist/docs/specifications/api/domains/rate_limiting.json +208 -208
  35. package/dist/docs/specifications/api/domains/secops_and_incident_response.json +88 -88
  36. package/dist/docs/specifications/api/domains/service_mesh.json +589 -589
  37. package/dist/docs/specifications/api/domains/shape.json +4451 -4451
  38. package/dist/docs/specifications/api/domains/sites.json +1870 -1870
  39. package/dist/docs/specifications/api/domains/statistics.json +1165 -1165
  40. package/dist/docs/specifications/api/domains/support.json +723 -723
  41. package/dist/docs/specifications/api/domains/telemetry_and_insights.json +376 -376
  42. package/dist/docs/specifications/api/domains/tenant_and_identity.json +2445 -2445
  43. package/dist/docs/specifications/api/domains/threat_campaign.json +75 -75
  44. package/dist/docs/specifications/api/domains/users.json +202 -202
  45. package/dist/docs/specifications/api/domains/virtual.json +1269 -1269
  46. package/dist/docs/specifications/api/domains/vpm_and_node_management.json +7 -7
  47. package/dist/docs/specifications/api/domains/waf.json +663 -663
  48. package/dist/docs/specifications/api/index.json +17 -17
  49. package/dist/docs/specifications/api/openapi.json +23266 -23266
  50. package/dist/docs/specifications/api/openapi.yaml +17296 -17296
  51. package/dist/metadata/resource-metadata.json +137 -769
  52. package/manifest.json +1 -1
  53. package/package.json +1 -1
@@ -2,12 +2,12 @@
2
2
  page_title: "f5xc_bgp Data Source - terraform-provider-f5xc"
3
3
  subcategory: "Networking"
4
4
  description: |-
5
- Manages bgp_asn_set creates a new object in the storage backend for metadata.namespace. in F5 Distributed Cloud.
5
+ Manages a BGP resource in F5 Distributed Cloud for bgp object is the configuration for peering with external bgp servers. it is created by users in system namespace. configuration.
6
6
  ---
7
7
 
8
8
  # f5xc_bgp (Data Source)
9
9
 
10
- Manages bgp_asn_set creates a new object in the storage backend for metadata.namespace. in F5 Distributed Cloud.
10
+ Manages a BGP resource in F5 Distributed Cloud for bgp object is the configuration for peering with external bgp servers. it is created by users 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
 
@@ -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 a Network Policy resource in F5 Distributed Cloud for network policy view specification. configuration.
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 a Network Policy resource in F5 Distributed Cloud for network policy view specification. 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
 
@@ -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
 
@@ -2,12 +2,12 @@
2
2
  page_title: "f5xc_bgp Resource - terraform-provider-f5xc"
3
3
  subcategory: "Networking"
4
4
  description: |-
5
- Manages bgp_asn_set creates a new object in the storage backend for metadata.namespace. in F5 Distributed Cloud.
5
+ Manages a BGP resource in F5 Distributed Cloud for bgp object is the configuration for peering with external bgp servers. it is created by users in system namespace. configuration.
6
6
  ---
7
7
 
8
8
  # f5xc_bgp (Resource)
9
9
 
10
- Manages bgp_asn_set creates a new object in the storage backend for metadata.namespace. in F5 Distributed Cloud.
10
+ Manages a BGP resource in F5 Distributed Cloud for bgp object is the configuration for peering with external bgp servers. it is created by users 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 bgp_asn_set creates a new object in the storage backend for metadata.nam
15
15
 
16
16
  ```terraform
17
17
  # BGP Resource Example
18
- # Manages bgp_asn_set creates a new object in the storage backend for metadata.namespace. in F5 Distributed Cloud.
18
+ # Manages a BGP resource in F5 Distributed Cloud for bgp object is the configuration for peering with external bgp servers. it is created by users in system namespace. configuration.
19
19
 
20
20
  # Basic BGP configuration
21
21
  resource "f5xc_bgp" "example" {
@@ -73,10 +73,14 @@ resource "f5xc_bgp" "example" {
73
73
 
74
74
  ### Spec Argument Reference
75
75
 
76
- <a id="as-numbers"></a>&#x2022; [`as_numbers`](#as-numbers) - Optional List<br>Unordered set of RFC 6793 defined 4-byte AS numbers that can be used to create whitelists or blacklists for use in network policy or service policy
76
+ <a id="bgp-parameters"></a>&#x2022; [`bgp_parameters`](#bgp-parameters) - Optional Block<br>BGP Parameters. BGP parameters for the local site<br>See [BGP Parameters](#bgp-parameters) below for details.
77
+
78
+ <a id="peers"></a>&#x2022; [`peers`](#peers) - Optional Block<br>Peers. List of peers<br>See [Peers](#peers) below for details.
77
79
 
78
80
  <a id="timeouts"></a>&#x2022; [`timeouts`](#timeouts) - Optional Block<br>See [Timeouts](#timeouts) below for details.
79
81
 
82
+ <a id="where"></a>&#x2022; [`where`](#where) - Optional Block<br>VirtualSiteSiteRefSelector defines a union of reference to site or reference to virtual_site It used to refer site or a group of sites indicated by virtual site<br>See [Where](#where) below for details.
83
+
80
84
  ### Attributes Reference
81
85
 
82
86
  In addition to all arguments above, the following attributes are exported:
@@ -85,6 +89,176 @@ In addition to all arguments above, the following attributes are exported:
85
89
 
86
90
  ---
87
91
 
92
+ #### BGP Parameters
93
+
94
+ A [`bgp_parameters`](#bgp-parameters) block supports the following:
95
+
96
+ <a id="bgp-parameters-asn"></a>&#x2022; [`asn`](#bgp-parameters-asn) - Optional Number<br>ASN. Autonomous System Number
97
+
98
+ <a id="bgp-parameters-from-site"></a>&#x2022; [`from_site`](#bgp-parameters-from-site) - Optional Block<br>Enable this option
99
+
100
+ <a id="bgp-parameters-ip-address"></a>&#x2022; [`ip_address`](#bgp-parameters-ip-address) - Optional String<br>Use the configured IPv4 Address as Router ID
101
+
102
+ <a id="bgp-parameters-local-address"></a>&#x2022; [`local_address`](#bgp-parameters-local-address) - Optional Block<br>Enable this option
103
+
104
+ #### Peers
105
+
106
+ A [`peers`](#peers) block supports the following:
107
+
108
+ <a id="peers-bfd-disabled"></a>&#x2022; [`bfd_disabled`](#peers-bfd-disabled) - Optional Block<br>Enable this option
109
+
110
+ <a id="peers-bfd-enabled"></a>&#x2022; [`bfd_enabled`](#peers-bfd-enabled) - Optional Block<br>BFD. BFD parameters<br>See [Bfd Enabled](#peers-bfd-enabled) below.
111
+
112
+ <a id="peers-disable"></a>&#x2022; [`disable`](#peers-disable) - Optional Block<br>Enable this option
113
+
114
+ <a id="peers-external"></a>&#x2022; [`external`](#peers-external) - Optional Block<br>External BGP Peer. External BGP Peer parameters<br>See [External](#peers-external) below.
115
+
116
+ <a id="peers-label"></a>&#x2022; [`label`](#peers-label) - Optional String<br>Label. Specify whether this peer should be
117
+
118
+ <a id="peers-metadata"></a>&#x2022; [`metadata`](#peers-metadata) - Optional Block<br>MessageMetaType is metadata (common attributes) of a message that only certain messages have. This information is propagated to the metadata of a child object that gets created from the containing message during view processing. The information in this type can be specified by user during create<br>See [Metadata](#peers-metadata) below.
119
+
120
+ <a id="peers-passive-mode-disabled"></a>&#x2022; [`passive_mode_disabled`](#peers-passive-mode-disabled) - Optional Block<br>Enable this option
121
+
122
+ <a id="peers-passive-mode-enabled"></a>&#x2022; [`passive_mode_enabled`](#peers-passive-mode-enabled) - Optional Block<br>Enable this option
123
+
124
+ <a id="peers-routing-policies"></a>&#x2022; [`routing_policies`](#peers-routing-policies) - Optional Block<br>List of rules which can be applied on all or particular nodes<br>See [Routing Policies](#peers-routing-policies) below.
125
+
126
+ #### Peers Bfd Enabled
127
+
128
+ A [`bfd_enabled`](#peers-bfd-enabled) block (within [`peers`](#peers)) supports the following:
129
+
130
+ <a id="peers-bfd-enabled-multiplier"></a>&#x2022; [`multiplier`](#peers-bfd-enabled-multiplier) - Optional Number<br>Specify Number of missed packets to bring session down'
131
+
132
+ <a id="milliseconds-dab8b3"></a>&#x2022; [`receive_interval_milliseconds`](#milliseconds-dab8b3) - Optional Number<br>BFD receive interval timer, in milliseconds
133
+
134
+ <a id="milliseconds-135c29"></a>&#x2022; [`transmit_interval_milliseconds`](#milliseconds-135c29) - Optional Number<br>BFD transmit interval timer, in milliseconds
135
+
136
+ #### Peers External
137
+
138
+ An [`external`](#peers-external) block (within [`peers`](#peers)) supports the following:
139
+
140
+ <a id="peers-external-address"></a>&#x2022; [`address`](#peers-external-address) - Optional String<br>Specify IPv4 peer address
141
+
142
+ <a id="peers-external-address-ipv6"></a>&#x2022; [`address_ipv6`](#peers-external-address-ipv6) - Optional String<br>Specify peer IPv6 address
143
+
144
+ <a id="peers-external-asn"></a>&#x2022; [`asn`](#peers-external-asn) - Optional Number<br>Autonomous System Number for BGP peer
145
+
146
+ <a id="peers-external-default-gateway"></a>&#x2022; [`default_gateway`](#peers-external-default-gateway) - Optional Block<br>Enable this option
147
+
148
+ <a id="peers-external-default-gateway-v6"></a>&#x2022; [`default_gateway_v6`](#peers-external-default-gateway-v6) - Optional Block<br>Enable this option
149
+
150
+ <a id="peers-external-disable"></a>&#x2022; [`disable`](#peers-external-disable) - Optional Block<br>Enable this option
151
+
152
+ <a id="peers-external-disable-v6"></a>&#x2022; [`disable_v6`](#peers-external-disable-v6) - Optional Block<br>Enable this option
153
+
154
+ <a id="peers-external-external-connector"></a>&#x2022; [`external_connector`](#peers-external-external-connector) - Optional Block<br>Enable this option
155
+
156
+ <a id="peers-external-family-inet"></a>&#x2022; [`family_inet`](#peers-external-family-inet) - Optional Block<br>BGP Family Inet. Parameters for inet family<br>See [Family Inet](#peers-external-family-inet) below.
157
+
158
+ <a id="peers-external-from-site"></a>&#x2022; [`from_site`](#peers-external-from-site) - Optional Block<br>Enable this option
159
+
160
+ <a id="peers-external-from-site-v6"></a>&#x2022; [`from_site_v6`](#peers-external-from-site-v6) - Optional Block<br>Enable this option
161
+
162
+ <a id="peers-external-interface"></a>&#x2022; [`interface`](#peers-external-interface) - Optional Block<br>Type establishes a direct reference from one object(the referrer) to another(the referred). Such a reference is in form of tenant/namespace/name<br>See [Interface](#peers-external-interface) below.
163
+
164
+ <a id="peers-external-interface-list"></a>&#x2022; [`interface_list`](#peers-external-interface-list) - Optional Block<br>Interface List. List of network interfaces<br>See [Interface List](#peers-external-interface-list) below.
165
+
166
+ <a id="peers-external-md5-auth-key"></a>&#x2022; [`md5_auth_key`](#peers-external-md5-auth-key) - Optional String<br>MD5 key for protecting BGP Sessions (RFC 2385)
167
+
168
+ <a id="peers-external-no-authentication"></a>&#x2022; [`no_authentication`](#peers-external-no-authentication) - Optional Block<br>Enable this option
169
+
170
+ <a id="peers-external-port"></a>&#x2022; [`port`](#peers-external-port) - Optional Number<br>Peer Port. Peer TCP port number
171
+
172
+ <a id="peers-external-subnet-begin-offset"></a>&#x2022; [`subnet_begin_offset`](#peers-external-subnet-begin-offset) - Optional Number<br>Calculate peer address using offset from the beginning of the subnet
173
+
174
+ <a id="peers-external-subnet-begin-offset-v6"></a>&#x2022; [`subnet_begin_offset_v6`](#peers-external-subnet-begin-offset-v6) - Optional Number<br>Calculate peer address using offset from the beginning of the subnet
175
+
176
+ <a id="peers-external-subnet-end-offset"></a>&#x2022; [`subnet_end_offset`](#peers-external-subnet-end-offset) - Optional Number<br>Calculate peer address using offset from the end of the subnet
177
+
178
+ <a id="peers-external-subnet-end-offset-v6"></a>&#x2022; [`subnet_end_offset_v6`](#peers-external-subnet-end-offset-v6) - Optional Number<br>Calculate peer address using offset from the end of the subnet
179
+
180
+ #### Peers External Family Inet
181
+
182
+ A [`family_inet`](#peers-external-family-inet) block (within [`peers.external`](#peers-external)) supports the following:
183
+
184
+ <a id="peers-external-family-inet-disable"></a>&#x2022; [`disable`](#peers-external-family-inet-disable) - Optional Block<br>Enable this option
185
+
186
+ <a id="peers-external-family-inet-enable"></a>&#x2022; [`enable`](#peers-external-family-inet-enable) - Optional Block<br>Enable this option
187
+
188
+ #### Peers External Interface
189
+
190
+ An [`interface`](#peers-external-interface) block (within [`peers.external`](#peers-external)) supports the following:
191
+
192
+ <a id="peers-external-interface-name"></a>&#x2022; [`name`](#peers-external-interface-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
193
+
194
+ <a id="peers-external-interface-namespace"></a>&#x2022; [`namespace`](#peers-external-interface-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
195
+
196
+ <a id="peers-external-interface-tenant"></a>&#x2022; [`tenant`](#peers-external-interface-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
197
+
198
+ #### Peers External Interface List
199
+
200
+ An [`interface_list`](#peers-external-interface-list) block (within [`peers.external`](#peers-external)) supports the following:
201
+
202
+ <a id="interfaces-2564cf"></a>&#x2022; [`interfaces`](#interfaces-2564cf) - Optional Block<br>List of network interfaces<br>See [Interfaces](#interfaces-2564cf) below.
203
+
204
+ #### Peers External Interface List Interfaces
205
+
206
+ An [`interfaces`](#interfaces-2564cf) block (within [`peers.external.interface_list`](#peers-external-interface-list)) supports the following:
207
+
208
+ <a id="name-25eca0"></a>&#x2022; [`name`](#name-25eca0) - 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
209
+
210
+ <a id="namespace-7cb7a8"></a>&#x2022; [`namespace`](#namespace-7cb7a8) - 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
211
+
212
+ <a id="tenant-5d2baa"></a>&#x2022; [`tenant`](#tenant-5d2baa) - 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
213
+
214
+ #### Peers Metadata
215
+
216
+ A [`metadata`](#peers-metadata) block (within [`peers`](#peers)) supports the following:
217
+
218
+ <a id="peers-metadata-description-spec"></a>&#x2022; [`description_spec`](#peers-metadata-description-spec) - Optional String<br>Description. Human readable description
219
+
220
+ <a id="peers-metadata-name"></a>&#x2022; [`name`](#peers-metadata-name) - Optional String<br>Name of the message. The value of name has to follow DNS-1035 format
221
+
222
+ #### Peers Routing Policies
223
+
224
+ A [`routing_policies`](#peers-routing-policies) block (within [`peers`](#peers)) supports the following:
225
+
226
+ <a id="peers-routing-policies-route-policy"></a>&#x2022; [`route_policy`](#peers-routing-policies-route-policy) - Optional Block<br>Policy configuration for this feature<br>See [Route Policy](#peers-routing-policies-route-policy) below.
227
+
228
+ #### Peers Routing Policies Route Policy
229
+
230
+ A [`route_policy`](#peers-routing-policies-route-policy) block (within [`peers.routing_policies`](#peers-routing-policies)) supports the following:
231
+
232
+ <a id="nodes-761998"></a>&#x2022; [`all_nodes`](#nodes-761998) - Optional Block<br>Enable this option
233
+
234
+ <a id="inbound-bbe39d"></a>&#x2022; [`inbound`](#inbound-bbe39d) - Optional Block<br>Enable this option
235
+
236
+ <a id="name-e2301f"></a>&#x2022; [`node_name`](#name-e2301f) - Optional Block<br>List of nodes on which BGP routing policy has to be applied<br>See [Node Name](#name-e2301f) below.
237
+
238
+ <a id="refs-6e5457"></a>&#x2022; [`object_refs`](#refs-6e5457) - Optional Block<br>Select route policy to apply<br>See [Object Refs](#refs-6e5457) below.
239
+
240
+ <a id="outbound-195eea"></a>&#x2022; [`outbound`](#outbound-195eea) - Optional Block<br>Enable this option
241
+
242
+ #### Peers Routing Policies Route Policy Node Name
243
+
244
+ A [`node_name`](#name-e2301f) block (within [`peers.routing_policies.route_policy`](#peers-routing-policies-route-policy)) supports the following:
245
+
246
+ <a id="node-a4a8b2"></a>&#x2022; [`node`](#node-a4a8b2) - Optional List<br>Select BGP Session on which policy will be applied
247
+
248
+ #### Peers Routing Policies Route Policy Object Refs
249
+
250
+ An [`object_refs`](#refs-6e5457) block (within [`peers.routing_policies.route_policy`](#peers-routing-policies-route-policy)) supports the following:
251
+
252
+ <a id="kind-8c3ca2"></a>&#x2022; [`kind`](#kind-8c3ca2) - 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')
253
+
254
+ <a id="name-7f5085"></a>&#x2022; [`name`](#name-7f5085) - 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
255
+
256
+ <a id="namespace-7ab467"></a>&#x2022; [`namespace`](#namespace-7ab467) - 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
257
+
258
+ <a id="tenant-685165"></a>&#x2022; [`tenant`](#tenant-685165) - 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
259
+
260
+ <a id="uid-965d22"></a>&#x2022; [`uid`](#uid-965d22) - 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
261
+
88
262
  #### Timeouts
89
263
 
90
264
  A [`timeouts`](#timeouts) block supports the following:
@@ -97,6 +271,66 @@ A [`timeouts`](#timeouts) block supports the following:
97
271
 
98
272
  <a id="timeouts-update"></a>&#x2022; [`update`](#timeouts-update) - Optional String (Defaults to `10 minutes`)<br>Used when updating the resource
99
273
 
274
+ #### Where
275
+
276
+ A [`where`](#where) block supports the following:
277
+
278
+ <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.
279
+
280
+ <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.
281
+
282
+ #### Where Site
283
+
284
+ A [`site`](#where-site) block (within [`where`](#where)) supports the following:
285
+
286
+ <a id="where-site-disable-internet-vip"></a>&#x2022; [`disable_internet_vip`](#where-site-disable-internet-vip) - Optional Block<br>Enable this option
287
+
288
+ <a id="where-site-enable-internet-vip"></a>&#x2022; [`enable_internet_vip`](#where-site-enable-internet-vip) - Optional Block<br>Enable this option
289
+
290
+ <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
291
+
292
+ <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.
293
+
294
+ #### Where Site Ref
295
+
296
+ A [`ref`](#where-site-ref) block (within [`where.site`](#where-site)) supports the following:
297
+
298
+ <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')
299
+
300
+ <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
301
+
302
+ <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
303
+
304
+ <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
305
+
306
+ <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
307
+
308
+ #### Where Virtual Site
309
+
310
+ A [`virtual_site`](#where-virtual-site) block (within [`where`](#where)) supports the following:
311
+
312
+ <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
313
+
314
+ <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
315
+
316
+ <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
317
+
318
+ <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.
319
+
320
+ #### Where Virtual Site Ref
321
+
322
+ A [`ref`](#where-virtual-site-ref) block (within [`where.virtual_site`](#where-virtual-site)) supports the following:
323
+
324
+ <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')
325
+
326
+ <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
327
+
328
+ <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
329
+
330
+ <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
331
+
332
+ <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
333
+
100
334
  ---
101
335
 
102
336
  ## Common Types