You are reading an unmaintained version of the Ansible documentation. Unmaintained Ansible versions can contain unfixed security vulnerabilities (CVE). Please upgrade to a maintained version. See the latest Ansible documentation.

community.network.pn_stp_port – CLI command to modify stp-port.

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_stp_port.

Synopsis

• This module can be used modify Spanning Tree Protocol (STP) parameters on ports.

Parameters

Parameter	Comments
pn_block boolean	Specify if a STP port blocks BPDUs. Choices: no yes
pn_bpdu_guard boolean	STP port BPDU guard. Choices: no yes
pn_cliswitch string	Target switch to run the CLI on.
pn_cost string	STP port cost from 1 to 200000000. Default: “2000”
pn_edge boolean	STP port is an edge port. Choices: no yes
pn_filter boolean	STP port filters BPDUs. Choices: no yes
pn_port string	STP port.
pn_priority string	STP port priority from 0 to 240. Default: “128”
pn_root_guard boolean	STP port Root guard. Choices: no yes
state string / required	State the action to perform. Use update to update stp-port. Choices: update

Examples

- name: Modify stp port
  community.network.pn_stp_port:
    pn_cliswitch: "sw01"
    state: "update"
    pn_port: "1"
    pn_filter: True
    pn_priority: '144'

- name: Modify stp port
  community.network.pn_stp_port:
    pn_cliswitch: "sw01"
    state: "update"
    pn_port: "1"
    pn_cost: "200"

- name: Modify stp port
  community.network.pn_stp_port:
    pn_cliswitch: "sw01"
    state: "update"
    pn_port: "1"
    pn_edge: True
    pn_cost: "200"

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 stp-port command. Returned: on error
stdout list / elements=string	set of responses from the stp-port command. Returned: always

Authors

• Pluribus Networks (@rajaspachipulusu17)