@robinmordasiewicz/f5xc-terraform-mcp 3.3.0 → 3.5.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 (86) hide show
  1. package/README.md +1 -1
  2. package/dist/docs/data-sources/bgp.md +2 -2
  3. package/dist/docs/data-sources/certificate.md +2 -2
  4. package/dist/docs/data-sources/log_receiver.md +2 -2
  5. package/dist/docs/data-sources/network_policy.md +2 -2
  6. package/dist/docs/data-sources/site.md +2 -2
  7. package/dist/docs/data-sources/workload.md +2 -2
  8. package/dist/docs/index.md +276 -0
  9. package/dist/docs/resources/bgp.md +238 -4
  10. package/dist/docs/resources/certificate.md +4 -56
  11. package/dist/docs/resources/cloud_connect.md +2 -2
  12. package/dist/docs/resources/log_receiver.md +44 -825
  13. package/dist/docs/resources/network_policy.md +217 -38
  14. package/dist/docs/resources/site.md +527 -233
  15. package/dist/docs/resources/workload.md +2951 -9
  16. package/dist/docs/specifications/api/CHANGELOG.md +4 -4
  17. package/dist/docs/specifications/api/README.md +1 -1
  18. package/dist/docs/specifications/api/domains/admin_console_and_ui.json +25 -25
  19. package/dist/docs/specifications/api/domains/ai_services.json +21 -21
  20. package/dist/docs/specifications/api/domains/api.json +173 -173
  21. package/dist/docs/specifications/api/domains/authentication.json +45 -45
  22. package/dist/docs/specifications/api/domains/bigip.json +94 -94
  23. package/dist/docs/specifications/api/domains/billing_and_usage.json +63 -63
  24. package/dist/docs/specifications/api/domains/blindfold.json +109 -109
  25. package/dist/docs/specifications/api/domains/bot_and_threat_defense.json +65 -65
  26. package/dist/docs/specifications/api/domains/cdn.json +177 -177
  27. package/dist/docs/specifications/api/domains/ce_management.json +76 -76
  28. package/dist/docs/specifications/api/domains/certificates.json +75 -75
  29. package/dist/docs/specifications/api/domains/cloud_infrastructure.json +112 -112
  30. package/dist/docs/specifications/api/domains/container_services.json +91 -91
  31. package/dist/docs/specifications/api/domains/data_and_privacy_security.json +66 -66
  32. package/dist/docs/specifications/api/domains/data_intelligence.json +62 -62
  33. package/dist/docs/specifications/api/domains/ddos.json +154 -154
  34. package/dist/docs/specifications/api/domains/dns.json +148 -148
  35. package/dist/docs/specifications/api/domains/managed_kubernetes.json +85 -85
  36. package/dist/docs/specifications/api/domains/marketplace.json +103 -103
  37. package/dist/docs/specifications/api/domains/network.json +230 -230
  38. package/dist/docs/specifications/api/domains/network_security.json +187 -187
  39. package/dist/docs/specifications/api/domains/nginx_one.json +62 -62
  40. package/dist/docs/specifications/api/domains/object_storage.json +12 -12
  41. package/dist/docs/specifications/api/domains/observability.json +102 -102
  42. package/dist/docs/specifications/api/domains/rate_limiting.json +52 -52
  43. package/dist/docs/specifications/api/domains/secops_and_incident_response.json +36 -36
  44. package/dist/docs/specifications/api/domains/service_mesh.json +119 -119
  45. package/dist/docs/specifications/api/domains/shape.json +313 -313
  46. package/dist/docs/specifications/api/domains/sites.json +349 -349
  47. package/dist/docs/specifications/api/domains/statistics.json +225 -225
  48. package/dist/docs/specifications/api/domains/support.json +108 -108
  49. package/dist/docs/specifications/api/domains/telemetry_and_insights.json +72 -72
  50. package/dist/docs/specifications/api/domains/tenant_and_identity.json +268 -268
  51. package/dist/docs/specifications/api/domains/threat_campaign.json +66 -66
  52. package/dist/docs/specifications/api/domains/users.json +66 -66
  53. package/dist/docs/specifications/api/domains/virtual.json +244 -244
  54. package/dist/docs/specifications/api/domains/vpm_and_node_management.json +1 -1
  55. package/dist/docs/specifications/api/domains/waf.json +139 -139
  56. package/dist/docs/specifications/api/index.json +12 -12
  57. package/dist/docs/specifications/api/openapi.json +2600 -2600
  58. package/dist/docs/specifications/api/openapi.yaml +2600 -2600
  59. package/dist/index.d.ts +2 -1
  60. package/dist/index.d.ts.map +1 -1
  61. package/dist/index.js +75 -4
  62. package/dist/index.js.map +1 -1
  63. package/dist/metadata/error-patterns.json +192 -0
  64. package/dist/metadata/resource-metadata.json +13095 -0
  65. package/dist/metadata/validation-patterns.json +69 -0
  66. package/dist/schemas/common.d.ts +33 -0
  67. package/dist/schemas/common.d.ts.map +1 -1
  68. package/dist/schemas/common.js +32 -0
  69. package/dist/schemas/common.js.map +1 -1
  70. package/dist/services/documentation.d.ts.map +1 -1
  71. package/dist/services/documentation.js +9 -0
  72. package/dist/services/documentation.js.map +1 -1
  73. package/dist/services/metadata.d.ts +193 -0
  74. package/dist/services/metadata.d.ts.map +1 -0
  75. package/dist/services/metadata.js +367 -0
  76. package/dist/services/metadata.js.map +1 -0
  77. package/dist/tools/discover.d.ts.map +1 -1
  78. package/dist/tools/discover.js +8 -0
  79. package/dist/tools/discover.js.map +1 -1
  80. package/dist/tools/metadata.d.ts +19 -0
  81. package/dist/tools/metadata.d.ts.map +1 -0
  82. package/dist/tools/metadata.js +612 -0
  83. package/dist/tools/metadata.js.map +1 -0
  84. package/dist/types.d.ts +1 -1
  85. package/dist/types.d.ts.map +1 -1
  86. package/package.json +1 -1
@@ -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>AS Numbers. An 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>Site or Virtual Site Reference. 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>IP Address. 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>Message Metadata. 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 and replace APIs<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>BGP Routing Policy. 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>Multiplier. 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>Minimum Receive Interval. BFD receive interval timer, in milliseconds
133
+
134
+ <a id="milliseconds-135c29"></a>&#x2022; [`transmit_interval_milliseconds`](#milliseconds-135c29) - Optional Number<br>Transmit Interval. 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>Peer Address. Specify IPv4 peer address
141
+
142
+ <a id="peers-external-address-ipv6"></a>&#x2022; [`address_ipv6`](#peers-external-address-ipv6) - Optional String<br>Peer IPv6 Address. Specify peer IPv6 address
143
+
144
+ <a id="peers-external-asn"></a>&#x2022; [`asn`](#peers-external-asn) - Optional Number<br>ASN. 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>Object reference. This type establishes a direct reference from one object(the referrer) to another(the referred). Such a reference is in form of tenant/namespace/name<br>See [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 Authentication Key. 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>Offset From Beginning Of Subnet. 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>Offset From Beginning Of Subnet. 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>Offset From End Of Subnet. 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>Offset From End Of Subnet. 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>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
193
+
194
+ <a id="peers-external-interface-namespace"></a>&#x2022; [`namespace`](#peers-external-interface-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
195
+
196
+ <a id="peers-external-interface-tenant"></a>&#x2022; [`tenant`](#peers-external-interface-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
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>Interface List. 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>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
209
+
210
+ <a id="namespace-7cb7a8"></a>&#x2022; [`namespace`](#namespace-7cb7a8) - 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
211
+
212
+ <a id="tenant-5d2baa"></a>&#x2022; [`tenant`](#tenant-5d2baa) - 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
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. This is the 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>BGP Routing policy. Route policy to be applied<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>Nodes. 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>BGP routing policy. 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>Node of choice. 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>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')
253
+
254
+ <a id="name-7f5085"></a>&#x2022; [`name`](#name-7f5085) - 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
255
+
256
+ <a id="namespace-7ab467"></a>&#x2022; [`namespace`](#namespace-7ab467) - 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
257
+
258
+ <a id="tenant-685165"></a>&#x2022; [`tenant`](#tenant-685165) - 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
259
+
260
+ <a id="uid-965d22"></a>&#x2022; [`uid`](#uid-965d22) - 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
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>Site Reference. This 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] 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
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>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')
299
+
300
+ <a id="where-site-ref-name"></a>&#x2022; [`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
301
+
302
+ <a id="where-site-ref-namespace"></a>&#x2022; [`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
303
+
304
+ <a id="where-site-ref-tenant"></a>&#x2022; [`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
305
+
306
+ <a id="where-site-ref-uid"></a>&#x2022; [`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
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] 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
317
+
318
+ <a id="where-virtual-site-ref"></a>&#x2022; [`ref`](#where-virtual-site-ref) - Optional Block<br>Reference. A 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>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')
325
+
326
+ <a id="where-virtual-site-ref-name"></a>&#x2022; [`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
327
+
328
+ <a id="where-virtual-site-ref-namespace"></a>&#x2022; [`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
329
+
330
+ <a id="where-virtual-site-ref-tenant"></a>&#x2022; [`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
331
+
332
+ <a id="where-virtual-site-ref-uid"></a>&#x2022; [`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
333
+
100
334
  ---
101
335
 
102
336
  ## Common Types
@@ -2,12 +2,12 @@
2
2
  page_title: "f5xc_certificate Resource - terraform-provider-f5xc"
3
3
  subcategory: "Certificates"
4
4
  description: |-
5
- Manages a Certificate resource in F5 Distributed Cloud for certificate. configuration.
5
+ Manages a Certificate resource in F5 Distributed Cloud for TLS/SSL certificate management.
6
6
  ---
7
7
 
8
8
  # f5xc_certificate (Resource)
9
9
 
10
- Manages a Certificate resource in F5 Distributed Cloud for certificate. configuration.
10
+ Manages a Certificate resource in F5 Distributed Cloud for TLS/SSL certificate management.
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 Certificate resource in F5 Distributed Cloud for certificate. configur
15
15
 
16
16
  ```terraform
17
17
  # Certificate Resource Example
18
- # Manages a Certificate resource in F5 Distributed Cloud for certificate. configuration.
18
+ # Manages a Certificate resource in F5 Distributed Cloud for TLS/SSL certificate management.
19
19
 
20
20
  # Basic Certificate configuration
21
21
  resource "f5xc_certificate" "example" {
@@ -60,20 +60,10 @@ resource "f5xc_certificate" "example" {
60
60
 
61
61
  ### Spec Argument Reference
62
62
 
63
- <a id="certificate-chain"></a>&#x2022; [`certificate_chain`](#certificate-chain) - Optional Block<br>Object reference. This type establishes a direct reference from one object(the referrer) to another(the referred). Such a reference is in form of tenant/namespace/name<br>See [Certificate Chain](#certificate-chain) below for details.
64
-
65
- <a id="certificate-url"></a>&#x2022; [`certificate_url`](#certificate-url) - Optional String<br>Certificate. Certificate. Certificate or certificate chain in PEM format including the PEM headers
66
-
67
- -> **One of the following:**
68
- &#x2022; <a id="custom-hash-algorithms"></a>[`custom_hash_algorithms`](#custom-hash-algorithms) - Optional Block<br>Hash Algorithms. Specifies the hash algorithms to be used<br>See [Custom Hash Algorithms](#custom-hash-algorithms) below for details.
69
- <br><br>&#x2022; <a id="disable-ocsp-stapling"></a>[`disable_ocsp_stapling`](#disable-ocsp-stapling) - Optional Block<br>Enable this option
70
-
71
- <a id="private-key"></a>&#x2022; [`private_key`](#private-key) - Optional Block<br>Secret. SecretType is used in an object to indicate a sensitive/confidential field<br>See [Private Key](#private-key) below for details.
63
+ <a id="certificate-url"></a>&#x2022; [`certificate_url`](#certificate-url) - Optional String<br>Certificates. Certificate chain is the list of intermediate certificates in PEM format including the PEM headers
72
64
 
73
65
  <a id="timeouts"></a>&#x2022; [`timeouts`](#timeouts) - Optional Block<br>See [Timeouts](#timeouts) below for details.
74
66
 
75
- <a id="use-system-defaults"></a>&#x2022; [`use_system_defaults`](#use-system-defaults) - Optional Block<br>Enable this option
76
-
77
67
  ### Attributes Reference
78
68
 
79
69
  In addition to all arguments above, the following attributes are exported:
@@ -82,48 +72,6 @@ In addition to all arguments above, the following attributes are exported:
82
72
 
83
73
  ---
84
74
 
85
- #### Certificate Chain
86
-
87
- A [`certificate_chain`](#certificate-chain) block supports the following:
88
-
89
- <a id="certificate-chain-name"></a>&#x2022; [`name`](#certificate-chain-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
90
-
91
- <a id="certificate-chain-namespace"></a>&#x2022; [`namespace`](#certificate-chain-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
92
-
93
- <a id="certificate-chain-tenant"></a>&#x2022; [`tenant`](#certificate-chain-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
94
-
95
- #### Custom Hash Algorithms
96
-
97
- A [`custom_hash_algorithms`](#custom-hash-algorithms) block supports the following:
98
-
99
- <a id="custom-hash-algorithms-hash-algorithms"></a>&#x2022; [`hash_algorithms`](#custom-hash-algorithms-hash-algorithms) - Optional List Defaults to `INVALID_HASH_ALGORITHM`<br>Possible values are `INVALID_HASH_ALGORITHM`, `SHA256`, `SHA1`<br>[Enum: INVALID_HASH_ALGORITHM|SHA256|SHA1] Hash Algorithms. Ordered list of hash algorithms to be used
100
-
101
- #### Private Key
102
-
103
- A [`private_key`](#private-key) block supports the following:
104
-
105
- <a id="private-key-blindfold-secret-info"></a>&#x2022; [`blindfold_secret_info`](#private-key-blindfold-secret-info) - Optional Block<br>Blindfold Secret. BlindfoldSecretInfoType specifies information about the Secret managed by F5XC Secret Management<br>See [Blindfold Secret Info](#private-key-blindfold-secret-info) below.
106
-
107
- <a id="private-key-clear-secret-info"></a>&#x2022; [`clear_secret_info`](#private-key-clear-secret-info) - Optional Block<br>In-Clear Secret. ClearSecretInfoType specifies information about the Secret that is not encrypted<br>See [Clear Secret Info](#private-key-clear-secret-info) below.
108
-
109
- #### Private Key Blindfold Secret Info
110
-
111
- A [`blindfold_secret_info`](#private-key-blindfold-secret-info) block (within [`private_key`](#private-key)) supports the following:
112
-
113
- <a id="provider-2cb137"></a>&#x2022; [`decryption_provider`](#provider-2cb137) - Optional String<br>Decryption Provider. Name of the Secret Management Access object that contains information about the backend Secret Management service
114
-
115
- <a id="location-208dea"></a>&#x2022; [`location`](#location-208dea) - Optional String<br>Location. Location is the uri_ref. It could be in URL format for string:/// Or it could be a path if the store provider is an HTTP/HTTPS location
116
-
117
- <a id="provider-1e06e0"></a>&#x2022; [`store_provider`](#provider-1e06e0) - Optional String<br>Store Provider. Name of the Secret Management Access object that contains information about the store to GET encrypted bytes This field needs to be provided only if the URL scheme is not string:///
118
-
119
- #### Private Key Clear Secret Info
120
-
121
- A [`clear_secret_info`](#private-key-clear-secret-info) block (within [`private_key`](#private-key)) supports the following:
122
-
123
- <a id="ref-e799a7"></a>&#x2022; [`provider_ref`](#ref-e799a7) - Optional String<br>Provider. Name of the Secret Management Access object that contains information about the store to GET encrypted bytes This field needs to be provided only if the URL scheme is not string:///
124
-
125
- <a id="private-key-clear-secret-info-url"></a>&#x2022; [`url`](#private-key-clear-secret-info-url) - Optional String<br>URL. URL of the secret. Currently supported URL schemes is string:///. For string:/// scheme, Secret needs to be encoded Base64 format. When asked for this secret, caller will GET Secret bytes after Base64 decoding
126
-
127
75
  #### Timeouts
128
76
 
129
77
  A [`timeouts`](#timeouts) block supports the following:
@@ -54,6 +54,8 @@ resource "f5xc_cloud_connect" "example" {
54
54
 
55
55
  <a id="name"></a>&#x2022; [`name`](#name) - Required String<br>Name of the Cloud Connect. Must be unique within the namespace
56
56
 
57
+ <a id="namespace"></a>&#x2022; [`namespace`](#namespace) - Required String<br>Namespace where the Cloud Connect will be created
58
+
57
59
  <a id="annotations"></a>&#x2022; [`annotations`](#annotations) - Optional Map<br>Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata
58
60
 
59
61
  <a id="description"></a>&#x2022; [`description`](#description) - Optional String<br>Human readable description for the object
@@ -62,8 +64,6 @@ resource "f5xc_cloud_connect" "example" {
62
64
 
63
65
  <a id="labels"></a>&#x2022; [`labels`](#labels) - Optional Map<br>Labels is a user defined key value map that can be attached to resources for organization and filtering
64
66
 
65
- <a id="namespace"></a>&#x2022; [`namespace`](#namespace) - Optional String<br>Namespace for the Cloud Connect. For this resource type, namespace should be empty or omitted
66
-
67
67
  ### Spec Argument Reference
68
68
 
69
69
  -> **One of the following:**