xref: /openbmc/openbmc-test-automation/ffdc/ffdc_config.yaml (revision c3a37e4a5b4879e24c9ee405d1e891e62f35a477)
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_collector.py
15
16# Commands and File to take snapshot of linux based system.
17# Filename is <OS>_general.txt, where <OS> is in [OPENBMC, RHEL, UBUNTU]
18GENERAL:
19    COMMANDS:
20        - 'rm -rf /tmp/%s_general.txt'
21        - 'echo "++++++++++ cat /etc/os-release ++++++++++" >> /tmp/%s_general.txt 2>&1'
22        - 'cat /etc/os-release >> /tmp/%s_general.txt 2>&1'
23        - 'echo -e "\n++++++++++ cat /etc/timestamp ++++++++++" >> /tmp/%s_general.txt 2>&1'
24        - 'cat /etc/timestamp >> /tmp/%s_general.txt 2>&1'
25        - 'echo -e "\n++++++++++ uname -a ++++++++++" >> /tmp/%s_general.txt 2>&1'
26        - 'uname -a >> /tmp/%s_general.txt'
27        - 'echo -e "\n++++++++++ cat /etc/timestamp ++++++++++" >> /tmp/%s_general.txt 2>&1'
28        - 'cat /etc/timestamp >> /tmp/%s_general.txt 2>&1'
29        - 'echo -e "\n++++++++++ uptime;cat /proc/uptime ++++++++++" >> /tmp/%s_general.txt 2>&1'
30        - 'uptime;cat /proc/uptime >> /tmp/%s_general.txt 2>&1'
31        - 'echo -e "\n++++++++++ df -hT ++++++++++" >> /tmp/%s_general.txt 2>&1'
32        - 'df -hT >> /tmp/%s_general.txt 2>&1'
33        - 'echo -e "\n++++++++++ date;/sbin/hwclock --show ++++++++++" >> /tmp/%s_general.txt 2>&1'
34        - 'date;/sbin/hwclock --show;/usr/bin/timedatectl >> /tmp/%s_general.txt 2>&1'
35        - 'echo -e "\n++++++++++ /usr/bin/obmcutil state ++++++++++" >> /tmp/%s_general.txt 2>&1'
36        - '/usr/bin/obmcutil state >> /tmp/%s_general.txt 2>&1'
37    FILES:
38        - '/tmp/%s_general.txt'
39    PROTOCOL:
40        - 'SSH'
41
42# Commands and Files to collect for a given OpenBMC system.
43OPENBMC:
44    COMMANDS:
45        - 'cat /sys/class/watchdog/watchdog1/bootstatus >/tmp/BMC_flash_side.txt 2>&1'
46        - 'grep -r . /sys/class/hwmon/* >/tmp/BMC_hwmon.txt 2>&1'
47        - 'top -n 1 -b >/tmp/BMC_proc_list.txt 2>&1'
48        - 'ls -Al /proc/*/fd/ >/tmp/BMC_proc_fd_active_list.txt 2>&1'
49        - 'journalctl --no-pager >/tmp/BMC_journalctl_nopager.txt 2>&1'
50        - 'journalctl -o json-pretty >/tmp/BMC_journalctl_pretty.json 2>&1'
51        - 'dmesg >/tmp/BMC_dmesg.txt 2>&1'
52        - 'cat /proc/cpuinfo >/tmp/BMC_procinfo.txt 2>&1'
53        - 'cat /proc/meminfo >/tmp/BMC_meminfo.txt 2>&1'
54        - 'systemctl status --all >/tmp/BMC_systemd.txt 2>&1'
55        - 'systemctl list-units --failed >/tmp/BMC_failed_service.txt 2>&1'
56        - 'systemctl list-jobs >/tmp/BMC_list_service.txt 2>&1'
57        - 'cat /var/log/obmc-console.log >/tmp/BMC_obmc_console.txt 2>&1'
58        - 'cat /var/log/obmc-console1.log >/tmp/BMC_obmc_console1.txt 2>&1'
59        - 'peltool -l >/tmp/PEL_logs_list.json 2>&1'
60        - 'peltool -a >/tmp/PEL_logs_display.json 2>&1'
61    FILES:
62        - '/tmp/BMC_flash_side.txt'
63        - '/tmp/BMC_hwmon.txt'
64        - '/tmp/BMC_proc_list.txt'
65        - '/tmp/BMC_proc_fd_active_list.txt'
66        - '/tmp/BMC_journalctl_nopager.txt'
67        - '/tmp/BMC_journalctl_pretty.json'
68        - '/tmp/BMC_dmesg.txt'
69        - '/tmp/BMC_procinfo.txt'
70        - '/tmp/BMC_meminfo.txt'
71        - '/tmp/BMC_systemd.txt'
72        - '/tmp/BMC_failed_service.txt'
73        - '/tmp/BMC_list_service.txt'
74        - '/tmp/BMC_obmc_console.txt'
75        - '/tmp/BMC_obmc_console1.txt'
76        - '/tmp/PEL_logs_list.json'
77        - '/tmp/PEL_logs_display.json'
78    PROTOCOL:
79        - 'SSH'
80
81# Commands and Files to collect for all Linux distributions
82LINUX:
83    COMMANDS:
84        - 'cat /sys/firmware/opal/msglog >/tmp/OS_msglog.txt 2>&1'
85        - 'ppc64_cpu --frequency >/tmp/OS_cpufrequency.txt 2>&1'
86        - 'dmesg >/tmp/OS_dmesg.txt 2>&1'
87        - 'cat /var/log/opal-prd* >/tmp/OS_opal_prd.txt 2>&1'
88        - 'cat /var/log/boot.log >/tmp/OS_boot.txt 2>&1'
89        - 'cat /proc/cpuinfo >/tmp/OS_procinfo.txt 2>&1'
90        - 'cat /proc/meminfo >/tmp/OS_meminfo.txt 2>&1'
91        - 'netstat -a >/tmp/OS_netstat.txt 2>&1'
92        - 'lspci >/tmp/OS_lspci.txt 2>&1'
93        - 'lscpu >/tmp/OS_lscpu.txt 2>&1'
94        - 'lscfg >/tmp/OS_lscfg.txt 2>&1'
95        - 'journalctl --no-pager -b > /tmp/OS_journalctl_nopager.txt  2>&1'
96    FILES:
97        - '/tmp/OS_msglog.txt'
98        - '/tmp/OS_cpufrequency.txt'
99        - '/tmp/OS_dmesg.txt'
100        - '/tmp/OS_opal_prd.txt'
101        - '/tmp/OS_boot.txt'
102        - '/tmp/OS_procinfo.txt'
103        - '/tmp/OS_meminfo.txt'
104        - '/tmp/OS_netstat.txt'
105        - '/tmp/OS_lspci.txt'
106        - '/tmp/OS_lscpu.txt'
107        - '/tmp/OS_lscfg.txt'
108        - '/tmp/OS_journalctl_nopager.txt'
109    PROTOCOL:
110        - 'SSH'
111
112# Commands and Files to collect for Ubuntu Linux only
113UBUNTU:
114    COMMANDS:
115        - '{ lsusb -t ; lsusb -v ; } >/tmp/OS_isub.txt 2>&1'
116        - 'tail -n 50000 /var/log/kern.log >/tmp/OS_kern.txt 2>&1'
117        - '{ cat /var/log/auth.log; cat /var/log/auth.log.1 ; } >/tmp/OS_authlog.txt 2>&1'
118        - 'tail -n 200000 /var/log/syslog >/tmp/OS_syslog.txt 2>&1'
119        - '{ uname -a; dpkg -s opal-prd; dpkg -s ipmitool ; } >/tmp/OS_info.txt 2>&1'
120        - 'rm -rf /tmp/sosreport*FFDC*'
121        - 'sosreport --batch --tmp-dir /tmp --ticket-number FFDC >/tmp/OS_sosreport.txt 2>&1'
122    FILES:
123        - '/tmp/OS_isub.txt'
124        - '/tmp/OS_kern.txt'
125        - '/tmp/OS_authlog.txt'
126        - '/tmp/OS_syslog.txt'
127        - '/tmp/OS_info.txt'
128        - '/tmp/OS_sosreport.txt'
129    PROTOCOL:
130        - 'SSH'
131
132# Commands and Files to collect for RHE Linux only
133RHEL:
134    COMMANDS:
135        - '/usr/bin/ctversion -bv >/tmp/OS_rsct.txt 2>&1'
136        - 'cat /var/log/secure >/tmp/OS_secure.txt 2>&1'
137        - 'tail -n 200000 /var/log/messages >/tmp/OS_syslog.txt 2>&1'
138        - '{ lsb_release -a; cat /etc/redhat-release; uname -a; rpm -qa ; } >/tmp/OS_info.txt 2>&1'
139        - 'rm -rf /tmp/sosreport*FFDC*'
140        - 'sosreport --batch --tmp-dir /tmp --label FFDC >/tmp/OS_sosreport.txt 2>&1'
141    FILES:
142        - '/tmp/OS_rsct.txt'
143        - '/tmp/OS_secure.txt'
144        - '/tmp/OS_syslog.txt'
145        - '/tmp/OS_info.txt'
146        - '/tmp/OS_sosreport.txt'
147    PROTOCOL:
148        - 'SSH'
149
150# Commands and Files to collect for AIX only
151AIX:
152    COMMANDS:
153        - 'errpt >/tmp/OS_errpt.txt 2>&1 ; errclear 0;'
154        - 'bindprocessor -q >/tmp/OS_processors.txt 2>&1'
155    FILES:
156        - '/tmp/OS_errpt.txt'
157        - '/tmp/OS_processors.txt'
158    PROTOCOL:
159        - 'SSH'
160