openbmc-test-automation/docs/openbmc_test_tools.md

8     $ ipmitool -V
14 HTX is a suite of test tools for stressing system hardware. It is routinely used
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:
28   - Go to https://openpower.xyz/job/openpower/job/openpower-op-build/
29   - Click the link for the BMC system of interest (e.g. witherspoon)
30   - Click the "host_fw_debug.tar" link in order to download the tar file.
31   - On your Power Linux system, untar the file with the following command:
34   $ tar -xvf host_fw_debug.tar
37   - Rename the untarred files with:
45 - The error log binary parser is also required:
46   - Go to https://sourceforge.net/projects/linux-diag/files/ppc64-diag/
47   - Download the latest release version of the source tar zipped.
48   - Extract the tarball and compile. Refer to README in the source.
49   - On successful compilation, get `opal-elog-parse` binary.
51 - To generate a readable error log from binary SEL data:
62   $ eSEL.pl -l SEL_data -p decode_obmc_data --op
65   where `SEL_data` is the file containing SEL binary data and option "--op" will
66   refer "opal-elog-parse" instead or errl.
70 ## The opal-prd Tool:
72 opal-prd is a tool used by the Energy Scale and RAS tests. It should be
73 installed on the OS of the system under test before running those tests.
75 opal-prd may be installed on Ubuntu with: `apt install opal-prd` and on RedHat
76 with: `yum install opal-prd`
95 Example for getting openbmc-test-automation issues:
98 $ python github_issues_to_csv <github user>  openbmc/openbmc-test-automation
122 ## Non-Volatile Memory Express Command Line Interface (nvme-cli):
124 nvme-cli is a linux command line tool for accessing Non-Volatile Storage (NVM)
127 Source: https://github.com/linux-nvme/nvme-cli
129 To install nvme-cli on RedHat:
132 yum install name-cli
135 To install nvme-cli on Ubuntu:
138 sudo apt-get install nvme-cli
141 - Obtaining the PPA for Ubuntu
142   - Add the sbates PPA to your sources:
143     https://launchpad.net/~sbates/+archive/ubuntu/ppa
156 To install hdparm on Ubuntu:
159 sudo apt-get update
160 sudo apt-get install hdparm
165 OpenSSL is an open-source command line tool that is commonly used to generate
168 To generate a self-signed certificate with a private key:
171 …q -x509 -sha256 -newkey rsa:2048 -nodes -days <number of days a certificate is valid for> -keyout …
177 openssl req -x509 -sha256 -newkey rsa:2048 -nodes -days 365 -keyout certificate.pem -out certificat…
180 To view installed certificates on a OpenBMC system:
183 openssl s_client -connect <BMC_IP>:443 -showcerts
192 peltool is an open-source platform event log(PEL) tool generally used to view
193 and delete pel logs that are generated on the BMC system. Also, provides various
194 pel related operations as mentioned in the 'peltool --help'.
197  peltool -h
202   --help                      Print this help message and exit
203   --file TEXT                 Display a PEL using its Raw PEL file
204   -i,--id TEXT                Display a PEL based on its ID
205   --bmc-id TEXT               Display a PEL based on its BMC Event ID
206   -a                          Display all PELs
207   -l                          List PELs
208   -n                          Show number of PELs
209   -r                          Reverse order of output
210   -h                          Include hidden PELs
211   -f,--info                   Include informational PELs
212   -t,--termination            List only critical system terminating PELs
213   -d,--delete TEXT            Delete a PEL based on its ID
214   -D,--delete-all             Delete all PELs
215   -s,--scrub TEXT             File containing SRC regular expressions to ignore
216   -x                          Display PEL(s) in hexdump instead of JSON
217   --archive                   List or display archived PELs
223 units. Refer to [README](https://github.com/open-power/guard#readme)
227 pldmtool is an open-source client tool that acts as a PLDM requester which runs
229 platform, bios, fru, and oem-ibm as mentioned in the 'pldmtool --help'. Refer to
234 VPD tool is designed for managing BMC system FRU's Vital Product Data(VPD). It
236 [VPD TOOL README](https://github.com/openbmc/openpower-vpd-parser/blob/master/vpd-tool/README.md)