|
| 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: "Generic" |
| 6 | +layout: "aci" |
| 7 | +page_title: "ACI: aci_vmm_uplink_container" |
| 8 | +sidebar_current: "docs-aci-resource-aci_vmm_uplink_container" |
| 9 | +description: |- |
| 10 | + Manages ACI VMM Uplink Container |
| 11 | +--- |
| 12 | + |
| 13 | +# aci_vmm_uplink_container # |
| 14 | + |
| 15 | +Manages ACI VMM Uplink Container |
| 16 | + |
| 17 | + |
| 18 | + |
| 19 | +## API Information ## |
| 20 | + |
| 21 | +* Class: [vmmUplinkPCont](https://pubhub.devnetcloud.com/media/model-doc-latest/docs/app/index.html#/objects/vmmUplinkPCont/overview) |
| 22 | + |
| 23 | +* Supported in ACI versions: 4.2(1i) and later. |
| 24 | + |
| 25 | +* Distinguished Name Format: `uni/vmmp-{vendor}/dom-{name}/uplinkpcont` |
| 26 | + |
| 27 | +## GUI Information ## |
| 28 | + |
| 29 | +* Location: `Generic` |
| 30 | + |
| 31 | +## Example Usage ## |
| 32 | + |
| 33 | +The configuration snippet below creates a VMM Uplink Container with only required attributes. |
| 34 | + |
| 35 | +```hcl |
| 36 | +
|
| 37 | +resource "aci_vmm_uplink_container" "example_vmm_domain" { |
| 38 | + parent_dn = aci_vmm_domain.example.id |
| 39 | + number_of_uplinks = "2" |
| 40 | +} |
| 41 | +
|
| 42 | +``` |
| 43 | +The configuration snippet below shows all possible attributes of the VMM Uplink Container. |
| 44 | + |
| 45 | +!> This example might not be valid configuration and is only used to show all possible attributes. |
| 46 | + |
| 47 | +```hcl |
| 48 | +
|
| 49 | +resource "aci_vmm_uplink_container" "full_example_vmm_domain" { |
| 50 | + parent_dn = aci_vmm_domain.example.id |
| 51 | + annotation = "annotation" |
| 52 | + name_alias = "name_alias_1" |
| 53 | + number_of_uplinks = "2" |
| 54 | + annotations = [ |
| 55 | + { |
| 56 | + key = "key_0" |
| 57 | + value = "value_1" |
| 58 | + } |
| 59 | + ] |
| 60 | + tags = [ |
| 61 | + { |
| 62 | + key = "key_0" |
| 63 | + value = "value_1" |
| 64 | + } |
| 65 | + ] |
| 66 | + uplink_policies = [ |
| 67 | + { |
| 68 | + annotation = "annotation_1" |
| 69 | + name_alias = "name_alias_1" |
| 70 | + uplink_id = "2" |
| 71 | + uplink_name = "uplink_name_2" |
| 72 | + annotations = [ |
| 73 | + { |
| 74 | + key = "key_0" |
| 75 | + value = "value_1" |
| 76 | + } |
| 77 | + ] |
| 78 | + tags = [ |
| 79 | + { |
| 80 | + key = "key_0" |
| 81 | + value = "value_1" |
| 82 | + } |
| 83 | + ] |
| 84 | + } |
| 85 | + ] |
| 86 | +} |
| 87 | +
|
| 88 | +``` |
| 89 | + |
| 90 | +All examples for the VMM Uplink Container resource can be found in the [examples](https://github.com/CiscoDevNet/terraform-provider-aci/tree/master/examples/resources/aci_vmm_uplink_container) folder. |
| 91 | + |
| 92 | +## Schema ## |
| 93 | + |
| 94 | +### Required ### |
| 95 | + |
| 96 | +* `parent_dn` - (string) The distinguished name (DN) of the parent object, possible resources: |
| 97 | + - [aci_vmm_domain](https://registry.terraform.io/providers/CiscoDevNet/aci/latest/docs/resources/vmm_domain) ([vmmDomP](https://pubhub.devnetcloud.com/media/model-doc-latest/docs/app/index.html#/objects/vmmDomP/overview)) |
| 98 | +* `number_of_uplinks` (numOfUplinks) - (string) The number of uplinks in the VMM Uplink Container object. |
| 99 | + |
| 100 | +### Read-Only ### |
| 101 | + |
| 102 | +* `id` - (string) The distinguished name (DN) of the VMM Uplink Container object. |
| 103 | + |
| 104 | +### Optional ### |
| 105 | + |
| 106 | +* `annotation` (annotation) - (string) The annotation of the VMM Uplink Container object. |
| 107 | + - Default: `orchestrator:terraform` |
| 108 | +* `name_alias` (nameAlias) - (string) The name alias of the VMM Uplink Container object. |
| 109 | +* `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. |
| 110 | + #### Required #### |
| 111 | + |
| 112 | + * `key` (key) - (string) The key used to uniquely identify this configuration object. |
| 113 | + * `value` (value) - (string) The value of the property. |
| 114 | +* `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. |
| 115 | + #### Required #### |
| 116 | + |
| 117 | + * `key` (key) - (string) The key used to uniquely identify this configuration object. |
| 118 | + * `value` (value) - (string) The value of the property. |
| 119 | +* `uplink_policies` - (list) A list of VMM Uplink Policys (ACI object [vmmUplinkP](https://pubhub.devnetcloud.com/media/model-doc-latest/docs/app/index.html#/objects/vmmUplinkP/overview)). VMM Uplink Policys can also be configured using a separate [aci_vmm_uplink_policy](https://registry.terraform.io/providers/CiscoDevNet/aci/latest/docs/resources/vmm_uplink_policy) resource. |
| 120 | + #### Required #### |
| 121 | + |
| 122 | + * `uplink_id` (uplinkId) - (string) The uplink identifier of the VMM Uplink Policy object. |
| 123 | + * `uplink_name` (uplinkName) - (string) The uplink name of the VMM Uplink Policy object. |
| 124 | + #### Optional #### |
| 125 | + |
| 126 | + * `annotation` (annotation) - (string) The annotation of the VMM Uplink Policy object. |
| 127 | + - Default: `orchestrator:terraform` |
| 128 | + * `name_alias` (nameAlias) - (string) The name alias of the VMM Uplink Policy object. |
| 129 | + * `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. |
| 130 | + #### Required #### |
| 131 | + |
| 132 | + * `key` (key) - (string) The key used to uniquely identify this configuration object. |
| 133 | + * `value` (value) - (string) The value of the property. |
| 134 | + * `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. |
| 135 | + #### Required #### |
| 136 | + |
| 137 | + * `key` (key) - (string) The key used to uniquely identify this configuration object. |
| 138 | + * `value` (value) - (string) The value of the property. |
| 139 | + |
| 140 | +## Importing |
| 141 | + |
| 142 | +An existing VMM Uplink Container can be [imported](https://www.terraform.io/docs/import/index.html) into this resource with its distinguished name (DN), via the following command: |
| 143 | + |
| 144 | +``` |
| 145 | +terraform import aci_vmm_uplink_container.example_vmm_domain uni/vmmp-{vendor}/dom-{name}/uplinkpcont |
| 146 | +``` |
| 147 | + |
| 148 | +Starting in Terraform version 1.5, an existing VMM Uplink Container can be imported |
| 149 | +using [import blocks](https://developer.hashicorp.com/terraform/language/import) via the following configuration: |
| 150 | + |
| 151 | +``` |
| 152 | +import { |
| 153 | + id = "uni/vmmp-{vendor}/dom-{name}/uplinkpcont" |
| 154 | + to = aci_vmm_uplink_container.example_vmm_domain |
| 155 | +} |
| 156 | +``` |
0 commit comments