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
parent 58eb2e849d
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

@ -36,101 +36,72 @@ options:
description:
- Specifies the ID of a DFS group.
The value must be 1.
required: false
default: null
dfs_source_ip:
description:
- Specifies the IPv4 address bound to a DFS group.
The value is in dotted decimal notation.
required: false
default: null
dfs_source_vpn:
description:
- Specifies the name of a VPN instance bound to a DFS group.
The value is a string of 1 to 31 case-sensitive characters without spaces.
If the character string is quoted by double quotation marks, the character string can contain spaces.
The value C(_public_) is reserved and cannot be used as the VPN instance name.
required: false
default: null
dfs_udp_port:
description:
- Specifies the UDP port number of the DFS group.
The value is an integer that ranges from 1025 to 65535.
required: false
default: null
dfs_all_active:
description:
- Creates all-active gateways.
required: false
choices: ['enable', 'disable']
default: null
dfs_peer_ip:
description:
- Configure the IP address of an all-active gateway peer.
The value is in dotted decimal notation.
required: false
default: null
dfs_peer_vpn:
description:
- Specifies the name of the VPN instance that is associated with all-active gateway peer.
The value is a string of 1 to 31 case-sensitive characters, spaces not supported.
When double quotation marks are used around the string, spaces are allowed in the string.
The value C(_public_) is reserved and cannot be used as the VPN instance name.
required: false
default: null
vpn_instance:
description:
- Specifies the name of a VPN instance.
The value is a string of 1 to 31 case-sensitive characters, spaces not supported.
When double quotation marks are used around the string, spaces are allowed in the string.
The value C(_public_) is reserved and cannot be used as the VPN instance name.
required: false
default: null
vpn_vni:
description:
- Specifies a VNI ID.
Binds a VXLAN network identifier (VNI) to a virtual private network (VPN) instance.
The value is an integer ranging from 1 to 16000000.
required: false
default: null
vbdif_name:
description:
- Full name of VBDIF interface, i.e. Vbdif100.
required: false
default: null
vbdif_bind_vpn:
description:
- Specifies the name of the VPN instance that is associated with the interface.
The value is a string of 1 to 31 case-sensitive characters, spaces not supported.
When double quotation marks are used around the string, spaces are allowed in the string.
The value C(_public_) is reserved and cannot be used as the VPN instance name.
required: false
default: null
vbdif_mac:
description:
- Specifies a MAC address for a VBDIF interface.
The value is in the format of H-H-H. Each H is a 4-digit hexadecimal number, such as C(00e0) or C(fc01).
If an H contains less than four digits, 0s are added ahead. For example, C(e0) is equal to C(00e0).
A MAC address cannot be all 0s or 1s or a multicast MAC address.
required: false
default: null
arp_distribute_gateway:
description:
- Enable the distributed gateway function on VBDIF interface.
required: false
choices: ['enable','disable']
default: null
arp_direct_route:
description:
- Enable VLINK direct route on VBDIF interface.
required: false
choices: ['enable','disable']
default: null
state:
description:
- Determines whether the config should be present or not
on the device.
required: false
default: present
choices: ['present', 'absent']
"""