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
|
.. _fault_set_module:
fault_set -- Manage Fault Sets on Dell PowerFlex
================================================
.. contents::
:local:
:depth: 1
Synopsis
--------
Managing fault sets on PowerFlex storage system includes creating, getting details, renaming and deleting a fault set.
Requirements
------------
The below requirements are needed on the host that executes this module.
- A Dell PowerFlex storage system version 3.6 or later.
- PyPowerFlex 1.12.0.
Parameters
----------
fault_set_name (optional, str, None)
Name of the Fault Set.
Mutually exclusive with *fault_set_id*.
fault_set_id (optional, str, None)
ID of the Fault Set.
Mutually exclusive with *fault_set_name*.
protection_domain_name (optional, str, None)
Name of protection domain.
Mutually exclusive with *protection_domain_id*.
protection_domain_id (optional, str, None)
ID of the protection domain.
Mutually exclusive with *protection_domain_name*.
fault_set_new_name (optional, str, None)
New name of the fault set.
state (optional, str, present)
State of the Fault Set.
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 supported.
- When *fault_set_name* is provided, *protection_domain_name* or *protection_domain_id* must be provided.
- 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: Create Fault Set on Protection Domain
dellemc.powerflex.fault_set:
hostname: "{{ hostname }}"
username: "{{ username }}"
password: "{{ password }}"
validate_certs: "{{ validate_certs }}"
fault_set_name: "{{ fault_set_name }}"
protection_domain_name: "{{ pd_name }}"
state: present
- name: Rename Fault Set
dellemc.powerflex.fault_set:
hostname: "{{ hostname }}"
username: "{{ username }}"
password: "{{ password }}"
validate_certs: "{{ validate_certs }}"
fault_set_name: "{{ fault_set_name }}"
fault_set_new_name: "{{ fault_set_new_name }}"
state: present
- name: Get details of a Fault Set
dellemc.powerflex.fault_set:
hostname: "{{ hostname }}"
username: "{{ username }}"
password: "{{ password }}"
validate_certs: "{{ validate_certs }}"
fault_set_id: "{{ fault_set_id }}"
state: present
- name: Delete Fault Set
dellemc.powerflex.fault_set:
hostname: "{{ hostname }}"
username: "{{ username }}"
password: "{{ password }}"
validate_certs: "{{ validate_certs }}"
fault_set_id: "{{ fault_set_id }}"
state: absent
Return Values
-------------
changed (always, bool, false)
Whether or not the resource has changed.
fault_set_details (always, dict, {'protectionDomainId': 'da721a8300000000', 'protectionDomainName': 'sample-pd', 'name': 'fs_001', 'id': 'eb44b70500000000', 'links': []})
Details of fault set.
protectionDomainId (, str, )
Unique identifier of the protection domain.
protectionDomainName (, str, )
Name of the protection domain.
name (, str, )
Name of the fault set.
id (, str, )
Unique identifier of the fault set.
SDS (, list, )
List of SDS associated to the fault set.
links (, list, )
Fault set links.
href (, str, )
Fault Set instance URL.
rel (, str, )
Relationship of fault set with different entities.
Status
------
Authors
~~~~~~~
- Carlos Tronco (@ctronco) <ansible.team@dell.com>
- Trisha Datta (@trisha-dell) <ansible.team@dell.com>
|
