blob: 6f66137b27eeb91a3123cf37ec0375dfd7e9a0d8 [file] [log] [blame]
Peter D Phan72ce6b82021-06-03 06:18:26 -05001---
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.
Peter D Phan04aca3b2021-06-21 10:37:18 -050012#
Peter D Phan2b8052d2021-06-22 10:55:41 -050013
Peter D Phan72ce6b82021-06-03 06:18:26 -050014# Commands and Files to collect for a given OpenBMC system.
15OPENBMC:
George Keishing6ea92b02021-07-01 11:20:50 -050016 # 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:
George Keishing4dd1aa32021-07-07 01:11:07 -050020 - 'rm -rf /tmp/OPENBMC_general.txt'
Peter D Phand1fccd32021-07-21 06:45:54 -050021 - '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'
George Keishing4dd1aa32021-07-07 01:11:07 -050026 - 'uname -a >> /tmp/OPENBMC_general.txt'
Peter D Phand1fccd32021-07-21 06:45:54 -050027 - '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'
George Keishing0c0bdd42021-07-23 13:36:06 -050040 - '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'
George Keishing6ea92b02021-07-01 11:20:50 -050042 FILES:
George Keishing4dd1aa32021-07-07 01:11:07 -050043 - '/tmp/OPENBMC_general.txt'
George Keishing6ea92b02021-07-01 11:20:50 -050044 PROTOCOL:
45 - 'SSH'
Peter D Phan72ce6b82021-06-03 06:18:26 -050046
George Keishing6ea92b02021-07-01 11:20:50 -050047 OPENBMC_LOGS:
48 COMMANDS:
Peter D Phand1fccd32021-07-21 06:45:54 -050049 - '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'
George Keishingfd246e22021-08-10 08:35:02 -050065 - 'killall -s SIGUSR1 pldmd; sleep 5'
George Keishing6ea92b02021-07-01 11:20:50 -050066 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'
George Keishingfd246e22021-08-10 08:35:02 -050083 - '/tmp/pldm_flight_recorder'
George Keishing6ea92b02021-07-01 11:20:50 -050084 PROTOCOL:
85 - 'SSH'
Peter D Phan56429a62021-06-23 08:38:29 -050086
Peter D Phanbabf2962021-07-07 11:24:40 -050087 # DUMP_LOGS: This section provides option to 'SCP if file exist'.
Peter D Phane86d9a52021-07-15 10:42:25 -050088 # COMMANDS: filename is preceded by ls -AX '.
Peter D Phanbabf2962021-07-07 11:24:40 -050089 # FILES: is not needed and is ignored if exists.
George Keishing6ea92b02021-07-01 11:20:50 -050090 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'
George Keishing6ea92b02021-07-01 11:20:50 -050095 PROTOCOL:
Peter D Phanbabf2962021-07-07 11:24:40 -050096 - 'SCP'
Peter D Phan0c669772021-06-24 13:52:42 -050097
George Keishing6ea92b02021-07-01 11:20:50 -050098 # 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:
George Keishing506b0582021-07-27 09:31:22 -0500102 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
George Keishing91308ea2021-08-10 14:43:15 -0500110 - plugin:
111 - plugin_name: plugin.redfish.enumerate_request
112 - plugin_args:
113 - ${hostname}
114 - ${username}
115 - ${password}
116 - /redfish/v1/
117 - json
George Keishing6ea92b02021-07-01 11:20:50 -0500118 FILES:
George Keishinga5079d72021-07-06 00:26:10 -0500119 - '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'
George Keishing91308ea2021-08-10 14:43:15 -0500126 - 'REDFISH_enumerate_v1.json'
George Keishing6ea92b02021-07-01 11:20:50 -0500127 PROTOCOL:
128 - 'REDFISH'
129
130 # Commands and Files to collect for via out of band IPMI.
131 IPMI_LOGS:
132 COMMANDS:
George Keishing484f8242021-07-27 01:42:02 -0500133 - 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
George Keishing6ea92b02021-07-01 11:20:50 -0500136 FILES:
137 - 'IPMI_LAN_print.txt'
138 - 'IPMI_FRU_list.txt'
139 - 'IPMI_USER_list.txt'
140 PROTOCOL:
141 - 'IPMI'
George Keishingeafba182021-06-29 13:44:58 -0500142
Peter D Phan72ce6b82021-06-03 06:18:26 -0500143# Commands and Files to collect for all Linux distributions
144LINUX:
George Keishing6ea92b02021-07-01 11:20:50 -0500145 LINUX_LOGS:
146 COMMANDS:
Peter D Phand1fccd32021-07-21 06:45:54 -0500147 - '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 '
George Keishing6ea92b02021-07-01 11:20:50 -0500159 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'
Peter D Phan72ce6b82021-06-03 06:18:26 -0500174
175# Commands and Files to collect for Ubuntu Linux only
Peter D Phan04aca3b2021-06-21 10:37:18 -0500176UBUNTU:
George Keishing0c0bdd42021-07-23 13:36:06 -0500177 GENERAL:
George Keishing6ea92b02021-07-01 11:20:50 -0500178 COMMANDS:
George Keishing0c0bdd42021-07-23 13:36:06 -0500179 - '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'
George Keishing6ea92b02021-07-01 11:20:50 -0500188 FILES:
George Keishing0c0bdd42021-07-23 13:36:06 -0500189 - '/tmp/UBUNTU_general.txt'
George Keishing86399c92021-07-01 13:01:49 -0500190 PROTOCOL:
191 - 'SSH'
George Keishing0c0bdd42021-07-23 13:36:06 -0500192 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'
George Keishing86399c92021-07-01 13:01:49 -0500213
Peter D Phan72ce6b82021-06-03 06:18:26 -0500214# Commands and Files to collect for RHE Linux only
Peter D Phan04aca3b2021-06-21 10:37:18 -0500215RHEL:
George Keishing0c0bdd42021-07-23 13:36:06 -0500216 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'
George Keishing6ea92b02021-07-01 11:20:50 -0500231 RHEL_LOGS:
232 COMMANDS:
Peter D Phand1fccd32021-07-21 06:45:54 -0500233 - '{ cat /etc/os-release; uname -a; rpm -qa ; } >/tmp/OS_info.txt'
234 - 'tail -n 200000 /var/log/messages >/tmp/OS_syslog.txt'
George Keishing6ea92b02021-07-01 11:20:50 -0500235 - 'rm -rf /tmp/sosreport*FFDC*'
Peter D Phand1fccd32021-07-21 06:45:54 -0500236 - {'sosreport --batch --tmp-dir /tmp --label FFDC >/tmp/OS_sosreport.txt': 1200}
George Keishing0c0bdd42021-07-23 13:36:06 -0500237 - 'tar -zcvf /tmp/crash.tar.gz /var/crash'
George Keishing6ea92b02021-07-01 11:20:50 -0500238 FILES:
George Keishing6ea92b02021-07-01 11:20:50 -0500239 - '/tmp/OS_info.txt'
George Keishing5b43c222021-07-09 01:10:00 -0500240 - '/tmp/OS_syslog.txt'
George Keishing6ea92b02021-07-01 11:20:50 -0500241 - '/tmp/OS_sosreport.txt'
George Keishing86399c92021-07-01 13:01:49 -0500242 - '/tmp/sosreport*.tar.xz'
George Keishing0c0bdd42021-07-23 13:36:06 -0500243 - '/tmp/crash.tar.gz'
George Keishing86399c92021-07-01 13:01:49 -0500244 PROTOCOL:
245 - 'SSH'
George Keishing0c0bdd42021-07-23 13:36:06 -0500246 DUMP_LOGS:
247 COMMANDS:
248 - 'ls -AX /tmp/htx/htxerr'
249 - 'ls -AX /tmp/htx/htxmsg'
250 PROTOCOL:
251 - 'SCP'
George Keishing86399c92021-07-01 13:01:49 -0500252
George Keishing5b43c222021-07-09 01:10:00 -0500253# Commands and Files to collect for SLES Linux only
254SLES:
George Keishing0c0bdd42021-07-23 13:36:06 -0500255 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'
George Keishing5b43c222021-07-09 01:10:00 -0500270 SLES_LOGS:
271 COMMANDS:
Peter D Phand1fccd32021-07-21 06:45:54 -0500272 - '{ cat /etc/os-release; uname -a; rpm -qa ; } >/tmp/OS_info.txt'
273 - 'tail -n 200000 /var/log/messages >/tmp/OS_syslog.txt'
George Keishing5b43c222021-07-09 01:10:00 -0500274 - 'rm -rf /tmp/scc*.txz.md5'
Peter D Phand1fccd32021-07-21 06:45:54 -0500275 - {'supportconfig >/tmp/OS_supportconfig.txt': 1200}
George Keishing5b43c222021-07-09 01:10:00 -0500276 - 'cp /var/log/scc*.txz.md5 /tmp/'
George Keishing0c0bdd42021-07-23 13:36:06 -0500277 - 'tar -zcvf /tmp/crash.tar.gz /var/crash'
George Keishing5b43c222021-07-09 01:10:00 -0500278 FILES:
279 - '/tmp/OS_info.txt'
280 - '/tmp/OS_syslog.txt'
281 - '/tmp/OS_supportconfig.txt'
George Keishing5b43c222021-07-09 01:10:00 -0500282 - '/tmp/scc*.txz.md5'
George Keishing0c0bdd42021-07-23 13:36:06 -0500283 - '/tmp/crash.tar.gz'
George Keishing5b43c222021-07-09 01:10:00 -0500284 PROTOCOL:
285 - 'SSH'
George Keishing0c0bdd42021-07-23 13:36:06 -0500286 DUMP_LOGS:
287 COMMANDS:
288 - 'ls -AX /tmp/htx/htxerr'
289 - 'ls -AX /tmp/htx/htxmsg'
290 PROTOCOL:
291 - 'SCP'
George Keishing5b43c222021-07-09 01:10:00 -0500292
George Keishinga3f3f592021-06-17 11:28:04 -0500293# Commands and Files to collect for AIX only
Peter D Phan04aca3b2021-06-21 10:37:18 -0500294AIX:
George Keishing0c0bdd42021-07-23 13:36:06 -0500295 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'
George Keishing6ea92b02021-07-01 11:20:50 -0500312 AIX_LOGS:
313 COMMANDS:
George Keishing0c0bdd42021-07-23 13:36:06 -0500314 - 'errpt -a >/tmp/OS_errpt.txt ; errclear 0;'
Peter D Phand1fccd32021-07-21 06:45:54 -0500315 - 'bindprocessor -q >/tmp/OS_processors.txt'
George Keishing6ea92b02021-07-01 11:20:50 -0500316 FILES:
317 - '/tmp/OS_errpt.txt'
318 - '/tmp/OS_processors.txt'
319 PROTOCOL:
320 - 'SSH'
George Keishing0c0bdd42021-07-23 13:36:06 -0500321 DUMP_LOGS:
322 COMMANDS:
323 - 'ls -AX /tmp/htx/htxerr'
324 - 'ls -AX /tmp/htx/htxmsg'
George Keishing0c0bdd42021-07-23 13:36:06 -0500325 PROTOCOL:
326 - 'SCP'