Skip to content

Commit

Permalink
Created fvRemoteId class
Browse files Browse the repository at this point in the history
  • Loading branch information
abrahammughal committed Jun 6, 2024
1 parent 65b4375 commit 126f211
Show file tree
Hide file tree
Showing 22 changed files with 2,387 additions and 5 deletions.
2 changes: 1 addition & 1 deletion docs/data-sources/annotation.md
Original file line number Diff line number Diff line change
Expand Up @@ -60,6 +60,7 @@ data "aci_annotation" "example_application_epg" {
- [aci_endpoint_tag_mac](https://registry.terraform.io/providers/CiscoDevNet/aci/latest/docs/resources/endpoint_tag_mac) ([fvEpMacTag](https://pubhub.devnetcloud.com/media/model-doc-latest/docs/app/index.html#/objects/fvEpMacTag/overview))
- [aci_vrf_fallback_route_group](https://registry.terraform.io/providers/CiscoDevNet/aci/latest/docs/resources/vrf_fallback_route_group) ([fvFBRGroup](https://pubhub.devnetcloud.com/media/model-doc-latest/docs/app/index.html#/objects/fvFBRGroup/overview))
- [aci_vrf_fallback_route_group_member](https://registry.terraform.io/providers/CiscoDevNet/aci/latest/docs/resources/vrf_fallback_route_group_member) ([fvFBRMember](https://pubhub.devnetcloud.com/media/model-doc-latest/docs/app/index.html#/objects/fvFBRMember/overview))
- [aci_remote_site_id_mappings](https://registry.terraform.io/providers/CiscoDevNet/aci/latest/docs/resources/remote_site_id_mappings) ([fvRemoteId](https://pubhub.devnetcloud.com/media/model-doc-latest/docs/app/index.html#/objects/fvRemoteId/overview))
- [aci_associated_site](https://registry.terraform.io/providers/CiscoDevNet/aci/latest/docs/resources/associated_site) ([fvSiteAssociated](https://pubhub.devnetcloud.com/media/model-doc-latest/docs/app/index.html#/objects/fvSiteAssociated/overview))
- [aci_tenant](https://registry.terraform.io/providers/CiscoDevNet/aci/latest/docs/resources/tenant) ([fvTenant](https://pubhub.devnetcloud.com/media/model-doc-latest/docs/app/index.html#/objects/fvTenant/overview))
- [aci_l3out_consumer_label](https://registry.terraform.io/providers/CiscoDevNet/aci/latest/docs/resources/l3out_consumer_label) ([l3extConsLbl](https://pubhub.devnetcloud.com/media/model-doc-latest/docs/app/index.html#/objects/l3extConsLbl/overview))
Expand All @@ -73,7 +74,6 @@ data "aci_annotation" "example_application_epg" {
- [aci_external_management_network_instance_profile](https://registry.terraform.io/providers/CiscoDevNet/aci/latest/docs/resources/external_management_network_instance_profile) ([mgmtInstP](https://pubhub.devnetcloud.com/media/model-doc-latest/docs/app/index.html#/objects/mgmtInstP/overview))
- [aci_relation_to_consumed_out_of_band_contract](https://registry.terraform.io/providers/CiscoDevNet/aci/latest/docs/resources/relation_to_consumed_out_of_band_contract) ([mgmtRsOoBCons](https://pubhub.devnetcloud.com/media/model-doc-latest/docs/app/index.html#/objects/mgmtRsOoBCons/overview))
- [aci_external_management_network_subnet](https://registry.terraform.io/providers/CiscoDevNet/aci/latest/docs/resources/external_management_network_subnet) ([mgmtSubnet](https://pubhub.devnetcloud.com/media/model-doc-latest/docs/app/index.html#/objects/mgmtSubnet/overview))
- [aci_l3out_node_sid_profile](https://registry.terraform.io/providers/CiscoDevNet/aci/latest/docs/resources/l3out_node_sid_profile) ([mplsNodeSidP](https://pubhub.devnetcloud.com/media/model-doc-latest/docs/app/index.html#/objects/mplsNodeSidP/overview))
* `key` (key) - (string) The key used to uniquely identify this configuration object.

### Read-Only ###
Expand Down
66 changes: 66 additions & 0 deletions docs/data-sources/remote_site_id_mappings.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,66 @@
---
# 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_remote_site_id_mappings"
sidebar_current: "docs-aci-data-source-aci_remote_site_id_mappings"
description: |-
Data source for Remote Site Id Mappings
---

# aci_remote_site_id_mappings #

Data source for Remote Site Id Mappings

## API Information ##

* Class: [fvRemoteId](https://pubhub.devnetcloud.com/media/model-doc-latest/docs/app/index.html#/objects/fvRemoteId/overview)

* Supported in ACI versions: 3.0(1k) and later.

* Distinguished Name Format: `uni/tn-{name}/ctx-{name}/stAsc/site-{siteId}`

## GUI Information ##

* Location: `Not shown in UI`

## Example Usage ##

```hcl
data "aci_remote_site_id_mappings" "example_associated_site" {
parent_dn = aci_associated_site.example.id
site_id = "0"
}
```

## Schema ##

### Required ###

* `parent_dn` - (string) The distinguished name (DN) of the parent object, possible resources:
- [aci_associated_site](https://registry.terraform.io/providers/CiscoDevNet/aci/latest/docs/resources/associated_site) ([fvSiteAssociated](https://pubhub.devnetcloud.com/media/model-doc-latest/docs/app/index.html#/objects/fvSiteAssociated/overview))
* `site_id` (siteId) - (string) Remote Site ID.

### Read-Only ###

* `id` - (string) The distinguished name (DN) of the Remote Site Id Mappings object.
* `annotation` (annotation) - (string) The annotation of the Remote Site Id Mappings object.
* `description` (descr) - (string) The description of the Remote Site Id Mappings object.
* `name` (name) - (string) The name of the Remote Site Id Mappings object.
* `name_alias` (nameAlias) - (string) The name alias of the Remote Site Id Mappings 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.
* `remote_ctx_pc_tag` (remoteCtxPcTag) - (string) Remote context's *pcTag*, mapping required for default route case.
* `remote_pc_tag` (remotePcTag) - (string) Remote Class 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.
2 changes: 1 addition & 1 deletion docs/data-sources/tag.md
Original file line number Diff line number Diff line change
Expand Up @@ -60,6 +60,7 @@ data "aci_tag" "example_application_epg" {
- [aci_endpoint_tag_mac](https://registry.terraform.io/providers/CiscoDevNet/aci/latest/docs/resources/endpoint_tag_mac) ([fvEpMacTag](https://pubhub.devnetcloud.com/media/model-doc-latest/docs/app/index.html#/objects/fvEpMacTag/overview))
- [aci_vrf_fallback_route_group](https://registry.terraform.io/providers/CiscoDevNet/aci/latest/docs/resources/vrf_fallback_route_group) ([fvFBRGroup](https://pubhub.devnetcloud.com/media/model-doc-latest/docs/app/index.html#/objects/fvFBRGroup/overview))
- [aci_vrf_fallback_route_group_member](https://registry.terraform.io/providers/CiscoDevNet/aci/latest/docs/resources/vrf_fallback_route_group_member) ([fvFBRMember](https://pubhub.devnetcloud.com/media/model-doc-latest/docs/app/index.html#/objects/fvFBRMember/overview))
- [aci_remote_site_id_mappings](https://registry.terraform.io/providers/CiscoDevNet/aci/latest/docs/resources/remote_site_id_mappings) ([fvRemoteId](https://pubhub.devnetcloud.com/media/model-doc-latest/docs/app/index.html#/objects/fvRemoteId/overview))
- [aci_associated_site](https://registry.terraform.io/providers/CiscoDevNet/aci/latest/docs/resources/associated_site) ([fvSiteAssociated](https://pubhub.devnetcloud.com/media/model-doc-latest/docs/app/index.html#/objects/fvSiteAssociated/overview))
- [aci_tenant](https://registry.terraform.io/providers/CiscoDevNet/aci/latest/docs/resources/tenant) ([fvTenant](https://pubhub.devnetcloud.com/media/model-doc-latest/docs/app/index.html#/objects/fvTenant/overview))
- [aci_l3out_consumer_label](https://registry.terraform.io/providers/CiscoDevNet/aci/latest/docs/resources/l3out_consumer_label) ([l3extConsLbl](https://pubhub.devnetcloud.com/media/model-doc-latest/docs/app/index.html#/objects/l3extConsLbl/overview))
Expand All @@ -73,7 +74,6 @@ data "aci_tag" "example_application_epg" {
- [aci_external_management_network_instance_profile](https://registry.terraform.io/providers/CiscoDevNet/aci/latest/docs/resources/external_management_network_instance_profile) ([mgmtInstP](https://pubhub.devnetcloud.com/media/model-doc-latest/docs/app/index.html#/objects/mgmtInstP/overview))
- [aci_relation_to_consumed_out_of_band_contract](https://registry.terraform.io/providers/CiscoDevNet/aci/latest/docs/resources/relation_to_consumed_out_of_band_contract) ([mgmtRsOoBCons](https://pubhub.devnetcloud.com/media/model-doc-latest/docs/app/index.html#/objects/mgmtRsOoBCons/overview))
- [aci_external_management_network_subnet](https://registry.terraform.io/providers/CiscoDevNet/aci/latest/docs/resources/external_management_network_subnet) ([mgmtSubnet](https://pubhub.devnetcloud.com/media/model-doc-latest/docs/app/index.html#/objects/mgmtSubnet/overview))
- [aci_l3out_node_sid_profile](https://registry.terraform.io/providers/CiscoDevNet/aci/latest/docs/resources/l3out_node_sid_profile) ([mplsNodeSidP](https://pubhub.devnetcloud.com/media/model-doc-latest/docs/app/index.html#/objects/mplsNodeSidP/overview))
* `key` (key) - (string) The key used to uniquely identify this configuration object.

### Read-Only ###
Expand Down
2 changes: 1 addition & 1 deletion docs/resources/annotation.md
Original file line number Diff line number Diff line change
Expand Up @@ -69,6 +69,7 @@ All examples for the Annotation resource can be found in the [examples](https://
- [aci_endpoint_tag_mac](https://registry.terraform.io/providers/CiscoDevNet/aci/latest/docs/resources/endpoint_tag_mac) ([fvEpMacTag](https://pubhub.devnetcloud.com/media/model-doc-latest/docs/app/index.html#/objects/fvEpMacTag/overview))
- [aci_vrf_fallback_route_group](https://registry.terraform.io/providers/CiscoDevNet/aci/latest/docs/resources/vrf_fallback_route_group) ([fvFBRGroup](https://pubhub.devnetcloud.com/media/model-doc-latest/docs/app/index.html#/objects/fvFBRGroup/overview))
- [aci_vrf_fallback_route_group_member](https://registry.terraform.io/providers/CiscoDevNet/aci/latest/docs/resources/vrf_fallback_route_group_member) ([fvFBRMember](https://pubhub.devnetcloud.com/media/model-doc-latest/docs/app/index.html#/objects/fvFBRMember/overview))
- [aci_remote_site_id_mappings](https://registry.terraform.io/providers/CiscoDevNet/aci/latest/docs/resources/remote_site_id_mappings) ([fvRemoteId](https://pubhub.devnetcloud.com/media/model-doc-latest/docs/app/index.html#/objects/fvRemoteId/overview))
- [aci_associated_site](https://registry.terraform.io/providers/CiscoDevNet/aci/latest/docs/resources/associated_site) ([fvSiteAssociated](https://pubhub.devnetcloud.com/media/model-doc-latest/docs/app/index.html#/objects/fvSiteAssociated/overview))
- [aci_tenant](https://registry.terraform.io/providers/CiscoDevNet/aci/latest/docs/resources/tenant) ([fvTenant](https://pubhub.devnetcloud.com/media/model-doc-latest/docs/app/index.html#/objects/fvTenant/overview))
- [aci_l3out_consumer_label](https://registry.terraform.io/providers/CiscoDevNet/aci/latest/docs/resources/l3out_consumer_label) ([l3extConsLbl](https://pubhub.devnetcloud.com/media/model-doc-latest/docs/app/index.html#/objects/l3extConsLbl/overview))
Expand All @@ -82,7 +83,6 @@ All examples for the Annotation resource can be found in the [examples](https://
- [aci_external_management_network_instance_profile](https://registry.terraform.io/providers/CiscoDevNet/aci/latest/docs/resources/external_management_network_instance_profile) ([mgmtInstP](https://pubhub.devnetcloud.com/media/model-doc-latest/docs/app/index.html#/objects/mgmtInstP/overview))
- [aci_relation_to_consumed_out_of_band_contract](https://registry.terraform.io/providers/CiscoDevNet/aci/latest/docs/resources/relation_to_consumed_out_of_band_contract) ([mgmtRsOoBCons](https://pubhub.devnetcloud.com/media/model-doc-latest/docs/app/index.html#/objects/mgmtRsOoBCons/overview))
- [aci_external_management_network_subnet](https://registry.terraform.io/providers/CiscoDevNet/aci/latest/docs/resources/external_management_network_subnet) ([mgmtSubnet](https://pubhub.devnetcloud.com/media/model-doc-latest/docs/app/index.html#/objects/mgmtSubnet/overview))
- [aci_l3out_node_sid_profile](https://registry.terraform.io/providers/CiscoDevNet/aci/latest/docs/resources/l3out_node_sid_profile) ([mplsNodeSidP](https://pubhub.devnetcloud.com/media/model-doc-latest/docs/app/index.html#/objects/mplsNodeSidP/overview))
* `key` (key) - (string) The key used to uniquely identify this configuration object.
* `value` (value) - (string) The value of the property.

Expand Down
4 changes: 4 additions & 0 deletions docs/resources/associated_site.md
Original file line number Diff line number Diff line change
Expand Up @@ -159,3 +159,7 @@ import {
to = aci_associated_site.example_application_epg
}
```

## Child Resources

- [aci_remote_site_id_mappings](https://registry.terraform.io/providers/CiscoDevNet/aci/latest/docs/resources/remote_site_id_mappings)
134 changes: 134 additions & 0 deletions docs/resources/remote_site_id_mappings.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,134 @@
---
# 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_remote_site_id_mappings"
sidebar_current: "docs-aci-resource-aci_remote_site_id_mappings"
description: |-
Manages ACI Remote Site Id Mappings
---

# aci_remote_site_id_mappings #

Manages ACI Remote Site Id Mappings



## API Information ##

* Class: [fvRemoteId](https://pubhub.devnetcloud.com/media/model-doc-latest/docs/app/index.html#/objects/fvRemoteId/overview)

* Supported in ACI versions: 3.0(1k) and later.

* Distinguished Name Format: `uni/tn-{name}/ctx-{name}/stAsc/site-{siteId}`

## GUI Information ##

* Location: `Not shown in UI`

## Example Usage ##

The configuration snippet below creates a Remote Site Id Mappings with only required attributes.

```hcl
resource "aci_remote_site_id_mappings" "example_associated_site" {
parent_dn = aci_associated_site.example.id
site_id = "0"
}
```
The configuration snippet below shows all possible attributes of the Remote Site Id Mappings.

!> This example might not be valid configuration and is only used to show all possible attributes.

```hcl
resource "aci_remote_site_id_mappings" "full_example_associated_site" {
parent_dn = aci_associated_site.example.id
annotation = "annotation"
description = "description"
name = "name"
name_alias = "name_alias"
owner_key = "owner_key"
owner_tag = "owner_tag"
remote_ctx_pc_tag = "remote_ctx_pc_tag"
remote_pc_tag = "remote_pc_tag"
site_id = "0"
annotations = [
{
key = "key_0"
value = "value_1"
}
]
tags = [
{
key = "key_0"
value = "value_1"
}
]
}
```

All examples for the Remote Site Id Mappings resource can be found in the [examples](https://github.com/CiscoDevNet/terraform-provider-aci/tree/master/examples/resources/aci_remote_site_id_mappings) folder.

## Schema ##

### Required ###

* `parent_dn` - (string) The distinguished name (DN) of the parent object, possible resources:
- [aci_associated_site](https://registry.terraform.io/providers/CiscoDevNet/aci/latest/docs/resources/associated_site) ([fvSiteAssociated](https://pubhub.devnetcloud.com/media/model-doc-latest/docs/app/index.html#/objects/fvSiteAssociated/overview))
* `site_id` (siteId) - (string) Remote Site ID.

### Read-Only ###

* `id` - (string) The distinguished name (DN) of the Remote Site Id Mappings object.

### Optional ###

* `annotation` (annotation) - (string) The annotation of the Remote Site Id Mappings object.
- Default: `orchestrator:terraform`
* `description` (descr) - (string) The description of the Remote Site Id Mappings object.
* `name` (name) - (string) The name of the Remote Site Id Mappings object.
* `name_alias` (nameAlias) - (string) The name alias of the Remote Site Id Mappings 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.
* `remote_ctx_pc_tag` (remoteCtxPcTag) - (string) Remote context's *pcTag*, mapping required for default route case.
- Valid Values: `any`.
* `remote_pc_tag` (remotePcTag) - (string) Remote Class ID.
- Valid Values: `any`.

* `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 Remote Site Id Mappings 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_remote_site_id_mappings.example_associated_site uni/tn-{name}/ctx-{name}/stAsc/site-{siteId}
```

Starting in Terraform version 1.5, an existing Remote Site Id Mappings can be imported
using [import blocks](https://developer.hashicorp.com/terraform/language/import) via the following configuration:

```
import {
id = "uni/tn-{name}/ctx-{name}/stAsc/site-{siteId}"
to = aci_remote_site_id_mappings.example_associated_site
}
```
Loading

0 comments on commit 126f211

Please sign in to comment.