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