Debian Codegraph @

ansible_collections/netapp/storagegrid/plugins/doc_fragments/netapp.py

raw
1 # Copyright: (c) 2019, NetApp Ansible Team <[email protected]>
2 # GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
3
4 from __future__ import absolute_import, division, print_function
5
6 __metaclass__ = type
7
8
9 class ModuleDocFragment(object):
10
11 DOCUMENTATION = r"""
12 options:
13 - See respective platform section for more details
14 requirements:
15 - See respective platform section for more details
16 notes:
17 - This is documentation for NetApp's StorageGRID modules.
18 """
19
20 # Documentation fragment for StorageGRID
21 SG = """
22 options:
23 auth_token:
24 required: true
25 type: str
26 description:
27 - The authorization token for the API request
28 api_url:
29 required: true
30 type: str
31 description:
32 - The url to the StorageGRID Admin Node REST API.
33 validate_certs:
34 required: false
35 default: true
36 description:
37 - Should https certificates be validated?
38 type: bool
39 notes:
40 - The modules prefixed with C(na_sg) are built to manage NetApp StorageGRID.
41 """
42
43 # Documentation fragment for StorageGRID node PGE
44 SG_PGE = """
45 options:
46 api_url:
47 required: true
48 type: str
49 description:
50 - The url to the StorageGRID Node PGE REST API.
51 validate_certs:
52 required: false
53 default: true
54 description:
55 - Should https certificates be validated?
56 type: bool
57 notes:
58 - The modules prefixed with C(na_sg_pge) are built to manage NetApp StorageGRID node Pre-Grid Environment (PGE) configuration.
59 """