-
Notifications
You must be signed in to change notification settings - Fork 49
/
get_power_manager_monitoring_list.py
321 lines (254 loc) · 16.8 KB
/
get_power_manager_monitoring_list.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
#
# _author_ = Mahendran P <Mahendran_P@Dell.com>
#
# 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 get devices or groups being monitored by Power Manager.
#### Description
This script exercises the Power Manager REST API to get devices or groups that being monitored by Power Manager.
- For authentication X-Auth is used over Basic Authentication
- Note that the credentials entered are not stored to disk.
#### Python Example
python get_power_manager_monitoring_list.py --ip <xx> --username <username> --password <pwd>
Output:
==============================================
Devices being Monitored by Power Manager
==============================================
DEVICE_ID DEVICE_NAME SERVICETAG MODEL IS_PART_OF_GROUP? IS_POWER_POLICY_CAPABLE?
10103 WINDOWS2012.BLR.net XXXXXXX PowerEdge R640 True False
10104 WINDWIW.BLR.net YYYYYYY PowerEdge R640 True True
==============================================
Groups being Monitored by Power Manager
==============================================
GROUP_TYPE GROUP_ID GROUP_PARENT_ID GROUP_NAME DEVICES_IN_WORKING_SET
PHYSICAL_GROUP 10489 10488 AISLE2 3
STATIC_GROUP 10116 1021 G1_PMP1.0 5
"""
# Import the modules required for this script
import argparse
import json
import sys
from argparse import RawTextHelpFormatter
# Import the modules required for this script
from requests.packages.urllib3.exceptions import InsecureRequestWarning
try:
import urllib3
import requests
from columnar import columnar
except ModuleNotFoundError:
print("This program requires urllib3, requests, and columnar. To install them on most systems run "
"`pip install requests urllib3`")
sys.exit(0)
from requests.packages.urllib3.exceptions import InsecureRequestWarning
requests.packages.urllib3.disable_warnings(InsecureRequestWarning)
# Define Group Type Dictionary
group_type_dictionary = {
1: "STATIC_GROUP",
2: "PHYSICAL_GROUP"}
# Funtion to parse the PMP device JSON content & store the data
def store_pmp_device_elem(pmp_device_content):
device_column_data = []
# For every elements in Power Manager monitored devices response, store the details in the table
for pmp_device_elem in pmp_device_content["value"]:
pmp_device_data = [pmp_device_elem["Id"], pmp_device_elem["DeviceName"], pmp_device_elem["ServiceTag"],
pmp_device_elem["Model"], pmp_device_elem["IsPartOfGroup"],
pmp_device_elem["PowerPolicyCapable"]]
device_column_data.append(pmp_device_data)
return device_column_data
# Funtion to parse the PMP device JSON content & store the data
def store_pmp_group_elem(pmp_group_content):
group_column_data = []
# For every elements in Power Manager monitored devices response, store the details in the table
for pmp_group_elem in pmp_group_content["value"]:
pmp_group_data = [group_type_dictionary[int(pmp_group_elem["Type"])], pmp_group_elem["Id"],
pmp_group_elem["ParentId"], pmp_group_elem["Name"], pmp_group_elem["DevicesInWorkingSet"]]
group_column_data.append(pmp_group_data)
return group_column_data
def get_power_manager_monitoring_list(ip_address, user_name, password):
""" Authenticate with OpenManage Enterprise, get power manager monitored devices"""
try:
# Define the Base URL, Session URL & headers
base_uri = 'https://%s' % ip_address
session_url = 'https://%s/api/SessionService/Sessions' % ip_address
headers = {'content-type': 'application/json'}
# Define Payload for posting session API
user_details = {'UserName': user_name,
'Password': password,
'SessionType': 'API'}
# Define Power Manager Device & Group URL
pmp_device_url = "https://%s/api/PowerService/MonitoredDevices?$top=500" % ip_address
pmp_group_url = "https://%s/api/PowerService/MonitoredGroups?$top=100" % ip_address
# Defining OUTPUT format
device_output_column_headers = ['Device_ID', 'Device_Name', 'ServiceTag', 'Model', 'Is_Part_Of_Group?',
'Is_Power_Policy_Capable?']
device_output_column_data = []
group_output_column_headers = ['Group_Type', 'Group_ID', 'Group_Parent_ID', 'Group_Name',
'Devices_In_Working_Set']
group_output_column_data = []
# Create the session with OpenManage Enterprise
session_info = requests.post(session_url, verify=False,
data=json.dumps(user_details),
headers=headers)
# If session doesn't create, message the user with error
if session_info.status_code != 201 & session_info.status_code != 200:
session_json_data = session_info.json()
if 'error' in session_json_data:
error_content = session_json_data['error']
if '@Message.ExtendedInfo' not in error_content:
print("Unable to create a session with %s. Please try again later" % ip_address)
else:
extended_error_content = error_content['@Message.ExtendedInfo']
print(
"Unable to create a session with %s. See below ExtendedInfo for more information" % ip_address)
print(extended_error_content[0]['Message'])
else:
print("Unable to create a session with %s. Please try again later" % ip_address)
else:
headers['X-Auth-Token'] = session_info.headers['X-Auth-Token']
# Get Devices being monitored Power Manager API call with OpenManage Enterprise
pmp_device_response = requests.get(pmp_device_url, headers=headers, verify=False)
pmp_device_json_data = pmp_device_response.json()
# If PMP Device API doesn't respond or failed, message the user with error
if pmp_device_response.status_code != 201 & pmp_device_response.status_code != 200:
if 'error' in pmp_device_json_data:
error_content = pmp_device_json_data['error']
if '@Message.ExtendedInfo' not in error_content:
print("Unable to retrieve Power Manager devices list from %s" % ip_address)
else:
extended_error_content = error_content['@Message.ExtendedInfo']
print(
"Unable to retrieve Power Manager devices list from %s. See below ExtendedInfo for more information" % ip_address)
print(extended_error_content[0]['Message'])
else:
print("Unable to retrieve Power Manager devices list from %s" % ip_address)
else:
# Get the pmp device count from the JSON response data
pmp_device_count = pmp_device_json_data['@odata.count']
# If the pmp device count is 0, then error out immediately
if pmp_device_count <= 0:
print("No Devices being monitored by Power Manager in %s" % ip_address)
# If the PMP device count is not 0, then get the content & further process it to get devices
else:
pmp_device_content = json.loads(pmp_device_response.content)
# If there is no nextLink, then process the content to parse & store the capable Power Manager devices
if '@odata.nextLink' not in pmp_device_json_data:
device_output_column_data = store_pmp_device_elem(pmp_device_content)
# Else if the next link exist, process to get, parse & store the Power Manager devices until the nextLink exhaust.
else:
print(
"\n !!! INFO :: There are more than 500 devices being monitored by Power Manager in %s !!! \n It may take several minutes to get the result. Please wait..." % ip_address)
# Process the first set of Devices content to parse & store the capable Power Manager devices
device_output_column_data = store_pmp_device_elem(pmp_device_content)
# Define the nextLink URL
next_link_url = base_uri + pmp_device_json_data['@odata.nextLink']
# Until nextLink exhaust
while next_link_url:
# Get next set of Devices API call with OpenManage Enterprise
next_link_response = requests.get(next_link_url, headers=headers, verify=False)
if next_link_response.status_code != 200 & next_link_response.status_code != 201:
print(
"Unable to retrieve Power Manager devices list from nextLink %s" % (next_link_url))
else:
pmp_device_content = json.loads(next_link_response.content)
device_output_column_data += store_pmp_device_elem(pmp_device_content)
next_link_json_data = next_link_response.json()
if '@odata.nextLink' in next_link_json_data:
next_link_url = base_uri + next_link_json_data['@odata.nextLink']
else:
next_link_url = None
device_table = columnar(device_output_column_data, device_output_column_headers, no_borders=True)
print("\n ==============================================")
print(" Devices being Monitored by Power Manager ")
print(" ==============================================")
print(device_table)
# Get Groups being monitored Power Manager API call with OpenManage Enterprise
pmp_group_response = requests.get(pmp_group_url, headers=headers, verify=False)
pmp_group_json_data = pmp_group_response.json()
# If PMP Group API doesn't respond or failed, message the user with error
if pmp_group_response.status_code != 201 & pmp_group_response.status_code != 200:
if 'error' in pmp_group_json_data:
error_content = pmp_group_json_data['error']
if '@Message.ExtendedInfo' not in error_content:
print("Unable to retrieve Power Manager groups list from %s" % ip_address)
else:
extended_error_content = error_content['@Message.ExtendedInfo']
print(
"Unable to retrieve Power Manager groups list from %s. See below ExtendedInfo for more information" % ip_address)
print(extended_error_content[0]['Message'])
else:
print("Unable to retrieve Power Manager groups list from %s" % ip_address)
else:
# Get the PMP group count from the JSON response data
pmp_group_count = pmp_group_json_data['@odata.count']
# If PMP group count is 0, then error out immediately
if pmp_group_count <= 0:
print("No Devices being monitored by Power Manager in %s" % ip_address)
# If PMP group count is not 0, then get the content & further process it to get device capabilities.
else:
pmp_group_content = json.loads(pmp_group_response.content)
# If there is no nextLink, then process the content to parse & store the capable Power Manager devices
if '@odata.nextLink' not in pmp_group_json_data:
group_output_column_data = store_pmp_group_elem(pmp_group_content)
# Else if the next link exist, process to get, parse & store the capable Power Manager devices until the nextLink exhaust.
else:
print(
"\n !!! INFO :: There are more than 100 groups being managed by Power Manager in %s !!! \n It may take several minutes to get the result. Please wait..." % ip_address)
# Process the first set of Devices content to parse & store the capable Power Manager devices
group_output_column_data = store_pmp_group_elem(pmp_group_content)
# Define the nextLink URL
next_link_url = base_uri + pmp_group_json_data['@odata.nextLink']
# Until nextLink exhaust
while next_link_url:
# Get next set of Devices API call with OpenManage Enterprise
next_link_response = requests.get(next_link_url, headers=headers, verify=False)
if next_link_response.status_code != 200 & next_link_response.status_code != 201:
print("Unable to retrieve Power Manager groups list from nextLink %s" % (next_link_url))
else:
pmp_group_content = json.loads(next_link_response.content)
group_output_column_data += store_pmp_group_elem(pmp_group_content)
next_link_json_data = next_link_response.json()
if '@odata.nextLink' in next_link_json_data:
next_link_url = base_uri + next_link_json_data['@odata.nextLink']
else:
next_link_url = None
group_table = columnar(group_output_column_data, group_output_column_headers, no_borders=True)
print("\n ==============================================")
print(" Groups being Monitored by Power Manager ")
print(" ==============================================")
print(group_table)
except Exception as error:
print("Unexpected error:", str(error))
if __name__ == '__main__':
parser = argparse.ArgumentParser(description=__doc__, formatter_class=RawTextHelpFormatter)
parser.add_argument("--ip", "-i", required=True, help="OpenManage Enterprise IP <- Mandatory")
parser.add_argument("--username", "-u", required=False,
help="Username for OpenManage Enterprise <- Optional; default = admin", default="admin")
parser.add_argument("--password", "-p", required=True, help="Password for OpenManage Enterprise <- Mandatory")
args = parser.parse_args()
print("WARNING: THIS SCRIPT IS EXPERIMENTAL.")
print("The Power Manager scripts were originally internal Dell scripts we then published externally. If you see "
"this message and are using one of these scripts it would be very helpful if you open an issue on GitHub "
"at https://github.com/dell/OpenManage-Enterprise/issues and tell us you are using the script. We have not "
"dedicated any resources to optimizing them but are happy to do so if we know the community is using them. "
"Likewise if you find a bug in one of these scripts feel free to open an issue and we will investigate.")
get_power_manager_monitoring_list(args.ip, args.username, args.password)
print("WARNING: THIS SCRIPT IS EXPERIMENTAL.")
print("The Power Manager scripts were originally internal Dell scripts we then published externally. If you see "
"this message and are using one of these scripts it would be very helpful if you open an issue on GitHub "
"at https://github.com/dell/OpenManage-Enterprise/issues and tell us you are using the script. We have not "
"dedicated any resources to optimizing them but are happy to do so if we know the community is using them. "
"Likewise if you find a bug in one of these scripts feel free to open an issue and we will investigate.")