mirror of
https://github.com/ansible-collections/community.general.git
synced 2024-09-14 20:13:21 +02:00
07ecfc940c
* Recover missing netapp.ontap module doc fragments from ansible/ansible@pre-ansible-base. * Fix PEP8 issues. * Remove netbox empty files, and test which shouldn't be here. * Add forgotten file for kubevirt tests. * Fix unit test imports. * ansible/ansible#68415 has been fixed. * Clean up/rearrange imports. * Update ignore.txt, fix boilerplate. * Netapp docs fragment: fix spacing * Forgot to adjust kubevirt tests.
114 lines
3.7 KiB
Python
114 lines
3.7 KiB
Python
# -*- 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)
|
|
|
|
from __future__ import (absolute_import, division, print_function)
|
|
__metaclass__ = type
|
|
|
|
|
|
class ModuleDocFragment(object):
|
|
|
|
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_cdot)
|
|
ONTAP = r'''
|
|
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://mysupport.netapp.com/NOW/download/software/nmsdk/9.4/).
|
|
aliases: ['user']
|
|
password:
|
|
required: true
|
|
description:
|
|
- Password for the specified user.
|
|
aliases: ['pass']
|
|
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 na\\_cdot are built to support the ONTAP storage platform.
|
|
|
|
'''
|
|
|
|
# Documentation fragment for SolidFire
|
|
SOLIDFIRE = r'''
|
|
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://mysupport.netapp.com/documentation/docweb/index.html?productID=62636&language=en-US).
|
|
aliases: ['user']
|
|
password:
|
|
required: true
|
|
description:
|
|
- Password for the specified user.
|
|
aliases: ['pass']
|
|
|
|
requirements:
|
|
- The modules were developed with SolidFire 10.1
|
|
- solidfire-sdk-python (1.1.0.92) or greater. Install using 'pip install solidfire-sdk-python'
|
|
|
|
notes:
|
|
- The modules prefixed with na\\_elementsw are built to support the SolidFire storage platform.
|
|
|
|
'''
|
|
|
|
# Documentation fragment for E-Series
|
|
ESERIES = r'''
|
|
options:
|
|
api_username:
|
|
required: true
|
|
type: str
|
|
description:
|
|
- The username to authenticate with the SANtricity Web Services Proxy or Embedded Web Services API.
|
|
api_password:
|
|
required: true
|
|
type: str
|
|
description:
|
|
- The password to authenticate with the SANtricity Web Services Proxy or Embedded Web Services API.
|
|
api_url:
|
|
required: true
|
|
type: str
|
|
description:
|
|
- The url to the SANtricity Web Services Proxy or Embedded Web Services API.
|
|
Example https://prod-1.wahoo.acme.com/devmgr/v2
|
|
validate_certs:
|
|
required: false
|
|
default: true
|
|
description:
|
|
- Should https certificates be validated?
|
|
type: bool
|
|
ssid:
|
|
required: false
|
|
type: str
|
|
default: 1
|
|
description:
|
|
- The ID of the array to manage. This value must be unique for each array.
|
|
|
|
notes:
|
|
- The E-Series Ansible modules require either an instance of the Web Services Proxy (WSP), to be available to manage
|
|
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.
|
|
'''
|