xref: /openbmc/openbmc-test-automation/ffdc/ffdc_config.yaml (revision 037407d32b7ca72f455e7daf70bf8db5502ddd0c)
1---
2# This yaml formatted file contains defaults items to collect FFDC for the targeted system
3# COMMANDS - List of commands to be run on the corresponding targeted system (inband)
4#            to generate and/or collect data
5# FILES    - List of files; with complete path; on the corresponding targeted system
6#            to be copied to external destination
7# PROTOCOL - Protocol used to communicate with targeted system; ssh, Rest, redfish, etc
8#
9# Note: Items in COMMANDS and FILES are not necessarily one-to-one correspondence.
10#       For example, a file could have been created by an internal process,
11#       and is listed in FILES to be collected.
12#
13# Note: When a new remote type is added to this configuration file,
14#       it is also need to be added the list of supported OSes in ffdc_lollector.py
15
16# Commands and Files to collect for a given OpenBMC system.
17OPENBMC:
18    COMMANDS:
19        - 'cat /sys/class/watchdog/watchdog1/bootstatus >/tmp/BMC_flash_side.txt 2>&1'
20        - 'grep -r . /sys/class/hwmon/* >/tmp/BMC_hwmon.txt 2>&1'
21        - 'top -n 1 -b >/tmp/BMC_proc_list.txt 2>&1'
22        - 'ls -Al /proc/*/fd/ >/tmp/BMC_proc_fd_active_list.txt 2>&1'
23        - 'journalctl --no-pager >/tmp/BMC_journalctl_nopager.txt 2>&1'
24        - 'journalctl -o json-pretty >/tmp/BMC_journalctl_pretty.json 2>&1'
25        - 'dmesg >/tmp/BMC_dmesg.txt 2>&1'
26        - 'cat /proc/cpuinfo >/tmp/BMC_procinfo.txt 2>&1'
27        - 'cat /proc/meminfo >/tmp/BMC_meminfo.txt 2>&1'
28        - 'systemctl status --all >/tmp/BMC_systemd.txt 2>&1'
29        - 'systemctl list-units --failed >/tmp/BMC_failed_service.txt 2>&1'
30        - 'systemctl list-jobs >/tmp/BMC_list_service.txt 2>&1'
31        - 'cat /var/log/obmc-console.log >/tmp/BMC_obmc_console.txt 2>&1'
32        - 'cat /var/log/obmc-console1.log >/tmp/BMC_obmc_console1.txt 2>&1'
33        - 'peltool -l >/tmp/PEL_logs_list.json 2>&1'
34        - 'peltool -a >/tmp/PEL_logs_display.json 2>&1'
35    FILES:
36        - '/tmp/BMC_flash_side.txt'
37        - '/tmp/BMC_hwmon.txt'
38        - '/tmp/BMC_proc_list.txt'
39        - '/tmp/BMC_proc_fd_active_list.txt'
40        - '/tmp/BMC_journalctl_nopager.txt'
41        - '/tmp/BMC_journalctl_pretty.json'
42        - '/tmp/BMC_dmesg.txt'
43        - '/tmp/BMC_procinfo.txt'
44        - '/tmp/BMC_meminfo.txt'
45        - '/tmp/BMC_systemd.txt'
46        - '/tmp/BMC_failed_service.txt'
47        - '/tmp/BMC_list_service.txt'
48        - '/tmp/BMC_obmc_console.txt'
49        - '/tmp/BMC_obmc_console1.txt'
50        - '/tmp/PEL_logs_list.json'
51        - '/tmp/PEL_logs_display.json'
52    PROTOCOL:
53        - 'SSH'
54
55# Commands and Files to collect for all Linux distributions
56LINUX:
57    COMMANDS:
58        - 'cat /sys/firmware/opal/msglog >/tmp/OS_msglog.txt 2>&1'
59        - 'ppc64_cpu --frequency >/tmp/OS_cpufrequency.txt 2>&1'
60        - 'dmesg >/tmp/OS_dmesg.txt 2>&1'
61        - 'cat /var/log/opal-prd* >/tmp/OS_opal_prd.txt 2>&1'
62        - 'cat /var/log/boot.log >/tmp/OS_boot.txt 2>&1'
63        - 'cat /proc/cpuinfo >/tmp/OS_procinfo.txt 2>&1'
64        - 'cat /proc/meminfo >/tmp/OS_meminfo.txt 2>&1'
65        - 'netstat -a >/tmp/OS_netstat.txt 2>&1'
66        - 'lspci >/tmp/OS_lspci.txt 2>&1'
67        - 'lscpu >/tmp/OS_lscpu.txt 2>&1'
68        - 'lscfg >/tmp/OS_lscfg.txt 2>&1'
69        - 'journalctl --no-pager -b > /tmp/OS_journalctl_nopager.txt  2>&1'
70    FILES:
71        - '/tmp/OS_msglog.txt'
72        - '/tmp/OS_cpufrequency.txt'
73        - '/tmp/OS_dmesg.txt'
74        - '/tmp/OS_opal_prd.txt'
75        - '/tmp/OS_boot.txt'
76        - '/tmp/OS_procinfo.txt'
77        - '/tmp/OS_meminfo.txt'
78        - '/tmp/OS_netstat.txt'
79        - '/tmp/OS_lspci.txt'
80        - '/tmp/OS_lscpu.txt'
81        - '/tmp/OS_lscfg.txt'
82        - '/tmp/OS_journalctl_nopager.txt'
83    PROTOCOL:
84        - 'SSH'
85
86# Commands and Files to collect for Ubuntu Linux only
87UBUNTU:
88    COMMANDS:
89        - '{ lsusb -t ; lsusb -v ; } >/tmp/OS_isub.txt 2>&1'
90        - 'tail -n 50000 /var/log/kern.log >/tmp/OS_kern.txt 2>&1'
91        - '{ cat /var/log/auth.log; cat /var/log/auth.log.1 ; } >/tmp/OS_authlog.txt 2>&1'
92        - 'tail -n 200000 /var/log/syslog >/tmp/OS_syslog.txt 2>&1'
93        - '{ uname -a; dpkg -s opal-prd; dpkg -s ipmitool ; } >/tmp/OS_info.txt 2>&1'
94        - 'rm -rf /tmp/sosreport*FFDC*'
95        - 'sosreport --batch --tmp-dir /tmp --ticket-number FFDC >/tmp/OS_sosreport.txt 2>&1'
96    FILES:
97        - '/tmp/OS_isub.txt'
98        - '/tmp/OS_kern.txt'
99        - '/tmp/OS_authlog.txt'
100        - '/tmp/OS_syslog.txt'
101        - '/tmp/OS_info.txt'
102        - '/tmp/OS_sosreport.txt'
103    PROTOCOL:
104        - 'SSH'
105
106# Commands and Files to collect for RHE Linux only
107RHEL:
108    COMMANDS:
109        - '/usr/bin/ctversion -bv >/tmp/OS_rsct.txt 2>&1'
110        - 'cat /var/log/secure >/tmp/OS_secure.txt 2>&1'
111        - 'tail -n 200000 /var/log/messages >/tmp/OS_syslog.txt 2>&1'
112        - '{ lsb_release -a; cat /etc/redhat-release; uname -a; rpm -qa ; } >/tmp/OS_info.txt 2>&1'
113        - 'rm -rf /tmp/sosreport*FFDC*'
114        - 'sosreport --batch --tmp-dir /tmp --label FFDC >/tmp/OS_sosreport.txt 2>&1'
115    FILES:
116        - '/tmp/OS_rsct.txt'
117        - '/tmp/OS_secure.txt'
118        - '/tmp/OS_syslog.txt'
119        - '/tmp/OS_info.txt'
120        - '/tmp/OS_sosreport.txt'
121    PROTOCOL:
122        - 'SSH'
123
124# Commands and Files to collect for AIX only
125AIX:
126    COMMANDS:
127        - 'errpt >/tmp/OS_errpt.txt 2>&1 ; errclear 0;'
128        - 'bindprocessor -q >/tmp/OS_processors.txt 2>&1'
129    FILES:
130        - '/tmp/OS_errpt.txt'
131        - '/tmp/OS_processors.txt'
132    PROTOCOL:
133        - 'SSH'
134