|
| 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_link_flap_interface_policy" |
| 8 | +sidebar_current: "docs-aci-resource-aci_link_flap_interface_policy" |
| 9 | +description: |- |
| 10 | + Manages ACI Link Flap Interface Policy |
| 11 | +--- |
| 12 | + |
| 13 | +# aci_link_flap_interface_policy # |
| 14 | + |
| 15 | +Manages ACI Link Flap Interface Policy |
| 16 | + |
| 17 | + |
| 18 | + |
| 19 | +## API Information ## |
| 20 | + |
| 21 | +* Class: [fabricLinkFlapPol](https://pubhub.devnetcloud.com/media/model-doc-latest/docs/app/index.html#/objects/fabricLinkFlapPol/overview) |
| 22 | + |
| 23 | +* Supported in ACI versions: 4.2(5k) and later. |
| 24 | + |
| 25 | +* Distinguished Name Format: `uni/infra/linkflappol-{name}` |
| 26 | + |
| 27 | +## GUI Information ## |
| 28 | + |
| 29 | +* Location: `Fabric -> Access Policies -> Policies -> Interface -> Link Flap` |
| 30 | + |
| 31 | +## Example Usage ## |
| 32 | + |
| 33 | +The configuration snippet below creates a Link Flap Interface Policy with only required attributes. |
| 34 | + |
| 35 | +```hcl |
| 36 | +
|
| 37 | +resource "aci_link_flap_interface_policy" "example" { |
| 38 | + name = "test_name" |
| 39 | +} |
| 40 | +
|
| 41 | +``` |
| 42 | +The configuration snippet below shows all possible attributes of the Link Flap 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_link_flap_interface_policy" "full_example" { |
| 49 | + annotation = "annotation" |
| 50 | + description = "description_1" |
| 51 | + maximum_flaps = "10" |
| 52 | + allowed_time_for_flaps = "350" |
| 53 | + name = "test_name" |
| 54 | + name_alias = "name_alias_1" |
| 55 | + owner_key = "owner_key_1" |
| 56 | + owner_tag = "owner_tag_1" |
| 57 | + annotations = [ |
| 58 | + { |
| 59 | + key = "key_0" |
| 60 | + value = "value_1" |
| 61 | + } |
| 62 | + ] |
| 63 | + tags = [ |
| 64 | + { |
| 65 | + key = "key_0" |
| 66 | + value = "value_1" |
| 67 | + } |
| 68 | + ] |
| 69 | +} |
| 70 | +
|
| 71 | +``` |
| 72 | + |
| 73 | +All examples for the Link Flap Interface Policy resource can be found in the [examples](https://github.com/CiscoDevNet/terraform-provider-aci/tree/master/examples/resources/aci_link_flap_interface_policy) folder. |
| 74 | + |
| 75 | +## Schema ## |
| 76 | + |
| 77 | +### Required ### |
| 78 | + |
| 79 | +* `name` (name) - (string) The name of the Link Flap Interface Policy object. |
| 80 | + |
| 81 | +### Read-Only ### |
| 82 | + |
| 83 | +* `id` - (string) The distinguished name (DN) of the Link Flap Interface Policy object. |
| 84 | + |
| 85 | +### Optional ### |
| 86 | + |
| 87 | +* `annotation` (annotation) - (string) The annotation of the Link Flap Interface Policy object. |
| 88 | + - Default: `"orchestrator:terraform"` |
| 89 | +* `description` (descr) - (string) The description of the Link Flap Interface Policy object. |
| 90 | +* `maximum_flaps` (linkFlapErrorMax) - (string) The maximum amount of link flaps allowed before the port goes into error disabled mode. The value must be in the range 2 - 30. |
| 91 | + - Default: `"30"` |
| 92 | +* `allowed_time_for_flaps` (linkFlapErrorSeconds) - (string) The duration in seconds to reach the maximum amount of link flaps before the port goes into error disabled mode. The value must be in the range 5 - 420. |
| 93 | + - Default: `"420"` |
| 94 | +* `name_alias` (nameAlias) - (string) The name alias of the Link Flap Interface Policy object. |
| 95 | +* `owner_key` (ownerKey) - (string) The key for enabling clients to own their data for entity correlation. |
| 96 | +* `owner_tag` (ownerTag) - (string) A tag for enabling clients to add their own data. For example, to indicate who created this object. |
| 97 | +* `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. |
| 98 | + #### Required #### |
| 99 | + |
| 100 | + * `key` (key) - (string) The key used to uniquely identify this configuration object. |
| 101 | + * `value` (value) - (string) The value of the property. |
| 102 | +* `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. |
| 103 | + #### Required #### |
| 104 | + |
| 105 | + * `key` (key) - (string) The key used to uniquely identify this configuration object. |
| 106 | + * `value` (value) - (string) The value of the property. |
| 107 | + |
| 108 | +## Importing |
| 109 | + |
| 110 | +An existing Link Flap 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: |
| 111 | + |
| 112 | +``` |
| 113 | +terraform import aci_link_flap_interface_policy.example uni/infra/linkflappol-{name} |
| 114 | +``` |
| 115 | + |
| 116 | +Starting in Terraform version 1.5, an existing Link Flap Interface Policy can be imported |
| 117 | +using [import blocks](https://developer.hashicorp.com/terraform/language/import) via the following configuration: |
| 118 | + |
| 119 | +``` |
| 120 | +import { |
| 121 | + id = "uni/infra/linkflappol-{name}" |
| 122 | + to = aci_link_flap_interface_policy.example |
| 123 | +} |
| 124 | +``` |
0 commit comments