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:
Dag Wieers 2018-03-15 22:15:24 +01:00 committed by GitHub
commit cdd21e2170
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
624 changed files with 1458 additions and 9114 deletions

View file

@ -33,54 +33,41 @@ options:
state:
description:
- Specify desired state of the resource.
required: false
default: present
choices: ['present','absent']
as_number:
description:
- Local AS number.
The value is a string of 1 to 11 characters.
required: false
default: null
graceful_restart:
description:
- Enable GR of the BGP speaker in the specified address family, peer address, or peer group.
required: false
default: no_use
choices: ['no_use','true','false']
time_wait_for_rib:
description:
- Period of waiting for the End-Of-RIB flag.
The value is an integer ranging from 3 to 3000. The default value is 600.
required: false
default: null
as_path_limit:
description:
- Maximum number of AS numbers in the AS_Path attribute. The default value is 255.
required: false
default: null
check_first_as:
description:
- Check the first AS in the AS_Path of the update messages from EBGP peers.
required: false
default: no_use
choices: ['no_use','true','false']
confed_id_number:
description:
- Confederation ID.
The value is a string of 1 to 11 characters.
required: false
default: null
confed_nonstanded:
description:
- Configure the device to be compatible with devices in a nonstandard confederation.
required: false
default: no_use
choices: ['no_use','true','false']
bgp_rid_auto_sel:
description:
- The function to automatically select router IDs for all VPN BGP instances is enabled.
required: false
default: no_use
choices: ['no_use','true','false']
keep_all_routes:
@ -89,101 +76,73 @@ options:
BGP connection setup.
If the value is false, the system stores only BGP update messages that are received from peers and pass
the configured import policy.
required: false
default: no_use
choices: ['no_use','true','false']
memory_limit:
description:
- Support BGP RIB memory protection.
required: false
default: no_use
choices: ['no_use','true','false']
gr_peer_reset:
description:
- Peer disconnection through GR.
required: false
default: no_use
choices: ['no_use','true','false']
is_shutdown:
description:
- Interrupt BGP all neighbor.
required: false
default: no_use
choices: ['no_use','true','false']
suppress_interval:
description:
- Suppress interval.
required: false
default: null
hold_interval:
description:
- Hold interval.
required: false
default: null
clear_interval:
description:
- Clear interval.
required: false
default: null
confed_peer_as_num:
description:
- Confederation AS number, in two-byte or four-byte format.
The value is a string of 1 to 11 characters.
required: false
default: null
vrf_name:
description:
- Name of a BGP instance. The name is a case-sensitive string of characters.
required: false
default: null
vrf_rid_auto_sel:
description:
- If the value is true, VPN BGP instances are enabled to automatically select router IDs.
If the value is false, VPN BGP instances are disabled from automatically selecting router IDs.
required: false
default: no_use
choices: ['no_use','true','false']
router_id:
description:
- ID of a router that is in IPv4 address format.
required: false
default: null
keepalive_time:
description:
- If the value of a timer changes, the BGP peer relationship between the routers is disconnected.
The value is an integer ranging from 0 to 21845. The default value is 60.
required: false
default: null
hold_time:
description:
- Hold time, in seconds. The value of the hold time can be 0 or range from 3 to 65535.
required: false
default: null
min_hold_time:
description:
- Min hold time, in seconds. The value of the hold time can be 0 or range from 20 to 65535.
required: false
default: null
conn_retry_time:
description:
- ConnectRetry interval. The value is an integer, in seconds. The default value is 32s.
required: false
default: null
ebgp_if_sensitive:
description:
- If the value is true, After the fast EBGP interface awareness function is enabled, EBGP sessions on
an interface are deleted immediately when the interface goes Down.
If the value is false, After the fast EBGP interface awareness function is enabled, EBGP sessions
on an interface are not deleted immediately when the interface goes Down.
required: false
default: no_use
choices: ['no_use','true','false']
default_af_type:
description:
- Type of a created address family, which can be IPv4 unicast or IPv6 unicast.
The default type is IPv4 unicast.
required: false
default: null
choices: ['ipv4uni','ipv6uni']
'''