Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Addition of new generated resource and data source for pkiTP (DCNE-142 DCNE-143) #1145

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 4 additions & 2 deletions docs/data-sources/access_interface_override.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,13 +42,15 @@ data "aci_access_interface_override" "example" {

### Required ###

* `name` (name) - (string) The name of the Access Interface Override object.

### Optional ###

* `parent_dn` - (string) The distinguished name (DN) of the parent object, possible resources:
- The distinguished name (DN) of classes below can be used but currently there is no available resource for it:
- [infraInfra](https://pubhub.devnetcloud.com/media/model-doc-latest/docs/app/index.html#/objects/infraInfra/overview)

- Default: `uni/infra`

* `name` (name) - (string) The name of the Access Interface Override object.

### Read-Only ###

Expand Down
1 change: 0 additions & 1 deletion docs/data-sources/application_epg.md
Original file line number Diff line number Diff line change
Expand Up @@ -122,7 +122,6 @@ data "aci_application_epg" "example_application_profile" {
* `switching_mode` (switchingMode) - (string) The switching mode of the Relation To Domain object.
* `target_dn` (tDn) - (string) The distinguished name of the target Domain object.
* `untagged` (untagged) - (string) The untagged status of the Relation To Domain object.
* `vnet_only` (vnetOnly) - (string) The VNET only status of the Relation To Domain object.

* `relation_to_data_plane_policing_policy` - (list) A list of Relation To Data Plane Policing Policy (ACI object [fvRsDppPol](https://pubhub.devnetcloud.com/media/model-doc-latest/docs/app/index.html#/objects/fvRsDppPol/overview)) pointing to Data Plane Policing Policy (ACI Object [qosDppPol](https://pubhub.devnetcloud.com/media/model-doc-latest/docs/app/index.html#/objects/qosDppPol/overview)). This attribute is supported in ACI versions: 3.0(1k) and later.
* `annotation` (annotation) - (string) The annotation of the Relation To Data Plane Policing Policy object.
Expand Down
77 changes: 77 additions & 0 deletions docs/data-sources/certificate_authority.md
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 ACI Certificate Authority
---

# aci_certificate_authority #

Data source for 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 ##

```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.
6 changes: 4 additions & 2 deletions docs/data-sources/data_plane_policing_policy.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,14 +43,16 @@ data "aci_data_plane_policing_policy" "example_tenant" {

### Required ###

* `name` (name) - (string) The name of the Data Plane Policing Policy 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/tenant) ([fvTenant](https://pubhub.devnetcloud.com/media/model-doc-latest/docs/app/index.html#/objects/fvTenant/overview))
- The distinguished name (DN) of classes below can be used but currently there is no available resource for it:
- [infraInfra](https://pubhub.devnetcloud.com/media/model-doc-latest/docs/app/index.html#/objects/infraInfra/overview)

- Default: `uni/infra`

* `name` (name) - (string) The name of the Data Plane Policing Policy object.

### Read-Only ###

Expand Down
84 changes: 84 additions & 0 deletions docs/data-sources/key_ring.md
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 ACI Key Ring
---

# aci_key_ring #

Data source for ACI 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.
6 changes: 4 additions & 2 deletions docs/data-sources/netflow_monitor_policy.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,14 +45,16 @@ data "aci_netflow_monitor_policy" "example_tenant" {

### Required ###

* `name` (name) - (string) The name of the Netflow Monitor Policy 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/tenant) ([fvTenant](https://pubhub.devnetcloud.com/media/model-doc-latest/docs/app/index.html#/objects/fvTenant/overview))
- The distinguished name (DN) of classes below can be used but currently there is no available resource for it:
- [infraInfra](https://pubhub.devnetcloud.com/media/model-doc-latest/docs/app/index.html#/objects/infraInfra/overview)

- Default: `uni/infra`
shrsr marked this conversation as resolved.
Show resolved Hide resolved

* `name` (name) - (string) The name of the Netflow Monitor Policy object.

### Read-Only ###

Expand Down
6 changes: 4 additions & 2 deletions docs/data-sources/netflow_record_policy.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,14 +45,16 @@ data "aci_netflow_record_policy" "example_tenant" {

### Required ###

* `name` (name) - (string) The name of the Netflow Record Policy 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/tenant) ([fvTenant](https://pubhub.devnetcloud.com/media/model-doc-latest/docs/app/index.html#/objects/fvTenant/overview))
- The distinguished name (DN) of classes below can be used but currently there is no available resource for it:
- [infraInfra](https://pubhub.devnetcloud.com/media/model-doc-latest/docs/app/index.html#/objects/infraInfra/overview)

- Default: `uni/infra`

* `name` (name) - (string) The name of the Netflow Record Policy object.

### Read-Only ###

Expand Down
1 change: 0 additions & 1 deletion docs/data-sources/relation_to_domain.md
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,6 @@ data "aci_relation_to_domain" "example_application_epg" {
* `secondary_encapsulation_inner` (secondaryEncapInner) - (string) The secondary inner encapsulation of the Relation To Domain object. This is used for the portgroup at the VMWare Distributed Virtual Switch (DVS). This VLAN is internal to the DVS and is used for communication between the other VMs and the AVE VM at a host. Traffic is not forwarded to the fabric over the VLAN. Only applicable for Cisco ACI Virtual Edge (AVE) domains.
* `switching_mode` (switchingMode) - (string) The switching mode of the Relation To Domain object.
* `untagged` (untagged) - (string) The untagged status of the Relation To Domain object.
* `vnet_only` (vnetOnly) - (string) The VNET only status of the Relation To Domain 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.
Expand Down
4 changes: 0 additions & 4 deletions docs/resources/application_epg.md
Original file line number Diff line number Diff line change
Expand Up @@ -134,7 +134,6 @@ resource "aci_application_epg" "full_example_application_profile" {
switching_mode = "AVE"
target_dn = "uni/vmmp-VMware/dom-domain_1"
untagged = "no"
vnet_only = "no"
}
]
relation_to_data_plane_policing_policy = [
Expand Down Expand Up @@ -414,9 +413,6 @@ All examples for the Application EPG resource can be found in the [examples](htt
* `untagged` (untagged) - (string) The untagged status of the Relation To Domain object.
- Default: `no`
- Valid Values: `no`, `yes`.
* `vnet_only` (vnetOnly) - (string) The VNET only status of the Relation To Domain object.
- Default: `no`
- Valid Values: `no`, `yes`.

* `relation_to_data_plane_policing_policy` - (list) A list of Relation To Data Plane Policing Policy (ACI object [fvRsDppPol](https://pubhub.devnetcloud.com/media/model-doc-latest/docs/app/index.html#/objects/fvRsDppPol/overview)) pointing to Data Plane Policing Policy (ACI Object [qosDppPol](https://pubhub.devnetcloud.com/media/model-doc-latest/docs/app/index.html#/objects/qosDppPol/overview)) which can be configured using the [aci_data_plane_policing_policy](https://registry.terraform.io/providers/CiscoDevNet/aci/latest/docs/resources/data_plane_policing_policy) resource. This attribute is supported in ACI versions: 3.0(1k) and later.
- Max Items: 1
Expand Down
Loading
Loading