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/junos/junos_banner.py

@@ -36,7 +36,6 @@ options:
       - 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
@@ -46,8 +45,8 @@ options:
   active:
     description:
       - Specifies whether or not the configuration is active or deactivated
-    default: True
-    choices: [True, False]
+    type: bool
+    default: 'yes'
 requirements:
   - ncclient (>=v0.5.2)
 notes:

lib/ansible/modules/network/junos/junos_command.py

@@ -33,15 +33,11 @@ options:
         is returned.  If the I(wait_for) argument is provided, the
         module is not returned until the condition is satisfied or
         the number of I(retries) has been exceeded.
-    required: false
-    default: null
   rpcs:
     description:
       - The C(rpcs) argument accepts a list of RPCs to be executed
         over a netconf session and the results from the RPC execution
         is return to the playbook via the modules results dictionary.
-    required: false
-    default: null
     version_added: "2.3"
   wait_for:
     description:
@@ -50,8 +46,6 @@ options:
         the task to wait for a particular conditional to be true
         before moving forward.   If the conditional is not true
         by the configured retries, the task fails.  See examples.
-    required: false
-    default: null
     aliases: ['waitfor']
     version_added: "2.2"
   match:
@@ -62,7 +56,6 @@ options:
         then all conditionals in the I(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"
@@ -72,7 +65,6 @@ options:
         before it is considered failed.  The command is run on the
         target device every retry and evaluated against the I(wait_for)
         conditionals.
-    required: false
     default: 10
   interval:
     description:
@@ -80,7 +72,6 @@ options:
         of the command.  If the command does not pass the specified
         conditional, the interval indicates how to long to wait before
         trying the command again.
-    required: false
     default: 1
   display:
     description:
@@ -90,7 +81,6 @@ options:
         display is C(xml) and for I(commands) argument default display
         is C(text). Value C(set) is applicable only for fetching configuration
         from device.
-    required: false
     default: depends on input argument I(rpcs) or I(commands)
     aliases: ['format', 'output']
     choices: ['text', 'json', 'xml', 'set']

lib/ansible/modules/network/junos/junos_config.py

@@ -32,8 +32,6 @@ options:
         lines to push into the remote device.  Each line must start with
         either C(set) or C(delete).  This argument is mutually exclusive
         with the I(src) argument.
-    required: false
-    default: null
   src:
     description:
       - The I(src) argument provides a path to the configuration file
@@ -41,8 +39,6 @@ options:
         system path to the configuration file if the value starts with /
         or relative to the root of the implemented role or playbook.
         This argument is mutually exclusive with the I(lines) argument.
-    required: false
-    default: null
     version_added: "2.2"
   src_format:
     description:
@@ -50,8 +46,6 @@ options:
         found int I(src).  If the I(src_format) argument is not provided,
         the module will attempt to determine the format of the configuration
         file specified in I(src).
-    required: false
-    default: null
     choices: ['xml', 'set', 'text', 'json']
     version_added: "2.2"
   rollback:
@@ -61,16 +55,12 @@ options:
         argument.  If the specified rollback identifier does not
         exist on the remote device, the module will fail.  To rollback
         to the most recent commit, set the C(rollback) argument to 0.
-    required: false
-    default: null
   zeroize:
     description:
       - The C(zeroize) argument is used to completely sanitize the
         remote device configuration back to initial defaults.  This
         argument will effectively remove all current configuration
         statements on the remote device.
-    required: false
-    default: null
   confirm:
     description:
       - The C(confirm) argument will configure a time out value for
@@ -78,14 +68,12 @@ options:
         rolled back.  If the C(confirm) argument is set to False, this
         argument is silently ignored.  If the value for this argument
         is set to 0, the commit is confirmed immediately.
-    required: false
     default: 0
   comment:
     description:
       - The C(comment) argument specifies a text string to be used
         when committing the configuration.  If the C(confirm) argument
         is set to False, this argument is silently ignored.
-    required: false
     default: configured by junos_config
   replace:
     description:
@@ -97,9 +85,8 @@ options:
         the equivalent, set the I(update) argument to C(replace). This argument
         will be removed in a future release. The C(replace) and C(update) argument
         is mutually exclusive.
-    required: false
-    choices: ['yes', 'no']
-    default: false
+    type: bool
+    default: 'no'
   backup:
     description:
       - This argument will cause the module to create a full backup of
@@ -107,9 +94,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
-    choices: ['yes', 'no']
+    type: bool
+    default: 'no'
     version_added: "2.2"
   update:
     description:
@@ -125,7 +111,6 @@ options:
         it with the loaded configuration.
         C(replace) substitutes each hierarchy level in the loaded configuration
         for the corresponding level.
-    required: false
     default: merge
     choices: ['merge', 'override', 'replace']
     version_added: "2.3"
@@ -133,9 +118,8 @@ options:
     description:
       - This argument will execute commit operation on remote device.
         It can be used to confirm a previous commit.
-    required: false
-    default: no
-    choices: ['yes', 'no']
+    type: bool
+    default: 'no'
     version_added: "2.4"
 requirements:
   - ncclient (>=v0.5.2)

lib/ansible/modules/network/junos/junos_package.py

@@ -33,7 +33,6 @@ options:
         The I(src) argument can be either a localized path or a full
         path to the package file to install.
     required: true
-    default: null
     aliases: ['package']
   version:
     description:
@@ -41,8 +40,6 @@ options:
         version of the package that should be installed on the remote
         device.  If the I(version) argument is not specified, then
         the version is extracts from the I(src) filename.
-    required: false
-    default: null
   reboot:
     description:
       - In order for a package to take effect, the remote device must be
@@ -51,16 +48,15 @@ options:
         If disabled or the remote package does not need to be changed,
         the device will not be started.
     required: true
-    default: true
-    choices: ['true', 'false']
+    type: bool
+    default: 'yes'
   no_copy:
     description:
       - The I(no_copy) argument is responsible for instructing the remote
         device on where to install the package from.  When enabled, the
         package is transferred to the remote device prior to installing.
-    required: false
-    default: false
-    choices: ['true', 'false']
+    type: bool
+    default: 'no'
   validate:
     description:
       - The I(validate) argument is responsible for instructing the remote
@@ -68,17 +64,16 @@ options:
         compatibility with the package being installed. When set to false
         validation is not performed.
     version_added: 2.5
-    required: false
-    default: true
-    choices: ['true', 'false']
+    type: bool
+    default: 'yes'
   force:
     description:
       - The I(force) argument instructs the module to bypass the package
         version check and install the packaged identified in I(src) on
         the remote device.
     required: true
-    default: false
-    choices: ['true', 'false']
+    type: bool
+    default: 'no'
 requirements:
   - junos-eznc
   - ncclient (>=v0.5.2)

lib/ansible/modules/network/junos/junos_rpc.py

@@ -37,8 +37,6 @@ options:
       - The C(args) argument provides a set of arguments for the RPC
         call and are encoded in the request message.  This argument
         accepts a set of key=value arguments.
-    required: false
-    default: null
   attrs:
     description:
       - The C(attrs) arguments defines a list of attributes and their values
@@ -50,7 +48,6 @@ options:
         return data.  This argument accepts one of C(xml), C(text),
         or C(json).  For C(json), the JUNOS device must be running a
         version of software that supports native JSON output.
-    required: false
     default: xml
 requirements:
   - ncclient (>=v0.5.2)

lib/ansible/modules/network/junos/junos_scp.py

@@ -30,27 +30,23 @@ options:
         transfered. The argument C(recursive) must be C(true) to transfer
         directories.
     required: true
-    default: null
   dest:
     description:
       - The C(dest) argument specifies the path in which to receive the files.
-    required: false
     default: '.'
   recursive:
     description:
       - The C(recursive) argument enables recursive transfer of files and
         directories.
-    required: false
-    default: false
-    choices: ['true', 'false']
+    type: bool
+    default: 'no'
   remote_src:
     description:
       - The C(remote_src) argument enables the download of files (I(scp get)) from
         the remote device. The default behavior is to upload files (I(scp put))
         to the remote device.
-    required: false
-    default: false
-    choices: ['true', 'false']
+    type: bool
+    default: 'no'
 requirements:
   - junos-eznc
   - ncclient (>=v0.5.2)

lib/ansible/modules/network/junos/junos_user.py

@@ -34,8 +34,6 @@ options:
         the device configuration.  This argument is mutually exclusive with
         the name argument.
     version_added: "2.4"
-    required: False
-    default: null
     aliases: ['users', 'collection']
   name:
     description:
@@ -43,37 +41,30 @@ options:
         on the system.  This argument must follow appropriate usernaming
         conventions for the target device running JUNOS.  This argument is
         mutually exclusive with the C(aggregate) argument.
-    required: false
-    default: null
   full_name:
     description:
       - The C(full_name) argument provides the full name of the user
         account to be created on the remote device.  This argument accepts
         any text string value.
-    required: false
-    default: null
   role:
     description:
       - The C(role) argument defines the role of the user account on the
         remote system.  User accounts can have more than one role
         configured.
-    required: false
     choices: ['operator', 'read-only', 'super-user', 'unauthorized']
   sshkey:
     description:
       - The C(sshkey) argument defines the public SSH key to be configured
         for the user account on the remote system.  This argument must
         be a valid SSH key
-    required: false
-    default: null
   purge:
     description:
       - The C(purge) argument instructs the module to consider the
         users definition absolute.  It will remove any previously configured
         users on the device with the exception of the current defined
         set of aggregate.
-    required: false
-    default: false
+    type: bool
+    default: 'no'
   state:
     description:
       - The C(state) argument configures the state of the user definitions
@@ -81,14 +72,13 @@ options:
         to I(present), the user should be configured in the device active
         configuration and when set to I(absent) the user should not be
         in the device active configuration
-    required: false
     default: present
     choices: ['present', 'absent']
   active:
     description:
       - Specifies whether or not the configuration is active or deactivated
-    default: True
-    choices: [True, False]
+    type: bool
+    default: 'yes'
     version_added: "2.4"
 requirements:
   - ncclient (>=v0.5.2)