-
Notifications
You must be signed in to change notification settings - Fork 98
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[minor_change] Addition of new generated resource and data source for…
… pkiTP
- Loading branch information
Showing
101 changed files
with
10,301 additions
and
368 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,77 @@ | ||
--- | ||
# Documentation generated by "gen/generator.go"; DO NOT EDIT. | ||
# In order to regenerate this file execute `go generate` from the repository root. | ||
# More details can be found in the [README](https://github.com/CiscoDevNet/terraform-provider-aci/blob/master/README.md). | ||
subcategory: "AAA" | ||
layout: "aci" | ||
page_title: "ACI: aci_certificate_authority" | ||
sidebar_current: "docs-aci-data-source-aci_certificate_authority" | ||
description: |- | ||
Data source for Certificate Authority | ||
--- | ||
|
||
# aci_certificate_authority # | ||
|
||
Data source for Certificate Authority | ||
|
||
## API Information ## | ||
|
||
* Class: [pkiTP](https://pubhub.devnetcloud.com/media/model-doc-latest/docs/app/index.html#/objects/pkiTP/overview) | ||
|
||
* Supported in ACI versions: 1.0(1e) and later. | ||
|
||
* Distinguished Name Formats: | ||
- `uni/tn-{name}/certstore/tp-{name}` | ||
- `uni/userext/pkiext/tp-{name}` | ||
|
||
## GUI Information ## | ||
|
||
* Locations: | ||
- `Admin -> AAA -> Security -> Certificate Authorities` | ||
- `Cloud Network Controller -> Administrative -> Security -> Certificate Authorities` | ||
|
||
## Example Usage ## | ||
|
||
```hcl | ||
data "aci_certificate_authority" "example" { | ||
name = "test_name" | ||
} | ||
// This example is only applicable to Cisco Cloud Network Controller | ||
data "aci_certificate_authority" "example_tenant" { | ||
parent_dn = aci_tenant.example.id | ||
name = "test_name" | ||
} | ||
``` | ||
|
||
## Schema ## | ||
|
||
### Required ### | ||
|
||
* `name` (name) - (string) The name of the Certificate Authority object. | ||
|
||
### Optional ### | ||
|
||
* `parent_dn` - (string) The distinguished name (DN) of the parent object, possible resources: | ||
- [aci_tenant](https://registry.terraform.io/providers/CiscoDevNet/aci/latest/docs/resources/fvTenant) ([fvTenant](https://pubhub.devnetcloud.com/media/model-doc-latest/docs/app/index.html#/objects/fvTenant/overview)) | ||
- Default: `uni/userext/pkiext` | ||
|
||
### Read-Only ### | ||
|
||
* `id` - (string) The distinguished name (DN) of the Certificate Authority object. | ||
* `annotation` (annotation) - (string) The annotation of the Certificate Authority object. | ||
* `certificate_chain` (certChain) - (string) The PEM-encoded chain of trust from the trustpoint to a trusted root authority. | ||
* `description` (descr) - (string) The description of the Certificate Authority object. | ||
* `name_alias` (nameAlias) - (string) The name alias of the Certificate Authority object. | ||
* `owner_key` (ownerKey) - (string) The key for enabling clients to own their data for entity correlation. | ||
* `owner_tag` (ownerTag) - (string) A tag for enabling clients to add their own data. For example, to indicate who created this object. | ||
|
||
* `annotations` - (list) A list of Annotations (ACI object [tagAnnotation](https://pubhub.devnetcloud.com/media/model-doc-latest/docs/app/index.html#/objects/tagAnnotation/overview)). This attribute is supported in ACI versions: 3.2(1l) and later. | ||
* `key` (key) - (string) The key used to uniquely identify this configuration object. | ||
* `value` (value) - (string) The value of the property. | ||
|
||
* `tags` - (list) A list of Tags (ACI object [tagTag](https://pubhub.devnetcloud.com/media/model-doc-latest/docs/app/index.html#/objects/tagTag/overview)). This attribute is supported in ACI versions: 3.2(1l) and later. | ||
* `key` (key) - (string) The key used to uniquely identify this configuration object. | ||
* `value` (value) - (string) The value of the property. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,84 @@ | ||
--- | ||
# Documentation generated by "gen/generator.go"; DO NOT EDIT. | ||
# In order to regenerate this file execute `go generate` from the repository root. | ||
# More details can be found in the [README](https://github.com/CiscoDevNet/terraform-provider-aci/blob/master/README.md). | ||
subcategory: "AAA" | ||
layout: "aci" | ||
page_title: "ACI: aci_key_ring" | ||
sidebar_current: "docs-aci-data-source-aci_key_ring" | ||
description: |- | ||
Data source for Key Ring | ||
--- | ||
|
||
# aci_key_ring # | ||
|
||
Data source for Key Ring | ||
|
||
## API Information ## | ||
|
||
* Class: [pkiKeyRing](https://pubhub.devnetcloud.com/media/model-doc-latest/docs/app/index.html#/objects/pkiKeyRing/overview) | ||
|
||
* Supported in ACI versions: 1.0(1e) and later. | ||
|
||
* Distinguished Name Formats: | ||
- `uni/tn-{name}/certstore/keyring-{name}` | ||
- `uni/userext/pkiext/keyring-{name}` | ||
|
||
## GUI Information ## | ||
|
||
* Locations: | ||
- `Admin -> AAA -> Security -> Key Rings` | ||
- `Cloud Network Controller -> Administrative -> Security -> Key Rings` | ||
|
||
## Example Usage ## | ||
|
||
```hcl | ||
data "aci_key_ring" "example" { | ||
name = "test_name" | ||
} | ||
// This example is only applicable to Cisco Cloud Network Controller | ||
data "aci_key_ring" "example_tenant" { | ||
parent_dn = aci_tenant.example.id | ||
name = "test_name" | ||
} | ||
``` | ||
|
||
## Schema ## | ||
|
||
### Required ### | ||
|
||
* `name` (name) - (string) The name of the Key Ring object. | ||
|
||
### Optional ### | ||
|
||
* `parent_dn` - (string) The distinguished name (DN) of the parent object, possible resources: | ||
- [aci_tenant](https://registry.terraform.io/providers/CiscoDevNet/aci/latest/docs/resources/fvTenant) ([fvTenant](https://pubhub.devnetcloud.com/media/model-doc-latest/docs/app/index.html#/objects/fvTenant/overview)) | ||
- Default: `uni/userext/pkiext` | ||
|
||
### Read-Only ### | ||
|
||
* `id` - (string) The distinguished name (DN) of the Key Ring object. | ||
* `admin_state` (adminState) - (string) The current administrative state of the certificate request process. | ||
* `annotation` (annotation) - (string) The annotation of the Key Ring object. | ||
* `certificate` (cert) - (string) A certificate is a file containing a device's public key along with signed information verifying the identity of the device. | ||
* `description` (descr) - (string) The description of the Key Ring object. | ||
* `elliptic_curve` (eccCurve) - (string) The elliptic curve used by the provided key. | ||
* `key` (key) - (string) The private key of the certificate. This sensitive value is excluded from the resource's lifecycle configuration and is not tracked by Terraform. | ||
* `key_type` (keyType) - (string) The type used by the provided key. | ||
* `modulus` (modulus) - (string) The length of the encryption keys. A longer key length increases the difficulty of breaking the key. | ||
* `name_alias` (nameAlias) - (string) The name alias of the Key Ring object. | ||
* `owner_key` (ownerKey) - (string) The key for enabling clients to own their data for entity correlation. | ||
* `owner_tag` (ownerTag) - (string) A tag for enabling clients to add their own data. For example, to indicate who created this object. | ||
* `regenerate` (regen) - (string) Forces regeneration of the keypair. Each PKI device holds a pair of asymmetric Rivest-Shamir-Adleman (RSA) or Elliptic Curve Cryptography (ECC) encryption keys, one kept private and one made public, stored in an internal key ring. | ||
* `certificate_authority` (tp) - (string) A third-party certificate from a trusted source, or trusted point, that affirms the identity of your device. The third-party certificate is signed by the issuing certificate authority (CA or trustpoint), which can be a root CA, an intermediate CA, or a trust anchor that is part of a trust chain that leads to a root CA. | ||
|
||
* `annotations` - (list) A list of Annotations (ACI object [tagAnnotation](https://pubhub.devnetcloud.com/media/model-doc-latest/docs/app/index.html#/objects/tagAnnotation/overview)). This attribute is supported in ACI versions: 3.2(1l) and later. | ||
* `key` (key) - (string) The key used to uniquely identify this configuration object. | ||
* `value` (value) - (string) The value of the property. | ||
|
||
* `tags` - (list) A list of Tags (ACI object [tagTag](https://pubhub.devnetcloud.com/media/model-doc-latest/docs/app/index.html#/objects/tagTag/overview)). This attribute is supported in ACI versions: 3.2(1l) and later. | ||
* `key` (key) - (string) The key used to uniquely identify this configuration object. | ||
* `value` (value) - (string) The value of the property. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,223 @@ | ||
--- | ||
# Documentation generated by "gen/generator.go"; DO NOT EDIT. | ||
# In order to regenerate this file execute `go generate` from the repository root. | ||
# More details can be found in the [README](https://github.com/CiscoDevNet/terraform-provider-aci/blob/master/README.md). | ||
subcategory: "AAA" | ||
layout: "aci" | ||
page_title: "ACI: aci_certificate_authority" | ||
sidebar_current: "docs-aci-resource-aci_certificate_authority" | ||
description: |- | ||
Manages ACI Certificate Authority | ||
--- | ||
|
||
# aci_certificate_authority # | ||
|
||
Manages ACI Certificate Authority | ||
|
||
|
||
|
||
## API Information ## | ||
|
||
* Class: [pkiTP](https://pubhub.devnetcloud.com/media/model-doc-latest/docs/app/index.html#/objects/pkiTP/overview) | ||
|
||
* Supported in ACI versions: 1.0(1e) and later. | ||
|
||
* Distinguished Name Formats: | ||
- `uni/tn-{name}/certstore/tp-{name}` | ||
- `uni/userext/pkiext/tp-{name}` | ||
|
||
## GUI Information ## | ||
|
||
* Locations: | ||
- `Admin -> AAA -> Security -> Certificate Authorities` | ||
- `Cloud Network Controller -> Administrative -> Security -> Certificate Authorities` | ||
|
||
## Example Usage ## | ||
|
||
The configuration snippet below creates a Certificate Authority with only required attributes. | ||
|
||
```hcl | ||
resource "aci_certificate_authority" "example" { | ||
certificate_chain = <<EOT | ||
-----BEGIN CERTIFICATE----- | ||
MIICODCCAaGgAwIBAgIJAIt8XMntue0VMA0GCSqGSIb3DQEBCwUAMDQxDjAMBgNV | ||
BAMMBUFkbWluMRUwEwYDVQQKDAxZb3VyIENvbXBhbnkxCzAJBgNVBAYTAlVTMCAX | ||
DTE4MDEwOTAwNTk0NFoYDzIxMTcxMjE2MDA1OTQ0WjA0MQ4wDAYDVQQDDAVBZG1p | ||
bjEVMBMGA1UECgwMWW91ciBDb21wYW55MQswCQYDVQQGEwJVUzCBnzANBgkqhkiG | ||
9w0BAQEFAAOBjQAwgYkCgYEAohG/7axtt7CbSaMP7r+2mhTKbNgh0Ww36C7Ta14i | ||
v+VmLyKkQHnXinKGhp6uy3Nug+15a+eIu7CrgpBVMQeCiWfsnwRocKcQJWIYDrWl | ||
XHxGQn31yYKR6mylE7Dcj3rMFybnyhezr5D8GcP85YRPmwG9H2hO/0Y1FUnWu9Iw | ||
AQkCAwEAAaNQME4wHQYDVR0OBBYEFD0jLXfpkrU/ChzRvfruRs/fy1VXMB8GA1Ud | ||
IwQYMBaAFD0jLXfpkrU/ChzRvfruRs/fy1VXMAwGA1UdEwQFMAMBAf8wDQYJKoZI | ||
hvcNAQELBQADgYEAOmvre+5tgZ0+F3DgsfxNQqLTrGiBgGCIymPkP/cBXXkNuJyl | ||
3ac7tArHQc7WEA4U2R2rZbEq8FC3UJJm4nUVtCPvEh3G9OhN2xwYev79yt6pIn/l | ||
KU0Td2OpVyo0eLqjoX5u2G90IBWzhyjFbo+CcKMrSVKj1YOdG0E3OuiJf00= | ||
-----END CERTIFICATE----- | ||
EOT | ||
name = "test_name" | ||
} | ||
// This example is only applicable to Cisco Cloud Network Controller | ||
resource "aci_certificate_authority" "example_tenant" { | ||
parent_dn = aci_tenant.example.id | ||
certificate_chain = <<EOT | ||
-----BEGIN CERTIFICATE----- | ||
MIICODCCAaGgAwIBAgIJAIt8XMntue0VMA0GCSqGSIb3DQEBCwUAMDQxDjAMBgNV | ||
BAMMBUFkbWluMRUwEwYDVQQKDAxZb3VyIENvbXBhbnkxCzAJBgNVBAYTAlVTMCAX | ||
DTE4MDEwOTAwNTk0NFoYDzIxMTcxMjE2MDA1OTQ0WjA0MQ4wDAYDVQQDDAVBZG1p | ||
bjEVMBMGA1UECgwMWW91ciBDb21wYW55MQswCQYDVQQGEwJVUzCBnzANBgkqhkiG | ||
9w0BAQEFAAOBjQAwgYkCgYEAohG/7axtt7CbSaMP7r+2mhTKbNgh0Ww36C7Ta14i | ||
v+VmLyKkQHnXinKGhp6uy3Nug+15a+eIu7CrgpBVMQeCiWfsnwRocKcQJWIYDrWl | ||
XHxGQn31yYKR6mylE7Dcj3rMFybnyhezr5D8GcP85YRPmwG9H2hO/0Y1FUnWu9Iw | ||
AQkCAwEAAaNQME4wHQYDVR0OBBYEFD0jLXfpkrU/ChzRvfruRs/fy1VXMB8GA1Ud | ||
IwQYMBaAFD0jLXfpkrU/ChzRvfruRs/fy1VXMAwGA1UdEwQFMAMBAf8wDQYJKoZI | ||
hvcNAQELBQADgYEAOmvre+5tgZ0+F3DgsfxNQqLTrGiBgGCIymPkP/cBXXkNuJyl | ||
3ac7tArHQc7WEA4U2R2rZbEq8FC3UJJm4nUVtCPvEh3G9OhN2xwYev79yt6pIn/l | ||
KU0Td2OpVyo0eLqjoX5u2G90IBWzhyjFbo+CcKMrSVKj1YOdG0E3OuiJf00= | ||
-----END CERTIFICATE----- | ||
EOT | ||
name = "test_name" | ||
} | ||
``` | ||
The configuration snippet below shows all possible attributes of the Certificate Authority. | ||
|
||
!> This example might not be valid configuration and is only used to show all possible attributes. | ||
|
||
```hcl | ||
resource "aci_certificate_authority" "full_example" { | ||
annotation = "annotation" | ||
certificate_chain = <<EOT | ||
-----BEGIN CERTIFICATE----- | ||
MIICODCCAaGgAwIBAgIJAIt8XMntue0VMA0GCSqGSIb3DQEBCwUAMDQxDjAMBgNV | ||
BAMMBUFkbWluMRUwEwYDVQQKDAxZb3VyIENvbXBhbnkxCzAJBgNVBAYTAlVTMCAX | ||
DTE4MDEwOTAwNTk0NFoYDzIxMTcxMjE2MDA1OTQ0WjA0MQ4wDAYDVQQDDAVBZG1p | ||
bjEVMBMGA1UECgwMWW91ciBDb21wYW55MQswCQYDVQQGEwJVUzCBnzANBgkqhkiG | ||
9w0BAQEFAAOBjQAwgYkCgYEAohG/7axtt7CbSaMP7r+2mhTKbNgh0Ww36C7Ta14i | ||
v+VmLyKkQHnXinKGhp6uy3Nug+15a+eIu7CrgpBVMQeCiWfsnwRocKcQJWIYDrWl | ||
XHxGQn31yYKR6mylE7Dcj3rMFybnyhezr5D8GcP85YRPmwG9H2hO/0Y1FUnWu9Iw | ||
AQkCAwEAAaNQME4wHQYDVR0OBBYEFD0jLXfpkrU/ChzRvfruRs/fy1VXMB8GA1Ud | ||
IwQYMBaAFD0jLXfpkrU/ChzRvfruRs/fy1VXMAwGA1UdEwQFMAMBAf8wDQYJKoZI | ||
hvcNAQELBQADgYEAOmvre+5tgZ0+F3DgsfxNQqLTrGiBgGCIymPkP/cBXXkNuJyl | ||
3ac7tArHQc7WEA4U2R2rZbEq8FC3UJJm4nUVtCPvEh3G9OhN2xwYev79yt6pIn/l | ||
KU0Td2OpVyo0eLqjoX5u2G90IBWzhyjFbo+CcKMrSVKj1YOdG0E3OuiJf00= | ||
-----END CERTIFICATE----- | ||
EOT | ||
description = "description" | ||
name = "test_name" | ||
name_alias = "name_alias" | ||
owner_key = "owner_key" | ||
owner_tag = "owner_tag" | ||
annotations = [ | ||
{ | ||
key = "key_0" | ||
value = "value_1" | ||
} | ||
] | ||
tags = [ | ||
{ | ||
key = "key_0" | ||
value = "value_1" | ||
} | ||
] | ||
} | ||
// This example is only applicable to Cisco Cloud Network Controller | ||
resource "aci_certificate_authority" "full_example_tenant" { | ||
parent_dn = aci_tenant.example.id | ||
annotation = "annotation" | ||
certificate_chain = <<EOT | ||
-----BEGIN CERTIFICATE----- | ||
MIICODCCAaGgAwIBAgIJAIt8XMntue0VMA0GCSqGSIb3DQEBCwUAMDQxDjAMBgNV | ||
BAMMBUFkbWluMRUwEwYDVQQKDAxZb3VyIENvbXBhbnkxCzAJBgNVBAYTAlVTMCAX | ||
DTE4MDEwOTAwNTk0NFoYDzIxMTcxMjE2MDA1OTQ0WjA0MQ4wDAYDVQQDDAVBZG1p | ||
bjEVMBMGA1UECgwMWW91ciBDb21wYW55MQswCQYDVQQGEwJVUzCBnzANBgkqhkiG | ||
9w0BAQEFAAOBjQAwgYkCgYEAohG/7axtt7CbSaMP7r+2mhTKbNgh0Ww36C7Ta14i | ||
v+VmLyKkQHnXinKGhp6uy3Nug+15a+eIu7CrgpBVMQeCiWfsnwRocKcQJWIYDrWl | ||
XHxGQn31yYKR6mylE7Dcj3rMFybnyhezr5D8GcP85YRPmwG9H2hO/0Y1FUnWu9Iw | ||
AQkCAwEAAaNQME4wHQYDVR0OBBYEFD0jLXfpkrU/ChzRvfruRs/fy1VXMB8GA1Ud | ||
IwQYMBaAFD0jLXfpkrU/ChzRvfruRs/fy1VXMAwGA1UdEwQFMAMBAf8wDQYJKoZI | ||
hvcNAQELBQADgYEAOmvre+5tgZ0+F3DgsfxNQqLTrGiBgGCIymPkP/cBXXkNuJyl | ||
3ac7tArHQc7WEA4U2R2rZbEq8FC3UJJm4nUVtCPvEh3G9OhN2xwYev79yt6pIn/l | ||
KU0Td2OpVyo0eLqjoX5u2G90IBWzhyjFbo+CcKMrSVKj1YOdG0E3OuiJf00= | ||
-----END CERTIFICATE----- | ||
EOT | ||
description = "description" | ||
name = "test_name" | ||
name_alias = "name_alias" | ||
owner_key = "owner_key" | ||
owner_tag = "owner_tag" | ||
annotations = [ | ||
{ | ||
key = "key_0" | ||
value = "value_1" | ||
} | ||
] | ||
tags = [ | ||
{ | ||
key = "key_0" | ||
value = "value_1" | ||
} | ||
] | ||
} | ||
``` | ||
|
||
All examples for the Certificate Authority resource can be found in the [examples](https://github.com/CiscoDevNet/terraform-provider-aci/tree/master/examples/resources/aci_certificate_authority) folder. | ||
|
||
## Schema ## | ||
|
||
### Required ### | ||
|
||
* `certificate_chain` (certChain) - (string) The PEM-encoded chain of trust from the trustpoint to a trusted root authority. | ||
* `name` (name) - (string) The name of the Certificate Authority object. | ||
|
||
### Read-Only ### | ||
|
||
* `id` - (string) The distinguished name (DN) of the Certificate Authority object. | ||
|
||
### Optional ### | ||
* `parent_dn` - (string) The distinguished name (DN) of the parent object, possible resources: | ||
- [aci_tenant](https://registry.terraform.io/providers/CiscoDevNet/aci/latest/docs/resources/fvTenant) ([fvTenant](https://pubhub.devnetcloud.com/media/model-doc-latest/docs/app/index.html#/objects/fvTenant/overview)) | ||
- Default: `uni/userext/pkiext` | ||
|
||
* `annotation` (annotation) - (string) The annotation of the Certificate Authority object. | ||
- Default: `orchestrator:terraform` | ||
* `description` (descr) - (string) The description of the Certificate Authority object. | ||
* `name_alias` (nameAlias) - (string) The name alias of the Certificate Authority object. | ||
* `owner_key` (ownerKey) - (string) The key for enabling clients to own their data for entity correlation. | ||
* `owner_tag` (ownerTag) - (string) A tag for enabling clients to add their own data. For example, to indicate who created this object. | ||
|
||
* `annotations` - (list) A list of Annotations (ACI object [tagAnnotation](https://pubhub.devnetcloud.com/media/model-doc-latest/docs/app/index.html#/objects/tagAnnotation/overview)). Annotations can also be configured using a separate [aci_annotation](https://registry.terraform.io/providers/CiscoDevNet/aci/latest/docs/resources/annotation) resource. This attribute is supported in ACI versions: 3.2(1l) and later. | ||
|
||
#### Required #### | ||
|
||
* `key` (key) - (string) The key used to uniquely identify this configuration object. | ||
* `value` (value) - (string) The value of the property. | ||
|
||
* `tags` - (list) A list of Tags (ACI object [tagTag](https://pubhub.devnetcloud.com/media/model-doc-latest/docs/app/index.html#/objects/tagTag/overview)). Tags can also be configured using a separate [aci_tag](https://registry.terraform.io/providers/CiscoDevNet/aci/latest/docs/resources/tag) resource. This attribute is supported in ACI versions: 3.2(1l) and later. | ||
|
||
#### Required #### | ||
|
||
* `key` (key) - (string) The key used to uniquely identify this configuration object. | ||
* `value` (value) - (string) The value of the property. | ||
|
||
## Importing | ||
|
||
An existing Certificate Authority can be [imported](https://www.terraform.io/docs/import/index.html) into this resource with its distinguished name (DN), via the following command: | ||
|
||
``` | ||
terraform import aci_certificate_authority.example uni/userext/pkiext/tp-{name} | ||
``` | ||
|
||
Starting in Terraform version 1.5, an existing Certificate Authority can be imported | ||
using [import blocks](https://developer.hashicorp.com/terraform/language/import) via the following configuration: | ||
|
||
``` | ||
import { | ||
id = "uni/userext/pkiext/tp-{name}" | ||
to = aci_certificate_authority.example | ||
} | ||
``` |
Oops, something went wrong.