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
224
225
226
227
228
229
230
231
232
233
234
235
236
|
.. _ome_groups_module:
ome_groups -- Manages static device groups on OpenManage Enterprise
===================================================================
.. contents::
:local:
:depth: 1
Synopsis
--------
This module allows to create, modify, and delete static device groups on OpenManage Enterprise.
Requirements
------------
The below requirements are needed on the host that executes this module.
- python \>= 3.9.6
Parameters
----------
state (optional, str, present)
\ :literal:`present`\ allows to create or modify a device group.
\ :literal:`absent`\ allows to delete a device group.
name (optional, list, None)
Name of the device group to be created, modified, or deleted.
If \ :emphasis:`state`\ is absent, multiple names can be provided.
This option is case insensitive.
This option is mutually exclusive with \ :emphasis:`group\_id`\ .
group_id (optional, list, None)
ID of the device group to be created, modified, or deleted.
If \ :emphasis:`state`\ is absent, multiple IDs can be provided.
This option is mutually exclusive with \ :emphasis:`name`\ .
new_name (optional, str, None)
New name for the existing device group.
This is applicable only when \ :emphasis:`state`\ is \ :literal:`present`\ .
description (optional, str, None)
Description for the device group.
This is applicable only when \ :emphasis:`state`\ is \ :literal:`present`\ .
parent_group_name (optional, str, Static Groups)
Name of the parent device group under which the device group to be created or modified.
This is applicable only when \ :emphasis:`state`\ is \ :literal:`present`\ .
\ :literal:`NOTE`\ If device group with such a name does not exist, device group with \ :emphasis:`parent\_group\_name`\ is created.
This option is case insensitive.
This option is mutually exclusive with \ :emphasis:`parent\_group\_id`\ .
parent_group_id (optional, int, None)
ID of the parent device group under which the device group to be created or modified.
This is applicable only when \ :emphasis:`state`\ is \ :literal:`present`\ .
This option is mutually exclusive with \ :emphasis:`parent\_group\_name`\ .
hostname (True, str, None)
OpenManage Enterprise IP address or hostname.
username (False, str, None)
OpenManage Enterprise username.
If the username is not provided, then the environment variable \ :envvar:`OME\_USERNAME`\ is used.
Example: export OME\_USERNAME=username
password (False, str, None)
OpenManage Enterprise password.
If the password is not provided, then the environment variable \ :envvar:`OME\_PASSWORD`\ is used.
Example: export OME\_PASSWORD=password
x_auth_token (False, str, None)
Authentication token.
If the x\_auth\_token is not provided, then the environment variable \ :envvar:`OME\_X\_AUTH\_TOKEN`\ is used.
Example: export OME\_X\_AUTH\_TOKEN=x\_auth\_token
port (optional, int, 443)
OpenManage Enterprise HTTPS port.
validate_certs (optional, bool, True)
If \ :literal:`false`\ , the SSL certificates will not be validated.
Configure \ :literal:`false`\ only on personally controlled sites where self-signed certificates are used.
Prior to collection version \ :literal:`5.0.0`\ , the \ :emphasis:`validate\_certs`\ is \ :literal:`false`\ by default.
ca_path (optional, path, None)
The Privacy Enhanced Mail (PEM) file that contains a CA certificate to be used for the validation.
timeout (optional, int, 30)
The socket level timeout in seconds.
Notes
-----
.. note::
- This module manages only static device groups on Dell OpenManage Enterprise.
- If a device group with the name \ :emphasis:`parent\_group\_name`\ does not exist, a new device group with the same name is created.
- Make sure the entered parent group is not the descendant of the provided group.
- Run this module from a system that has direct access to Dell OpenManage Enterprise.
- This module supports \ :literal:`check\_mode`\ .
Examples
--------
.. code-block:: yaml+jinja
---
- name: Create a new device group
dellemc.openmanage.ome_groups:
hostname: "192.168.0.1"
username: "username"
password: "password"
ca_path: "/path/to/ca_cert.pem"
name: "group 1"
description: "Group 1 description"
parent_group_name: "group parent 1"
- name: Modify a device group using the group ID
dellemc.openmanage.ome_groups:
hostname: "192.168.0.1"
username: "username"
password: "password"
ca_path: "/path/to/ca_cert.pem"
group_id: 1234
description: "Group description updated"
parent_group_name: "group parent 2"
- name: Delete a device group using the device group name
dellemc.openmanage.ome_groups:
hostname: "192.168.0.1"
username: "username"
password: "password"
ca_path: "/path/to/ca_cert.pem"
state: absent
name: "group 1"
- name: Delete multiple device groups using the group IDs
dellemc.openmanage.ome_groups:
hostname: "192.168.0.1"
username: "username"
password: "password"
ca_path: "/path/to/ca_cert.pem"
state: absent
group_id:
- 1234
- 5678
Return Values
-------------
msg (always, str, Successfully deleted the device group(s).)
Overall status of the device group operation.
group_status (success, dict, {'Description': 'my group description', 'Id': 12123, 'MembershipTypeId': 12, 'Name': 'group 1', 'ParentId': 12345, 'TypeId': 3000, 'IdOwner': 30, 'CreatedBy': 'admin', 'CreationTime': '2021-01-01 10:10:10.100', 'DefinitionDescription': 'UserDefined', 'DefinitionId': 400, 'GlobalStatus': 5000, 'HasAttributes': False, 'UpdatedBy': '', 'UpdatedTime': '2021-01-01 11:11:10.100', 'Visible': True})
Details of the device group operation status.
group_ids (when I(state) is C(absent), list, [1234, 5678])
List of the deleted device group IDs.
invalid_groups (when I(state) is C(absent), list, [1234, 5678])
List of the invalid device group IDs or names.
error_info (on HTTP error, dict, {'error': {'code': 'Base.1.0.GeneralError', 'message': 'A general error has occurred. See ExtendedInfo for more information.', '@Message.ExtendedInfo': [{'MessageId': 'CGRP9013', 'RelatedProperties': [], 'Message': 'Unable to update group 12345 with the provided parent 54321 because a group/parent relationship already exists.', 'MessageArgs': ['12345', '54321'], 'Severity': 'Warning', 'Resolution': 'Make sure the entered parent ID does not create a bidirectional relationship and retry the operation.'}]}})
Details of the HTTP Error.
Status
------
Authors
~~~~~~~
- Jagadeesh N V(@jagadeeshnv)
|
