Skip to content

Commit

Permalink
[ignore] Fix documentation sentences
Browse files Browse the repository at this point in the history
  • Loading branch information
akinross committed Jul 2, 2024
1 parent 72eaf20 commit 7a32fa8
Show file tree
Hide file tree
Showing 29 changed files with 51 additions and 51 deletions.
10 changes: 5 additions & 5 deletions docs/data-sources/endpoint_security_group.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,18 +53,18 @@ data "aci_endpoint_security_group" "example_application_profile" {
* `exception_tag` (exceptionTag) - (string) Contract Exception Tag.
* `match_criteria` (matchT) - (string) The provider label match criteria.
* `name_alias` (nameAlias) - (string) The name alias of the Endpoint Security Group object.
* `intra_esg_isolation` (pcEnfPref) - (string) Represents parameter used by the node (i.e. Leaf) to enforce filter rules in this ESG.
* `preferred_group_member` (prefGrMemb) - (string) Represents parameter used to determine if the ESG is part of a group that is not a contract for communication.
* `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.

* `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 system class determines the quality of service and priority for the consumer traffic.
* `priority` (prio) - (string) The QoS priority class identifierq of the Relation To Consumed Contract object.
* `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 contract interface priority.
* `priority` (prio) - (string) The QoS priority class identifierq of the Relation To Imported Contract object.
* `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.
Expand All @@ -74,7 +74,7 @@ data "aci_endpoint_security_group" "example_application_profile" {
* `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 system class determines the quality of service and priority for the consumer traffic.
* `priority` (prio) - (string) The QoS priority class identifierq of the Relation To Provided Contract object.
* `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)).
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.
* `priority` (prio) - (string) The QoS priority class identifierq of the External Management Network Instance Profile object.

* `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 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.
* `priority` (prio) - (string) The QoS priority class identifierq of the Relation To Consumed Out Of Band Contract object.
* `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 priority of the Out Of Band Contract object.
* `priority` (prio) - (string) The QoS priority class identifierq of the Out Of Band Contract object.
* `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 system class determines the quality of service and priority for the consumer traffic.
* `priority` (prio) - (string) The QoS priority class identifierq of the Relation To Consumed 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.
* `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 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.
* `priority` (prio) - (string) The QoS priority class identifierq of the Relation To Consumed 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.
* `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 contract interface priority.
* `priority` (prio) - (string) The QoS priority class identifierq of the Relation To Imported 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.
* `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_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 system class determines the quality of service and priority for the consumer traffic.
* `priority` (prio) - (string) The QoS priority class identifierq of the Relation To Provided 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.
* `key` (key) - (string) The key used to uniquely identify this configuration object.
Expand Down
10 changes: 5 additions & 5 deletions docs/resources/endpoint_security_group.md
Original file line number Diff line number Diff line change
Expand Up @@ -137,10 +137,10 @@ All examples for the Endpoint Security Group resource can be found in the [examp
- Default: `AtleastOne`
- Valid Values: `All`, `AtleastOne`, `AtmostOne`, `None`.
* `name_alias` (nameAlias) - (string) The name alias of the Endpoint Security Group object.
* `intra_esg_isolation` (pcEnfPref) - (string) Represents parameter used by the node (i.e. Leaf) to enforce filter rules in this ESG.
* `intra_esg_isolation` (pcEnfPref) - (string) Parameter used to determine whether communication between endpoints within the ESG is blocked.
- Default: `unenforced`
- Valid Values: `enforced`, `unenforced`.
* `preferred_group_member` (prefGrMemb) - (string) Represents parameter used to determine if the ESG is part of a group that is not a contract for communication.
* `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.
- Default: `exclude`
- Valid Values: `exclude`, `include`.
* `admin_state` (shutdown) - (string) Withdraw ESg Configuration from all Nodes in the Fabric.
Expand All @@ -157,7 +157,7 @@ All examples for the Endpoint Security Group resource can be found in the [examp

* `annotation` (annotation) - (string) The annotation of the Relation To Consumed Contract object.
- Default: `orchestrator:terraform`
* `priority` (prio) - (string) The system class determines the quality of service and priority for the consumer traffic.
* `priority` (prio) - (string) The QoS priority class identifierq of the Relation To Consumed Contract object.
- Default: `unspecified`
- Valid Values: `level1`, `level2`, `level3`, `level4`, `level5`, `level6`, `unspecified`.

Expand All @@ -171,7 +171,7 @@ All examples for the Endpoint Security Group resource can be found in the [examp

* `annotation` (annotation) - (string) The annotation of the Relation To Imported Contract object.
- Default: `orchestrator:terraform`
* `priority` (prio) - (string) The contract interface priority.
* `priority` (prio) - (string) The QoS priority class identifierq of the Relation To Imported Contract object.
- Default: `unspecified`
- Valid Values: `level1`, `level2`, `level3`, `level4`, `level5`, `level6`, `unspecified`.

Expand Down Expand Up @@ -199,7 +199,7 @@ All examples for the Endpoint Security Group resource can be found in the [examp
* `match_criteria` (matchT) - (string) The matched EPG type.
- Default: `AtleastOne`
- Valid Values: `All`, `AtleastOne`, `AtmostOne`, `None`.
* `priority` (prio) - (string) The system class determines the quality of service and priority for the consumer traffic.
* `priority` (prio) - (string) The QoS priority class identifierq of the Relation To Provided Contract object.
- Default: `unspecified`
- Valid Values: `level1`, `level2`, `level3`, `level4`, `level5`, `level6`, `unspecified`.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -92,7 +92,7 @@ All examples for the External Management Network Instance Profile resource can b
- Default: `orchestrator:terraform`
* `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.
* `priority` (prio) - (string) The QoS priority class identifierq of the External Management Network Instance Profile object.
- Default: `unspecified`
- Valid Values: `level1`, `level2`, `level3`, `level4`, `level5`, `level6`, `unspecified`.

Expand All @@ -106,7 +106,7 @@ All examples for the External Management Network Instance Profile resource can b

* `annotation` (annotation) - (string) The annotation of the Relation To Consumed Out Of Band Contract object.
- Default: `orchestrator:terraform`
* `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.
* `priority` (prio) - (string) The QoS priority class identifierq of the Relation To Consumed Out Of Band Contract object.
- Default: `unspecified`
- Valid Values: `level1`, `level2`, `level3`, `level4`, `level5`, `level6`, `unspecified`.

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 @@ -95,7 +95,7 @@ All examples for the Out Of Band Contract resource can be found in the [examples
* `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 priority of the Out Of Band Contract object.
* `priority` (prio) - (string) The QoS priority class identifierq of the Out Of Band Contract object.
- Default: `unspecified`
- Valid Values: `level1`, `level2`, `level3`, `level4`, `level5`, `level6`, `unspecified`.
* `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.
Expand Down
2 changes: 1 addition & 1 deletion docs/resources/relation_to_consumed_contract.md
Original file line number Diff line number Diff line change
Expand Up @@ -139,7 +139,7 @@ All examples for the Relation To Consumed Contract resource can be found in the

* `annotation` (annotation) - (string) The annotation of the Relation To Consumed Contract object.
- Default: `orchestrator:terraform`
* `priority` (prio) - (string) The system class determines the quality of service and priority for the consumer traffic.
* `priority` (prio) - (string) The QoS priority class identifierq of the Relation To Consumed Contract object.
- Default: `unspecified`
- Valid Values: `level1`, `level2`, `level3`, `level4`, `level5`, `level6`, `unspecified`.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,7 @@ All examples for the Relation To Consumed Out Of Band Contract resource can be f

* `annotation` (annotation) - (string) The annotation of the Relation To Consumed Out Of Band Contract object.
- Default: `orchestrator:terraform`
* `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.
* `priority` (prio) - (string) The QoS priority class identifierq of the Relation To Consumed Out Of Band Contract object.
- Default: `unspecified`
- Valid Values: `level1`, `level2`, `level3`, `level4`, `level5`, `level6`, `unspecified`.

Expand Down
2 changes: 1 addition & 1 deletion docs/resources/relation_to_imported_contract.md
Original file line number Diff line number Diff line change
Expand Up @@ -139,7 +139,7 @@ All examples for the Relation To Imported Contract resource can be found in the

* `annotation` (annotation) - (string) The annotation of the Relation To Imported Contract object.
- Default: `orchestrator:terraform`
* `priority` (prio) - (string) The contract interface priority.
* `priority` (prio) - (string) The QoS priority class identifierq of the Relation To Imported Contract object.
- Default: `unspecified`
- Valid Values: `level1`, `level2`, `level3`, `level4`, `level5`, `level6`, `unspecified`.

Expand Down
2 changes: 1 addition & 1 deletion docs/resources/relation_to_provided_contract.md
Original file line number Diff line number Diff line change
Expand Up @@ -144,7 +144,7 @@ All examples for the Relation To Provided Contract resource can be found in the
* `match_criteria` (matchT) - (string) The matched EPG type.
- Default: `AtleastOne`
- Valid Values: `All`, `AtleastOne`, `AtmostOne`, `None`.
* `priority` (prio) - (string) The system class determines the quality of service and priority for the consumer traffic.
* `priority` (prio) - (string) The QoS priority class identifierq of the Relation To Provided Contract object.
- Default: `unspecified`
- Valid Values: `level1`, `level2`, `level3`, `level4`, `level5`, `level6`, `unspecified`.

Expand Down
Loading

0 comments on commit 7a32fa8

Please sign in to comment.