1IPMCTL-DUMP-SUPPORT-DATA(1)         ipmctl         IPMCTL-DUMP-SUPPORT-DATA(1)
2
3
4

NAME

6       ipmctl-dump-support-data - Dumps a support snapshot to a file
7

SYNOPSIS

9           ipmctl dump [OPTIONS] -destination (file_prefix) [-dict (filename)] -support
10

DESCRIPTION

12       Creates a support snapshot and dump support data to a file for off-line
13       analysis by support personnel. Support data may include system logs,
14       error logs, trace logs, platform configuration, sensor information and
15       diagnostic results.
16
17       This command may take significantly longer than other commands to
18       complete, because it combines and executes multiple individual
19       commands.
20
21       Commands executed:
22
23       •   version
24
25       •   show -memoryresources
26
27       •   show -a -system -capabilities
28
29       •   show -a -topology
30
31       •   start -diagnostic
32
33       •   show -system
34
35       Commands executed per PMem module:
36
37       •   show -a -dimm
38
39       •   show -a -sensor -dimm
40
41       •   show -pcd -dimm
42
43       •   show -error media -dimm
44
45       •   show -error thermal -dimm
46

OPTIONS

48       -h, -help
49           Displays help for the command.
50
51       -ddrt
52           Used to specify DDRT as the desired transport protocol for the
53           current invocation of ipmctl.
54
55       -smbus
56           Used to specify SMBUS as the desired transport protocol for the
57           current invocation of ipmctl.
58
59           Note
60           The -ddrt and -smbus options are mutually exclusive and may not be
61           used together.
62
63       -o (text|nvmxml), -output (text|nvmxml)
64           Changes the output format of the command execution (the output file
65           content will remain text). One of: "text" (default) or "nvmxml".
66

TARGET

68       -destination (filename)
69           This command creates a text file with a name starting with the
70           given filename option and dumps the platform support information
71           into it. In addition, this command also outputs the debug log
72           information in separate files. Refer to Dump Debug Log for more
73           details.
74
75       -dict (filename)
76           Optional file path to the dictionary file. If supplied, the command
77           will create both the binary debug log and a text file with decoded
78           log data with the file prefix specified by -destination. This
79           option is used only to dump the debug log information.
80

EXAMPLES

82       Creates a text file named dumpfile_platform_support_info.txt and stores
83       the platform supported data in that file. Also, dumps the debug log
84       info in the related files that start with the file name dumpfile_*.
85       Refer to Dump Debug Log for more info on the output files.
86
87           ipmctl dump -destination filename -dict nlog_dict.1.1.0.0000.txt -support
88

LIMITATIONS

90       In order to successfully execute this command:
91
92       •   The caller must have the appropriate privileges.
93
94       •   The specified PMem modules must be manageable by the host software.
95

RETURN DATA

97       Returns the status of the operation.
98

SAMPLE OUTPUT

100       On success:
101
102           Dump support data successfully written to filename_platform_support_info.txt.
103
104
105
106ipmctl                            2021-05-13       IPMCTL-DUMP-SUPPORT-DATA(1)
Impressum