community.network.pn_port_cos_bw module – CLI command to modify port-cos-bw

Note

This module is part of the community.network collection (version 5.0.2).

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.

Aliases: network.netvisor.pn_port_cos_bw

Parameters

Parameter

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.

Choices:

  • "priority"

  • "no-priority"

state

string / required

State the action to perform. Use update to modify the port-cos-bw.

Choices:

  • "update"

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

Description

changed

boolean

indicates whether the CLI caused changes on the target.

Returned: always

command

string

the CLI command run on the target node.

Returned: always

stderr

list / elements=string

set of error responses from the port-cos-bw command.

Returned: on error

stdout

list / elements=string

set of responses from the port-cos-bw command.

Returned: always

Authors

  • Pluribus Networks (@rajaspachipulusu17)