nvme-rpmb-read-data(1)

# nvme-rpmb-read-data(1) Manual Page

## NAME

nvme-rpmb-read-data - Read authenticated data from an RPMB target

## SYNOPSIS

    nvme [<global-options>] rpmb read-data <device>
                            [--msgfile=<data-file> | -f <data-file>]
                            [--address=<offset> | -o <offset>]
                            [--blocks=<512 byte sectors> | -b <sectors>]
                            [--target=<target-id> | -t <target-id>]

## DESCRIPTION

Supports authenticated data reading from the specified RPMB target, at the given sector offset, writing the resulting data to the file given with --msgfile.

If the requested size is not within the total size supported by the target, the request fails without being sent to the device.

The <device> parameter is mandatory and an NVMe character device (ex: /dev/nvme0) must be specified.

## OPTIONS

-t <target>
--target=<target>

  RPMB target id. This should be one of the supported RPMB targets as reported by nvme rpmb info. If nothing is given, the default of 0 is used as the RPMB target.

-o <offset>
--address=<offset>

  The address (in 512 byte sector offset from 0) to read from on the specified RPMB target.

-b <sectors>
--blocks=<sectors>

  The size in 512 byte sectors to read from the specified RPMB target.

-f <data-file>
--msgfile=<data-file>

  Name of the file the read data is written to. If an existing file is given, data is appended to it.

## GLOBAL OPTIONS

The following options are defined at the top-level `nvme` command and are available to this subcommand:

--dry-run

  Print the command that would be executed, but do not actually execute it.

--no-ioctl-probing

  Disable probing for 64-bit IOCTL support.

--no-retries

  Disable retry logic on transient errors.

-o <fmt>
--output-format=<fmt>

  Set the reporting format to normal, tabular, 'json, or binary. Only one output format may be used at a time.

--output-format-version=<version>

  Select the output format version. Version 1 uses the original field naming, while version 2 (default) provides more consistent and script-friendly field names.

--timeout=<ms>

  Set the timeout for the command in milliseconds.

-v
--verbose

  Increase the level of detail in the output. May be specified multiple times to further increase verbosity.

These options can also be set as machine-wide defaults in nvme-cli.conf(5). A command-line flag always overrides the file.

## EXAMPLES

- Read 200 blocks of (512 bytes) from target 2, at offset 0x100 and save

- the data onto output.bin

      # nvme rpmb read-data /dev/nvme0 -t 2 -f output.bin -b 200 -o 0x100

## NVME

Part of the nvme-user suite