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