-
Notifications
You must be signed in to change notification settings - Fork 98
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[minor_change] Add aci_netflow_record_policy resource and datasource. (…
- Loading branch information
Showing
29 changed files
with
3,018 additions
and
107 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,74 @@ | ||
--- | ||
# 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: "Tenant Policies" | ||
layout: "aci" | ||
page_title: "ACI: aci_netflow_record_policy" | ||
sidebar_current: "docs-aci-data-source-aci_netflow_record_policy" | ||
description: |- | ||
Data source for Netflow Record Policy | ||
--- | ||
|
||
# aci_netflow_record_policy # | ||
|
||
Data source for Netflow Record Policy | ||
|
||
## API Information ## | ||
|
||
* Class: [netflowRecordPol](https://pubhub.devnetcloud.com/media/model-doc-latest/docs/app/index.html#/objects/netflowRecordPol/overview) | ||
|
||
* Supported in ACI versions: 2.2(1k) and later. | ||
|
||
* Distinguished Name Formats: | ||
- `uni/infra/recordpol-{name}` | ||
- `uni/tn-{name}/recordpol-{name}` | ||
|
||
## GUI Information ## | ||
|
||
* Locations: | ||
- `Tenants -> Policies -> NetFlow -> NetFlow Records` | ||
- `Fabric -> Access Policies -> Policies -> Interface -> NetFlow -> NetFlow Records` | ||
|
||
## Example Usage ## | ||
|
||
```hcl | ||
data "aci_netflow_record_policy" "example_tenant" { | ||
parent_dn = aci_tenant.example.id | ||
name = "netfow_record" | ||
} | ||
``` | ||
|
||
## Schema ## | ||
|
||
### Required ### | ||
|
||
* `parent_dn` - (string) The distinguished name (DN) of the parent object, possible resources: | ||
- [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)) | ||
- The distinguished name (DN) of classes below can be used but currently there is no available resource for it: | ||
- [infraInfra](https://pubhub.devnetcloud.com/media/model-doc-latest/docs/app/index.html#/objects/infraInfra/overview) | ||
|
||
- Default: `uni/infra` | ||
|
||
* `name` (name) - (string) The name of the Netflow Record Policy object. | ||
|
||
### Read-Only ### | ||
|
||
* `id` - (string) The distinguished name (DN) of the Netflow Record Policy object. | ||
* `annotation` (annotation) - (string) The annotation of the Netflow Record Policy object. | ||
* `collect_parameters` (collect) - (list) Collect parameters of the Netflow Record Policy object. | ||
* `description` (descr) - (string) The description of the Netflow Record Policy object. | ||
* `match_parameters` (match) - (list) Match parameters of the Netflow Record Policy object. | ||
* `name_alias` (nameAlias) - (string) The name alias of the Netflow Record Policy 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. | ||
|
||
* `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,142 @@ | ||
--- | ||
# 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: "Tenant Policies" | ||
layout: "aci" | ||
page_title: "ACI: aci_netflow_record_policy" | ||
sidebar_current: "docs-aci-resource-aci_netflow_record_policy" | ||
description: |- | ||
Manages ACI Netflow Record Policy | ||
--- | ||
|
||
# aci_netflow_record_policy # | ||
|
||
Manages ACI Netflow Record Policy | ||
|
||
|
||
|
||
## API Information ## | ||
|
||
* Class: [netflowRecordPol](https://pubhub.devnetcloud.com/media/model-doc-latest/docs/app/index.html#/objects/netflowRecordPol/overview) | ||
|
||
* Supported in ACI versions: 2.2(1k) and later. | ||
|
||
* Distinguished Name Formats: | ||
- `uni/infra/recordpol-{name}` | ||
- `uni/tn-{name}/recordpol-{name}` | ||
|
||
## GUI Information ## | ||
|
||
* Locations: | ||
- `Tenants -> Policies -> NetFlow -> NetFlow Records` | ||
- `Fabric -> Access Policies -> Policies -> Interface -> NetFlow -> NetFlow Records` | ||
|
||
## Example Usage ## | ||
|
||
The configuration snippet below creates a Netflow Record Policy with only required attributes. | ||
|
||
```hcl | ||
resource "aci_netflow_record_policy" "example_tenant" { | ||
parent_dn = aci_tenant.example.id | ||
name = "netfow_record" | ||
} | ||
``` | ||
The configuration snippet below shows all possible attributes of the Netflow Record Policy. | ||
|
||
!> This example might not be valid configuration and is only used to show all possible attributes. | ||
|
||
```hcl | ||
resource "aci_netflow_record_policy" "full_example_tenant" { | ||
parent_dn = aci_tenant.example.id | ||
annotation = "annotation" | ||
collect_parameters = ["count-bytes", "src-intf"] | ||
description = "description" | ||
match_parameters = ["dst-ip", "src-ip"] | ||
name = "netfow_record" | ||
name_alias = "name_alias" | ||
owner_key = "owner_key" | ||
owner_tag = "owner_tag" | ||
annotations = [ | ||
{ | ||
key = "key_0" | ||
value = "value_1" | ||
} | ||
] | ||
tags = [ | ||
{ | ||
key = "key_0" | ||
value = "value_1" | ||
} | ||
] | ||
} | ||
``` | ||
|
||
All examples for the Netflow Record Policy resource can be found in the [examples](https://github.com/CiscoDevNet/terraform-provider-aci/tree/master/examples/resources/aci_netflow_record_policy) folder. | ||
|
||
## Schema ## | ||
|
||
### Required ### | ||
|
||
* `name` (name) - (string) The name of the Netflow Record Policy object. | ||
|
||
### Read-Only ### | ||
|
||
* `id` - (string) The distinguished name (DN) of the Netflow Record Policy object. | ||
|
||
### Optional ### | ||
* `parent_dn` - (string) The distinguished name (DN) of the parent object, possible resources: | ||
- [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)) | ||
- The distinguished name (DN) of classes below can be used but currently there is no available resource for it: | ||
- [infraInfra](https://pubhub.devnetcloud.com/media/model-doc-latest/docs/app/index.html#/objects/infraInfra/overview) | ||
|
||
- Default: `uni/infra` | ||
|
||
* `annotation` (annotation) - (string) The annotation of the Netflow Record Policy object. | ||
- Default: `orchestrator:terraform` | ||
* `collect_parameters` (collect) - (list) Collect parameters of the Netflow Record Policy object. | ||
- Default: `src-intf`. | ||
- Valid Values: `count-bytes`, `count-pkts`, `pkt-disp`, `sampler-id`, `src-intf`, `tcp-flags`, `ts-first`, `ts-recent`. | ||
* `description` (descr) - (string) The description of the Netflow Record Policy object. | ||
* `match_parameters` (match) - (list) Match parameters of the Netflow Record Policy object. | ||
- Default: `unspecified`. | ||
- Valid Values: `dst-ip`, `dst-ipv4`, `dst-ipv6`, `dst-mac`, `dst-port`, `ethertype`, `proto`, `src-ip`, `src-ipv4`, `src-ipv6`, `src-mac`, `src-port`, `tos`, `vlan`. | ||
* `name_alias` (nameAlias) - (string) The name alias of the Netflow Record Policy 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. | ||
|
||
* `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 Netflow Record Policy 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_netflow_record_policy.example_tenant uni/infra/recordpol-{name} | ||
``` | ||
|
||
Starting in Terraform version 1.5, an existing Netflow Record Policy can be imported | ||
using [import blocks](https://developer.hashicorp.com/terraform/language/import) via the following configuration: | ||
|
||
``` | ||
import { | ||
id = "uni/infra/recordpol-{name}" | ||
to = aci_netflow_record_policy.example_tenant | ||
} | ||
``` |
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
5 changes: 5 additions & 0 deletions
5
examples/data-sources/aci_netflow_record_policy/data-source.tf
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,5 @@ | ||
|
||
data "aci_netflow_record_policy" "example_tenant" { | ||
parent_dn = aci_tenant.example.id | ||
name = "netfow_record" | ||
} |
14 changes: 14 additions & 0 deletions
14
examples/data-sources/aci_netflow_record_policy/provider.tf
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,14 @@ | ||
terraform { | ||
required_providers { | ||
aci = { | ||
source = "ciscodevnet/aci" | ||
} | ||
} | ||
} | ||
|
||
provider "aci" { | ||
username = "" | ||
password = "" | ||
url = "" | ||
insecure = true | ||
} |
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,14 @@ | ||
terraform { | ||
required_providers { | ||
aci = { | ||
source = "ciscodevnet/aci" | ||
} | ||
} | ||
} | ||
|
||
provider "aci" { | ||
username = "" | ||
password = "" | ||
url = "" | ||
insecure = true | ||
} |
24 changes: 24 additions & 0 deletions
24
examples/resources/aci_netflow_record_policy/resource-all-attributes.tf
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,24 @@ | ||
|
||
resource "aci_netflow_record_policy" "full_example_tenant" { | ||
parent_dn = aci_tenant.example.id | ||
annotation = "annotation" | ||
collect_parameters = ["count-bytes", "src-intf"] | ||
description = "description" | ||
match_parameters = ["dst-ip", "src-ip"] | ||
name = "netfow_record" | ||
name_alias = "name_alias" | ||
owner_key = "owner_key" | ||
owner_tag = "owner_tag" | ||
annotations = [ | ||
{ | ||
key = "key_0" | ||
value = "value_1" | ||
} | ||
] | ||
tags = [ | ||
{ | ||
key = "key_0" | ||
value = "value_1" | ||
} | ||
] | ||
} |
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,5 @@ | ||
|
||
resource "aci_netflow_record_policy" "example_tenant" { | ||
parent_dn = aci_tenant.example.id | ||
name = "netfow_record" | ||
} |
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
Oops, something went wrong.