|
| 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_zr_transceiver_interface_policy" |
| 8 | +sidebar_current: "docs-aci-resource-aci_zr_transceiver_interface_policy" |
| 9 | +description: |- |
| 10 | + Manages ACI ZR Transceiver Interface Policy |
| 11 | +--- |
| 12 | + |
| 13 | +# aci_zr_transceiver_interface_policy # |
| 14 | + |
| 15 | +Manages ACI ZR Transceiver Interface Policy |
| 16 | + |
| 17 | + |
| 18 | + |
| 19 | +## API Information ## |
| 20 | + |
| 21 | +* Class: [xcvrZRIfPol](https://pubhub.devnetcloud.com/media/model-doc-latest/docs/app/index.html#/objects/xcvrZRIfPol/overview) |
| 22 | + |
| 23 | +* Supported in ACI versions: 5.2(6e) to 5.3(2f), 6.0(2h) and later. |
| 24 | + |
| 25 | +* Distinguished Name Format: `uni/infra/zr-{name}` |
| 26 | + |
| 27 | +## GUI Information ## |
| 28 | + |
| 29 | +* Location: `Fabric -> Access Policies -> Policies -> Interface -> Transceiver` |
| 30 | + |
| 31 | +## Example Usage ## |
| 32 | + |
| 33 | +The configuration snippet below creates a ZR Transceiver Interface Policy with only required attributes. |
| 34 | + |
| 35 | +```hcl |
| 36 | +
|
| 37 | +resource "aci_zr_transceiver_interface_policy" "example" { |
| 38 | + name = "test_name" |
| 39 | +} |
| 40 | +
|
| 41 | +``` |
| 42 | +The configuration snippet below shows all possible attributes of the ZR Transceiver 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_zr_transceiver_interface_policy" "full_example" { |
| 49 | + admin_state = "enabled" |
| 50 | + annotation = "annotation" |
| 51 | + maximum_chromatic_dispersion = "-1390" |
| 52 | + minimum_chromatic_dispersion = "-2391" |
| 53 | + dac_rate = "1x1" |
| 54 | + description = "description_1" |
| 55 | + dwdm_carrier_grid = "50GHzFrequency" |
| 56 | + fec_mode = "cFEC" |
| 57 | + frequency_100_mhz = "1912504" |
| 58 | + frequency_50_ghz = "19415" |
| 59 | + itu_channel_50_ghz = "23" |
| 60 | + modulation = "16QAM" |
| 61 | + muxponder_mode = "1x400" |
| 62 | + name = "test_name" |
| 63 | + name_alias = "name_alias_1" |
| 64 | + owner_key = "owner_key_1" |
| 65 | + owner_tag = "owner_tag_1" |
| 66 | + transmit_power = "20" |
| 67 | + wavelength_50_ghz = "1563742" |
| 68 | + annotations = [ |
| 69 | + { |
| 70 | + key = "key_0" |
| 71 | + value = "value_1" |
| 72 | + } |
| 73 | + ] |
| 74 | + tags = [ |
| 75 | + { |
| 76 | + key = "key_0" |
| 77 | + value = "value_1" |
| 78 | + } |
| 79 | + ] |
| 80 | +} |
| 81 | +
|
| 82 | +``` |
| 83 | + |
| 84 | +All examples for the ZR Transceiver Interface Policy resource can be found in the [examples](https://github.com/CiscoDevNet/terraform-provider-aci/tree/master/examples/resources/aci_zr_transceiver_interface_policy) folder. |
| 85 | + |
| 86 | +## Schema ## |
| 87 | + |
| 88 | +### Required ### |
| 89 | + |
| 90 | +* `name` (name) - (string) The name of the ZR Transceiver Interface Policy object. |
| 91 | + |
| 92 | +### Read-Only ### |
| 93 | + |
| 94 | +* `id` - (string) The distinguished name (DN) of the ZR Transceiver Interface Policy object. |
| 95 | + |
| 96 | +### Optional ### |
| 97 | + |
| 98 | +* `admin_state` (adminSt) - (string) The administrative state of the ZR Transceiver Interface Policy object. |
| 99 | + - Default: `"disabled"` |
| 100 | + - Valid Values: `"disabled"`, `"enabled"`. |
| 101 | +* `annotation` (annotation) - (string) The annotation of the ZR Transceiver Interface Policy object. |
| 102 | + - Default: `"orchestrator:terraform"` |
| 103 | +* `maximum_chromatic_dispersion` (cdMax) - (string) The maximum chromatic dispersion of the ZR Transceiver Interface Policy object. The difference with 'minimum_chromatic_dispersion' must be greater than 1000, and the value must be in the range -1399 - 2400. |
| 104 | + - Default: `"2400"` |
| 105 | +* `minimum_chromatic_dispersion` (cdMin) - (string) The minimum chromatic dispersion of the ZR Transceiver Interface Policy object. The difference with 'maximum_chromatic_dispersion' must be greater than 1000, and the value must be in the range -2400 - 1399. |
| 106 | + - Default: `"-2400"` |
| 107 | +* `dac_rate` (dacRate) - (string) The Digital-to-Analog Converter (DAC) rate of the ZR Transceiver Interface Policy object. |
| 108 | + - Default: `"1x1"` |
| 109 | + - Valid Values: `"1x1"`. |
| 110 | +* `description` (descr) - (string) The description of the ZR Transceiver Interface Policy object. |
| 111 | +* `dwdm_carrier_grid` (dwdmCarrier) - (string) The Dense Wavelength Division Multiplexing (DWDM) carrier grid selector of the ZR Transceiver Interface Policy object. |
| 112 | + - Default: `"100MHzFrequency"` |
| 113 | + - Valid Values: `"100MHzFrequency"`, `"50GHzFrequency"`, `"50GHzITUchannel"`, `"50GHzWavelength"`. |
| 114 | +* `fec_mode` (fecMode) - (string) The Forward Error Correction (FEC) mode of the ZR Transceiver Interface Policy object. |
| 115 | + - Default: `"cFEC"` |
| 116 | + - Valid Values: `"cFEC"`. |
| 117 | +* `frequency_100_mhz` (frequency100MHz) - (string) The 100 Megahertz (MHz) frequency of the ZR Transceiver Interface Policy object. The value must be in the range 1911500 - 1961000. |
| 118 | + - Default: `"1931000"` |
| 119 | +* `frequency_50_ghz` (frequency50GHz) - (string) The 50 Gigahertz (GHz) frequency of the ZR Transceiver Interface Policy object. The value must be in the range 19115 - 19610. |
| 120 | + - Default: `"19310"` |
| 121 | +* `itu_channel_50_ghz` (ituChannel50GHz) - (string) The 50 Gigahertz (GHz) International Telecommunication Union (ITU) channel of the ZR Transceiver Interface Policy object. The value must be in the range 1 - 100. |
| 122 | + - Default: `"61"` |
| 123 | +* `modulation` (modulation) - (string) The modulation of the ZR Transceiver Interface Policy object. |
| 124 | + - Default: `"16QAM"` |
| 125 | + - Valid Values: `"16QAM"`. |
| 126 | +* `muxponder_mode` (muxponder) - (string) The muxponder mode of the ZR Transceiver Interface Policy object. |
| 127 | + - Default: `"1x400"` |
| 128 | + - Valid Values: `"1x400"`. |
| 129 | +* `name_alias` (nameAlias) - (string) The name alias of the ZR Transceiver Interface Policy object. |
| 130 | +* `owner_key` (ownerKey) - (string) The key for enabling clients to own their data for entity correlation. |
| 131 | +* `owner_tag` (ownerTag) - (string) A tag for enabling clients to add their own data. For example, to indicate who created this object. |
| 132 | +* `transmit_power` (transmitPower) - (string) The transmit power of the ZR Transceiver Interface Policy object. The value must be in the range -190 - 50. |
| 133 | + - Default: `"-190"` |
| 134 | +* `wavelength_50_ghz` (wavelength50GHz) - (string) The 50 Gigahertz (GHz) wavelength of the ZR Transceiver Interface Policy object. The value must be in the range 1528773 - 1568362. |
| 135 | + - Default: `"1552524"` |
| 136 | +* `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. |
| 137 | + #### Required #### |
| 138 | + |
| 139 | + * `key` (key) - (string) The key used to uniquely identify this configuration object. |
| 140 | + * `value` (value) - (string) The value of the property. |
| 141 | +* `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. |
| 142 | + #### Required #### |
| 143 | + |
| 144 | + * `key` (key) - (string) The key used to uniquely identify this configuration object. |
| 145 | + * `value` (value) - (string) The value of the property. |
| 146 | + |
| 147 | +## Importing |
| 148 | + |
| 149 | +An existing ZR Transceiver 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: |
| 150 | + |
| 151 | +``` |
| 152 | +terraform import aci_zr_transceiver_interface_policy.example uni/infra/zr-{name} |
| 153 | +``` |
| 154 | + |
| 155 | +Starting in Terraform version 1.5, an existing ZR Transceiver Interface Policy can be imported |
| 156 | +using [import blocks](https://developer.hashicorp.com/terraform/language/import) via the following configuration: |
| 157 | + |
| 158 | +``` |
| 159 | +import { |
| 160 | + id = "uni/infra/zr-{name}" |
| 161 | + to = aci_zr_transceiver_interface_policy.example |
| 162 | +} |
| 163 | +``` |
0 commit comments