|
| 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: "Application Management" |
| 6 | +layout: "aci" |
| 7 | +page_title: "ACI: aci_tenant" |
| 8 | +sidebar_current: "docs-aci-resource-aci_tenant" |
| 9 | +description: |- |
| 10 | + Manages ACI Tenant |
| 11 | +--- |
| 12 | + |
| 13 | +# aci_tenant # |
| 14 | + |
| 15 | +Manages ACI Tenant |
| 16 | + |
| 17 | + |
| 18 | + |
| 19 | +## API Information ## |
| 20 | + |
| 21 | +* Class: [fvTenant](https://pubhub.devnetcloud.com/media/model-doc-latest/docs/app/index.html#/objects/fvTenant/overview) |
| 22 | + |
| 23 | +* Supported in ACI versions: 1.0(1e) and later. |
| 24 | + |
| 25 | +* Distinguished Name Format: `uni/tn-{name}` |
| 26 | + |
| 27 | +## GUI Information ## |
| 28 | + |
| 29 | +* Location: `Tenants` |
| 30 | + |
| 31 | +## Example Usage ## |
| 32 | + |
| 33 | +The configuration snippet below creates a Tenant with only required attributes. |
| 34 | + |
| 35 | +```hcl |
| 36 | +
|
| 37 | +resource "aci_tenant" "example" { |
| 38 | + name = "test_name" |
| 39 | +} |
| 40 | +
|
| 41 | +``` |
| 42 | +The configuration snippet below shows all possible attributes of the Tenant. |
| 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_tenant" "full_example" { |
| 49 | + annotation = "annotation" |
| 50 | + description = "description_1" |
| 51 | + name = "test_name" |
| 52 | + name_alias = "name_alias_1" |
| 53 | + owner_key = "owner_key_1" |
| 54 | + owner_tag = "owner_tag_1" |
| 55 | + relation_to_tenant_monitoring_policy = { |
| 56 | + annotation = "annotation_1" |
| 57 | + monitoring_policy_name = aci_monitoring_policy.example.name |
| 58 | + annotations = [ |
| 59 | + { |
| 60 | + key = "key_0" |
| 61 | + value = "value_1" |
| 62 | + } |
| 63 | + ] |
| 64 | + tags = [ |
| 65 | + { |
| 66 | + key = "key_0" |
| 67 | + value = "value_1" |
| 68 | + } |
| 69 | + ] |
| 70 | + } |
| 71 | + annotations = [ |
| 72 | + { |
| 73 | + key = "key_0" |
| 74 | + value = "value_1" |
| 75 | + } |
| 76 | + ] |
| 77 | + tags = [ |
| 78 | + { |
| 79 | + key = "key_0" |
| 80 | + value = "value_1" |
| 81 | + } |
| 82 | + ] |
| 83 | +} |
| 84 | +
|
| 85 | +``` |
| 86 | + |
| 87 | +All examples for the Tenant resource can be found in the [examples](https://github.com/CiscoDevNet/terraform-provider-aci/tree/master/examples/resources/aci_tenant) folder. |
| 88 | + |
| 89 | +## Schema ## |
| 90 | + |
| 91 | +### Required ### |
| 92 | + |
| 93 | +* `name` (name) - (string) The name of the Tenant object. |
| 94 | + |
| 95 | +### Read-Only ### |
| 96 | + |
| 97 | +* `id` - (string) The distinguished name (DN) of the Tenant object. |
| 98 | + |
| 99 | +### Optional ### |
| 100 | + |
| 101 | +* `annotation` (annotation) - (string) The annotation of the Tenant object. |
| 102 | + - Default: `orchestrator:terraform` |
| 103 | +* `description` (descr) - (string) The description of the Tenant object. |
| 104 | +* `name_alias` (nameAlias) - (string) The name alias of the Tenant object. |
| 105 | +* `owner_key` (ownerKey) - (string) The key for enabling clients to own their data for entity correlation. |
| 106 | +* `owner_tag` (ownerTag) - (string) A tag for enabling clients to add their own data. For example, to indicate who created this object. |
| 107 | +* `relation_to_tenant_monitoring_policy` - (map) A map of Relation To Tenant Monitoring Policy (ACI object [fvRsTenantMonPol](https://pubhub.devnetcloud.com/media/model-doc-latest/docs/app/index.html#/objects/fvRsTenantMonPol/overview)) pointing to Monitoring Policy (ACI Object [monEPGPol](https://pubhub.devnetcloud.com/media/model-doc-latest/docs/app/index.html#/objects/monEPGPol/overview)) which can be configured using the [aci_monitoring_policy](https://registry.terraform.io/providers/CiscoDevNet/aci/latest/docs/resources/monitoring_policy) resource. |
| 108 | + #### Optional #### |
| 109 | + |
| 110 | + * `annotation` (annotation) - (string) The annotation of the Relation To Tenant Monitoring Policy object. |
| 111 | + - Default: `orchestrator:terraform` |
| 112 | + * `monitoring_policy_name` (tnMonEPGPolName) - (string) The name of the monitoring policy. |
| 113 | + * `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. |
| 114 | + #### Required #### |
| 115 | + |
| 116 | + * `key` (key) - (string) The key used to uniquely identify this configuration object. |
| 117 | + * `value` (value) - (string) The value of the property. |
| 118 | + * `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. |
| 119 | + #### Required #### |
| 120 | + |
| 121 | + * `key` (key) - (string) The key used to uniquely identify this configuration object. |
| 122 | + * `value` (value) - (string) The value of the property. |
| 123 | +* `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. |
| 124 | + #### Required #### |
| 125 | + |
| 126 | + * `key` (key) - (string) The key used to uniquely identify this configuration object. |
| 127 | + * `value` (value) - (string) The value of the property. |
| 128 | +* `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. |
| 129 | + #### Required #### |
| 130 | + |
| 131 | + * `key` (key) - (string) The key used to uniquely identify this configuration object. |
| 132 | + * `value` (value) - (string) The value of the property. |
| 133 | + |
| 134 | +## Importing |
| 135 | + |
| 136 | +An existing Tenant can be [imported](https://www.terraform.io/docs/import/index.html) into this resource with its distinguished name (DN), via the following command: |
| 137 | + |
| 138 | +``` |
| 139 | +terraform import aci_tenant.example uni/tn-{name} |
| 140 | +``` |
| 141 | + |
| 142 | +Starting in Terraform version 1.5, an existing Tenant can be imported |
| 143 | +using [import blocks](https://developer.hashicorp.com/terraform/language/import) via the following configuration: |
| 144 | + |
| 145 | +``` |
| 146 | +import { |
| 147 | + id = "uni/tn-{name}" |
| 148 | + to = aci_tenant.example |
| 149 | +} |
| 150 | +``` |
| 151 | + |
| 152 | +## Child Resources |
| 153 | + |
| 154 | + - [aci_application_profile](https://registry.terraform.io/providers/CiscoDevNet/aci/latest/docs/resources/application_profile) |
| 155 | + - [aci_bridge_domain](https://registry.terraform.io/providers/CiscoDevNet/aci/latest/docs/resources/bridge_domain) |
| 156 | + - [aci_certificate_store](https://registry.terraform.io/providers/CiscoDevNet/aci/latest/docs/resources/certificate_store) |
| 157 | + - [aci_contract](https://registry.terraform.io/providers/CiscoDevNet/aci/latest/docs/resources/contract) |
| 158 | + - [aci_dhcp_relay_policy](https://registry.terraform.io/providers/CiscoDevNet/aci/latest/docs/resources/dhcp_relay_policy) |
| 159 | + - [aci_end_point_retention_policy](https://registry.terraform.io/providers/CiscoDevNet/aci/latest/docs/resources/end_point_retention_policy) |
| 160 | + - [aci_filter](https://registry.terraform.io/providers/CiscoDevNet/aci/latest/docs/resources/filter) |
| 161 | + - [aci_igmp_snooping_policy](https://registry.terraform.io/providers/CiscoDevNet/aci/latest/docs/resources/igmp_snooping_policy) |
| 162 | + - [aci_imported_contract](https://registry.terraform.io/providers/CiscoDevNet/aci/latest/docs/resources/imported_contract) |
| 163 | + - [aci_l3_outside](https://registry.terraform.io/providers/CiscoDevNet/aci/latest/docs/resources/l3_outside) |
| 164 | + - [aci_mld_snooping_policy](https://registry.terraform.io/providers/CiscoDevNet/aci/latest/docs/resources/mld_snooping_policy) |
| 165 | + - [aci_monitoring_policy](https://registry.terraform.io/providers/CiscoDevNet/aci/latest/docs/resources/monitoring_policy) |
| 166 | + - [aci_neighbor_discovery_interface_policy](https://registry.terraform.io/providers/CiscoDevNet/aci/latest/docs/resources/neighbor_discovery_interface_policy) |
| 167 | + - [aci_netflow_exporter_policy](https://registry.terraform.io/providers/CiscoDevNet/aci/latest/docs/resources/netflow_exporter_policy) |
| 168 | + - [aci_netflow_monitor_policy](https://registry.terraform.io/providers/CiscoDevNet/aci/latest/docs/resources/netflow_monitor_policy) |
| 169 | + - [aci_netflow_record_policy](https://registry.terraform.io/providers/CiscoDevNet/aci/latest/docs/resources/netflow_record_policy) |
| 170 | + - [aci_out_of_band_contract](https://registry.terraform.io/providers/CiscoDevNet/aci/latest/docs/resources/out_of_band_contract) |
| 171 | + - [aci_pim_route_map_policy](https://registry.terraform.io/providers/CiscoDevNet/aci/latest/docs/resources/pim_route_map_policy) |
| 172 | + - [aci_route_control_profile](https://registry.terraform.io/providers/CiscoDevNet/aci/latest/docs/resources/route_control_profile) |
| 173 | + - [aci_taboo_contract](https://registry.terraform.io/providers/CiscoDevNet/aci/latest/docs/resources/taboo_contract) |
| 174 | + - [aci_vrf](https://registry.terraform.io/providers/CiscoDevNet/aci/latest/docs/resources/vrf) |
0 commit comments