Docs4dev
Docs
ansible / 2.4 / ce_stp_module.html

ce_stp - Manages STP configuration on HUAWEI CloudEngine switches.

New in version 2.4.

Synopsis

  • Manages STP configurations on HUAWEI CloudEngine switches.

Options

parameter required default choices comments
bpdu_filter
 no
  • enable
  • disable
Specify a port as a BPDU filter port.
bpdu_protection
 no
  • enable
  • disable
Configure BPDU protection on an edge port. This function prevents network flapping caused by attack packets.
cost
 no
Set the path cost of the current port. The default instance is 0.
edged_port
 no
  • enable
  • disable
Set the current port as an edge port.
interface
 no
Interface name. If the value is all, will apply configuration to all interfaces. if the value is a special name, only support input the full name.
loop_protection
 no
  • enable
  • disable
Enable loop protection on the current port.
root_protection
 no
  • enable
  • disable
Enable root protection on the current port.
state
 no present
  • present
  • absent
Specify desired state of the resource.
stp_converge
 no
  • fast
  • normal
STP convergence mode. Fast means set STP aging mode to Fast. Normal means set STP aging mode to Normal.
stp_enable
 no
  • enable
  • disable
Enable or disable STP on a switch.
stp_mode
 no
  • stp
  • rstp
  • mstp
Set an operation mode for the current MSTP process. The mode can be STP, RSTP, or MSTP.
tc_protection
 no
  • enable
  • disable
Configure the TC BPDU protection function for an MSTP process.
tc_protection_interval
 no
Set the time the MSTP device takes to handle the maximum number of TC BPDUs and immediately refresh forwarding entries. The value is an integer ranging from 1 to 600, in seconds.
tc_protection_threshold
 no
Set the maximum number of TC BPDUs that the MSTP can handle. The value is an integer ranging from 1 to 255. The default value is 1 on the switch.

Examples

- name: CloudEngine stp test
  hosts: cloudengine
  connection: local
  gather_facts: no
  vars:
    cli:
      host: "{{ inventory_hostname }}"
      port: "{{ ansible_ssh_port }}"
      username: "{{ username }}"
      password: "{{ password }}"
      transport: cli

  tasks:

  - name: "Config stp mode"
    ce_stp:
      state: present
      stp_mode: stp
      provider: "{{ cli }}"

  - name: "Undo stp mode"
    ce_stp:
      state: absent
      stp_mode: stp
      provider: "{{ cli }}"

  - name: "Enable bpdu protection"
    ce_stp:
      state: present
      bpdu_protection: enable
      provider: "{{ cli }}"

  - name: "Disable bpdu protection"
    ce_stp:
      state: present
      bpdu_protection: disable
      provider: "{{ cli }}"

Return Values

Common return values are documented here Return Values, the following are the fields unique to this module:

name description returned type sample
changed
check to see if a change was made on the device
always boolean True
end_state
k/v pairs of aaa params after module execution
always dict {'bpdu_protection': 'enable'}
existing
k/v pairs of existing aaa server
always dict {'bpdu_protection': 'disable'}
proposed
k/v pairs of parameters passed into module
always dict {'bpdu_protection': 'enable', 'state': 'present'}
updates
command sent to the device
always list ['stp bpdu-protection']

Status

This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.

For help in developing on modules, should you be so inclined, please read Community Information & Contributing, Testing Ansible and Developing Modules.

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.4/ce_stp_module.html