Aci macsec interface policy (DCNE-597)

docs/data-sources/macsec_interface_policy.md

@@ -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: "Access Policies"
+layout: "aci"
+page_title: "ACI: aci_macsec_interface_policy"
+sidebar_current: "docs-aci-data-source-aci_macsec_interface_policy"
+description: |-
+  Data source for ACI MACsec Interface Policy
+---
+
+# aci_macsec_interface_policy #
+
+Data source for ACI MACsec Interface Policy
+
+## API Information ##
+
+* Class: [macsecIfPol](https://pubhub.devnetcloud.com/media/model-doc-latest/docs/app/index.html#/objects/macsecIfPol/overview)
+
+* Supported in ACI versions: 3.1(1i) and later.
+
+* Distinguished Name Format: `uni/infra/macsecifp-{name}`
+
+## GUI Information ##
+
+* Location: `Fabric -> Access Policies -> Policies -> Interface -> MACSec -> Interfaces`
+
+## Example Usage ##
+
+```hcl
+
+data "aci_macsec_interface_policy" "example" {
+  name = "test_name"
+}
+
+```
+
+## Schema ##
+
+### Required ###
+
+* `name` (name) - (string) The name of the MACsec Interface Policy object.
+
+### Read-Only ###
+
+* `id` - (string) The distinguished name (DN) of the MACsec Interface Policy object.
+* `admin_state` (adminSt) - (string) The administrative state of the MACsec Interface Policy object.
+* `annotation` (annotation) - (string) The annotation of the MACsec Interface Policy object. This attribute is supported in ACI versions: 3.2(1l) and later.
+* `description` (descr) - (string) The description of the MACsec Interface Policy object.
+* `name_alias` (nameAlias) - (string) The name alias of the MACsec Interface Policy 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.
+* `relation_to_macsec_key_chain` - (map) A map of Relation To MACsec Key Chain (ACI object [macsecRsToKeyChainPol](https://pubhub.devnetcloud.com/media/model-doc-latest/docs/app/index.html#/objects/macsecRsToKeyChainPol/overview)) pointing to MACsec Key Chain (ACI Object [macsecKeyChainPol](https://pubhub.devnetcloud.com/media/model-doc-latest/docs/app/index.html#/objects/macsecKeyChainPol/overview)).
+    * `annotation` (annotation) - (string) The annotation of the Relation To MACsec Key Chain object. This attribute is supported in ACI versions: 3.2(1l) and later.
+    * `target_dn` (tDn) - (string) The distinguished name of the target.
+    * `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.
+* `relation_to_macsec_parameters` - (map) A map of Relation To MACsec Parameters (ACI object [macsecRsToParamPol](https://pubhub.devnetcloud.com/media/model-doc-latest/docs/app/index.html#/objects/macsecRsToParamPol/overview)) pointing to MACsec Parameters (ACI Object [macsecParamPol](https://pubhub.devnetcloud.com/media/model-doc-latest/docs/app/index.html#/objects/macsecParamPol/overview)).
+    * `annotation` (annotation) - (string) The annotation of the Relation To MACsec Parameters object. This attribute is supported in ACI versions: 3.2(1l) and later.
+    * `target_dn` (tDn) - (string) The distinguished name of the target.
+    * `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.
+* `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.

docs/data-sources/macsec_key.md

@@ -0,0 +1,69 @@
+---
+# 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: "Access Policies"
+layout: "aci"
+page_title: "ACI: aci_macsec_key"
+sidebar_current: "docs-aci-data-source-aci_macsec_key"
+description: |-
+  Data source for ACI MACsec Key
+---
+
+# aci_macsec_key #
+
+Data source for ACI MACsec Key
+
+## API Information ##
+
+* Class: [macsecKeyPol](https://pubhub.devnetcloud.com/media/model-doc-latest/docs/app/index.html#/objects/macsecKeyPol/overview)
+
+* Supported in ACI versions: 3.1(1i) and later.
+
+* Distinguished Name Formats:
+  - `uni/fabric/macsecpcontfab/keychainp-{name}/keyp-{keyName}`
+  - `uni/infra/macsecpcont/keychainp-{name}/keyp-{keyName}`
+
+## GUI Information ##
+
+* Locations:
+  - `Fabric -> Access Policies -> Policies -> Interface -> MACSec -> MACSec KeyChain Policies -> MACSec Key Policy`
+  - `Fabric -> Fabric Policies -> Policies -> MACSec -> MACSec KeyChain Policies -> MACSec Key Policy`
+
+## Example Usage ##
+
+```hcl
+
+data "aci_macsec_key" "example_macsec_key_chain" {
+  parent_dn = aci_macsec_key_chain.example.id
+  key_name  = "aa"
+}
+
+```
+
+## Schema ##
+
+### Required ###
+
+* `parent_dn` - (string) The distinguished name (DN) of the parent object, possible resources:
+  - [aci_macsec_key_chain](https://registry.terraform.io/providers/CiscoDevNet/aci/latest/docs/resources/macsec_key_chain) ([macsecKeyChainPol](https://pubhub.devnetcloud.com/media/model-doc-latest/docs/app/index.html#/objects/macsecKeyChainPol/overview))
+* `key_name` (keyName) - (string) The key name of the MACsec Key object.
+
+### Read-Only ###
+
+* `id` - (string) The distinguished name (DN) of the MACsec Key object.
+* `annotation` (annotation) - (string) The annotation of the MACsec Key object. This attribute is supported in ACI versions: 3.2(1l) and later.
+* `description` (descr) - (string) The description of the MACsec Key object.
+* `end_time` (endTime) - (string) The end time of the MACsec Key object. The default value cannot be used directly, since APIC will calculate this value to the datetime representation which results in a applied state that does not match the planned state. Do not provide this attribute when APIC should calculate the current datetime ('now'). Furthermore, make sure that the time-zone part (in the full example this is '-08:00') matches the time-zone configured on APIC. Providing a different time-zone will result in unexpected behaviour.
+* `name` (name) - (string) The name of the MACsec Key object.
+* `name_alias` (nameAlias) - (string) The name alias of the MACsec Key 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.
+* `pre_shared_key` (preSharedKey) - (string) The  pre-shared key of the MACsec Key object.
+* `start_time` (startTime) - (string) The start time of the MACsec Key object. Please make sure that the time-zone part (in the full example this is '-08:00') matches the time-zone configured on APIC. Providing a different time-zone will result in unexpected behaviour.
+* `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.

docs/data-sources/macsec_key_chain.md

@@ -0,0 +1,71 @@
+---
+# 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: "Access Policies"
+layout: "aci"
+page_title: "ACI: aci_macsec_key_chain"
+sidebar_current: "docs-aci-data-source-aci_macsec_key_chain"
+description: |-
+  Data source for ACI MACsec Key Chain
+---
+
+# aci_macsec_key_chain #
+
+Data source for ACI MACsec Key Chain
+
+## API Information ##
+
+* Class: [macsecKeyChainPol](https://pubhub.devnetcloud.com/media/model-doc-latest/docs/app/index.html#/objects/macsecKeyChainPol/overview)
+
+* Supported in ACI versions: 3.1(1i) and later.
+
+* Distinguished Name Formats:
+  - `uni/fabric/macsecpcontfab/keychainp-{name}`
+  - `uni/infra/macsecpcont/keychainp-{name}`
+
+## GUI Information ##
+
+* Locations:
+  - `Fabric -> Access Policies -> Policies -> Interface -> MACSec -> MACSec KeyChain Policies`
+  - `Fabric -> Fabric Policies -> Policies -> MACSec -> MACSec KeyChain Policies`
+
+## Example Usage ##
+
+```hcl
+
+data "aci_macsec_key_chain" "example" {
+  name = "test_name"
+}
+
+```
+
+## Schema ##
+
+### Required ###
+
+* `name` (name) - (string) The name of the MACsec Key Chain 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:
+    - [macsecFabPolCont](https://pubhub.devnetcloud.com/media/model-doc-latest/docs/app/index.html#/objects/macsecFabPolCont/overview)
+    - [macsecPolCont](https://pubhub.devnetcloud.com/media/model-doc-latest/docs/app/index.html#/objects/macsecPolCont/overview)
+
+  - Default: `uni/infra/macsecpcont`
+
+### Read-Only ###
+
+* `id` - (string) The distinguished name (DN) of the MACsec Key Chain object.
+* `annotation` (annotation) - (string) The annotation of the MACsec Key Chain object. This attribute is supported in ACI versions: 3.2(1l) and later.
+* `description` (descr) - (string) The description of the MACsec Key Chain object.
+* `name_alias` (nameAlias) - (string) The name alias of the MACsec Key Chain 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.

docs/data-sources/macsec_parameters.md

@@ -0,0 +1,63 @@
+---
+# 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: "Access Policies"
+layout: "aci"
+page_title: "ACI: aci_macsec_parameters"
+sidebar_current: "docs-aci-data-source-aci_macsec_parameters"
+description: |-
+  Data source for ACI MACsec Parameters
+---
+
+# aci_macsec_parameters #
+
+Data source for ACI MACsec Parameters
+
+## API Information ##
+
+* Class: [macsecParamPol](https://pubhub.devnetcloud.com/media/model-doc-latest/docs/app/index.html#/objects/macsecParamPol/overview)
+
+* Supported in ACI versions: 3.1(1i) and later.
+
+* Distinguished Name Format: `uni/infra/macsecpcont/paramp-{name}`
+
+## GUI Information ##
+
+* Location: `Fabric -> Access Policies -> Policies -> Interface -> MACSec -> Parameters`
+
+## Example Usage ##
+
+```hcl
+
+data "aci_macsec_parameters" "example" {
+  name = "test_name"
+}
+
+```
+
+## Schema ##
+
+### Required ###
+
+* `name` (name) - (string) The name of the MACsec Parameters object.
+
+### Read-Only ###
+
+* `id` - (string) The distinguished name (DN) of the MACsec Parameters object.
+* `annotation` (annotation) - (string) The annotation of the MACsec Parameters object. This attribute is supported in ACI versions: 3.2(1l) and later.
+* `cipher_suite` (cipherSuite) - (string) The cipher suite of the MACsec Parameters object.
+* `confidentiality_offset` (confOffset) - (string) The confidentiality offset in bytes of the MACsec Parameters object.
+* `description` (descr) - (string) The description of the MACsec Parameters object.
+* `key_server_priority` (keySvrPrio) - (string) The key server priority of the MACsec Parameters object. The value must be in the range 0 - 255.
+* `name_alias` (nameAlias) - (string) The name alias of the MACsec Parameters 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.
+* `window_size` (replayWindow) - (string) The replay protection window size of the MACsec Parameters object. The value must be in the range 0 - 4294967295.
+* `security_policy` (secPolicy) - (string) The security policy of the MACsec Parameters 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.