Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ Data source for ACI Relation From Attachable Access Entity Profile To Domain

data "aci_relation_from_attachable_access_entity_profile_to_domain" "example_attachable_access_entity_profile" {
parent_dn = aci_attachable_access_entity_profile.example.id
target_dn = aci_physical_domain.example.id
target_dn = aci_physical_domain.example_physical_domain.id
}

```
Expand Down
62 changes: 62 additions & 0 deletions docs/list-resources/access_interface_override.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,62 @@
---
# 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: "Access Policies"
layout: "aci"
page_title: "ACI: aci_access_interface_override"
sidebar_current: "docs-aci-list-resource-aci_access_interface_override"
description: |-
Manages ACI Access Interface Override
---

# aci_access_interface_override #

List existing ACI Access Interface Override objects with the [terraform query](https://developer.hashicorp.com/terraform/cli/commands/query) command.

For more information about the usage see the official Hashicorp documentation for [importing existing resources in bulk](https://developer.hashicorp.com/terraform/language/v1.14.x/import/bulk?page=import&page=bulk).

## API Information ##

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

* Supported in ACI versions: 1.1(1j) and later.

* Distinguished Name Format: `uni/infra/hpaths-{name}`

## GUI Information ##

* Locations:
- `Fabric -> Access Policies -> Interfaces -> Leaf Interfaces -> Overrides`
- `Fabric -> Access Policies -> Interfaces -> Spine Interfaces -> Overrides`

## Example Usage ##

The configuration snippet below shows an example for Access Interface Override with only required attributes. This snippet retrieves a list of all Access Interface Override objects.

```hcl
list "aci_access_interface_override" "example" {
provider = aci
}
```

The configuration snippet below shows an example for Access Interface Override with filter capabilties.

```hcl
list "aci_access_interface_override" "example" {
provider = aci
config {
filter = "query-target-filter=eq(infraHPathS.dn,\"uni/infra/hpaths-{name}\")"
}
}
```

## Schema ##

### Optional ###

* `config` - (map) A map that contains all configurable options for the list resource.

### Optional ###

* `filter` - (string) A filter to restrict the results of the class query to APIC. See [Cisco APIC REST API Configuration Guide, Release 4.2(x) and Later](https://www.cisco.com/c/en/us/td/docs/dcn/aci/apic/all/apic-rest-api-configuration-guide/cisco-apic-rest-api-configuration-guide-42x-and-later/m_using_the_rest_api.html#concept_1B75A78853DD46AABC15B048AAFAD1AD) for more information about composing filter query expressions.
63 changes: 63 additions & 0 deletions docs/list-resources/access_port_block.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,63 @@
---
# 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: "Access Policies"
layout: "aci"
page_title: "ACI: aci_access_port_block"
sidebar_current: "docs-aci-list-resource-aci_access_port_block"
description: |-
Manages ACI Access Port Block
---

# aci_access_port_block #

List existing ACI Access Port Block objects with the [terraform query](https://developer.hashicorp.com/terraform/cli/commands/query) command.

For more information about the usage see the official Hashicorp documentation for [importing existing resources in bulk](https://developer.hashicorp.com/terraform/language/v1.14.x/import/bulk?page=import&page=bulk).

## API Information ##

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

* Supported in ACI versions: 1.0(1e) and later.

* Distinguished Name Formats:
- `uni/infra/accportprof-{name}/hports-{name}-typ-{type}/portblk-{name}`
- `uni/infra/fexprof-{name}/hports-{name}-typ-{type}/portblk-{name}`
- `uni/infra/spaccportprof-{name}/shports-{name}-typ-{type}/portblk-{name}`

## GUI Information ##

* Location: `Fabric -> Access Policies -> Interfaces -> Leaf/Spine Interfaces -> Profiles -> Interface Selectors -> Port Blocks`

## Example Usage ##

The configuration snippet below shows an example for Access Port Block with only required attributes. This snippet retrieves a list of all Access Port Block objects.

```hcl
list "aci_access_port_block" "example" {
provider = aci
}
```

The configuration snippet below shows an example for Access Port Block with filter capabilties.

```hcl
list "aci_access_port_block" "example" {
provider = aci
config {
filter = "query-target-filter=eq(infraPortBlk.dn,\"uni/infra/spaccportprof-{name}/shports-{name}-typ-{type}/portblk-{name}\")"
}
}
```

## Schema ##

### Optional ###

* `config` - (map) A map that contains all configurable options for the list resource.

### Optional ###

* `filter` - (string) A filter to restrict the results of the class query to APIC. See [Cisco APIC REST API Configuration Guide, Release 4.2(x) and Later](https://www.cisco.com/c/en/us/td/docs/dcn/aci/apic/all/apic-rest-api-configuration-guide/cisco-apic-rest-api-configuration-guide-42x-and-later/m_using_the_rest_api.html#concept_1B75A78853DD46AABC15B048AAFAD1AD) for more information about composing filter query expressions.
62 changes: 62 additions & 0 deletions docs/list-resources/access_port_selector.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,62 @@
---
# 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: "Access Policies"
layout: "aci"
page_title: "ACI: aci_access_port_selector"
sidebar_current: "docs-aci-list-resource-aci_access_port_selector"
description: |-
Manages ACI Access Port Selector
---

# aci_access_port_selector #

List existing ACI Access Port Selector objects with the [terraform query](https://developer.hashicorp.com/terraform/cli/commands/query) command.

For more information about the usage see the official Hashicorp documentation for [importing existing resources in bulk](https://developer.hashicorp.com/terraform/language/v1.14.x/import/bulk?page=import&page=bulk).

## API Information ##

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

* Supported in ACI versions: 1.0(1e) and later.

* Distinguished Name Formats:
- `uni/infra/accportprof-{name}/hports-{name}-typ-{type}`
- `uni/infra/fexprof-{name}/hports-{name}-typ-{type}`

## GUI Information ##

* Location: `Fabric -> Access Policies -> Interfaces -> Leaf Interfaces -> Profiles -> Interface Selectors`

## Example Usage ##

The configuration snippet below shows an example for Access Port Selector with only required attributes. This snippet retrieves a list of all Access Port Selector objects.

```hcl
list "aci_access_port_selector" "example" {
provider = aci
}
```

The configuration snippet below shows an example for Access Port Selector with filter capabilties.

```hcl
list "aci_access_port_selector" "example" {
provider = aci
config {
filter = "query-target-filter=eq(infraHPortS.dn,\"uni/infra/fexprof-{name}/hports-{name}-typ-{type}\")"
}
}
```

## Schema ##

### Optional ###

* `config` - (map) A map that contains all configurable options for the list resource.

### Optional ###

* `filter` - (string) A filter to restrict the results of the class query to APIC. See [Cisco APIC REST API Configuration Guide, Release 4.2(x) and Later](https://www.cisco.com/c/en/us/td/docs/dcn/aci/apic/all/apic-rest-api-configuration-guide/cisco-apic-rest-api-configuration-guide-42x-and-later/m_using_the_rest_api.html#concept_1B75A78853DD46AABC15B048AAFAD1AD) for more information about composing filter query expressions.
66 changes: 66 additions & 0 deletions docs/list-resources/annotation.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: "Generic"
layout: "aci"
page_title: "ACI: aci_annotation"
sidebar_current: "docs-aci-list-resource-aci_annotation"
description: |-
Manages ACI Annotation
---

# aci_annotation #

List existing ACI Annotation objects with the [terraform query](https://developer.hashicorp.com/terraform/cli/commands/query) command.

For more information about the usage see the official Hashicorp documentation for [importing existing resources in bulk](https://developer.hashicorp.com/terraform/language/v1.14.x/import/bulk?page=import&page=bulk).

## API Information ##

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

* Supported in ACI versions: 3.2(1l) and later.

* Distinguished Name Formats:
- Too many DN formats to display, see model documentation for all possible parents of [tagAnnotation](https://pubhub.devnetcloud.com/media/model-doc-latest/docs/app/index.html#/objects/tagAnnotation/overview).
- `uni/tn-{name}/BD-{name}/annotationKey-[{key}]`
- `uni/tn-{name}/annotationKey-[{key}]`
- `uni/tn-{name}/ap-{name}/annotationKey-[{key}]`
- `uni/tn-{name}/ap-{name}/epg-{name}/annotationKey-[{key}]`
- `uni/tn-{name}/ctx-{name}/annotationKey-[{key}]`

## GUI Information ##

* Location: `Under every object as Annotations in the Policy tab in recent APIC versions.`

## Example Usage ##

The configuration snippet below shows an example for Annotation with only required attributes. This snippet retrieves a list of all Annotation objects.

```hcl
list "aci_annotation" "example" {
provider = aci
}
```

The configuration snippet below shows an example for Annotation with filter capabilties.

```hcl
list "aci_annotation" "example" {
provider = aci
config {
filter = "query-target-filter=eq(tagAnnotation.dn,\"uni/tn-{name}/annotationKey-[{key}]\")"
}
}
```

## Schema ##

### Optional ###

* `config` - (map) A map that contains all configurable options for the list resource.

### Optional ###

* `filter` - (string) A filter to restrict the results of the class query to APIC. See [Cisco APIC REST API Configuration Guide, Release 4.2(x) and Later](https://www.cisco.com/c/en/us/td/docs/dcn/aci/apic/all/apic-rest-api-configuration-guide/cisco-apic-rest-api-configuration-guide-42x-and-later/m_using_the_rest_api.html#concept_1B75A78853DD46AABC15B048AAFAD1AD) for more information about composing filter query expressions.
60 changes: 60 additions & 0 deletions docs/list-resources/any.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,60 @@
---
# 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: "Networking"
layout: "aci"
page_title: "ACI: aci_any"
sidebar_current: "docs-aci-list-resource-aci_any"
description: |-
Manages ACI Any
---

# aci_any #

List existing ACI Any objects with the [terraform query](https://developer.hashicorp.com/terraform/cli/commands/query) command.

For more information about the usage see the official Hashicorp documentation for [importing existing resources in bulk](https://developer.hashicorp.com/terraform/language/v1.14.x/import/bulk?page=import&page=bulk).

## API Information ##

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

* Supported in ACI versions: 1.0(1e) and later.

* Distinguished Name Format: `uni/tn-{name}/ctx-{name}/any`

## GUI Information ##

* Location: `Tenants -> Networking -> VRFs -> EPG|ESG Collection for VRF`

## Example Usage ##

The configuration snippet below shows an example for Any with only required attributes. This snippet retrieves a list of all Any objects.

```hcl
list "aci_any" "example" {
provider = aci
}
```

The configuration snippet below shows an example for Any with filter capabilties.

```hcl
list "aci_any" "example" {
provider = aci
config {
filter = "query-target-filter=eq(vzAny.dn,\"uni/tn-{name}/ctx-{name}/any\")"
}
}
```

## Schema ##

### Optional ###

* `config` - (map) A map that contains all configurable options for the list resource.

### Optional ###

* `filter` - (string) A filter to restrict the results of the class query to APIC. See [Cisco APIC REST API Configuration Guide, Release 4.2(x) and Later](https://www.cisco.com/c/en/us/td/docs/dcn/aci/apic/all/apic-rest-api-configuration-guide/cisco-apic-rest-api-configuration-guide-42x-and-later/m_using_the_rest_api.html#concept_1B75A78853DD46AABC15B048AAFAD1AD) for more information about composing filter query expressions.
60 changes: 60 additions & 0 deletions docs/list-resources/application_epg.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,60 @@
---
# 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: "Application Management"
layout: "aci"
page_title: "ACI: aci_application_epg"
sidebar_current: "docs-aci-list-resource-aci_application_epg"
description: |-
Manages ACI Application EPG
---

# aci_application_epg #

List existing ACI Application EPG objects with the [terraform query](https://developer.hashicorp.com/terraform/cli/commands/query) command.

For more information about the usage see the official Hashicorp documentation for [importing existing resources in bulk](https://developer.hashicorp.com/terraform/language/v1.14.x/import/bulk?page=import&page=bulk).

## API Information ##

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

* Supported in ACI versions: 1.0(1e) and later.

* Distinguished Name Format: `uni/tn-{name}/ap-{name}/epg-{name}`

## GUI Information ##

* Location: `Tenants -> Application Profiles -> Application EPGs`

## Example Usage ##

The configuration snippet below shows an example for Application EPG with only required attributes. This snippet retrieves a list of all Application EPG objects.

```hcl
list "aci_application_epg" "example" {
provider = aci
}
```

The configuration snippet below shows an example for Application EPG with filter capabilties.

```hcl
list "aci_application_epg" "example" {
provider = aci
config {
filter = "query-target-filter=eq(fvAEPg.dn,\"uni/tn-{name}/ap-{name}/epg-{name}\")"
}
}
```

## Schema ##

### Optional ###

* `config` - (map) A map that contains all configurable options for the list resource.

### Optional ###

* `filter` - (string) A filter to restrict the results of the class query to APIC. See [Cisco APIC REST API Configuration Guide, Release 4.2(x) and Later](https://www.cisco.com/c/en/us/td/docs/dcn/aci/apic/all/apic-rest-api-configuration-guide/cisco-apic-rest-api-configuration-guide-42x-and-later/m_using_the_rest_api.html#concept_1B75A78853DD46AABC15B048AAFAD1AD) for more information about composing filter query expressions.
Loading
Loading