-
Notifications
You must be signed in to change notification settings - Fork 49
/
get_power_manager_top_energy_consumers.py
232 lines (191 loc) · 10.9 KB
/
get_power_manager_top_energy_consumers.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
#
# _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 the list of top 5 energy consuming (KWH) Server/Chassis/Group being monitored by Power Manager
#### Description
This script exercises the OpenManage Enterprise REST API to get the list of top 5 energy consuming Server/Chassis/Group (in KWH) 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_top_energy_consumers.py --ip <xx> --username <username> --password <pwd>
"""
# 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)
# Top energy consumer dictionary to display the output for better reading
top_energy_consumer_dictionary = {
1: "Server",
2: "Chassis",
3: "Group"}
# Duration dictionary to display the output for better reading
duration_dictionary = {
4: "1 Day",
5: "1 Week",
6: "2 Weeks",
7: "1 Month",
8: "3 Months",
9: "6 Months",
10: "1 Year"}
def entity_type_definition(ent_input):
entity_switch = {
'Group': (1, 1000),
'Server': (0, 1000),
'Chassis': (0, 2000)
}
return entity_switch.get(ent_input, "Empty")
def get_power_manager_top_energy_consumers(ip_address, user_name, password, entity, duration):
""" Authenticate with OpenManage Enterprise, enumerate top energy consumers"""
try:
# Defining Session URL & its headers
session_url = 'https://%s/api/SessionService/Sessions' % ip_address
headers = {'content-type': 'application/json'}
user_details = {'UserName': user_name,
'Password': password,
'SessionType': 'API'}
# Define the power manager top energy consumer URL
top_energy_consumer_url = "https://%s/api/MetricService/TopEnergyConsumption" % ip_address
# Get entity & device type basis user input
entity_type, device_type = entity_type_definition(entity)
# Define Payload for posting top energy consumer API
top_energy_consumer_payload = {
"PluginId": "2F6D05BE-EE4B-4B0E-B873-C8D2F64A4625",
"Top": 5,
"EntityType": entity_type,
"DeviceType": device_type,
"Duration": duration}
# Defining OUTPUT format
output_column_headers = ['Id', 'Name', 'Value (in KWH)']
top_energy_consumer_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" % 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 top energy consumer API call with OpenManage Enterprise
top_energy_consumer_response = requests.post(top_energy_consumer_url,
data=json.dumps(top_energy_consumer_payload), headers=headers,
verify=False)
top_energy_consumer_json_data = top_energy_consumer_response.json()
# If Top energy consumer API doesn't respond or failed, message the user with error
if top_energy_consumer_response.status_code != 201 & top_energy_consumer_response.status_code != 200:
if 'error' in top_energy_consumer_json_data:
error_content = top_energy_consumer_json_data['error']
if '@Message.ExtendedInfo' not in error_content:
print("Unable to retrieve Power Manager - top energy consuming %s in %s" % (entity, ip_address))
else:
extended_error_content = error_content['@Message.ExtendedInfo']
print(
"Unable to retrieve Power Manager - top energy consuming %s in %s. See below ExtendedInfo for more information" % (
entity, ip_address))
print(extended_error_content[0]['Message'])
else:
print("Unable to retrieve Power Manager - top energy consuming %s in %s" % (entity, ip_address))
else:
top_energy_consumer_content = json.loads(top_energy_consumer_response.content)
if 'Value' not in top_energy_consumer_content:
print("No Power Manager - top energy consuming %s in %s" % (entity, ip_address))
else:
# For every elements in the Power Manager Metrics Alerts response, store the details in the table
for top_energy_consumer_elem in top_energy_consumer_content["Value"]:
top_energy_consumer_data = [top_energy_consumer_elem["Id"], top_energy_consumer_elem["Name"],
top_energy_consumer_elem["Value"]]
top_energy_consumer_output_column_data.append(top_energy_consumer_data)
table = columnar(top_energy_consumer_output_column_data, output_column_headers, no_borders=True)
print("\n =====================================================")
print(" Power Manager - Top energy consuming %s " % (entity))
print(" =====================================================")
print(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")
parser.add_argument("--username", "-u", required=False, help="Username for OpenManage Enterprise ", default="admin")
parser.add_argument("--password", "-p", required=True, help="Password for OpenManage Enterprise ")
args = parser.parse_args()
get_inputs = 'Y'
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.")
# Until user says NO to get top energy consumers
while get_inputs in ('Y', 'y', ''):
# Get the top energy consumers choice
entity_inputs = input("Enter the choice of Top Energy Consumer - 1 - Server / 2 - Chassis / 3 - Group : ")
if not entity_inputs.isdigit():
print("\n *** ERROR: Wrong Value Entered!!! Please enter proper value for Top Energy Consumer\n")
continue
else:
entity_inputs = top_energy_consumer_dictionary.get(int(entity_inputs))
if entity_inputs == None:
print("\n *** ERROR: Wrong Value Entered!!! Please enter proper value for Top Energy Consumer\n")
continue
print("Supported durations: \n ")
for key, value in duration_dictionary.items():
print(" ", key, ' : ', value)
# Get the input from user for duration value
duration_inputs = input("\nPlease enter duration value : ")
if not duration_inputs.isdigit():
print("\n *** ERROR: Wrong Value Entered!!! Please enter proper value for Top Energy Consumer\n")
continue
else:
dict_data_duration_inputs = duration_dictionary.get(int(duration_inputs))
if dict_data_duration_inputs == None:
print("\n *** ERROR: Wrong Value Entered!!! Please enter proper value for Top Energy Consumer\n")
continue
get_power_manager_top_energy_consumers(args.ip, args.username, args.password, entity_inputs,
int(duration_inputs))
get_inputs = input("\nDo you want to continue getting other top energy consumer (Y/N) : ")
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.")