Skip to content

Commit

Permalink
[ignore] Add an Optional section in datasource doc when parent_dn has…
Browse files Browse the repository at this point in the history
… a default value.
  • Loading branch information
gmicol authored and lhercot committed Sep 10, 2024
1 parent cde80d6 commit f66657b
Show file tree
Hide file tree
Showing 75 changed files with 112 additions and 110 deletions.
6 changes: 4 additions & 2 deletions docs/data-sources/access_interface_override.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,13 +42,15 @@ data "aci_access_interface_override" "example" {

### Required ###

* `name` (name) - (string) The name of the Access Interface Override object.

### Optional ###

* `parent_dn` - (string) The distinguished name (DN) of the parent object, possible resources:
- 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 Access Interface Override object.

### Read-Only ###

Expand Down
6 changes: 4 additions & 2 deletions docs/data-sources/data_plane_policing_policy.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,14 +43,16 @@ data "aci_data_plane_policing_policy" "example_tenant" {

### Required ###

* `name` (name) - (string) The name of the Data Plane Policing 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`

* `name` (name) - (string) The name of the Data Plane Policing Policy object.

### Read-Only ###

Expand Down
6 changes: 4 additions & 2 deletions docs/data-sources/netflow_exporter_policy.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,14 +45,16 @@ data "aci_netflow_exporter_policy" "example_tenant" {

### Required ###

* `name` (name) - (string) The name of the NetFlow Exporter 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`

* `name` (name) - (string) The name of the NetFlow Exporter Policy object.

### Read-Only ###

Expand Down
6 changes: 4 additions & 2 deletions docs/data-sources/netflow_monitor_policy.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,14 +45,16 @@ data "aci_netflow_monitor_policy" "example_tenant" {

### Required ###

* `name` (name) - (string) The name of the NetFlow Monitor 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`

* `name` (name) - (string) The name of the NetFlow Monitor Policy object.

### Read-Only ###

Expand Down
6 changes: 4 additions & 2 deletions docs/data-sources/netflow_record_policy.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,14 +45,16 @@ data "aci_netflow_record_policy" "example_tenant" {

### Required ###

* `name` (name) - (string) The name 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`

* `name` (name) - (string) The name of the NetFlow Record Policy object.

### Read-Only ###

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ Data source for ACI Relation From L3Out Consumer Label To External EPG
data "aci_relation_from_l3out_consumer_label_to_external_epg" "example_l3out_consumer_label" {
parent_dn = aci_l3out_consumer_label.example.id
target_dn = "uni/tn-example_tenant/out-example_l3_outside/instP-inst_profile_2"
target_dn = aci_external_network_instance_profile.example.id
}
```
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ Data source for ACI Relation From L3Out Consumer Label To Route Control Profile
data "aci_relation_from_l3out_consumer_label_to_route_control_profile" "example_l3out_consumer_label" {
parent_dn = aci_l3out_consumer_label.example.id
direction = "import"
target_dn = "uni/tn-example_tenant/prof-rt_ctrl_profile_2"
target_dn = aci_route_control_profile.example.id
}
```
Expand Down
2 changes: 1 addition & 1 deletion docs/resources/access_interface_override.md
Original file line number Diff line number Diff line change
Expand Up @@ -95,12 +95,12 @@ All examples for the Access Interface Override resource can be found in the [exa
* `id` - (string) The distinguished name (DN) of the Access Interface Override object.

### Optional ###

* `parent_dn` - (string) The distinguished name (DN) of the parent object, possible resources:
- 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 Access Interface Override object.
- Default: `orchestrator:terraform`
* `description` (descr) - (string) The description of the Access Interface Override object.
Expand Down
2 changes: 1 addition & 1 deletion docs/resources/application_epg.md
Original file line number Diff line number Diff line change
Expand Up @@ -236,7 +236,7 @@ All examples for the Application EPG resource can be found in the [examples](htt
* `id` - (string) The distinguished name (DN) of the Application EPG object.

### Optional ###

* `annotation` (annotation) - (string) The annotation of the Application EPG object.
- Default: `orchestrator:terraform`
* `description` (descr) - (string) The description of the Application EPG object.
Expand Down
2 changes: 1 addition & 1 deletion docs/resources/custom_qos_policy.md
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,7 @@ All examples for the Custom Qos Policy resource can be found in the [examples](h
* `id` - (string) The distinguished name (DN) of the Custom Qos Policy object.

### Optional ###

* `annotation` (annotation) - (string) The annotation of the Custom Qos Policy object.
- Default: `orchestrator:terraform`
* `description` (descr) - (string) The description of the Custom Qos Policy object.
Expand Down
2 changes: 1 addition & 1 deletion docs/resources/data_plane_policing_policy.md
Original file line number Diff line number Diff line change
Expand Up @@ -106,13 +106,13 @@ All examples for the Data Plane Policing Policy resource can be found in the [ex
* `id` - (string) The distinguished name (DN) of the Data Plane Policing 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`

* `admin_state` (adminSt) - (string) The administrative state of the Data Plane Policing Policy object.
- Default: `disabled`
- Valid Values: `disabled`, `enabled`.
Expand Down
2 changes: 1 addition & 1 deletion docs/resources/endpoint_security_group.md
Original file line number Diff line number Diff line change
Expand Up @@ -128,7 +128,7 @@ All examples for the Endpoint Security Group resource can be found in the [examp
* `id` - (string) The distinguished name (DN) of the Endpoint Security Group object.

### Optional ###

* `annotation` (annotation) - (string) The annotation of the Endpoint Security Group object.
- Default: `orchestrator:terraform`
* `description` (descr) - (string) The description of the Endpoint Security Group object.
Expand Down
2 changes: 1 addition & 1 deletion docs/resources/endpoint_tag_ip.md
Original file line number Diff line number Diff line change
Expand Up @@ -87,7 +87,7 @@ All examples for the Endpoint Tag IP resource can be found in the [examples](htt
* `id` - (string) The distinguished name (DN) of the Endpoint Tag IP object.

### Optional ###

* `annotation` (annotation) - (string) The annotation of the Endpoint Tag IP object.
- Default: `orchestrator:terraform`
* `id_attribute` (id) - (string) The identifier of the Endpoint Tag IP object.
Expand Down
2 changes: 1 addition & 1 deletion docs/resources/endpoint_tag_mac.md
Original file line number Diff line number Diff line change
Expand Up @@ -87,7 +87,7 @@ All examples for the Endpoint Tag MAC resource can be found in the [examples](ht
* `id` - (string) The distinguished name (DN) of the Endpoint Tag MAC object.

### Optional ###

* `annotation` (annotation) - (string) The annotation of the Endpoint Tag MAC object.
- Default: `orchestrator:terraform`
* `id_attribute` (id) - (string) The identifier of the Endpoint Tag MAC object.
Expand Down
2 changes: 1 addition & 1 deletion docs/resources/epg_useg_ad_group_attribute.md
Original file line number Diff line number Diff line change
Expand Up @@ -86,7 +86,7 @@ All examples for the EPG uSeg AD Group Attribute resource can be found in the [e
* `id` - (string) The distinguished name (DN) of the EPG uSeg AD Group Attribute object.

### Optional ###

* `annotation` (annotation) - (string) The annotation of the EPG uSeg AD Group Attribute object.
- Default: `orchestrator:terraform`
* `description` (descr) - (string) The description of the EPG uSeg AD Group Attribute object.
Expand Down
2 changes: 1 addition & 1 deletion docs/resources/epg_useg_block_statement.md
Original file line number Diff line number Diff line change
Expand Up @@ -86,7 +86,7 @@ All examples for the EPG uSeg Block Statement resource can be found in the [exam
* `id` - (string) The distinguished name (DN) of the EPG uSeg Block Statement object.

### Optional ###

* `annotation` (annotation) - (string) The annotation of the EPG uSeg Block Statement object.
- Default: `orchestrator:terraform`
* `description` (descr) - (string) The description of the EPG uSeg Block Statement object.
Expand Down
2 changes: 1 addition & 1 deletion docs/resources/epg_useg_dns_attribute.md
Original file line number Diff line number Diff line change
Expand Up @@ -86,7 +86,7 @@ All examples for the EPG uSeg DNS Attribute resource can be found in the [exampl
* `id` - (string) The distinguished name (DN) of the EPG uSeg DNS Attribute object.

### Optional ###

* `annotation` (annotation) - (string) The annotation of the EPG uSeg DNS Attribute object.
- Default: `orchestrator:terraform`
* `description` (descr) - (string) The description of the EPG uSeg DNS Attribute object.
Expand Down
2 changes: 1 addition & 1 deletion docs/resources/epg_useg_ip_attribute.md
Original file line number Diff line number Diff line change
Expand Up @@ -89,7 +89,7 @@ All examples for the EPG uSeg IP Attribute resource can be found in the [example
* `id` - (string) The distinguished name (DN) of the EPG uSeg IP Attribute object.

### Optional ###

* `annotation` (annotation) - (string) The annotation of the EPG uSeg IP Attribute object.
- Default: `orchestrator:terraform`
* `description` (descr) - (string) The description of the EPG uSeg IP Attribute object.
Expand Down
2 changes: 1 addition & 1 deletion docs/resources/epg_useg_mac_attribute.md
Original file line number Diff line number Diff line change
Expand Up @@ -88,7 +88,7 @@ All examples for the EPG uSeg MAC Attribute resource can be found in the [exampl
* `id` - (string) The distinguished name (DN) of the EPG uSeg MAC Attribute object.

### Optional ###

* `annotation` (annotation) - (string) The annotation of the EPG uSeg MAC Attribute object.
- Default: `orchestrator:terraform`
* `description` (descr) - (string) The description of the EPG uSeg MAC Attribute object.
Expand Down
2 changes: 1 addition & 1 deletion docs/resources/epg_useg_sub_block_statement.md
Original file line number Diff line number Diff line change
Expand Up @@ -116,7 +116,7 @@ All examples for the EPG uSeg Sub Block Statement resource can be found in the [
* `id` - (string) The distinguished name (DN) of the EPG uSeg Sub Block Statement object.

### Optional ###

* `annotation` (annotation) - (string) The annotation of the EPG uSeg Sub Block Statement object.
- Default: `orchestrator:terraform`
* `description` (descr) - (string) The description of the EPG uSeg Sub Block Statement object.
Expand Down
2 changes: 1 addition & 1 deletion docs/resources/epg_useg_vm_attribute.md
Original file line number Diff line number Diff line change
Expand Up @@ -128,7 +128,7 @@ All examples for the EPG uSeg VM Attribute resource can be found in the [example
* `id` - (string) The distinguished name (DN) of the EPG uSeg VM Attribute object.

### Optional ###

* `annotation` (annotation) - (string) The annotation of the EPG uSeg VM Attribute object.
- Default: `orchestrator:terraform`
* `category` (category) - (string) The category of the EPG uSeg VM Attribute object.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -87,7 +87,7 @@ All examples for the External Management Network Instance Profile resource can b
* `id` - (string) The distinguished name (DN) of the External Management Network Instance Profile object.

### Optional ###

* `annotation` (annotation) - (string) The annotation of the External Management Network Instance Profile object.
- Default: `orchestrator:terraform`
* `description` (descr) - (string) The description of the External Management Network Instance Profile object.
Expand Down
2 changes: 1 addition & 1 deletion docs/resources/external_management_network_subnet.md
Original file line number Diff line number Diff line change
Expand Up @@ -84,7 +84,7 @@ All examples for the External Management Network Subnet resource can be found in
* `id` - (string) The distinguished name (DN) of the External Management Network Subnet object.

### Optional ###

* `annotation` (annotation) - (string) The annotation of the External Management Network Subnet object.
- Default: `orchestrator:terraform`
* `description` (descr) - (string) The description of the External Management Network Subnet object.
Expand Down
6 changes: 3 additions & 3 deletions docs/resources/l3out_consumer_label.md
Original file line number Diff line number Diff line change
Expand Up @@ -61,14 +61,14 @@ resource "aci_l3out_consumer_label" "full_example_l3_outside" {
relation_to_external_epgs = [
{
annotation = "annotation_1"
target_dn = "uni/tn-test_tenant/out-test_l3_outside/instP-inst_profile_1"
target_dn = aci_external_network_instance_profile.example.id
}
]
relation_to_route_control_profiles = [
{
annotation = "annotation_1"
direction = "export"
target_dn = "uni/tn-test_tenant/prof-rt_ctrl_profile_1"
target_dn = aci_route_control_profile.example.id
}
]
annotations = [
Expand Down Expand Up @@ -102,7 +102,7 @@ All examples for the L3Out Consumer Label resource can be found in the [examples
* `id` - (string) The distinguished name (DN) of the L3Out Consumer Label object.

### Optional ###

* `annotation` (annotation) - (string) The annotation of the L3Out Consumer Label object.
- Default: `orchestrator:terraform`
* `description` (descr) - (string) The description of the L3Out Consumer Label object.
Expand Down
2 changes: 1 addition & 1 deletion docs/resources/l3out_node_sid_profile.md
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,7 @@ All examples for the L3Out Node SR-MPLS Segment ID Profile resource can be found
* `id` - (string) The distinguished name (DN) of the L3Out Node SR-MPLS Segment ID Profile object.

### Optional ###

* `annotation` (annotation) - (string) The annotation of the L3Out Node SR-MPLS Segment ID Profile object.
- Default: `orchestrator:terraform`
* `description` (descr) - (string) The description of the L3Out Node SR-MPLS Segment ID Profile object.
Expand Down
2 changes: 1 addition & 1 deletion docs/resources/l3out_provider_label.md
Original file line number Diff line number Diff line change
Expand Up @@ -86,7 +86,7 @@ All examples for the L3Out Provider Label resource can be found in the [examples
* `id` - (string) The distinguished name (DN) of the L3Out Provider Label object.

### Optional ###

* `annotation` (annotation) - (string) The annotation of the L3Out Provider Label object.
- Default: `orchestrator:terraform`
* `description` (descr) - (string) The description of the L3Out Provider Label object.
Expand Down
2 changes: 1 addition & 1 deletion docs/resources/l3out_redistribute_policy.md
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,7 @@ All examples for the L3Out Redistribute Policy resource can be found in the [exa
* `id` - (string) The distinguished name (DN) of the L3Out Redistribute Policy object.

### Optional ###

* `annotation` (annotation) - (string) The annotation of the L3Out Redistribute Policy object.
- Default: `orchestrator:terraform`

Expand Down
2 changes: 1 addition & 1 deletion docs/resources/netflow_exporter_policy.md
Original file line number Diff line number Diff line change
Expand Up @@ -112,13 +112,13 @@ All examples for the NetFlow Exporter Policy resource can be found in the [examp
* `id` - (string) The distinguished name (DN) of the NetFlow Exporter 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 Exporter Policy object.
- Default: `orchestrator:terraform`
* `description` (descr) - (string) The description of the NetFlow Exporter Policy object.
Expand Down
2 changes: 1 addition & 1 deletion docs/resources/netflow_monitor_policy.md
Original file line number Diff line number Diff line change
Expand Up @@ -99,13 +99,13 @@ All examples for the NetFlow Monitor Policy resource can be found in the [exampl
* `id` - (string) The distinguished name (DN) of the NetFlow Monitor 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 Monitor Policy object.
- Default: `orchestrator:terraform`
* `description` (descr) - (string) The description of the NetFlow Monitor Policy object.
Expand Down
2 changes: 1 addition & 1 deletion docs/resources/netflow_record_policy.md
Original file line number Diff line number Diff line change
Expand Up @@ -89,13 +89,13 @@ All examples for the NetFlow Record Policy resource can be found in the [example
* `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.
Expand Down
2 changes: 1 addition & 1 deletion docs/resources/out_of_band_contract.md
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,7 @@ All examples for the Out Of Band Contract resource can be found in the [examples
* `id` - (string) The distinguished name (DN) of the Out Of Band Contract object.

### Optional ###

* `annotation` (annotation) - (string) The annotation of the Out Of Band Contract object.
- Default: `orchestrator:terraform`
* `description` (descr) - (string) The description of the Out Of Band Contract object.
Expand Down
2 changes: 1 addition & 1 deletion docs/resources/pim_route_map_entry.md
Original file line number Diff line number Diff line change
Expand Up @@ -88,7 +88,7 @@ All examples for the Pim Route Map Entry resource can be found in the [examples]
* `id` - (string) The distinguished name (DN) of the Pim Route Map Entry object.

### Optional ###

* `action` (action) - (string) The route action of the Pim Route Map Entry object.
- Default: `permit`
- Valid Values: `deny`, `permit`.
Expand Down
2 changes: 1 addition & 1 deletion docs/resources/pim_route_map_policy.md
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,7 @@ All examples for the Pim Route Map Policy resource can be found in the [examples
* `id` - (string) The distinguished name (DN) of the Pim Route Map Policy object.

### Optional ###

* `annotation` (annotation) - (string) The annotation of the Pim Route Map Policy object.
- Default: `orchestrator:terraform`
* `description` (descr) - (string) The description of the Pim Route Map Policy object.
Expand Down
Loading

0 comments on commit f66657b

Please sign in to comment.