// Copyright (c) 2018, Intel Corporation.
// SPDX-License-Identifier: BSD-3-Clause

ifdef::manpage[]
ipmctl-stop-session(1)
======================
endif::manpage[]

NAME
----
ipmctl-stop-session - Stops the active playback or recording session.

SYNOPSIS
--------
[listing]
ipmctl stop [OPTIONS] -session

DESCRIPTION
-----------
Stops the active playback or recording session.

OPTIONS
-------
-f::
-force::
  Do not warn the user that stopping a new session terminates an active recording
  session resulting in deleting recorded content.

-h::
-help::
    Displays help for the command.

-ddrt::
  Used to specify DDRT as the desired transport protocol for the current invocation of ipmctl.

-smbus::
  Used to specify SMBUS as the desired transport protocol for the current invocation of ipmctl.

NOTE: The -ddrt and -smbus options are mutually exclusive and may not be used together.

TARGET
------
-session::
  Specifies to stop a session.

EXAMPLES
--------
Stop the current session.

[listing]
ipmctl stop -session

LIMITATIONS
-----------
A session must be already started.

SAMPLE OUTPUT
-------------
[listing]
--
Successfully dumped 1060619 bytes to file.

Warning - Executing in playback mode!

Stopping a session will free all recording content.
Do you want to continue? [y/n] y
Stopped PBR session.
--
