summaryrefslogtreecommitdiffstats
path: root/ansible_collections/dellemc/powerflex/docs/modules/sdc.rst
blob: ad375ebc7ec930a7a659fee0af4d6ff5c7123f5d (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
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
.. _sdc_module:


sdc -- Manage SDCs on Dell PowerFlex
====================================

.. contents::
   :local:
   :depth: 1


Synopsis
--------

Managing SDCs on PowerFlex storage system includes getting details of SDC and renaming SDC.



Requirements
------------
The below requirements are needed on the host that executes this module.

- A Dell PowerFlex storage system version 3.6 or later.
- Ansible-core 2.14 or later.
- PyPowerFlex 1.9.0.
- Python 3.9, 3.10 or 3.11.



Parameters
----------

  sdc_name (optional, str, None)
    Name of the SDC.

    Specify either *sdc_name*, *sdc_id* or *sdc_ip* for get/rename operation.

    Mutually exclusive with *sdc_id* and *sdc_ip*.


  sdc_id (optional, str, None)
    ID of the SDC.

    Specify either *sdc_name*, *sdc_id* or *sdc_ip* for get/rename operation.

    Mutually exclusive with *sdc_name* and *sdc_ip*.


  sdc_ip (optional, str, None)
    IP of the SDC.

    Specify either *sdc_name*, *sdc_id* or *sdc_ip* for get/rename operation.

    Mutually exclusive with *sdc_id* and *sdc_name*.


  sdc_new_name (optional, str, None)
    New name of the SDC. Used to rename the SDC.


  performance_profile (optional, str, None)
    Define the performance profile as *Compact* or *HighPerformance*.

    The high performance profile configures a predefined set of parameters for very high performance use cases.


  state (True, str, None)
    State of the SDC.


  hostname (True, str, None)
    IP or FQDN of the PowerFlex host.


  username (True, str, None)
    The username of the PowerFlex host.


  password (True, str, None)
    The password of the PowerFlex host.


  validate_certs (optional, bool, True)
    Boolean variable to specify whether or not to validate SSL certificate.

    ``true`` - Indicates that the SSL certificate should be verified.

    ``false`` - Indicates that the SSL certificate should not be verified.


  port (optional, int, 443)
    Port number through which communication happens with PowerFlex host.


  timeout (False, int, 120)
    Time after which connection will get terminated.

    It is to be mentioned in seconds.





Notes
-----

.. note::
   - The *check_mode* is not supported.
   - The modules present in the collection named as 'dellemc.powerflex' are built to support the Dell PowerFlex storage platform.




Examples
--------

.. code-block:: yaml+jinja

    
    - name: Get SDC details using SDC ip
      dellemc.powerflex.sdc:
        hostname: "{{hostname}}"
        username: "{{username}}"
        password: "{{password}}"
        validate_certs: "{{validate_certs}}"
        sdc_ip: "{{sdc_ip}}"
        state: "present"

    - name: Rename SDC using SDC name
      dellemc.powerflex.sdc:
        hostname: "{{hostname}}"
        username: "{{username}}"
        password: "{{password}}"
        validate_certs: "{{validate_certs}}"
        sdc_name: "centos_sdc"
        sdc_new_name: "centos_sdc_renamed"
        state: "present"

    - name: Modify performance profile of SDC using SDC name
      dellemc.powerflex.sdc:
        hostname: "{{hostname}}"
        username: "{{username}}"
        password: "{{password}}"
        validate_certs: "{{validate_certs}}"
        sdc_name: "centos_sdc"
        performance_profile: "Compact"
        state: "present"

    - name: Remove SDC using SDC name
      dellemc.powerflex.sdc:
        hostname: "{{hostname}}"
        username: "{{username}}"
        password: "{{password}}"
        validate_certs: "{{validate_certs}}"
        sdc_name: "centos_sdc"
        state: "absent"



Return Values
-------------

changed (always, bool, false)
  Whether or not the resource has changed.


sdc_details (When SDC exists, dict, {'id': '07335d3d00000006', 'installedSoftwareVersionInfo': 'R3_6.0.0', 'kernelBuildNumber': None, 'kernelVersion': '3.10.0', 'links': [{'href': '/api/instances/Sdc::07335d3d00000006', 'rel': 'self'}, {'href': '/api/instances/Sdc::07335d3d00000006/relationships/ Statistics', 'rel': '/api/Sdc/relationship/Statistics'}, {'href': '/api/instances/Sdc::07335d3d00000006/relationships/ Volume', 'rel': '/api/Sdc/relationship/Volume'}, {'href': '/api/instances/System::4a54a8ba6df0690f', 'rel': '/api/parent/relationship/systemId'}], 'mapped_volumes': [], 'mdmConnectionState': 'Disconnected', 'memoryAllocationFailure': None, 'name': 'LGLAP203', 'osType': 'Linux', 'peerMdmId': None, 'perfProfile': 'HighPerformance', 'sdcApproved': True, 'sdcApprovedIps': None, 'sdcGuid': 'F8ECB844-23B8-4629-92BB-B6E49A1744CB', 'sdcIp': 'N/A', 'sdcIps': None, 'sdcType': 'AppSdc', 'sdrId': None, 'socketAllocationFailure': None, 'softwareVersionInfo': 'R3_6.0.0', 'systemId': '4a54a8ba6df0690f', 'versionInfo': 'R3_6.0.0'})
  Details of the SDC.


  id (, str, )
    The ID of the SDC.


  name (, str, )
    Name of the SDC.


  sdcIp (, str, )
    IP of the SDC.


  osType (, str, )
    OS type of the SDC.


  mapped_volumes (, list, )
    The details of the mapped volumes.


    id (, str, )
      The ID of the volume.


    name (, str, )
      The name of the volume.


    volumeType (, str, )
      Type of the volume.



  sdcApproved (, bool, )
    Indicates whether an SDC has approved access to the system.






Status
------





Authors
~~~~~~~

- Akash Shendge (@shenda1) <ansible.team@dell.com>