|
| 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_synce_interface_policy" |
| 8 | +sidebar_current: "docs-aci-resource-aci_synce_interface_policy" |
| 9 | +description: |- |
| 10 | + Manages ACI SyncE Interface Policy |
| 11 | +--- |
| 12 | + |
| 13 | +# aci_synce_interface_policy # |
| 14 | + |
| 15 | +Manages ACI SyncE Interface Policy |
| 16 | + |
| 17 | + |
| 18 | + |
| 19 | +## API Information ## |
| 20 | + |
| 21 | +* Class: [synceEthIfPol](https://pubhub.devnetcloud.com/media/model-doc-latest/docs/app/index.html#/objects/synceEthIfPol/overview) |
| 22 | + |
| 23 | +* Supported in ACI versions: 5.2(1g) and later. |
| 24 | + |
| 25 | +* Distinguished Name Format: `uni/infra/synceEthIfP-{name}` |
| 26 | + |
| 27 | +## GUI Information ## |
| 28 | + |
| 29 | +* Location: `Fabric -> Access Policies -> Policies -> Interface -> Synchronous Ethernet Interface` |
| 30 | + |
| 31 | +## Example Usage ## |
| 32 | + |
| 33 | +The configuration snippet below creates a SyncE Interface Policy with only required attributes. |
| 34 | + |
| 35 | +```hcl |
| 36 | +
|
| 37 | +resource "aci_synce_interface_policy" "example" { |
| 38 | + name = "test_name" |
| 39 | +} |
| 40 | +
|
| 41 | +``` |
| 42 | +The configuration snippet below shows all possible attributes of the SyncE 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_synce_interface_policy" "full_example" { |
| 49 | + admin_state = "enabled" |
| 50 | + annotation = "annotation" |
| 51 | + description = "description_1" |
| 52 | + name = "test_name" |
| 53 | + name_alias = "name_alias_1" |
| 54 | + owner_key = "owner_key_1" |
| 55 | + owner_tag = "owner_tag_1" |
| 56 | + quality_level_options = "op2g2" |
| 57 | + quality_receive_exact_value = "fsync-ql-o2-g2-eec2" |
| 58 | + quality_receive_highest_value = "fsync-ql-common-none" |
| 59 | + quality_receive_lowest_value = "fsync-ql-common-none" |
| 60 | + quality_transmit_exact_value = "fsync-ql-o2-g2-eec2" |
| 61 | + quality_transmit_highest_value = "fsync-ql-common-none" |
| 62 | + quality_transmit_lowest_value = "fsync-ql-common-none" |
| 63 | + selection_input = "yes" |
| 64 | + source_priority = "10" |
| 65 | + synchronization_status_message = "yes" |
| 66 | + wait_to_restore_time = "8" |
| 67 | + annotations = [ |
| 68 | + { |
| 69 | + key = "key_0" |
| 70 | + value = "value_1" |
| 71 | + } |
| 72 | + ] |
| 73 | + tags = [ |
| 74 | + { |
| 75 | + key = "key_0" |
| 76 | + value = "value_1" |
| 77 | + } |
| 78 | + ] |
| 79 | +} |
| 80 | +
|
| 81 | +``` |
| 82 | + |
| 83 | +All examples for the SyncE Interface Policy resource can be found in the [examples](https://github.com/CiscoDevNet/terraform-provider-aci/tree/master/examples/resources/aci_synce_interface_policy) folder. |
| 84 | + |
| 85 | +## Schema ## |
| 86 | + |
| 87 | +### Required ### |
| 88 | + |
| 89 | +* `name` (name) - (string) The name of the SyncE Interface Policy object. |
| 90 | + |
| 91 | +### Read-Only ### |
| 92 | + |
| 93 | +* `id` - (string) The distinguished name (DN) of the SyncE Interface Policy object. |
| 94 | + |
| 95 | +### Optional ### |
| 96 | + |
| 97 | +* `admin_state` (adminSt) - (string) The administrative state of the SyncE Interface Policy object. |
| 98 | + - Default: `"disabled"` |
| 99 | + - Valid Values: `"disabled"`, `"enabled"`. |
| 100 | +* `annotation` (annotation) - (string) The annotation of the SyncE Interface Policy object. |
| 101 | + - Default: `"orchestrator:terraform"` |
| 102 | +* `description` (descr) - (string) The description of the SyncE Interface Policy object. |
| 103 | +* `name_alias` (nameAlias) - (string) The name alias of the SyncE Interface Policy object. |
| 104 | +* `owner_key` (ownerKey) - (string) The key for enabling clients to own their data for entity correlation. |
| 105 | +* `owner_tag` (ownerTag) - (string) A tag for enabling clients to add their own data. For example, to indicate who created this object. |
| 106 | +* `quality_level_options` (qloptype) - (string) The quality level options of the SyncE Interface Policy object. This attribute is only applicable when 'synchronization_status_message' is 'yes'. |
| 107 | + - Default: `"none"` |
| 108 | + - Valid Values: `"none"`, `"op1"`, `"op2g1"`, `"op2g2"`. |
| 109 | +* `quality_receive_exact_value` (qlrcvexactval) - (string) The exact quality receive value for the SyncE Interface Policy object. This attribute is only applicable when 'synchronization_status_message' is 'yes', and valid input value depends on the choice of 'quality_level_options'. |
| 110 | + - Default: `"fsync-ql-common-none"` |
| 111 | + - Valid Values: `"fsync-ql-common-dnu"`, `"fsync-ql-common-failed"`, `"fsync-ql-common-invalid"`, `"fsync-ql-common-none"`, `"fsync-ql-o1-eec1"`, `"fsync-ql-o1-eeec"`, `"fsync-ql-o1-eprtc"`, `"fsync-ql-o1-prc"`, `"fsync-ql-o1-prtc"`, `"fsync-ql-o1-sec"`, `"fsync-ql-o1-ssu-a"`, `"fsync-ql-o1-ssu-b"`, `"fsync-ql-o2-g1-eec2"`, `"fsync-ql-o2-g1-eeec"`, `"fsync-ql-o2-g1-eprtc"`, `"fsync-ql-o2-g1-prs"`, `"fsync-ql-o2-g1-prtc"`, `"fsync-ql-o2-g1-res"`, `"fsync-ql-o2-g1-smc"`, `"fsync-ql-o2-g1-st2"`, `"fsync-ql-o2-g1-st3"`, `"fsync-ql-o2-g1-st4"`, `"fsync-ql-o2-g1-stu"`, `"fsync-ql-o2-g2-eec2"`, `"fsync-ql-o2-g2-eeec"`, `"fsync-ql-o2-g2-eprtc"`, `"fsync-ql-o2-g2-prov"`, `"fsync-ql-o2-g2-prs"`, `"fsync-ql-o2-g2-prtc"`, `"fsync-ql-o2-g2-smc"`, `"fsync-ql-o2-g2-st2"`, `"fsync-ql-o2-g2-st3"`, `"fsync-ql-o2-g2-st3e"`, `"fsync-ql-o2-g2-st4"`, `"fsync-ql-o2-g2-stu"`, `"fsync-ql-o2-g2-tnc"`. |
| 112 | +* `quality_receive_highest_value` (qlrcvhval) - (string) The highest quality receive value for the SyncE Interface Policy object. This attribute is only applicable when 'synchronization_status_message' is 'yes', and valid input value depends on the choice of 'quality_level_options'. |
| 113 | + - Default: `"fsync-ql-common-none"` |
| 114 | + - Valid Values: `"fsync-ql-common-dnu"`, `"fsync-ql-common-failed"`, `"fsync-ql-common-invalid"`, `"fsync-ql-common-none"`, `"fsync-ql-o1-eec1"`, `"fsync-ql-o1-eeec"`, `"fsync-ql-o1-eprtc"`, `"fsync-ql-o1-prc"`, `"fsync-ql-o1-prtc"`, `"fsync-ql-o1-sec"`, `"fsync-ql-o1-ssu-a"`, `"fsync-ql-o1-ssu-b"`, `"fsync-ql-o2-g1-eec2"`, `"fsync-ql-o2-g1-eeec"`, `"fsync-ql-o2-g1-eprtc"`, `"fsync-ql-o2-g1-prs"`, `"fsync-ql-o2-g1-prtc"`, `"fsync-ql-o2-g1-res"`, `"fsync-ql-o2-g1-smc"`, `"fsync-ql-o2-g1-st2"`, `"fsync-ql-o2-g1-st3"`, `"fsync-ql-o2-g1-st4"`, `"fsync-ql-o2-g1-stu"`, `"fsync-ql-o2-g2-eec2"`, `"fsync-ql-o2-g2-eeec"`, `"fsync-ql-o2-g2-eprtc"`, `"fsync-ql-o2-g2-prov"`, `"fsync-ql-o2-g2-prs"`, `"fsync-ql-o2-g2-prtc"`, `"fsync-ql-o2-g2-smc"`, `"fsync-ql-o2-g2-st2"`, `"fsync-ql-o2-g2-st3"`, `"fsync-ql-o2-g2-st3e"`, `"fsync-ql-o2-g2-st4"`, `"fsync-ql-o2-g2-stu"`, `"fsync-ql-o2-g2-tnc"`. |
| 115 | +* `quality_receive_lowest_value` (qlrcvlval) - (string) The lowest quality receive value for the SyncE Interface Policy object. This attribute is only applicable when 'synchronization_status_message' is 'yes', and valid input value depends on the choice of 'quality_level_options'. |
| 116 | + - Default: `"fsync-ql-common-none"` |
| 117 | + - Valid Values: `"fsync-ql-common-dnu"`, `"fsync-ql-common-failed"`, `"fsync-ql-common-invalid"`, `"fsync-ql-common-none"`, `"fsync-ql-o1-eec1"`, `"fsync-ql-o1-eeec"`, `"fsync-ql-o1-eprtc"`, `"fsync-ql-o1-prc"`, `"fsync-ql-o1-prtc"`, `"fsync-ql-o1-sec"`, `"fsync-ql-o1-ssu-a"`, `"fsync-ql-o1-ssu-b"`, `"fsync-ql-o2-g1-eec2"`, `"fsync-ql-o2-g1-eeec"`, `"fsync-ql-o2-g1-eprtc"`, `"fsync-ql-o2-g1-prs"`, `"fsync-ql-o2-g1-prtc"`, `"fsync-ql-o2-g1-res"`, `"fsync-ql-o2-g1-smc"`, `"fsync-ql-o2-g1-st2"`, `"fsync-ql-o2-g1-st3"`, `"fsync-ql-o2-g1-st4"`, `"fsync-ql-o2-g1-stu"`, `"fsync-ql-o2-g2-eec2"`, `"fsync-ql-o2-g2-eeec"`, `"fsync-ql-o2-g2-eprtc"`, `"fsync-ql-o2-g2-prov"`, `"fsync-ql-o2-g2-prs"`, `"fsync-ql-o2-g2-prtc"`, `"fsync-ql-o2-g2-smc"`, `"fsync-ql-o2-g2-st2"`, `"fsync-ql-o2-g2-st3"`, `"fsync-ql-o2-g2-st3e"`, `"fsync-ql-o2-g2-st4"`, `"fsync-ql-o2-g2-stu"`, `"fsync-ql-o2-g2-tnc"`. |
| 118 | +* `quality_transmit_exact_value` (qltxexactval) - (string) The exact quality transmit value of the SyncE Interface Policy object. This attribute is only applicable when 'synchronization_status_message' is 'yes', and valid input value depends on the choice of 'quality_level_options'. |
| 119 | + - Default: `"fsync-ql-common-none"` |
| 120 | + - Valid Values: `"fsync-ql-common-dnu"`, `"fsync-ql-common-failed"`, `"fsync-ql-common-invalid"`, `"fsync-ql-common-none"`, `"fsync-ql-o1-eec1"`, `"fsync-ql-o1-eeec"`, `"fsync-ql-o1-eprtc"`, `"fsync-ql-o1-prc"`, `"fsync-ql-o1-prtc"`, `"fsync-ql-o1-sec"`, `"fsync-ql-o1-ssu-a"`, `"fsync-ql-o1-ssu-b"`, `"fsync-ql-o2-g1-eec2"`, `"fsync-ql-o2-g1-eeec"`, `"fsync-ql-o2-g1-eprtc"`, `"fsync-ql-o2-g1-prs"`, `"fsync-ql-o2-g1-prtc"`, `"fsync-ql-o2-g1-res"`, `"fsync-ql-o2-g1-smc"`, `"fsync-ql-o2-g1-st2"`, `"fsync-ql-o2-g1-st3"`, `"fsync-ql-o2-g1-st4"`, `"fsync-ql-o2-g1-stu"`, `"fsync-ql-o2-g2-eec2"`, `"fsync-ql-o2-g2-eeec"`, `"fsync-ql-o2-g2-eprtc"`, `"fsync-ql-o2-g2-prov"`, `"fsync-ql-o2-g2-prs"`, `"fsync-ql-o2-g2-prtc"`, `"fsync-ql-o2-g2-smc"`, `"fsync-ql-o2-g2-st2"`, `"fsync-ql-o2-g2-st3"`, `"fsync-ql-o2-g2-st3e"`, `"fsync-ql-o2-g2-st4"`, `"fsync-ql-o2-g2-stu"`, `"fsync-ql-o2-g2-tnc"`. |
| 121 | +* `quality_transmit_highest_value` (qltxhval) - (string) The highest quality transmit value of the SyncE Interface Policy object. This attribute is only applicable when 'synchronization_status_message' is 'yes', and valid input value depends on the choice of 'quality_level_options'. |
| 122 | + - Default: `"fsync-ql-common-none"` |
| 123 | + - Valid Values: `"fsync-ql-common-dnu"`, `"fsync-ql-common-failed"`, `"fsync-ql-common-invalid"`, `"fsync-ql-common-none"`, `"fsync-ql-o1-eec1"`, `"fsync-ql-o1-eeec"`, `"fsync-ql-o1-eprtc"`, `"fsync-ql-o1-prc"`, `"fsync-ql-o1-prtc"`, `"fsync-ql-o1-sec"`, `"fsync-ql-o1-ssu-a"`, `"fsync-ql-o1-ssu-b"`, `"fsync-ql-o2-g1-eec2"`, `"fsync-ql-o2-g1-eeec"`, `"fsync-ql-o2-g1-eprtc"`, `"fsync-ql-o2-g1-prs"`, `"fsync-ql-o2-g1-prtc"`, `"fsync-ql-o2-g1-res"`, `"fsync-ql-o2-g1-smc"`, `"fsync-ql-o2-g1-st2"`, `"fsync-ql-o2-g1-st3"`, `"fsync-ql-o2-g1-st4"`, `"fsync-ql-o2-g1-stu"`, `"fsync-ql-o2-g2-eec2"`, `"fsync-ql-o2-g2-eeec"`, `"fsync-ql-o2-g2-eprtc"`, `"fsync-ql-o2-g2-prov"`, `"fsync-ql-o2-g2-prs"`, `"fsync-ql-o2-g2-prtc"`, `"fsync-ql-o2-g2-smc"`, `"fsync-ql-o2-g2-st2"`, `"fsync-ql-o2-g2-st3"`, `"fsync-ql-o2-g2-st3e"`, `"fsync-ql-o2-g2-st4"`, `"fsync-ql-o2-g2-stu"`, `"fsync-ql-o2-g2-tnc"`. |
| 124 | +* `quality_transmit_lowest_value` (qltxlval) - (string) The lowest quality transmit value of the SyncE Interface Policy object. This attribute is only applicable when 'synchronization_status_message' is 'yes', and valid input value depends on the choice of 'quality_level_options'. |
| 125 | + - Default: `"fsync-ql-common-none"` |
| 126 | + - Valid Values: `"fsync-ql-common-dnu"`, `"fsync-ql-common-failed"`, `"fsync-ql-common-invalid"`, `"fsync-ql-common-none"`, `"fsync-ql-o1-eec1"`, `"fsync-ql-o1-eeec"`, `"fsync-ql-o1-eprtc"`, `"fsync-ql-o1-prc"`, `"fsync-ql-o1-prtc"`, `"fsync-ql-o1-sec"`, `"fsync-ql-o1-ssu-a"`, `"fsync-ql-o1-ssu-b"`, `"fsync-ql-o2-g1-eec2"`, `"fsync-ql-o2-g1-eeec"`, `"fsync-ql-o2-g1-eprtc"`, `"fsync-ql-o2-g1-prs"`, `"fsync-ql-o2-g1-prtc"`, `"fsync-ql-o2-g1-res"`, `"fsync-ql-o2-g1-smc"`, `"fsync-ql-o2-g1-st2"`, `"fsync-ql-o2-g1-st3"`, `"fsync-ql-o2-g1-st4"`, `"fsync-ql-o2-g1-stu"`, `"fsync-ql-o2-g2-eec2"`, `"fsync-ql-o2-g2-eeec"`, `"fsync-ql-o2-g2-eprtc"`, `"fsync-ql-o2-g2-prov"`, `"fsync-ql-o2-g2-prs"`, `"fsync-ql-o2-g2-prtc"`, `"fsync-ql-o2-g2-smc"`, `"fsync-ql-o2-g2-st2"`, `"fsync-ql-o2-g2-st3"`, `"fsync-ql-o2-g2-st3e"`, `"fsync-ql-o2-g2-st4"`, `"fsync-ql-o2-g2-stu"`, `"fsync-ql-o2-g2-tnc"`. |
| 127 | +* `selection_input` (selinput) - (string) Enable selection input for the SyncE Interface Policy object. |
| 128 | + - Default: `"no"` |
| 129 | + - Valid Values: `"no"`, `"yes"`. |
| 130 | +* `source_priority` (srcpriority) - (string) The source priority of the SyncE Interface Policy object. This attribute is only applicable when 'selection_input' is 'yes'. The value must be in the range 1 - 254. |
| 131 | + - Default: `"100"` |
| 132 | +* `synchronization_status_message` (ssm) - (string) Enable a synchronization status message for the SyncE Interface Policy object. |
| 133 | + - Default: `"yes"` |
| 134 | + - Valid Values: `"no"`, `"yes"`. |
| 135 | +* `wait_to_restore_time` (wtr) - (string) The wait-to-restore time (minutes) for the SyncE Interface Policy object. This attribute is only applicable when 'selection_input' is 'yes'. The value must be in the range 0 - 12. |
| 136 | + - Default: `"5"` |
| 137 | +* `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. |
| 138 | + #### Required #### |
| 139 | + |
| 140 | + * `key` (key) - (string) The key used to uniquely identify this configuration object. |
| 141 | + * `value` (value) - (string) The value of the property. |
| 142 | +* `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. |
| 143 | + #### Required #### |
| 144 | + |
| 145 | + * `key` (key) - (string) The key used to uniquely identify this configuration object. |
| 146 | + * `value` (value) - (string) The value of the property. |
| 147 | + |
| 148 | +## Importing |
| 149 | + |
| 150 | +An existing SyncE 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: |
| 151 | + |
| 152 | +``` |
| 153 | +terraform import aci_synce_interface_policy.example uni/infra/synceEthIfP-{name} |
| 154 | +``` |
| 155 | + |
| 156 | +Starting in Terraform version 1.5, an existing SyncE Interface Policy can be imported |
| 157 | +using [import blocks](https://developer.hashicorp.com/terraform/language/import) via the following configuration: |
| 158 | + |
| 159 | +``` |
| 160 | +import { |
| 161 | + id = "uni/infra/synceEthIfP-{name}" |
| 162 | + to = aci_synce_interface_policy.example |
| 163 | +} |
| 164 | +``` |
0 commit comments