mirror of
https://github.com/ansible-collections/community.general.git
synced 2024-09-14 20:13:21 +02:00
108 lines
3.2 KiB
Python
108 lines
3.2 KiB
Python
#
|
|
# (c) 2016, Sumit Kumar <sumit4@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/>.
|
|
|
|
|
|
class ModuleDocFragment(object):
|
|
|
|
DOCUMENTATION = """
|
|
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
|
|
ONTAP = """
|
|
options:
|
|
hostname:
|
|
required: true
|
|
description:
|
|
- The hostname or IP address of the ONTAP instance.
|
|
username:
|
|
required: true
|
|
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://goo.gl/BRu78Z).
|
|
password:
|
|
required: true
|
|
description:
|
|
- Password for the specified user.
|
|
|
|
requirements:
|
|
- A physical or virtual clustered Data ONTAP system. The modules were developed with Clustered Data ONTAP 8.3
|
|
- Ansible 2.2
|
|
- netapp-lib (2015.9.25). Install using 'pip install netapp-lib'
|
|
|
|
notes:
|
|
- The modules prefixed with C(netapp\_cdot) are built to support the ONTAP storage platform.
|
|
|
|
"""
|
|
|
|
# Documentation fragment for SolidFire
|
|
SOLIDFIRE = """
|
|
options:
|
|
hostname:
|
|
required: true
|
|
description:
|
|
- The hostname or IP address of the SolidFire cluster.
|
|
username:
|
|
required: true
|
|
description:
|
|
- Please ensure that the user has the adequate permissions. For more information, please read the official documentation U(https://goo.gl/ddJa4Q).
|
|
password:
|
|
required: true
|
|
description:
|
|
- Password for the specified user.
|
|
|
|
requirements:
|
|
- solidfire-sdk-python (1.1.0.92)
|
|
|
|
notes:
|
|
- The modules prefixed with C(sf\_) are built to support the SolidFire storage platform.
|
|
|
|
"""
|
|
|
|
# Documentation fragment for E-Series
|
|
ESERIES = """
|
|
options:
|
|
api_username:
|
|
required: true
|
|
description:
|
|
- The username to authenticate with the SANtricity WebServices Proxy or embedded REST API.
|
|
api_password:
|
|
required: true
|
|
description:
|
|
- The password to authenticate with the SANtricity WebServices Proxy or embedded REST API.
|
|
api_url:
|
|
required: true
|
|
description:
|
|
- The url to the SANtricity WebServices Proxy or embedded REST API.
|
|
example:
|
|
- https://prod-1.wahoo.acme.com/devmgr/v2
|
|
validate_certs:
|
|
required: false
|
|
default: true
|
|
description:
|
|
- Should https certificates be validated?
|
|
ssid:
|
|
required: true
|
|
description:
|
|
- The ID of the array to manage. This value must be unique for each array.
|
|
"""
|