community.network.pn_stp module – CLI command to modify stp
Note
This module is part of the community.network collection (version 5.1.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
.
Note
The community.network collection has been deprecated and will be removed from Ansible 12. See the discussion thread for more information.
DEPRECATED
- Removed in:
version 6.0.0
- Why:
This collection and all content in it is unmaintained and deprecated.
- Alternative:
Unknown.
Synopsis
This module can be used to modify Spanning Tree Protocol parameters.
Aliases: network.netvisor.pn_stp
Parameters
Parameter |
Comments |
---|---|
BPDU packets to bridge specific port. Choices:
|
|
STP bridge id. |
|
STP bridge priority. Default: |
|
Target switch to run the CLI on. |
|
enable or disable STP Choices:
|
|
STP forwarding delay between 4 and 30 secs. Default: |
|
STP hello time between 1 and 10 secs. Default: |
|
maximum age time between 6 and 40 secs. Default: |
|
Name for MST Configuration Instance. |
|
maximum hop count for mstp bpdu. Default: |
|
root guard wait time between 0 and 300 secs. 0 to disable wait. Default: |
|
STP mode. Choices:
|
|
State the action to perform. Use Choices:
|
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 |
Description |
---|---|
indicates whether the CLI caused changes on the target. Returned: always |
|
the CLI command run on the target node. Returned: always |
|
set of error responses from the stp command. Returned: on error |
|
set of responses from the stp command. Returned: always |
Status
This module will be removed in version 6.0.0. [deprecated]
For more information see DEPRECATED.