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