community.network.pn_port_cos_rate_setting – CLI command to modify port-cos-rate-setting
Note
This plugin is part of the community.network collection (version 3.0.0).
You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.
To install it, use: ansible-galaxy collection install community.network.
To use it in a playbook, specify: community.network.pn_port_cos_rate_setting.
Synopsis
- This modules can be used to update the port cos rate limit.
Parameters
| Parameter | Choices/Defaults | Comments |
|---|---|---|
| pn_cliswitch
string
|
Target switch to run the CLI on.
|
|
| pn_cos0_rate
string
|
cos0 rate limit (pps) unlimited or 0 to 10000000.
|
|
| pn_cos1_rate
string
|
cos1 rate limit (pps) unlimited or 0 to 10000000.
|
|
| pn_cos2_rate
string
|
cos2 rate limit (pps) unlimited or 0 to 10000000.
|
|
| pn_cos3_rate
string
|
cos3 rate limit (pps) unlimited or 0 to 10000000.
|
|
| pn_cos4_rate
string
|
cos4 rate limit (pps) unlimited or 0 to 10000000.
|
|
| pn_cos5_rate
string
|
cos5 rate limit (pps) unlimited or 0 to 10000000.
|
|
| pn_cos6_rate
string
|
cos6 rate limit (pps) unlimited or 0 to 10000000.
|
|
| pn_cos7_rate
string
|
cos7 rate limit (pps) unlimited or 0 to 10000000.
|
|
| pn_port
string
|
|
port.
|
| state
string / required
|
|
State the action to perform. Use update to modify the port-cos-rate-setting.
|
Examples
- name: Port cos rate modify
community.network.pn_port_cos_rate_setting:
pn_cliswitch: "sw01"
state: "update"
pn_port: "control-port"
pn_cos1_rate: "1000"
pn_cos5_rate: "1000"
pn_cos2_rate: "1000"
pn_cos0_rate: "1000"
- name: Port cos rate modify
community.network.pn_port_cos_rate_setting:
pn_cliswitch: "sw01"
state: "update"
pn_port: "data-port"
pn_cos1_rate: "2000"
pn_cos5_rate: "2000"
pn_cos2_rate: "2000"
pn_cos0_rate: "2000"
Return Values
Common return values are documented here, the following are the fields unique to this module:
| Key | Returned | Description |
|---|---|---|
| changed
boolean
|
always |
indicates whether the CLI caused changes on the target.
|
| command
string
|
always |
the CLI command run on the target node.
|
| stderr
list / elements=string
|
on error |
set of error responses from the port-cos-rate-setting command.
|
| stdout
list / elements=string
|
always |
set of responses from the port-cos-rate-setting command.
|
Authors
- Pluribus Networks (@rajaspachipulusu17)
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/community/network/pn_port_cos_rate_setting_module.html