-
Notifications
You must be signed in to change notification settings - Fork 106
Aci poe interface policy (DCNE-599) #1416
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
akinross
wants to merge
2
commits into
CiscoDevNet:master
Choose a base branch
from
akinross:aci_poe_interface_policy
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or 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,73 @@ | ||
| --- | ||
| # 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_poe_interface_policy" | ||
| sidebar_current: "docs-aci-data-source-aci_poe_interface_policy" | ||
| description: |- | ||
| Data source for ACI PoE Interface Policy | ||
| --- | ||
|
|
||
| # aci_poe_interface_policy # | ||
|
|
||
| Data source for ACI PoE Interface Policy | ||
|
|
||
| ## API Information ## | ||
|
|
||
| * Class: [poeIfPol](https://pubhub.devnetcloud.com/media/model-doc-latest/docs/app/index.html#/objects/poeIfPol/overview) | ||
|
|
||
| * Supported in ACI versions: 3.0(1k) and later. | ||
|
|
||
| * Distinguished Name Format: `uni/infra/poeIfP-{name}` | ||
|
|
||
| ## GUI Information ## | ||
|
|
||
| * Location: `Fabric -> Access Policies -> Policies -> Interface -> PoE` | ||
|
|
||
| ## Example Usage ## | ||
|
|
||
| ```hcl | ||
|
|
||
| data "aci_poe_interface_policy" "example" { | ||
| name = "test_name" | ||
| } | ||
|
|
||
| ``` | ||
|
|
||
| ## Schema ## | ||
|
|
||
| ### Required ### | ||
|
|
||
| * `name` (name) - (string) The name of the PoE Interface Policy object. | ||
|
|
||
| ### Read-Only ### | ||
|
|
||
| * `id` - (string) The distinguished name (DN) of the PoE Interface Policy object. | ||
| * `admin_st` (adminSt) - (string) The administrative state of the PoE Interface Policy object. This attribute is supported in ACI versions: 4.0(1h) and later. | ||
| * `annotation` (annotation) - (string) The annotation of the PoE Interface Policy object. This attribute is supported in ACI versions: 3.2(1l) and later. | ||
| * `description` (descr) - (string) The description of the PoE Interface Policy object. | ||
| * `maximum_power` (max) - (string) The maximum power in milliwatts that is allowed for the PoE Interface Policy object. The value must be in the range 4000 - 60000. | ||
| * `host_mode` (mode) - (string) The host mode of the PoE Interface Policy object. | ||
| * `name_alias` (nameAlias) - (string) The name alias of the PoE Interface 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. | ||
| * `poe_vlan` (poeVoiceVlan) - (string) The PoE VLAN of the PoE Interface Policy object. This attribute is supported in ACI versions: 4.0(1h) and later. | ||
| * `policing_action` (policeAct) - (string) The policing action of the PoE Interface Policy object. | ||
| * `port_priority_high` (prioHigh) - (string) Enable high port priority for the PoE Interface Policy object. | ||
| * `relation_to_application_epg` - (map) A map of Relation To Application EPG (ACI object [poeRsPoeEpg](https://pubhub.devnetcloud.com/media/model-doc-latest/docs/app/index.html#/objects/poeRsPoeEpg/overview)) pointing to Application EPG (ACI Object [fvAEPg](https://pubhub.devnetcloud.com/media/model-doc-latest/docs/app/index.html#/objects/fvAEPg/overview)). This attribute is supported in ACI versions: 4.0(1h) and later. | ||
| * `annotation` (annotation) - (string) The annotation of the Relation To Application EPG object. | ||
| * `target_dn` (tDn) - (string) The distinguished name (DN) of the EPG 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. | ||
| * `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 hidden or 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,172 @@ | ||
| --- | ||
| # 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_poe_interface_policy" | ||
| sidebar_current: "docs-aci-resource-aci_poe_interface_policy" | ||
| description: |- | ||
| Manages ACI PoE Interface Policy | ||
| --- | ||
|
|
||
| # aci_poe_interface_policy # | ||
|
|
||
| Manages ACI PoE Interface Policy | ||
|
|
||
|
|
||
|
|
||
| ## API Information ## | ||
|
|
||
| * Class: [poeIfPol](https://pubhub.devnetcloud.com/media/model-doc-latest/docs/app/index.html#/objects/poeIfPol/overview) | ||
|
|
||
| * Supported in ACI versions: 3.0(1k) and later. | ||
|
|
||
| * Distinguished Name Format: `uni/infra/poeIfP-{name}` | ||
|
|
||
| ## GUI Information ## | ||
|
|
||
| * Location: `Fabric -> Access Policies -> Policies -> Interface -> PoE` | ||
|
|
||
| ## Example Usage ## | ||
|
|
||
| The configuration snippet below creates a PoE Interface Policy with only required attributes. | ||
|
|
||
| ```hcl | ||
|
|
||
| resource "aci_poe_interface_policy" "example" { | ||
| name = "test_name" | ||
| } | ||
|
|
||
| ``` | ||
| The configuration snippet below shows all possible attributes of the PoE Interface Policy. | ||
|
|
||
| !> This example might not be valid configuration and is only used to show all possible attributes. | ||
|
|
||
| ```hcl | ||
|
|
||
| resource "aci_poe_interface_policy" "full_example" { | ||
| admin_st = "disabled" | ||
| annotation = "annotation" | ||
| description = "description_1" | ||
| maximum_power = "15400" | ||
| host_mode = "never" | ||
| name = "test_name" | ||
| name_alias = "name_alias_1" | ||
| owner_key = "owner_key_1" | ||
| owner_tag = "owner_tag_1" | ||
| poe_vlan = "vlan-200" | ||
| policing_action = "log" | ||
| port_priority_high = "yes" | ||
| relation_to_application_epg = { | ||
| annotation = "annotation_1" | ||
| target_dn = aci_application_epg.test_application_epg_0.id | ||
| annotations = [ | ||
| { | ||
| key = "key_0" | ||
| value = "value_1" | ||
| } | ||
| ] | ||
| tags = [ | ||
| { | ||
| key = "key_0" | ||
| value = "value_1" | ||
| } | ||
| ] | ||
| } | ||
| annotations = [ | ||
| { | ||
| key = "key_0" | ||
| value = "value_1" | ||
| } | ||
| ] | ||
| tags = [ | ||
| { | ||
| key = "key_0" | ||
| value = "value_1" | ||
| } | ||
| ] | ||
| } | ||
|
|
||
| ``` | ||
|
|
||
| All examples for the PoE Interface Policy resource can be found in the [examples](https://github.com/CiscoDevNet/terraform-provider-aci/tree/master/examples/resources/aci_poe_interface_policy) folder. | ||
|
|
||
| ## Schema ## | ||
|
|
||
| ### Required ### | ||
|
|
||
| * `name` (name) - (string) The name of the PoE Interface Policy object. | ||
|
|
||
| ### Read-Only ### | ||
|
|
||
| * `id` - (string) The distinguished name (DN) of the PoE Interface Policy object. | ||
|
|
||
| ### Optional ### | ||
|
|
||
| * `admin_st` (adminSt) - (string) The administrative state of the PoE Interface Policy object. This attribute is supported in ACI versions: 4.0(1h) and later. | ||
| - Default: `"disabled"` | ||
| - Valid Values: `"disabled"`, `"enabled"`. | ||
| * `annotation` (annotation) - (string) The annotation of the PoE Interface Policy object. This attribute is supported in ACI versions: 3.2(1l) and later. | ||
| - Default: `"orchestrator:terraform"` | ||
| * `description` (descr) - (string) The description of the PoE Interface Policy object. | ||
| * `maximum_power` (max) - (string) The maximum power in milliwatts that is allowed for the PoE Interface Policy object. The value must be in the range 4000 - 60000. | ||
| - Default: `"30000"` | ||
| * `host_mode` (mode) - (string) The host mode of the PoE Interface Policy object. | ||
| - Default: `"auto"` | ||
| - Valid Values: `"auto"`, `"never"`, `"static"`. | ||
| * `name_alias` (nameAlias) - (string) The name alias of the PoE Interface 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. | ||
| * `poe_vlan` (poeVoiceVlan) - (string) The PoE VLAN of the PoE Interface Policy object. This attribute is supported in ACI versions: 4.0(1h) and later. | ||
| - Default: `"unknown"` | ||
| * `policing_action` (policeAct) - (string) The policing action of the PoE Interface Policy object. | ||
| - Default: `"err-dis"` | ||
| - Valid Values: `"err-dis"`, `"log"`, `"none"`. | ||
| * `port_priority_high` (prioHigh) - (string) Enable high port priority for the PoE Interface Policy object. | ||
| - Default: `"no"` | ||
| - Valid Values: `"no"`, `"yes"`. | ||
| * `relation_to_application_epg` - (map) A map of Relation To Application EPG (ACI object [poeRsPoeEpg](https://pubhub.devnetcloud.com/media/model-doc-latest/docs/app/index.html#/objects/poeRsPoeEpg/overview)) pointing to Application EPG (ACI Object [fvAEPg](https://pubhub.devnetcloud.com/media/model-doc-latest/docs/app/index.html#/objects/fvAEPg/overview)) which can be configured using the [aci_application_epg](https://registry.terraform.io/providers/CiscoDevNet/aci/latest/docs/resources/application_epg) resource. This attribute is supported in ACI versions: 4.0(1h) and later. | ||
| #### Optional #### | ||
|
|
||
| * `annotation` (annotation) - (string) The annotation of the Relation To Application EPG object. | ||
| - Default: `"orchestrator:terraform"` | ||
| * `target_dn` (tDn) - (string) The distinguished name (DN) of the EPG 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. | ||
| * `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 PoE Interface 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_poe_interface_policy.example uni/infra/poeIfP-{name} | ||
| ``` | ||
|
|
||
| Starting in Terraform version 1.5, an existing PoE Interface Policy can be imported | ||
| using [import blocks](https://developer.hashicorp.com/terraform/language/import) via the following configuration: | ||
|
|
||
| ``` | ||
| import { | ||
| id = "uni/infra/poeIfP-{name}" | ||
| to = aci_poe_interface_policy.example | ||
| } | ||
| ``` | ||
4 changes: 4 additions & 0 deletions
4
examples/data-sources/aci_poe_interface_policy/data-source.tf
This file contains hidden or 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,4 @@ | ||
|
|
||
| data "aci_poe_interface_policy" "example" { | ||
| name = "test_name" | ||
| } |
14 changes: 14 additions & 0 deletions
14
examples/data-sources/aci_poe_interface_policy/provider.tf
This file contains hidden or 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 hidden or 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 | ||
| } |
43 changes: 43 additions & 0 deletions
43
examples/resources/aci_poe_interface_policy/resource-all-attributes.tf
This file contains hidden or 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,43 @@ | ||
|
|
||
| resource "aci_poe_interface_policy" "full_example" { | ||
| admin_st = "disabled" | ||
| annotation = "annotation" | ||
| description = "description_1" | ||
| maximum_power = "15400" | ||
| host_mode = "never" | ||
| name = "test_name" | ||
| name_alias = "name_alias_1" | ||
| owner_key = "owner_key_1" | ||
| owner_tag = "owner_tag_1" | ||
| poe_vlan = "vlan-200" | ||
| policing_action = "log" | ||
| port_priority_high = "yes" | ||
| relation_to_application_epg = { | ||
| annotation = "annotation_1" | ||
| target_dn = aci_application_epg.test_application_epg_0.id | ||
| annotations = [ | ||
| { | ||
| key = "key_0" | ||
| value = "value_1" | ||
| } | ||
| ] | ||
| tags = [ | ||
| { | ||
| key = "key_0" | ||
| value = "value_1" | ||
| } | ||
| ] | ||
| } | ||
| annotations = [ | ||
| { | ||
| key = "key_0" | ||
| value = "value_1" | ||
| } | ||
| ] | ||
| tags = [ | ||
| { | ||
| key = "key_0" | ||
| value = "value_1" | ||
| } | ||
| ] | ||
| } |
This file contains hidden or 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,4 @@ | ||
|
|
||
| resource "aci_poe_interface_policy" "example" { | ||
| name = "test_name" | ||
| } |
This file contains hidden or 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.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I remember having a discussion that we would include expanding abbreviations in the docs some shape or form. Did we decide to include those in a glossary? Is an issue opened for this? @samiib @akinross
Uh oh!
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think there was a discussion indeed but no issue has been tracked for this as far as I know. You want to change it to Power over Ethernet (PoE)? Or other suggestion?