From f28abce4a2cae8ff8b810664c15f6d152c86b7ec Mon Sep 17 00:00:00 2001 From: John R Barker Date: Fri, 21 Sep 2018 20:04:43 +0100 Subject: [PATCH] Update short description for NetApp E-Series modules. (#45820) (#45864) Update short description according to new standards (cherry picked from commit 205693a3f94d5d0b8d3dc8c97ff457d68434f3a3) --- lib/ansible/modules/storage/netapp/netapp_e_amg.py | 2 +- lib/ansible/modules/storage/netapp/netapp_e_amg_role.py | 2 +- lib/ansible/modules/storage/netapp/netapp_e_amg_sync.py | 2 +- lib/ansible/modules/storage/netapp/netapp_e_asup.py | 2 +- lib/ansible/modules/storage/netapp/netapp_e_auth.py | 2 +- lib/ansible/modules/storage/netapp/netapp_e_facts.py | 2 +- lib/ansible/modules/storage/netapp/netapp_e_flashcache.py | 2 +- lib/ansible/modules/storage/netapp/netapp_e_host.py | 5 ++--- lib/ansible/modules/storage/netapp/netapp_e_hostgroup.py | 2 +- .../modules/storage/netapp/netapp_e_snapshot_group.py | 2 +- .../modules/storage/netapp/netapp_e_snapshot_images.py | 2 +- .../modules/storage/netapp/netapp_e_snapshot_volume.py | 2 +- .../modules/storage/netapp/netapp_e_storage_system.py | 2 +- lib/ansible/modules/storage/netapp/netapp_e_storagepool.py | 2 +- lib/ansible/modules/storage/netapp/netapp_e_volume.py | 2 +- lib/ansible/modules/storage/netapp/netapp_e_volume_copy.py | 2 +- 16 files changed, 17 insertions(+), 18 deletions(-) diff --git a/lib/ansible/modules/storage/netapp/netapp_e_amg.py b/lib/ansible/modules/storage/netapp/netapp_e_amg.py index 2441eba5e5e..6b40a5e6597 100644 --- a/lib/ansible/modules/storage/netapp/netapp_e_amg.py +++ b/lib/ansible/modules/storage/netapp/netapp_e_amg.py @@ -14,7 +14,7 @@ ANSIBLE_METADATA = {'metadata_version': '1.1', DOCUMENTATION = """ --- module: netapp_e_amg -short_description: Create, Remove, and Update Asynchronous Mirror Groups +short_description: NetApp E-Series create, remove, and update asynchronous mirror groups description: - Allows for the creation, removal and updating of Asynchronous Mirror Groups for NetApp E-series storage arrays version_added: '2.2' diff --git a/lib/ansible/modules/storage/netapp/netapp_e_amg_role.py b/lib/ansible/modules/storage/netapp/netapp_e_amg_role.py index 71acf5a555a..3ac6fd10668 100644 --- a/lib/ansible/modules/storage/netapp/netapp_e_amg_role.py +++ b/lib/ansible/modules/storage/netapp/netapp_e_amg_role.py @@ -15,7 +15,7 @@ ANSIBLE_METADATA = {'metadata_version': '1.1', DOCUMENTATION = """ --- module: netapp_e_amg_role -short_description: Update the role of a storage array within an Asynchronous Mirror Group (AMG). +short_description: NetApp E-Series update the role of a storage array within an Asynchronous Mirror Group (AMG). description: - Update a storage array to become the primary or secondary instance in an asynchronous mirror group version_added: '2.2' diff --git a/lib/ansible/modules/storage/netapp/netapp_e_amg_sync.py b/lib/ansible/modules/storage/netapp/netapp_e_amg_sync.py index 5b747193a91..a168489a93e 100644 --- a/lib/ansible/modules/storage/netapp/netapp_e_amg_sync.py +++ b/lib/ansible/modules/storage/netapp/netapp_e_amg_sync.py @@ -15,7 +15,7 @@ ANSIBLE_METADATA = {'metadata_version': '1.1', DOCUMENTATION = """ --- module: netapp_e_amg_sync -short_description: Conduct synchronization actions on asynchronous mirror groups. +short_description: NetApp E-Series conduct synchronization actions on asynchronous mirror groups. description: - Allows for the initialization, suspension and resumption of an asynchronous mirror group's synchronization for NetApp E-series storage arrays. version_added: '2.2' diff --git a/lib/ansible/modules/storage/netapp/netapp_e_asup.py b/lib/ansible/modules/storage/netapp/netapp_e_asup.py index 1f921a63339..6301868e936 100644 --- a/lib/ansible/modules/storage/netapp/netapp_e_asup.py +++ b/lib/ansible/modules/storage/netapp/netapp_e_asup.py @@ -14,7 +14,7 @@ ANSIBLE_METADATA = {'metadata_version': '1.1', DOCUMENTATION = """ --- module: netapp_e_asup -short_description: manage E-Series auto-support settings +short_description: NetApp E-Series manage auto-support settings description: - Allow the auto-support settings to be configured for an individual E-Series storage-system version_added: '2.7' diff --git a/lib/ansible/modules/storage/netapp/netapp_e_auth.py b/lib/ansible/modules/storage/netapp/netapp_e_auth.py index 1c8534fe998..a014d0a318e 100644 --- a/lib/ansible/modules/storage/netapp/netapp_e_auth.py +++ b/lib/ansible/modules/storage/netapp/netapp_e_auth.py @@ -14,7 +14,7 @@ ANSIBLE_METADATA = {'metadata_version': '1.1', DOCUMENTATION = ''' --- module: netapp_e_auth -short_description: Sets or updates the password for a storage array. +short_description: NetApp E-Series set or update the password for a storage array. description: - Sets or updates the password for a storage array. When the password is updated on the storage array, it must be updated on the SANtricity Web Services proxy. Note, all storage arrays do not have a Monitor or RO role. diff --git a/lib/ansible/modules/storage/netapp/netapp_e_facts.py b/lib/ansible/modules/storage/netapp/netapp_e_facts.py index cda569874bc..7bb70764361 100644 --- a/lib/ansible/modules/storage/netapp/netapp_e_facts.py +++ b/lib/ansible/modules/storage/netapp/netapp_e_facts.py @@ -15,7 +15,7 @@ ANSIBLE_METADATA = {'metadata_version': '1.1', DOCUMENTATION = ''' module: netapp_e_facts version_added: '2.2' -short_description: Get facts about NetApp E-Series arrays +short_description: NetApp E-Series retrieve facts about NetApp E-Series storage arrays options: api_username: required: true diff --git a/lib/ansible/modules/storage/netapp/netapp_e_flashcache.py b/lib/ansible/modules/storage/netapp/netapp_e_flashcache.py index e8ac7b22ddf..ac769f53418 100644 --- a/lib/ansible/modules/storage/netapp/netapp_e_flashcache.py +++ b/lib/ansible/modules/storage/netapp/netapp_e_flashcache.py @@ -16,7 +16,7 @@ DOCUMENTATION = ''' module: netapp_e_flashcache author: Kevin Hulquest (@hulquest) version_added: '2.2' -short_description: Manage NetApp SSD caches +short_description: NetApp E-Series manage SSD caches description: - Create or remove SSD caches on a NetApp E-Series storage array. options: diff --git a/lib/ansible/modules/storage/netapp/netapp_e_host.py b/lib/ansible/modules/storage/netapp/netapp_e_host.py index 920685ee9e5..54e498af25f 100644 --- a/lib/ansible/modules/storage/netapp/netapp_e_host.py +++ b/lib/ansible/modules/storage/netapp/netapp_e_host.py @@ -14,9 +14,8 @@ ANSIBLE_METADATA = {'metadata_version': '1.1', DOCUMENTATION = """ --- module: netapp_e_host -short_description: manage eseries hosts -description: - - Create, update, remove hosts on NetApp E-series storage arrays +short_description: NetApp E-Series manage eseries hosts +description: Create, update, remove hosts on NetApp E-series storage arrays version_added: '2.2' author: Kevin Hulquest (@hulquest) extends_documentation_fragment: diff --git a/lib/ansible/modules/storage/netapp/netapp_e_hostgroup.py b/lib/ansible/modules/storage/netapp/netapp_e_hostgroup.py index 36b5f31a21e..231705b1b66 100644 --- a/lib/ansible/modules/storage/netapp/netapp_e_hostgroup.py +++ b/lib/ansible/modules/storage/netapp/netapp_e_hostgroup.py @@ -17,7 +17,7 @@ DOCUMENTATION = ''' --- module: netapp_e_hostgroup version_added: "2.2" -short_description: Manage NetApp Storage Array Host Groups +short_description: NetApp E-Series manage array host groups author: Kevin Hulquest (@hulquest) description: - Create, update or destroy host groups on a NetApp E-Series storage array. diff --git a/lib/ansible/modules/storage/netapp/netapp_e_snapshot_group.py b/lib/ansible/modules/storage/netapp/netapp_e_snapshot_group.py index 7786e195c88..5f191b31607 100644 --- a/lib/ansible/modules/storage/netapp/netapp_e_snapshot_group.py +++ b/lib/ansible/modules/storage/netapp/netapp_e_snapshot_group.py @@ -15,7 +15,7 @@ ANSIBLE_METADATA = {'metadata_version': '1.1', DOCUMENTATION = """ --- module: netapp_e_snapshot_group -short_description: Manage snapshot groups +short_description: NetApp E-Series manage snapshot groups description: - Create, update, delete snapshot groups for NetApp E-series storage arrays version_added: '2.2' diff --git a/lib/ansible/modules/storage/netapp/netapp_e_snapshot_images.py b/lib/ansible/modules/storage/netapp/netapp_e_snapshot_images.py index 0320fcbab8d..634e8ca4652 100644 --- a/lib/ansible/modules/storage/netapp/netapp_e_snapshot_images.py +++ b/lib/ansible/modules/storage/netapp/netapp_e_snapshot_images.py @@ -15,7 +15,7 @@ ANSIBLE_METADATA = {'metadata_version': '1.1', DOCUMENTATION = """ --- module: netapp_e_snapshot_images -short_description: Create and delete snapshot images +short_description: NetApp E-Series create and delete snapshot images description: - Create and delete snapshots images on snapshot groups for NetApp E-series storage arrays. - Only the oldest snapshot image can be deleted so consistency is preserved. diff --git a/lib/ansible/modules/storage/netapp/netapp_e_snapshot_volume.py b/lib/ansible/modules/storage/netapp/netapp_e_snapshot_volume.py index e73b5573eb1..33596a8da11 100644 --- a/lib/ansible/modules/storage/netapp/netapp_e_snapshot_volume.py +++ b/lib/ansible/modules/storage/netapp/netapp_e_snapshot_volume.py @@ -15,7 +15,7 @@ ANSIBLE_METADATA = {'metadata_version': '1.1', DOCUMENTATION = """ --- module: netapp_e_snapshot_volume -short_description: Manage E/EF-Series snapshot volumes. +short_description: NetApp E-Series manage snapshot volumes. description: - Create, update, remove snapshot volumes for NetApp E/EF-Series storage arrays. version_added: '2.2' diff --git a/lib/ansible/modules/storage/netapp/netapp_e_storage_system.py b/lib/ansible/modules/storage/netapp/netapp_e_storage_system.py index 0cee0d21b71..5dbec3bdb68 100644 --- a/lib/ansible/modules/storage/netapp/netapp_e_storage_system.py +++ b/lib/ansible/modules/storage/netapp/netapp_e_storage_system.py @@ -15,7 +15,7 @@ ANSIBLE_METADATA = {'metadata_version': '1.1', DOCUMENTATION = ''' module: netapp_e_storage_system version_added: "2.2" -short_description: Add/remove arrays from the Web Services Proxy +short_description: NetApp E-Series Web Services Proxy manage storage arrays description: - Manage the arrays accessible via a NetApp Web Services Proxy for NetApp E-series storage arrays. options: diff --git a/lib/ansible/modules/storage/netapp/netapp_e_storagepool.py b/lib/ansible/modules/storage/netapp/netapp_e_storagepool.py index 6643c0db1c7..daa63084c41 100644 --- a/lib/ansible/modules/storage/netapp/netapp_e_storagepool.py +++ b/lib/ansible/modules/storage/netapp/netapp_e_storagepool.py @@ -15,7 +15,7 @@ ANSIBLE_METADATA = {'metadata_version': '1.1', DOCUMENTATION = ''' --- module: netapp_e_storagepool -short_description: Manage disk groups and disk pools +short_description: NetApp E-Series manage disk groups and disk pools version_added: '2.2' description: - Create or remove disk groups and disk pools for NetApp E-series storage arrays. diff --git a/lib/ansible/modules/storage/netapp/netapp_e_volume.py b/lib/ansible/modules/storage/netapp/netapp_e_volume.py index 8905e15c8cb..2468b710cb8 100644 --- a/lib/ansible/modules/storage/netapp/netapp_e_volume.py +++ b/lib/ansible/modules/storage/netapp/netapp_e_volume.py @@ -15,7 +15,7 @@ DOCUMENTATION = ''' --- module: netapp_e_volume version_added: "2.2" -short_description: Manage storage volumes (standard and thin) +short_description: NetApp E-Series manage storage volumes (standard and thin) description: - Create or remove volumes (standard and thin) for NetApp E/EF-series storage arrays. extends_documentation_fragment: diff --git a/lib/ansible/modules/storage/netapp/netapp_e_volume_copy.py b/lib/ansible/modules/storage/netapp/netapp_e_volume_copy.py index dec33f05da8..73c64866e00 100644 --- a/lib/ansible/modules/storage/netapp/netapp_e_volume_copy.py +++ b/lib/ansible/modules/storage/netapp/netapp_e_volume_copy.py @@ -15,7 +15,7 @@ ANSIBLE_METADATA = {'metadata_version': '1.1', DOCUMENTATION = """ --- module: netapp_e_volume_copy -short_description: Create volume copy pairs +short_description: NetApp E-Series create volume copy pairs description: - Create and delete snapshots images on volume groups for NetApp E-series storage arrays. version_added: '2.2'