summaryrefslogtreecommitdiffstats
path: root/ansible_collections/dellemc/unity/plugins/doc_fragments/unity.py
blob: a712a80378ced3f276048a0583efbc8a63645701 (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
# Copyright: (c) 2024, Dell Technologies.
# Apache License version 2.0 (see MODULE-LICENSE or http://www.apache.org/licenses/LICENSE-2.0.txt)

from __future__ import absolute_import, division, print_function
__metaclass__ = type


class ModuleDocFragment(object):

    # Documentation fragment for Unity (unity)
    DOCUMENTATION = r'''
    options:
        unispherehost:
            required: true
            description:
            - IP or FQDN of the Unity management server.
            type: str
        username:
            type: str
            required: true
            description:
            - The username of the Unity management server.
        password:
            type: str
            required: true
            description:
            - The password of the Unity management server.
        validate_certs:
            type: bool
            default: true
            aliases:
            - verifycert
            description:
            - Boolean variable to specify whether or not to validate SSL
              certificate.
            - C(true) - Indicates that the SSL certificate should be verified.
            - C(false) - Indicates that the SSL certificate should not be
              verified.
        port:
            description:
            - Port number through which communication happens with Unity
              management server.
            type: int
            default: 443
    requirements:
      - A Dell Unity Storage device version 5.1 or later.
      - Ansible-core 2.14 or later.
      - Python 3.9, 3.10 or 3.11.
      - Storops Python SDK 1.2.11.
    notes:
      - The modules present in this collection named as 'dellemc.unity'
        are built to support the Dell Unity storage platform.
'''