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
47       •   dump -destination -debug
48

OPTIONS

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

TARGET

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

EXAMPLES

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

LIMITATIONS

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

RETURN DATA

99       Returns the status of the operation.
100

SAMPLE OUTPUT

102       On success:
103
104           Dump support data successfully written to filename_platform_support_info.txt.
105
106
107
108ipmctl                            2022-09-28       IPMCTL-DUMP-SUPPORT-DATA(1)
Impressum