@robinmordasiewicz/f5xc-terraform-mcp 3.11.1 → 3.11.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/docs/data-sources/bgp.md +2 -2
- package/dist/docs/data-sources/certificate.md +2 -2
- package/dist/docs/data-sources/discovery.md +2 -2
- package/dist/docs/data-sources/log_receiver.md +2 -2
- package/dist/docs/data-sources/namespace.md +141 -0
- package/dist/docs/data-sources/site.md +2 -2
- package/dist/docs/data-sources/workload.md +2 -2
- package/dist/docs/index.md +241 -117
- package/dist/docs/resources/bgp.md +4 -238
- package/dist/docs/resources/certificate.md +56 -4
- package/dist/docs/resources/discovery.md +8 -259
- package/dist/docs/resources/log_receiver.md +825 -44
- package/dist/docs/resources/namespace.md +170 -0
- package/dist/docs/resources/site.md +911 -200
- package/dist/docs/resources/workload.md +9 -2951
- package/dist/metadata/resource-metadata.json +371 -177
- package/dist/metadata/validation-patterns.json +1 -1
- package/package.json +1 -1
- package/dist/docs/data-sources/index.md +0 -25
- package/dist/docs/functions/index.md +0 -39
- package/dist/docs/guides/index.md +0 -22
- package/dist/docs/resources/index.md +0 -27
|
@@ -2,12 +2,12 @@
|
|
|
2
2
|
page_title: "f5xc_bgp Resource - terraform-provider-f5xc"
|
|
3
3
|
subcategory: "Networking"
|
|
4
4
|
description: |-
|
|
5
|
-
Manages
|
|
5
|
+
Manages bgp_asn_set creates a new object in the storage backend for metadata.namespace. in F5 Distributed Cloud.
|
|
6
6
|
---
|
|
7
7
|
|
|
8
8
|
# f5xc_bgp (Resource)
|
|
9
9
|
|
|
10
|
-
Manages
|
|
10
|
+
Manages bgp_asn_set creates a new object in the storage backend for metadata.namespace. in F5 Distributed Cloud.
|
|
11
11
|
|
|
12
12
|
~> **Note** For more information about this resource, please refer to the [F5 XC API Documentation](https://docs.cloud.f5.com/docs/api/).
|
|
13
13
|
|
|
@@ -15,7 +15,7 @@ Manages a BGP resource in F5 Distributed Cloud for bgp object is the configurati
|
|
|
15
15
|
|
|
16
16
|
```terraform
|
|
17
17
|
# BGP Resource Example
|
|
18
|
-
# Manages
|
|
18
|
+
# Manages bgp_asn_set creates a new object in the storage backend for metadata.namespace. in F5 Distributed Cloud.
|
|
19
19
|
|
|
20
20
|
# Basic BGP configuration
|
|
21
21
|
resource "f5xc_bgp" "example" {
|
|
@@ -73,14 +73,10 @@ resource "f5xc_bgp" "example" {
|
|
|
73
73
|
|
|
74
74
|
### Spec Argument Reference
|
|
75
75
|
|
|
76
|
-
<a id="
|
|
77
|
-
|
|
78
|
-
<a id="peers"></a>• [`peers`](#peers) - Optional Block<br>Peers. List of peers<br>See [Peers](#peers) below for details.
|
|
76
|
+
<a id="as-numbers"></a>• [`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
|
|
79
77
|
|
|
80
78
|
<a id="timeouts"></a>• [`timeouts`](#timeouts) - Optional Block<br>See [Timeouts](#timeouts) below for details.
|
|
81
79
|
|
|
82
|
-
<a id="where"></a>• [`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
|
-
|
|
84
80
|
### Attributes Reference
|
|
85
81
|
|
|
86
82
|
In addition to all arguments above, the following attributes are exported:
|
|
@@ -89,176 +85,6 @@ In addition to all arguments above, the following attributes are exported:
|
|
|
89
85
|
|
|
90
86
|
---
|
|
91
87
|
|
|
92
|
-
#### BGP Parameters
|
|
93
|
-
|
|
94
|
-
A [`bgp_parameters`](#bgp-parameters) block supports the following:
|
|
95
|
-
|
|
96
|
-
<a id="bgp-parameters-asn"></a>• [`asn`](#bgp-parameters-asn) - Optional Number<br>ASN. Autonomous System Number
|
|
97
|
-
|
|
98
|
-
<a id="bgp-parameters-from-site"></a>• [`from_site`](#bgp-parameters-from-site) - Optional Block<br>Enable this option
|
|
99
|
-
|
|
100
|
-
<a id="bgp-parameters-ip-address"></a>• [`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>• [`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>• [`bfd_disabled`](#peers-bfd-disabled) - Optional Block<br>Enable this option
|
|
109
|
-
|
|
110
|
-
<a id="peers-bfd-enabled"></a>• [`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>• [`disable`](#peers-disable) - Optional Block<br>Enable this option
|
|
113
|
-
|
|
114
|
-
<a id="peers-external"></a>• [`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>• [`label`](#peers-label) - Optional String<br>Label. Specify whether this peer should be
|
|
117
|
-
|
|
118
|
-
<a id="peers-metadata"></a>• [`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>• [`passive_mode_disabled`](#peers-passive-mode-disabled) - Optional Block<br>Enable this option
|
|
121
|
-
|
|
122
|
-
<a id="peers-passive-mode-enabled"></a>• [`passive_mode_enabled`](#peers-passive-mode-enabled) - Optional Block<br>Enable this option
|
|
123
|
-
|
|
124
|
-
<a id="peers-routing-policies"></a>• [`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>• [`multiplier`](#peers-bfd-enabled-multiplier) - Optional Number<br>Specify Number of missed packets to bring session down'
|
|
131
|
-
|
|
132
|
-
<a id="milliseconds-dab8b3"></a>• [`receive_interval_milliseconds`](#milliseconds-dab8b3) - Optional Number<br>BFD receive interval timer, in milliseconds
|
|
133
|
-
|
|
134
|
-
<a id="milliseconds-135c29"></a>• [`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>• [`address`](#peers-external-address) - Optional String<br>Specify IPv4 peer address
|
|
141
|
-
|
|
142
|
-
<a id="peers-external-address-ipv6"></a>• [`address_ipv6`](#peers-external-address-ipv6) - Optional String<br>Specify peer IPv6 address
|
|
143
|
-
|
|
144
|
-
<a id="peers-external-asn"></a>• [`asn`](#peers-external-asn) - Optional Number<br>Autonomous System Number for BGP peer
|
|
145
|
-
|
|
146
|
-
<a id="peers-external-default-gateway"></a>• [`default_gateway`](#peers-external-default-gateway) - Optional Block<br>Enable this option
|
|
147
|
-
|
|
148
|
-
<a id="peers-external-default-gateway-v6"></a>• [`default_gateway_v6`](#peers-external-default-gateway-v6) - Optional Block<br>Enable this option
|
|
149
|
-
|
|
150
|
-
<a id="peers-external-disable"></a>• [`disable`](#peers-external-disable) - Optional Block<br>Enable this option
|
|
151
|
-
|
|
152
|
-
<a id="peers-external-disable-v6"></a>• [`disable_v6`](#peers-external-disable-v6) - Optional Block<br>Enable this option
|
|
153
|
-
|
|
154
|
-
<a id="peers-external-external-connector"></a>• [`external_connector`](#peers-external-external-connector) - Optional Block<br>Enable this option
|
|
155
|
-
|
|
156
|
-
<a id="peers-external-family-inet"></a>• [`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>• [`from_site`](#peers-external-from-site) - Optional Block<br>Enable this option
|
|
159
|
-
|
|
160
|
-
<a id="peers-external-from-site-v6"></a>• [`from_site_v6`](#peers-external-from-site-v6) - Optional Block<br>Enable this option
|
|
161
|
-
|
|
162
|
-
<a id="peers-external-interface"></a>• [`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>• [`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>• [`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>• [`no_authentication`](#peers-external-no-authentication) - Optional Block<br>Enable this option
|
|
169
|
-
|
|
170
|
-
<a id="peers-external-port"></a>• [`port`](#peers-external-port) - Optional Number<br>Peer Port. Peer TCP port number
|
|
171
|
-
|
|
172
|
-
<a id="peers-external-subnet-begin-offset"></a>• [`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>• [`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>• [`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>• [`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>• [`disable`](#peers-external-family-inet-disable) - Optional Block<br>Enable this option
|
|
185
|
-
|
|
186
|
-
<a id="peers-external-family-inet-enable"></a>• [`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>• [`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>• [`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>• [`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>• [`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>• [`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>• [`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>• [`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>• [`description_spec`](#peers-metadata-description-spec) - Optional String<br>Description. Human readable description
|
|
219
|
-
|
|
220
|
-
<a id="peers-metadata-name"></a>• [`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>• [`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>• [`all_nodes`](#nodes-761998) - Optional Block<br>Enable this option
|
|
233
|
-
|
|
234
|
-
<a id="inbound-bbe39d"></a>• [`inbound`](#inbound-bbe39d) - Optional Block<br>Enable this option
|
|
235
|
-
|
|
236
|
-
<a id="name-e2301f"></a>• [`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>• [`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>• [`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>• [`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>• [`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>• [`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>• [`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>• [`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>• [`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
|
-
|
|
262
88
|
#### Timeouts
|
|
263
89
|
|
|
264
90
|
A [`timeouts`](#timeouts) block supports the following:
|
|
@@ -271,66 +97,6 @@ A [`timeouts`](#timeouts) block supports the following:
|
|
|
271
97
|
|
|
272
98
|
<a id="timeouts-update"></a>• [`update`](#timeouts-update) - Optional String (Defaults to `10 minutes`)<br>Used when updating the resource
|
|
273
99
|
|
|
274
|
-
#### Where
|
|
275
|
-
|
|
276
|
-
A [`where`](#where) block supports the following:
|
|
277
|
-
|
|
278
|
-
<a id="where-site"></a>• [`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>• [`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>• [`disable_internet_vip`](#where-site-disable-internet-vip) - Optional Block<br>Enable this option
|
|
287
|
-
|
|
288
|
-
<a id="where-site-enable-internet-vip"></a>• [`enable_internet_vip`](#where-site-enable-internet-vip) - Optional Block<br>Enable this option
|
|
289
|
-
|
|
290
|
-
<a id="where-site-network-type"></a>• [`network_type`](#where-site-network-type) - Optional String Defaults to `VIRTUAL_NETWORK_SITE_LOCAL`<br>Possible values are `VIRTUAL_NETWORK_SITE_LOCAL`, `VIRTUAL_NETWORK_SITE_LOCAL_INSIDE`, `VIRTUAL_NETWORK_PER_SITE`, `VIRTUAL_NETWORK_PUBLIC`, `VIRTUAL_NETWORK_GLOBAL`, `VIRTUAL_NETWORK_SITE_SERVICE`, `VIRTUAL_NETWORK_VER_INTERNAL`, `VIRTUAL_NETWORK_SITE_LOCAL_INSIDE_OUTSIDE`, `VIRTUAL_NETWORK_IP_AUTO`, `VIRTUAL_NETWORK_VOLTADN_PRIVATE_NETWORK`, `VIRTUAL_NETWORK_SRV6_NETWORK`, `VIRTUAL_NETWORK_IP_FABRIC`, `VIRTUAL_NETWORK_SEGMENT`<br>[Enum: VIRTUAL_NETWORK_SITE_LOCAL|VIRTUAL_NETWORK_SITE_LOCAL_INSIDE|VIRTUAL_NETWORK_PER_SITE|VIRTUAL_NETWORK_PUBLIC|VIRTUAL_NETWORK_GLOBAL|VIRTUAL_NETWORK_SITE_SERVICE|VIRTUAL_NETWORK_VER_INTERNAL|VIRTUAL_NETWORK_SITE_LOCAL_INSIDE_OUTSIDE|VIRTUAL_NETWORK_IP_AUTO|VIRTUAL_NETWORK_VOLTADN_PRIVATE_NETWORK|VIRTUAL_NETWORK_SRV6_NETWORK|VIRTUAL_NETWORK_IP_FABRIC|VIRTUAL_NETWORK_SEGMENT] 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>• [`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>• [`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>• [`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>• [`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>• [`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>• [`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>• [`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>• [`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>• [`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>• [`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>• [`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>• [`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>• [`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>• [`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>• [`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
|
-
|
|
334
100
|
---
|
|
335
101
|
|
|
336
102
|
## 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
|
|
5
|
+
Manages a Certificate resource in F5 Distributed Cloud for certificate. configuration.
|
|
6
6
|
---
|
|
7
7
|
|
|
8
8
|
# f5xc_certificate (Resource)
|
|
9
9
|
|
|
10
|
-
Manages a Certificate resource in F5 Distributed Cloud for
|
|
10
|
+
Manages a Certificate resource in F5 Distributed Cloud for certificate. 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 a Certificate resource in F5 Distributed Cloud for TLS/SSL certificate m
|
|
|
15
15
|
|
|
16
16
|
```terraform
|
|
17
17
|
# Certificate Resource Example
|
|
18
|
-
# Manages a Certificate resource in F5 Distributed Cloud for
|
|
18
|
+
# Manages a Certificate resource in F5 Distributed Cloud for certificate. configuration.
|
|
19
19
|
|
|
20
20
|
# Basic Certificate configuration
|
|
21
21
|
resource "f5xc_certificate" "example" {
|
|
@@ -60,10 +60,20 @@ resource "f5xc_certificate" "example" {
|
|
|
60
60
|
|
|
61
61
|
### Spec Argument Reference
|
|
62
62
|
|
|
63
|
-
<a id="certificate-
|
|
63
|
+
<a id="certificate-chain"></a>• [`certificate_chain`](#certificate-chain) - 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 [Certificate Chain](#certificate-chain) below for details.
|
|
64
|
+
|
|
65
|
+
<a id="certificate-url"></a>• [`certificate_url`](#certificate-url) - Optional String<br>Certificate. Certificate or certificate chain in PEM format including the PEM headers
|
|
66
|
+
|
|
67
|
+
-> **One of the following:**
|
|
68
|
+
• <a id="custom-hash-algorithms"></a>[`custom_hash_algorithms`](#custom-hash-algorithms) - Optional Block<br>Specifies the hash algorithms to be used<br>See [Custom Hash Algorithms](#custom-hash-algorithms) below for details.
|
|
69
|
+
<br><br>• <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>• [`private_key`](#private-key) - Optional Block<br>SecretType is used in an object to indicate a sensitive/confidential field<br>See [Private Key](#private-key) below for details.
|
|
64
72
|
|
|
65
73
|
<a id="timeouts"></a>• [`timeouts`](#timeouts) - Optional Block<br>See [Timeouts](#timeouts) below for details.
|
|
66
74
|
|
|
75
|
+
<a id="use-system-defaults"></a>• [`use_system_defaults`](#use-system-defaults) - Optional Block<br>Enable this option
|
|
76
|
+
|
|
67
77
|
### Attributes Reference
|
|
68
78
|
|
|
69
79
|
In addition to all arguments above, the following attributes are exported:
|
|
@@ -72,6 +82,48 @@ In addition to all arguments above, the following attributes are exported:
|
|
|
72
82
|
|
|
73
83
|
---
|
|
74
84
|
|
|
85
|
+
#### Certificate Chain
|
|
86
|
+
|
|
87
|
+
A [`certificate_chain`](#certificate-chain) block supports the following:
|
|
88
|
+
|
|
89
|
+
<a id="certificate-chain-name"></a>• [`name`](#certificate-chain-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
|
|
90
|
+
|
|
91
|
+
<a id="certificate-chain-namespace"></a>• [`namespace`](#certificate-chain-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
|
|
92
|
+
|
|
93
|
+
<a id="certificate-chain-tenant"></a>• [`tenant`](#certificate-chain-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
|
|
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>• [`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] 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>• [`blindfold_secret_info`](#private-key-blindfold-secret-info) - Optional Block<br>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>• [`clear_secret_info`](#private-key-clear-secret-info) - Optional Block<br>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>• [`decryption_provider`](#provider-2cb137) - Optional String<br>Name of the Secret Management Access object that contains information about the backend Secret Management service
|
|
114
|
+
|
|
115
|
+
<a id="location-208dea"></a>• [`location`](#location-208dea) - Optional String<br>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>• [`store_provider`](#provider-1e06e0) - Optional String<br>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>• [`provider_ref`](#ref-e799a7) - Optional String<br>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>• [`url`](#private-key-clear-secret-info-url) - Optional String<br>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
|
+
|
|
75
127
|
#### Timeouts
|
|
76
128
|
|
|
77
129
|
A [`timeouts`](#timeouts) block supports the following:
|