Skip to content

Commit

Permalink
[ignore] Change documentation for attributes
Browse files Browse the repository at this point in the history
  • Loading branch information
akinross authored and lhercot committed Jul 2, 2024
1 parent 0f79c1e commit c9b51cd
Show file tree
Hide file tree
Showing 33 changed files with 62 additions and 57 deletions.
12 changes: 6 additions & 6 deletions docs/data-sources/endpoint_security_group.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,31 +55,31 @@ data "aci_endpoint_security_group" "example_application_profile" {
* `name_alias` (nameAlias) - (string) The name alias of the Endpoint Security Group object.
* `intra_esg_isolation` (pcEnfPref) - (string) Parameter used to determine whether communication between endpoints within the ESG is blocked.
* `preferred_group_member` (prefGrMemb) - (string) Parameter used to determine whether the ESG is part of the preferred group. Members of this group are allowed to communicate without contracts.
* `admin_state` (shutdown) - (string) Withdraw ESg Configuration from all Nodes in the Fabric.
* `admin_state` (shutdown) - (string) Withdraw the ESG configuration from all nodes in the fabric.

* `relation_to_consumed_contracts` - (list) A list of Relation To Consumed Contracts (ACI object [fvRsCons](https://pubhub.devnetcloud.com/media/model-doc-latest/docs/app/index.html#/objects/fvRsCons/overview)) pointing to Contract (ACI Object [vzBrCP](https://pubhub.devnetcloud.com/media/model-doc-latest/docs/app/index.html#/objects/vzBrCP/overview)). This attribute is supported in ACI versions: 1.0(1e) and later.
* `annotation` (annotation) - (string) The annotation of the Relation To Consumed Contract object.
* `priority` (prio) - (string) The QoS priority class identifier of the Relation To Consumed Contract object.
* `priority` (prio) - (string) The Quality of Service (QoS) priority class ID. QoS refers to the capability of a network to provide better service to selected network traffic over various technologies. The primary goal of QoS is to provide priority including dedicated bandwidth, controlled jitter and latency (required by some real-time and interactive traffic), and improved loss characteristics. You can configure the bandwidth of each QoS level using QoS profiles.
* `contract_name` (tnVzBrCPName) - (string) The consumer contract name.

* `relation_to_imported_contracts` - (list) A list of Relation To Imported Contracts (ACI object [fvRsConsIf](https://pubhub.devnetcloud.com/media/model-doc-latest/docs/app/index.html#/objects/fvRsConsIf/overview)) pointing to Imported Contract (ACI Object [vzCPIf](https://pubhub.devnetcloud.com/media/model-doc-latest/docs/app/index.html#/objects/vzCPIf/overview)). This attribute is supported in ACI versions: 1.0(1e) and later.
* `annotation` (annotation) - (string) The annotation of the Relation To Imported Contract object.
* `priority` (prio) - (string) The QoS priority class identifier of the Relation To Imported Contract object.
* `priority` (prio) - (string) The Quality of Service (QoS) priority class ID. QoS refers to the capability of a network to provide better service to selected network traffic over various technologies. The primary goal of QoS is to provide priority including dedicated bandwidth, controlled jitter and latency (required by some real-time and interactive traffic), and improved loss characteristics. You can configure the bandwidth of each QoS level using QoS profiles.
* `imported_contract_name` (tnVzCPIfName) - (string) The contract interface name.

* `relation_to_intra_epg_contracts` - (list) A list of Relation To Intra Epg Contracts (ACI object [fvRsIntraEpg](https://pubhub.devnetcloud.com/media/model-doc-latest/docs/app/index.html#/objects/fvRsIntraEpg/overview)) pointing to Contract (ACI Object [vzBrCP](https://pubhub.devnetcloud.com/media/model-doc-latest/docs/app/index.html#/objects/vzBrCP/overview)). This attribute is supported in ACI versions: 3.0(1k) and later.
* `annotation` (annotation) - (string) The annotation of the Relation To Intra Epg Contract object.
* `contract_name` (tnVzBrCPName) - (string) The binary contract name.
* `contract_name` (tnVzBrCPName) - (string) The contract name.

* `relation_to_provided_contracts` - (list) A list of Relation To Provided Contracts (ACI object [fvRsProv](https://pubhub.devnetcloud.com/media/model-doc-latest/docs/app/index.html#/objects/fvRsProv/overview)) pointing to Contract (ACI Object [vzBrCP](https://pubhub.devnetcloud.com/media/model-doc-latest/docs/app/index.html#/objects/vzBrCP/overview)). This attribute is supported in ACI versions: 1.0(1e) and later.
* `annotation` (annotation) - (string) The annotation of the Relation To Provided Contract object.
* `match_criteria` (matchT) - (string) The matched EPG type.
* `priority` (prio) - (string) The QoS priority class identifier of the Relation To Provided Contract object.
* `priority` (prio) - (string) The Quality of Service (QoS) priority class ID. QoS refers to the capability of a network to provide better service to selected network traffic over various technologies. The primary goal of QoS is to provide priority including dedicated bandwidth, controlled jitter and latency (required by some real-time and interactive traffic), and improved loss characteristics. You can configure the bandwidth of each QoS level using QoS profiles.
* `contract_name` (tnVzBrCPName) - (string) The provider contract name.

* `relation_to_vrf` - (list) A list of Relation To VRF (ACI object [fvRsScope](https://pubhub.devnetcloud.com/media/model-doc-latest/docs/app/index.html#/objects/fvRsScope/overview)) pointing to VRF (ACI Object [fvCtx](https://pubhub.devnetcloud.com/media/model-doc-latest/docs/app/index.html#/objects/fvCtx/overview)).
* `annotation` (annotation) - (string) The annotation of the Relation To VRF object.
* `vrf_name` (tnFvCtxName) - (string) Name.
* `vrf_name` (tnFvCtxName) - (string) The name of the VRF object.

* `relation_to_contract_masters` - (list) A list of Relation To Contract Masters (ACI object [fvRsSecInherited](https://pubhub.devnetcloud.com/media/model-doc-latest/docs/app/index.html#/objects/fvRsSecInherited/overview)) pointing to Endpoint Security Group (ACI Object [fvESg](https://pubhub.devnetcloud.com/media/model-doc-latest/docs/app/index.html#/objects/fvESg/overview)). This attribute is supported in ACI versions: 2.3(1e) and later.
* `annotation` (annotation) - (string) The annotation of the Relation To Contract Master object.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -48,11 +48,11 @@ data "aci_external_management_network_instance_profile" "example" {
* `annotation` (annotation) - (string) The annotation of the External Management Network Instance Profile object.
* `description` (descr) - (string) The description of the External Management Network Instance Profile object.
* `name_alias` (nameAlias) - (string) The name alias of the External Management Network Instance Profile object.
* `priority` (prio) - (string) The QoS priority class identifier of the External Management Network Instance Profile object.
* `priority` (prio) - (string) The Quality of Service (QoS) priority class ID. QoS refers to the capability of a network to provide better service to selected network traffic over various technologies. The primary goal of QoS is to provide priority including dedicated bandwidth, controlled jitter and latency (required by some real-time and interactive traffic), and improved loss characteristics. You can configure the bandwidth of each QoS level using QoS profiles.

* `relation_to_consumed_out_of_band_contracts` - (list) A list of Relation To Consumed Out Of Band Contracts (ACI object [mgmtRsOoBCons](https://pubhub.devnetcloud.com/media/model-doc-latest/docs/app/index.html#/objects/mgmtRsOoBCons/overview)) pointing to Out Of Band Contract (ACI Object [vzOOBBrCP](https://pubhub.devnetcloud.com/media/model-doc-latest/docs/app/index.html#/objects/vzOOBBrCP/overview)).
* `annotation` (annotation) - (string) The annotation of the Relation To Consumed Out Of Band Contract object.
* `priority` (prio) - (string) The QoS priority class identifier of the Relation To Consumed Out Of Band Contract object.
* `priority` (prio) - (string) The Quality of Service (QoS) priority class ID. QoS refers to the capability of a network to provide better service to selected network traffic over various technologies. The primary goal of QoS is to provide priority including dedicated bandwidth, controlled jitter and latency (required by some real-time and interactive traffic), and improved loss characteristics. You can configure the bandwidth of each QoS level using QoS profiles.
* `out_of_band_contract_name` (tnVzOOBBrCPName) - (string) The name of the Out Of Band Contract 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.
Expand Down
2 changes: 1 addition & 1 deletion docs/data-sources/out_of_band_contract.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ data "aci_out_of_band_contract" "example" {
* `name_alias` (nameAlias) - (string) The name alias of the Out Of Band Contract 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.
* `priority` (prio) - (string) The QoS priority class identifier of the Out Of Band Contract object.
* `priority` (prio) - (string) The Quality of Service (QoS) priority class ID. QoS refers to the capability of a network to provide better service to selected network traffic over various technologies. The primary goal of QoS is to provide priority including dedicated bandwidth, controlled jitter and latency (required by some real-time and interactive traffic), and improved loss characteristics. You can configure the bandwidth of each QoS level using QoS profiles.
* `scope` (scope) - (string) Represents the scope of this contract. If the scope is set as application-profile, the epg can only communicate with epgs in the same application-profile.
* `target_dscp` (targetDscp) - (string) The target DSCP value of the Out Of Band Contract object.

Expand Down
2 changes: 1 addition & 1 deletion docs/data-sources/relation_to_consumed_contract.md
Original file line number Diff line number Diff line change
Expand Up @@ -84,7 +84,7 @@ data "aci_relation_to_consumed_contract" "example_endpoint_security_group" {

* `id` - (string) The distinguished name (DN) of the Relation To Consumed Contract object.
* `annotation` (annotation) - (string) The annotation of the Relation To Consumed Contract object.
* `priority` (prio) - (string) The QoS priority class identifier of the Relation To Consumed Contract object.
* `priority` (prio) - (string) The Quality of Service (QoS) priority class ID. QoS refers to the capability of a network to provide better service to selected network traffic over various technologies. The primary goal of QoS is to provide priority including dedicated bandwidth, controlled jitter and latency (required by some real-time and interactive traffic), and improved loss characteristics. You can configure the bandwidth of each QoS level using QoS profiles.

* `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.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ data "aci_relation_to_consumed_out_of_band_contract" "example_external_managemen

* `id` - (string) The distinguished name (DN) of the Relation To Consumed Out Of Band Contract object.
* `annotation` (annotation) - (string) The annotation of the Relation To Consumed Out Of Band Contract object.
* `priority` (prio) - (string) The QoS priority class identifier of the Relation To Consumed Out Of Band Contract object.
* `priority` (prio) - (string) The Quality of Service (QoS) priority class ID. QoS refers to the capability of a network to provide better service to selected network traffic over various technologies. The primary goal of QoS is to provide priority including dedicated bandwidth, controlled jitter and latency (required by some real-time and interactive traffic), and improved loss characteristics. You can configure the bandwidth of each QoS level using QoS profiles.

* `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.
Expand Down
2 changes: 1 addition & 1 deletion docs/data-sources/relation_to_imported_contract.md
Original file line number Diff line number Diff line change
Expand Up @@ -84,7 +84,7 @@ data "aci_relation_to_imported_contract" "example_endpoint_security_group" {

* `id` - (string) The distinguished name (DN) of the Relation To Imported Contract object.
* `annotation` (annotation) - (string) The annotation of the Relation To Imported Contract object.
* `priority` (prio) - (string) The QoS priority class identifier of the Relation To Imported Contract object.
* `priority` (prio) - (string) The Quality of Service (QoS) priority class ID. QoS refers to the capability of a network to provide better service to selected network traffic over various technologies. The primary goal of QoS is to provide priority including dedicated bandwidth, controlled jitter and latency (required by some real-time and interactive traffic), and improved loss characteristics. You can configure the bandwidth of each QoS level using QoS profiles.

* `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.
Expand Down
2 changes: 1 addition & 1 deletion docs/data-sources/relation_to_intra_epg_contract.md
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,7 @@ data "aci_relation_to_intra_epg_contract" "example_endpoint_security_group" {
- [vnsSDEPpInfo](https://pubhub.devnetcloud.com/media/model-doc-latest/docs/app/index.html#/objects/vnsSDEPpInfo/overview)
- [vnsSHEPpInfo](https://pubhub.devnetcloud.com/media/model-doc-latest/docs/app/index.html#/objects/vnsSHEPpInfo/overview)

* `contract_name` (tnVzBrCPName) - (string) The binary contract name. This attribute can be referenced from a [resource](https://registry.terraform.io/providers/CiscoDevNet/aci/latest/docs/resources/contract) with `aci_contract.example.name` or from a [datasource](https://registry.terraform.io/providers/CiscoDevNet/aci/latest/docs/data-sources/contract) with `data.aci_contract.example.name`.
* `contract_name` (tnVzBrCPName) - (string) The contract name. This attribute can be referenced from a [resource](https://registry.terraform.io/providers/CiscoDevNet/aci/latest/docs/resources/contract) with `aci_contract.example.name` or from a [datasource](https://registry.terraform.io/providers/CiscoDevNet/aci/latest/docs/data-sources/contract) with `data.aci_contract.example.name`.

### Read-Only ###

Expand Down
2 changes: 1 addition & 1 deletion docs/data-sources/relation_to_provided_contract.md
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,7 @@ data "aci_relation_to_provided_contract" "example_endpoint_security_group" {
* `id` - (string) The distinguished name (DN) of the Relation To Provided Contract object.
* `annotation` (annotation) - (string) The annotation of the Relation To Provided Contract object.
* `match_criteria` (matchT) - (string) The matched EPG type.
* `priority` (prio) - (string) The QoS priority class identifier of the Relation To Provided Contract object.
* `priority` (prio) - (string) The Quality of Service (QoS) priority class ID. QoS refers to the capability of a network to provide better service to selected network traffic over various technologies. The primary goal of QoS is to provide priority including dedicated bandwidth, controlled jitter and latency (required by some real-time and interactive traffic), and improved loss characteristics. You can configure the bandwidth of each QoS level using QoS profiles.

* `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.
Expand Down
Loading

0 comments on commit c9b51cd

Please sign in to comment.