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            - {
80                  ? "strace -p $(pidof pldmd) -o /tmp/pldmd_strace.txt & sleep
81                    60 ; kill $!"
82                  : 70,
83              }
84            - "hexdump -C /var/lib/phosphor-logging/extensions/pels/badPEL
85              >/tmp/PEL_logs_badPEL.txt"
86            - "guard -l >/tmp/GUARD_list.txt"
87            - "pldmtool fru getfrurecordtable>/tmp/PLDM_fru_record.txt"
88            - "killall -s SIGUSR1 pldmd; sleep 5"
89            - "fanctl dump"
90            - "cat /var/lib/phosphor-software-manager/pnor/rw/DEVTREE >
91              /tmp/DEVTREE"
92            - "cat /home/root/bmcweb_persistent_data.json >
93              /tmp/bmcweb_persistent_data.json"
94        FILES:
95            - "/tmp/BMC_flash_side.txt"
96            - "/tmp/BMC_hwmon.txt"
97            - "/tmp/BMC_proc_list.txt"
98            - "/tmp/BMC_proc_fd_active_list.txt"
99            - "/tmp/BMC_journalctl_nopager.txt"
100            - "/tmp/BMC_journalctl_pretty.json"
101            - "/tmp/BMC_dmesg.txt"
102            - "/tmp/BMC_procinfo.txt"
103            - "/tmp/BMC_meminfo.txt"
104            - "/tmp/BMC_systemd.txt"
105            - "/tmp/BMC_failed_service.txt"
106            - "/tmp/BMC_list_service.txt"
107            - "/tmp/BMC_obmc_console.txt"
108            - "/tmp/BMC_obmc_console1.txt"
109            - "/tmp/PEL_logs_list.json"
110            - "/tmp/PEL_logs_complete_list.json"
111            - "/tmp/PEL_logs_complete_display.json"
112            - "/tmp/PEL_logs_display.json"
113            - "/tmp/pldmd_strace.txt"
114            - "/tmp/PEL_logs_badPEL.txt"
115            - "/tmp/GUARD_list.txt"
116            - "/tmp/PLDM_fru_record.txt"
117            - "/tmp/pldm_flight_recorder"
118            - "/tmp/fan_control_dump.json"
119            - "/tmp/DEVTREE"
120            - "/tmp/bmcweb_persistent_data.json"
121        PROTOCOL:
122            - "SSH"
123
124    # DUMP_LOGS: This section provides option to 'SCP if file exist'.
125    #     COMMANDS: filename is preceded by ls -AX '.
126    #     FILES: is not needed and is ignored if exists.
127    DUMP_LOGS:
128        COMMANDS:
129            - "ls -AX /var/lib/systemd/coredump/core.*"
130            - "ls -AX /var/lib/phosphor-debug-collector/dumps/*/*"
131            - "ls -AX /var/lib/phosphor-debug-collector/hostbootdump/*/*"
132        PROTOCOL:
133            - "SCP"
134
135    # URLs and Files for OPENBMC redfish
136    # URLs and Files are one-to-one corresponding.
137    # File contains the data returned from 'redfishtool GET URL'
138    REDFISH_LOGS:
139        COMMANDS:
140            - redfishtool -u ${username} -p ${password} -r ${hostname} -S Always
141              raw GET /redfish/v1/AccountService/Accounts
142            - redfishtool -u ${username} -p ${password} -r ${hostname} -S Always
143              raw GET /redfish/v1/Managers/bmc/LogServices/Dump/Entries
144            - redfishtool -u ${username} -p ${password} -r ${hostname} -S Always
145              raw GET /redfish/v1/Systems/system/LogServices/Dump/Entries
146            - redfishtool -u ${username} -p ${password} -r ${hostname} -S Always
147              raw GET /redfish/v1/Systems/system/LogServices/EventLog/Entries
148            - plugin:
149                  - plugin_name: plugin.redfish.enumerate_request
150                  - plugin_args:
151                        - ${hostname}
152                        - ${username}
153                        - ${password}
154                        - /redfish/v1/
155                        - json
156        FILES:
157            - "REDFISH_bmc_user_accounts.json"
158            - "REDFISH_bmc_dump_entries.json"
159            - "REDFISH_system_dumps_entries.json"
160            - "REDFISH_event_log_entries.json"
161            - "REDFISH_enumerate_v1.json"
162        PROTOCOL:
163            - "REDFISH"
164
165    # Commands and Files to collect for via out of band IPMI.
166    IPMI_LOGS:
167        COMMANDS:
168            - ipmitool -I lanplus -C 17 -U ${username} -P ${password} -H
169              ${hostname} lan print
170            - ipmitool -I lanplus -C 17 -U ${username} -P ${password} -H
171              ${hostname} fru list
172            - ipmitool -I lanplus -C 17 -U ${username} -P ${password} -H
173              ${hostname} user list
174        FILES:
175            - "IPMI_LAN_print.txt"
176            - "IPMI_FRU_list.txt"
177            - "IPMI_USER_list.txt"
178        PROTOCOL:
179            - "IPMI"
180
181# Commands and Files to collect for all Linux distributions
182LINUX:
183    LINUX_LOGS:
184        COMMANDS:
185            - "cat /sys/firmware/opal/msglog >/tmp/OS_msglog.txt"
186            - "ppc64_cpu --frequency >/tmp/OS_cpufrequency.txt"
187            - "dmesg >/tmp/OS_dmesg.txt"
188            - "cat /var/log/opal-prd* >/tmp/OS_opal_prd.txt"
189            - "cat /var/log/boot.log >/tmp/OS_boot.txt"
190            - "cat /proc/cpuinfo >/tmp/OS_procinfo.txt"
191            - "cat /proc/meminfo >/tmp/OS_meminfo.txt"
192            - "netstat -a >/tmp/OS_netstat.txt"
193            - "lspci >/tmp/OS_lspci.txt"
194            - "lscpu >/tmp/OS_lscpu.txt"
195            - "lscfg >/tmp/OS_lscfg.txt"
196            - "journalctl --no-pager -b > /tmp/OS_journalctl_nopager.txt "
197        FILES:
198            - "/tmp/OS_msglog.txt"
199            - "/tmp/OS_cpufrequency.txt"
200            - "/tmp/OS_dmesg.txt"
201            - "/tmp/OS_opal_prd.txt"
202            - "/tmp/OS_boot.txt"
203            - "/tmp/OS_procinfo.txt"
204            - "/tmp/OS_meminfo.txt"
205            - "/tmp/OS_netstat.txt"
206            - "/tmp/OS_lspci.txt"
207            - "/tmp/OS_lscpu.txt"
208            - "/tmp/OS_lscfg.txt"
209            - "/tmp/OS_journalctl_nopager.txt"
210        PROTOCOL:
211            - "SSH"
212
213# Commands and Files to collect for Ubuntu Linux only
214UBUNTU:
215    GENERAL:
216        COMMANDS:
217            - "rm -rf /tmp/UBUNTU_general.txt"
218            - 'echo "++++++++++ UBUNTU Rleasae ++++++++++" >
219              /tmp/UBUNTU_general.txt'
220            - "cat /etc/os-release >> /tmp/UBUNTU_general.txt"
221            - 'echo "\n++++++++++ Time stamp ++++++++++" >>
222              /tmp/UBUNTU_general.txt'
223            - "date >> /tmp/UBUNTU_general.txt"
224            - 'echo  "\n++++++++++ uname -a ++++++++++" >>
225              /tmp/UBUNTU_general.txt'
226            - "uname -a >> /tmp/UBUNTU_general.txt"
227            - 'echo "\n++++++++++ uptime ++++++++++" >> /tmp/UBUNTU_general.txt'
228            - "uptime >> /tmp/UBUNTU_general.txt"
229        FILES:
230            - "/tmp/UBUNTU_general.txt"
231        PROTOCOL:
232            - "SSH"
233    UBUNTU_LOGS:
234        COMMANDS:
235            - "{ cat /etc/os-release; uname -a; rpm -qa ; } >/tmp/OS_info.txt"
236            - "tail -n 200000 /var/log/messages >/tmp/OS_syslog.txt"
237            - "rm -rf /tmp/sosreport*FFDC*"
238            - {
239                  ? "sosreport --batch --tmp-dir /tmp --label FFDC
240                    >/tmp/OS_sosreport.txt"
241                  : 1200,
242              }
243            - "tar -zcvf /tmp/crash.tar.gz /var/crash"
244        FILES:
245            - "/tmp/OS_info.txt"
246            - "/tmp/OS_syslog.txt"
247            - "/tmp/OS_sosreport.txt"
248            - "/tmp/sosreport*.tar.xz"
249            - "/tmp/crash.tar.gz"
250        PROTOCOL:
251            - "SSH"
252    DUMP_LOGS:
253        COMMANDS:
254            - "ls -AX /tmp/htx/htxerr"
255            - "ls -AX /tmp/htx/htxmsg"
256        PROTOCOL:
257            - "SCP"
258
259# Commands and Files to collect for RHE Linux only
260RHEL:
261    GENERAL:
262        COMMANDS:
263            - "rm -rf /tmp/RHEL_general.txt"
264            - 'echo "++++++++++ RHEL Rleasae ++++++++++" > /tmp/RHEL_general.txt'
265            - "cat /etc/os-release >> /tmp/RHEL_general.txt"
266            - 'echo -e "\n++++++++++ Time stamp ++++++++++" >>
267              /tmp/RHEL_general.txt'
268            - "date >> /tmp/RHEL_general.txt"
269            - 'echo -e "\n++++++++++ uname -a ++++++++++" >>
270              /tmp/RHEL_general.txt'
271            - "uname -a >> /tmp/RHEL_general.txt"
272            - 'echo -e "\n++++++++++ uptime ++++++++++" >> /tmp/RHEL_general.txt'
273            - "uptime >> /tmp/RHEL_general.txt"
274        FILES:
275            - "/tmp/RHEL_general.txt"
276        PROTOCOL:
277            - "SSH"
278    RHEL_LOGS:
279        COMMANDS:
280            - "{ cat /etc/os-release; uname -a; rpm -qa ; } >/tmp/OS_info.txt"
281            - "tail -n 200000 /var/log/messages >/tmp/OS_syslog.txt"
282            - "rm -rf /tmp/sosreport*FFDC*"
283            - {
284                  ? "sosreport --batch --tmp-dir /tmp --label FFDC
285                    >/tmp/OS_sosreport.txt"
286                  : 1200,
287              }
288            - "tar -zcvf /tmp/crash.tar.gz /var/crash"
289        FILES:
290            - "/tmp/OS_info.txt"
291            - "/tmp/OS_syslog.txt"
292            - "/tmp/OS_sosreport.txt"
293            - "/tmp/sosreport*.tar.xz"
294            - "/tmp/crash.tar.gz"
295        PROTOCOL:
296            - "SSH"
297    DUMP_LOGS:
298        COMMANDS:
299            - "ls -AX /tmp/htx/htxerr"
300            - "ls -AX /tmp/htx/htxmsg"
301        PROTOCOL:
302            - "SCP"
303
304# Commands and Files to collect for SLES Linux only
305SLES:
306    GENERAL:
307        COMMANDS:
308            - "rm -rf /tmp/SLES_general.txt"
309            - 'echo "++++++++++ SLES Rleasae ++++++++++" > /tmp/SLES_general.txt'
310            - "cat /etc/os-release >> /tmp/SLES_general.txt"
311            - 'echo "\n++++++++++ Time stamp ++++++++++" >>
312              /tmp/SLES_general.txt'
313            - "date >> /tmp/SLES_general.txt"
314            - 'echo "\n++++++++++ uname -a ++++++++++" >> /tmp/SLES_general.txt'
315            - "uname -a >> /tmp/SLES_general.txt"
316            - 'echo "\n++++++++++ uptime ++++++++++" >> /tmp/SLES_general.txt'
317            - "uptime >> /tmp/SLES_general.txt"
318        FILES:
319            - "/tmp/SLES_general.txt"
320        PROTOCOL:
321            - "SSH"
322    SLES_LOGS:
323        COMMANDS:
324            - "{ cat /etc/os-release; uname -a; rpm -qa ; } >/tmp/OS_info.txt"
325            - "tail -n 200000 /var/log/messages >/tmp/OS_syslog.txt"
326            - "rm -rf /tmp/scc*.txz.md5"
327            - { "supportconfig >/tmp/OS_supportconfig.txt": 1200 }
328            - "cp /var/log/scc*.txz.md5 /tmp/"
329            - "tar -zcvf /tmp/crash.tar.gz /var/crash"
330        FILES:
331            - "/tmp/OS_info.txt"
332            - "/tmp/OS_syslog.txt"
333            - "/tmp/OS_supportconfig.txt"
334            - "/tmp/scc*.txz.md5"
335            - "/tmp/crash.tar.gz"
336        PROTOCOL:
337            - "SSH"
338    DUMP_LOGS:
339        COMMANDS:
340            - "ls -AX /tmp/htx/htxerr"
341            - "ls -AX /tmp/htx/htxmsg"
342        PROTOCOL:
343            - "SCP"
344
345# Commands and Files to collect for AIX only
346AIX:
347    GENERAL:
348        COMMANDS:
349            - "rm -rf /tmp/AIX_general.txt"
350            - 'echo "++++++++++ AIX Release ++++++++++" > /tmp/AIX_general.txt'
351            - "cat /proc/version | tail -1 >> /tmp/AIX_general.txt"
352            - 'echo "\n++++++++++ Time stamp ++++++++++" >> /tmp/AIX_general.txt'
353            - "date >> /tmp/AIX_general.txt"
354            - 'echo  "\n++++++++++ uname -a ++++++++++" >> /tmp/AIX_general.txt'
355            - "uname -a >> /tmp/AIX_general.txt"
356            - 'echo "\n++++++++++ uptime ++++++++++" >> /tmp/AIX_general.txt'
357            - "uptime >> /tmp/AIX_general.txt"
358            - 'echo "\n++++++++++ System Info ++++++++++" >>
359              /tmp/AIX_general.txt'
360            - "prtconf | head -15 >> /tmp/AIX_general.txt"
361        FILES:
362            - "/tmp/AIX_general.txt"
363        PROTOCOL:
364            - "SSH"
365    AIX_LOGS:
366        COMMANDS:
367            - "errpt -a >/tmp/OS_errpt.txt ; errclear 0;"
368            - "bindprocessor -q >/tmp/OS_processors.txt"
369        FILES:
370            - "/tmp/OS_errpt.txt"
371            - "/tmp/OS_processors.txt"
372        PROTOCOL:
373            - "SSH"
374    DUMP_LOGS:
375        COMMANDS:
376            - "ls -AX /tmp/htx/htxerr"
377            - "ls -AX /tmp/htx/htxmsg"
378        PROTOCOL:
379            - "SCP"
380