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