@robinmordasiewicz/f5xc-terraform-mcp 3.12.1 → 3.12.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (15) hide show
  1. package/dist/docs/data-sources/bgp.md +2 -2
  2. package/dist/docs/data-sources/certificate.md +2 -2
  3. package/dist/docs/data-sources/discovery.md +2 -2
  4. package/dist/docs/data-sources/irule.md +2 -2
  5. package/dist/docs/data-sources/namespace.md +141 -0
  6. package/dist/docs/data-sources/site.md +2 -2
  7. package/dist/docs/resources/bgp.md +4 -238
  8. package/dist/docs/resources/certificate.md +56 -4
  9. package/dist/docs/resources/discovery.md +8 -259
  10. package/dist/docs/resources/irule.md +7 -5
  11. package/dist/docs/resources/namespace.md +170 -0
  12. package/dist/docs/resources/site.md +455 -1444
  13. package/dist/metadata/resource-metadata.json +309 -301
  14. package/manifest.json +1 -1
  15. package/package.json +1 -1
package/dist/docs/data-sources/bgp.md CHANGED
@@ -2,12 +2,12 @@
2
2
  page_title: "f5xc_bgp Data Source - terraform-provider-f5xc"
3
3
  subcategory: "Networking"
4
4
  description: |-
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.
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 (Data Source)
9
9
 
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.
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 data source, please refer to the [F5 XC API Documentation](https://docs.cloud.f5.com/docs/api/).
13
13
 
package/dist/docs/data-sources/certificate.md CHANGED
@@ -2,12 +2,12 @@
2
2
  page_title: "f5xc_certificate Data Source - terraform-provider-f5xc"
3
3
  subcategory: "Certificates"
4
4
  description: |-
5
- Manages a Certificate resource in F5 Distributed Cloud for TLS/SSL certificate management.
5
+ Manages a Certificate resource in F5 Distributed Cloud for certificate. configuration.
6
6
  ---
7
7
 
8
8
  # f5xc_certificate (Data Source)
9
9
 
10
- Manages a Certificate resource in F5 Distributed Cloud for TLS/SSL certificate management.
10
+ Manages a Certificate resource in F5 Distributed Cloud for certificate. configuration.
11
11
 
12
12
  ~> **Note** For more information about this data source, please refer to the [F5 XC API Documentation](https://docs.cloud.f5.com/docs/api/).
13
13
 
package/dist/docs/data-sources/discovery.md CHANGED
@@ -2,12 +2,12 @@
2
2
  page_title: "f5xc_discovery Data Source - terraform-provider-f5xc"
3
3
  subcategory: "Applications"
4
4
  description: |-
5
- Manages a Discovery resource in F5 Distributed Cloud for api to create discovery object for a site or virtual site in system namespace. configuration.
5
+ Manages API discovery creates a new object in the storage backend for metadata.namespace. in F5 Distributed Cloud.
6
6
  ---
7
7
 
8
8
  # f5xc_discovery (Data Source)
9
9
 
10
- Manages a Discovery resource in F5 Distributed Cloud for api to create discovery object for a site or virtual site in system namespace. configuration.
10
+ Manages API discovery creates a new object in the storage backend for metadata.namespace. in F5 Distributed Cloud.
11
11
 
12
12
  ~> **Note** For more information about this data source, please refer to the [F5 XC API Documentation](https://docs.cloud.f5.com/docs/api/).
13
13
 
package/dist/docs/data-sources/irule.md CHANGED
@@ -2,12 +2,12 @@
2
2
  page_title: "f5xc_irule Data Source - terraform-provider-f5xc"
3
3
  subcategory: "BIG-IP Integration"
4
4
  description: |-
5
- Manages iRule in a given namespace. If one already exists it will give an error. in F5 Distributed Cloud.
5
+ Manages a Irule resource in F5 Distributed Cloud for desired state for big-ip irule service. configuration.
6
6
  ---
7
7
 
8
8
  # f5xc_irule (Data Source)
9
9
 
10
- Manages iRule in a given namespace. If one already exists it will give an error. in F5 Distributed Cloud.
10
+ Manages a Irule resource in F5 Distributed Cloud for desired state for big-ip irule service. configuration.
11
11
 
12
12
  ~> **Note** For more information about this data source, please refer to the [F5 XC API Documentation](https://docs.cloud.f5.com/docs/api/).
13
13
 
package/dist/docs/data-sources/namespace.md ADDED
@@ -0,0 +1,141 @@
1
+ ---
2
+ page_title: "f5xc_namespace Data Source - terraform-provider-f5xc"
3
+ subcategory: "Organization"
4
+ description: |-
5
+ Manages new namespace. Name of the object is name of the name space. in F5 Distributed Cloud.
6
+ ---
7
+
8
+ # f5xc_namespace (Data Source)
9
+
10
+ Manages new namespace. Name of the object is name of the name space. in F5 Distributed Cloud.
11
+
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
+
14
+ ## Example Usage
15
+
16
+ ```terraform
17
+ # Namespace Data Source Example
18
+ # Retrieves information about an existing Namespace
19
+
20
+ # Look up an existing Namespace by name
21
+ data "f5xc_namespace" "example" {
22
+ name = "example-namespace"
23
+ namespace = "system"
24
+ }
25
+
26
+ # Example: Use the data source in another resource
27
+ # output "namespace_id" {
28
+ # value = data.f5xc_namespace.example.id
29
+ # }
30
+
31
+ # Example: Create resources in a namespace discovered via data source
32
+ # resource "f5xc_origin_pool" "example" {
33
+ # name = "example-pool"
34
+ # namespace = data.f5xc_namespace.example.name
35
+ # # ... other configuration
36
+ # }
37
+ ```
38
+
39
+ <!-- schema generated by tfplugindocs -->
40
+ ## Argument Reference
41
+
42
+ ### Metadata Argument Reference
43
+
44
+ <a id="name"></a>&#x2022; [`name`](#name) - Required String<br>Name of the Namespace
45
+
46
+ <a id="namespace"></a>&#x2022; [`namespace`](#namespace) - Required String<br>Namespace where the Namespace exists
47
+
48
+ ### Attributes Reference
49
+
50
+ In addition to all arguments above, the following attributes are exported:
51
+
52
+ <a id="annotations"></a>&#x2022; [`annotations`](#annotations) - Optional Map<br>Annotations applied to this resource
53
+
54
+ <a id="description"></a>&#x2022; [`description`](#description) - Optional String<br>Description of the Namespace
55
+
56
+ <a id="id"></a>&#x2022; [`id`](#id) - Optional String<br>Unique identifier for the resource
57
+
58
+ <a id="labels"></a>&#x2022; [`labels`](#labels) - Optional Map<br>Labels applied to this resource
59
+
60
+ ---
61
+
62
+ ## Common Types
63
+
64
+ The following type definitions are used throughout this resource. See the full definition here rather than repeated inline.
65
+
66
+ ### Object Reference {#common-object-reference}
67
+
68
+ Object references establish a direct reference from one configuration object to another in F5 Distributed Cloud. References use the format `tenant/namespace/name`.
69
+
70
+ | Field | Type | Description |
71
+ | ----- | ---- | ----------- |
72
+ | `name` | String | Name of the referenced object |
73
+ | `namespace` | String | Namespace containing the referenced object |
74
+ | `tenant` | String | Tenant of the referenced object (system-managed) |
75
+
76
+ ### Transformers {#common-transformers}
77
+
78
+ Transformers apply transformations to input values before matching. Multiple transformers can be applied in order.
79
+
80
+ | Value | Description |
81
+ | ----- | ----------- |
82
+ | `LOWER_CASE` | Convert to lowercase |
83
+ | `UPPER_CASE` | Convert to uppercase |
84
+ | `BASE64_DECODE` | Decode base64 content |
85
+ | `NORMALIZE_PATH` | Normalize URL path |
86
+ | `REMOVE_WHITESPACE` | Remove whitespace characters |
87
+ | `URL_DECODE` | Decode URL-encoded characters |
88
+ | `TRIM_LEFT` | Trim leading whitespace |
89
+ | `TRIM_RIGHT` | Trim trailing whitespace |
90
+ | `TRIM` | Trim both leading and trailing whitespace |
91
+
92
+ ### HTTP Methods {#common-http-methods}
93
+
94
+ HTTP methods used for request matching.
95
+
96
+ | Value | Description |
97
+ | ----- | ----------- |
98
+ | `ANY` | Match any HTTP method |
99
+ | `GET` | HTTP GET request |
100
+ | `HEAD` | HTTP HEAD request |
101
+ | `POST` | HTTP POST request |
102
+ | `PUT` | HTTP PUT request |
103
+ | `DELETE` | HTTP DELETE request |
104
+ | `CONNECT` | HTTP CONNECT request |
105
+ | `OPTIONS` | HTTP OPTIONS request |
106
+ | `TRACE` | HTTP TRACE request |
107
+ | `PATCH` | HTTP PATCH request |
108
+ | `COPY` | HTTP COPY request (WebDAV) |
109
+
110
+ ### TLS Fingerprints {#common-tls-fingerprints}
111
+
112
+ TLS fingerprint categories for malicious client detection.
113
+
114
+ | Value | Description |
115
+ | ----- | ----------- |
116
+ | `TLS_FINGERPRINT_NONE` | No fingerprint matching |
117
+ | `ANY_MALICIOUS_FINGERPRINT` | Match any known malicious fingerprint |
118
+ | `ADWARE` | Adware-associated fingerprints |
119
+ | `DRIDEX` | Dridex malware fingerprints |
120
+ | `GOOTKIT` | Gootkit malware fingerprints |
121
+ | `RANSOMWARE` | Ransomware-associated fingerprints |
122
+ | `TRICKBOT` | Trickbot malware fingerprints |
123
+
124
+ ### IP Threat Categories {#common-ip-threat-categories}
125
+
126
+ IP address threat categories for security filtering.
127
+
128
+ | Value | Description |
129
+ | ----- | ----------- |
130
+ | `SPAM_SOURCES` | Known spam sources |
131
+ | `WINDOWS_EXPLOITS` | Windows exploit sources |
132
+ | `WEB_ATTACKS` | Web attack sources |
133
+ | `BOTNETS` | Known botnet IPs |
134
+ | `SCANNERS` | Network scanner IPs |
135
+ | `REPUTATION` | Poor reputation IPs |
136
+ | `PHISHING` | Phishing-related IPs |
137
+ | `PROXY` | Anonymous proxy IPs |
138
+ | `MOBILE_THREATS` | Mobile threat sources |
139
+ | `TOR_PROXY` | Tor exit nodes |
140
+ | `DENIAL_OF_SERVICE` | DoS attack sources |
141
+ | `NETWORK` | Known bad network ranges |
package/dist/docs/data-sources/site.md CHANGED
@@ -2,12 +2,12 @@
2
2
  page_title: "f5xc_site Data Source - terraform-provider-f5xc"
3
3
  subcategory: "Uncategorized"
4
4
  description: |-
5
- Manages a Site resource in F5 Distributed Cloud for secure mesh site specification. configuration.
5
+ Manages a Site resource in F5 Distributed Cloud for aws vpc site specification. configuration.
6
6
  ---
7
7
 
8
8
  # f5xc_site (Data Source)
9
9
 
10
- Manages a Site resource in F5 Distributed Cloud for secure mesh site specification. configuration.
10
+ Manages a Site resource in F5 Distributed Cloud for aws vpc site 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
 
package/dist/docs/resources/bgp.md CHANGED
@@ -2,12 +2,12 @@
2
2
  page_title: "f5xc_bgp Resource - terraform-provider-f5xc"
3
3
  subcategory: "Networking"
4
4
  description: |-
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.
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 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.
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 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.
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="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.
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
79
77
 
80
78
  <a id="timeouts"></a>&#x2022; [`timeouts`](#timeouts) - Optional Block<br>See [Timeouts](#timeouts) below for details.
81
79
 
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
-
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>&#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
-
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>&#x2022; [`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>&#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
-
334
100
  ---
335
101
 
336
102
  ## Common Types
package/dist/docs/resources/certificate.md CHANGED
@@ -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 TLS/SSL certificate management.
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 TLS/SSL certificate management.
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 TLS/SSL certificate management.
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-url"></a>&#x2022; [`certificate_url`](#certificate-url) - Optional String<br>Certificate chain is the list of intermediate certificates in PEM format including the PEM headers
63
+ <a id="certificate-chain"></a>&#x2022; [`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>&#x2022; [`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
+ &#x2022; <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>&#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>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>&#x2022; [`timeouts`](#timeouts) - Optional Block<br>See [Timeouts](#timeouts) below for details.
66
74
 
75
+ <a id="use-system-defaults"></a>&#x2022; [`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>&#x2022; [`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>&#x2022; [`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>&#x2022; [`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>&#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] 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>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>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>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 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>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>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 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: