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

ifdef::manpage[]
ipmctl-show-cap(1)
===================
endif::manpage[]

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

SYNOPSIS
--------
[listing]
ipmctl show [OPTIONS] -cap [TARGETS]

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

OPTIONS
-------
-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.

ifdef::os_build[]
-o (text|nvmxml)::
-output (text|nvmxml)::
  Changes the output format. One of: "text" (default) or "nvmxml".
endif::os_build[]

TARGETS
-------
-dimm [DimmIDs]::
  Restricts output to specific PMem modules by supplying one or more comma separated
  PMem module identifiers. The default is to display all manageable PMem modules.

EXAMPLES
--------
Lists restrictions for all PMem modules installed in the system
[listing]
ipmctl show -cap

Lists restrictions for PMem module 0x1001
[listing]
ipmctl show -dimm 0x1001 -cap

LIMITATIONS
-----------
In order to successfully execute this command:

- The caller must have the appropriate privileges.

- The specified PMem modules must be manageable by the host software.

RETURN DATA
-----------
The default behavior is to return a table which indicates the restrictions enforced by Command Access Policy (CAP).

DimmID::
  The default display of PMem module identifiers. One of:
  - UID: Use the DimmUID attribute as defined in the command Show Device.
  - HANDLE: Use the DimmHandle attribute as defined in the command Show Device.
    This is the default.

Opcode::
  The Opcode for a command.

SubOpcode::
  The SubOpcode for a command.

Restriction::
  Text describing which mailboxes are restricted for Opcode:SubOcode combination. One of:
  - None
  - BIOS only
  - SMBus only
  - BIOS and SMBus only
  - Unsupported
