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

lib/ansible/modules/network/ios/ios_banner.py

@@ -40,14 +40,12 @@ options:
       - Specifies which banner should be configured on the remote device.
         In Ansible 2.4 and earlier only I(login) and I(motd) were supported.
     required: true
-    default: null
     choices: ['login', 'motd', 'exec', 'incoming', 'slip-ppp']
   text:
     description:
       - The banner text that should be
         present in the remote device running configuration.  This argument
         accepts a multiline string, with no empty lines. Requires I(state=present).
-    default: null
   state:
     description:
       - Specifies whether or not the configuration is

lib/ansible/modules/network/ios/ios_command.py

@@ -55,8 +55,6 @@ options:
         before moving forward. If the conditional is not true
         within the configured number of retries, the task fails.
         See examples.
-    required: false
-    default: null
     aliases: ['waitfor']
     version_added: "2.2"
   match:
@@ -67,7 +65,6 @@ options:
         then all conditionals in the wait_for must be satisfied.  If
         the value is set to C(any) then only one of the values must be
         satisfied.
-    required: false
     default: all
     choices: ['any', 'all']
     version_added: "2.2"
@@ -77,7 +74,6 @@ options:
         before it is considered failed. The command is run on the
         target device every retry and evaluated against the
         I(wait_for) conditions.
-    required: false
     default: 10
   interval:
     description:
@@ -85,7 +81,6 @@ options:
         of the command. If the command does not pass the specified
         conditions, the interval indicates how long to wait before
         trying the command again.
-    required: false
     default: 1
 """
 

lib/ansible/modules/network/ios/ios_config.py

@@ -43,8 +43,6 @@ options:
         in the device running-config.  Be sure to note the configuration
         command syntax as some commands are automatically modified by the
         device config parser.
-    required: false
-    default: null
     aliases: ['commands']
   parents:
     description:
@@ -52,8 +50,6 @@ options:
         the commands should be checked against.  If the parents argument
         is omitted, the commands are checked against the set of top
         level or global commands.
-    required: false
-    default: null
   src:
     description:
       - Specifies the source path to the file that contains the configuration
@@ -61,8 +57,6 @@ options:
         either be the full path on the Ansible control host or a relative
         path from the playbook or role root directory.  This argument is mutually
         exclusive with I(lines), I(parents).
-    required: false
-    default: null
     version_added: "2.2"
   before:
     description:
@@ -71,16 +65,12 @@ options:
         the opportunity to perform configuration commands prior to pushing
         any changes without affecting how the set of commands are matched
         against the system.
-    required: false
-    default: null
   after:
     description:
       - The ordered set of commands to append to the end of the command
         stack if a change needs to be made.  Just like with I(before) this
         allows the playbook designer to append a set of commands to be
         executed after the command set.
-    required: false
-    default: null
   match:
     description:
       - Instructs the module on the way to perform the matching of
@@ -91,9 +81,8 @@ options:
         must be an equal match.  Finally, if match is set to I(none), the
         module will not attempt to compare the source configuration with
         the running configuration on the remote device.
-    required: false
-    default: line
     choices: ['line', 'strict', 'exact', 'none']
+    default: line
   replace:
     description:
       - Instructs the module on the way to perform the configuration
@@ -102,7 +91,6 @@ options:
         mode.  If the replace argument is set to I(block) then the entire
         command block is pushed to the device in configuration mode if any
         line is not correct.
-    required: false
     default: line
     choices: ['line', 'block']
   multiline_delimiter:
@@ -111,7 +99,6 @@ options:
         element to the IOS device.  It specifies the character to use
         as the delimiting character.  This only applies to the
         configuration action.
-    required: false
     default: "@"
     version_added: "2.3"
   force:
@@ -123,9 +110,8 @@ options:
       - Note this argument should be considered deprecated.  To achieve
         the equivalent, set the C(match=none) which is idempotent.  This argument
         will be removed in Ansible 2.6.
-    required: false
-    default: false
     type: bool
+    default: 'no'
   backup:
     description:
       - This argument will cause the module to create a full backup of
@@ -133,9 +119,8 @@ options:
         changes are made.  The backup file is written to the C(backup)
         folder in the playbook root directory.  If the directory does not
         exist, it is created.
-    required: false
-    default: no
     type: bool
+    default: 'no'
     version_added: "2.2"
   running_config:
     description:
@@ -146,8 +131,6 @@ options:
         every task in a playbook.  The I(running_config) argument allows the
         implementer to pass in the configuration to use as the base
         config for comparison.
-    required: false
-    default: null
     aliases: ['config']
     version_added: "2.4"
   defaults:
@@ -156,9 +139,8 @@ options:
         when getting the remote device running config.  When enabled,
         the module will get the current config by issuing the command
         C(show running-config all).
-    required: false
-    default: no
     type: bool
+    default: 'no'
     version_added: "2.2"
   save:
     description:
@@ -167,9 +149,8 @@ options:
         running.  If check mode is specified, this argument is ignored.
       - This option is deprecated as of Ansible 2.4 and will be removed
         in Ansible 2.8, use C(save_when) instead.
-    required: false
-    default: false
     type: bool
+    default: 'no'
     version_added: "2.2"
   save_when:
     description:
@@ -185,7 +166,6 @@ options:
         startup-config.  If the argument is set to I(changed), then the running-config
         will only be copied to the startup-config if the task has made a change.
         I(changed) was added in Ansible 2.5.
-    required: false
     default: never
     choices: ['always', 'never', 'modified', 'changed']
     version_added: "2.4"
@@ -201,7 +181,6 @@ options:
       - When this option is configured as I(running), the module will
         return the before and after diff of the running-config with respect
         to any changes made to the device configuration.
-    required: false
     choices: ['running', 'startup', 'intended']
     version_added: "2.4"
   diff_ignore_lines:
@@ -210,7 +189,6 @@ options:
         ignored during the diff.  This is used for lines in the configuration
         that are automatically updated by the system.  This argument takes
         a list of regular expressions or exact line matches.
-    required: false
     version_added: "2.4"
   intended_config:
     description:
@@ -221,7 +199,6 @@ options:
         of the current device's configuration against.  When specifying this
         argument, the task should also modify the C(diff_against) value and
         set it to I(intended).
-    required: false
     version_added: "2.4"
 """
 

lib/ansible/modules/network/ios/ios_ping.py

@@ -27,7 +27,6 @@ options:
   count:
     description:
     - Number of packets to send.
-    required: false
     default: 5
   dest:
     description:
@@ -36,8 +35,6 @@ options:
   source:
     description:
     - The source IP Address.
-    required: false
-    default: null
   state:
     description:
     - Determines if the expected result is success or fail.
@@ -46,7 +43,6 @@ options:
   vrf:
     description:
     - The VRF to use for forwarding.
-    required: false
     default: default
 notes:
   - For a general purpose network module, see the M(net_ping) module.