doc_fragments: Clean up parameter types (storage) (#52179)

* module_utils: Clean up parameter types (storage)

This PR includes:

- Parameter types added
- Copyright format fixes
- Short license statement
- Description fixes (only for a few files, then I stopped :-))

* Fix quotes

* Fix rST issue
This commit is contained in:
Dag Wieers 2019-02-15 09:31:12 +01:00 committed by John R Barker
commit fbca8a4615
5 changed files with 66 additions and 94 deletions

View file

@ -1,62 +1,52 @@
#
# (c) 2018, Sumit Kumar <sumit4@netapp.com>, chris Archibald <carchi@netapp.com>
#
# This file is part of Ansible
#
# Ansible is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# Ansible is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with Ansible. If not, see <http://www.gnu.org/licenses/>.
# -*- coding: utf-8 -*-
# Copyright: (c) 2018, Sumit Kumar <sumit4@netapp.com>, chris Archibald <carchi@netapp.com>
# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
class ModuleDocFragment(object):
DOCUMENTATION = """
DOCUMENTATION = r'''
options:
- See respective platform section for more details
requirements:
- See respective platform section for more details
notes:
- Ansible modules are available for the following NetApp Storage Platforms: E-Series, ONTAP, SolidFire
"""
'''
# Documentation fragment for ONTAP (na_ontap)
NA_ONTAP = """
NA_ONTAP = r'''
options:
hostname:
required: true
description:
- The hostname or IP address of the ONTAP instance.
username:
type: str
required: true
username:
description:
- This can be a Cluster-scoped or SVM-scoped account, depending on whether a Cluster-level or SVM-level API is required.
For more information, please read the documentation U(https://mysupport.netapp.com/NOW/download/software/nmsdk/9.4/).
aliases: ['user']
password:
type: str
required: true
aliases: [ user ]
password:
description:
- Password for the specified user.
aliases: ['pass']
type: str
required: true
aliases: [ pass ]
https:
description:
- Enable and disable https
type: bool
default: false
default: no
validate_certs:
description:
- If set to C(False), the SSL certificates will not be validated.
- If set to C(no), the SSL certificates will not be validated.
- This should only set to C(False) used on personally controlled sites using self-signed certificates.
default: true
type: bool
default: yes
http_port:
description:
- Override the default port (80 or 443) with this port
@ -77,10 +67,10 @@ requirements:
notes:
- The modules prefixed with na\\_ontap are built to support the ONTAP storage platform.
"""
'''
# Documentation fragment for ONTAP (na_cdot)
ONTAP = """
ONTAP = r'''
options:
hostname:
required: true
@ -105,10 +95,10 @@ requirements:
notes:
- The modules prefixed with na\\_cdot are built to support the ONTAP storage platform.
"""
'''
# Documentation fragment for SolidFire
SOLIDFIRE = """
SOLIDFIRE = r'''
options:
hostname:
required: true
@ -133,10 +123,10 @@ requirements:
notes:
- The modules prefixed with na\\_elementsw are built to support the SolidFire storage platform.
"""
'''
# Documentation fragment for E-Series
ESERIES = """
ESERIES = r'''
options:
api_username:
required: true
@ -168,4 +158,4 @@ notes:
the storage-system, or an E-Series storage-system that supports the Embedded Web Services API.
- Embedded Web Services is currently available on the E2800, E5700, EF570, and newer hardware models.
- M(netapp_e_storage_system) may be utilized for configuring the systems managed by a WSP instance.
"""
'''