|
| 1 | +--- |
| 2 | +# Documentation generated by "gen/generator.go"; DO NOT EDIT. |
| 3 | +# In order to regenerate this file execute `go generate` from the repository root. |
| 4 | +# More details can be found in the [README](https://github.com/CiscoDevNet/terraform-provider-aci/blob/master/README.md). |
| 5 | +subcategory: "Access Policies" |
| 6 | +layout: "aci" |
| 7 | +page_title: "ACI: aci_storm_control_interface_policy" |
| 8 | +sidebar_current: "docs-aci-resource-aci_storm_control_interface_policy" |
| 9 | +description: |- |
| 10 | + Manages ACI Storm Control Interface Policy |
| 11 | +--- |
| 12 | + |
| 13 | +# aci_storm_control_interface_policy # |
| 14 | + |
| 15 | +Manages ACI Storm Control Interface Policy |
| 16 | + |
| 17 | + |
| 18 | + |
| 19 | +## API Information ## |
| 20 | + |
| 21 | +* Class: [stormctrlIfPol](https://pubhub.devnetcloud.com/media/model-doc-latest/docs/app/index.html#/objects/stormctrlIfPol/overview) |
| 22 | + |
| 23 | +* Supported in ACI versions: 1.0(2j) and later. |
| 24 | + |
| 25 | +* Distinguished Name Format: `uni/infra/stormctrlifp-{name}` |
| 26 | + |
| 27 | +## GUI Information ## |
| 28 | + |
| 29 | +* Location: `Fabric -> Access Policies -> Policies -> Interface -> Storm Control` |
| 30 | + |
| 31 | +## Example Usage ## |
| 32 | + |
| 33 | +The configuration snippet below creates a Storm Control Interface Policy with only required attributes. |
| 34 | + |
| 35 | +```hcl |
| 36 | +
|
| 37 | +resource "aci_storm_control_interface_policy" "example" { |
| 38 | + name = "test_name" |
| 39 | +} |
| 40 | +
|
| 41 | +``` |
| 42 | +The configuration snippet below shows all possible attributes of the Storm Control Interface Policy. |
| 43 | + |
| 44 | +!> This example might not be valid configuration and is only used to show all possible attributes. |
| 45 | + |
| 46 | +```hcl |
| 47 | +
|
| 48 | +resource "aci_storm_control_interface_policy" "full_example" { |
| 49 | + annotation = "annotation" |
| 50 | + broadcast_burst_rate_packets_per_second = "11" |
| 51 | + broadcast_burst_rate_percentage = "100.000000" |
| 52 | + broadcast_rate_percentage = "100.000000" |
| 53 | + broadcast_rate_packets_per_second = "10" |
| 54 | + burst_rate_packets_per_second = "unspecified" |
| 55 | + burst_rate_percentage = "100.000000" |
| 56 | + description = "description_1" |
| 57 | + unicast_multicast_broadcast = "Valid" |
| 58 | + multicast_burst_rate_packets_per_second = "13" |
| 59 | + multicast_burst_rate_percentage = "100.000000" |
| 60 | + multicast_rate_percentage = "100.000000" |
| 61 | + multicast_rate_packets_per_second = "12" |
| 62 | + name = "test_name" |
| 63 | + name_alias = "name_alias_1" |
| 64 | + owner_key = "owner_key_1" |
| 65 | + owner_tag = "owner_tag_1" |
| 66 | + rate_percentage = "100.000000" |
| 67 | + rate_packets_per_second = "unspecified" |
| 68 | + action = "drop" |
| 69 | + soak_count = "3" |
| 70 | + unicast_burst_rate_packets_per_second = "15" |
| 71 | + unicast_burst_rate_percentage = "100.000000" |
| 72 | + unicast_rate_percentage = "100.000000" |
| 73 | + unicast_rate_packets_per_second = "14" |
| 74 | + annotations = [ |
| 75 | + { |
| 76 | + key = "key_0" |
| 77 | + value = "value_1" |
| 78 | + } |
| 79 | + ] |
| 80 | + tags = [ |
| 81 | + { |
| 82 | + key = "key_0" |
| 83 | + value = "value_1" |
| 84 | + } |
| 85 | + ] |
| 86 | +} |
| 87 | +
|
| 88 | +``` |
| 89 | + |
| 90 | +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. |
| 91 | + |
| 92 | +## Schema ## |
| 93 | + |
| 94 | +### Required ### |
| 95 | + |
| 96 | +* `name` (name) - (string) The name of the Storm Control Interface Policy object. |
| 97 | + |
| 98 | +### Read-Only ### |
| 99 | + |
| 100 | +* `id` - (string) The distinguished name (DN) of the Storm Control Interface Policy object. |
| 101 | + |
| 102 | +### Optional ### |
| 103 | + |
| 104 | +* `annotation` (annotation) - (string) The annotation of the Storm Control Interface Policy object. This attribute is supported in ACI versions: 3.2(1l) and later. |
| 105 | + - Default: `"orchestrator:terraform"` |
| 106 | +* `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. |
| 107 | + - Default: `"unspecified"` |
| 108 | + - Valid Values: |
| 109 | + * `"unspecified"`. |
| 110 | + * Or a value in the range of `0` to `390625000`. |
| 111 | +* `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. |
| 112 | + - Default: `"100.000000"` |
| 113 | + - Valid Values: |
| 114 | + * A value in the range of `0` to `100`. |
| 115 | +* `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. |
| 116 | + - Default: `"100.000000"` |
| 117 | + - Valid Values: |
| 118 | + * A value in the range of `0` to `100`. |
| 119 | +* `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. |
| 120 | + - Default: `"unspecified"` |
| 121 | + - Valid Values: |
| 122 | + * `"unspecified"`. |
| 123 | + * Or a value in the range of `0` to `390625000`. |
| 124 | +* `burst_rate_packets_per_second` (burstPps) - (string) The burst interval rate in packets per second for the Storm Control Interface Policy object. |
| 125 | + - Default: `"unspecified"` |
| 126 | + - Valid Values: |
| 127 | + * `"unspecified"`. |
| 128 | + * Or a value in the range of `0` to `390625000`. |
| 129 | +* `burst_rate_percentage` (burstRate) - (string) The burst rate in percentage for the Storm Control Interface Policy object. |
| 130 | + - Default: `"100.000000"` |
| 131 | + - Valid Values: |
| 132 | + * A value in the range of `0` to `100`. |
| 133 | +* `description` (descr) - (string) The description of the Storm Control Interface Policy object. |
| 134 | +* `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. |
| 135 | + - Default: `"Invalid"` |
| 136 | + - Valid Values: `"Invalid"`, `"Valid"`. |
| 137 | +* `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. |
| 138 | + - Default: `"unspecified"` |
| 139 | + - Valid Values: |
| 140 | + * `"unspecified"`. |
| 141 | + * Or a value in the range of `0` to `390625000`. |
| 142 | +* `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. |
| 143 | + - Default: `"100.000000"` |
| 144 | + - Valid Values: |
| 145 | + * A value in the range of `0` to `100`. |
| 146 | +* `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. |
| 147 | + - Default: `"100.000000"` |
| 148 | + - Valid Values: |
| 149 | + * A value in the range of `0` to `100`. |
| 150 | +* `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. |
| 151 | + - Default: `"unspecified"` |
| 152 | + - Valid Values: |
| 153 | + * `"unspecified"`. |
| 154 | + * Or a value in the range of `0` to `390625000`. |
| 155 | +* `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. |
| 156 | +* `owner_key` (ownerKey) - (string) The key for enabling clients to own their data for entity correlation. |
| 157 | +* `owner_tag` (ownerTag) - (string) A tag for enabling clients to add their own data. For example, to indicate who created this object. |
| 158 | +* `rate_percentage` (rate) - (string) The rate in percentage for the Storm Control Interface Policy object. |
| 159 | + - Default: `"100.000000"` |
| 160 | + - Valid Values: |
| 161 | + * A value in the range of `0` to `100`. |
| 162 | +* `rate_packets_per_second` (ratePps) - (string) The rate in packets per second for the Storm Control Interface Policy object. |
| 163 | + - Default: `"unspecified"` |
| 164 | + - Valid Values: |
| 165 | + * `"unspecified"`. |
| 166 | + * Or a value in the range of `0` to `390625000`. |
| 167 | +* `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. |
| 168 | + - Default: `"drop"` |
| 169 | + - Valid Values: `"drop"`, `"shutdown"`. |
| 170 | +* `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. |
| 171 | + - Default: `"3"` |
| 172 | +* `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. |
| 173 | + - Default: `"unspecified"` |
| 174 | + - Valid Values: |
| 175 | + * `"unspecified"`. |
| 176 | + * Or a value in the range of `0` to `390625000`. |
| 177 | +* `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. |
| 178 | + - Default: `"100.000000"` |
| 179 | + - Valid Values: |
| 180 | + * A value in the range of `0` to `100`. |
| 181 | +* `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. |
| 182 | + - Default: `"100.000000"` |
| 183 | + - Valid Values: |
| 184 | + * A value in the range of `0` to `100`. |
| 185 | +* `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. |
| 186 | + - Default: `"unspecified"` |
| 187 | + - Valid Values: |
| 188 | + * `"unspecified"`. |
| 189 | + * Or a value in the range of `0` to `390625000`. |
| 190 | +* `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. |
| 191 | + #### Required #### |
| 192 | + |
| 193 | + * `key` (key) - (string) The key used to uniquely identify this configuration object. |
| 194 | + * `value` (value) - (string) The value of the property. |
| 195 | +* `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. |
| 196 | + #### Required #### |
| 197 | + |
| 198 | + * `key` (key) - (string) The key used to uniquely identify this configuration object. |
| 199 | + * `value` (value) - (string) The value of the property. |
| 200 | + |
| 201 | +## Importing |
| 202 | + |
| 203 | +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: |
| 204 | + |
| 205 | +``` |
| 206 | +terraform import aci_storm_control_interface_policy.example uni/infra/stormctrlifp-{name} |
| 207 | +``` |
| 208 | + |
| 209 | +Starting in Terraform version 1.5, an existing Storm Control Interface Policy can be imported |
| 210 | +using [import blocks](https://developer.hashicorp.com/terraform/language/import) via the following configuration: |
| 211 | + |
| 212 | +``` |
| 213 | +import { |
| 214 | + id = "uni/infra/stormctrlifp-{name}" |
| 215 | + to = aci_storm_control_interface_policy.example |
| 216 | +} |
| 217 | +``` |
0 commit comments