[minor_change] Add support for storm control access policy with resource aci_storm_control_interface_policy (DCNE-623)

docs/data-sources/storm_control_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_storm_control_interface_policy"
+sidebar_current: "docs-aci-data-source-aci_storm_control_interface_policy"
+description: |-
+  Data source for ACI Storm Control Interface Policy
+---
+
+# aci_storm_control_interface_policy #
+
+Data source for ACI Storm Control Interface Policy
+
+## API Information ##
+
+* Class: [stormctrlIfPol](https://pubhub.devnetcloud.com/media/model-doc-latest/docs/app/index.html#/objects/stormctrlIfPol/overview)
+
+* Supported in ACI versions: 1.0(2j) and later.
+
+* Distinguished Name Format: `uni/infra/stormctrlifp-{name}`
+
+## GUI Information ##
+
+* Location: `Fabric -> Access Policies -> Policies -> Interface -> Storm Control`
+
+## Example Usage ##
+
+```hcl
+
+data "aci_storm_control_interface_policy" "example" {
+  name = "test_name"
+}
+
+```
+
+## Schema ##
+
+### Required ###
+
+* `name` (name) - (string) The name of the Storm Control Interface Policy object.
+
+### Read-Only ###
+
+* `id` - (string) The distinguished name (DN) of the Storm Control Interface Policy object.
+* `annotation` (annotation) - (string) The annotation of the Storm Control Interface Policy object. This attribute is supported in ACI versions: 3.2(1l) and later.
+* `broadcast_burst_rate_packets_per_second` (bcBurstPps) - (string) The broadcast burst interval rate in packets per second for the Storm Control Interface Policy object. This attribute is supported in ACI versions: 2.3(1e) and later.
+* `broadcast_burst_rate_percentage` (bcBurstRate) - (string) The broadcast burst rate in percentage for the Storm Control Interface Policy object. This attribute is supported in ACI versions: 2.3(1e) and later.
+* `broadcast_rate_percentage` (bcRate) - (string) The broadcast rate in percentage for the Storm Control Interface Policy object. This attribute is supported in ACI versions: 2.3(1e) and later.
+* `broadcast_rate_packets_per_second` (bcRatePps) - (string) The broadcast rate in packets per second for the Storm Control Interface Policy object. This attribute is supported in ACI versions: 2.3(1e) and later.
+* `burst_rate_packets_per_second` (burstPps) - (string) The burst interval rate in packets per second for the Storm Control Interface Policy object.
+* `burst_rate_percentage` (burstRate) - (string) The burst rate in percentage for the Storm Control Interface Policy object.
+* `description` (descr) - (string) The description of the Storm Control Interface Policy object.
+* `unicast_multicast_broadcast` (isUcMcBcStormPktCfgValid) - (string) Configure the Storm Control Interface Policy object for unicast, multicast, and broadcast. Use 'Valid' when enabling the object for unicast, multicast, and broadcast. This attribute is supported in ACI versions: 2.3(1e) and later.
+* `multicast_burst_rate_packets_per_second` (mcBurstPps) - (string) The multicast burst interval rate in packets per second for the Storm Control Interface Policy object. This attribute is supported in ACI versions: 2.3(1e) and later.
+* `multicast_burst_rate_percentage` (mcBurstRate) - (string) The multicast burst rate in percentage for the Storm Control Interface Policy object. This attribute is supported in ACI versions: 2.3(1e) and later.
+* `multicast_rate_percentage` (mcRate) - (string) The multicast rate in percentage for the Storm Control Interface Policy object. This attribute is supported in ACI versions: 2.3(1e) and later.
+* `multicast_rate_packets_per_second` (mcRatePps) - (string) The multicast rate in packets per second for the Storm Control Interface Policy object. This attribute is supported in ACI versions: 2.3(1e) and later.
+* `name_alias` (nameAlias) - (string) The name alias of the Storm Control Interface Policy object. This attribute is supported in ACI versions: 2.2(1k) and later.
+* `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.
+* `rate_percentage` (rate) - (string) The rate in percentage for the Storm Control Interface Policy object.
+* `rate_packets_per_second` (ratePps) - (string) The rate in packets per second for the Storm Control Interface Policy object.
+* `action` (stormCtrlAction) - (string) The action of the Storm Control Interface Policy object. The value must be in the range 3 - 10. This attribute is supported in ACI versions: 4.1(1i) and later.
+* `soak_count` (stormCtrlSoakInstCount) - (string) The soak count for the Storm Control Interface Policy object. This attribute is supported in ACI versions: 4.1(1i) and later.
+* `unicast_burst_rate_packets_per_second` (uucBurstPps) - (string) The unicast burst interval rate in packets per second for the Storm Control Interface Policy object. This attribute is supported in ACI versions: 2.3(1e) and later.
+* `unicast_burst_rate_percentage` (uucBurstRate) - (string) The unicast burst rate in percentage for the Storm Control Interface Policy object. This attribute is supported in ACI versions: 2.3(1e) and later.
+* `unicast_rate_percentage` (uucRate) - (string) The unicast rate in percentage for the Storm Control Interface Policy object. This attribute is supported in ACI versions: 2.3(1e) and later.
+* `unicast_rate_packets_per_second` (uucRatePps) - (string) The unicast rate in packets per second for the Storm Control Interface Policy object. This attribute is supported in ACI versions: 2.3(1e) and later.
+* `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/resources/storm_control_interface_policy.md

@@ -0,0 +1,217 @@
+---
+# 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_storm_control_interface_policy"
+sidebar_current: "docs-aci-resource-aci_storm_control_interface_policy"
+description: |-
+  Manages ACI Storm Control Interface Policy
+---
+
+# aci_storm_control_interface_policy #
+
+Manages ACI Storm Control Interface Policy
+
+
+
+## API Information ##
+
+* Class: [stormctrlIfPol](https://pubhub.devnetcloud.com/media/model-doc-latest/docs/app/index.html#/objects/stormctrlIfPol/overview)
+
+* Supported in ACI versions: 1.0(2j) and later.
+
+* Distinguished Name Format: `uni/infra/stormctrlifp-{name}`
+
+## GUI Information ##
+
+* Location: `Fabric -> Access Policies -> Policies -> Interface -> Storm Control`
+
+## Example Usage ##
+
+The configuration snippet below creates a Storm Control Interface Policy with only required attributes.
+
+```hcl
+
+resource "aci_storm_control_interface_policy" "example" {
+  name = "test_name"
+}
+
+```
+The configuration snippet below shows all possible attributes of the Storm Control Interface Policy.
+
+!> This example might not be valid configuration and is only used to show all possible attributes.
+
+```hcl
+
+resource "aci_storm_control_interface_policy" "full_example" {
+  annotation                              = "annotation"
+  broadcast_burst_rate_packets_per_second = "11"
+  broadcast_burst_rate_percentage         = "100.000000"
+  broadcast_rate_percentage               = "100.000000"
+  broadcast_rate_packets_per_second       = "10"
+  burst_rate_packets_per_second           = "unspecified"
+  burst_rate_percentage                   = "100.000000"
+  description                             = "description_1"
+  unicast_multicast_broadcast             = "Valid"
+  multicast_burst_rate_packets_per_second = "13"
+  multicast_burst_rate_percentage         = "100.000000"
+  multicast_rate_percentage               = "100.000000"
+  multicast_rate_packets_per_second       = "12"
+  name                                    = "test_name"
+  name_alias                              = "name_alias_1"
+  owner_key                               = "owner_key_1"
+  owner_tag                               = "owner_tag_1"
+  rate_percentage                         = "100.000000"
+  rate_packets_per_second                 = "unspecified"
+  action                                  = "drop"
+  soak_count                              = "3"
+  unicast_burst_rate_packets_per_second   = "15"
+  unicast_burst_rate_percentage           = "100.000000"
+  unicast_rate_percentage                 = "100.000000"
+  unicast_rate_packets_per_second         = "14"
+  annotations = [
+    {
+      key   = "key_0"
+      value = "value_1"
+    }
+  ]
+  tags = [
+    {
+      key   = "key_0"
+      value = "value_1"
+    }
+  ]
+}
+
+```
+
+All examples for the Storm Control Interface Policy resource can be found in the [examples](https://github.com/CiscoDevNet/terraform-provider-aci/tree/master/examples/resources/aci_storm_control_interface_policy) folder.
+
+## Schema ##
+
+### Required ###
+
+* `name` (name) - (string) The name of the Storm Control Interface Policy object.
+
+### Read-Only ###
+
+* `id` - (string) The distinguished name (DN) of the Storm Control Interface Policy object.
+
+### Optional ###
+
+* `annotation` (annotation) - (string) The annotation of the Storm Control Interface Policy object. This attribute is supported in ACI versions: 3.2(1l) and later.
+  - Default: `"orchestrator:terraform"`
+* `broadcast_burst_rate_packets_per_second` (bcBurstPps) - (string) The broadcast burst interval rate in packets per second for the Storm Control Interface Policy object. This attribute is supported in ACI versions: 2.3(1e) and later.
+  - Default: `"unspecified"`
+  - Valid Values:
+    * `"unspecified"`.
+    * Or a value in the range of `0` to `390625000`.
+* `broadcast_burst_rate_percentage` (bcBurstRate) - (string) The broadcast burst rate in percentage for the Storm Control Interface Policy object. This attribute is supported in ACI versions: 2.3(1e) and later.
+  - Default: `"100.000000"`
+  - Valid Values:
+    * A value in the range of `0` to `100`.
+* `broadcast_rate_percentage` (bcRate) - (string) The broadcast rate in percentage for the Storm Control Interface Policy object. This attribute is supported in ACI versions: 2.3(1e) and later.
+  - Default: `"100.000000"`
+  - Valid Values:
+    * A value in the range of `0` to `100`.
+* `broadcast_rate_packets_per_second` (bcRatePps) - (string) The broadcast rate in packets per second for the Storm Control Interface Policy object. This attribute is supported in ACI versions: 2.3(1e) and later.
+  - Default: `"unspecified"`
+  - Valid Values:
+    * `"unspecified"`.
+    * Or a value in the range of `0` to `390625000`.
+* `burst_rate_packets_per_second` (burstPps) - (string) The burst interval rate in packets per second for the Storm Control Interface Policy object.
+  - Default: `"unspecified"`
+  - Valid Values:
+    * `"unspecified"`.
+    * Or a value in the range of `0` to `390625000`.
+* `burst_rate_percentage` (burstRate) - (string) The burst rate in percentage for the Storm Control Interface Policy object.
+  - Default: `"100.000000"`
+  - Valid Values:
+    * A value in the range of `0` to `100`.
+* `description` (descr) - (string) The description of the Storm Control Interface Policy object.
+* `unicast_multicast_broadcast` (isUcMcBcStormPktCfgValid) - (string) Configure the Storm Control Interface Policy object for unicast, multicast, and broadcast. Use 'Valid' when enabling the object for unicast, multicast, and broadcast. This attribute is supported in ACI versions: 2.3(1e) and later.
+  - Default: `"Invalid"`
+  - Valid Values: `"Invalid"`, `"Valid"`.
+* `multicast_burst_rate_packets_per_second` (mcBurstPps) - (string) The multicast burst interval rate in packets per second for the Storm Control Interface Policy object. This attribute is supported in ACI versions: 2.3(1e) and later.
+  - Default: `"unspecified"`
+  - Valid Values:
+    * `"unspecified"`.
+    * Or a value in the range of `0` to `390625000`.
+* `multicast_burst_rate_percentage` (mcBurstRate) - (string) The multicast burst rate in percentage for the Storm Control Interface Policy object. This attribute is supported in ACI versions: 2.3(1e) and later.
+  - Default: `"100.000000"`
+  - Valid Values:
+    * A value in the range of `0` to `100`.
+* `multicast_rate_percentage` (mcRate) - (string) The multicast rate in percentage for the Storm Control Interface Policy object. This attribute is supported in ACI versions: 2.3(1e) and later.
+  - Default: `"100.000000"`
+  - Valid Values:
+    * A value in the range of `0` to `100`.
+* `multicast_rate_packets_per_second` (mcRatePps) - (string) The multicast rate in packets per second for the Storm Control Interface Policy object. This attribute is supported in ACI versions: 2.3(1e) and later.
+  - Default: `"unspecified"`
+  - Valid Values:
+    * `"unspecified"`.
+    * Or a value in the range of `0` to `390625000`.
+* `name_alias` (nameAlias) - (string) The name alias of the Storm Control Interface Policy object. This attribute is supported in ACI versions: 2.2(1k) and later.
+* `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.
+* `rate_percentage` (rate) - (string) The rate in percentage for the Storm Control Interface Policy object.
+  - Default: `"100.000000"`
+  - Valid Values:
+    * A value in the range of `0` to `100`.
+* `rate_packets_per_second` (ratePps) - (string) The rate in packets per second for the Storm Control Interface Policy object.
+  - Default: `"unspecified"`
+  - Valid Values:
+    * `"unspecified"`.
+    * Or a value in the range of `0` to `390625000`.
+* `action` (stormCtrlAction) - (string) The action of the Storm Control Interface Policy object. The value must be in the range 3 - 10. This attribute is supported in ACI versions: 4.1(1i) and later.
+  - Default: `"drop"`
+  - Valid Values: `"drop"`, `"shutdown"`.
+* `soak_count` (stormCtrlSoakInstCount) - (string) The soak count for the Storm Control Interface Policy object. This attribute is supported in ACI versions: 4.1(1i) and later.
+  - Default: `"3"`
+* `unicast_burst_rate_packets_per_second` (uucBurstPps) - (string) The unicast burst interval rate in packets per second for the Storm Control Interface Policy object. This attribute is supported in ACI versions: 2.3(1e) and later.
+  - Default: `"unspecified"`
+  - Valid Values:
+    * `"unspecified"`.
+    * Or a value in the range of `0` to `390625000`.
+* `unicast_burst_rate_percentage` (uucBurstRate) - (string) The unicast burst rate in percentage for the Storm Control Interface Policy object. This attribute is supported in ACI versions: 2.3(1e) and later.
+  - Default: `"100.000000"`
+  - Valid Values:
+    * A value in the range of `0` to `100`.
+* `unicast_rate_percentage` (uucRate) - (string) The unicast rate in percentage for the Storm Control Interface Policy object. This attribute is supported in ACI versions: 2.3(1e) and later.
+  - Default: `"100.000000"`
+  - Valid Values:
+    * A value in the range of `0` to `100`.
+* `unicast_rate_packets_per_second` (uucRatePps) - (string) The unicast rate in packets per second for the Storm Control Interface Policy object. This attribute is supported in ACI versions: 2.3(1e) and later.
+  - Default: `"unspecified"`
+  - Valid Values:
+    * `"unspecified"`.
+    * Or a value in the range of `0` to `390625000`.
+* `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 Storm Control Interface Policy 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_storm_control_interface_policy.example uni/infra/stormctrlifp-{name}
+```
+
+Starting in Terraform version 1.5, an existing Storm Control Interface Policy can be imported
+using [import blocks](https://developer.hashicorp.com/terraform/language/import) via the following configuration:
+
+```
+import {
+  id = "uni/infra/stormctrlifp-{name}"
+  to = aci_storm_control_interface_policy.example
+}
+```

examples/data-sources/aci_storm_control_interface_policy/data-source.tf

@@ -0,0 +1,4 @@
+
+data "aci_storm_control_interface_policy" "example" {
+  name = "test_name"
+}

examples/data-sources/aci_storm_control_interface_policy/provider.tf

@@ -0,0 +1,14 @@
+terraform {
+  required_providers {
+    aci = {
+      source = "ciscodevnet/aci"
+    }
+  }
+}
+
+provider "aci" {
+  username = ""
+  password = ""
+  url      = ""
+  insecure = true
+}

examples/resources/aci_storm_control_interface_policy/provider.tf

@@ -0,0 +1,14 @@
+terraform {
+  required_providers {
+    aci = {
+      source = "ciscodevnet/aci"
+    }
+  }
+}
+
+provider "aci" {
+  username = ""
+  password = ""
+  url      = ""
+  insecure = true
+}