xref: /openbmc/openbmc-test-automation/ffdc/ffdc_config.yaml (revision 010f221a38db52a4ddc322d9af101f805f37ae06) 
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
14# Commands and Files to collect for a given OpenBMC system.
15OPENBMC:
16    # Commands and File to take snapshot of linux based system.
17    # Filename is <OS>_general.txt, where <OS> is in [OPENBMC, RHEL, UBUNTU]
18    GENERAL:
19        COMMANDS:
20            - "rm -rf /tmp/*BMC_* /tmp/PEL_* /tmp/pldm* /tmp/PLDM* /tmp/GUARD*
21              /tmp/fan_* /tmp/DEVTREE /tmp/bmcweb_*"
22            - 'echo "++++++++++ cat /etc/os-release ++++++++++" >>
23              /tmp/OPENBMC_general.txt'
24            - "cat /etc/os-release >> /tmp/OPENBMC_general.txt"
25            - 'echo -e "\n++++++++++ cat /etc/timestamp ++++++++++" >>
26              /tmp/OPENBMC_general.txt'
27            - "cat /etc/timestamp >> /tmp/OPENBMC_general.txt"
28            - 'echo -e "\n++++++++++ uname -a ++++++++++" >>
29              /tmp/OPENBMC_general.txt'
30            - "uname -a >> /tmp/OPENBMC_general.txt"
31            - 'echo -e "\n++++++++++ cat /etc/timestamp ++++++++++" >>
32              /tmp/OPENBMC_general.txt'
33            - "cat /etc/timestamp >> /tmp/OPENBMC_general.txt"
34            - 'echo -e "\n++++++++++ uptime;cat /proc/uptime ++++++++++" >>
35              /tmp/OPENBMC_general.txt'
36            - "uptime >> /tmp/OPENBMC_general.txt"
37            - "cat /proc/uptime >> /tmp/OPENBMC_general.txt"
38            - 'echo -e "\n++++++++++ df -hT ++++++++++" >>
39              /tmp/OPENBMC_general.txt'
40            - "df -hT >> /tmp/OPENBMC_general.txt"
41            - 'echo -e "\n++++++++++ date;/sbin/hwclock --show ++++++++++" >>
42              /tmp/OPENBMC_general.txt'
43            - "date >> /tmp/OPENBMC_general.txt"
44            - "/sbin/hwclock --show >> /tmp/OPENBMC_general.txt"
45            - "/usr/bin/timedatectl >> /tmp/OPENBMC_general.txt"
46            - 'echo -e "\n++++++++++ /usr/bin/obmcutil state ++++++++++" >>
47              /tmp/OPENBMC_general.txt'
48            - "/usr/bin/obmcutil state >> /tmp/OPENBMC_general.txt"
49        FILES:
50            - "/tmp/OPENBMC_general.txt"
51        PROTOCOL:
52            - "SSH"
53
54    OPENBMC_LOGS:
55        COMMANDS:
56            - "cat /sys/class/watchdog/watchdog1/bootstatus
57              >/tmp/BMC_flash_side.txt"
58            - "grep -r . /sys/class/hwmon/* >/tmp/BMC_hwmon.txt"
59            - "top -n 1 -b >/tmp/BMC_proc_list.txt"
60            - "ls -Al /proc/*/fd/ >/tmp/BMC_proc_fd_active_list.txt"
61            - "journalctl --no-pager >/tmp/BMC_journalctl_nopager.txt"
62            - "journalctl -o json-pretty >/tmp/BMC_journalctl_pretty.json"
63            - "dmesg >/tmp/BMC_dmesg.txt"
64            - "cat /proc/cpuinfo >/tmp/BMC_procinfo.txt"
65            - "cat /proc/meminfo >/tmp/BMC_meminfo.txt"
66            - "systemctl status --all >/tmp/BMC_systemd.txt"
67            - "systemctl list-units --failed >/tmp/BMC_failed_service.txt"
68            - "systemctl list-jobs >/tmp/BMC_list_service.txt"
69            - "cat /var/log/obmc-console.log >/tmp/BMC_obmc_console.txt"
70            - "cat /var/log/obmc-console1.log >/tmp/BMC_obmc_console1.txt"
71            - "peltool -l >/tmp/PEL_logs_list.json"
72            - { "peltool -a >/tmp/PEL_logs_display.json": 600 }
73            - {
74                  "peltool  -l -a -f >/tmp/PEL_logs_complete_list.json 2>&1": 1200,
75              }
76            - {
77                  "peltool -a -f -h>/tmp/PEL_logs_complete_display.json 2>&1": 1200,
78              }
79            - "hexdump -C /var/lib/phosphor-logging/extensions/pels/badPEL
80              >/tmp/PEL_logs_badPEL.txt"
81            - "guard -l >/tmp/GUARD_list.txt"
82            - "pldmtool fru getfrurecordtable>/tmp/PLDM_fru_record.txt"
83            - "killall -s SIGUSR1 pldmd; sleep 5"
84            - "fanctl dump"
85            - "killall -s SIGUSR1 phosphor-fan-monitor; sleep 5"
86            - "cat /var/lib/phosphor-software-manager/pnor/rw/DEVTREE >
87              /tmp/DEVTREE"
88            - "/usr/bin/vpd-tool -i > /tmp/vpd-inventory.txt"
89            - "cat /sys/kernel/tracing/trace > /tmp/kernel_sys_trace.txt"
90        FILES:
91            - "/tmp/BMC_flash_side.txt"
92            - "/tmp/BMC_hwmon.txt"
93            - "/tmp/BMC_proc_list.txt"
94            - "/tmp/BMC_proc_fd_active_list.txt"
95            - "/tmp/BMC_journalctl_nopager.txt"
96            - "/tmp/BMC_journalctl_pretty.json"
97            - "/tmp/BMC_dmesg.txt"
98            - "/tmp/BMC_procinfo.txt"
99            - "/tmp/BMC_meminfo.txt"
100            - "/tmp/BMC_systemd.txt"
101            - "/tmp/BMC_failed_service.txt"
102            - "/tmp/BMC_list_service.txt"
103            - "/tmp/BMC_obmc_console.txt"
104            - "/tmp/BMC_obmc_console1.txt"
105            - "/tmp/PEL_logs_list.json"
106            - "/tmp/PEL_logs_complete_list.json"
107            - "/tmp/PEL_logs_complete_display.json"
108            - "/tmp/PEL_logs_display.json"
109            - "/tmp/PEL_logs_badPEL.txt"
110            - "/tmp/GUARD_list.txt"
111            - "/tmp/PLDM_fru_record.txt"
112            - "/tmp/pldm_flight_recorder"
113            - "/tmp/fan_control_dump.json"
114            - "/tmp/fan_monitor_dump.json"
115            - "/tmp/DEVTREE"
116            - "/tmp/vpd-inventory.txt"
117            - "/tmp/kernel_sys_trace.txt"
118        PROTOCOL:
119            - "SSH"
120
121    # DUMP_LOGS: This section provides option to 'SCP if file exist'.
122    #     COMMANDS: filename is preceded by ls -AX '.
123    #     FILES: is not needed and is ignored if exists.
124    DUMP_LOGS:
125        COMMANDS:
126            - "ls -AX /var/lib/systemd/coredump/core.*"
127            - "ls -AX /var/lib/phosphor-debug-collector/dumps/*/*"
128            - "ls -AX /var/lib/phosphor-debug-collector/hostbootdump/*/*"
129        PROTOCOL:
130            - "SCP"
131
132    # URLs and Files for OPENBMC redfish
133    # URLs and Files are one-to-one corresponding.
134    # File contains the data returned from 'redfishtool GET URL'
135    REDFISH_LOGS:
136        COMMANDS:
137            - redfishtool -u ${username} -p ${password} -r
138              ${hostname}:${port_https} -S Always raw GET
139              /redfish/v1/AccountService/Accounts
140            - redfishtool -u ${username} -p ${password} -r
141              ${hostname}:${port_https} -S Always raw GET
142              /redfish/v1/Managers/${manager_id}/LogServices/Dump/Entries
143            - redfishtool -u ${username} -p ${password} -r
144              ${hostname}:${port_https} -S Always raw GET
145              /redfish/v1/Systems/system/LogServices/Dump/Entries
146            - redfishtool -u ${username} -p ${password} -r
147              ${hostname}:${port_https} -S Always raw GET
148              /redfish/v1/Systems/system/LogServices/EventLog/Entries
149            - plugin:
150                  - plugin_name: plugin.redfish.enumerate_request
151                  - plugin_args:
152                        - ${hostname}:${port_https}
153                        - ${username}
154                        - ${password}
155                        - /redfish/v1/
156                        - json
157        FILES:
158            - "REDFISH_bmc_user_accounts.json"
159            - "REDFISH_bmc_dump_entries.json"
160            - "REDFISH_system_dumps_entries.json"
161            - "REDFISH_event_log_entries.json"
162            - "REDFISH_enumerate_v1.json"
163        PROTOCOL:
164            - "REDFISH"
165
166    # Commands and Files to collect for via out of band IPMI.
167    IPMI_LOGS:
168        COMMANDS:
169            - ipmitool -I lanplus -C 17 -U ${username} -P ${password} -H
170              ${hostname} -p ${port_ipmi} lan print
171            - ipmitool -I lanplus -C 17 -U ${username} -P ${password} -H
172              ${hostname} -p ${port_ipmi} fru list
173            - ipmitool -I lanplus -C 17 -U ${username} -P ${password} -H
174              ${hostname} -p ${port_ipmi} user list
175        FILES:
176            - "IPMI_LAN_print.txt"
177            - "IPMI_FRU_list.txt"
178            - "IPMI_USER_list.txt"
179        PROTOCOL:
180            - "IPMI"
181
182# Commands and Files to collect for all Linux distributions
183LINUX:
184    LINUX_LOGS:
185        COMMANDS:
186            - "cat /sys/firmware/opal/msglog >/tmp/OS_msglog.txt"
187            - "ppc64_cpu --frequency >/tmp/OS_cpufrequency.txt"
188            - "dmesg >/tmp/OS_dmesg.txt"
189            - "cat /var/log/opal-prd* >/tmp/OS_opal_prd.txt"
190            - "cat /var/log/boot.log >/tmp/OS_boot.txt"
191            - "cat /proc/cpuinfo >/tmp/OS_procinfo.txt"
192            - "cat /proc/meminfo >/tmp/OS_meminfo.txt"
193            - "netstat -a >/tmp/OS_netstat.txt"
194            - "lspci >/tmp/OS_lspci.txt"
195            - "lscpu >/tmp/OS_lscpu.txt"
196            - "lscfg >/tmp/OS_lscfg.txt"
197            - "journalctl --no-pager -b > /tmp/OS_journalctl_nopager.txt "
198        FILES:
199            - "/tmp/OS_msglog.txt"
200            - "/tmp/OS_cpufrequency.txt"
201            - "/tmp/OS_dmesg.txt"
202            - "/tmp/OS_opal_prd.txt"
203            - "/tmp/OS_boot.txt"
204            - "/tmp/OS_procinfo.txt"
205            - "/tmp/OS_meminfo.txt"
206            - "/tmp/OS_netstat.txt"
207            - "/tmp/OS_lspci.txt"
208            - "/tmp/OS_lscpu.txt"
209            - "/tmp/OS_lscfg.txt"
210            - "/tmp/OS_journalctl_nopager.txt"
211        PROTOCOL:
212            - "SSH"
213
214# Commands and Files to collect for Ubuntu Linux only
215UBUNTU:
216    GENERAL:
217        COMMANDS:
218            - "rm -rf /tmp/UBUNTU_general.txt"
219            - 'echo "++++++++++ UBUNTU Rleasae ++++++++++" >
220              /tmp/UBUNTU_general.txt'
221            - "cat /etc/os-release >> /tmp/UBUNTU_general.txt"
222            - 'echo "\n++++++++++ Time stamp ++++++++++" >>
223              /tmp/UBUNTU_general.txt'
224            - "date >> /tmp/UBUNTU_general.txt"
225            - 'echo  "\n++++++++++ uname -a ++++++++++" >>
226              /tmp/UBUNTU_general.txt'
227            - "uname -a >> /tmp/UBUNTU_general.txt"
228            - 'echo "\n++++++++++ uptime ++++++++++" >> /tmp/UBUNTU_general.txt'
229            - "uptime >> /tmp/UBUNTU_general.txt"
230        FILES:
231            - "/tmp/UBUNTU_general.txt"
232        PROTOCOL:
233            - "SSH"
234    UBUNTU_LOGS:
235        COMMANDS:
236            - "{ cat /etc/os-release; uname -a; rpm -qa ; } >/tmp/OS_info.txt"
237            - "tail -n 200000 /var/log/messages >/tmp/OS_syslog.txt"
238            - "rm -rf /tmp/sosreport*FFDC*"
239            - {
240                  ? "sosreport --batch --tmp-dir /tmp --label FFDC
241                    >/tmp/OS_sosreport.txt"
242                  : 1200,
243              }
244            - "tar -zcvf /tmp/crash.tar.gz /var/crash"
245        FILES:
246            - "/tmp/OS_info.txt"
247            - "/tmp/OS_syslog.txt"
248            - "/tmp/OS_sosreport.txt"
249            - "/tmp/sosreport*.tar.xz"
250            - "/tmp/crash.tar.gz"
251        PROTOCOL:
252            - "SSH"
253    DUMP_LOGS:
254        COMMANDS:
255            - "ls -AX /tmp/htx/htxerr"
256            - "ls -AX /tmp/htx/htxmsg"
257        PROTOCOL:
258            - "SCP"
259
260# Commands and Files to collect for RHE Linux only
261RHEL:
262    GENERAL:
263        COMMANDS:
264            - "rm -rf /tmp/RHEL_general.txt"
265            - 'echo "++++++++++ RHEL Rleasae ++++++++++" > /tmp/RHEL_general.txt'
266            - "cat /etc/os-release >> /tmp/RHEL_general.txt"
267            - 'echo -e "\n++++++++++ Time stamp ++++++++++" >>
268              /tmp/RHEL_general.txt'
269            - "date >> /tmp/RHEL_general.txt"
270            - 'echo -e "\n++++++++++ uname -a ++++++++++" >>
271              /tmp/RHEL_general.txt'
272            - "uname -a >> /tmp/RHEL_general.txt"
273            - 'echo -e "\n++++++++++ uptime ++++++++++" >> /tmp/RHEL_general.txt'
274            - "uptime >> /tmp/RHEL_general.txt"
275        FILES:
276            - "/tmp/RHEL_general.txt"
277        PROTOCOL:
278            - "SSH"
279    RHEL_LOGS:
280        COMMANDS:
281            - "{ cat /etc/os-release; uname -a; rpm -qa ; } >/tmp/OS_info.txt"
282            - "tail -n 200000 /var/log/messages >/tmp/OS_syslog.txt"
283            - "rm -rf /tmp/sosreport*FFDC*"
284            - {
285                  ? "sosreport --batch --tmp-dir /tmp --label FFDC
286                    >/tmp/OS_sosreport.txt"
287                  : 1200,
288              }
289            - "tar -zcvf /tmp/crash.tar.gz /var/crash"
290        FILES:
291            - "/tmp/OS_info.txt"
292            - "/tmp/OS_syslog.txt"
293            - "/tmp/OS_sosreport.txt"
294            - "/tmp/sosreport*.tar.xz"
295            - "/tmp/crash.tar.gz"
296        PROTOCOL:
297            - "SSH"
298    DUMP_LOGS:
299        COMMANDS:
300            - "ls -AX /tmp/htx/htxerr"
301            - "ls -AX /tmp/htx/htxmsg"
302        PROTOCOL:
303            - "SCP"
304
305# Commands and Files to collect for SLES Linux only
306SLES:
307    GENERAL:
308        COMMANDS:
309            - "rm -rf /tmp/SLES_general.txt"
310            - 'echo "++++++++++ SLES Rleasae ++++++++++" > /tmp/SLES_general.txt'
311            - "cat /etc/os-release >> /tmp/SLES_general.txt"
312            - 'echo "\n++++++++++ Time stamp ++++++++++" >>
313              /tmp/SLES_general.txt'
314            - "date >> /tmp/SLES_general.txt"
315            - 'echo "\n++++++++++ uname -a ++++++++++" >> /tmp/SLES_general.txt'
316            - "uname -a >> /tmp/SLES_general.txt"
317            - 'echo "\n++++++++++ uptime ++++++++++" >> /tmp/SLES_general.txt'
318            - "uptime >> /tmp/SLES_general.txt"
319        FILES:
320            - "/tmp/SLES_general.txt"
321        PROTOCOL:
322            - "SSH"
323    SLES_LOGS:
324        COMMANDS:
325            - "{ cat /etc/os-release; uname -a; rpm -qa ; } >/tmp/OS_info.txt"
326            - "tail -n 200000 /var/log/messages >/tmp/OS_syslog.txt"
327            - "rm -rf /tmp/scc*.txz.md5"
328            - { "supportconfig >/tmp/OS_supportconfig.txt": 1200 }
329            - "cp /var/log/scc*.txz.md5 /tmp/"
330            - "tar -zcvf /tmp/crash.tar.gz /var/crash"
331        FILES:
332            - "/tmp/OS_info.txt"
333            - "/tmp/OS_syslog.txt"
334            - "/tmp/OS_supportconfig.txt"
335            - "/tmp/scc*.txz.md5"
336            - "/tmp/crash.tar.gz"
337        PROTOCOL:
338            - "SSH"
339    DUMP_LOGS:
340        COMMANDS:
341            - "ls -AX /tmp/htx/htxerr"
342            - "ls -AX /tmp/htx/htxmsg"
343        PROTOCOL:
344            - "SCP"
345
346# Commands and Files to collect for AIX only
347AIX:
348    GENERAL:
349        COMMANDS:
350            - "rm -rf /tmp/AIX_general.txt"
351            - 'echo "++++++++++ AIX Release ++++++++++" > /tmp/AIX_general.txt'
352            - "cat /proc/version | tail -1 >> /tmp/AIX_general.txt"
353            - 'echo "\n++++++++++ Time stamp ++++++++++" >> /tmp/AIX_general.txt'
354            - "date >> /tmp/AIX_general.txt"
355            - 'echo  "\n++++++++++ uname -a ++++++++++" >> /tmp/AIX_general.txt'
356            - "uname -a >> /tmp/AIX_general.txt"
357            - 'echo "\n++++++++++ uptime ++++++++++" >> /tmp/AIX_general.txt'
358            - "uptime >> /tmp/AIX_general.txt"
359            - 'echo "\n++++++++++ System Info ++++++++++" >>
360              /tmp/AIX_general.txt'
361            - "prtconf | head -15 >> /tmp/AIX_general.txt"
362        FILES:
363            - "/tmp/AIX_general.txt"
364        PROTOCOL:
365            - "SSH"
366    AIX_LOGS:
367        COMMANDS:
368            - "errpt -a >/tmp/OS_errpt.txt ; errclear 0;"
369            - "bindprocessor -q >/tmp/OS_processors.txt"
370        FILES:
371            - "/tmp/OS_errpt.txt"
372            - "/tmp/OS_processors.txt"
373        PROTOCOL:
374            - "SSH"
375    DUMP_LOGS:
376        COMMANDS:
377            - "ls -AX /tmp/htx/htxerr"
378            - "ls -AX /tmp/htx/htxmsg"
379        PROTOCOL:
380            - "SCP"
381