Update author field and add type for all options in docs (#54350)

lib/ansible/modules/storage/purestorage/purefa_dns.py

@@ -20,20 +20,23 @@ description:
 - Set or erase configuration for the DNS settings.
 - Nameservers provided will overwrite any existing nameservers.
 author:
-- Simon Dodsley (@sdodsley)
+- Pure Storage Ansible Team (@sdodsley) <pure-ansible-team@purestorage.com>
 options:
   state:
     description:
     - Set or delete directory service configuration
     default: present
+    type: str
     choices: [ absent, present ]
   domain:
     description:
     - Domain suffix to be appended when perofrming DNS lookups.
+    type: str
   nameservers:
     description:
     - List of up to 3 unique DNS server IP addresses. These can be
       IPv4 or IPv6 - No validation is done of the addresses is performed.
+    type: list
 extends_documentation_fragment:
 - purestorage.fa
 '''

lib/ansible/modules/storage/purestorage/purefa_ds.py

@@ -23,9 +23,10 @@ description:
 - To modify an existing directory service configuration you must first delete
   an exisitng configuration and then recreate with new settings.
 author:
-- Simon Dodsley (@sdodsley)
+- Pure Storage Ansible Team (@sdodsley) <pure-ansible-team@purestorage.com>
 options:
   state:
+    type: str
     description:
     - Create or delete directory service configuration
     default: present
@@ -36,6 +37,7 @@ options:
     default: false
     type: bool
   uri:
+    type: list
     description:
     - A list of up to 30 URIs of the directory servers. Each URI must include
       the scheme ldap:// or ldaps:// (for LDAP over SSL), a hostname, and a
@@ -43,6 +45,7 @@ options:
       the directory service with the hostname "ad" in the domain "company.com"
       while specifying the unencrypted LDAP protocol.
   base_dn:
+    type: str
     description:
     - Sets the base of the Distinguished Name (DN) of the directory service
       groups. The base should consist of only Domain Components (DCs). The
@@ -51,9 +54,11 @@ options:
       for each domain component and multiple DCs should be separated by commas.
     required: true
   bind_password:
+    type: str
     description:
     - Sets the password of the bind_user user name account.
   bind_user:
+    type: str
     description:
     - Sets the user name that can be used to bind to and query the directory.
     - For Active Directory, enter the username - often referred to as
@@ -61,6 +66,7 @@ options:
       perform directory lookups.
     - For OpenLDAP, enter the full DN of the user.
   group_base:
+    type: str
     description:
     - Specifies where the configured groups are located in the directory
       tree. This field consists of Organizational Units (OUs) that combine
@@ -71,6 +77,7 @@ options:
       to right. Each OU should not exceed 64 characters in length.
     - Not Supported from Purity 5.2.0 or higher. Use I(purefa_dsrole) module.
   ro_group:
+    type: str
     description:
     - Sets the common Name (CN) of the configured directory service group
       containing users with read-only privileges on the FlashArray. This
@@ -78,6 +85,7 @@ options:
       specifier. Common Names should not exceed 64 characters in length.
     - Not Supported from Purity 5.2.0 or higher. Use I(purefa_dsrole) module.
   sa_group:
+    type: str
     description:
     - Sets the common Name (CN) of the configured directory service group
       containing administrators with storage-related privileges on the
@@ -86,6 +94,7 @@ options:
       characters in length.
     - Not Supported from Purity 5.2.0 or higher. Use I(purefa_dsrole) module.
   aa_group:
+    type: str
     description:
     - Sets the common Name (CN) of the directory service group containing
       administrators with full privileges when managing the FlashArray.

lib/ansible/modules/storage/purestorage/purefa_dsrole.py

@@ -20,11 +20,12 @@ description:
 - Set or erase directory services role configurations.
 - Only available for FlashArray running Purity 5.2.0 or higher
 author:
-- Simon Dodsley (@sdodsley)
+- Pure Storage Ansible Team (@sdodsley) <pure-ansible-team@purestorage.com>
 options:
   state:
     description:
     - Create or delete directory service role
+    type: str
     default: present
     choices: [ absent, present ]
   role:
@@ -32,6 +33,7 @@ options:
     - The directory service role to work on
     choices: [ array_admin, ops_admin, readonly, storage_admin ]
   group_base:
+    type: str
     description:
     - Specifies where the configured group is located in the directory
       tree. This field consists of Organizational Units (OUs) that combine
@@ -42,6 +44,7 @@ options:
       to right.
     - Each OU should not exceed 64 characters in length.
   group:
+    type: str
     description:
     - Sets the common Name (CN) of the configured directory service group
       containing users for the FlashBlade. This name should be just the

lib/ansible/modules/storage/purestorage/purefa_facts.py

@@ -23,7 +23,7 @@ description:
     groups and volume counts. Additional fact information can be collected
     based on the configured set of arguements.
 author:
-  - Simon Dodsley (@sdodsley)
+  - Pure Storage ansible Team (@sdodsley) <pure-ansible-team@purestorage.com>
 options:
   gather_subset:
     description:
@@ -31,6 +31,7 @@ options:
         Possible values for this include all, minimum, config, performance,
         capacity, network, subnet, interfaces, hgroups, pgroups, hosts,
         admins, volumes, snapshots, pods, vgroups, offload and apps.
+    type: list
     required: false
     default: minimum
 extends_documentation_fragment:

lib/ansible/modules/storage/purestorage/purefa_hg.py

@@ -19,21 +19,25 @@ short_description: Manage hostgroups on Pure Storage FlashArrays
 description:
 - Create, delete or modifiy hostgroups on Pure Storage FlashArrays.
 author:
-- Simon Dodsley (@sdodsley)
+- Pure Storage ansible Team (@sdodsley) <pure-ansible-team@purestorage.com>
 options:
   hostgroup:
     description:
     - The name of the hostgroup.
+    type: str
     required: true
   state:
     description:
     - Define whether the hostgroup should exist or not.
+    type: str
     default: present
     choices: [ absent, present ]
   host:
+    type: list
     description:
     - List of existing hosts to add to hostgroup.
   volume:
+    type: list
     description:
     - List of existing volumes to add to hostgroup.
 extends_documentation_fragment:

lib/ansible/modules/storage/purestorage/purefa_host.py

@@ -19,36 +19,43 @@ short_description: Manage hosts on Pure Storage FlashArrays
 description:
 - Create, delete or modify hosts on Pure Storage FlashArrays.
 author:
-- Simon Dodsley (@sdodsley)
+- Pure Storage Ansible Team (@sdodsley) <pure-ansible-team@purestorage.com>
 notes:
 - If specifying C(lun) option ensure host support requested value
 options:
   host:
     description:
     - The name of the host.
+    type: str
     required: true
   state:
     description:
     - Define whether the host should exist or not.
     - When removing host all connected volumes will be disconnected.
+    type: str
     default: present
     choices: [ absent, present ]
   protocol:
     description:
     - Defines the host connection protocol for volumes.
+    type: str
     default: iscsi
     choices: [ fc, iscsi, nvme, mixed ]
   wwns:
+    type: list
     description:
     - List of wwns of the host if protocol is fc or mixed.
   iqn:
+    type: list
     description:
     - List of IQNs of the host if protocol is iscsi or mixed.
   nqn:
+    type: list
     description:
     - List of NQNs of the host if protocol is nvme or mixed.
     version_added: '2.8'
   volume:
+    type: str
     description:
     - Volume name to map to the host.
   lun:
@@ -56,8 +63,10 @@ options:
     - LUN ID to assign to volume for host. Must be unique.
     - If not provided the ID will be automatically assigned.
     - Range for LUN ID is 1 to 4095.
+    type: int
     version_added: '2.8'
   personality:
+    type: str
     description:
     - Define which operating system the host is. Recommend for
       ActiveCluster integration.

lib/ansible/modules/storage/purestorage/purefa_ntp.py

@@ -19,14 +19,16 @@ short_description: Configure Pure Storage FlashArray NTP settings
 description:
 - Set or erase NTP configuration for Pure Storage FlashArrays.
 author:
-- Simon Dodsley (@sdodsley)
+- Pure Storage Ansible Team (@sdodsley) <pure-ansible-team@purestorage.com>
 options:
   state:
     description:
     - Create or delete NTP servers configuration
+    type: str
     default: present
     choices: [ absent, present ]
   ntp_servers:
+    type: list
     description:
     - A list of up to 4 alternate NTP servers. These may include IPv4,
       IPv6 or FQDNs. Invalid IP addresses will cause the module to fail.

lib/ansible/modules/storage/purestorage/purefa_pg.py

@@ -22,26 +22,31 @@ description:
   to a volume protection group the module will ignore the invalid types.
 - Protection Groups on Offload targets are supported.
 author:
-- Simon Dodsley (@sdodsley)
+- Pure Storage Ansible Team (@sdodsley) <pure-ansible-team@purestorage.com>
 options:
   pgroup:
     description:
     - The name of the protection group.
+    type: str
     required: true
   state:
     description:
     - Define whether the protection group should exist or not.
+    type: str
     default: present
     choices: [ absent, present ]
   volume:
     description:
     - List of existing volumes to add to protection group.
+    type: list
   host:
     description:
     - List of existing hosts to add to protection group.
+    type: list
   hostgroup:
     description:
     - List of existing hostgroups to add to protection group.
+    type: list
   eradicate:
     description:
     - Define whether to eradicate the protection group on delete and leave in trash.
@@ -60,6 +65,7 @@ options:
     - Target arrays or offload targets must already be connected to the source array.
     - Maximum number of targets per Portection Group is 4, assuming your
       configuration suppors this.
+    type: list
     version_added: '2.8'
 extends_documentation_fragment:
 - purestorage.fa

lib/ansible/modules/storage/purestorage/purefa_pgsnap.py

@@ -20,11 +20,12 @@ description:
 - Create or delete protection group snapshots on Pure Storage FlashArray.
 - Recovery of replicated snapshots on the replica target array is enabled.
 author:
-- Simon Dodsley (@sdodsley)
+- Pure Storage Ansible Team (@sdodsley) <pure-ansible-team@purestorage.com>
 options:
   name:
     description:
     - The name of the source protection group.
+    type: str
     required: true
   suffix:
     description:
@@ -34,6 +35,7 @@ options:
     - Define whether the protection group snapshot should exist or not.
       Copy (added in 2.7) will create a full read/write clone of the
       snapshot.
+    type: str
     choices: [ absent, present, copy ]
     default: present
   eradicate:
@@ -44,6 +46,7 @@ options:
   restore:
     description:
     - Restore a specific volume from a protection group snapshot.
+    type: str
     version_added: 2.7
   overwrite:
     description:
@@ -55,6 +58,7 @@ options:
     description:
     - Volume to restore a specified volume to.
     - If not supplied this will default to the volume defined in I(restore)
+    type: str
     version_added: 2.8
 extends_documentation_fragment:
 - purestorage.fa

lib/ansible/modules/storage/purestorage/purefa_ra.py

@@ -19,13 +19,14 @@ short_description: Enable or Disable Pure Storage FlashArray Remote Assist
 description:
 - Enablke or Disable Remote Assist for a Pure Storage FlashArray.
 author:
-- Simon Dodsley (@sdodsley)
+- Pure Storage Ansible Team (@sdodsley) <pure-ansible-team@purestorage.com>
 options:
   state:
     description:
     - Define state of remote assist
     - When set to I(enable) the RA port can be exposed using the
       I(debug) module.
+    type: str
     default: enable
     choices: [ enable, disable ]
 extends_documentation_fragment:

lib/ansible/modules/storage/purestorage/purefa_snap.py

@@ -19,18 +19,21 @@ short_description: Manage volume snapshots on Pure Storage FlashArrays
 description:
 - Create or delete volumes and volume snapshots on Pure Storage FlashArray.
 author:
-- Simon Dodsley (@sdodsley)
+- Pure Storage Ansible Team (@sdodsley) <pure-ansible-team@purestorage.com>
 options:
   name:
     description:
     - The name of the source volume.
+    type: str
     required: true
   suffix:
     description:
     - Suffix of snapshot name.
+    type: str
   target:
     description:
     - Name of target volume if creating from snapshot.
+    type: str
   overwrite:
     description:
     - Define whether to overwrite existing volume when creating from snapshot.
@@ -40,6 +43,7 @@ options:
     description:
     - Define whether the volume snapshot should exist or not.
     choices: [ absent, copy, present ]
+    type: str
     default: present
   eradicate:
     description:

lib/ansible/modules/storage/purestorage/purefa_user.py

@@ -19,26 +19,31 @@ short_description: Create, modify or delete FlashArray local user account
 description:
 - Create, modify or delete local users on a Pure Stoage FlashArray.
 author:
-- Simon Dodsley (@sdodsley)
+- Pure Storage Ansible Team (@sdodsley) <pure-ansible-team@purestorage.com>
 options:
   state:
     description:
     - Create, delete or update local user account
     default: present
+    type: str
     choices: [ absent, present ]
   name:
     description:
     - The name of the local user account
+    type: str
   role:
     description:
     - Sets the local user's access level to the array
+    type: str
     choices: [ readonly, storage_admin, array_admin ]
   password:
     description:
     - Password for the local user.
+    type: str
   old_password:
     description:
     - If changing an existing password, you must provide the old password for security
+    type: str
   api_token:
     description:
     - Define whether to create an API token for this user

lib/ansible/modules/storage/purestorage/purefa_volume.py

@@ -19,20 +19,23 @@ short_description:  Manage volumes on Pure Storage FlashArrays
 description:
 - Create, delete or extend the capacity of a volume on Pure Storage FlashArray.
 author:
-- Simon Dodsley (@sdodsley)
+- Pure Storage Ansible Team (@sdodsley) <pure-ansible-team@purestorage.com>
 options:
   name:
     description:
     - The name of the volume.
+    type: str
     required: true
   target:
     description:
     - The name of the target volume, if copying.
+    type: str
   state:
     description:
     - Define whether the volume should exist or not.
     default: present
     choices: [ absent, present ]
+    type: str
   eradicate:
     description:
     - Define whether to eradicate the volume on delete or leave in trash.
@@ -46,6 +49,7 @@ options:
   size:
     description:
     - Volume size in M, G, T or P units.
+    type: str
   qos:
     description:
     - Bandwidth limit for volume in M or G units.
@@ -53,6 +57,7 @@ options:
       G will set GB/s
       To clear an existing Qos setting using 0 (zero)
     version_added: '2.8'
+    type: str
 extends_documentation_fragment:
 - purestorage.fa
 '''

lib/ansible/modules/storage/purestorage/purefb_bucket.py

@@ -20,21 +20,24 @@ version_added: "2.8"
 short_description:  Manage Object Store Buckets on a  Pure Storage FlashBlade.
 description:
     - This module managess object store (s3) buckets on Pure Storage FlashBlade.
-author: Simon Dodsley (@sdodsley)
+author: Pure Storage Ansible Team (@sdodsley) <pure-ansible-team@purestorage.com>
 options:
   name:
     description:
       - Bucket Name.
     required: true
+    type: str
   account:
     description:
       - Object Store Account for Bucket.
     required: true
+    type: str
   state:
     description:
       - Create, delete or modifies a bucket.
     required: false
     default: present
+    type: str
     choices: [ "present", "absent" ]
   eradicate:
     description:

lib/ansible/modules/storage/purestorage/purefb_ds.py

@@ -23,17 +23,19 @@ description:
 - To modify an existing directory service configuration you must first delete
   an exisitng configuration and then recreate with new settings.
 author:
-- Simon Dodsley (@sdodsley)
+- Pure Storage Ansible Team (@sdodsley) <pure-ansible-team@purestorage.com>
 options:
   state:
     description:
     - Create or delete directory service configuration
     default: present
+    type: str
     choices: [ absent, present ]
   dstype:
     description:
     - The type of directory service to work on
     choices: [ management, nfs, smb ]
+    type: str
   enable:
     description:
     - Whether to enable or disable directory service support.
@@ -46,6 +48,7 @@ options:
       domain name or IP address. For example, ldap://ad.company.com configures
       the directory service with the hostname "ad" in the domain "company.com"
       while specifying the unencrypted LDAP protocol.
+    type: list
   base_dn:
     description:
     - Sets the base of the Distinguished Name (DN) of the directory service
@@ -54,9 +57,11 @@ options:
       parsing domain components from the URI. The base DN should specify DC=
       for each domain component and multiple DCs should be separated by commas.
     required: true
+    type: str
   bind_password:
     description:
     - Sets the password of the bind_user user name account.
+    type: str
   bind_user:
     description:
     - Sets the user name that can be used to bind to and query the directory.
@@ -64,6 +69,7 @@ options:
       sAMAccountName or User Logon Name - of the account that is used to
       perform directory lookups.
     - For OpenLDAP, enter the full DN of the user.
+    type: str
 extends_documentation_fragment:
 - purestorage.fb
 '''

lib/ansible/modules/storage/purestorage/purefb_dsrole.py

@@ -19,17 +19,19 @@ short_description: Configure FlashBlade  Management Directory Service Roles
 description:
 - Set or erase directory services role configurations.
 author:
-- Simon Dodsley (@sdodsley)
+- Pure Storage Ansible Team (@sdodsley) <pure-ansible-team@purestorage.com>
 options:
   state:
     description:
     - Create or delete directory service role
     default: present
+    type: str
     choices: [ absent, present ]
   role:
     description:
     - The directory service role to work on
     choices: [ array_admin, ops_admin, readonly, storage_admin ]
+    type: str
   group_base:
     description:
     - Specifies where the configured group is located in the directory
@@ -40,12 +42,14 @@ options:
       The order of OUs is important and should get larger in scope from left
       to right.
     - Each OU should not exceed 64 characters in length.
+    type: str
   group:
     description:
     - Sets the common Name (CN) of the configured directory service group
       containing users for the FlashBlade. This name should be just the
       Common Name of the group without the CN= specifier.
     - Common Names should not exceed 64 characters in length.
+    type: str
 extends_documentation_fragment:
 - purestorage.fb
 '''

lib/ansible/modules/storage/purestorage/purefb_facts.py

@@ -24,7 +24,7 @@ description:
     groups and volume counts. Additional fact information can be collected
     based on the configured set of arguements.
 author:
-  - Simon Dodsley (@sdodsley)
+  - Pure Storage Ansible Team (@sdodsley) <pure-ansible-team@purestorage.com>
 options:
   gather_subset:
     description:
@@ -32,6 +32,7 @@ options:
         Possible values for this include all, minimum, config, performance,
         capacity, network, subnets, lags, filesystems and snapshots.
     required: false
+    type: list
     default: minimum
 extends_documentation_fragment:
   - purestorage.fb

lib/ansible/modules/storage/purestorage/purefb_fs.py

@@ -20,17 +20,19 @@ version_added: "2.6"
 short_description:  Manage filesystemon Pure Storage FlashBlade`
 description:
     - This module manages filesystems on Pure Storage FlashBlade.
-author: Simon Dodsley (@sdodsley)
+author: Pure Storage Ansible Team (@sdodsley) <pure-ansible-team@purestorage.com>
 options:
   name:
     description:
       - Filesystem Name.
     required: true
+    type: str
   state:
     description:
       - Create, delete or modifies a filesystem.
     required: false
     default: present
+    type: str
     choices: [ "present", "absent" ]
   eradicate:
     description:
@@ -41,6 +43,7 @@ options:
   size:
     description:
       - Volume size in M, G, T or P units. See examples.
+    type: str
     required: false
     default: 32G
   nfs:
@@ -54,6 +57,7 @@ options:
       - Define the NFS rules in operation.
     required: false
     default: '*(rw,no_root_squash)'
+    type: str
   smb:
     description:
       - Define whether to SMB protocol is enabled for the filesystem.

lib/ansible/modules/storage/purestorage/purefb_network.py

@@ -23,34 +23,39 @@ description:
     - When creating a network interface a subnet must already exist with
       a network prefix that covers the IP address of the interface being
       created.
-author: Simon Dodsley (@sdodsley)
+author: Pure Storage Ansible Team (@sdodsley) <pure-ansible-team@purestorage.com>
 options:
   name:
     description:
       - Interface Name.
     required: true
+    type: str
   state:
     description:
       - Create, delete or modifies a network interface.
     required: false
     default: present
     choices: [ "present", "absent" ]
+    type: str
   address:
     description:
       - IP address of interface.
     required: false
+    type: str
   services:
     description:
       - Define which services are configured for the interfaces.
     required: false
     choices: [ "data" ]
     default: data
+    type: str
   itype:
     description:
       - Type of interface.
     required: false
     choices: [ "vip" ]
     default: vip
+    type: str
 extends_documentation_fragment:
     - purestorage.fb
 '''

lib/ansible/modules/storage/purestorage/purefb_s3acc.py

@@ -19,16 +19,18 @@ short_description: Create or delete FlashBlade Object Store accounts
 description:
 - Create or delete object store accounts on a Pure Stoage FlashBlade.
 author:
-- Simon Dodsley (@sdodsley)
+- Pure Storage Ansible Team (@sdodsley) <pure-ansible-team@purestorage.com>
 options:
   state:
     description:
     - Create or delete object store account
     default: present
     choices: [ absent, present ]
+    type: str
   name:
     description:
     - The name of object store account
+    type: str
 extends_documentation_fragment:
 - purestorage.fb
 '''

lib/ansible/modules/storage/purestorage/purefb_s3user.py

@@ -19,19 +19,22 @@ short_description: Create or delete FlashBlade Object Store account users
 description:
 - Create or delete object store account users on a Pure Stoage FlashBlade.
 author:
-- Simon Dodsley (@sdodsley)
+- Pure Storage Ansible Team (@sdodsley) <pure-ansible-team@purestorage.com>
 options:
   state:
     description:
     - Create or delete object store account user
     default: present
     choices: [ absent, present ]
+    type: str
   name:
     description:
     - The name of object store user
+    type: str
   account:
     description:
     - The name of object store account associated with user
+    type: str
   access_key:
     description:
     - Create secret access key.

lib/ansible/modules/storage/purestorage/purefb_snap.py

@@ -19,20 +19,23 @@ short_description: Manage filesystem snapshots on Pure Storage FlashBlades
 description:
 - Create or delete volumes and filesystem snapshots on Pure Storage FlashBlades.
 author:
-- Simon Dodsley (@sdodsley)
+- Pure Storage Ansible Team (@sdodsley) <pure-ansible-team@purestorage.com>
 options:
   name:
     description:
     - The name of the source filesystem.
     required: true
+    type: str
   suffix:
     description:
     - Suffix of snapshot name.
+    type: str
   state:
     description:
     - Define whether the filesystem snapshot should exist or not.
     choices: [ absent, present ]
     default: present
+    type: str
   eradicate:
     description:
     - Define whether to eradicate the snapshot on delete or leave in trash.

lib/ansible/modules/storage/purestorage/purefb_subnet.py

@@ -20,37 +20,43 @@ version_added: "2.8"
 short_description:  Manage network subnets in a Pure Storage FlashBlade
 description:
     - This module manages network subnets on Pure Storage FlashBlade.
-author: Simon Dodsley (@sdodsley)
+author: Pure Storage Ansible Team (@sdodsley) <pure-ansible-team@purestorage.com>
 options:
   name:
     description:
       - Subnet Name.
     required: true
+    type: str
   state:
     description:
       - Create, delete or modifies a subnet.
     required: false
     default: present
     choices: [ "present", "absent" ]
+    type: str
   gateway:
     description:
       - IPv4 or IPv6 address of subnet gateway.
     required: false
+    type: str
   mtu:
     description:
       - MTU size of the subnet. Range is 1280 to 9216.
     required: false
     default: 1500
+    type: int
   prefix:
     description:
       - IPv4 or IPv6 address associated with the subnet.
       - Supply the prefix length (CIDR) as well as the IP address.
     required: false
+    type: str
   vlan:
     description:
       - VLAN ID of the subnet.
     required: false
     default: 0
+    type: int
 extends_documentation_fragment:
     - purestorage.fb
 notes: