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/storage/netapp/na_cdot_license.py

@@ -30,19 +30,18 @@ options:
   remove_unused:
     description:
     - Remove licenses that have no controller affiliation in the cluster.
-    choices: ['true', 'false']
+    type: bool
 
   remove_expired:
     description:
     - Remove licenses that have expired in the cluster.
-    choices: ['true', 'false']
+    type: bool
 
   serial_number:
     description:
     - Serial number of the node associated with the license.
     - This parameter is used primarily when removing license for a specific service.
     - If this parameter is not provided, the cluster serial number is used by default.
-    default: None
 
   licenses:
     description:

lib/ansible/modules/storage/netapp/na_cdot_user.py

@@ -66,7 +66,6 @@ options:
     - Password for the user account.
     - It is ignored for creating snmp users, but is required for creating non-snmp users.
     - For an existing user, this value will be used as the new password.
-    default: None
 
   role_name:
     description:

lib/ansible/modules/storage/netapp/na_cdot_volume.py

@@ -41,14 +41,14 @@ options:
   infinite:
     description:
     - Set True if the volume is an Infinite Volume.
-    choices: ['True', 'False']
-    default: 'False'
+    type: bool
+    default: 'no'
 
   online:
     description:
     - Whether the specified volume is online, or not.
-    choices: ['True', 'False']
-    default: 'True'
+    type: bool
+    default: 'yes'
 
   aggregate_name:
     description:
@@ -68,7 +68,6 @@ options:
     description:
     - Name of the vserver to use.
     required: true
-    default: None
 
 '''
 

lib/ansible/modules/storage/netapp/netapp_e_amg.py

@@ -34,22 +34,19 @@ options:
     syncIntervalMinutes:
         description:
             - The synchronization interval in minutes
-        required: no
         default: 10
     manualSync:
         description:
             - Setting this to true will cause other synchronization values to be ignored
-        required: no
-        default: no
+        type: bool
+        default: 'no'
     recoveryWarnThresholdMinutes:
         description:
             - Recovery point warning threshold (minutes). The user will be warned when the age of the last good failures point exceeds this value
-        required: no
         default: 20
     repoUtilizationWarnThreshold:
         description:
             - Recovery point warning threshold
-        required: no
         default: 80
     interfaceType:
         description:
@@ -57,17 +54,15 @@ options:
         choices:
             - iscsi
             - fibre
-        required: no
-        default: null
     syncWarnThresholdMinutes:
         description:
             - The threshold (in minutes) for notifying the user that periodic synchronization has taken too long to complete.
-        required: no
         default: 10
     state:
         description:
             - A C(state) of present will either create or update the async mirror group.
             - A C(state) of absent will remove the async mirror group.
+        choices: [ absent, present ]
         required: yes
 """
 

lib/ansible/modules/storage/netapp/netapp_e_storage_system.py

@@ -20,52 +20,48 @@ description:
 - Manage the arrays accessible via a NetApp Web Services Proxy for NetApp E-series storage arrays.
 options:
   api_username:
-    required: true
     description:
     - The username to authenticate with the SANtricity WebServices Proxy or embedded REST API.
-  api_password:
     required: true
+  api_password:
     description:
     - The password to authenticate with the SANtricity WebServices Proxy or embedded REST API.
-  api_url:
     required: true
+  api_url:
     description:
     - The url to the SANtricity WebServices Proxy or embedded REST API.
+    required: true
   validate_certs:
-    required: false
-    default: true
     description:
     - Should https certificates be validated?
+    type: bool
+    default: 'yes'
   ssid:
-    required: true
     description:
     - The ID of the array to manage. This value must be unique for each array.
-  state:
     required: true
+  state:
     description:
     - Whether the specified array should be configured on the Web Services Proxy or not.
+    required: true
     choices: ['present', 'absent']
   controller_addresses:
-    required: true
     description:
     - The list addresses for the out-of-band management adapter or the agent host. Mutually exclusive of array_wwn parameter.
+    required: true
   array_wwn:
-    required: false
     description:
     - The WWN of the array to manage. Only necessary if in-band managing multiple arrays on the same agent host.  Mutually exclusive of
       controller_addresses parameter.
   array_password:
-    required: false
     description:
     - The management password of the array to manage, if set.
   enable_trace:
-    required: false
-    default: false
     description:
     - Enable trace logging for SYMbol calls to the storage system.
+    type: bool
+    default: 'no'
   meta_tags:
-    required: false
-    default: None
     description:
     - Optional meta tags to associate to this storage system
 author: Kevin Hulquest (@hulquest)

lib/ansible/modules/storage/netapp/netapp_e_volume.py

@@ -22,27 +22,27 @@ extends_documentation_fragment:
     - netapp.eseries
 options:
   state:
-    required: true
     description:
     - Whether the specified volume should exist or not.
+    required: true
     choices: ['present', 'absent']
   name:
-    required: true
     description:
     - The name of the volume to manage
-  storage_pool_name:
     required: true
+  storage_pool_name:
     description:
     - "Required only when requested state is 'present'.  The name of the storage pool the volume should exist on."
+    required: true
   size_unit:
     description:
     - The unit used to interpret the size parameter
     choices: ['bytes', 'b', 'kb', 'mb', 'gb', 'tb', 'pb', 'eb', 'zb', 'yb']
     default: 'gb'
   size:
-    required: true
     description:
     - "Required only when state = 'present'.  The size of the volume in (size_unit)."
+    required: true
   segment_size_kb:
     description:
     - The segment size of the new volume
@@ -50,8 +50,8 @@ options:
   thin_provision:
     description:
     - Whether the volume should be thin provisioned.  Thin volumes can only be created on disk pools (raidDiskPool).
-    default: False
-    choices: ['yes','no','true','false']
+    type: bool
+    default: 'no'
   thin_volume_repo_size:
     description:
     - Initial size of the thin volume repository volume (in size_unit)
@@ -63,12 +63,13 @@ options:
   ssd_cache_enabled:
     description:
     - Whether an existing SSD cache should be enabled on the volume (fails if no SSD cache defined)
-    default: None (ignores existing SSD cache setting)
-    choices: ['yes','no','true','false']
+    - The default value is to ignore existing SSD cache setting.
+    type: bool
   data_assurance_enabled:
     description:
     - If data assurance should be enabled for the volume
-    default: false
+    type: bool
+    default: 'no'
 
 # TODO: doc thin volume parameters
 

lib/ansible/modules/storage/netapp/sf_account_manager.py

@@ -40,15 +40,12 @@ options:
     new_name:
         description:
         - New name for the user account.
-        required: false
-        default: None
 
     initiator_secret:
         description:
         - CHAP secret to use for the initiator. Should be 12-16 characters long and impenetrable.
         - The CHAP initiator secrets must be unique and cannot be the same as the target CHAP secret.
         - If not specified, a random secret is created.
-        required: false
 
     target_secret:
         description:
@@ -56,22 +53,17 @@ options:
         - Should be 12-16 characters long and impenetrable.
         - The CHAP target secrets must be unique and cannot be the same as the initiator CHAP secret.
         - If not specified, a random secret is created.
-        required: false
 
     attributes:
         description: List of Name/Value pairs in JSON object format.
-        required: false
 
     account_id:
         description:
         - The ID of the account to manage or update.
-        required: false
-        default: None
 
     status:
         description:
         - Status of the account.
-        required: false
 
 '''
 

lib/ansible/modules/storage/netapp/sf_check_connections.py

@@ -30,23 +30,17 @@ options:
   skip:
     description:
     - Skip checking connection to SVIP or MVIP.
-    required: false
     choices: ['svip', 'mvip']
-    default: None
 
   mvip:
     description:
     - Optionally, use to test connection of a different MVIP.
     - This is not needed to test the connection to the target cluster.
-    required: false
-    default: None
 
   svip:
     description:
     - Optionally, use to test connection of a different SVIP.
     - This is not needed to test the connection to the target cluster.
-    required: false
-    default: None
 
 '''
 

lib/ansible/modules/storage/netapp/sf_volume_access_group_manager.py

@@ -40,37 +40,25 @@ options:
     initiators:
         description:
         - List of initiators to include in the volume access group. If unspecified, the access group will start out without configured initiators.
-        required: false
-        default: None
 
     volumes:
         description:
         - List of volumes to initially include in the volume access group. If unspecified, the access group will start without any volumes.
-        required: false
-        default: None
 
     virtual_network_id:
         description:
         - The ID of the SolidFire Virtual Network ID to associate the volume access group with.
-        required: false
-        default: None
 
     virtual_network_tags:
         description:
         - The ID of the VLAN Virtual Network Tag to associate the volume access group with.
-        required: false
-        default: None
 
     attributes:
         description: List of Name/Value pairs in JSON object format.
-        required: false
-        default: None
 
     volume_access_group_id:
         description:
         - The ID of the volume access group to modify or delete.
-        required: false
-        default: None
 
 '''
 

lib/ansible/modules/storage/netapp/sf_volume_manager.py

@@ -46,17 +46,12 @@ options:
         description:
         - Should the volume provide 512-byte sector emulation?
         - Required when C(state=present)
-        required: false
 
     qos:
         description: Initial quality of service settings for this volume. Configure as dict in playbooks.
-        required: false
-        default: None
 
     attributes:
         description: A YAML dictionary of attributes that you would like to apply on this volume.
-        required: false
-        default: None
 
     volume_id:
         description:
@@ -64,25 +59,19 @@ options:
         - In order to create multiple volumes with the same name, but different volume_ids, please declare the I(volume_id)
           parameter with an arbitrary value. However, the specified volume_id will not be assigned to the newly created
           volume (since it's an auto-generated property).
-        required: false
-        default: None
 
     size:
         description:
         - The size of the volume in (size_unit).
         - Required when C(state = present).
-        required: false
 
     size_unit:
         description:
         - The unit used to interpret the size parameter.
-        required: false
         choices: ['bytes', 'b', 'kb', 'mb', 'gb', 'tb', 'pb', 'eb', 'zb', 'yb']
         default: 'gb'
 
     access:
-        required: false
-        choices: ['readOnly', 'readWrite', 'locked', 'replicationTarget']
         description:
         - "Access allowed for the volume."
         - "readOnly: Only read operations are allowed."
@@ -90,7 +79,7 @@ options:
         - "locked: No reads or writes are allowed."
         - "replicationTarget: Identify a volume as the target volume for a paired set of volumes. If the volume is not paired, the access status is locked."
         - "If unspecified, the access settings of the clone will be the same as the source."
-        default: None
+        choices: ['readOnly', 'readWrite', 'locked', 'replicationTarget']
 
 '''