blob: 84717338dd8c30ab01c190eec8a418db37d36259 [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 Keishing6ea92b02021-07-01 11:20:50 -050040 FILES:
George Keishing4dd1aa32021-07-07 01:11:07 -050041 - '/tmp/OPENBMC_general.txt'
George Keishing6ea92b02021-07-01 11:20:50 -050042 PROTOCOL:
43 - 'SSH'
Peter D Phan72ce6b82021-06-03 06:18:26 -050044
George Keishing6ea92b02021-07-01 11:20:50 -050045 OPENBMC_LOGS:
46 COMMANDS:
Peter D Phand1fccd32021-07-21 06:45:54 -050047 - 'cat /sys/class/watchdog/watchdog1/bootstatus >/tmp/BMC_flash_side.txt'
48 - 'grep -r . /sys/class/hwmon/* >/tmp/BMC_hwmon.txt'
49 - 'top -n 1 -b >/tmp/BMC_proc_list.txt'
50 - 'ls -Al /proc/*/fd/ >/tmp/BMC_proc_fd_active_list.txt'
51 - 'journalctl --no-pager >/tmp/BMC_journalctl_nopager.txt'
52 - 'journalctl -o json-pretty >/tmp/BMC_journalctl_pretty.json'
53 - 'dmesg >/tmp/BMC_dmesg.txt'
54 - 'cat /proc/cpuinfo >/tmp/BMC_procinfo.txt'
55 - 'cat /proc/meminfo >/tmp/BMC_meminfo.txt'
56 - 'systemctl status --all >/tmp/BMC_systemd.txt'
57 - 'systemctl list-units --failed >/tmp/BMC_failed_service.txt'
58 - 'systemctl list-jobs >/tmp/BMC_list_service.txt'
59 - 'cat /var/log/obmc-console.log >/tmp/BMC_obmc_console.txt'
60 - 'cat /var/log/obmc-console1.log >/tmp/BMC_obmc_console1.txt'
61 - 'peltool -l >/tmp/PEL_logs_list.json'
62 - 'peltool -a >/tmp/PEL_logs_display.json'
George Keishing6ea92b02021-07-01 11:20:50 -050063 FILES:
64 - '/tmp/BMC_flash_side.txt'
65 - '/tmp/BMC_hwmon.txt'
66 - '/tmp/BMC_proc_list.txt'
67 - '/tmp/BMC_proc_fd_active_list.txt'
68 - '/tmp/BMC_journalctl_nopager.txt'
69 - '/tmp/BMC_journalctl_pretty.json'
70 - '/tmp/BMC_dmesg.txt'
71 - '/tmp/BMC_procinfo.txt'
72 - '/tmp/BMC_meminfo.txt'
73 - '/tmp/BMC_systemd.txt'
74 - '/tmp/BMC_failed_service.txt'
75 - '/tmp/BMC_list_service.txt'
76 - '/tmp/BMC_obmc_console.txt'
77 - '/tmp/BMC_obmc_console1.txt'
78 - '/tmp/PEL_logs_list.json'
79 - '/tmp/PEL_logs_display.json'
80 PROTOCOL:
81 - 'SSH'
Peter D Phan56429a62021-06-23 08:38:29 -050082
Peter D Phanbabf2962021-07-07 11:24:40 -050083 # DUMP_LOGS: This section provides option to 'SCP if file exist'.
Peter D Phane86d9a52021-07-15 10:42:25 -050084 # COMMANDS: filename is preceded by ls -AX '.
Peter D Phanbabf2962021-07-07 11:24:40 -050085 # FILES: is not needed and is ignored if exists.
George Keishing6ea92b02021-07-01 11:20:50 -050086 DUMP_LOGS:
87 COMMANDS:
88 - 'ls -AX /var/lib/systemd/coredump/core.*'
89 - 'ls -AX /var/lib/phosphor-debug-collector/dumps/*/*.tar.xz'
90 - 'ls -AX /var/lib/phosphor-debug-collector/hostbootdump/*/*.tar.gz'
91 FILES:
92 - '/var/lib/systemd/coredump/core.*'
93 - '/var/lib/phosphor-debug-collector/dumps/*/*.tar.xz'
94 - '/var/lib/phosphor-debug-collector/hostbootdump/*/*.tar.gz'
95 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:
102 URL:
103 - '/xyz/openbmc_project/software/enumerate'
104 - '/xyz/openbmc_project/state/enumerate'
105 - '/org/open_power/enumerate'
106 - '/redfish/v1/AccountService/Accounts'
107 - '/redfish/v1/Managers/bmc/LogServices/Dump/Entries'
108 - '/redfish/v1/Systems/system/LogServices/Dump/Entries'
109 - '/redfish/v1/Systems/system/LogServices/EventLog/Entries'
110 FILES:
George Keishinga5079d72021-07-06 00:26:10 -0500111 - 'REDFISH_software.json'
112 - 'REDFISH_bmc_state.json'
113 - 'REDFISH_openpower_control_occ_state.json'
114 - 'REDFISH_bmc_user_accounts.json'
115 - 'REDFISH_bmc_dump_entries.json'
116 - 'REDFISH_system_dumps_entries.json'
117 - 'REDFISH_event_log_entries.json'
George Keishing6ea92b02021-07-01 11:20:50 -0500118 PROTOCOL:
119 - 'REDFISH'
120
121 # Commands and Files to collect for via out of band IPMI.
122 IPMI_LOGS:
123 COMMANDS:
124 - 'lan print'
125 - 'fru list'
126 - 'user list'
127 FILES:
128 - 'IPMI_LAN_print.txt'
129 - 'IPMI_FRU_list.txt'
130 - 'IPMI_USER_list.txt'
131 PROTOCOL:
132 - 'IPMI'
George Keishingeafba182021-06-29 13:44:58 -0500133
Peter D Phan72ce6b82021-06-03 06:18:26 -0500134# Commands and Files to collect for all Linux distributions
135LINUX:
George Keishing6ea92b02021-07-01 11:20:50 -0500136 LINUX_LOGS:
137 COMMANDS:
Peter D Phand1fccd32021-07-21 06:45:54 -0500138 - 'cat /sys/firmware/opal/msglog >/tmp/OS_msglog.txt'
139 - 'ppc64_cpu --frequency >/tmp/OS_cpufrequency.txt'
140 - 'dmesg >/tmp/OS_dmesg.txt'
141 - 'cat /var/log/opal-prd* >/tmp/OS_opal_prd.txt'
142 - 'cat /var/log/boot.log >/tmp/OS_boot.txt'
143 - 'cat /proc/cpuinfo >/tmp/OS_procinfo.txt'
144 - 'cat /proc/meminfo >/tmp/OS_meminfo.txt'
145 - 'netstat -a >/tmp/OS_netstat.txt'
146 - 'lspci >/tmp/OS_lspci.txt'
147 - 'lscpu >/tmp/OS_lscpu.txt'
148 - 'lscfg >/tmp/OS_lscfg.txt'
149 - 'journalctl --no-pager -b > /tmp/OS_journalctl_nopager.txt '
George Keishing6ea92b02021-07-01 11:20:50 -0500150 FILES:
151 - '/tmp/OS_msglog.txt'
152 - '/tmp/OS_cpufrequency.txt'
153 - '/tmp/OS_dmesg.txt'
154 - '/tmp/OS_opal_prd.txt'
155 - '/tmp/OS_boot.txt'
156 - '/tmp/OS_procinfo.txt'
157 - '/tmp/OS_meminfo.txt'
158 - '/tmp/OS_netstat.txt'
159 - '/tmp/OS_lspci.txt'
160 - '/tmp/OS_lscpu.txt'
161 - '/tmp/OS_lscfg.txt'
162 - '/tmp/OS_journalctl_nopager.txt'
163 PROTOCOL:
164 - 'SSH'
Peter D Phan72ce6b82021-06-03 06:18:26 -0500165
166# Commands and Files to collect for Ubuntu Linux only
Peter D Phan04aca3b2021-06-21 10:37:18 -0500167UBUNTU:
George Keishing6ea92b02021-07-01 11:20:50 -0500168 UBUNTU_LOGS:
169 COMMANDS:
Peter D Phand1fccd32021-07-21 06:45:54 -0500170 - '{ lsusb -t ; lsusb -v ; } >/tmp/OS_isub.txt'
171 - 'tail -n 50000 /var/log/kern.log >/tmp/OS_kern.txt'
172 - '{ cat /var/log/auth.log; cat /var/log/auth.log.1 ; } >/tmp/OS_authlog.txt'
173 - 'tail -n 200000 /var/log/syslog >/tmp/OS_syslog.txt'
174 - '{ uname -a; dpkg -s opal-prd; dpkg -s ipmitool ; } >/tmp/OS_info.txt'
George Keishing6ea92b02021-07-01 11:20:50 -0500175 - 'rm -rf /tmp/sosreport*FFDC*'
Peter D Phan2b6cb3a2021-07-19 06:55:42 -0500176 - {'sosreport --batch --tmp-dir /tmp --ticket-number FFDC >/tmp/OS_sosreport.txt': 1200}
George Keishing6ea92b02021-07-01 11:20:50 -0500177 FILES:
178 - '/tmp/OS_isub.txt'
179 - '/tmp/OS_kern.txt'
180 - '/tmp/OS_authlog.txt'
181 - '/tmp/OS_syslog.txt'
182 - '/tmp/OS_info.txt'
183 - '/tmp/OS_sosreport.txt'
George Keishing86399c92021-07-01 13:01:49 -0500184 - '/tmp/sosreport*.tar.xz'
185 PROTOCOL:
186 - 'SSH'
187
Peter D Phan72ce6b82021-06-03 06:18:26 -0500188# Commands and Files to collect for RHE Linux only
Peter D Phan04aca3b2021-06-21 10:37:18 -0500189RHEL:
George Keishing6ea92b02021-07-01 11:20:50 -0500190 RHEL_LOGS:
191 COMMANDS:
Peter D Phand1fccd32021-07-21 06:45:54 -0500192 - '{ cat /etc/os-release; uname -a; rpm -qa ; } >/tmp/OS_info.txt'
193 - 'tail -n 200000 /var/log/messages >/tmp/OS_syslog.txt'
George Keishing6ea92b02021-07-01 11:20:50 -0500194 - 'rm -rf /tmp/sosreport*FFDC*'
Peter D Phand1fccd32021-07-21 06:45:54 -0500195 - {'sosreport --batch --tmp-dir /tmp --label FFDC >/tmp/OS_sosreport.txt': 1200}
George Keishing6ea92b02021-07-01 11:20:50 -0500196 FILES:
George Keishing6ea92b02021-07-01 11:20:50 -0500197 - '/tmp/OS_info.txt'
George Keishing5b43c222021-07-09 01:10:00 -0500198 - '/tmp/OS_syslog.txt'
George Keishing6ea92b02021-07-01 11:20:50 -0500199 - '/tmp/OS_sosreport.txt'
George Keishing86399c92021-07-01 13:01:49 -0500200 - '/tmp/sosreport*.tar.xz'
201 PROTOCOL:
202 - 'SSH'
203
George Keishing5b43c222021-07-09 01:10:00 -0500204# Commands and Files to collect for SLES Linux only
205SLES:
206 SLES_LOGS:
207 COMMANDS:
Peter D Phand1fccd32021-07-21 06:45:54 -0500208 - '{ cat /etc/os-release; uname -a; rpm -qa ; } >/tmp/OS_info.txt'
209 - 'tail -n 200000 /var/log/messages >/tmp/OS_syslog.txt'
George Keishing5b43c222021-07-09 01:10:00 -0500210 - 'rm -rf /tmp/scc*.txz.md5'
Peter D Phand1fccd32021-07-21 06:45:54 -0500211 - {'supportconfig >/tmp/OS_supportconfig.txt': 1200}
George Keishing5b43c222021-07-09 01:10:00 -0500212 - 'cp /var/log/scc*.txz.md5 /tmp/'
213 FILES:
214 - '/tmp/OS_info.txt'
215 - '/tmp/OS_syslog.txt'
216 - '/tmp/OS_supportconfig.txt'
George Keishing5b43c222021-07-09 01:10:00 -0500217 - '/tmp/scc*.txz.md5'
218 PROTOCOL:
219 - 'SSH'
220
George Keishinga3f3f592021-06-17 11:28:04 -0500221# Commands and Files to collect for AIX only
Peter D Phan04aca3b2021-06-21 10:37:18 -0500222AIX:
George Keishing6ea92b02021-07-01 11:20:50 -0500223 AIX_LOGS:
224 COMMANDS:
Peter D Phand1fccd32021-07-21 06:45:54 -0500225 - 'errpt >/tmp/OS_errpt.txt ; errclear 0;'
226 - 'bindprocessor -q >/tmp/OS_processors.txt'
George Keishing6ea92b02021-07-01 11:20:50 -0500227 FILES:
228 - '/tmp/OS_errpt.txt'
229 - '/tmp/OS_processors.txt'
230 PROTOCOL:
231 - 'SSH'