mirror of
https://github.com/ansible-collections/community.general.git
synced 2025-06-01 13:59:09 -07:00
Clean up module documentation (#36909)
* Clean up module documentation This PR includes: - Removal of `default: None` (and variations) - Removal of `required: false` - Fixing booleans and `type: bool` where required * Fix remaining (new) validation issues
This commit is contained in:
parent
58eb2e849d
commit
cdd21e2170
624 changed files with 1458 additions and 9114 deletions
|
@ -33,92 +33,65 @@ options:
|
|||
state:
|
||||
description:
|
||||
- Specify desired state of the resource.
|
||||
required: false
|
||||
default: present
|
||||
choices: ['present', 'absent']
|
||||
stp_mode:
|
||||
description:
|
||||
- Set an operation mode for the current MSTP process.
|
||||
The mode can be STP, RSTP, or MSTP.
|
||||
required: false
|
||||
default: null
|
||||
choices: ['stp', 'rstp', 'mstp']
|
||||
stp_enable:
|
||||
description:
|
||||
- Enable or disable STP on a switch.
|
||||
required: false
|
||||
default: null
|
||||
choices: ['enable', 'disable']
|
||||
stp_converge:
|
||||
description:
|
||||
- STP convergence mode.
|
||||
Fast means set STP aging mode to Fast.
|
||||
Normal means set STP aging mode to Normal.
|
||||
required: false
|
||||
default: null
|
||||
choices: ['fast', 'normal']
|
||||
bpdu_protection:
|
||||
description:
|
||||
- Configure BPDU protection on an edge port.
|
||||
This function prevents network flapping caused by attack packets.
|
||||
required: false
|
||||
default: null
|
||||
choices: ['enable', 'disable']
|
||||
tc_protection:
|
||||
description:
|
||||
- Configure the TC BPDU protection function for an MSTP process.
|
||||
required: false
|
||||
default: null
|
||||
choices: ['enable', 'disable']
|
||||
tc_protection_interval:
|
||||
description:
|
||||
- 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.
|
||||
required: false
|
||||
default: null
|
||||
tc_protection_threshold:
|
||||
description:
|
||||
- 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.
|
||||
required: false
|
||||
default: null
|
||||
interface:
|
||||
description:
|
||||
- Interface name.
|
||||
If the value is C(all), will apply configuration to all interfaces.
|
||||
if the value is a special name, only support input the full name.
|
||||
required: false
|
||||
default: null
|
||||
edged_port:
|
||||
description:
|
||||
- Set the current port as an edge port.
|
||||
required: false
|
||||
default: null
|
||||
choices: ['enable', 'disable']
|
||||
bpdu_filter:
|
||||
description:
|
||||
- Specify a port as a BPDU filter port.
|
||||
required: false
|
||||
default: null
|
||||
choices: ['enable', 'disable']
|
||||
cost:
|
||||
description:
|
||||
- Set the path cost of the current port.
|
||||
The default instance is 0.
|
||||
required: false
|
||||
default: null
|
||||
root_protection:
|
||||
description:
|
||||
- Enable root protection on the current port.
|
||||
required: false
|
||||
default: null
|
||||
choices: ['enable', 'disable']
|
||||
loop_protection:
|
||||
description:
|
||||
- Enable loop protection on the current port.
|
||||
required: false
|
||||
default: null
|
||||
choices: ['enable', 'disable']
|
||||
'''
|
||||
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue