Run openbmctool data collection tool on Win10 and macOS

Steps

 1. Download file ‘openbmctool-x.xx.zip’

A) Go to IBM website:

https://www.ibm.com/support/pages/node/6125409

B) Scroll down to section “IBM OpenBMC tool”, download the up-to-date version of openbmctool-x.xx.zip file for "other operating systems".

For example:

C) Unpack the zip file. There are two files "openbmctool.py" and "policyTable.json" included in this zip file.

2021/06/19  10:30           244,408 openbmctool.py
2021/06/19  10:30         1,064,641 policyTable.json

2. Download and install python3

Python3 is required by IBM OpenBMC Tool. Python2 doesn’t work here.

A) Download up-to-date version of python3, go to weblink:

https://www.python.org/downloads/

For example:

Get this file:

B) Double-click the executable file python-x.x.x-amd64.exe to start the installation wizard, select the option “Install Now”, also check the “Install launcher for all users(recommended)” & “Add Python 3.9 to PATH”.

C) Setup is in progress

D) Select the option “Disable path length limit” and setup is completed.

 3. Check the python version

A) Open a new Win10 CMD window. DO NOT use the previously existed CMD window.

Run command ‘python’. You will see the version information of python3, which indicates that python3 has been installed successfully.

For example:

D:\openbmctool-1.19>python
Python 3.9.5 (tags/v3.9.5:0a7dcbd, May  3 2021, 17:27:52) [MSC v.1928 64 bit (AMD64)] on win32
Type "help", "copyright", "credits" or "license" for more information.
>>> exit()

B) Install two python modules 'requests' and ‘simplejson' by command pip3. These two python modules are not installed by default but required by IBM OpenBMC Tool.

  pip3 install requests
  pip3 install simplejson

4. Run script openbmctool.py

Go to the folder where the "openbmctool-x.xx.zip" file was previously unpacked, run script openbmctool.py. If you see the message “You must specify a password”, that indicates the IBM OpenBMC Tool works now.

D:\openbmctool-1.19>openbmctool.py
You must specify a password

5. Use IBM OpenBMC Tool to collect BMC service data

Connect your Win10 laptop to the BMC port directly or through the customer’s network switch. Ensure that pinging to BMC’s IP address is successful.

A) To view log entries:

openbmctool.py -H <bmc IP> or <bmc hostname> -U <username> -P <password> sel print

 B) To collect service data from the BMC:

openbmctool.py -H <bmc IP> or <bmc hostname> -U <username> -P <password> collect_service_data

 For example:

D:\openbmctool-1.19>openbmctool.py -U root -P abcd1234 -H 192.168.10.10  collect_service_data
Attempting login...
Inventory collected and stored in
D:\openbmctool-1.19\192.168.10.10--2021-06-19_11.17.48\inventory.txt
Sensor readings collected and stored in
D:\openbmctool-1.19\192.168.10.10--2021-06-19_11.17.48\sensorReadings.txt
LED status collected and stored in
D:\openbmctool-1.19\192.168.10.10--2021-06-19_11.17.48\ledStatus.txt
SEL short list collected and stored in
D:\openbmctool-1.19\192.168.10.10--2021-06-19_11.17.48\SELshortlist.txt
Parsed SELs collected and stored in
D:\openbmctool-1.19\192.168.10.10--2021-06-19_11.17.48\parsedSELs.txt
Attempting to get a full BMC enumeration
RAW BMC data collected and saved into
D:\openbmctool-1.19\192.168.10.10--2021-06-19_11.17.48\bmcFullRaw.txt
Waiting for new BMC dump to finish being created. Wait time could be up to 5 minutes
Timed out waiting for bmc to make a new dump file. Continuing without it.
Collecting bmc dump files
OpenBMC tool runtime errors collected and stored in
D:\openbmctool-1.19\192.168.10.10--2021-06-19_11.17.48\openbmctoolRuntimeErrors.txt
Zip file with all collected data created and stored in:
D:\openbmctool-1.19\192.168.10.10--2021-06-19_11.17.48\192.168.10.10--2021-06-19_11.17.48_1.19_openbmc.zip
Data collection finished

2021/06/03  17:33             5,852 9.197.40.230-dump1.tar.xz
2021/06/03  17:33           145,172 9.197.40.230-dump10.tar.xz
2021/06/03  17:33           179,760 9.197.40.230-dump11.tar.xz
2021/06/03  17:33           194,648 9.197.40.230-dump12.tar.xz
2021/06/03  17:33             1,752 9.197.40.230-dump13.tar.xz
2021/06/03  17:33            13,264 9.197.40.230-dump14.tar.xz
2021/06/03  17:33            13,168 9.197.40.230-dump15.tar.xz
2021/06/03  17:33            10,652 9.197.40.230-dump16.tar.xz
2021/06/03  17:34             5,520 9.197.40.230-dump8.tar.xz
2021/06/03  17:34           109,656 9.197.40.230-dump9.tar.xz
2021/06/03  17:28           113,091 bmcFullRaw.txt
2021/06/03  17:28            35,849 inventory.txt
2021/06/03  17:28             4,179 ledStatus.txt
2021/06/03  17:34               270 openbmctoolRuntimeErrors.txt
2021/06/03  17:28                 0 parsedSELs.txt
2021/06/03  17:28                20 SELshortlist.txt
2021/06/03  17:28            10,560 sensorReadings.txt

python3 openbmctool.py -H <bmc IP> or <bmc hostname> -U <username> -P <password> chassis power status

MacBook-Pro:openbmctool-1.19 joe$ ls -l
total 4216
-rwxrwxr-x@  1 joe  staff   244408  5 13  2020 openbmctool.py
-rw-rw-r--@  1 joe  staff  1064641  4  6  2020 policyTable.json
MacBook-Pro:openbmctool-1.19 joe$ python3 ./openbmctool.py
You must specify a password
MacBook-Pro:openbmctool-1.19 joe$