openbmc-test-automation/docs/openbmc_test_tools.md

8     $ ipmitool -V
16 [README](https://github.com/open-power/HTX)
21 [README](https://github.com/openbmc/phosphor-logging/blob/master/README.md#remote-logging-via-rsysl…
25 Pre-requisite: A Power Linux system is required.
27 - Obtain the SEL (System Error Log) parser tools:
29   - Go to https://openpower.xyz/job/openpower/job/openpower-op-build/
30   - Click the link for the BMC system of interest (e.g. witherspoon)
31   - Click the "host_fw_debug.tar" link in order to download the tar file.
32   - On your Power Linux system, untar the file with the following command:
35   $ tar -xvf host_fw_debug.tar
38   - Rename the untarred files with:
46 - The error log binary parser is also required:
48   - Go to https://sourceforge.net/projects/linux-diag/files/ppc64-diag/
49   - Download the latest release version of the source tar zipped.
50   - Extract the tarball and compile. Refer to README in the source.
51   - On successful compilation, get `opal-elog-parse` binary.
53 - To generate a readable error log from binary SEL data:
64   $ eSEL.pl -l SEL_data -p decode_obmc_data --op
67   where `SEL_data` is the file containing SEL binary data and option "--op" will
68   refer "opal-elog-parse" instead or errl.
70   The output file `SEL_data.txt` contains the readable error log (SEL) data.
72 ## The opal-prd Tool:
74 opal-prd is a tool used by the Energy Scale and RAS tests. It should be
75 installed on the OS of the system under test before running those tests.
77 opal-prd may be installed on Ubuntu with: `apt install opal-prd` and on RedHat
78 with: `yum install opal-prd`
97 Example for getting openbmc-test-automation issues:
100 $ python github_issues_to_csv <github user>  openbmc/openbmc-test-automation
124 ## Non-Volatile Memory Express Command Line Interface (nvme-cli):
126 nvme-cli is a linux command line tool for accessing Non-Volatile Storage (NVM)
129 Source: https://github.com/linux-nvme/nvme-cli
131 To install nvme-cli on RedHat:
134 yum install name-cli
137 To install nvme-cli on Ubuntu:
140 sudo apt-get install nvme-cli
143 - Obtaining the PPA for Ubuntu
144   - Add the sbates PPA to your sources:
152 To install hdparm on RedHat:
158 To install hdparm on Ubuntu:
161 sudo apt-get update
162 sudo apt-get install hdparm
167 OpenSSL is an open-source command line tool that is commonly used to generate
170 To generate a self-signed certificate with a private key:
173 …q -x509 -sha256 -newkey rsa:2048 -nodes -days <number of days a certificate is valid for> -keyout …
179 openssl req -x509 -sha256 -newkey rsa:2048 -nodes -days 365 -keyout certificate.pem -out certificat…
182 To view installed certificates on a OpenBMC system:
185 openssl s_client -connect <BMC_IP>:443 -showcerts
194 peltool is an open-source platform event log(PEL) tool generally used to view
195 and delete pel logs that are generated on the BMC system. Also, provides various
196 pel related operations as mentioned in the 'peltool --help'.
199  peltool -h
204   --help                      Print this help message and exit
205   --file TEXT                 Display a PEL using its Raw PEL file
206   -i,--id TEXT                Display a PEL based on its ID
207   --bmc-id TEXT               Display a PEL based on its BMC Event ID
208   -a                          Display all PELs
209   -l                          List PELs
210   -n                          Show number of PELs
211   -r                          Reverse order of output
212   -h                          Include hidden PELs
213   -f,--info                   Include informational PELs
214   -t,--termination            List only critical system terminating PELs
215   -d,--delete TEXT            Delete a PEL based on its ID
216   -D,--delete-all             Delete all PELs
217   -s,--scrub TEXT             File containing SRC regular expressions to ignore
218   -x                          Display PEL(s) in hexdump instead of JSON
219   --archive                   List or display archived PELs
224 guard tool on BMC provides an option to create, view and delete the faulty
225 units. Refer to [README](https://github.com/open-power/guard#readme)
229 pldmtool is an open-source client tool that acts as a PLDM requester which runs
230 on the BMC. pldmtool supports the subcommands for PLDM types such as base,
231 platform, bios, fru, and oem-ibm as mentioned in the 'pldmtool --help'. Refer to
238 [VPD TOOL README](https://github.com/openbmc/openpower-vpd-parser/blob/master/vpd-tool/README.md)