community.network.pn_port_cos_bw – CLI command to modify port-cos-bw
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_bw.
Synopsis
- This module can be used to update bw settings for CoS queues.
Parameters
| Parameter | Choices/Defaults | Comments |
|---|---|---|
| pn_cliswitch
string
|
Target switch to run the CLI on.
|
|
| pn_cos
string
|
CoS priority.
|
|
| pn_max_bw_limit
string
|
Maximum b/w in percentage.
|
|
| pn_min_bw_guarantee
string
|
Minimum b/w in percentage.
|
|
| pn_port
string
|
physical port number.
|
|
| pn_weight
string
|
|
Scheduling weight (1 to 127) after b/w guarantee met.
|
| state
string / required
|
|
State the action to perform. Use update to modify the port-cos-bw.
|
Examples
- name: Port cos bw modify
community.network.pn_port_cos_bw:
pn_cliswitch: "sw01"
state: "update"
pn_port: "1"
pn_cos: "0"
pn_min_bw_guarantee: "60"
- name: Port cos bw modify
community.network.pn_port_cos_bw:
pn_cliswitch: "sw01"
state: "update"
pn_port: "all"
pn_cos: "0"
pn_weight: "priority"
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-bw command.
|
| stdout
list / elements=string
|
always |
set of responses from the port-cos-bw 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_bw_module.html