blob: 1318d5d10baec92619506c59210fec2d0bc268c6 [file] [log] [blame]
Justin Thalerb8807ce2018-05-25 19:16:20 -05001#!/usr/bin/python3
Justin Thalere412dc22018-01-12 16:28:24 -06002"""
3 Copyright 2017 IBM Corporation
Justin Thalerf9aee3e2017-12-05 12:11:09 -06004
Justin Thalere412dc22018-01-12 16:28:24 -06005 Licensed under the Apache License, Version 2.0 (the "License");
6 you may not use this file except in compliance with the License.
7 You may obtain a copy of the License at
8
9 http://www.apache.org/licenses/LICENSE-2.0
10
11 Unless required by applicable law or agreed to in writing, software
12 distributed under the License is distributed on an "AS IS" BASIS,
13 WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 See the License for the specific language governing permissions and
15 limitations under the License.
16"""
Justin Thalerf9aee3e2017-12-05 12:11:09 -060017import argparse
18import requests
19import getpass
20import json
21import os
22import urllib3
23import time, datetime
Justin Thalerf9aee3e2017-12-05 12:11:09 -060024import binascii
25import subprocess
26import platform
27import zipfile
Justin Thaler22b1bb52018-03-15 13:31:32 -050028import tarfile
29import tempfile
30import hashlib
Justin Thalera6b5df72018-07-16 11:10:07 -050031import re
Justin Thalerf9aee3e2017-12-05 12:11:09 -060032
Justin Thalerf9aee3e2017-12-05 12:11:09 -060033def hilight(textToColor, color, bold):
Justin Thalere412dc22018-01-12 16:28:24 -060034 """
35 Used to add highlights to various text for displaying in a terminal
36
37 @param textToColor: string, the text to be colored
38 @param color: string, used to color the text red or green
39 @param bold: boolean, used to bold the textToColor
40 @return: Buffered reader containing the modified string.
41 """
Justin Thalerf9aee3e2017-12-05 12:11:09 -060042 if(sys.platform.__contains__("win")):
43 if(color == "red"):
44 os.system('color 04')
45 elif(color == "green"):
46 os.system('color 02')
47 else:
48 os.system('color') #reset to default
49 return textToColor
50 else:
51 attr = []
52 if(color == "red"):
53 attr.append('31')
54 elif(color == "green"):
55 attr.append('32')
56 else:
57 attr.append('0')
58 if bold:
59 attr.append('1')
60 else:
61 attr.append('0')
62 return '\x1b[%sm%s\x1b[0m' % (';'.join(attr),textToColor)
63
Justin Thalere412dc22018-01-12 16:28:24 -060064
Justin Thalerf9aee3e2017-12-05 12:11:09 -060065def connectionErrHandler(jsonFormat, errorStr, err):
Justin Thalere412dc22018-01-12 16:28:24 -060066 """
67 Error handler various connection errors to bmcs
68
69 @param jsonFormat: boolean, used to output in json format with an error code.
70 @param errorStr: string, used to color the text red or green
71 @param err: string, the text from the exception
72 """
Justin Thalerf9aee3e2017-12-05 12:11:09 -060073 if errorStr == "Timeout":
74 if not jsonFormat:
75 return("FQPSPIN0000M: Connection timed out. Ensure you have network connectivity to the bmc")
76 else:
Justin Thaler115bca72018-05-25 19:29:08 -050077 conerror = {}
78 conerror['CommonEventID'] = 'FQPSPIN0000M'
79 conerror['sensor']="N/A"
80 conerror['state']="N/A"
81 conerror['additionalDetails'] = "N/A"
82 conerror['Message']="Connection timed out. Ensure you have network connectivity to the BMC"
83 conerror['LengthyDescription'] = "While trying to establish a connection with the specified BMC, the BMC failed to respond in adequate time. Verify the BMC is functioning properly, and the network connectivity to the BMC is stable."
84 conerror['Serviceable']="Yes"
85 conerror['CallHomeCandidate']= "No"
86 conerror['Severity'] = "Critical"
87 conerror['EventType'] = "Communication Failure/Timeout"
88 conerror['VMMigrationFlag'] = "Yes"
89 conerror["AffectedSubsystem"] = "Interconnect (Networking)"
90 conerror["timestamp"] = str(int(time.time()))
91 conerror["UserAction"] = "Verify network connectivity between the two systems and the bmc is functional."
92 eventdict = {}
93 eventdict['event0'] = conerror
94 eventdict['numAlerts'] = '1'
95
96 errorMessageStr = errorMessageStr = json.dumps(eventdict, sort_keys=True, indent=4, separators=(',', ': '), ensure_ascii=False)
Justin Thalerf9aee3e2017-12-05 12:11:09 -060097 return(errorMessageStr)
98 elif errorStr == "ConnectionError":
99 if not jsonFormat:
100 return("FQPSPIN0001M: " + str(err))
101 else:
Justin Thaler115bca72018-05-25 19:29:08 -0500102 conerror = {}
103 conerror['CommonEventID'] = 'FQPSPIN0001M'
104 conerror['sensor']="N/A"
105 conerror['state']="N/A"
106 conerror['additionalDetails'] = str(err)
107 conerror['Message']="Connection Error. View additional details for more information"
108 conerror['LengthyDescription'] = "A connection error to the specified BMC occurred and additional details are provided. Review these details to resolve the issue."
109 conerror['Serviceable']="Yes"
110 conerror['CallHomeCandidate']= "No"
111 conerror['Severity'] = "Critical"
112 conerror['EventType'] = "Communication Failure/Timeout"
113 conerror['VMMigrationFlag'] = "Yes"
114 conerror["AffectedSubsystem"] = "Interconnect (Networking)"
115 conerror["timestamp"] = str(int(time.time()))
116 conerror["UserAction"] = "Correct the issue highlighted in additional details and try again"
117 eventdict = {}
118 eventdict['event0'] = conerror
119 eventdict['numAlerts'] = '1'
120
121 errorMessageStr = json.dumps(eventdict, sort_keys=True, indent=4, separators=(',', ': '), ensure_ascii=False)
Justin Thalerf9aee3e2017-12-05 12:11:09 -0600122 return(errorMessageStr)
Justin Thaler115bca72018-05-25 19:29:08 -0500123
Justin Thalerf9aee3e2017-12-05 12:11:09 -0600124 else:
125 return("Unknown Error: "+ str(err))
126
Justin Thalere412dc22018-01-12 16:28:24 -0600127
Justin Thalerf9aee3e2017-12-05 12:11:09 -0600128def setColWidth(keylist, numCols, dictForOutput, colNames):
Justin Thalere412dc22018-01-12 16:28:24 -0600129 """
130 Sets the output width of the columns to display
131
132 @param keylist: list, list of strings representing the keys for the dictForOutput
133 @param numcols: the total number of columns in the final output
134 @param dictForOutput: dictionary, contains the information to print to the screen
135 @param colNames: list, The strings to use for the column headings, in order of the keylist
136 @return: A list of the column widths for each respective column.
137 """
Justin Thalerf9aee3e2017-12-05 12:11:09 -0600138 colWidths = []
139 for x in range(0, numCols):
140 colWidths.append(0)
141 for key in dictForOutput:
142 for x in range(0, numCols):
143 colWidths[x] = max(colWidths[x], len(str(dictForOutput[key][keylist[x]])))
144
145 for x in range(0, numCols):
146 colWidths[x] = max(colWidths[x], len(colNames[x])) +2
147
148 return colWidths
149
150def loadPolicyTable(pathToPolicyTable):
Justin Thalere412dc22018-01-12 16:28:24 -0600151 """
152 loads a json based policy table into a dictionary
153
154 @param value: boolean, the value to convert
155 @return: A string of "Yes" or "No"
156 """
Justin Thalerf9aee3e2017-12-05 12:11:09 -0600157 policyTable = {}
158 if(os.path.exists(pathToPolicyTable)):
159 with open(pathToPolicyTable, 'r') as stream:
160 try:
Justin Thalerf9aee3e2017-12-05 12:11:09 -0600161 contents =json.load(stream)
162 policyTable = contents['events']
Justin Thalere412dc22018-01-12 16:28:24 -0600163 except Exception as err:
Justin Thalerf9aee3e2017-12-05 12:11:09 -0600164 print(err)
165 return policyTable
166
Justin Thalere412dc22018-01-12 16:28:24 -0600167
168def boolToString(value):
169 """
170 converts a boolean value to a human readable string value
171
172 @param value: boolean, the value to convert
173 @return: A string of "Yes" or "No"
174 """
175 if(value):
176 return "Yes"
177 else:
178 return "No"
179
Justin Thalera6b5df72018-07-16 11:10:07 -0500180def stringToInt(text):
181 """
182 returns an integer if the string can be converted, otherwise returns the string
183
184 @param text: the string to try to convert to an integer
185 """
186 if text.isdigit():
187 return int(text)
188 else:
189 return text
Justin Thalere412dc22018-01-12 16:28:24 -0600190
Justin Thalera6b5df72018-07-16 11:10:07 -0500191def naturalSort(text):
192 """
193 provides a way to naturally sort a list
194
195 @param text: the key to convert for sorting
196 @return list containing the broken up string parts by integers and strings
197 """
198 stringPartList = []
199 for c in re.split('(\d+)', text):
200 stringPartList.append(stringToInt(c))
201 return stringPartList
202
Justin Thalere412dc22018-01-12 16:28:24 -0600203def tableDisplay(keylist, colNames, output):
204 """
205 Logs into the BMC and creates a session
206
207 @param keylist: list, keys for the output dictionary, ordered by colNames
208 @param colNames: Names for the Table of the columns
209 @param output: The dictionary of data to display
210 @return: Session object
211 """
212 colWidth = setColWidth(keylist, len(colNames), output, colNames)
213 row = ""
214 outputText = ""
215 for i in range(len(colNames)):
216 if (i != 0): row = row + "| "
217 row = row + colNames[i].ljust(colWidth[i])
218 outputText += row + "\n"
Justin Thalera6b5df72018-07-16 11:10:07 -0500219
220 output_keys = list(output.keys())
221 output_keys.sort(key=naturalSort)
222 for key in output_keys:
Justin Thalere412dc22018-01-12 16:28:24 -0600223 row = ""
Justin Thaler8fe0c732018-07-24 14:32:35 -0500224 for i in range(len(keylist)):
Justin Thalere412dc22018-01-12 16:28:24 -0600225 if (i != 0): row = row + "| "
226 row = row + output[key][keylist[i]].ljust(colWidth[i])
227 outputText += row + "\n"
228
229 return outputText
230
Justin Thaler22b1bb52018-03-15 13:31:32 -0500231def checkFWactivation(host, args, session):
232 """
233 Checks the software inventory for an image that is being activated.
234
235 @return: True if an image is being activated, false is no activations are happening
236 """
237 url="https://"+host+"/xyz/openbmc_project/software/enumerate"
238 httpHeader = {'Content-Type':'application/json'}
239 try:
240 resp = session.get(url, headers=httpHeader, verify=False, timeout=30)
241 except(requests.exceptions.Timeout):
242 print(connectionErrHandler(args.json, "Timeout", None))
243 return(True)
244 except(requests.exceptions.ConnectionError) as err:
245 print( connectionErrHandler(args.json, "ConnectionError", err))
246 return True
247 fwInfo = json.loads(resp.text)['data']
248 for key in fwInfo:
249 if 'Activation' in fwInfo[key]:
250 if 'Activating' in fwInfo[key]['Activation'] or 'Activating' in fwInfo[key]['RequestedActivation']:
251 return True
252 return False
253
Justin Thalerf9aee3e2017-12-05 12:11:09 -0600254def login(host, username, pw,jsonFormat):
Justin Thalere412dc22018-01-12 16:28:24 -0600255 """
256 Logs into the BMC and creates a session
257
258 @param host: string, the hostname or IP address of the bmc to log into
259 @param username: The user name for the bmc to log into
260 @param pw: The password for the BMC to log into
261 @param jsonFormat: boolean, flag that will only allow relevant data from user command to be display. This function becomes silent when set to true.
262 @return: Session object
263 """
Justin Thalerf9aee3e2017-12-05 12:11:09 -0600264 if(jsonFormat==False):
265 print("Attempting login...")
266 httpHeader = {'Content-Type':'application/json'}
267 mysess = requests.session()
268 try:
269 r = mysess.post('https://'+host+'/login', headers=httpHeader, json = {"data": [username, pw]}, verify=False, timeout=30)
270 loginMessage = json.loads(r.text)
271 if (loginMessage['status'] != "ok"):
272 print(loginMessage["data"]["description"].encode('utf-8'))
273 sys.exit(1)
274# if(sys.version_info < (3,0)):
275# urllib3.disable_warnings(urllib3.exceptions.InsecureRequestWarning)
276# if sys.version_info >= (3,0):
277# requests.packages.urllib3.disable_warnings(requests.packages.urllib3.exceptions.InsecureRequestWarning)
278 return mysess
279 except(requests.exceptions.Timeout):
Justin Thaler115bca72018-05-25 19:29:08 -0500280 return (connectionErrHandler(jsonFormat, "Timeout", None))
Justin Thalerf9aee3e2017-12-05 12:11:09 -0600281 except(requests.exceptions.ConnectionError) as err:
Justin Thaler115bca72018-05-25 19:29:08 -0500282 return (connectionErrHandler(jsonFormat, "ConnectionError", err))
Justin Thalerf9aee3e2017-12-05 12:11:09 -0600283
Justin Thalere412dc22018-01-12 16:28:24 -0600284
Justin Thalerf9aee3e2017-12-05 12:11:09 -0600285def logout(host, username, pw, session, jsonFormat):
Justin Thalere412dc22018-01-12 16:28:24 -0600286 """
287 Logs out of the bmc and terminates the session
288
289 @param host: string, the hostname or IP address of the bmc to log out of
290 @param username: The user name for the bmc to log out of
291 @param pw: The password for the BMC to log out of
292 @param session: the active session to use
293 @param jsonFormat: boolean, flag that will only allow relevant data from user command to be display. This function becomes silent when set to true.
294 """
Justin Thalerf9aee3e2017-12-05 12:11:09 -0600295 httpHeader = {'Content-Type':'application/json'}
Justin Thalere412dc22018-01-12 16:28:24 -0600296 try:
297 r = session.post('https://'+host+'/logout', headers=httpHeader,json = {"data": [username, pw]}, verify=False, timeout=10)
298 except(requests.exceptions.Timeout):
299 print(connectionErrHandler(jsonFormat, "Timeout", None))
300
Justin Thalerf9aee3e2017-12-05 12:11:09 -0600301 if(jsonFormat==False):
302 if('"message": "200 OK"' in r.text):
303 print('User ' +username + ' has been logged out')
304
Justin Thalere412dc22018-01-12 16:28:24 -0600305
Justin Thalerf9aee3e2017-12-05 12:11:09 -0600306def fru(host, args, session):
Justin Thalere412dc22018-01-12 16:28:24 -0600307 """
308 prints out the system inventory. deprecated see fruPrint and fruList
309
310 @param host: string, the hostname or IP address of the bmc
311 @param args: contains additional arguments used by the fru sub command
312 @param session: the active session to use
313 @param args.json: boolean, if this flag is set to true, the output will be provided in json format for programmatic consumption
314 """
Justin Thalerf9aee3e2017-12-05 12:11:09 -0600315 #url="https://"+host+"/org/openbmc/inventory/system/chassis/enumerate"
316
317 #print(url)
318 #res = session.get(url, headers=httpHeader, verify=False)
319 #print(res.text)
320 #sample = res.text
321
322 #inv_list = json.loads(sample)["data"]
323
324 url="https://"+host+"/xyz/openbmc_project/inventory/enumerate"
325 httpHeader = {'Content-Type':'application/json'}
Justin Thalere412dc22018-01-12 16:28:24 -0600326 try:
327 res = session.get(url, headers=httpHeader, verify=False, timeout=40)
328 except(requests.exceptions.Timeout):
329 return(connectionErrHandler(args.json, "Timeout", None))
330
Justin Thalerf9aee3e2017-12-05 12:11:09 -0600331 sample = res.text
332# inv_list.update(json.loads(sample)["data"])
333#
334# #determine column width's
335# colNames = ["FRU Name", "FRU Type", "Has Fault", "Is FRU", "Present", "Version"]
336# colWidths = setColWidth(["FRU Name", "fru_type", "fault", "is_fru", "present", "version"], 6, inv_list, colNames)
337#
338# print("FRU Name".ljust(colWidths[0])+ "FRU Type".ljust(colWidths[1]) + "Has Fault".ljust(colWidths[2]) + "Is FRU".ljust(colWidths[3])+
339# "Present".ljust(colWidths[4]) + "Version".ljust(colWidths[5]))
340# format the output
341# for key in sorted(inv_list.keys()):
342# keyParts = key.split("/")
343# isFRU = "True" if (inv_list[key]["is_fru"]==1) else "False"
344#
345# fruEntry = (keyParts[len(keyParts) - 1].ljust(colWidths[0]) + inv_list[key]["fru_type"].ljust(colWidths[1])+
346# inv_list[key]["fault"].ljust(colWidths[2])+isFRU.ljust(colWidths[3])+
347# inv_list[key]["present"].ljust(colWidths[4])+ inv_list[key]["version"].ljust(colWidths[5]))
348# if(isTTY):
349# if(inv_list[key]["is_fru"] == 1):
350# color = "green"
351# bold = True
352# else:
353# color='black'
354# bold = False
355# fruEntry = hilight(fruEntry, color, bold)
356# print (fruEntry)
357 return sample
Justin Thalere412dc22018-01-12 16:28:24 -0600358
359def fruPrint(host, args, session):
360 """
361 prints out all inventory
362
363 @param host: string, the hostname or IP address of the bmc
364 @param args: contains additional arguments used by the fru sub command
365 @param session: the active session to use
366 @param args.json: boolean, if this flag is set to true, the output will be provided in json format for programmatic consumption
367 @return returns the total fru list.
368 """
Justin Thalerf9aee3e2017-12-05 12:11:09 -0600369 url="https://"+host+"/xyz/openbmc_project/inventory/enumerate"
370 httpHeader = {'Content-Type':'application/json'}
Justin Thalere412dc22018-01-12 16:28:24 -0600371 try:
372 res = session.get(url, headers=httpHeader, verify=False, timeout=40)
373 except(requests.exceptions.Timeout):
374 return(connectionErrHandler(args.json, "Timeout", None))
375
376
Justin Thalerf9aee3e2017-12-05 12:11:09 -0600377# print(res.text)
378 frulist = res.text
379 url="https://"+host+"/xyz/openbmc_project/software/enumerate"
Justin Thalere412dc22018-01-12 16:28:24 -0600380 try:
381 res = session.get(url, headers=httpHeader, verify=False, timeout=40)
382 except(requests.exceptions.Timeout):
383 return(connectionErrHandler(args.json, "Timeout", None))
Justin Thalerf9aee3e2017-12-05 12:11:09 -0600384# print(res.text)
385 frulist = frulist +"\n" + res.text
386
387 return frulist
388
Justin Thalere412dc22018-01-12 16:28:24 -0600389
Justin Thalerf9aee3e2017-12-05 12:11:09 -0600390def fruList(host, args, session):
Justin Thalere412dc22018-01-12 16:28:24 -0600391 """
392 prints out all inventory or only a specific specified item
393
394 @param host: string, the hostname or IP address of the bmc
395 @param args: contains additional arguments used by the fru sub command
396 @param session: the active session to use
397 @param args.json: boolean, if this flag is set to true, the output will be provided in json format for programmatic consumption
398 """
Justin Thalerf9aee3e2017-12-05 12:11:09 -0600399 if(args.items==True):
400 return fruPrint(host, args, session)
401 else:
Justin Thalere412dc22018-01-12 16:28:24 -0600402 return fruPrint(host, args, session)
Justin Thalerf9aee3e2017-12-05 12:11:09 -0600403
404
Justin Thalerf9aee3e2017-12-05 12:11:09 -0600405
Justin Thalerf9aee3e2017-12-05 12:11:09 -0600406def fruStatus(host, args, session):
Justin Thalere412dc22018-01-12 16:28:24 -0600407 """
408 prints out the status of all FRUs
409
410 @param host: string, the hostname or IP address of the bmc
411 @param args: contains additional arguments used by the fru sub command
412 @param session: the active session to use
413 @param args.json: boolean, if this flag is set to true, the output will be provided in json format for programmatic consumption
414 """
415 url="https://"+host+"/xyz/openbmc_project/inventory/enumerate"
Justin Thalerf9aee3e2017-12-05 12:11:09 -0600416 httpHeader = {'Content-Type':'application/json'}
Justin Thalere412dc22018-01-12 16:28:24 -0600417 try:
418 res = session.get(url, headers=httpHeader, verify=False)
419 except(requests.exceptions.Timeout):
420 return(connectionErrHandler(args.json, "Timeout", None))
Justin Thalerf9aee3e2017-12-05 12:11:09 -0600421# print(res.text)
Justin Thalere412dc22018-01-12 16:28:24 -0600422 frulist = json.loads(res.text)['data']
423 frus = {}
424 for key in frulist:
425 component = frulist[key]
426 isFru = False
427 present = False
428 func = False
429 hasSels = False
430 keyPieces = key.split('/')
431 fruName = keyPieces[-1]
432 if 'core' in fruName: #associate cores to cpus
433 fruName = keyPieces[-2] + '-' + keyPieces[-1]
434 if 'Functional' in component:
435 if('Present' in component):
436
437 if 'FieldReplaceable' in component:
438 if component['FieldReplaceable'] == 1:
439 isFru = True
440 if "fan" in fruName:
441 isFru = True;
442 if component['Present'] == 1:
443 present = True
444 if component['Functional'] == 1:
445 func = True
446 if ((key + "/fault") in frulist):
447 hasSels = True;
448 if args.verbose:
449 if hasSels:
450 loglist = []
451 faults = frulist[key+"/fault"]['endpoints']
452 for item in faults:
453 loglist.append(item.split('/')[-1])
454 frus[fruName] = {"compName": fruName, "Functional": boolToString(func), "Present":boolToString(present), "IsFru": boolToString(isFru), "selList": ', '.join(loglist).strip() }
455 else:
456 frus[fruName] = {"compName": fruName, "Functional": boolToString(func), "Present":boolToString(present), "IsFru": boolToString(isFru), "selList": "None" }
457 else:
458 frus[fruName] = {"compName": fruName, "Functional": boolToString(func), "Present":boolToString(present), "IsFru": boolToString(isFru), "hasSEL": boolToString(hasSels) }
Justin Thalerfb9c81c2018-07-16 11:14:37 -0500459 elif "power_supply" in fruName or "powersupply" in fruName:
Justin Thalere412dc22018-01-12 16:28:24 -0600460 if component['Present'] ==1:
461 present = True
462 isFru = True
463 if ((key + "/fault") in frulist):
464 hasSels = True;
465 if args.verbose:
466 if hasSels:
467 loglist = []
468 faults = frulist[key+"/fault"]['endpoints']
469 for key in faults:
470 loglist.append(faults[key].split('/')[-1])
471 frus[fruName] = {"compName": fruName, "Functional": "No", "Present":boolToString(present), "IsFru": boolToString(isFru), "selList": ', '.join(loglist).strip() }
472 else:
473 frus[fruName] = {"compName": fruName, "Functional": "Yes", "Present":boolToString(present), "IsFru": boolToString(isFru), "selList": "None" }
474 else:
475 frus[fruName] = {"compName": fruName, "Functional": boolToString(not hasSels), "Present":boolToString(present), "IsFru": boolToString(isFru), "hasSEL": boolToString(hasSels) }
476 if not args.json:
477 if not args.verbose:
478 colNames = ["Component", "Is a FRU", "Present", "Functional", "Has Logs"]
479 keylist = ["compName", "IsFru", "Present", "Functional", "hasSEL"]
480 else:
481 colNames = ["Component", "Is a FRU", "Present", "Functional", "Assoc. Log Number(s)"]
482 keylist = ["compName", "IsFru", "Present", "Functional", "selList"]
483 return tableDisplay(keylist, colNames, frus)
484 else:
485 return str(json.dumps(frus, sort_keys=True, indent=4, separators=(',', ': '), ensure_ascii=False))
486
487def sensor(host, args, session):
488 """
489 prints out all sensors
490
491 @param host: string, the hostname or IP address of the bmc
492 @param args: contains additional arguments used by the sensor sub command
493 @param session: the active session to use
494 @param args.json: boolean, if this flag is set to true, the output will be provided in json format for programmatic consumption
495 """
496 httpHeader = {'Content-Type':'application/json'}
Justin Thalerf9aee3e2017-12-05 12:11:09 -0600497 url="https://"+host+"/xyz/openbmc_project/sensors/enumerate"
Justin Thalere412dc22018-01-12 16:28:24 -0600498 try:
499 res = session.get(url, headers=httpHeader, verify=False, timeout=30)
500 except(requests.exceptions.Timeout):
501 return(connectionErrHandler(args.json, "Timeout", None))
Justin Thalerf9aee3e2017-12-05 12:11:09 -0600502
503 #Get OCC status
504 url="https://"+host+"/org/open_power/control/enumerate"
Justin Thalere412dc22018-01-12 16:28:24 -0600505 try:
506 occres = session.get(url, headers=httpHeader, verify=False, timeout=30)
507 except(requests.exceptions.Timeout):
508 return(connectionErrHandler(args.json, "Timeout", None))
Justin Thalerf9aee3e2017-12-05 12:11:09 -0600509 if not args.json:
510 colNames = ['sensor', 'type', 'units', 'value', 'target']
511 sensors = json.loads(res.text)["data"]
512 output = {}
513 for key in sensors:
514 senDict = {}
515 keyparts = key.split("/")
516 senDict['sensorName'] = keyparts[-1]
517 senDict['type'] = keyparts[-2]
Justin Thalere412dc22018-01-12 16:28:24 -0600518 try:
519 senDict['units'] = sensors[key]['Unit'].split('.')[-1]
520 except KeyError:
Justin Thaler22b1bb52018-03-15 13:31:32 -0500521 senDict['units'] = "N/A"
Justin Thalerf9aee3e2017-12-05 12:11:09 -0600522 if('Scale' in sensors[key]):
523 scale = 10 ** sensors[key]['Scale']
524 else:
525 scale = 1
Justin Thaler22b1bb52018-03-15 13:31:32 -0500526 try:
527 senDict['value'] = str(sensors[key]['Value'] * scale)
528 except KeyError:
529 if 'value' in sensors[key]:
530 senDict['value'] = sensors[key]['value']
531 else:
532 senDict['value'] = "N/A"
Justin Thalerf9aee3e2017-12-05 12:11:09 -0600533 if 'Target' in sensors[key]:
534 senDict['target'] = str(sensors[key]['Target'])
535 else:
536 senDict['target'] = 'N/A'
537 output[senDict['sensorName']] = senDict
538
539 occstatus = json.loads(occres.text)["data"]
540 if '/org/open_power/control/occ0' in occstatus:
541 occ0 = occstatus["/org/open_power/control/occ0"]['OccActive']
542 if occ0 == 1:
543 occ0 = 'Active'
544 else:
545 occ0 = 'Inactive'
546 output['OCC0'] = {'sensorName':'OCC0', 'type': 'Discrete', 'units': 'N/A', 'value': occ0, 'target': 'Active'}
547 occ1 = occstatus["/org/open_power/control/occ1"]['OccActive']
548 if occ1 == 1:
549 occ1 = 'Active'
550 else:
551 occ1 = 'Inactive'
552 output['OCC1'] = {'sensorName':'OCC1', 'type': 'Discrete', 'units': 'N/A', 'value': occ0, 'target': 'Active'}
553 else:
554 output['OCC0'] = {'sensorName':'OCC0', 'type': 'Discrete', 'units': 'N/A', 'value': 'Inactive', 'target': 'Inactive'}
555 output['OCC1'] = {'sensorName':'OCC1', 'type': 'Discrete', 'units': 'N/A', 'value': 'Inactive', 'target': 'Inactive'}
556 keylist = ['sensorName', 'type', 'units', 'value', 'target']
Justin Thalere412dc22018-01-12 16:28:24 -0600557
558 return tableDisplay(keylist, colNames, output)
Justin Thalerf9aee3e2017-12-05 12:11:09 -0600559 else:
560 return res.text + occres.text
Justin Thalere412dc22018-01-12 16:28:24 -0600561
Justin Thalerf9aee3e2017-12-05 12:11:09 -0600562def sel(host, args, session):
Justin Thalere412dc22018-01-12 16:28:24 -0600563 """
564 prints out the bmc alerts
565
566 @param host: string, the hostname or IP address of the bmc
567 @param args: contains additional arguments used by the sel sub command
568 @param session: the active session to use
569 @param args.json: boolean, if this flag is set to true, the output will be provided in json format for programmatic consumption
570 """
Justin Thalerf9aee3e2017-12-05 12:11:09 -0600571
572 url="https://"+host+"/xyz/openbmc_project/logging/entry/enumerate"
573 httpHeader = {'Content-Type':'application/json'}
Justin Thalere412dc22018-01-12 16:28:24 -0600574 try:
575 res = session.get(url, headers=httpHeader, verify=False, timeout=60)
576 except(requests.exceptions.Timeout):
577 return(connectionErrHandler(args.json, "Timeout", None))
Justin Thalerf9aee3e2017-12-05 12:11:09 -0600578 return res.text
Justin Thalere412dc22018-01-12 16:28:24 -0600579
580
Justin Thalerf9aee3e2017-12-05 12:11:09 -0600581def parseESEL(args, eselRAW):
Justin Thalere412dc22018-01-12 16:28:24 -0600582 """
583 parses the esel data and gets predetermined search terms
584
585 @param eselRAW: string, the raw esel string from the bmc
586 @return: A dictionary containing the quick snapshot data unless args.fullEsel is listed then a full PEL log is returned
587 """
Justin Thalerf9aee3e2017-12-05 12:11:09 -0600588 eselParts = {}
589 esel_bin = binascii.unhexlify(''.join(eselRAW.split()[16:]))
590 #search terms contains the search term as the key and the return dictionary key as it's value
591 searchTerms = { 'Signature Description':'signatureDescription', 'devdesc':'devdesc',
Justin Thaler22b1bb52018-03-15 13:31:32 -0500592 'Callout type': 'calloutType', 'Procedure':'procedure', 'Sensor Type': 'sensorType'}
Justin Thalercf1deae2018-05-25 19:35:21 -0500593 eselBinPath = tempfile.gettempdir() + os.sep + 'esel.bin'
594 with open(eselBinPath, 'wb') as f:
Justin Thalerf9aee3e2017-12-05 12:11:09 -0600595 f.write(esel_bin)
596 errlPath = ""
597 #use the right errl file for the machine architecture
598 arch = platform.machine()
599 if(arch =='x86_64' or arch =='AMD64'):
600 if os.path.exists('/opt/ibm/ras/bin/x86_64/errl'):
601 errlPath = '/opt/ibm/ras/bin/x86_64/errl'
602 elif os.path.exists('errl/x86_64/errl'):
603 errlPath = 'errl/x86_64/errl'
604 else:
605 errlPath = 'x86_64/errl'
606 elif (platform.machine()=='ppc64le'):
607 if os.path.exists('/opt/ibm/ras/bin/ppc64le/errl'):
608 errlPath = '/opt/ibm/ras/bin/ppc64le/errl'
609 elif os.path.exists('errl/ppc64le/errl'):
610 errlPath = 'errl/ppc64le/errl'
611 else:
612 errlPath = 'ppc64le/errl'
613 else:
614 print("machine architecture not supported for parsing eSELs")
615 return eselParts
616
Justin Thalerf9aee3e2017-12-05 12:11:09 -0600617 if(os.path.exists(errlPath)):
Justin Thalercf1deae2018-05-25 19:35:21 -0500618 output= subprocess.check_output([errlPath, '-d', '--file='+eselBinPath]).decode('utf-8')
Justin Thalerf9aee3e2017-12-05 12:11:09 -0600619# output = proc.communicate()[0]
620 lines = output.split('\n')
621
622 if(hasattr(args, 'fullEsel')):
623 return output
624
625 for i in range(0, len(lines)):
626 lineParts = lines[i].split(':')
627 if(len(lineParts)>1): #ignore multi lines, output formatting lines, and other information
628 for term in searchTerms:
629 if(term in lineParts[0]):
630 temp = lines[i][lines[i].find(':')+1:].strip()[:-1].strip()
631 if lines[i+1].find(':') != -1:
632 if (len(lines[i+1].split(':')[0][1:].strip())==0):
633 while(len(lines[i][:lines[i].find(':')].strip())>2):
634 if((i+1) <= len(lines)):
635 i+=1
636 else:
637 i=i-1
638 break
639 temp = temp + lines[i][lines[i].find(':'):].strip()[:-1].strip()[:-1].strip()
Justin Thaler22b1bb52018-03-15 13:31:32 -0500640 if(searchTerms[term] in eselParts):
641 eselParts[searchTerms[term]] = eselParts[searchTerms[term]] + ", " + temp
642 else:
643 eselParts[searchTerms[term]] = temp
Justin Thalercf1deae2018-05-25 19:35:21 -0500644 os.remove(eselBinPath)
Justin Thalerf9aee3e2017-12-05 12:11:09 -0600645 else:
646 print("errl file cannot be found")
647
648 return eselParts
649
Justin Thalere412dc22018-01-12 16:28:24 -0600650
Matt Spinler02d0dff2018-08-29 13:19:25 -0500651def getESELSeverity(esel):
652 """
653 Finds the severity type in an eSEL from the User Header section.
654 @param esel - the eSEL data
655 @return severity - e.g. 'Critical'
656 """
657
658 # everything but 1 and 2 are Critical
659 # '1': 'recovered',
660 # '2': 'predictive',
661 # '4': 'unrecoverable',
662 # '5': 'critical',
663 # '6': 'diagnostic',
664 # '7': 'symptom'
665 severities = {
666 '1': 'Informational',
667 '2': 'Warning'
668 }
669
670 try:
671 headerPosition = esel.index('55 48') # 'UH'
672 # The severity is the last byte in the 8 byte section (a byte is ' bb')
673 severity = esel[headerPosition:headerPosition+32].split(' ')[-1]
674 type = severity[0]
675 except ValueError:
676 print("Could not find severity value in UH section in eSEL")
677 type = 'x';
678
679 return severities.get(type, 'Critical')
680
681
Justin Thalerf9aee3e2017-12-05 12:11:09 -0600682def sortSELs(events):
Justin Thalere412dc22018-01-12 16:28:24 -0600683 """
684 sorts the sels by timestamp, then log entry number
685
686 @param events: Dictionary containing events
687 @return: list containing a list of the ordered log entries, and dictionary of keys
688 """
Justin Thalerf9aee3e2017-12-05 12:11:09 -0600689 logNumList = []
690 timestampList = []
691 eventKeyDict = {}
692 eventsWithTimestamp = {}
693 logNum2events = {}
694 for key in events:
695 if key == 'numAlerts': continue
696 if 'callout' in key: continue
697 timestamp = (events[key]['timestamp'])
698 if timestamp not in timestampList:
699 eventsWithTimestamp[timestamp] = [events[key]['logNum']]
700 else:
701 eventsWithTimestamp[timestamp].append(events[key]['logNum'])
702 #map logNumbers to the event dictionary keys
703 eventKeyDict[str(events[key]['logNum'])] = key
704
705 timestampList = list(eventsWithTimestamp.keys())
706 timestampList.sort()
707 for ts in timestampList:
708 if len(eventsWithTimestamp[ts]) > 1:
709 tmplist = eventsWithTimestamp[ts]
710 tmplist.sort()
711 logNumList = logNumList + tmplist
712 else:
713 logNumList = logNumList + eventsWithTimestamp[ts]
714
715 return [logNumList, eventKeyDict]
716
Justin Thalere412dc22018-01-12 16:28:24 -0600717
Justin Thalerf9aee3e2017-12-05 12:11:09 -0600718def parseAlerts(policyTable, selEntries, args):
Justin Thalere412dc22018-01-12 16:28:24 -0600719 """
720 parses alerts in the IBM CER format, using an IBM policy Table
721
722 @param policyTable: dictionary, the policy table entries
723 @param selEntries: dictionary, the alerts retrieved from the bmc
724 @return: A dictionary of the parsed entries, in chronological order
725 """
Justin Thalerf9aee3e2017-12-05 12:11:09 -0600726 eventDict = {}
727 eventNum =""
728 count = 0
729 esel = ""
730 eselParts = {}
731 i2cdevice= ""
Matt Spinler02d0dff2018-08-29 13:19:25 -0500732 eselSeverity = None
Justin Thalerf9aee3e2017-12-05 12:11:09 -0600733
734 'prepare and sort the event entries'
735 for key in selEntries:
736 if 'callout' not in key:
737 selEntries[key]['logNum'] = key.split('/')[-1]
738 selEntries[key]['timestamp'] = selEntries[key]['Timestamp']
739 sortedEntries = sortSELs(selEntries)
740 logNumList = sortedEntries[0]
741 eventKeyDict = sortedEntries[1]
742
743 for logNum in logNumList:
744 key = eventKeyDict[logNum]
Justin Thalerf9aee3e2017-12-05 12:11:09 -0600745 hasEsel=False
746 i2creadFail = False
747 if 'callout' in key:
748 continue
749 else:
750 messageID = str(selEntries[key]['Message'])
751 addDataPiece = selEntries[key]['AdditionalData']
752 calloutIndex = 0
753 calloutFound = False
754 for i in range(len(addDataPiece)):
755 if("CALLOUT_INVENTORY_PATH" in addDataPiece[i]):
756 calloutIndex = i
757 calloutFound = True
758 fruCallout = str(addDataPiece[calloutIndex]).split('=')[1]
759 if("CALLOUT_DEVICE_PATH" in addDataPiece[i]):
760 i2creadFail = True
Matt Spinlerd178a472018-08-31 09:48:52 -0500761
762 fruCallout = str(addDataPiece[calloutIndex]).split('=')[1]
763
764 # Fall back to "I2C"/"FSI" if dev path isn't in policy table
765 if (messageID + '||' + fruCallout) not in policyTable:
766 i2cdevice = str(addDataPiece[i]).strip().split('=')[1]
767 i2cdevice = '/'.join(i2cdevice.split('/')[-4:])
768 if 'fsi' in str(addDataPiece[calloutIndex]).split('=')[1]:
769 fruCallout = 'FSI'
770 else:
771 fruCallout = 'I2C'
Justin Thalere34c43a2018-05-25 19:37:55 -0500772 calloutFound = True
773 if("CALLOUT_GPIO_NUM" in addDataPiece[i]):
774 if not calloutFound:
775 fruCallout = 'GPIO'
776 calloutFound = True
777 if("CALLOUT_IIC_BUS" in addDataPiece[i]):
778 if not calloutFound:
779 fruCallout = "I2C"
780 calloutFound = True
781 if("CALLOUT_IPMI_SENSOR_NUM" in addDataPiece[i]):
782 if not calloutFound:
783 fruCallout = "IPMI"
Justin Thalerf9aee3e2017-12-05 12:11:09 -0600784 calloutFound = True
785 if("ESEL" in addDataPiece[i]):
786 esel = str(addDataPiece[i]).strip().split('=')[1]
Matt Spinler02d0dff2018-08-29 13:19:25 -0500787 eselSeverity = getESELSeverity(esel)
Justin Thalerf9aee3e2017-12-05 12:11:09 -0600788 if args.devdebug:
789 eselParts = parseESEL(args, esel)
790 hasEsel=True
791 if("GPU" in addDataPiece[i]):
792 fruCallout = '/xyz/openbmc_project/inventory/system/chassis/motherboard/gpu' + str(addDataPiece[i]).strip()[-1]
793 calloutFound = True
794 if("PROCEDURE" in addDataPiece[i]):
795 fruCallout = str(hex(int(str(addDataPiece[i]).split('=')[1])))[2:]
796 calloutFound = True
Justin Thalere412dc22018-01-12 16:28:24 -0600797 if("RAIL_NAME" in addDataPiece[i]):
798 calloutFound=True
799 fruCallout = str(addDataPiece[i]).split('=')[1].strip()
800 if("INPUT_NAME" in addDataPiece[i]):
801 calloutFound=True
802 fruCallout = str(addDataPiece[i]).split('=')[1].strip()
803 if("SENSOR_TYPE" in addDataPiece[i]):
804 calloutFound=True
805 fruCallout = str(addDataPiece[i]).split('=')[1].strip()
Justin Thalerf9aee3e2017-12-05 12:11:09 -0600806
807 if(calloutFound):
Justin Thaler22b1bb52018-03-15 13:31:32 -0500808 if fruCallout != "":
809 policyKey = messageID +"||" + fruCallout
Matt Spinler02d0dff2018-08-29 13:19:25 -0500810
811 # Also use the severity for hostboot errors
812 if eselSeverity and messageID == 'org.open_power.Host.Error.Event':
813 policyKey += '||' + eselSeverity
814
815 # if not in the table, fall back to the original key
816 if policyKey not in policyTable:
817 policyKey = policyKey.replace('||'+eselSeverity, '')
818
Justin Thalere34c43a2018-05-25 19:37:55 -0500819 if policyKey not in policyTable:
820 policyKey = messageID
Justin Thaler22b1bb52018-03-15 13:31:32 -0500821 else:
822 policyKey = messageID
Justin Thalerf9aee3e2017-12-05 12:11:09 -0600823 else:
824 policyKey = messageID
825 event = {}
826 eventNum = str(count)
827 if policyKey in policyTable:
828 for pkey in policyTable[policyKey]:
829 if(type(policyTable[policyKey][pkey])== bool):
830 event[pkey] = boolToString(policyTable[policyKey][pkey])
831 else:
832 if (i2creadFail and pkey == 'Message'):
833 event[pkey] = policyTable[policyKey][pkey] + ' ' +i2cdevice
834 else:
835 event[pkey] = policyTable[policyKey][pkey]
836 event['timestamp'] = selEntries[key]['Timestamp']
837 event['resolved'] = bool(selEntries[key]['Resolved'])
838 if(hasEsel):
839 if args.devdebug:
840 event['eselParts'] = eselParts
841 event['raweSEL'] = esel
842 event['logNum'] = key.split('/')[-1]
843 eventDict['event' + eventNum] = event
844
845 else:
846 severity = str(selEntries[key]['Severity']).split('.')[-1]
847 if severity == 'Error':
848 severity = 'Critical'
849 eventDict['event'+eventNum] = {}
850 eventDict['event' + eventNum]['error'] = "error: Not found in policy table: " + policyKey
851 eventDict['event' + eventNum]['timestamp'] = selEntries[key]['Timestamp']
852 eventDict['event' + eventNum]['Severity'] = severity
853 if(hasEsel):
854 if args.devdebug:
855 eventDict['event' +eventNum]['eselParts'] = eselParts
856 eventDict['event' +eventNum]['raweSEL'] = esel
857 eventDict['event' +eventNum]['logNum'] = key.split('/')[-1]
858 eventDict['event' +eventNum]['resolved'] = bool(selEntries[key]['Resolved'])
Justin Thalerf9aee3e2017-12-05 12:11:09 -0600859 count += 1
860 return eventDict
861
862
Justin Thalerf9aee3e2017-12-05 12:11:09 -0600863def selDisplay(events, args):
Justin Thalere412dc22018-01-12 16:28:24 -0600864 """
865 displays alerts in human readable format
866
867 @param events: Dictionary containing events
868 @return:
869 """
Justin Thalerf9aee3e2017-12-05 12:11:09 -0600870 activeAlerts = []
871 historyAlerts = []
872 sortedEntries = sortSELs(events)
873 logNumList = sortedEntries[0]
874 eventKeyDict = sortedEntries[1]
875 keylist = ['Entry', 'ID', 'Timestamp', 'Serviceable', 'Severity','Message']
876 if(args.devdebug):
877 colNames = ['Entry', 'ID', 'Timestamp', 'Serviceable', 'Severity','Message', 'eSEL contents']
878 keylist.append('eSEL')
879 else:
880 colNames = ['Entry', 'ID', 'Timestamp', 'Serviceable', 'Severity', 'Message']
881 for log in logNumList:
882 selDict = {}
883 alert = events[eventKeyDict[str(log)]]
884 if('error' in alert):
885 selDict['Entry'] = alert['logNum']
886 selDict['ID'] = 'Unknown'
887 selDict['Timestamp'] = datetime.datetime.fromtimestamp(int(alert['timestamp']/1000)).strftime("%Y-%m-%d %H:%M:%S")
888 msg = alert['error']
889 polMsg = msg.split("policy table:")[0]
890 msg = msg.split("policy table:")[1]
891 msgPieces = msg.split("||")
892 err = msgPieces[0]
893 if(err.find("org.open_power.")!=-1):
894 err = err.split("org.open_power.")[1]
895 elif(err.find("xyz.openbmc_project.")!=-1):
896 err = err.split("xyz.openbmc_project.")[1]
897 else:
898 err = msgPieces[0]
899 callout = ""
900 if len(msgPieces) >1:
901 callout = msgPieces[1]
902 if(callout.find("/org/open_power/")!=-1):
903 callout = callout.split("/org/open_power/")[1]
904 elif(callout.find("/xyz/openbmc_project/")!=-1):
905 callout = callout.split("/xyz/openbmc_project/")[1]
906 else:
907 callout = msgPieces[1]
908 selDict['Message'] = polMsg +"policy table: "+ err + "||" + callout
909 selDict['Serviceable'] = 'Unknown'
910 selDict['Severity'] = alert['Severity']
911 else:
912 selDict['Entry'] = alert['logNum']
913 selDict['ID'] = alert['CommonEventID']
914 selDict['Timestamp'] = datetime.datetime.fromtimestamp(int(alert['timestamp']/1000)).strftime("%Y-%m-%d %H:%M:%S")
915 selDict['Message'] = alert['Message']
916 selDict['Serviceable'] = alert['Serviceable']
917 selDict['Severity'] = alert['Severity']
918
919
920 eselOrder = ['refCode','signatureDescription', 'eselType', 'devdesc', 'calloutType', 'procedure']
921 if ('eselParts' in alert and args.devdebug):
922 eselOutput = ""
923 for item in eselOrder:
924 if item in alert['eselParts']:
925 eselOutput = eselOutput + item + ": " + alert['eselParts'][item] + " | "
926 selDict['eSEL'] = eselOutput
927 else:
928 if args.devdebug:
929 selDict['eSEL'] = "None"
930
931 if not alert['resolved']:
932 activeAlerts.append(selDict)
933 else:
934 historyAlerts.append(selDict)
935 mergedOutput = activeAlerts + historyAlerts
936 colWidth = setColWidth(keylist, len(colNames), dict(enumerate(mergedOutput)), colNames)
937
938 output = ""
939 if(len(activeAlerts)>0):
940 row = ""
941 output +="----Active Alerts----\n"
942 for i in range(0, len(colNames)):
943 if i!=0: row =row + "| "
944 row = row + colNames[i].ljust(colWidth[i])
945 output += row + "\n"
946
947 for i in range(0,len(activeAlerts)):
948 row = ""
949 for j in range(len(activeAlerts[i])):
950 if (j != 0): row = row + "| "
951 row = row + activeAlerts[i][keylist[j]].ljust(colWidth[j])
952 output += row + "\n"
953
954 if(len(historyAlerts)>0):
955 row = ""
956 output+= "----Historical Alerts----\n"
957 for i in range(len(colNames)):
958 if i!=0: row =row + "| "
959 row = row + colNames[i].ljust(colWidth[i])
960 output += row + "\n"
961
962 for i in range(0, len(historyAlerts)):
963 row = ""
964 for j in range(len(historyAlerts[i])):
965 if (j != 0): row = row + "| "
966 row = row + historyAlerts[i][keylist[j]].ljust(colWidth[j])
967 output += row + "\n"
968# print(events[eventKeyDict[str(log)]])
969 return output
970
Justin Thalere412dc22018-01-12 16:28:24 -0600971
Justin Thalerf9aee3e2017-12-05 12:11:09 -0600972def selPrint(host, args, session):
Justin Thalere412dc22018-01-12 16:28:24 -0600973 """
974 prints out all bmc alerts
975
976 @param host: string, the hostname or IP address of the bmc
977 @param args: contains additional arguments used by the fru sub command
978 @param session: the active session to use
979 @param args.json: boolean, if this flag is set to true, the output will be provided in json format for programmatic consumption
980 """
Justin Thalerf9aee3e2017-12-05 12:11:09 -0600981 if(args.policyTableLoc is None):
982 if os.path.exists('policyTable.json'):
983 ptableLoc = "policyTable.json"
984 elif os.path.exists('/opt/ibm/ras/lib/policyTable.json'):
985 ptableLoc = '/opt/ibm/ras/lib/policyTable.json'
986 else:
987 ptableLoc = 'lib/policyTable.json'
988 else:
989 ptableLoc = args.policyTableLoc
990 policyTable = loadPolicyTable(ptableLoc)
991 rawselEntries = ""
992 if(hasattr(args, 'fileloc') and args.fileloc is not None):
993 if os.path.exists(args.fileloc):
994 with open(args.fileloc, 'r') as selFile:
995 selLines = selFile.readlines()
996 rawselEntries = ''.join(selLines)
997 else:
998 print("Error: File not found")
999 sys.exit(1)
1000 else:
1001 rawselEntries = sel(host, args, session)
1002 loadFailed = False
1003 try:
1004 selEntries = json.loads(rawselEntries)
1005 except ValueError:
1006 loadFailed = True
1007 if loadFailed:
1008 cleanSels = json.dumps(rawselEntries).replace('\\n', '')
1009 #need to load json twice as original content was string escaped a second time
1010 selEntries = json.loads(json.loads(cleanSels))
1011 selEntries = selEntries['data']
Justin Thalere412dc22018-01-12 16:28:24 -06001012
Justin Thalerf9aee3e2017-12-05 12:11:09 -06001013 if 'description' in selEntries:
1014 if(args.json):
1015 return("{\n\t\"numAlerts\": 0\n}")
1016 else:
1017 return("No log entries found")
1018
1019 else:
1020 if(len(policyTable)>0):
1021 events = parseAlerts(policyTable, selEntries, args)
1022 if(args.json):
1023 events["numAlerts"] = len(events)
1024 retValue = str(json.dumps(events, sort_keys=True, indent=4, separators=(',', ': '), ensure_ascii=False))
1025 return retValue
1026 elif(hasattr(args, 'fullSel')):
1027 return events
1028 else:
1029 #get log numbers to order event entries sequentially
1030 return selDisplay(events, args)
1031 else:
1032 if(args.json):
1033 return selEntries
1034 else:
1035 print("error: Policy Table not found.")
1036 return selEntries
Justin Thalere412dc22018-01-12 16:28:24 -06001037
Justin Thalerf9aee3e2017-12-05 12:11:09 -06001038def selList(host, args, session):
Justin Thalere412dc22018-01-12 16:28:24 -06001039 """
1040 prints out all all bmc alerts, or only prints out the specified alerts
1041
1042 @param host: string, the hostname or IP address of the bmc
1043 @param args: contains additional arguments used by the fru sub command
1044 @param session: the active session to use
1045 @param args.json: boolean, if this flag is set to true, the output will be provided in json format for programmatic consumption
1046 """
Justin Thalerf9aee3e2017-12-05 12:11:09 -06001047 return(sel(host, args, session))
1048
Justin Thalere412dc22018-01-12 16:28:24 -06001049
Justin Thalerf9aee3e2017-12-05 12:11:09 -06001050def selClear(host, args, session):
Justin Thalere412dc22018-01-12 16:28:24 -06001051 """
1052 clears all alerts
1053
1054 @param host: string, the hostname or IP address of the bmc
1055 @param args: contains additional arguments used by the fru sub command
1056 @param session: the active session to use
1057 @param args.json: boolean, if this flag is set to true, the output will be provided in json format for programmatic consumption
1058 """
Justin Thalerf9aee3e2017-12-05 12:11:09 -06001059 url="https://"+host+"/xyz/openbmc_project/logging/action/deleteAll"
1060 httpHeader = {'Content-Type':'application/json'}
1061 data = "{\"data\": [] }"
Justin Thalere412dc22018-01-12 16:28:24 -06001062
1063 try:
1064 res = session.post(url, headers=httpHeader, data=data, verify=False, timeout=30)
1065 except(requests.exceptions.Timeout):
1066 return(connectionErrHandler(args.json, "Timeout", None))
Justin Thalerf9aee3e2017-12-05 12:11:09 -06001067 if res.status_code == 200:
1068 return "The Alert Log has been cleared. Please allow a few minutes for the action to complete."
1069 else:
1070 print("Unable to clear the logs, trying to clear 1 at a time")
1071 sels = json.loads(sel(host, args, session))['data']
1072 for key in sels:
1073 if 'callout' not in key:
1074 logNum = key.split('/')[-1]
1075 url = "https://"+ host+ "/xyz/openbmc_project/logging/entry/"+logNum+"/action/Delete"
1076 try:
1077 session.post(url, headers=httpHeader, data=data, verify=False, timeout=30)
1078 except(requests.exceptions.Timeout):
1079 return connectionErrHandler(args.json, "Timeout", None)
1080 sys.exit(1)
1081 except(requests.exceptions.ConnectionError) as err:
1082 return connectionErrHandler(args.json, "ConnectionError", err)
1083 sys.exit(1)
1084 return ('Sel clearing complete')
1085
1086def selSetResolved(host, args, session):
Justin Thalere412dc22018-01-12 16:28:24 -06001087 """
1088 sets a sel entry to resolved
1089
1090 @param host: string, the hostname or IP address of the bmc
1091 @param args: contains additional arguments used by the fru sub command
1092 @param session: the active session to use
1093 @param args.json: boolean, if this flag is set to true, the output will be provided in json format for programmatic consumption
1094 """
Justin Thalerf9aee3e2017-12-05 12:11:09 -06001095 url="https://"+host+"/xyz/openbmc_project/logging/entry/" + str(args.selNum) + "/attr/Resolved"
1096 httpHeader = {'Content-Type':'application/json'}
1097 data = "{\"data\": 1 }"
Justin Thalere412dc22018-01-12 16:28:24 -06001098 try:
1099 res = session.put(url, headers=httpHeader, data=data, verify=False, timeout=30)
1100 except(requests.exceptions.Timeout):
1101 return(connectionErrHandler(args.json, "Timeout", None))
Justin Thalerf9aee3e2017-12-05 12:11:09 -06001102 if res.status_code == 200:
1103 return "Sel entry "+ str(args.selNum) +" is now set to resolved"
1104 else:
1105 return "Unable to set the alert to resolved"
Justin Thalerf9aee3e2017-12-05 12:11:09 -06001106
Justin Thalere412dc22018-01-12 16:28:24 -06001107def selResolveAll(host, args, session):
1108 """
1109 sets a sel entry to resolved
1110
1111 @param host: string, the hostname or IP address of the bmc
1112 @param args: contains additional arguments used by the fru sub command
1113 @param session: the active session to use
1114 @param args.json: boolean, if this flag is set to true, the output will be provided in json format for programmatic consumption
1115 """
1116 rawselEntries = sel(host, args, session)
1117 loadFailed = False
1118 try:
1119 selEntries = json.loads(rawselEntries)
1120 except ValueError:
1121 loadFailed = True
1122 if loadFailed:
1123 cleanSels = json.dumps(rawselEntries).replace('\\n', '')
1124 #need to load json twice as original content was string escaped a second time
1125 selEntries = json.loads(json.loads(cleanSels))
1126 selEntries = selEntries['data']
1127
1128 if 'description' in selEntries:
1129 if(args.json):
1130 return("{\n\t\"selsResolved\": 0\n}")
1131 else:
1132 return("No log entries found")
1133 else:
1134 d = vars(args)
1135 successlist = []
1136 failedlist = []
1137 for key in selEntries:
1138 if 'callout' not in key:
1139 d['selNum'] = key.split('/')[-1]
1140 resolved = selSetResolved(host,args,session)
1141 if 'Sel entry' in resolved:
1142 successlist.append(d['selNum'])
1143 else:
1144 failedlist.append(d['selNum'])
1145 output = ""
1146 successlist.sort()
1147 failedlist.sort()
1148 if len(successlist)>0:
1149 output = "Successfully resolved: " +', '.join(successlist) +"\n"
1150 if len(failedlist)>0:
1151 output += "Failed to resolve: " + ', '.join(failedlist) + "\n"
1152 return output
1153
Justin Thalerf9aee3e2017-12-05 12:11:09 -06001154def chassisPower(host, args, session):
Justin Thalere412dc22018-01-12 16:28:24 -06001155 """
1156 called by the chassis function. Controls the power state of the chassis, or gets the status
1157
1158 @param host: string, the hostname or IP address of the bmc
1159 @param args: contains additional arguments used by the fru sub command
1160 @param session: the active session to use
1161 @param args.json: boolean, if this flag is set to true, the output will be provided in json format for programmatic consumption
1162 """
Justin Thalerf9aee3e2017-12-05 12:11:09 -06001163 if(args.powcmd == 'on'):
Justin Thaler22b1bb52018-03-15 13:31:32 -05001164 if checkFWactivation(host, args, session):
1165 return ("Chassis Power control disabled during firmware activation")
Justin Thalerf9aee3e2017-12-05 12:11:09 -06001166 print("Attempting to Power on...:")
1167 url="https://"+host+"/xyz/openbmc_project/state/host0/attr/RequestedHostTransition"
1168 httpHeader = {'Content-Type':'application/json',}
1169 data = '{"data":"xyz.openbmc_project.State.Host.Transition.On"}'
Justin Thalere412dc22018-01-12 16:28:24 -06001170 try:
1171 res = session.put(url, headers=httpHeader, data=data, verify=False, timeout=30)
1172 except(requests.exceptions.Timeout):
1173 return(connectionErrHandler(args.json, "Timeout", None))
Justin Thalerf9aee3e2017-12-05 12:11:09 -06001174 return res.text
Justin Thalere412dc22018-01-12 16:28:24 -06001175 elif(args.powcmd == 'softoff'):
Justin Thaler22b1bb52018-03-15 13:31:32 -05001176 if checkFWactivation(host, args, session):
1177 return ("Chassis Power control disabled during firmware activation")
Justin Thalere412dc22018-01-12 16:28:24 -06001178 print("Attempting to Power off gracefully...:")
Justin Thalerf9aee3e2017-12-05 12:11:09 -06001179 url="https://"+host+"/xyz/openbmc_project/state/host0/attr/RequestedHostTransition"
1180 httpHeader = {'Content-Type':'application/json'}
1181 data = '{"data":"xyz.openbmc_project.State.Host.Transition.Off"}'
Justin Thalere412dc22018-01-12 16:28:24 -06001182 try:
1183 res = session.put(url, headers=httpHeader, data=data, verify=False, timeout=30)
1184 except(requests.exceptions.Timeout):
1185 return(connectionErrHandler(args.json, "Timeout", None))
1186 return res.text
1187 elif(args.powcmd == 'hardoff'):
Justin Thaler22b1bb52018-03-15 13:31:32 -05001188 if checkFWactivation(host, args, session):
1189 return ("Chassis Power control disabled during firmware activation")
Justin Thalere412dc22018-01-12 16:28:24 -06001190 print("Attempting to Power off immediately...:")
1191 url="https://"+host+"/xyz/openbmc_project/state/chassis0/attr/RequestedPowerTransition"
1192 httpHeader = {'Content-Type':'application/json'}
1193 data = '{"data":"xyz.openbmc_project.State.Chassis.Transition.Off"}'
1194 try:
1195 res = session.put(url, headers=httpHeader, data=data, verify=False, timeout=30)
1196 except(requests.exceptions.Timeout):
1197 return(connectionErrHandler(args.json, "Timeout", None))
Justin Thalerf9aee3e2017-12-05 12:11:09 -06001198 return res.text
1199 elif(args.powcmd == 'status'):
1200 url="https://"+host+"/xyz/openbmc_project/state/chassis0/attr/CurrentPowerState"
1201 httpHeader = {'Content-Type':'application/json'}
1202# print(url)
Justin Thalere412dc22018-01-12 16:28:24 -06001203 try:
1204 res = session.get(url, headers=httpHeader, verify=False, timeout=30)
1205 except(requests.exceptions.Timeout):
1206 return(connectionErrHandler(args.json, "Timeout", None))
Justin Thalerf9aee3e2017-12-05 12:11:09 -06001207 chassisState = json.loads(res.text)['data'].split('.')[-1]
1208 url="https://"+host+"/xyz/openbmc_project/state/host0/attr/CurrentHostState"
Justin Thalere412dc22018-01-12 16:28:24 -06001209 try:
1210 res = session.get(url, headers=httpHeader, verify=False, timeout=30)
1211 except(requests.exceptions.Timeout):
1212 return(connectionErrHandler(args.json, "Timeout", None))
Justin Thalerf9aee3e2017-12-05 12:11:09 -06001213 hostState = json.loads(res.text)['data'].split('.')[-1]
1214 url="https://"+host+"/xyz/openbmc_project/state/bmc0/attr/CurrentBMCState"
Justin Thalere412dc22018-01-12 16:28:24 -06001215 try:
1216 res = session.get(url, headers=httpHeader, verify=False, timeout=30)
1217 except(requests.exceptions.Timeout):
1218 return(connectionErrHandler(args.json, "Timeout", None))
Justin Thalerf9aee3e2017-12-05 12:11:09 -06001219 bmcState = json.loads(res.text)['data'].split('.')[-1]
1220 if(args.json):
1221 outDict = {"Chassis Power State" : chassisState, "Host Power State" : hostState, "BMC Power State":bmcState}
1222 return json.dumps(outDict, sort_keys=True, indent=4, separators=(',', ': '), ensure_ascii=False)
1223 else:
1224 return "Chassis Power State: " +chassisState + "\nHost Power State: " + hostState + "\nBMC Power State: " + bmcState
1225 else:
1226 return "Invalid chassis power command"
1227
Justin Thalere412dc22018-01-12 16:28:24 -06001228
Justin Thalerf9aee3e2017-12-05 12:11:09 -06001229def chassisIdent(host, args, session):
Justin Thalere412dc22018-01-12 16:28:24 -06001230 """
1231 called by the chassis function. Controls the identify led of the chassis. Sets or gets the state
1232
1233 @param host: string, the hostname or IP address of the bmc
1234 @param args: contains additional arguments used by the fru sub command
1235 @param session: the active session to use
1236 @param args.json: boolean, if this flag is set to true, the output will be provided in json format for programmatic consumption
1237 """
Justin Thalerf9aee3e2017-12-05 12:11:09 -06001238 if(args.identcmd == 'on'):
1239 print("Attempting to turn identify light on...:")
1240 url="https://"+host+"/xyz/openbmc_project/led/groups/enclosure_identify/attr/Asserted"
1241 httpHeader = {'Content-Type':'application/json',}
1242 data = '{"data":true}'
Justin Thalere412dc22018-01-12 16:28:24 -06001243 try:
1244 res = session.put(url, headers=httpHeader, data=data, verify=False, timeout=30)
1245 except(requests.exceptions.Timeout):
1246 return(connectionErrHandler(args.json, "Timeout", None))
Justin Thalerf9aee3e2017-12-05 12:11:09 -06001247 return res.text
1248 elif(args.identcmd == 'off'):
1249 print("Attempting to turn identify light off...:")
1250 url="https://"+host+"/xyz/openbmc_project/led/groups/enclosure_identify/attr/Asserted"
1251 httpHeader = {'Content-Type':'application/json'}
1252 data = '{"data":false}'
Justin Thalere412dc22018-01-12 16:28:24 -06001253 try:
1254 res = session.put(url, headers=httpHeader, data=data, verify=False, timeout=30)
1255 except(requests.exceptions.Timeout):
1256 return(connectionErrHandler(args.json, "Timeout", None))
Justin Thalerf9aee3e2017-12-05 12:11:09 -06001257 return res.text
1258 elif(args.identcmd == 'status'):
1259 url="https://"+host+"/xyz/openbmc_project/led/groups/enclosure_identify"
1260 httpHeader = {'Content-Type':'application/json'}
Justin Thalere412dc22018-01-12 16:28:24 -06001261 try:
1262 res = session.get(url, headers=httpHeader, verify=False, timeout=30)
1263 except(requests.exceptions.Timeout):
1264 return(connectionErrHandler(args.json, "Timeout", None))
Justin Thalerf9aee3e2017-12-05 12:11:09 -06001265 status = json.loads(res.text)['data']
1266 if(args.json):
1267 return status
1268 else:
1269 if status['Asserted'] == 0:
1270 return "Identify light is off"
1271 else:
1272 return "Identify light is blinking"
1273 else:
1274 return "Invalid chassis identify command"
1275
Justin Thalere412dc22018-01-12 16:28:24 -06001276
Justin Thalerf9aee3e2017-12-05 12:11:09 -06001277def chassis(host, args, session):
Justin Thalere412dc22018-01-12 16:28:24 -06001278 """
1279 controls the different chassis commands
1280
1281 @param host: string, the hostname or IP address of the bmc
1282 @param args: contains additional arguments used by the fru sub command
1283 @param session: the active session to use
1284 @param args.json: boolean, if this flag is set to true, the output will be provided in json format for programmatic consumption
1285 """
Justin Thalerf9aee3e2017-12-05 12:11:09 -06001286 if(hasattr(args, 'powcmd')):
1287 result = chassisPower(host,args,session)
1288 elif(hasattr(args, 'identcmd')):
1289 result = chassisIdent(host, args, session)
1290 else:
Justin Thaler22b1bb52018-03-15 13:31:32 -05001291 return "This feature is not yet implemented"
Justin Thalerf9aee3e2017-12-05 12:11:09 -06001292 return result
Justin Thalere412dc22018-01-12 16:28:24 -06001293
Justin Thalerf9aee3e2017-12-05 12:11:09 -06001294def bmcDumpRetrieve(host, args, session):
Justin Thalere412dc22018-01-12 16:28:24 -06001295 """
1296 Downloads a dump file from the bmc
1297
1298 @param host: string, the hostname or IP address of the bmc
1299 @param args: contains additional arguments used by the collectServiceData sub command
1300 @param session: the active session to use
1301 @param args.json: boolean, if this flag is set to true, the output will be provided in json format for programmatic consumption
1302 """
Justin Thalerf9aee3e2017-12-05 12:11:09 -06001303 httpHeader = {'Content-Type':'application/json'}
1304 dumpNum = args.dumpNum
1305 if (args.dumpSaveLoc is not None):
1306 saveLoc = args.dumpSaveLoc
1307 else:
Justin Thalercf1deae2018-05-25 19:35:21 -05001308 saveLoc = tempfile.gettempdir()
Justin Thalerf9aee3e2017-12-05 12:11:09 -06001309 url ='https://'+host+'/download/dump/' + str(dumpNum)
1310 try:
Justin Thalere412dc22018-01-12 16:28:24 -06001311 r = session.get(url, headers=httpHeader, stream=True, verify=False, timeout=30)
Justin Thalerf9aee3e2017-12-05 12:11:09 -06001312 if (args.dumpSaveLoc is not None):
1313 if os.path.exists(saveLoc):
1314 if saveLoc[-1] != os.path.sep:
1315 saveLoc = saveLoc + os.path.sep
1316 filename = saveLoc + host+'-dump' + str(dumpNum) + '.tar.xz'
1317
1318 else:
1319 return 'Invalid save location specified'
1320 else:
Justin Thalercf1deae2018-05-25 19:35:21 -05001321 filename = tempfile.gettempdir()+os.sep + host+'-dump' + str(dumpNum) + '.tar.xz'
Justin Thalerf9aee3e2017-12-05 12:11:09 -06001322
1323 with open(filename, 'wb') as f:
1324 for chunk in r.iter_content(chunk_size =1024):
1325 if chunk:
1326 f.write(chunk)
1327 return 'Saved as ' + filename
1328
1329 except(requests.exceptions.Timeout):
1330 return connectionErrHandler(args.json, "Timeout", None)
Justin Thalere412dc22018-01-12 16:28:24 -06001331
Justin Thalerf9aee3e2017-12-05 12:11:09 -06001332 except(requests.exceptions.ConnectionError) as err:
1333 return connectionErrHandler(args.json, "ConnectionError", err)
Justin Thalerf9aee3e2017-12-05 12:11:09 -06001334
Justin Thalere412dc22018-01-12 16:28:24 -06001335def bmcDumpList(host, args, session):
1336 """
1337 Lists the number of dump files on the bmc
1338
1339 @param host: string, the hostname or IP address of the bmc
1340 @param args: contains additional arguments used by the collectServiceData sub command
1341 @param session: the active session to use
1342 @param args.json: boolean, if this flag is set to true, the output will be provided in json format for programmatic consumption
1343 """
Justin Thalerf9aee3e2017-12-05 12:11:09 -06001344 httpHeader = {'Content-Type':'application/json'}
1345 url ='https://'+host+'/xyz/openbmc_project/dump/list'
1346 try:
1347 r = session.get(url, headers=httpHeader, verify=False, timeout=20)
1348 dumpList = json.loads(r.text)
1349 return r.text
1350 except(requests.exceptions.Timeout):
1351 return connectionErrHandler(args.json, "Timeout", None)
Justin Thalere412dc22018-01-12 16:28:24 -06001352
Justin Thalerf9aee3e2017-12-05 12:11:09 -06001353 except(requests.exceptions.ConnectionError) as err:
Justin Thalere412dc22018-01-12 16:28:24 -06001354 return connectionErrHandler(args.json, "ConnectionError", err)
Justin Thalerf9aee3e2017-12-05 12:11:09 -06001355
Justin Thalerf9aee3e2017-12-05 12:11:09 -06001356def bmcDumpDelete(host, args, session):
Justin Thalere412dc22018-01-12 16:28:24 -06001357 """
1358 Deletes BMC dump files from the bmc
1359
1360 @param host: string, the hostname or IP address of the bmc
1361 @param args: contains additional arguments used by the collectServiceData sub command
1362 @param session: the active session to use
1363 @param args.json: boolean, if this flag is set to true, the output will be provided in json format for programmatic consumption
1364 """
Justin Thalerf9aee3e2017-12-05 12:11:09 -06001365 httpHeader = {'Content-Type':'application/json'}
1366 dumpList = []
1367 successList = []
1368 failedList = []
1369 if args.dumpNum is not None:
1370 if isinstance(args.dumpNum, list):
1371 dumpList = args.dumpNum
1372 else:
1373 dumpList.append(args.dumpNum)
1374 for dumpNum in dumpList:
1375 url ='https://'+host+'/xyz/openbmc_project/dump/entry/'+str(dumpNum)+'/action/Delete'
1376 try:
1377 r = session.post(url, headers=httpHeader, json = {"data": []}, verify=False, timeout=30)
1378 if r.status_code == 200:
1379 successList.append(str(dumpNum))
Justin Thalerf9aee3e2017-12-05 12:11:09 -06001380 else:
1381 failedList.append(str(dumpNum))
Justin Thalerf9aee3e2017-12-05 12:11:09 -06001382 except(requests.exceptions.Timeout):
1383 return connectionErrHandler(args.json, "Timeout", None)
Justin Thalerf9aee3e2017-12-05 12:11:09 -06001384 except(requests.exceptions.ConnectionError) as err:
1385 return connectionErrHandler(args.json, "ConnectionError", err)
Justin Thalerf9aee3e2017-12-05 12:11:09 -06001386 output = "Successfully deleted dumps: " + ', '.join(successList)
1387 if(len(failedList)>0):
1388 output+= '\nFailed to delete dumps: ' + ', '.join(failedList)
1389 return output
1390 else:
1391 return 'You must specify an entry number to delete'
1392
Justin Thalerf9aee3e2017-12-05 12:11:09 -06001393def bmcDumpDeleteAll(host, args, session):
Justin Thalere412dc22018-01-12 16:28:24 -06001394 """
1395 Deletes All BMC dump files from the bmc
1396
1397 @param host: string, the hostname or IP address of the bmc
1398 @param args: contains additional arguments used by the collectServiceData sub command
1399 @param session: the active session to use
1400 @param args.json: boolean, if this flag is set to true, the output will be provided in json format for programmatic consumption
1401 """
1402 dumpResp = bmcDumpList(host, args, session)
1403 if 'FQPSPIN0000M' in dumpResp or 'FQPSPIN0001M'in dumpResp:
1404 return dumpResp
1405 dumpList = json.loads(dumpResp)['data']
Justin Thalerf9aee3e2017-12-05 12:11:09 -06001406 d = vars(args)
1407 dumpNums = []
1408 for dump in dumpList:
1409 if '/xyz/openbmc_project/dump/internal/manager' not in dump:
1410 dumpNums.append(int(dump.strip().split('/')[-1]))
1411 d['dumpNum'] = dumpNums
1412
1413 return bmcDumpDelete(host, args, session)
1414
Justin Thalere412dc22018-01-12 16:28:24 -06001415
Justin Thalerf9aee3e2017-12-05 12:11:09 -06001416def bmcDumpCreate(host, args, session):
Justin Thalere412dc22018-01-12 16:28:24 -06001417 """
1418 Creates a bmc dump file
1419
1420 @param host: string, the hostname or IP address of the bmc
1421 @param args: contains additional arguments used by the collectServiceData sub command
1422 @param session: the active session to use
1423 @param args.json: boolean, if this flag is set to true, the output will be provided in json format for programmatic consumption
1424 """
Justin Thalerf9aee3e2017-12-05 12:11:09 -06001425 httpHeader = {'Content-Type':'application/json'}
1426 url = 'https://'+host+'/xyz/openbmc_project/dump/action/CreateDump'
1427 try:
1428 r = session.post(url, headers=httpHeader, json = {"data": []}, verify=False, timeout=30)
1429 if('"message": "200 OK"' in r.text and not args.json):
1430 return ('Dump successfully created')
1431 else:
1432 return ('Failed to create dump')
1433 except(requests.exceptions.Timeout):
1434 return connectionErrHandler(args.json, "Timeout", None)
1435 except(requests.exceptions.ConnectionError) as err:
1436 return connectionErrHandler(args.json, "ConnectionError", err)
1437
1438
1439
Justin Thalere412dc22018-01-12 16:28:24 -06001440
Justin Thalerf9aee3e2017-12-05 12:11:09 -06001441def collectServiceData(host, args, session):
Justin Thalere412dc22018-01-12 16:28:24 -06001442 """
1443 Collects all data needed for service from the BMC
1444
1445 @param host: string, the hostname or IP address of the bmc
1446 @param args: contains additional arguments used by the collectServiceData sub command
1447 @param session: the active session to use
1448 @param args.json: boolean, if this flag is set to true, the output will be provided in json format for programmatic consumption
1449 """
Justin Thaler22b1bb52018-03-15 13:31:32 -05001450
1451 global toolVersion
Justin Thalerf9aee3e2017-12-05 12:11:09 -06001452 #create a bmc dump
1453 dumpcount = len(json.loads(bmcDumpList(host, args, session))['data'])
1454 try:
1455 dumpcreated = bmcDumpCreate(host, args, session)
1456 except Exception as e:
1457 print('failed to create a bmc dump')
1458
1459
1460 #Collect Inventory
1461 try:
1462 args.silent = True
Justin Thalercf1deae2018-05-25 19:35:21 -05001463 myDir = tempfile.gettempdir()+os.sep + host + "--" + datetime.datetime.now().strftime("%Y-%m-%d_%H.%M.%S")
Justin Thalerf9aee3e2017-12-05 12:11:09 -06001464 os.makedirs(myDir)
1465 filelist = []
1466 frulist = fruPrint(host, args, session)
1467 with open(myDir +'/inventory.txt', 'w') as f:
1468 f.write(frulist)
1469 print("Inventory collected and stored in " + myDir + "/inventory.txt")
1470 filelist.append(myDir+'/inventory.txt')
1471 except Exception as e:
1472 print("Failed to collect inventory")
1473
1474 #Read all the sensor and OCC status
1475 try:
1476 sensorReadings = sensor(host, args, session)
1477 with open(myDir +'/sensorReadings.txt', 'w') as f:
1478 f.write(sensorReadings)
1479 print("Sensor readings collected and stored in " +myDir + "/sensorReadings.txt")
1480 filelist.append(myDir+'/sensorReadings.txt')
1481 except Exception as e:
1482 print("Failed to collect sensor readings")
1483
1484 #Collect all of the LEDs status
1485 try:
1486 url="https://"+host+"/xyz/openbmc_project/led/enumerate"
1487 httpHeader = {'Content-Type':'application/json'}
1488 leds = session.get(url, headers=httpHeader, verify=False, timeout=20)
1489 with open(myDir +'/ledStatus.txt', 'w') as f:
1490 f.write(leds.text)
1491 print("System LED status collected and stored in "+myDir +"/ledStatus.txt")
1492 filelist.append(myDir+'/ledStatus.txt')
1493 except Exception as e:
1494 print("Failed to collect LED status")
1495
1496 #Collect the bmc logs
1497 try:
1498 sels = selPrint(host,args,session)
1499 with open(myDir +'/SELshortlist.txt', 'w') as f:
1500 f.write(str(sels))
1501 print("sel short list collected and stored in "+myDir +"/SELshortlist.txt")
1502 filelist.append(myDir+'/SELshortlist.txt')
1503 time.sleep(2)
1504
1505 d = vars(args)
1506 d['json'] = True
1507 d['fullSel'] = True
1508 parsedfullsels = json.loads(selPrint(host, args, session))
1509 d['fullEsel'] = True
1510 sortedSELs = sortSELs(parsedfullsels)
1511 with open(myDir +'/parsedSELs.txt', 'w') as f:
1512 for log in sortedSELs[0]:
1513 esel = ""
1514 parsedfullsels[sortedSELs[1][str(log)]]['timestamp'] = datetime.datetime.fromtimestamp(int(parsedfullsels[sortedSELs[1][str(log)]]['timestamp']/1000)).strftime("%Y-%m-%d %H:%M:%S")
1515 if ('raweSEL' in parsedfullsels[sortedSELs[1][str(log)]] and args.devdebug):
1516 esel = parsedfullsels[sortedSELs[1][str(log)]]['raweSEL']
1517 del parsedfullsels[sortedSELs[1][str(log)]]['raweSEL']
1518 f.write(json.dumps(parsedfullsels[sortedSELs[1][str(log)]],sort_keys=True, indent=4, separators=(',', ': ')))
1519 if(args.devdebug and esel != ""):
1520 f.write(parseESEL(args, esel))
1521 print("fully parsed sels collected and stored in "+myDir +"/parsedSELs.txt")
1522 filelist.append(myDir+'/parsedSELs.txt')
1523 except Exception as e:
1524 print("Failed to collect system event logs")
1525 print(e)
1526
1527 #collect RAW bmc enumeration
1528 try:
1529 url="https://"+host+"/xyz/openbmc_project/enumerate"
1530 print("Attempting to get a full BMC enumeration")
1531 fullDump = session.get(url, headers=httpHeader, verify=False, timeout=120)
1532 with open(myDir +'/bmcFullRaw.txt', 'w') as f:
1533 f.write(fullDump.text)
1534 print("RAW BMC data collected and saved into "+myDir +"/bmcFullRaw.txt")
1535 filelist.append(myDir+'/bmcFullRaw.txt')
1536 except Exception as e:
1537 print("Failed to collect bmc full enumeration")
1538
1539 #collect the dump files
1540 waitingForNewDump = True
1541 count = 0;
1542 while(waitingForNewDump):
1543 dumpList = json.loads(bmcDumpList(host, args, session))['data']
1544 if len(dumpList) > dumpcount:
1545 waitingForNewDump = False
1546 break;
1547 elif(count>30):
1548 print("Timed out waiting for bmc to make a new dump file. Dump space may be full.")
1549 break;
1550 else:
1551 time.sleep(2)
1552 count += 1
1553 try:
1554 print('Collecting bmc dump files')
1555 d['dumpSaveLoc'] = myDir
1556 dumpList = json.loads(bmcDumpList(host, args, session))['data']
1557 for dump in dumpList:
1558 if '/xyz/openbmc_project/dump/internal/manager' not in dump:
1559 d['dumpNum'] = int(dump.strip().split('/')[-1])
1560 print('retrieving dump file ' + str(d['dumpNum']))
1561 filename = bmcDumpRetrieve(host, args, session).split('Saved as ')[-1]
1562 filelist.append(filename)
1563 time.sleep(2)
1564 except Exception as e:
1565 print("Failed to collect bmc dump files")
1566 print(e)
1567
1568 #create the zip file
1569 try:
Justin Thalercf1deae2018-05-25 19:35:21 -05001570 filename = myDir.split(tempfile.gettempdir()+os.sep)[-1] + "_" + toolVersion + '_openbmc.zip'
Justin Thalerf9aee3e2017-12-05 12:11:09 -06001571 zf = zipfile.ZipFile(myDir+'/' + filename, 'w')
1572 for myfile in filelist:
1573 zf.write(myfile, os.path.basename(myfile))
1574 zf.close()
1575 except Exception as e:
1576 print("Failed to create zip file with collected information")
1577 return "data collection complete"
1578
Justin Thalere412dc22018-01-12 16:28:24 -06001579
1580def healthCheck(host, args, session):
1581 """
1582 runs a health check on the platform
1583
1584 @param host: string, the hostname or IP address of the bmc
1585 @param args: contains additional arguments used by the bmc sub command
1586 @param session: the active session to use
1587 @param args.json: boolean, if this flag is set to true, the output will be provided in json format for programmatic consumption
1588 """
1589 #check fru status and get as json to easily work through
1590 d = vars(args)
1591 useJson = d['json']
1592 d['json'] = True
1593 d['verbose']= False
1594
1595 frus = json.loads(fruStatus(host, args, session))
1596
1597 hwStatus= "OK"
1598 performanceStatus = "OK"
1599 for key in frus:
1600 if frus[key]["Functional"] == "No" and frus[key]["Present"] == "Yes":
1601 hwStatus= "Degraded"
Justin Thalerfb9c81c2018-07-16 11:14:37 -05001602 if("power_supply" in key or "powersupply" in key):
1603 gpuCount =0
1604 for comp in frus:
Justin Thalere412dc22018-01-12 16:28:24 -06001605 if "gv100card" in comp:
1606 gpuCount +=1
1607 if gpuCount > 4:
1608 hwStatus = "Critical"
1609 performanceStatus="Degraded"
1610 break;
1611 elif("fan" in key):
1612 hwStatus = "Degraded"
1613 else:
1614 performanceStatus = "Degraded"
1615 if useJson:
1616 output = {"Hardware Status": hwStatus, "Performance": performanceStatus}
1617 output = json.dumps(output, sort_keys=True, indent=4, separators=(',', ': '), ensure_ascii=False)
1618 else:
1619 output = ("Hardware Status: " + hwStatus +
1620 "\nPerformance: " +performanceStatus )
1621
1622
1623 #SW407886: Clear the duplicate entries
1624 #collect the dups
1625 d['devdebug'] = False
1626 sels = json.loads(selPrint(host, args, session))
1627 logNums2Clr = []
1628 oldestLogNum={"logNum": "bogus" ,"key" : ""}
1629 count = 0
1630 if sels['numAlerts'] > 0:
1631 for key in sels:
1632 if "numAlerts" in key:
1633 continue
1634 try:
1635 if "slave@00:00/00:00:00:06/sbefifo1-dev0/occ1-dev0" in sels[key]['Message']:
1636 count += 1
1637 if count > 1:
1638 #preserve first occurrence
1639 if sels[key]['timestamp'] < sels[oldestLogNum['key']]['timestamp']:
1640 oldestLogNum['key']=key
1641 oldestLogNum['logNum'] = sels[key]['logNum']
1642 else:
1643 oldestLogNum['key']=key
1644 oldestLogNum['logNum'] = sels[key]['logNum']
1645 logNums2Clr.append(sels[key]['logNum'])
1646 except KeyError:
1647 continue
1648 if(count >0):
1649 logNums2Clr.remove(oldestLogNum['logNum'])
1650 #delete the dups
1651 if count >1:
1652 httpHeader = {'Content-Type':'application/json'}
1653 data = "{\"data\": [] }"
1654 for logNum in logNums2Clr:
1655 url = "https://"+ host+ "/xyz/openbmc_project/logging/entry/"+logNum+"/action/Delete"
1656 try:
1657 session.post(url, headers=httpHeader, data=data, verify=False, timeout=30)
1658 except(requests.exceptions.Timeout):
1659 deleteFailed = True
1660 except(requests.exceptions.ConnectionError) as err:
1661 deleteFailed = True
1662 #End of defect resolve code
1663 d['json'] = useJson
1664 return output
1665
1666
1667
Justin Thalerf9aee3e2017-12-05 12:11:09 -06001668def bmc(host, args, session):
Justin Thalere412dc22018-01-12 16:28:24 -06001669 """
1670 handles various bmc level commands, currently bmc rebooting
1671
1672 @param host: string, the hostname or IP address of the bmc
1673 @param args: contains additional arguments used by the bmc sub command
1674 @param session: the active session to use
1675 @param args.json: boolean, if this flag is set to true, the output will be provided in json format for programmatic consumption
1676 """
Justin Thalerf9aee3e2017-12-05 12:11:09 -06001677 if(args.type is not None):
1678 return bmcReset(host, args, session)
Justin Thalere412dc22018-01-12 16:28:24 -06001679 if(args.info):
1680 return "Not implemented at this time"
1681
Justin Thalerf9aee3e2017-12-05 12:11:09 -06001682
Justin Thalere412dc22018-01-12 16:28:24 -06001683
Justin Thalerf9aee3e2017-12-05 12:11:09 -06001684def bmcReset(host, args, session):
Justin Thalere412dc22018-01-12 16:28:24 -06001685 """
1686 controls resetting the bmc. warm reset reboots the bmc, cold reset removes the configuration and reboots.
1687
1688 @param host: string, the hostname or IP address of the bmc
1689 @param args: contains additional arguments used by the bmcReset sub command
1690 @param session: the active session to use
1691 @param args.json: boolean, if this flag is set to true, the output will be provided in json format for programmatic consumption
1692 """
Justin Thaler22b1bb52018-03-15 13:31:32 -05001693 if checkFWactivation(host, args, session):
1694 return ("BMC reset control disabled during firmware activation")
Justin Thalerf9aee3e2017-12-05 12:11:09 -06001695 if(args.type == "warm"):
1696 print("\nAttempting to reboot the BMC...:")
1697 url="https://"+host+"/xyz/openbmc_project/state/bmc0/attr/RequestedBMCTransition"
1698 httpHeader = {'Content-Type':'application/json'}
Justin Thalere412dc22018-01-12 16:28:24 -06001699 data = '{"data":"xyz.openbmc_project.State.BMC.Transition.Reboot"}'
1700 res = session.put(url, headers=httpHeader, data=data, verify=False, timeout=20)
Justin Thalerf9aee3e2017-12-05 12:11:09 -06001701 return res.text
1702 elif(args.type =="cold"):
Justin Thalere412dc22018-01-12 16:28:24 -06001703 print("\nAttempting to reboot the BMC...:")
1704 url="https://"+host+"/xyz/openbmc_project/state/bmc0/attr/RequestedBMCTransition"
1705 httpHeader = {'Content-Type':'application/json'}
1706 data = '{"data":"xyz.openbmc_project.State.BMC.Transition.Reboot"}'
1707 res = session.put(url, headers=httpHeader, data=data, verify=False, timeout=20)
1708 return res.text
Justin Thalerf9aee3e2017-12-05 12:11:09 -06001709 else:
1710 return "invalid command"
Justin Thalere412dc22018-01-12 16:28:24 -06001711
1712def gardClear(host, args, session):
1713 """
1714 clears the gard records from the bmc
1715
1716 @param host: string, the hostname or IP address of the bmc
1717 @param args: contains additional arguments used by the gardClear sub command
1718 @param session: the active session to use
1719 """
1720 url="https://"+host+"/org/open_power/control/gard/action/Reset"
1721 httpHeader = {'Content-Type':'application/json'}
1722 data = '{"data":[]}'
1723 try:
1724
1725 res = session.post(url, headers=httpHeader, data=data, verify=False, timeout=30)
1726 if res.status_code == 404:
1727 return "Command not supported by this firmware version"
1728 else:
1729 return res.text
1730 except(requests.exceptions.Timeout):
1731 return connectionErrHandler(args.json, "Timeout", None)
1732 except(requests.exceptions.ConnectionError) as err:
1733 return connectionErrHandler(args.json, "ConnectionError", err)
1734
1735def activateFWImage(host, args, session):
1736 """
1737 activates a firmware image on the bmc
1738
1739 @param host: string, the hostname or IP address of the bmc
1740 @param args: contains additional arguments used by the fwflash sub command
1741 @param session: the active session to use
1742 @param fwID: the unique ID of the fw image to activate
1743 """
1744 fwID = args.imageID
1745
1746 #determine the existing versions
1747 httpHeader = {'Content-Type':'application/json'}
1748 url="https://"+host+"/xyz/openbmc_project/software/enumerate"
1749 try:
1750 resp = session.get(url, headers=httpHeader, verify=False, timeout=30)
1751 except(requests.exceptions.Timeout):
1752 return connectionErrHandler(args.json, "Timeout", None)
1753 except(requests.exceptions.ConnectionError) as err:
1754 return connectionErrHandler(args.json, "ConnectionError", err)
1755 existingSoftware = json.loads(resp.text)['data']
1756 altVersionID = ''
1757 versionType = ''
1758 imageKey = '/xyz/openbmc_project/software/'+fwID
1759 if imageKey in existingSoftware:
1760 versionType = existingSoftware[imageKey]['Purpose']
1761 for key in existingSoftware:
1762 if imageKey == key:
1763 continue
1764 if 'Purpose' in existingSoftware[key]:
1765 if versionType == existingSoftware[key]['Purpose']:
1766 altVersionID = key.split('/')[-1]
1767
1768
1769
1770
1771 url="https://"+host+"/xyz/openbmc_project/software/"+ fwID + "/attr/Priority"
1772 url1="https://"+host+"/xyz/openbmc_project/software/"+ altVersionID + "/attr/Priority"
1773 data = "{\"data\": 0}"
1774 data1 = "{\"data\": 1 }"
1775 try:
1776 resp = session.put(url, headers=httpHeader, data=data, verify=False, timeout=30)
1777 resp1 = session.put(url1, headers=httpHeader, data=data1, verify=False, timeout=30)
1778 except(requests.exceptions.Timeout):
1779 return connectionErrHandler(args.json, "Timeout", None)
1780 except(requests.exceptions.ConnectionError) as err:
1781 return connectionErrHandler(args.json, "ConnectionError", err)
1782 if(not args.json):
1783 if resp.status_code == 200 and resp1.status_code == 200:
Justin Thaler22b1bb52018-03-15 13:31:32 -05001784 return 'Firmware flash and activation completed. Please reboot the bmc and then boot the host OS for the changes to take effect. '
Justin Thalere412dc22018-01-12 16:28:24 -06001785 else:
1786 return "Firmware activation failed."
1787 else:
1788 return resp.text + resp1.text
Justin Thaler22b1bb52018-03-15 13:31:32 -05001789
1790def activateStatus(host, args, session):
1791 if checkFWactivation(host, args, session):
1792 return("Firmware is currently being activated. Do not reboot the BMC or start the Host OS")
1793 else:
1794 return("No firmware activations are pending")
1795
1796def extractFWimage(path, imageType):
1797 """
1798 extracts the bmc image and returns information about the package
1799
1800 @param path: the path and file name of the firmware image
1801 @param imageType: The type of image the user is trying to flash. Host or BMC
1802 @return: the image id associated with the package. returns an empty string on error.
1803 """
1804 f = tempfile.TemporaryFile()
1805 tmpDir = tempfile.gettempdir()
1806 newImageID = ""
1807 if os.path.exists(path):
1808 try:
1809 imageFile = tarfile.open(path,'r')
1810 contents = imageFile.getmembers()
1811 for tf in contents:
1812 if 'MANIFEST' in tf.name:
1813 imageFile.extract(tf.name, path=tmpDir)
1814 with open(tempfile.gettempdir() +os.sep+ tf.name, 'r') as imageInfo:
1815 for line in imageInfo:
1816 if 'purpose' in line:
1817 purpose = line.split('=')[1]
1818 if imageType not in purpose.split('.')[-1]:
1819 print('The specified image is not for ' + imageType)
1820 print('Please try again with the image for ' + imageType)
1821 return ""
1822 if 'version' == line.split('=')[0]:
1823 version = line.split('=')[1].strip().encode('utf-8')
1824 m = hashlib.sha512()
1825 m.update(version)
1826 newImageID = m.hexdigest()[:8]
1827 break
1828 try:
1829 os.remove(tempfile.gettempdir() +os.sep+ tf.name)
1830 except OSError:
1831 pass
1832 return newImageID
1833 except tarfile.ExtractError as e:
1834 print('Unable to extract information from the firmware file.')
1835 print('Ensure you have write access to the directory: ' + tmpDir)
1836 return newImageID
1837 except tarfile.TarError as e:
1838 print('This is not a valid firmware file.')
1839 return newImageID
1840 print("This is not a valid firmware file.")
1841 return newImageID
1842 else:
1843 print('The filename and path provided are not valid.')
1844 return newImageID
1845
1846def getAllFWImageIDs(fwInvDict):
1847 """
1848 gets a list of all the firmware image IDs
1849
1850 @param fwInvDict: the dictionary to search for FW image IDs
1851 @return: list containing string representation of the found image ids
1852 """
1853 idList = []
1854 for key in fwInvDict:
1855 if 'Version' in fwInvDict[key]:
1856 idList.append(key.split('/')[-1])
1857 return idList
1858
Justin Thalere412dc22018-01-12 16:28:24 -06001859def fwFlash(host, args, session):
1860 """
1861 updates the bmc firmware and pnor firmware
1862
1863 @param host: string, the hostname or IP address of the bmc
1864 @param args: contains additional arguments used by the fwflash sub command
1865 @param session: the active session to use
1866 """
Justin Thaler22b1bb52018-03-15 13:31:32 -05001867 d = vars(args)
Justin Thalere412dc22018-01-12 16:28:24 -06001868 if(args.type == 'bmc'):
1869 purp = 'BMC'
1870 else:
1871 purp = 'Host'
Justin Thaler22b1bb52018-03-15 13:31:32 -05001872
1873 #check power state of the machine. No concurrent FW updates allowed
1874 d['powcmd'] = 'status'
1875 powerstate = chassisPower(host, args, session)
1876 if 'Chassis Power State: On' in powerstate:
1877 return("Aborting firmware update. Host is powered on. Please turn off the host and try again.")
1878
1879 #determine the existing images on the bmc
Justin Thalere412dc22018-01-12 16:28:24 -06001880 httpHeader = {'Content-Type':'application/json'}
1881 url="https://"+host+"/xyz/openbmc_project/software/enumerate"
1882 try:
1883 resp = session.get(url, headers=httpHeader, verify=False, timeout=30)
1884 except(requests.exceptions.Timeout):
1885 return connectionErrHandler(args.json, "Timeout", None)
1886 except(requests.exceptions.ConnectionError) as err:
1887 return connectionErrHandler(args.json, "ConnectionError", err)
1888 oldsoftware = json.loads(resp.text)['data']
1889
Justin Thaler22b1bb52018-03-15 13:31:32 -05001890 #Extract the tar and get information from the manifest file
1891 newversionID = extractFWimage(args.fileloc, purp)
1892 if newversionID == "":
1893 return "Unable to verify FW image."
1894
1895
1896 #check if the new image is already on the bmc
1897 if newversionID not in getAllFWImageIDs(oldsoftware):
1898
1899 #upload the file
1900 httpHeader = {'Content-Type':'application/octet-stream'}
1901 url="https://"+host+"/upload/image"
1902 data=open(args.fileloc,'rb').read()
1903 print("Uploading file to BMC")
Justin Thalere412dc22018-01-12 16:28:24 -06001904 try:
Justin Thaler22b1bb52018-03-15 13:31:32 -05001905 resp = session.post(url, headers=httpHeader, data=data, verify=False)
Justin Thalere412dc22018-01-12 16:28:24 -06001906 except(requests.exceptions.Timeout):
1907 return connectionErrHandler(args.json, "Timeout", None)
1908 except(requests.exceptions.ConnectionError) as err:
1909 return connectionErrHandler(args.json, "ConnectionError", err)
Justin Thaler22b1bb52018-03-15 13:31:32 -05001910 if resp.status_code != 200:
1911 return "Failed to upload the file to the bmc"
Justin Thalere412dc22018-01-12 16:28:24 -06001912 else:
Justin Thaler22b1bb52018-03-15 13:31:32 -05001913 print("Upload complete.")
1914
1915 #verify bmc processed the image
1916 software ={}
1917 for i in range(0, 5):
1918 httpHeader = {'Content-Type':'application/json'}
1919 url="https://"+host+"/xyz/openbmc_project/software/enumerate"
1920 try:
1921 resp = session.get(url, headers=httpHeader, verify=False, timeout=30)
1922 except(requests.exceptions.Timeout):
1923 return connectionErrHandler(args.json, "Timeout", None)
1924 except(requests.exceptions.ConnectionError) as err:
1925 return connectionErrHandler(args.json, "ConnectionError", err)
1926 software = json.loads(resp.text)['data']
1927 #check if bmc is done processing the new image
1928 if (newversionID in getAllFWImageIDs(software)):
Justin Thalere412dc22018-01-12 16:28:24 -06001929 break
Justin Thaler22b1bb52018-03-15 13:31:32 -05001930 else:
1931 time.sleep(15)
1932
1933 #activate the new image
1934 print("Activating new image: "+newversionID)
1935 url="https://"+host+"/xyz/openbmc_project/software/"+ newversionID + "/attr/RequestedActivation"
1936 data = '{"data":"xyz.openbmc_project.Software.Activation.RequestedActivations.Active"}'
1937 try:
1938 resp = session.put(url, headers=httpHeader, data=data, verify=False, timeout=30)
1939 except(requests.exceptions.Timeout):
1940 return connectionErrHandler(args.json, "Timeout", None)
1941 except(requests.exceptions.ConnectionError) as err:
1942 return connectionErrHandler(args.json, "ConnectionError", err)
1943
1944 #wait for the activation to complete, timeout after ~1 hour
1945 i=0
1946 while i < 360:
1947 url="https://"+host+"/xyz/openbmc_project/software/"+ newversionID
1948 data = '{"data":"xyz.openbmc_project.Software.Activation.RequestedActivations.Active"}'
1949 try:
1950 resp = session.get(url, headers=httpHeader, verify=False, timeout=30)
1951 except(requests.exceptions.Timeout):
1952 return connectionErrHandler(args.json, "Timeout", None)
1953 except(requests.exceptions.ConnectionError) as err:
1954 return connectionErrHandler(args.json, "ConnectionError", err)
1955 fwInfo = json.loads(resp.text)['data']
1956 if 'Activating' not in fwInfo['Activation'] and 'Activating' not in fwInfo['RequestedActivation']:
1957 print('')
1958 break
1959 else:
1960 sys.stdout.write('.')
1961 sys.stdout.flush()
1962 time.sleep(10) #check every 10 seconds
1963 return "Firmware flash and activation completed. Please reboot the bmc and then boot the host OS for the changes to take effect. "
1964 else:
1965 print("This image has been found on the bmc. Activating image: " + newversionID)
1966
1967 d['imageID'] = newversionID
1968 return activateFWImage(host, args, session)
Justin Thalere412dc22018-01-12 16:28:24 -06001969
Justin Thaler3d71d402018-07-24 14:35:39 -05001970def getFWInventoryAttributes(rawFWInvItem, ID):
1971 """
1972 gets and lists all of the firmware in the system.
1973
1974 @return: returns a dictionary containing the image attributes
1975 """
1976 reqActivation = rawFWInvItem["RequestedActivation"].split('.')[-1]
1977 pendingActivation = ""
1978 if reqActivation == "None":
1979 pendingActivation = "No"
1980 else:
1981 pendingActivation = "Yes"
1982 firmwareAttr = {ID: {
1983 "Purpose": rawFWInvItem["Purpose"].split('.')[-1],
1984 "Version": rawFWInvItem["Version"],
1985 "RequestedActivation": pendingActivation,
1986 "ID": ID}}
1987
1988 if "ExtendedVersion" in rawFWInvItem:
1989 firmwareAttr[ID]['ExtendedVersion'] = rawFWInvItem['ExtendedVersion'].split(',')
1990 else:
1991 firmwareAttr[ID]['ExtendedVersion'] = ""
1992 return firmwareAttr
1993
1994def parseFWdata(firmwareDict):
1995 """
1996 creates a dictionary with parsed firmware data
1997
1998 @return: returns a dictionary containing the image attributes
1999 """
2000 firmwareInfoDict = {"Functional": {}, "Activated":{}, "NeedsActivated":{}}
2001 for key in firmwareDict['data']:
2002 #check for valid endpoint
2003 if "Purpose" in firmwareDict['data'][key]:
2004 id = key.split('/')[-1]
2005 if firmwareDict['data'][key]['Activation'].split('.')[-1] == "Active":
2006 fwActivated = True
2007 else:
2008 fwActivated = False
2009 if firmwareDict['data'][key]['Priority'] == 0:
2010 firmwareInfoDict['Functional'].update(getFWInventoryAttributes(firmwareDict['data'][key], id))
2011 elif firmwareDict['data'][key]['Priority'] >= 0 and fwActivated:
2012 firmwareInfoDict['Activated'].update(getFWInventoryAttributes(firmwareDict['data'][key], id))
2013 else:
2014 firmwareInfoDict['Activated'].update(getFWInventoryAttributes(firmwareDict['data'][key], id))
2015 emptySections = []
2016 for key in firmwareInfoDict:
2017 if len(firmwareInfoDict[key])<=0:
2018 emptySections.append(key)
2019 for key in emptySections:
2020 del firmwareInfoDict[key]
2021 return firmwareInfoDict
2022
2023def displayFWInvenory(firmwareInfoDict, args):
2024 """
2025 gets and lists all of the firmware in the system.
2026
2027 @return: returns a string containing all of the firmware information
2028 """
2029 output = ""
2030 if not args.json:
2031 for key in firmwareInfoDict:
2032 for subkey in firmwareInfoDict[key]:
2033 firmwareInfoDict[key][subkey]['ExtendedVersion'] = str(firmwareInfoDict[key][subkey]['ExtendedVersion'])
2034 if not args.verbose:
2035 output = "---Running Images---\n"
2036 colNames = ["Purpose", "Version", "ID"]
2037 keylist = ["Purpose", "Version", "ID"]
2038 output += tableDisplay(keylist, colNames, firmwareInfoDict["Functional"])
2039 if "Activated" in firmwareInfoDict:
2040 output += "\n---Available Images---\n"
2041 output += tableDisplay(keylist, colNames, firmwareInfoDict["Activated"])
2042 if "NeedsActivated" in firmwareInfoDict:
2043 output += "\n---Needs Activated Images---\n"
2044 output += tableDisplay(keylist, colNames, firmwareInfoDict["NeedsActivated"])
2045
2046 else:
2047 output = "---Running Images---\n"
2048 colNames = ["Purpose", "Version", "ID", "Pending Activation", "Extended Version"]
2049 keylist = ["Purpose", "Version", "ID", "RequestedActivation", "ExtendedVersion"]
2050 output += tableDisplay(keylist, colNames, firmwareInfoDict["Functional"])
2051 if "Activated" in firmwareInfoDict:
2052 output += "\n---Available Images---\n"
2053 output += tableDisplay(keylist, colNames, firmwareInfoDict["Activated"])
2054 if "NeedsActivated" in firmwareInfoDict:
2055 output += "\n---Needs Activated Images---\n"
2056 output += tableDisplay(keylist, colNames, firmwareInfoDict["NeedsActivated"])
2057 return output
2058 else:
2059 return str(json.dumps(firmwareInfoDict, sort_keys=True, indent=4, separators=(',', ': '), ensure_ascii=False))
2060
2061def firmwareList(host, args, session):
2062 """
2063 gets and lists all of the firmware in the system.
2064
2065 @return: returns a string containing all of the firmware information
2066 """
2067 httpHeader = {'Content-Type':'application/json'}
2068 url="https://{hostname}/xyz/openbmc_project/software/enumerate".format(hostname=host)
2069 try:
2070 res = session.get(url, headers=httpHeader, verify=False, timeout=40)
2071 except(requests.exceptions.Timeout):
2072 return(connectionErrHandler(args.json, "Timeout", None))
2073 firmwareDict = json.loads(res.text)
2074
2075 #sort the received information
2076 firmwareInfoDict = parseFWdata(firmwareDict)
2077
2078 #display the information
2079 return displayFWInvenory(firmwareInfoDict, args)
2080
Deepak Kodihalli22d4df02018-09-18 06:52:43 -05002081
2082def restLogging(host, args, session):
2083 """
2084 Called by the logging function. Turns REST API logging on/off.
2085
2086 @param host: string, the hostname or IP address of the bmc
2087 @param args: contains additional arguments used by the logging sub command
2088 @param session: the active session to use
2089 @param args.json: boolean, if this flag is set to true, the output will be provided in json format for programmatic consumption
2090 """
2091
2092 url="https://"+host+"/xyz/openbmc_project/logging/rest_api_logs/attr/Enabled"
2093 httpHeader = {'Content-Type':'application/json'}
2094
2095 if(args.rest_logging == 'on'):
2096 data = '{"data": 1}'
2097 elif(args.rest_logging == 'off'):
2098 data = '{"data": 0}'
2099 else:
2100 return "Invalid logging rest_api command"
2101
2102 try:
2103 res = session.put(url, headers=httpHeader, data=data, verify=False, timeout=30)
2104 except(requests.exceptions.Timeout):
2105 return(connectionErrHandler(args.json, "Timeout", None))
2106 return res.text
2107
2108
Deepak Kodihalli02d53282018-09-18 06:53:31 -05002109def remoteLogging(host, args, session):
2110 """
2111 Called by the logging function. View config information for/disable remote logging (rsyslog).
2112
2113 @param host: string, the hostname or IP address of the bmc
2114 @param args: contains additional arguments used by the logging sub command
2115 @param session: the active session to use
2116 @param args.json: boolean, if this flag is set to true, the output will be provided in json format for programmatic consumption
2117 """
2118
2119 url="https://"+host+"/xyz/openbmc_project/logging/config/remote"
2120 httpHeader = {'Content-Type':'application/json'}
2121
2122 try:
2123 if(args.remote_logging == 'view'):
2124 res = session.get(url, headers=httpHeader, verify=False, timeout=30)
2125 elif(args.remote_logging == 'disable'):
2126 res = session.put(url + '/attr/Port', headers=httpHeader, json = {"data": 0}, verify=False, timeout=30)
2127 res = session.put(url + '/attr/Address', headers=httpHeader, json = {"data": ""}, verify=False, timeout=30)
2128 else:
2129 return "Invalid logging remote_logging command"
2130 except(requests.exceptions.Timeout):
2131 return(connectionErrHandler(args.json, "Timeout", None))
2132 return res.text
2133
2134
2135def remoteLoggingConfig(host, args, session):
2136 """
2137 Called by the logging function. Configures remote logging (rsyslog).
2138
2139 @param host: string, the hostname or IP address of the bmc
2140 @param args: contains additional arguments used by the logging sub command
2141 @param session: the active session to use
2142 @param args.json: boolean, if this flag is set to true, the output will be provided in json format for programmatic consumption
2143 """
2144
2145 url="https://"+host+"/xyz/openbmc_project/logging/config/remote"
2146 httpHeader = {'Content-Type':'application/json'}
2147
2148 try:
2149 res = session.put(url + '/attr/Port', headers=httpHeader, json = {"data": args.port}, verify=False, timeout=30)
2150 res = session.put(url + '/attr/Address', headers=httpHeader, json = {"data": args.address}, verify=False, timeout=30)
2151 except(requests.exceptions.Timeout):
2152 return(connectionErrHandler(args.json, "Timeout", None))
2153 return res.text
2154
2155
Matt Spinler7d426c22018-09-24 14:42:07 -05002156def localUsers(host, args, session):
2157 """
2158 Enables and disables local BMC users.
2159
2160 @param host: string, the hostname or IP address of the bmc
2161 @param args: contains additional arguments used by the logging sub command
2162 @param session: the active session to use
2163 """
2164
2165 httpHeader = {'Content-Type':'application/json'}
2166 url="https://{hostname}/xyz/openbmc_project/user/enumerate".format(hostname=host)
2167 try:
2168 res = session.get(url, headers=httpHeader, verify=False, timeout=40)
2169 except(requests.exceptions.Timeout):
2170 return(connectionErrHandler(args.json, "Timeout", None))
2171 usersDict = json.loads(res.text)
2172
2173 if not usersDict['data']:
2174 return "No users found"
2175
2176 output = ""
2177 for user in usersDict['data']:
Matt Spinler015adc22018-10-23 14:30:19 -05002178
2179 # Skip LDAP and another non-local users
2180 if 'UserEnabled' not in usersDict['data'][user]:
2181 continue
2182
Matt Spinler7d426c22018-09-24 14:42:07 -05002183 name = user.split('/')[-1]
2184 url = "https://{hostname}{user}/attr/UserEnabled".format(hostname=host, user=user)
2185
2186 if args.local_users == "queryenabled":
2187 try:
2188 res = session.get(url, headers=httpHeader,verify=False, timeout=30)
2189 except(requests.exceptions.Timeout):
2190 return(connectionErrHandler(args.json, "Timeout", None))
2191
2192 result = json.loads(res.text)
2193 output += ("User: {name} Enabled: {result}\n").format(name=name, result=result['data'])
2194
2195 elif args.local_users in ["enableall", "disableall"]:
2196 action = ""
2197 if args.local_users == "enableall":
2198 data = '{"data": true}'
2199 action = "Enabling"
2200 else:
2201 data = '{"data": false}'
2202 action = "Disabling"
2203
2204 output += "{action} {name}\n".format(action=action, name=name)
2205
2206 try:
2207 resp = session.put(url, headers=httpHeader, data=data, verify=False, timeout=30)
2208 except(requests.exceptions.Timeout):
2209 return connectionErrHandler(args.json, "Timeout", None)
2210 except(requests.exceptions.ConnectionError) as err:
2211 return connectionErrHandler(args.json, "ConnectionError", err)
2212 else:
2213 return "Invalid local users argument"
2214
2215 return output
2216
Justin Thalerf9aee3e2017-12-05 12:11:09 -06002217def createCommandParser():
Justin Thalere412dc22018-01-12 16:28:24 -06002218 """
2219 creates the parser for the command line along with help for each command and subcommand
2220
2221 @return: returns the parser for the command line
2222 """
Justin Thalerf9aee3e2017-12-05 12:11:09 -06002223 parser = argparse.ArgumentParser(description='Process arguments')
Justin Thalere412dc22018-01-12 16:28:24 -06002224 parser.add_argument("-H", "--host", help='A hostname or IP for the BMC')
2225 parser.add_argument("-U", "--user", help='The username to login with')
Justin Thalerf9aee3e2017-12-05 12:11:09 -06002226 group = parser.add_mutually_exclusive_group()
2227 group.add_argument("-A", "--askpw", action='store_true', help='prompt for password')
2228 group.add_argument("-P", "--PW", help='Provide the password in-line')
2229 parser.add_argument('-j', '--json', action='store_true', help='output json data only')
2230 parser.add_argument('-t', '--policyTableLoc', help='The location of the policy table to parse alerts')
2231 parser.add_argument('-c', '--CerFormat', action='store_true', help=argparse.SUPPRESS)
2232 parser.add_argument('-T', '--procTime', action='store_true', help= argparse.SUPPRESS)
Justin Thalere412dc22018-01-12 16:28:24 -06002233 parser.add_argument('-V', '--version', action='store_true', help='Display the version number of the openbmctool')
2234 subparsers = parser.add_subparsers(title='subcommands', description='valid subcommands',help="sub-command help", dest='command')
Justin Thalerf9aee3e2017-12-05 12:11:09 -06002235
2236 #fru command
2237 parser_inv = subparsers.add_parser("fru", help='Work with platform inventory')
Justin Thalere412dc22018-01-12 16:28:24 -06002238 inv_subparser = parser_inv.add_subparsers(title='subcommands', description='valid inventory actions', help="valid inventory actions", dest='command')
Justin Thaler53bf2f12018-07-16 14:05:32 -05002239 inv_subparser.required = True
2240 #fru print
Justin Thalerf9aee3e2017-12-05 12:11:09 -06002241 inv_print = inv_subparser.add_parser("print", help="prints out a list of all FRUs")
2242 inv_print.set_defaults(func=fruPrint)
2243 #fru list [0....n]
2244 inv_list = inv_subparser.add_parser("list", help="print out details on selected FRUs. Specifying no items will list the entire inventory")
2245 inv_list.add_argument('items', nargs='?', help="print out details on selected FRUs. Specifying no items will list the entire inventory")
2246 inv_list.set_defaults(func=fruList)
2247 #fru status
2248 inv_status = inv_subparser.add_parser("status", help="prints out the status of all FRUs")
Justin Thalere412dc22018-01-12 16:28:24 -06002249 inv_status.add_argument('-v', '--verbose', action='store_true', help='Verbose output')
Justin Thalerf9aee3e2017-12-05 12:11:09 -06002250 inv_status.set_defaults(func=fruStatus)
Justin Thalerf9aee3e2017-12-05 12:11:09 -06002251
2252 #sensors command
2253 parser_sens = subparsers.add_parser("sensors", help="Work with platform sensors")
Justin Thalere412dc22018-01-12 16:28:24 -06002254 sens_subparser=parser_sens.add_subparsers(title='subcommands', description='valid sensor actions', help='valid sensor actions', dest='command')
Justin Thaler53bf2f12018-07-16 14:05:32 -05002255 sens_subparser.required = True
Justin Thalerf9aee3e2017-12-05 12:11:09 -06002256 #sensor print
2257 sens_print= sens_subparser.add_parser('print', help="prints out a list of all Sensors.")
2258 sens_print.set_defaults(func=sensor)
2259 #sensor list[0...n]
2260 sens_list=sens_subparser.add_parser("list", help="Lists all Sensors in the platform. Specify a sensor for full details. ")
2261 sens_list.add_argument("sensNum", nargs='?', help="The Sensor number to get full details on" )
2262 sens_list.set_defaults(func=sensor)
2263
2264
2265 #sel command
2266 parser_sel = subparsers.add_parser("sel", help="Work with platform alerts")
Justin Thalere412dc22018-01-12 16:28:24 -06002267 sel_subparser = parser_sel.add_subparsers(title='subcommands', description='valid SEL actions', help = 'valid SEL actions', dest='command')
Justin Thaler53bf2f12018-07-16 14:05:32 -05002268 sel_subparser.required = True
Justin Thalerf9aee3e2017-12-05 12:11:09 -06002269 #sel print
2270 sel_print = sel_subparser.add_parser("print", help="prints out a list of all sels in a condensed list")
2271 sel_print.add_argument('-d', '--devdebug', action='store_true', help=argparse.SUPPRESS)
2272 sel_print.add_argument('-v', '--verbose', action='store_true', help="Changes the output to being very verbose")
2273 sel_print.add_argument('-f', '--fileloc', help='Parse a file instead of the BMC output')
2274 sel_print.set_defaults(func=selPrint)
Justin Thaler22b1bb52018-03-15 13:31:32 -05002275
Justin Thalerf9aee3e2017-12-05 12:11:09 -06002276 #sel list
2277 sel_list = sel_subparser.add_parser("list", help="Lists all SELs in the platform. Specifying a specific number will pull all the details for that individual SEL")
2278 sel_list.add_argument("selNum", nargs='?', type=int, help="The SEL entry to get details on")
2279 sel_list.set_defaults(func=selList)
2280
2281 sel_get = sel_subparser.add_parser("get", help="Gets the verbose details of a specified SEL entry")
2282 sel_get.add_argument('selNum', type=int, help="the number of the SEL entry to get")
2283 sel_get.set_defaults(func=selList)
2284
2285 sel_clear = sel_subparser.add_parser("clear", help="Clears all entries from the SEL")
2286 sel_clear.set_defaults(func=selClear)
2287
2288 sel_setResolved = sel_subparser.add_parser("resolve", help="Sets the sel entry to resolved")
Justin Thalere412dc22018-01-12 16:28:24 -06002289 sel_setResolved.add_argument('-n', '--selNum', type=int, help="the number of the SEL entry to resolve")
2290 sel_ResolveAll_sub = sel_setResolved.add_subparsers(title='subcommands', description='valid subcommands',help="sub-command help", dest='command')
2291 sel_ResolveAll = sel_ResolveAll_sub.add_parser('all', help='Resolve all SEL entries')
2292 sel_ResolveAll.set_defaults(func=selResolveAll)
Justin Thalerf9aee3e2017-12-05 12:11:09 -06002293 sel_setResolved.set_defaults(func=selSetResolved)
2294
2295 parser_chassis = subparsers.add_parser("chassis", help="Work with chassis power and status")
Justin Thalere412dc22018-01-12 16:28:24 -06002296 chas_sub = parser_chassis.add_subparsers(title='subcommands', description='valid subcommands',help="sub-command help", dest='command')
Justin Thalerf9aee3e2017-12-05 12:11:09 -06002297
2298 parser_chassis.add_argument('status', action='store_true', help='Returns the current status of the platform')
2299 parser_chassis.set_defaults(func=chassis)
2300
2301 parser_chasPower = chas_sub.add_parser("power", help="Turn the chassis on or off, check the power state")
Justin Thalere412dc22018-01-12 16:28:24 -06002302 parser_chasPower.add_argument('powcmd', choices=['on','softoff', 'hardoff', 'status'], help='The value for the power command. on, off, or status')
Justin Thalerf9aee3e2017-12-05 12:11:09 -06002303 parser_chasPower.set_defaults(func=chassisPower)
2304
2305 #control the chassis identify led
2306 parser_chasIdent = chas_sub.add_parser("identify", help="Control the chassis identify led")
2307 parser_chasIdent.add_argument('identcmd', choices=['on', 'off', 'status'], help='The control option for the led: on, off, blink, status')
2308 parser_chasIdent.set_defaults(func=chassisIdent)
2309
2310 #collect service data
2311 parser_servData = subparsers.add_parser("collect_service_data", help="Collect all bmc data needed for service")
2312 parser_servData.add_argument('-d', '--devdebug', action='store_true', help=argparse.SUPPRESS)
2313 parser_servData.set_defaults(func=collectServiceData)
2314
Justin Thalere412dc22018-01-12 16:28:24 -06002315 #system quick health check
2316 parser_healthChk = subparsers.add_parser("health_check", help="Work with platform sensors")
2317 parser_healthChk.set_defaults(func=healthCheck)
2318
Justin Thalerf9aee3e2017-12-05 12:11:09 -06002319 #work with bmc dumps
2320 parser_bmcdump = subparsers.add_parser("dump", help="Work with bmc dump files")
Justin Thalere412dc22018-01-12 16:28:24 -06002321 bmcDump_sub = parser_bmcdump.add_subparsers(title='subcommands', description='valid subcommands',help="sub-command help", dest='command')
Justin Thaler53bf2f12018-07-16 14:05:32 -05002322 bmcDump_sub.required = True
Justin Thalerf9aee3e2017-12-05 12:11:09 -06002323 dump_Create = bmcDump_sub.add_parser('create', help="Create a bmc dump")
2324 dump_Create.set_defaults(func=bmcDumpCreate)
2325
Justin Thalerf9aee3e2017-12-05 12:11:09 -06002326 dump_list = bmcDump_sub.add_parser('list', help="list all bmc dump files")
2327 dump_list.set_defaults(func=bmcDumpList)
2328
2329 parserdumpdelete = bmcDump_sub.add_parser('delete', help="Delete bmc dump files")
2330 parserdumpdelete.add_argument("-n", "--dumpNum", nargs='*', type=int, help="The Dump entry to delete")
Justin Thalerf9aee3e2017-12-05 12:11:09 -06002331 parserdumpdelete.set_defaults(func=bmcDumpDelete)
2332
Justin Thalere412dc22018-01-12 16:28:24 -06002333 bmcDumpDelsub = parserdumpdelete.add_subparsers(title='subcommands', description='valid subcommands',help="sub-command help", dest='command')
Justin Thalerf9aee3e2017-12-05 12:11:09 -06002334 deleteAllDumps = bmcDumpDelsub.add_parser('all', help='Delete all bmc dump files')
2335 deleteAllDumps.set_defaults(func=bmcDumpDeleteAll)
2336
2337 parser_dumpretrieve = bmcDump_sub.add_parser('retrieve', help='Retrieve a dump file')
2338 parser_dumpretrieve.add_argument("dumpNum", type=int, help="The Dump entry to delete")
2339 parser_dumpretrieve.add_argument("-s", "--dumpSaveLoc", help="The location to save the bmc dump file")
2340 parser_dumpretrieve.set_defaults(func=bmcDumpRetrieve)
2341
Justin Thaler22b1bb52018-03-15 13:31:32 -05002342 #bmc command for reseting the bmc
Justin Thalerf9aee3e2017-12-05 12:11:09 -06002343 parser_bmc = subparsers.add_parser('bmc', help="Work with the bmc")
Justin Thalere412dc22018-01-12 16:28:24 -06002344 bmc_sub = parser_bmc.add_subparsers(title='subcommands', description='valid subcommands',help="sub-command help", dest='command')
Justin Thalerf9aee3e2017-12-05 12:11:09 -06002345 parser_BMCReset = bmc_sub.add_parser('reset', help='Reset the bmc' )
2346 parser_BMCReset.add_argument('type', choices=['warm','cold'], help="Warm: Reboot the BMC, Cold: CLEAR config and reboot bmc")
Justin Thalerf9aee3e2017-12-05 12:11:09 -06002347 parser_bmc.add_argument('info', action='store_true', help="Displays information about the BMC hardware, including device revision, firmware revision, IPMI version supported, manufacturer ID, and information on additional device support.")
2348 parser_bmc.set_defaults(func=bmc)
Justin Thalerf9aee3e2017-12-05 12:11:09 -06002349
2350 #add alias to the bmc command
2351 parser_mc = subparsers.add_parser('mc', help="Work with the management controller")
Justin Thalere412dc22018-01-12 16:28:24 -06002352 mc_sub = parser_mc.add_subparsers(title='subcommands', description='valid subcommands',help="sub-command help", dest='command')
Justin Thalerf9aee3e2017-12-05 12:11:09 -06002353 parser_MCReset = mc_sub.add_parser('reset', help='Reset the bmc' )
2354 parser_MCReset.add_argument('type', choices=['warm','cold'], help="Reboot the BMC")
2355 #parser_MCReset.add_argument('cold', action='store_true', help="Reboot the BMC and CLEAR the configuration")
2356 parser_mc.add_argument('info', action='store_true', help="Displays information about the BMC hardware, including device revision, firmware revision, IPMI version supported, manufacturer ID, and information on additional device support.")
Justin Thalere412dc22018-01-12 16:28:24 -06002357 parser_MCReset.set_defaults(func=bmcReset)
Justin Thalerf9aee3e2017-12-05 12:11:09 -06002358 parser_mc.set_defaults(func=bmc)
Justin Thalere412dc22018-01-12 16:28:24 -06002359
2360 #gard clear
2361 parser_gc = subparsers.add_parser("gardclear", help="Used to clear gard records")
2362 parser_gc.set_defaults(func=gardClear)
2363
2364 #firmware_flash
2365 parser_fw = subparsers.add_parser("firmware", help="Work with the system firmware")
2366 fwflash_subproc = parser_fw.add_subparsers(title='subcommands', description='valid firmware commands', help='sub-command help', dest='command')
Justin Thaler53bf2f12018-07-16 14:05:32 -05002367 fwflash_subproc.required = True
2368
Justin Thalere412dc22018-01-12 16:28:24 -06002369 fwflash = fwflash_subproc.add_parser('flash', help="Flash the system firmware")
2370 fwflash.add_argument('type', choices=['bmc', 'pnor'], help="image type to flash")
2371 fwflash.add_argument('-f', '--fileloc', required=True, help="The absolute path to the firmware image")
2372 fwflash.set_defaults(func=fwFlash)
2373
Justin Thaler22b1bb52018-03-15 13:31:32 -05002374 fwActivate = fwflash_subproc.add_parser('activate', help="Activate existing image on the bmc")
Justin Thalere412dc22018-01-12 16:28:24 -06002375 fwActivate.add_argument('imageID', help="The image ID to activate from the firmware list. Ex: 63c95399")
2376 fwActivate.set_defaults(func=activateFWImage)
2377
Justin Thaler22b1bb52018-03-15 13:31:32 -05002378 fwActivateStatus = fwflash_subproc.add_parser('activation_status', help="Check Status of activations")
2379 fwActivateStatus.set_defaults(func=activateStatus)
2380
Justin Thaler3d71d402018-07-24 14:35:39 -05002381 fwList = fwflash_subproc.add_parser('list', help="List all of the installed firmware")
2382 fwList.add_argument('-v', '--verbose', action='store_true', help='Verbose output')
2383 fwList.set_defaults(func=firmwareList)
2384
2385 fwprint = fwflash_subproc.add_parser('print', help="List all of the installed firmware")
2386 fwprint.add_argument('-v', '--verbose', action='store_true', help='Verbose output')
2387 fwprint.set_defaults(func=firmwareList)
Justin Thaler22b1bb52018-03-15 13:31:32 -05002388
Deepak Kodihalli22d4df02018-09-18 06:52:43 -05002389 #logging
2390 parser_logging = subparsers.add_parser("logging", help="logging controls")
2391 logging_sub = parser_logging.add_subparsers(title='subcommands', description='valid subcommands',help="sub-command help", dest='command')
2392
2393 #turn rest api logging on/off
2394 parser_rest_logging = logging_sub.add_parser("rest_api", help="turn rest api logging on/off")
2395 parser_rest_logging.add_argument('rest_logging', choices=['on', 'off'], help='The control option for rest logging: on, off')
2396 parser_rest_logging.set_defaults(func=restLogging)
Deepak Kodihalli02d53282018-09-18 06:53:31 -05002397
2398 #remote logging
2399 parser_remote_logging = logging_sub.add_parser("remote_logging", help="Remote logging (rsyslog) commands")
2400 parser_remote_logging.add_argument('remote_logging', choices=['view', 'disable'], help='Remote logging (rsyslog) commands')
2401 parser_remote_logging.set_defaults(func=remoteLogging)
2402
2403 #configure remote logging
2404 parser_remote_logging_config = logging_sub.add_parser("remote_logging_config", help="Configure remote logging (rsyslog)")
2405 parser_remote_logging_config.add_argument("-a", "--address", required=True, help="Set IP address of rsyslog server")
2406 parser_remote_logging_config.add_argument("-p", "--port", required=True, type=int, help="Set Port of rsyslog server")
2407 parser_remote_logging_config.set_defaults(func=remoteLoggingConfig)
Deepak Kodihalli22d4df02018-09-18 06:52:43 -05002408
Matt Spinler7d426c22018-09-24 14:42:07 -05002409 # local users
2410 parser_users = subparsers.add_parser("local_users", help="Work with local users")
2411 parser_users.add_argument('local_users', choices=['disableall','enableall', 'queryenabled'], help="Disable, enable or query local user accounts")
2412 parser_users.add_argument('-v', '--verbose', action='store_true', help='Verbose output')
2413 parser_users.set_defaults(func=localUsers)
2414
Justin Thalerf9aee3e2017-12-05 12:11:09 -06002415 return parser
2416
Justin Thalerf9aee3e2017-12-05 12:11:09 -06002417def main(argv=None):
Justin Thalere412dc22018-01-12 16:28:24 -06002418 """
2419 main function for running the command line utility as a sub application
2420 """
Justin Thaler22b1bb52018-03-15 13:31:32 -05002421 global toolVersion
Matt Spinler7d426c22018-09-24 14:42:07 -05002422 toolVersion = "1.08"
Justin Thalerf9aee3e2017-12-05 12:11:09 -06002423 parser = createCommandParser()
Justin Thalerf9aee3e2017-12-05 12:11:09 -06002424 args = parser.parse_args(argv)
Justin Thalerf9aee3e2017-12-05 12:11:09 -06002425
2426 totTimeStart = int(round(time.time()*1000))
2427
2428 if(sys.version_info < (3,0)):
2429 urllib3.disable_warnings(urllib3.exceptions.InsecureRequestWarning)
2430 if sys.version_info >= (3,0):
2431 requests.packages.urllib3.disable_warnings(requests.packages.urllib3.exceptions.InsecureRequestWarning)
Justin Thalere412dc22018-01-12 16:28:24 -06002432 if (args.version):
Justin Thaler22b1bb52018-03-15 13:31:32 -05002433 print("Version: "+ toolVersion)
Justin Thalere412dc22018-01-12 16:28:24 -06002434 sys.exit(0)
2435 if (hasattr(args, 'fileloc') and args.fileloc is not None and 'print' in args.command):
Justin Thalerf9aee3e2017-12-05 12:11:09 -06002436 mysess = None
Justin Thalere412dc22018-01-12 16:28:24 -06002437 print(selPrint('N/A', args, mysess))
Justin Thalerf9aee3e2017-12-05 12:11:09 -06002438 else:
Justin Thalere412dc22018-01-12 16:28:24 -06002439 if(hasattr(args, 'host') and hasattr(args,'user')):
2440 if (args.askpw):
2441 pw = getpass.getpass()
2442 elif(args.PW is not None):
2443 pw = args.PW
2444 else:
2445 print("You must specify a password")
2446 sys.exit()
2447 logintimeStart = int(round(time.time()*1000))
2448 mysess = login(args.host, args.user, pw, args.json)
Justin Thalera9415b42018-05-25 19:40:13 -05002449 if(sys.version_info < (3,0)):
2450 if isinstance(mysess, basestring):
2451 print(mysess)
2452 sys.exit(1)
2453 elif sys.version_info >= (3,0):
2454 if isinstance(mysess, str):
2455 print(mysess)
2456 sys.exit(1)
Justin Thalere412dc22018-01-12 16:28:24 -06002457 logintimeStop = int(round(time.time()*1000))
2458
2459 commandTimeStart = int(round(time.time()*1000))
2460 output = args.func(args.host, args, mysess)
2461 commandTimeStop = int(round(time.time()*1000))
2462 print(output)
2463 if (mysess is not None):
2464 logout(args.host, args.user, pw, mysess, args.json)
2465 if(args.procTime):
2466 print("Total time: " + str(int(round(time.time()*1000))- totTimeStart))
2467 print("loginTime: " + str(logintimeStop - logintimeStart))
2468 print("command Time: " + str(commandTimeStop - commandTimeStart))
2469 else:
2470 print("usage: openbmctool.py [-h] -H HOST -U USER [-A | -P PW] [-j]\n" +
2471 "\t[-t POLICYTABLELOC] [-V]\n" +
Deepak Kodihalli22d4df02018-09-18 06:52:43 -05002472 "\t{fru,sensors,sel,chassis,collect_service_data, \
2473 health_check,dump,bmc,mc,gardclear,firmware,logging}\n" +
Justin Thalere412dc22018-01-12 16:28:24 -06002474 "\t...\n" +
2475 "openbmctool.py: error: the following arguments are required: -H/--host, -U/--user")
2476 sys.exit()
Justin Thalerf9aee3e2017-12-05 12:11:09 -06002477
Justin Thalerf9aee3e2017-12-05 12:11:09 -06002478if __name__ == '__main__':
Justin Thalere412dc22018-01-12 16:28:24 -06002479 """
2480 main function when called from the command line
2481
2482 """
Justin Thalerf9aee3e2017-12-05 12:11:09 -06002483 import sys
2484
2485 isTTY = sys.stdout.isatty()
2486 assert sys.version_info >= (2,7)
2487 main()