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

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

NAME
----
ipmctl-show-error-log - Shows thermal or media errors on the specified DCPMMs

SYNOPSIS
--------
[verse]
ipmctl show [OPTIONS] -error (Thermal|Media) [TARGETS] [PROPERTIES]

DESCRIPTION
-----------
Shows thermal or media errors on the specified DCPMMs.

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.

-lpmb::
  Used to specify large transport payload size for the current invocation of ipmctl.

-spmb::
  Used to specify small transport payload size for the current invocation of ipmctl.

NOTE: The -lpmb and -spmb 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]::
  Filter output to events on a specific DCPMM by supplying the dimm target and
  one DCPMM identifier.

PROPERTIES
----------
SequenceNumber::
  Error log entries are stored with a sequence number starting with 1 and
  rolling over back to 1 after 65535. Limit the error log entries returned by
  providing a sequence number. Only errors with a sequence number equal to or
  higher than provided will be returned. The default is 1.

Level::
  Severity level of errors to be fetched. One of:
  - "High": High severity errors (Default)
  - "Low": Low severity errors

Count::
  Max number of error entries to be fetched and printed.
  The default is 8 for media errors and 16 for thermal errors.

EXAMPLES
--------
Show all high thermal error log entries
[verse]
ipmctl show -error Thermal Level=High

Show all low media error log entries
[verse]
ipmctl show -error Thermal Level=High

LIMITATIONS
-----------
To successfully execute this command, the specified DCPMM(s) must be manageable
by the host software.
<commit_msg>Fix typo in documentation example for Show Media Error Log.<commit_after>// Copyright (c) 2018, Intel Corporation.
// SPDX-License-Identifier: BSD-3-Clause

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

NAME
----
ipmctl-show-error-log - Shows thermal or media errors on the specified DCPMMs

SYNOPSIS
--------
[verse]
ipmctl show [OPTIONS] -error (Thermal|Media) [TARGETS] [PROPERTIES]

DESCRIPTION
-----------
Shows thermal or media errors on the specified DCPMMs.

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.

-lpmb::
  Used to specify large transport payload size for the current invocation of ipmctl.

-spmb::
  Used to specify small transport payload size for the current invocation of ipmctl.

NOTE: The -lpmb and -spmb 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]::
  Filter output to events on a specific DCPMM by supplying the dimm target and
  one DCPMM identifier.

PROPERTIES
----------
SequenceNumber::
  Error log entries are stored with a sequence number starting with 1 and
  rolling over back to 1 after 65535. Limit the error log entries returned by
  providing a sequence number. Only errors with a sequence number equal to or
  higher than provided will be returned. The default is 1.

Level::
  Severity level of errors to be fetched. One of:
  - "High": High severity errors (Default)
  - "Low": Low severity errors

Count::
  Max number of error entries to be fetched and printed.
  The default is 8 for media errors and 16 for thermal errors.

EXAMPLES
--------
Show all high thermal error log entries
[verse]
ipmctl show -error Thermal Level=High

Show all low media error log entries
[verse]
ipmctl show -error Thermal Level=Low

LIMITATIONS
-----------
To successfully execute this command, the specified DCPMM(s) must be manageable
by the host software.

{'fraction_non_alphanumeric': 0.10317975340687865, 'fraction_numerical': 0.007354531689379191, 'mean_word_length': 3.6009950248756217, 'pattern_counts': {'":': 4, '<': 3, '<?xml version=': 0, '>': 3, 'https://': 0, 'lorem ipsum': 0, 'www.': 0, 'xml': 6}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '2975321', 'n_tokens_mistral': 1395, 'n_tokens_neox': 1334, 'n_words': 633}