'\" t
.\"     Title: ipmctl-dump-support-data
.\"    Author: [see the "AUTHOR(S)" section]
.\" Generator: Asciidoctor 2.0.18
.\"      Date: 2023-06-12
.\"    Manual: ipmctl
.\"    Source: ipmctl
.\"  Language: English
.\"
.TH "IPMCTL\-DUMP\-SUPPORT\-DATA" "1" "2023-06-12" "ipmctl" "ipmctl"
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.ss \n[.ss] 0
.nh
.ad l
.de URL
\fI\\$2\fP <\\$1>\\$3
..
.als MTO URL
.if \n[.g] \{\
.  mso www.tmac
.  am URL
.    ad l
.  .
.  am MTO
.    ad l
.  .
.  LINKSTYLE blue R < >
.\}
.SH "NAME"
ipmctl-dump-support-data \- Dumps a support snapshot to a file
.SH "SYNOPSIS"
.sp
.if n .RS 4
.nf
.fam C
ipmctl dump [OPTIONS] \-destination (file_prefix) [\-dict (filename)] \-support
.fam
.fi
.if n .RE
.SH "DESCRIPTION"
.sp
Creates a support snapshot and dump support data to a file for off\-line analysis
by support personnel. Support data may include system logs, error logs,
trace logs, platform configuration, sensor information and diagnostic results.
.sp
This command may take significantly longer than other commands to complete, because
it combines and executes multiple individual commands.
.sp
Commands executed:
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.  sp -1
.  IP \(bu 2.3
.\}
version
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.  sp -1
.  IP \(bu 2.3
.\}
show \-memoryresources
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.  sp -1
.  IP \(bu 2.3
.\}
show \-a \-system \-capabilities
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.  sp -1
.  IP \(bu 2.3
.\}
show \-a \-topology
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.  sp -1
.  IP \(bu 2.3
.\}
start \-diagnostic
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.  sp -1
.  IP \(bu 2.3
.\}
show \-system
.RE
.sp
Commands executed per PMem module:
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.  sp -1
.  IP \(bu 2.3
.\}
show \-a \-dimm
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.  sp -1
.  IP \(bu 2.3
.\}
show \-a \-sensor \-dimm
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.  sp -1
.  IP \(bu 2.3
.\}
show \-pcd \-dimm
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.  sp -1
.  IP \(bu 2.3
.\}
show \-error media \-dimm
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.  sp -1
.  IP \(bu 2.3
.\}
show \-error thermal \-dimm
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.  sp -1
.  IP \(bu 2.3
.\}
dump \-destination \-debug
.RE
.SH "OPTIONS"
.sp
\-h, \-help
.RS 4
Displays help for the command.
.RE
.sp
\-ddrt
.RS 4
Used to specify DDRT as the desired transport protocol for the current invocation of ipmctl.
.RE
.sp
\-smbus
.RS 4
Used to specify SMBUS as the desired transport protocol for the current invocation of ipmctl.
.RE
.if n .sp
.RS 4
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.ps +1
.B Note
.ps -1
.br
.sp
The \-ddrt and \-smbus options are mutually exclusive and may not be used together.
.sp .5v
.RE
.sp
\-o (text|nvmxml), \-output (text|nvmxml)
.RS 4
Changes the output format of the command execution (the output file content
will remain text). One of: "text" (default) or "nvmxml".
.RE
.SH "TARGET"
.sp
\-destination (filename)
.RS 4
This command creates a text file with a name starting with the given
filename option and dumps the platform support information into it.
In addition, this command also outputs the debug log information in
separate files. Refer to [Dump Debug Log] for more details.
.RE
.sp
\-dict (filename)
.RS 4
Optional file path to the dictionary file. If supplied, the command will
create both the binary debug log and a text file with decoded log data with
the file prefix specified by \-destination. This option is used only to dump
the debug log information.
.RE
.SH "EXAMPLES"
.sp
Creates a text file named dumpfile_platform_support_info.txt and stores the
platform supported data in that file. Also, dumps the debug log info in the
related files that start with the file name dumpfile. Refer to
[Dump Debug Log] for more info on the output files.
.sp
.if n .RS 4
.nf
.fam C
ipmctl dump \-destination filename \-dict nlog_dict.1.1.0.0000.txt \-support
.fam
.fi
.if n .RE
.SH "LIMITATIONS"
.sp
In order to successfully execute this command:
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.  sp -1
.  IP \(bu 2.3
.\}
The caller must have the appropriate privileges.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.  sp -1
.  IP \(bu 2.3
.\}
The specified PMem modules must be manageable by the host software.
.RE
.SH "RETURN DATA"
.sp
Returns the status of the operation.
.SH "SAMPLE OUTPUT"
.sp
On success:
.sp
.if n .RS 4
.nf
.fam C
Dump support data successfully written to filename_platform_support_info.txt.
.fam
.fi
.if n .RE