@robinmordasiewicz/f5xc-terraform-mcp 3.0.2 → 3.2.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 (157) hide show
  1. package/dist/docs/data-sources/certificate.md +2 -2
  2. package/dist/docs/data-sources/fast_acl.md +2 -2
  3. package/dist/docs/data-sources/irule.md +2 -2
  4. package/dist/docs/data-sources/network_policy.md +2 -2
  5. package/dist/docs/data-sources/policer.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/resources/certificate.md +4 -56
  9. package/dist/docs/resources/fast_acl.md +166 -60
  10. package/dist/docs/resources/irule.md +7 -5
  11. package/dist/docs/resources/network_policy.md +210 -37
  12. package/dist/docs/resources/policer.md +10 -50
  13. package/dist/docs/resources/securemesh_site.md +1614 -253
  14. package/dist/docs/resources/site.md +12 -819
  15. package/dist/docs/resources/workload.md +9 -2951
  16. package/dist/docs/specifications/api/CHANGELOG.md +4 -4
  17. package/dist/docs/specifications/api/README.md +2 -2
  18. package/dist/docs/specifications/api/domains/admin_console_and_ui.json +29 -25
  19. package/dist/docs/specifications/api/domains/ai_services.json +23 -21
  20. package/dist/docs/specifications/api/domains/api.json +201 -173
  21. package/dist/docs/specifications/api/domains/authentication.json +57 -45
  22. package/dist/docs/specifications/api/domains/bigip.json +106 -94
  23. package/dist/docs/specifications/api/domains/billing_and_usage.json +71 -63
  24. package/dist/docs/specifications/api/domains/blindfold.json +141 -109
  25. package/dist/docs/specifications/api/domains/bot_and_threat_defense.json +77 -65
  26. package/dist/docs/specifications/api/domains/cdn.json +371 -177
  27. package/dist/docs/specifications/api/domains/ce_management.json +137 -111
  28. package/dist/docs/specifications/api/domains/certificates.json +81 -75
  29. package/dist/docs/specifications/api/domains/cloud_infrastructure.json +136 -112
  30. package/dist/docs/specifications/api/domains/container_services.json +123 -91
  31. package/dist/docs/specifications/api/domains/data_and_privacy_security.json +72 -66
  32. package/dist/docs/specifications/api/domains/data_intelligence.json +68 -62
  33. package/dist/docs/specifications/api/domains/ddos.json +168 -154
  34. package/dist/docs/specifications/api/domains/dns.json +160 -148
  35. package/dist/docs/specifications/api/domains/managed_kubernetes.json +91 -85
  36. package/dist/docs/specifications/api/domains/marketplace.json +111 -103
  37. package/dist/docs/specifications/api/domains/network.json +269 -230
  38. package/dist/docs/specifications/api/domains/network_security.json +243 -187
  39. package/dist/docs/specifications/api/domains/nginx_one.json +70 -62
  40. package/dist/docs/specifications/api/domains/object_storage.json +12 -12
  41. package/dist/docs/specifications/api/domains/observability.json +231 -102
  42. package/dist/docs/specifications/api/domains/rate_limiting.json +58 -52
  43. package/dist/docs/specifications/api/domains/secops_and_incident_response.json +42 -36
  44. package/dist/docs/specifications/api/domains/service_mesh.json +143 -119
  45. package/dist/docs/specifications/api/domains/shape.json +327 -313
  46. package/dist/docs/specifications/api/domains/sites.json +536 -349
  47. package/dist/docs/specifications/api/domains/statistics.json +401 -225
  48. package/dist/docs/specifications/api/domains/support.json +116 -108
  49. package/dist/docs/specifications/api/domains/telemetry_and_insights.json +118 -72
  50. package/dist/docs/specifications/api/domains/tenant_and_identity.json +298 -268
  51. package/dist/docs/specifications/api/domains/threat_campaign.json +126 -66
  52. package/dist/docs/specifications/api/domains/users.json +76 -66
  53. package/dist/docs/specifications/api/domains/virtual.json +492 -244
  54. package/dist/docs/specifications/api/domains/vpm_and_node_management.json +1 -1
  55. package/dist/docs/specifications/api/domains/waf.json +227 -139
  56. package/dist/docs/specifications/api/index.json +99 -4
  57. package/dist/docs/specifications/api/openapi.json +3409 -2616
  58. package/dist/docs/specifications/api/openapi.yaml +5304 -2616
  59. package/package.json +1 -1
  60. package/dist/docs/data-sources/addon_service.md +0 -143
  61. package/dist/docs/data-sources/addon_service_activation_status.md +0 -144
  62. package/dist/docs/data-sources/addon_subscription.md +0 -134
  63. package/dist/docs/data-sources/allowed_tenant.md +0 -134
  64. package/dist/docs/data-sources/api_credential.md +0 -134
  65. package/dist/docs/data-sources/bigip_irule.md +0 -134
  66. package/dist/docs/data-sources/child_tenant.md +0 -134
  67. package/dist/docs/data-sources/child_tenant_manager.md +0 -134
  68. package/dist/docs/data-sources/contact.md +0 -134
  69. package/dist/docs/data-sources/customer_support.md +0 -134
  70. package/dist/docs/data-sources/dns_lb_health_check.md +0 -134
  71. package/dist/docs/data-sources/dns_lb_pool.md +0 -134
  72. package/dist/docs/data-sources/dns_load_balancer.md +0 -134
  73. package/dist/docs/data-sources/dns_zone.md +0 -145
  74. package/dist/docs/data-sources/geo_location_set.md +0 -134
  75. package/dist/docs/data-sources/ike1.md +0 -134
  76. package/dist/docs/data-sources/ike2.md +0 -134
  77. package/dist/docs/data-sources/ike_phase1_profile.md +0 -134
  78. package/dist/docs/data-sources/ike_phase2_profile.md +0 -134
  79. package/dist/docs/data-sources/infraprotect_asn.md +0 -134
  80. package/dist/docs/data-sources/infraprotect_asn_prefix.md +0 -134
  81. package/dist/docs/data-sources/infraprotect_deny_list_rule.md +0 -134
  82. package/dist/docs/data-sources/infraprotect_firewall_rule.md +0 -134
  83. package/dist/docs/data-sources/infraprotect_firewall_rule_group.md +0 -134
  84. package/dist/docs/data-sources/infraprotect_internet_prefix_advertisement.md +0 -134
  85. package/dist/docs/data-sources/infraprotect_tunnel.md +0 -134
  86. package/dist/docs/data-sources/k8s_cluster.md +0 -134
  87. package/dist/docs/data-sources/k8s_cluster_role.md +0 -134
  88. package/dist/docs/data-sources/k8s_cluster_role_binding.md +0 -134
  89. package/dist/docs/data-sources/k8s_pod_security_admission.md +0 -134
  90. package/dist/docs/data-sources/k8s_pod_security_policy.md +0 -134
  91. package/dist/docs/data-sources/managed_tenant.md +0 -134
  92. package/dist/docs/data-sources/namespace.md +0 -141
  93. package/dist/docs/data-sources/oidc_provider.md +0 -134
  94. package/dist/docs/data-sources/quota.md +0 -134
  95. package/dist/docs/data-sources/registration.md +0 -134
  96. package/dist/docs/data-sources/report_config.md +0 -134
  97. package/dist/docs/data-sources/role.md +0 -134
  98. package/dist/docs/data-sources/secret_policy.md +0 -134
  99. package/dist/docs/data-sources/secret_policy_rule.md +0 -134
  100. package/dist/docs/data-sources/securemesh_site_v2.md +0 -134
  101. package/dist/docs/data-sources/srv6_network_slice.md +0 -134
  102. package/dist/docs/data-sources/tenant_profile.md +0 -134
  103. package/dist/docs/data-sources/ticket_tracking_system.md +0 -134
  104. package/dist/docs/data-sources/token.md +0 -134
  105. package/dist/docs/data-sources/tpm_api_key.md +0 -134
  106. package/dist/docs/data-sources/tpm_category.md +0 -134
  107. package/dist/docs/data-sources/tpm_manager.md +0 -134
  108. package/dist/docs/data-sources/virtual_k8s.md +0 -134
  109. package/dist/docs/data-sources/voltshare_admin_policy.md +0 -134
  110. package/dist/docs/resources/addon_subscription.md +0 -213
  111. package/dist/docs/resources/allowed_tenant.md +0 -181
  112. package/dist/docs/resources/api_credential.md +0 -184
  113. package/dist/docs/resources/bigip_irule.md +0 -173
  114. package/dist/docs/resources/child_tenant.md +0 -237
  115. package/dist/docs/resources/child_tenant_manager.md +0 -201
  116. package/dist/docs/resources/contact.md +0 -187
  117. package/dist/docs/resources/customer_support.md +0 -253
  118. package/dist/docs/resources/dns_lb_health_check.md +0 -249
  119. package/dist/docs/resources/dns_lb_pool.md +0 -310
  120. package/dist/docs/resources/dns_load_balancer.md +0 -309
  121. package/dist/docs/resources/dns_zone.md +0 -790
  122. package/dist/docs/resources/geo_location_set.md +0 -180
  123. package/dist/docs/resources/ike1.md +0 -216
  124. package/dist/docs/resources/ike2.md +0 -210
  125. package/dist/docs/resources/ike_phase1_profile.md +0 -224
  126. package/dist/docs/resources/ike_phase2_profile.md +0 -214
  127. package/dist/docs/resources/infraprotect_asn.md +0 -183
  128. package/dist/docs/resources/infraprotect_asn_prefix.md +0 -181
  129. package/dist/docs/resources/infraprotect_deny_list_rule.md +0 -191
  130. package/dist/docs/resources/infraprotect_firewall_rule.md +0 -288
  131. package/dist/docs/resources/infraprotect_firewall_rule_group.md +0 -169
  132. package/dist/docs/resources/infraprotect_internet_prefix_advertisement.md +0 -191
  133. package/dist/docs/resources/infraprotect_tunnel.md +0 -289
  134. package/dist/docs/resources/k8s_cluster.md +0 -326
  135. package/dist/docs/resources/k8s_cluster_role.md +0 -222
  136. package/dist/docs/resources/k8s_cluster_role_binding.md +0 -207
  137. package/dist/docs/resources/k8s_pod_security_admission.md +0 -199
  138. package/dist/docs/resources/k8s_pod_security_policy.md +0 -337
  139. package/dist/docs/resources/managed_tenant.md +0 -193
  140. package/dist/docs/resources/namespace.md +0 -170
  141. package/dist/docs/resources/oidc_provider.md +0 -291
  142. package/dist/docs/resources/quota.md +0 -187
  143. package/dist/docs/resources/registration.md +0 -489
  144. package/dist/docs/resources/report_config.md +0 -237
  145. package/dist/docs/resources/role.md +0 -183
  146. package/dist/docs/resources/secret_policy.md +0 -240
  147. package/dist/docs/resources/secret_policy_rule.md +0 -198
  148. package/dist/docs/resources/securemesh_site_v2.md +0 -2027
  149. package/dist/docs/resources/srv6_network_slice.md +0 -175
  150. package/dist/docs/resources/tenant_profile.md +0 -233
  151. package/dist/docs/resources/ticket_tracking_system.md +0 -195
  152. package/dist/docs/resources/token.md +0 -170
  153. package/dist/docs/resources/tpm_api_key.md +0 -191
  154. package/dist/docs/resources/tpm_category.md +0 -191
  155. package/dist/docs/resources/tpm_manager.md +0 -167
  156. package/dist/docs/resources/virtual_k8s.md +0 -209
  157. package/dist/docs/resources/voltshare_admin_policy.md +0 -271
@@ -1,184 +0,0 @@
1
- ---
2
- page_title: "f5xc_api_credential Resource - terraform-provider-f5xc"
3
- subcategory: "Authentication"
4
- description: |-
5
- Manages request specification. in F5 Distributed Cloud.
6
- ---
7
-
8
- # f5xc_api_credential (Resource)
9
-
10
- Manages request specification. in F5 Distributed Cloud.
11
-
12
- ~> **Note** For more information about this resource, please refer to the [F5 XC API Documentation](https://docs.cloud.f5.com/docs/api/).
13
-
14
- ## Example Usage
15
-
16
- ```terraform
17
- # API Credential Resource Example
18
- # Manages request specification. in F5 Distributed Cloud.
19
-
20
- # Basic API Credential configuration
21
- resource "f5xc_api_credential" "example" {
22
- name = "example-api-credential"
23
- namespace = "system"
24
-
25
- labels = {
26
- environment = "production"
27
- managed_by = "terraform"
28
- }
29
-
30
- annotations = {
31
- "owner" = "platform-team"
32
- }
33
-
34
- # API Credential configuration
35
- api_credential_type = "API_CERTIFICATE"
36
-
37
- # Expiration settings
38
- expiration_timestamp = "2025-12-31T23:59:59Z"
39
-
40
- # Active state
41
- active = true
42
- }
43
- ```
44
-
45
- <!-- schema generated by tfplugindocs -->
46
- ## Argument Reference
47
-
48
- ### Metadata Argument Reference
49
-
50
- <a id="name"></a>&#x2022; [`name`](#name) - Required String<br>Name of the API Credential. Must be unique within the namespace
51
-
52
- <a id="namespace"></a>&#x2022; [`namespace`](#namespace) - Required String<br>Namespace where the API Credential will be created
53
-
54
- <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
55
-
56
- <a id="description"></a>&#x2022; [`description`](#description) - Optional String<br>Human readable description for the object
57
-
58
- <a id="disable"></a>&#x2022; [`disable`](#disable) - Optional Bool<br>A value of true will administratively disable the object
59
-
60
- <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
61
-
62
- ### Spec Argument Reference
63
-
64
- <a id="password"></a>&#x2022; [`password`](#password) - Optional String<br>Password. Password is used for generating an API certificate P12 bundle user can use to protect access to it. this password will not be saved/persisted anywhere in the system. Applicable for credential type API_CERTIFICATE Users have to use this password when they use the certificate, e.g. in curl or while adding to key chain
65
-
66
- <a id="timeouts"></a>&#x2022; [`timeouts`](#timeouts) - Optional Block<br>See [Timeouts](#timeouts) below for details.
67
-
68
- <a id="type"></a>&#x2022; [`type`](#type) - Optional String Defaults to `API_CERTIFICATE`<br>Possible values are `API_CERTIFICATE`, `KUBE_CONFIG`, `API_TOKEN`, `SERVICE_API_TOKEN`, `SERVICE_API_CERTIFICATE`, `SERVICE_KUBE_CONFIG`, `SITE_GLOBAL_KUBE_CONFIG`, `SCIM_API_TOKEN`, `SERVICE_SITE_GLOBAL_KUBE_CONFIG`<br>[Enum: API_CERTIFICATE|KUBE_CONFIG|API_TOKEN|SERVICE_API_TOKEN|SERVICE_API_CERTIFICATE|SERVICE_KUBE_CONFIG|SITE_GLOBAL_KUBE_CONFIG|SCIM_API_TOKEN|SERVICE_SITE_GLOBAL_KUBE_CONFIG] Credential Type. Types of API credential given when requesting credentials from volterra F5XC user certificate to access F5XC public API using mTLS using self credential (my credential) Kubernetes config file to access Virtual Kubernetes API in Volterra using self credential (my credential) API token to access F5XC public API using self credential (my credential) API token for service credentials using service user credential (service credential) API certificate for service credentials using service user credential (service credential) Service Credential kubeconfig using service user credential (service credential) Kubeconfig for accessing Site via Global Controller using self credential (my credential) Token for the SCIM public APIs used to sync users and groups with the F5XC platform. External identity provider's SCIM client can use this token as Bearer token with Authorization header Service Credential Kubeconfig for accessing Site via Global Controller using service user credential (service credential)
69
-
70
- <a id="virtual-k8s-name"></a>&#x2022; [`virtual_k8s_name`](#virtual-k8s-name) - Optional String<br>vK8s Cluster. Name of virtual K8S cluster. Applicable for KUBE_CONFIG
71
-
72
- <a id="virtual-k8s-namespace"></a>&#x2022; [`virtual_k8s_namespace`](#virtual-k8s-namespace) - Optional String<br>vK8s Namespace. Namespace of virtual K8S cluster. Applicable for KUBE_CONFIG
73
-
74
- ### Attributes Reference
75
-
76
- In addition to all arguments above, the following attributes are exported:
77
-
78
- <a id="id"></a>&#x2022; [`id`](#id) - Optional String<br>Unique identifier for the resource
79
-
80
- ---
81
-
82
- #### Timeouts
83
-
84
- A [`timeouts`](#timeouts) block supports the following:
85
-
86
- <a id="timeouts-create"></a>&#x2022; [`create`](#timeouts-create) - Optional String (Defaults to `10 minutes`)<br>Used when creating the resource
87
-
88
- <a id="timeouts-delete"></a>&#x2022; [`delete`](#timeouts-delete) - Optional String (Defaults to `10 minutes`)<br>Used when deleting the resource
89
-
90
- <a id="timeouts-read"></a>&#x2022; [`read`](#timeouts-read) - Optional String (Defaults to `5 minutes`)<br>Used when retrieving the resource
91
-
92
- <a id="timeouts-update"></a>&#x2022; [`update`](#timeouts-update) - Optional String (Defaults to `10 minutes`)<br>Used when updating the resource
93
-
94
- ---
95
-
96
- ## Common Types
97
-
98
- The following type definitions are used throughout this resource. See the full definition here rather than repeated inline.
99
-
100
- ### Object Reference {#common-object-reference}
101
-
102
- Object references establish a direct reference from one configuration object to another in F5 Distributed Cloud. References use the format `tenant/namespace/name`.
103
-
104
- | Field | Type | Description |
105
- | ----- | ---- | ----------- |
106
- | `name` | String | Name of the referenced object |
107
- | `namespace` | String | Namespace containing the referenced object |
108
- | `tenant` | String | Tenant of the referenced object (system-managed) |
109
-
110
- ### Transformers {#common-transformers}
111
-
112
- Transformers apply transformations to input values before matching. Multiple transformers can be applied in order.
113
-
114
- | Value | Description |
115
- | ----- | ----------- |
116
- | `LOWER_CASE` | Convert to lowercase |
117
- | `UPPER_CASE` | Convert to uppercase |
118
- | `BASE64_DECODE` | Decode base64 content |
119
- | `NORMALIZE_PATH` | Normalize URL path |
120
- | `REMOVE_WHITESPACE` | Remove whitespace characters |
121
- | `URL_DECODE` | Decode URL-encoded characters |
122
- | `TRIM_LEFT` | Trim leading whitespace |
123
- | `TRIM_RIGHT` | Trim trailing whitespace |
124
- | `TRIM` | Trim both leading and trailing whitespace |
125
-
126
- ### HTTP Methods {#common-http-methods}
127
-
128
- HTTP methods used for request matching.
129
-
130
- | Value | Description |
131
- | ----- | ----------- |
132
- | `ANY` | Match any HTTP method |
133
- | `GET` | HTTP GET request |
134
- | `HEAD` | HTTP HEAD request |
135
- | `POST` | HTTP POST request |
136
- | `PUT` | HTTP PUT request |
137
- | `DELETE` | HTTP DELETE request |
138
- | `CONNECT` | HTTP CONNECT request |
139
- | `OPTIONS` | HTTP OPTIONS request |
140
- | `TRACE` | HTTP TRACE request |
141
- | `PATCH` | HTTP PATCH request |
142
- | `COPY` | HTTP COPY request (WebDAV) |
143
-
144
- ### TLS Fingerprints {#common-tls-fingerprints}
145
-
146
- TLS fingerprint categories for malicious client detection.
147
-
148
- | Value | Description |
149
- | ----- | ----------- |
150
- | `TLS_FINGERPRINT_NONE` | No fingerprint matching |
151
- | `ANY_MALICIOUS_FINGERPRINT` | Match any known malicious fingerprint |
152
- | `ADWARE` | Adware-associated fingerprints |
153
- | `DRIDEX` | Dridex malware fingerprints |
154
- | `GOOTKIT` | Gootkit malware fingerprints |
155
- | `RANSOMWARE` | Ransomware-associated fingerprints |
156
- | `TRICKBOT` | Trickbot malware fingerprints |
157
-
158
- ### IP Threat Categories {#common-ip-threat-categories}
159
-
160
- IP address threat categories for security filtering.
161
-
162
- | Value | Description |
163
- | ----- | ----------- |
164
- | `SPAM_SOURCES` | Known spam sources |
165
- | `WINDOWS_EXPLOITS` | Windows exploit sources |
166
- | `WEB_ATTACKS` | Web attack sources |
167
- | `BOTNETS` | Known botnet IPs |
168
- | `SCANNERS` | Network scanner IPs |
169
- | `REPUTATION` | Poor reputation IPs |
170
- | `PHISHING` | Phishing-related IPs |
171
- | `PROXY` | Anonymous proxy IPs |
172
- | `MOBILE_THREATS` | Mobile threat sources |
173
- | `TOR_PROXY` | Tor exit nodes |
174
- | `DENIAL_OF_SERVICE` | DoS attack sources |
175
- | `NETWORK` | Known bad network ranges |
176
-
177
- ## Import
178
-
179
- Import is supported using the following syntax:
180
-
181
- ```shell
182
- # Import using namespace/name format
183
- terraform import f5xc_api_credential.example system/example
184
- ```
@@ -1,173 +0,0 @@
1
- ---
2
- page_title: "f5xc_bigip_irule Resource - terraform-provider-f5xc"
3
- subcategory: "BIG-IP Integration"
4
- description: |-
5
- Manages a BIG-IP Irule resource in F5 Distributed Cloud for desired state for big-ip irule service configuration.
6
- ---
7
-
8
- # f5xc_bigip_irule (Resource)
9
-
10
- Manages a BIG-IP Irule resource in F5 Distributed Cloud for desired state for big-ip irule service configuration.
11
-
12
- ~> **Note** For more information about this resource, please refer to the [F5 XC API Documentation](https://docs.cloud.f5.com/docs/api/).
13
-
14
- ## Example Usage
15
-
16
- ```terraform
17
- # Bigip Irule Resource Example
18
- # Manages a BIG-IP Irule resource in F5 Distributed Cloud for desired state for big-ip irule service configuration.
19
-
20
- # Basic Bigip Irule configuration
21
- resource "f5xc_bigip_irule" "example" {
22
- name = "example-bigip-irule"
23
- namespace = "staging"
24
-
25
- labels = {
26
- environment = "production"
27
- managed_by = "terraform"
28
- }
29
-
30
- annotations = {
31
- "owner" = "platform-team"
32
- }
33
- }
34
- ```
35
-
36
- <!-- schema generated by tfplugindocs -->
37
- ## Argument Reference
38
-
39
- ### Metadata Argument Reference
40
-
41
- <a id="name"></a>&#x2022; [`name`](#name) - Required String<br>Name of the BIG-IP Irule. Must be unique within the namespace
42
-
43
- <a id="namespace"></a>&#x2022; [`namespace`](#namespace) - Required String<br>Namespace where the BIG-IP Irule will be created
44
-
45
- <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
46
-
47
- <a id="description"></a>&#x2022; [`description`](#description) - Optional String<br>Human readable description for the object
48
-
49
- <a id="disable"></a>&#x2022; [`disable`](#disable) - Optional Bool<br>A value of true will administratively disable the object
50
-
51
- <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
52
-
53
- ### Spec Argument Reference
54
-
55
- <a id="code"></a>&#x2022; [`code`](#code) - Optional String<br>iRule code. iRule code content, this content will be base64 encoded for preserving formating
56
-
57
- <a id="irule-name"></a>&#x2022; [`irule_name`](#irule-name) - Optional String<br>iRule name. iRule name
58
-
59
- <a id="source"></a>&#x2022; [`source`](#source) - Optional String<br>iRule source. iRule generation/updation source
60
-
61
- <a id="timeouts"></a>&#x2022; [`timeouts`](#timeouts) - Optional Block<br>See [Timeouts](#timeouts) below for details.
62
-
63
- ### Attributes Reference
64
-
65
- In addition to all arguments above, the following attributes are exported:
66
-
67
- <a id="id"></a>&#x2022; [`id`](#id) - Optional String<br>Unique identifier for the resource
68
-
69
- ---
70
-
71
- #### Timeouts
72
-
73
- A [`timeouts`](#timeouts) block supports the following:
74
-
75
- <a id="timeouts-create"></a>&#x2022; [`create`](#timeouts-create) - Optional String (Defaults to `10 minutes`)<br>Used when creating the resource
76
-
77
- <a id="timeouts-delete"></a>&#x2022; [`delete`](#timeouts-delete) - Optional String (Defaults to `10 minutes`)<br>Used when deleting the resource
78
-
79
- <a id="timeouts-read"></a>&#x2022; [`read`](#timeouts-read) - Optional String (Defaults to `5 minutes`)<br>Used when retrieving the resource
80
-
81
- <a id="timeouts-update"></a>&#x2022; [`update`](#timeouts-update) - Optional String (Defaults to `10 minutes`)<br>Used when updating the resource
82
-
83
- ---
84
-
85
- ## Common Types
86
-
87
- The following type definitions are used throughout this resource. See the full definition here rather than repeated inline.
88
-
89
- ### Object Reference {#common-object-reference}
90
-
91
- Object references establish a direct reference from one configuration object to another in F5 Distributed Cloud. References use the format `tenant/namespace/name`.
92
-
93
- | Field | Type | Description |
94
- | ----- | ---- | ----------- |
95
- | `name` | String | Name of the referenced object |
96
- | `namespace` | String | Namespace containing the referenced object |
97
- | `tenant` | String | Tenant of the referenced object (system-managed) |
98
-
99
- ### Transformers {#common-transformers}
100
-
101
- Transformers apply transformations to input values before matching. Multiple transformers can be applied in order.
102
-
103
- | Value | Description |
104
- | ----- | ----------- |
105
- | `LOWER_CASE` | Convert to lowercase |
106
- | `UPPER_CASE` | Convert to uppercase |
107
- | `BASE64_DECODE` | Decode base64 content |
108
- | `NORMALIZE_PATH` | Normalize URL path |
109
- | `REMOVE_WHITESPACE` | Remove whitespace characters |
110
- | `URL_DECODE` | Decode URL-encoded characters |
111
- | `TRIM_LEFT` | Trim leading whitespace |
112
- | `TRIM_RIGHT` | Trim trailing whitespace |
113
- | `TRIM` | Trim both leading and trailing whitespace |
114
-
115
- ### HTTP Methods {#common-http-methods}
116
-
117
- HTTP methods used for request matching.
118
-
119
- | Value | Description |
120
- | ----- | ----------- |
121
- | `ANY` | Match any HTTP method |
122
- | `GET` | HTTP GET request |
123
- | `HEAD` | HTTP HEAD request |
124
- | `POST` | HTTP POST request |
125
- | `PUT` | HTTP PUT request |
126
- | `DELETE` | HTTP DELETE request |
127
- | `CONNECT` | HTTP CONNECT request |
128
- | `OPTIONS` | HTTP OPTIONS request |
129
- | `TRACE` | HTTP TRACE request |
130
- | `PATCH` | HTTP PATCH request |
131
- | `COPY` | HTTP COPY request (WebDAV) |
132
-
133
- ### TLS Fingerprints {#common-tls-fingerprints}
134
-
135
- TLS fingerprint categories for malicious client detection.
136
-
137
- | Value | Description |
138
- | ----- | ----------- |
139
- | `TLS_FINGERPRINT_NONE` | No fingerprint matching |
140
- | `ANY_MALICIOUS_FINGERPRINT` | Match any known malicious fingerprint |
141
- | `ADWARE` | Adware-associated fingerprints |
142
- | `DRIDEX` | Dridex malware fingerprints |
143
- | `GOOTKIT` | Gootkit malware fingerprints |
144
- | `RANSOMWARE` | Ransomware-associated fingerprints |
145
- | `TRICKBOT` | Trickbot malware fingerprints |
146
-
147
- ### IP Threat Categories {#common-ip-threat-categories}
148
-
149
- IP address threat categories for security filtering.
150
-
151
- | Value | Description |
152
- | ----- | ----------- |
153
- | `SPAM_SOURCES` | Known spam sources |
154
- | `WINDOWS_EXPLOITS` | Windows exploit sources |
155
- | `WEB_ATTACKS` | Web attack sources |
156
- | `BOTNETS` | Known botnet IPs |
157
- | `SCANNERS` | Network scanner IPs |
158
- | `REPUTATION` | Poor reputation IPs |
159
- | `PHISHING` | Phishing-related IPs |
160
- | `PROXY` | Anonymous proxy IPs |
161
- | `MOBILE_THREATS` | Mobile threat sources |
162
- | `TOR_PROXY` | Tor exit nodes |
163
- | `DENIAL_OF_SERVICE` | DoS attack sources |
164
- | `NETWORK` | Known bad network ranges |
165
-
166
- ## Import
167
-
168
- Import is supported using the following syntax:
169
-
170
- ```shell
171
- # Import using namespace/name format
172
- terraform import f5xc_bigip_irule.example system/example
173
- ```
@@ -1,237 +0,0 @@
1
- ---
2
- page_title: "f5xc_child_tenant Resource - terraform-provider-f5xc"
3
- subcategory: "Organization"
4
- description: |-
5
- Manages child_tenant config instance. Name of the object is the name of the child tenant to be created. in F5 Distributed Cloud.
6
- ---
7
-
8
- # f5xc_child_tenant (Resource)
9
-
10
- Manages child_tenant config instance. Name of the object is the name of the child tenant to be created. in F5 Distributed Cloud.
11
-
12
- ~> **Note** For more information about this resource, please refer to the [F5 XC API Documentation](https://docs.cloud.f5.com/docs/api/).
13
-
14
- ## Example Usage
15
-
16
- ```terraform
17
- # Child Tenant Resource Example
18
- # Manages child_tenant config instance. Name of the object is the name of the child tenant to be created. in F5 Distributed Cloud.
19
-
20
- # Basic Child Tenant configuration
21
- resource "f5xc_child_tenant" "example" {
22
- name = "example-child-tenant"
23
- namespace = "staging"
24
-
25
- labels = {
26
- environment = "production"
27
- managed_by = "terraform"
28
- }
29
-
30
- annotations = {
31
- "owner" = "platform-team"
32
- }
33
-
34
- # Resource-specific configuration
35
- # Object reference. This type establishes a direct referenc...
36
- child_tenant_manager {
37
- # Configure child_tenant_manager settings
38
- }
39
- # Contact. Instance of one single contact that can be used ...
40
- contact_detail {
41
- # Configure contact_detail settings
42
- }
43
- # Customer Info. Optional details for the new child tenant
44
- customer_info {
45
- # Configure customer_info settings
46
- }
47
- }
48
- ```
49
-
50
- <!-- schema generated by tfplugindocs -->
51
- ## Argument Reference
52
-
53
- ### Metadata Argument Reference
54
-
55
- <a id="name"></a>&#x2022; [`name`](#name) - Required String<br>Name of the Child Tenant. Must be unique within the namespace
56
-
57
- <a id="namespace"></a>&#x2022; [`namespace`](#namespace) - Required String<br>Namespace where the Child Tenant will be created
58
-
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
60
-
61
- <a id="description"></a>&#x2022; [`description`](#description) - Optional String<br>Human readable description for the object
62
-
63
- <a id="disable"></a>&#x2022; [`disable`](#disable) - Optional Bool<br>A value of true will administratively disable the object
64
-
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
66
-
67
- ### Spec Argument Reference
68
-
69
- <a id="child-tenant-manager"></a>&#x2022; [`child_tenant_manager`](#child-tenant-manager) - 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 [Child Tenant Manager](#child-tenant-manager) below for details.
70
-
71
- <a id="company-name"></a>&#x2022; [`company_name`](#company-name) - Optional String<br>Company Name. Company name (enterprise only)
72
-
73
- <a id="contact-detail"></a>&#x2022; [`contact_detail`](#contact-detail) - Optional Block<br>Contact. Instance of one single contact that can be used to communicate with customers. Depending on contact type we use these details to send general communication (regular, physical mail) or invoices<br>See [Contact Detail](#contact-detail) below for details.
74
-
75
- <a id="customer-info"></a>&#x2022; [`customer_info`](#customer-info) - Optional Block<br>Customer Info. Optional details for the new child tenant<br>See [Customer Info](#customer-info) below for details.
76
-
77
- <a id="domain"></a>&#x2022; [`domain`](#domain) - Optional String<br>Domain. Text string that will be used for the subdomain of the new Child Tenant. This will be where users will directly log into the new Child Tenant. example domain.console.ves.volterra.io
78
-
79
- <a id="tenant-profile"></a>&#x2022; [`tenant_profile`](#tenant-profile) - 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 [Tenant Profile](#tenant-profile) below for details.
80
-
81
- <a id="timeouts"></a>&#x2022; [`timeouts`](#timeouts) - Optional Block<br>See [Timeouts](#timeouts) below for details.
82
-
83
- ### Attributes Reference
84
-
85
- In addition to all arguments above, the following attributes are exported:
86
-
87
- <a id="id"></a>&#x2022; [`id`](#id) - Optional String<br>Unique identifier for the resource
88
-
89
- ---
90
-
91
- #### Child Tenant Manager
92
-
93
- <a id="objref-017768"></a>Uses standard [Object Reference](#common-object-reference) fields (name, namespace, tenant).
94
-
95
- #### Contact Detail
96
-
97
- A [`contact_detail`](#contact-detail) block supports the following:
98
-
99
- <a id="contact-detail-address1"></a>&#x2022; [`address1`](#contact-detail-address1) - Optional String<br>Address Line 1
100
-
101
- <a id="contact-detail-address2"></a>&#x2022; [`address2`](#contact-detail-address2) - Optional String<br>Address Line 2
102
-
103
- <a id="contact-detail-city"></a>&#x2022; [`city`](#contact-detail-city) - Optional String<br>City
104
-
105
- <a id="contact-detail-contact-type"></a>&#x2022; [`contact_type`](#contact-detail-contact-type) - Optional String Defaults to `MAILING`<br>Possible values are `MAILING`, `BILLING`, `PAYMENT`<br>[Enum: MAILING|BILLING|PAYMENT] Contact Type. Determines the contact type Indicates snail mail address (used for correspondence) Indicates billing address (this address will appear on invoices) Indicates contact used for a payment method (this address is used when charging a payment method)
106
-
107
- <a id="contact-detail-country"></a>&#x2022; [`country`](#contact-detail-country) - Optional String<br>Country
108
-
109
- <a id="contact-detail-county"></a>&#x2022; [`county`](#contact-detail-county) - Optional String<br>County
110
-
111
- <a id="contact-detail-phone-number"></a>&#x2022; [`phone_number`](#contact-detail-phone-number) - Optional String<br>Phone Number
112
-
113
- <a id="contact-detail-state"></a>&#x2022; [`state`](#contact-detail-state) - Optional String<br>State
114
-
115
- <a id="contact-detail-state-code"></a>&#x2022; [`state_code`](#contact-detail-state-code) - Optional String<br>State Code
116
-
117
- <a id="contact-detail-zip-code"></a>&#x2022; [`zip_code`](#contact-detail-zip-code) - Optional String<br>ZIP code
118
-
119
- #### Customer Info
120
-
121
- A [`customer_info`](#customer-info) block supports the following:
122
-
123
- <a id="customer-info-additional-info"></a>&#x2022; [`additional_info`](#customer-info-additional-info) - Optional String<br>Additional Info. Use this field for any additional information about the new child tenant
124
-
125
- <a id="customer-info-email"></a>&#x2022; [`email`](#customer-info-email) - Optional String<br>Email
126
-
127
- <a id="customer-info-first-name"></a>&#x2022; [`first_name`](#customer-info-first-name) - Optional String<br>First Name
128
-
129
- <a id="customer-info-last-name"></a>&#x2022; [`last_name`](#customer-info-last-name) - Optional String<br>Last Name
130
-
131
- #### Tenant Profile
132
-
133
- <a id="objref-c0d099"></a>Uses standard [Object Reference](#common-object-reference) fields (name, namespace, tenant).
134
-
135
- #### Timeouts
136
-
137
- A [`timeouts`](#timeouts) block supports the following:
138
-
139
- <a id="timeouts-create"></a>&#x2022; [`create`](#timeouts-create) - Optional String (Defaults to `10 minutes`)<br>Used when creating the resource
140
-
141
- <a id="timeouts-delete"></a>&#x2022; [`delete`](#timeouts-delete) - Optional String (Defaults to `10 minutes`)<br>Used when deleting the resource
142
-
143
- <a id="timeouts-read"></a>&#x2022; [`read`](#timeouts-read) - Optional String (Defaults to `5 minutes`)<br>Used when retrieving the resource
144
-
145
- <a id="timeouts-update"></a>&#x2022; [`update`](#timeouts-update) - Optional String (Defaults to `10 minutes`)<br>Used when updating the resource
146
-
147
- ---
148
-
149
- ## Common Types
150
-
151
- The following type definitions are used throughout this resource. See the full definition here rather than repeated inline.
152
-
153
- ### Object Reference {#common-object-reference}
154
-
155
- Object references establish a direct reference from one configuration object to another in F5 Distributed Cloud. References use the format `tenant/namespace/name`.
156
-
157
- | Field | Type | Description |
158
- | ----- | ---- | ----------- |
159
- | `name` | String | Name of the referenced object |
160
- | `namespace` | String | Namespace containing the referenced object |
161
- | `tenant` | String | Tenant of the referenced object (system-managed) |
162
-
163
- ### Transformers {#common-transformers}
164
-
165
- Transformers apply transformations to input values before matching. Multiple transformers can be applied in order.
166
-
167
- | Value | Description |
168
- | ----- | ----------- |
169
- | `LOWER_CASE` | Convert to lowercase |
170
- | `UPPER_CASE` | Convert to uppercase |
171
- | `BASE64_DECODE` | Decode base64 content |
172
- | `NORMALIZE_PATH` | Normalize URL path |
173
- | `REMOVE_WHITESPACE` | Remove whitespace characters |
174
- | `URL_DECODE` | Decode URL-encoded characters |
175
- | `TRIM_LEFT` | Trim leading whitespace |
176
- | `TRIM_RIGHT` | Trim trailing whitespace |
177
- | `TRIM` | Trim both leading and trailing whitespace |
178
-
179
- ### HTTP Methods {#common-http-methods}
180
-
181
- HTTP methods used for request matching.
182
-
183
- | Value | Description |
184
- | ----- | ----------- |
185
- | `ANY` | Match any HTTP method |
186
- | `GET` | HTTP GET request |
187
- | `HEAD` | HTTP HEAD request |
188
- | `POST` | HTTP POST request |
189
- | `PUT` | HTTP PUT request |
190
- | `DELETE` | HTTP DELETE request |
191
- | `CONNECT` | HTTP CONNECT request |
192
- | `OPTIONS` | HTTP OPTIONS request |
193
- | `TRACE` | HTTP TRACE request |
194
- | `PATCH` | HTTP PATCH request |
195
- | `COPY` | HTTP COPY request (WebDAV) |
196
-
197
- ### TLS Fingerprints {#common-tls-fingerprints}
198
-
199
- TLS fingerprint categories for malicious client detection.
200
-
201
- | Value | Description |
202
- | ----- | ----------- |
203
- | `TLS_FINGERPRINT_NONE` | No fingerprint matching |
204
- | `ANY_MALICIOUS_FINGERPRINT` | Match any known malicious fingerprint |
205
- | `ADWARE` | Adware-associated fingerprints |
206
- | `DRIDEX` | Dridex malware fingerprints |
207
- | `GOOTKIT` | Gootkit malware fingerprints |
208
- | `RANSOMWARE` | Ransomware-associated fingerprints |
209
- | `TRICKBOT` | Trickbot malware fingerprints |
210
-
211
- ### IP Threat Categories {#common-ip-threat-categories}
212
-
213
- IP address threat categories for security filtering.
214
-
215
- | Value | Description |
216
- | ----- | ----------- |
217
- | `SPAM_SOURCES` | Known spam sources |
218
- | `WINDOWS_EXPLOITS` | Windows exploit sources |
219
- | `WEB_ATTACKS` | Web attack sources |
220
- | `BOTNETS` | Known botnet IPs |
221
- | `SCANNERS` | Network scanner IPs |
222
- | `REPUTATION` | Poor reputation IPs |
223
- | `PHISHING` | Phishing-related IPs |
224
- | `PROXY` | Anonymous proxy IPs |
225
- | `MOBILE_THREATS` | Mobile threat sources |
226
- | `TOR_PROXY` | Tor exit nodes |
227
- | `DENIAL_OF_SERVICE` | DoS attack sources |
228
- | `NETWORK` | Known bad network ranges |
229
-
230
- ## Import
231
-
232
- Import is supported using the following syntax:
233
-
234
- ```shell
235
- # Import using namespace/name format
236
- terraform import f5xc_child_tenant.example system/example
237
- ```