1IPMCTL-SHOW-CAP(1)                  ipmctl                  IPMCTL-SHOW-CAP(1)
2
3
4

NAME

6       ipmctl-show-cap - Shows the current Command Access Policy restrictions.
7

SYNOPSIS

9           ipmctl show [OPTIONS] -cap [TARGETS]
10

DESCRIPTION

12       Shows the current Command Access Policy restrictions. This is a list of
13       Opcode:SubOpcode and the corresponding mailboxes the commands are
14       restricted, if any. Each command may be restricted to None, BIOS only,
15       SMBus only, or BIOS and SMBus only. None indicates that Host, BIOS, and
16       SMBus mailbox access is allowed.
17

OPTIONS

19       -h, -help
20           Displays help for the command.
21
22       -ddrt
23           Used to specify DDRT as the desired transport protocol for the
24           current invocation of ipmctl.
25
26       -smbus
27           Used to specify SMBUS as the desired transport protocol for the
28           current invocation of ipmctl.
29
30           Note
31           The -ddrt and -smbus options are mutually exclusive and may not be
32           used together.
33
34       -o (text|nvmxml), -output (text|nvmxml)
35           Changes the output format. One of: "text" (default) or "nvmxml".
36

TARGETS

38       -dimm [DimmIDs]
39           Restricts output to specific PMem modules by supplying one or more
40           comma separated PMem module identifiers. The default is to display
41           all manageable PMem modules.
42

EXAMPLES

44       Lists restrictions for all PMem modules installed in the system
45
46           ipmctl show -cap
47
48       Lists restrictions for PMem module 0x1001
49
50           ipmctl show -dimm 0x1001 -cap
51

LIMITATIONS

53       In order to successfully execute this command:
54
55       •   The caller must have the appropriate privileges.
56
57       •   The specified PMem modules must be manageable by the host software.
58

RETURN DATA

60       The default behavior is to return a table which indicates the
61       restrictions enforced by Command Access Policy (CAP).
62
63       DimmID
64           The default display of PMem module identifiers. One of:
65
66           •   UID: Use the DimmUID attribute as defined in the command [Show
67               Dimm].
68
69           •   HANDLE: Use the DimmHandle attribute as defined in the command
70               [Show Dimm]. This is the default.
71
72       Opcode
73           The Opcode for a command.
74
75       SubOpcode
76           The SubOpcode for a command.
77
78       Restriction
79           Text describing which mailboxes are restricted for Opcode:SubOpcode
80           combination. One of:
81
82           •   None
83
84           •   BIOS only
85
86           •   SMBus only
87
88           •   BIOS and SMBus only
89
90           •   Management only
91
92           •   Management and BIOS only
93
94           •   Management and SMBus only
95
96           •   Management, BIOS and SMBus only
97
98           •   Unsupported
99
100
101
102ipmctl                            2023-07-20                IPMCTL-SHOW-CAP(1)
Impressum