1IPMCTL-START-SESSION(1)             ipmctl             IPMCTL-START-SESSION(1)
2
3
4

NAME

6       ipmctl-start-session - Starts a recording or playback session.
7

SYNOPSIS

9           ipmctl start [OPTIONS] -session -mode (record|playback|playback_manual) [TARGETS]
10

DESCRIPTION

12       Starts a recording or playback session. The recording session records
13       the platform’s ACPI NFIT, PCAT, PMTT tables, SMBIOS tables, and FIS
14       mailbox transactions that occur during the recording session. The
15       normal use-case would be to start a recording session, execute commands
16       (e.g., create -goal, show -sensors, etc.) to be recorded, dump the
17       recorded session using the [Dump Session] command, followed by stopping
18       the session using the [Stop Session] command. The "dumped" session can
19       then be loaded and "played" back on any platform that can execute the
20       ipmctl tool.
21
22       The playback session has two modes: playback and playback_manual. The
23       playback mode will automatically execute all commands that were
24       previously recorded. The playback_manual mode allows commands to be
25       executed one at a time in a manual fashion. If a tag is given, the
26       playback will begin at the command that corresponds with the tagID.
27       Note, the [Show Session] command displays the order and commands to
28       execute, where the * denotes which command to execute next.
29

OPTIONS

31       -f, -force
32           Do not warn the user that starting a new session terminates an
33           active recording session resulting in deleting recorded content.
34
35       -h, -help
36           Displays help for the command.
37
38       -ddrt
39           Used to specify DDRT as the desired transport protocol for the
40           current invocation of ipmctl.
41
42       -smbus
43           Used to specify SMBUS as the desired transport protocol for the
44           current invocation of ipmctl.
45
46           Note
47           The -ddrt and -smbus options are mutually exclusive and may not be
48           used together.
49

TARGET

51       -session
52           Specifies to start a session.
53
54       -mode (record|playback|playback_manual)
55           The session modes supported. One of:
56
57           ·   "record" - records data associated with command execution
58
59           ·   "playback" - automatically executes commands previously
60               recorded
61
62           ·   "playback_manual" - enables manual execution of commands
63               previously recorded
64
65       -tag [tagID]
66           Specifies the starting command by tagID. Only available with
67           "playback" and "playback_manual" mode.
68

EXAMPLES

70       Start a recording session.
71
72           ipmctl start -session -mode record
73
74       Automatically execute commands in a session.
75
76           ipmctl start -session -mode playback
77
78       Allow for manual execution of commands in playback mode
79
80           ipmctl start -session -mode playback_manual
81

LIMITATIONS

83       Recordings should be played back on the same IPMCTL version that
84       created the recording. Recordings taken in UEFI should be played back
85       in the UEFI environment (simulated or real). Recordings taken in an OS
86       are binary compatible with other OS versions of IPMCTL (i.e., recording
87       taken in Linux can be played back in Windows).
88

RETURN DATA

90       In playback mode the output will be a concatination of the output from
91       each played back command.
92
93
94
95ipmctl                            2020-05-01           IPMCTL-START-SESSION(1)
Impressum