summaryrefslogtreecommitdiffstats
path: root/ansible_collections/netapp_eseries/santricity/plugins/doc_fragments/santricity.py
blob: 0551f28213831f476b18919ed30b8e24f84ce56d (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
# -*- coding: utf-8 -*-

# (c) 2020, NetApp, Inc
# BSD-3 Clause (see COPYING or https://opensource.org/licenses/BSD-3-Clause)
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
"""

    # Documentation fragment for E-Series
    SANTRICITY_PROXY_DOC = 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:8443/devmgr/v2
    validate_certs:
        required: false
        default: true
        description:
            - Should https certificates be validated?
        type: bool

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.
"""

    # Documentation fragment for E-Series
    SANTRICITY_DOC = 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:8443/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.
"""