W3cubDocs

/Ansible

community.network.pn_stp – CLI command to modify stp

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.

Synopsis

  • This module can be used to modify Spanning Tree Protocol parameters.

Parameters

Parameter Choices/Defaults Comments
pn_bpdus_bridge_ports
boolean
    Choices:
  • no
  • yes
BPDU packets to bridge specific port.
pn_bridge_id
string
STP bridge id.
pn_bridge_priority
string
Default:
"32768"
STP bridge priority.
pn_cliswitch
string
Target switch to run the CLI on.
pn_enable
boolean
    Choices:
  • no
  • yes
enable or disable STP
pn_forwarding_delay
string
Default:
"15"
STP forwarding delay between 4 and 30 secs.
pn_hello_time
string
Default:
"2"
STP hello time between 1 and 10 secs.
pn_max_age
string
Default:
"20"
maximum age time between 6 and 40 secs.
pn_mst_config_name
string
Name for MST Configuration Instance.
pn_mst_max_hops
string
Default:
"20"
maximum hop count for mstp bpdu.
pn_root_guard_wait_time
string
Default:
"20"
root guard wait time between 0 and 300 secs. 0 to disable wait.
pn_stp_mode
string
    Choices:
  • rstp
  • mstp
STP mode.
state
string / required
    Choices:
  • update
State the action to perform. Use update to stp.

Examples

- name: Modify stp
  community.network.pn_stp:
    pn_cliswitch: "sw01"
    state: "update"
    pn_hello_time: "3"
    pn_stp_mode: "rstp"

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 stp command.
stdout
list / elements=string
always
set of responses from the stp 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_stp_module.html