-
Notifications
You must be signed in to change notification settings - Fork 49
/
new_mcm_group.py
332 lines (299 loc) · 12.3 KB
/
new_mcm_group.py
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
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
#
# Copyright (c) 2022 Dell EMC Corporation
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
"""
#### Synopsis
Script to create MCM group, add all members to the created group,
and assign a backup lead
#### Description:
This script creates a MCM group, adds all standalone domains to the
created group and assigns a member as backup lead.
Note:
1. Credentials entered are not stored to disk.
2. The value passed in by the user for the argument 'ip'
is set as the lead in the created MCM group
#### API Workflow
1. POST on SessionService/Sessions
2. If new session is created (201) parse headers
for x-auth token and update headers with token
3. All subsequent requests use X-auth token and not
user name and password entered by user
4. Create MCM group with given group name
with PUT on /ManagementDomainService
5. Parse returned job id and monitor it to completion
6. Add all standalone members to the created group
with POST on /ManagementDomainService/Actions/ManagementDomainService.Domains
7. Parse returned job id and monitor it to completion
8. Assign a random member as backup lead
with POST on /ManagementDomainService/Actions/ManagementDomainService.AssignBackupLead
9. Parse returned job id and monitor it to completion
#### Python Example
`python new_mcm_group.py --ip <ip addr> --user root --password <passwd> --groupname testgroup`
"""
import argparse
import random
import sys
import time
from argparse import RawTextHelpFormatter
from getpass import getpass
import requests
import urllib3
class SessionManager:
session = None
base_url = ''
def get_session(self):
if not self.session:
self.session = requests.Session()
self.session.headers.update({'content-type': 'application/json'})
return self.session
def get_base_url(self):
return self.base_url
def set_base_url(self, url):
self.base_url = url
def authenticate(session_manager, username, password):
session_url = '{0}/SessionService/Sessions'.format(session_manager.get_base_url())
session = session_manager.get_session()
auth_success = False
user_details = {
'UserName': username,
'Password': password,
'SessionType': 'API'
}
session_info = session.post(session_url, verify=False, json=user_details)
if session_info.status_code == 201:
session.headers.update({
'X-Auth-Token': session_info.headers['X-Auth-Token'],
'content-type': 'application/json'
})
auth_success = True
else:
print('Failed to login. Check username and password')
return auth_success
def create_mcm_group(session_manager, group_name):
create_group_url = '{0}/ManagementDomainService'.format(session_manager.get_base_url())
session = session_manager.get_session()
create_group_payload = {
"GroupName": group_name,
"GroupDescription": "",
"JoinApproval": "AUTOMATIC",
"ConfigReplication": [{
"ConfigType": "Power",
"Enabled": False
}, {
"ConfigType": "UserAuthentication",
"Enabled": False
}, {
"ConfigType": "AlertDestinations",
"Enabled": False
}, {
"ConfigType": "TimeSettings",
"Enabled": False
}, {
"ConfigType": "ProxySettings",
"Enabled": False
}, {
"ConfigType": "SecuritySettings",
"Enabled": False
}, {
"ConfigType": "NetworkServices",
"Enabled": False
}, {
"ConfigType": "LocalAccessConfiguration",
"Enabled": False
}]
}
group_info = session.put(create_group_url, verify=False,
json=create_group_payload)
job_id = None
if group_info.status_code == 200:
group_info = group_info.json()
job_id = group_info.get('JobId')
print('MCM group created : Job ID = {0}'.format(job_id))
else:
print('Failed to create MCM group with the below error')
return job_id
# Modified this section to return members
def get_domains(session_manager):
members = []
session = session_manager.get_session()
url = '{0}/ManagementDomainService/Domains'.format(session_manager.get_base_url())
response = session.get(url, verify=False)
if response.status_code == 200:
response = response.json()
member_devices = response.get('value')
member_devices = list(filter(lambda x: x.get(
'DomainRoleTypeValue') == 'MEMBER', member_devices))
members = member_devices
else:
print('Failed to get domains and status code returned is %s', response.status_code)
return members
def get_discovered_domains(session_manager, role=None):
discovered_domains = []
session = session_manager.get_session()
url = '{0}/ManagementDomainService/DiscoveredDomains'.format(session_manager.get_base_url())
domains_info = session.get(url, verify=False)
if domains_info.status_code == 200:
domains = domains_info.json()
if domains.get('@odata.count') > 0:
discovered_domains = domains.get('value')
else:
print("No domains discovered ... Error")
else:
print('Failed to discover domains - Status Code %s')
if role:
discovered_domains = list(filter(lambda x: x.get(
'DomainRoleTypeValue') == role, discovered_domains))
return discovered_domains
def add_all_members_via_lead(session_manager):
""" Add standalone domains to the group"""
standalone_domains = get_discovered_domains(session_manager,
role='STANDALONE')
session = session_manager.get_session()
job_id = None
if standalone_domains:
body = []
for domain in standalone_domains:
body.append({'GroupId': domain.get('GroupId')})
url = '{0}/ManagementDomainService/Actions/ManagementDomainService.Domains'.format(
session_manager.get_base_url())
response = session.post(url, json=body, verify=False)
if response.status_code == 200:
response_data = response.json()
job_id = response_data.get('JobId')
print('Added members to the created group, Job ID = {0}'.format(job_id))
else:
print('Failed to add members to the group')
else:
print('No standalone chassis found to add as member to the created group')
return job_id
def assign_backup_lead(session_manager):
url = '{0}/ManagementDomainService/Actions/ManagementDomainService.AssignBackupLead'.format(
session_manager.get_base_url())
session = session_manager.get_session()
members = get_domains(session_manager)
job_id = None
if members:
member = random.choice(members)
member_id = member.get('Id')
body = [{
'Id': member_id
}]
response = session.post(url, verify=False, json=body)
if response.status_code == 200:
response = response.json()
job_id = response.get('JobId')
else:
print('Failed to assign backup lead')
else:
print('Created group has no members. Failed to assign a backup lead')
return job_id
def get_job_status(session_manager, job_id):
""" Tracks the update job to completion / error """
session = session_manager.get_session()
job_status_map = {
"2020": "Scheduled",
"2030": "Queued",
"2040": "Starting",
"2050": "Running",
"2060": "Completed",
"2070": "Failed",
"2090": "Warning",
"2080": "New",
"2100": "Aborted",
"2101": "Paused",
"2102": "Stopped",
"2103": "Canceled"
}
max_retries = 20
sleep_interval = 60
failed_job_status = [2070, 2090, 2100, 2101, 2102, 2103]
job_url = '{0}/JobService/Jobs({1})'.format(session_manager.get_base_url(), job_id)
loop_ctr = 0
job_incomplete = True
print("Polling %s to completion ..." % job_id)
while loop_ctr < max_retries:
loop_ctr += 1
time.sleep(sleep_interval)
job_resp = session.get(job_url, verify=False)
if job_resp.status_code == 200:
job_status = str((job_resp.json())['LastRunStatus']['Id'])
print("Iteration %s: Status of %s is %s" % (loop_ctr, job_id, job_status_map[job_status]))
if int(job_status) == 2060:
job_incomplete = False
print("Completed job successfully ... Exiting")
break
elif int(job_status) in failed_job_status:
job_incomplete = False
print("Job failed ... ")
job_hist_url = str(job_url) + "/ExecutionHistories"
job_hist_resp = session.get(job_hist_url, verify=False)
if job_hist_resp.status_code == 200:
job_history_id = str((job_hist_resp.json())['value'][0]['Id'])
job_hist_det_url = str(job_hist_url) + "(" + job_history_id + ")/ExecutionHistoryDetails"
job_hist_det_resp = session.get(job_hist_det_url, verify=False)
if job_hist_det_resp.status_code == 200:
print(job_hist_det_resp.text)
else:
print("Unable to parse job execution history .. Exiting")
break
else:
print("Unable to poll status of %s - Iteration %s " % (job_id, loop_ctr))
if job_incomplete:
print("Job %s incomplete after polling %s times...Check status" % (job_id, max_retries))
if __name__ == '__main__':
urllib3.disable_warnings(urllib3.exceptions.InsecureRequestWarning)
parser = argparse.ArgumentParser(description=__doc__, formatter_class=RawTextHelpFormatter)
parser.add_argument("--ip", "-i", required=True, help="MSM IP")
parser.add_argument("--user", "-u", required=True, help="Username for MSM", default="root")
parser.add_argument("--password", "-p", required=False, help="Password for MSM")
parser.add_argument("--groupname", "-g", required=True, help="A valid name for the group")
args = parser.parse_args()
if not args.password:
if not sys.stdin.isatty():
# notify user that they have a bad terminal
# perhaps if os.name == 'nt': , prompt them to use winpty?
print("Your terminal is not compatible with Python's getpass module. You will need to provide the"
" --password argument instead. See https://stackoverflow.com/a/58277159/4427375")
sys.exit(0)
else:
password = getpass()
else:
password = args.password
base_url = 'https://{0}/api'.format(args.ip)
session_manager = SessionManager()
session_manager.set_base_url(base_url)
try:
if authenticate(session_manager, args.user, password):
job_id = create_mcm_group(session_manager, args.groupname)
if job_id:
print('Polling group creation ...')
get_job_status(session_manager, job_id)
job_id = add_all_members_via_lead(session_manager)
if job_id:
print('Polling addition of members to group ...')
get_job_status(session_manager, job_id)
job_id = assign_backup_lead(session_manager)
if job_id:
print('Polling backup lead assignment ...')
get_job_status(session_manager, job_id)
else:
print('Unable to track backup lead assignment ...')
else:
print("Unable to track addition of members to group ...")
else:
print("Unable to track group creation .. Exiting")
else:
print('Unable to authenticate. Check IP/username/password')
except Exception as error:
print("Unexpected error:", str(error))