forked from CiscoDevNet/terraform-provider-aci
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Generated resource and datasource for fvSiteAssociated
- Loading branch information
abmughal
authored and
abmughal
committed
May 31, 2024
1 parent
6f45104
commit d738218
Showing
23 changed files
with
2,538 additions
and
7 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,77 @@ | ||
| --- | ||
| # Documentation generated by "gen/generator.go"; DO NOT EDIT. | ||
| # In order to regenerate this file execute `go generate` from the repository root. | ||
| # More details can be found in the [README](https://github.com/CiscoDevNet/terraform-provider-aci/blob/master/README.md). | ||
| subcategory: "Multi-Site" | ||
| layout: "aci" | ||
| page_title: "ACI: aci_associated_site" | ||
| sidebar_current: "docs-aci-data-source-aci_associated_site" | ||
| description: |- | ||
| Data source for Associated Site | ||
| --- | ||
|
|
||
| # aci_associated_site # | ||
|
|
||
| Data source for Associated Site | ||
|
|
||
| ## API Information ## | ||
|
|
||
| * Class: [fvSiteAssociated](https://pubhub.devnetcloud.com/media/model-doc-latest/docs/app/index.html#/objects/fvSiteAssociated/overview) | ||
|
|
||
|
|
||
| * Distinguished Name Formats: | ||
| - `uni/tn-{name}/BD-{name}/stAsc` | ||
| - `uni/tn-{name}/ap-{name}/epg-{name}/stAsc` | ||
| - `uni/tn-{name}/ctx-{name}/stAsc` | ||
| - `uni/tn-{name}/mscGraphXlateCont/epgDefXlate-[{epgDefDn}]/stAsc` | ||
| - `uni/tn-{name}/out-{name}/instP-{name}/stAsc` | ||
|
|
||
| ## GUI Information ## | ||
|
|
||
| * Location: `Not shown in UI` | ||
|
|
||
| ## Example Usage ## | ||
|
|
||
| ```hcl | ||
| data "aci_associated_site" "example_application_epg" { | ||
| parent_dn = aci_application_epg.example.id | ||
| } | ||
| data "aci_associated_site" "example_vrf" { | ||
| parent_dn = aci_vrf.example.id | ||
| } | ||
| ``` | ||
|
|
||
| ## Schema ## | ||
|
|
||
| ### Required ### | ||
|
|
||
| * `parent_dn` - (string) The distinguished name (DN) of the parent object, possible resources: | ||
| - [aci_application_epg](https://registry.terraform.io/providers/CiscoDevNet/aci/latest/docs/resources/application_epg) ([fvAEPg](https://pubhub.devnetcloud.com/media/model-doc-latest/docs/app/index.html#/objects/fvAEPg/overview)) | ||
| - [aci_vrf](https://registry.terraform.io/providers/CiscoDevNet/aci/latest/docs/resources/vrf) ([fvCtx](https://pubhub.devnetcloud.com/media/model-doc-latest/docs/app/index.html#/objects/fvCtx/overview)) | ||
| - The distinquised name (DN) of classes below can be used but currently there is no available resource for it: | ||
| - [fvBD](https://pubhub.devnetcloud.com/media/model-doc-latest/docs/app/index.html#/objects/fvBD/overview) | ||
| - [l3extInstP](https://pubhub.devnetcloud.com/media/model-doc-latest/docs/app/index.html#/objects/l3extInstP/overview) | ||
| - [vnsEpgDefXlate](https://pubhub.devnetcloud.com/media/model-doc-latest/docs/app/index.html#/objects/vnsEpgDefXlate/overview) | ||
|
|
||
|
|
||
| ### Read-Only ### | ||
|
|
||
| * `id` - (string) The distinguished name (DN) of the Associated Site object. | ||
| * `annotation` (annotation) - (string) The annotation of the Associated Site object. | ||
| * `description` (descr) - (string) The description of the Associated Site object. | ||
| * `name` (name) - (string) The name of the Associated Site object. | ||
| * `name_alias` (nameAlias) - (string) The name alias of the Associated Site object. | ||
| * `owner_key` (ownerKey) - (string) The key for enabling clients to own their data for entity correlation. | ||
| * `owner_tag` (ownerTag) - (string) A tag for enabling clients to add their own data. For example, to indicate who created this object. | ||
| * `site_id` (siteId) - (string) Local Site ID. | ||
|
|
||
| * `annotations` - (list) A list of Annotations (ACI object [tagAnnotation](https://pubhub.devnetcloud.com/media/model-doc-latest/docs/app/index.html#/objects/tagAnnotation/overview)). This attribute is supported in ACI versions: 3.2(1l) and later. | ||
| * `key` (key) - (string) The key used to uniquely identify this configuration object. | ||
| * `value` (value) - (string) The value of the property. | ||
|
|
||
| * `tags` - (list) A list of Tags (ACI object [tagTag](https://pubhub.devnetcloud.com/media/model-doc-latest/docs/app/index.html#/objects/tagTag/overview)). This attribute is supported in ACI versions: 3.2(1l) and later. | ||
| * `key` (key) - (string) The key used to uniquely identify this configuration object. | ||
| * `value` (value) - (string) The value of the property. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,165 @@ | ||
| --- | ||
| # Documentation generated by "gen/generator.go"; DO NOT EDIT. | ||
| # In order to regenerate this file execute `go generate` from the repository root. | ||
| # More details can be found in the [README](https://github.com/CiscoDevNet/terraform-provider-aci/blob/master/README.md). | ||
| subcategory: "Multi-Site" | ||
| layout: "aci" | ||
| page_title: "ACI: aci_associated_site" | ||
| sidebar_current: "docs-aci-resource-aci_associated_site" | ||
| description: |- | ||
| Manages ACI Associated Site | ||
| --- | ||
|
|
||
| # aci_associated_site # | ||
|
|
||
| Manages ACI Associated Site | ||
|
|
||
|
|
||
|
|
||
| ## API Information ## | ||
|
|
||
| * Class: [fvSiteAssociated](https://pubhub.devnetcloud.com/media/model-doc-latest/docs/app/index.html#/objects/fvSiteAssociated/overview) | ||
|
|
||
|
|
||
| * Distinguished Name Formats: | ||
| - `uni/tn-{name}/BD-{name}/stAsc` | ||
| - `uni/tn-{name}/ap-{name}/epg-{name}/stAsc` | ||
| - `uni/tn-{name}/ctx-{name}/stAsc` | ||
| - `uni/tn-{name}/mscGraphXlateCont/epgDefXlate-[{epgDefDn}]/stAsc` | ||
| - `uni/tn-{name}/out-{name}/instP-{name}/stAsc` | ||
|
|
||
| ## GUI Information ## | ||
|
|
||
| * Location: `Not shown in UI` | ||
|
|
||
| ## Example Usage ## | ||
|
|
||
| The configuration snippet below creates a Associated Site with only required attributes. | ||
|
|
||
| ```hcl | ||
| resource "aci_associated_site" "example_application_epg" { | ||
| parent_dn = aci_application_epg.example.id | ||
| } | ||
| resource "aci_associated_site" "example_vrf" { | ||
| parent_dn = aci_vrf.example.id | ||
| } | ||
| ``` | ||
| The configuration snippet below shows all possible attributes of the Associated Site. | ||
|
|
||
| !> This example might not be valid configuration and is only used to show all possible attributes. | ||
|
|
||
| ```hcl | ||
| resource "aci_associated_site" "full_example_application_epg" { | ||
| parent_dn = aci_application_epg.example.id | ||
| annotation = "annotation" | ||
| description = "description" | ||
| name = "name" | ||
| name_alias = "name_alias" | ||
| owner_key = "owner_key" | ||
| owner_tag = "owner_tag" | ||
| site_id = "0.000000" | ||
| annotations = [ | ||
| { | ||
| key = "key_0" | ||
| value = "value_1" | ||
| } | ||
| ] | ||
| tags = [ | ||
| { | ||
| key = "key_0" | ||
| value = "value_1" | ||
| } | ||
| ] | ||
| } | ||
| resource "aci_associated_site" "full_example_vrf" { | ||
| parent_dn = aci_vrf.example.id | ||
| annotation = "annotation" | ||
| description = "description" | ||
| name = "name" | ||
| name_alias = "name_alias" | ||
| owner_key = "owner_key" | ||
| owner_tag = "owner_tag" | ||
| site_id = "0.000000" | ||
| annotations = [ | ||
| { | ||
| key = "key_0" | ||
| value = "value_1" | ||
| } | ||
| ] | ||
| tags = [ | ||
| { | ||
| key = "key_0" | ||
| value = "value_1" | ||
| } | ||
| ] | ||
| } | ||
| ``` | ||
|
|
||
| All examples for the Associated Site resource can be found in the [examples](https://github.com/CiscoDevNet/terraform-provider-aci/tree/master/examples/resources/aci_associated_site) folder. | ||
|
|
||
| ## Schema ## | ||
|
|
||
| ### Required ### | ||
|
|
||
| * `parent_dn` - (string) The distinguished name (DN) of the parent object, possible resources: | ||
| - [aci_application_epg](https://registry.terraform.io/providers/CiscoDevNet/aci/latest/docs/resources/application_epg) ([fvAEPg](https://pubhub.devnetcloud.com/media/model-doc-latest/docs/app/index.html#/objects/fvAEPg/overview)) | ||
| - [aci_vrf](https://registry.terraform.io/providers/CiscoDevNet/aci/latest/docs/resources/vrf) ([fvCtx](https://pubhub.devnetcloud.com/media/model-doc-latest/docs/app/index.html#/objects/fvCtx/overview)) | ||
| - The distinquised name (DN) of classes below can be used but currently there is no available resource for it: | ||
| - [fvBD](https://pubhub.devnetcloud.com/media/model-doc-latest/docs/app/index.html#/objects/fvBD/overview) | ||
| - [l3extInstP](https://pubhub.devnetcloud.com/media/model-doc-latest/docs/app/index.html#/objects/l3extInstP/overview) | ||
| - [vnsEpgDefXlate](https://pubhub.devnetcloud.com/media/model-doc-latest/docs/app/index.html#/objects/vnsEpgDefXlate/overview) | ||
|
|
||
|
|
||
| ### Read-Only ### | ||
|
|
||
| * `id` - (string) The distinguished name (DN) of the Associated Site object. | ||
|
|
||
| ### Optional ### | ||
|
|
||
| * `annotation` (annotation) - (string) The annotation of the Associated Site object. | ||
| - Default: `orchestrator:terraform` | ||
| * `description` (descr) - (string) The description of the Associated Site object. | ||
| * `name` (name) - (string) The name of the Associated Site object. | ||
| * `name_alias` (nameAlias) - (string) The name alias of the Associated Site object. | ||
| * `owner_key` (ownerKey) - (string) The key for enabling clients to own their data for entity correlation. | ||
| * `owner_tag` (ownerTag) - (string) A tag for enabling clients to add their own data. For example, to indicate who created this object. | ||
| * `site_id` (siteId) - (string) Local Site ID. | ||
| - Default: `0.000000` | ||
|
|
||
| * `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. | ||
|
|
||
| #### Required #### | ||
|
|
||
| * `key` (key) - (string) The key used to uniquely identify this configuration object. | ||
| * `value` (value) - (string) The value of the property. | ||
|
|
||
| * `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. | ||
|
|
||
| #### Required #### | ||
|
|
||
| * `key` (key) - (string) The key used to uniquely identify this configuration object. | ||
| * `value` (value) - (string) The value of the property. | ||
|
|
||
| ## Importing | ||
|
|
||
| An existing Associated Site can be [imported](https://www.terraform.io/docs/import/index.html) into this resource with its distinguished name (DN), via the following command: | ||
|
|
||
| ``` | ||
| terraform import aci_associated_site.example_application_epg uni/tn-{name}/mscGraphXlateCont/epgDefXlate-[{epgDefDn}]/stAsc | ||
| ``` | ||
|
|
||
| Starting in Terraform version 1.5, an existing Associated Site can be imported | ||
| using [import blocks](https://developer.hashicorp.com/terraform/language/import) via the following configuration: | ||
|
|
||
| ``` | ||
| import { | ||
| id = "uni/tn-{name}/mscGraphXlateCont/epgDefXlate-[{epgDefDn}]/stAsc" | ||
| to = aci_associated_site.example_application_epg | ||
| } | ||
| ``` |
Oops, something went wrong.