'\" t
.\"     Title: ipmctl-dump-session
.\"    Author: [see the "AUTHOR(S)" section]
.\" Generator: Asciidoctor 2.0.16
.\"      Date: 2021-12-29
.\"    Manual: ipmctl
.\"    Source: ipmctl
.\"  Language: English
.\"
.TH "IPMCTL\-DUMP\-SESSION" "1" "2021-12-29" "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-session \- Dumps content captured during a recording session.
.SH "SYNOPSIS"
.sp
.if n .RS 4
.nf
.fam C
ipmctl dump [OPTIONS] \-destination (path) \-session
.fam
.fi
.if n .RE
.SH "DESCRIPTION"
.sp
Dumps content captured during a recording session.
Captured content includes ACPI, SMBIOS tables,
and FIS requests and responses. The resulting session file
that is generated can be used to playback commands recorded
on a real platform in a simulated environment,
making it possible to debug issues offline.
.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
.SH "TARGET"
.sp
\-destination (path)
.RS 4
An absolute or relative path including the filename, where the contents
of the active session will be copied to.
.RE
.sp
\-session
.RS 4
Specifies to dump the contents associated with an active recording session.
.RE
.SH "EXAMPLES"
.sp
Dump the contents associated with the current active recording session to
/tmp/session.pbr.
.sp
.if n .RS 4
.nf
.fam C
ipmctl dump \-destination /tmp/session.pbr \-session
.fam
.fi
.if n .RE
.SH "LIMITATIONS"
.sp
To successfully execute this command, there must be an active recording session.
.SH "RETURN DATA"
.sp
The resulting file includes, NFIT, PCAT, PMTT and SMBIOS tables that are used by IPMCTL
to determine the PMem module topology.  PMem module data that is transferred to/from PMem modules
over the mailbox interface.
.SH "SAMPLE OUTPUT"
.sp
.if n .RS 4
.nf
.fam C
Successfully dumped 1060619 bytes to file.
.fam
.fi
.if n .RE