pmem Tools version 1.3

The PMDK repository on GitHub is the ultimate source of information on PMDK from release 2.0! For all questions and to submit eventual issues please follow to that repository. The PMDK documentation collected here should be valid up to the 1.13.1 release but is maintained only on a best-effort basis and may not reflect the latest state of the art.

comment: <> (SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT) comment: <> (LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,) comment: <> (DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY) comment: <> (THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT) comment: <> ((INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE) comment: <> (OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.)

NAME
SYNOPSIS
DESCRIPTION
OPTIONS
COMMANDS
SEE ALSO

NAME

pmempool – Persistent Memory Pool Management Tool

SYNOPSIS

$ pmempool [--help] [--version] <command> [<args>]

DESCRIPTION

The pmempool is a management tool for Persistent Memory pool files created by NVML libraries.

The main purpose of pmempool is to provide a user with a set of utilities for off-line analysis and manipulation of pools created by pmem libraries. The pmempool is a generic command which consists of subcommands for specific purposes. Some of subcommands are required to work without any impact on processed pool, but some of them may create a new or modify an existing one.

The pmempool may be useful for troubleshooting by system administrators and for software developers who work on applications based on NVM Library. The latter may find these tools useful for testing and debugging purposes also.

OPTIONS

-V, --version

Prints the version of pmempool.

-h, --help

Prints synopsis and list of commands.

COMMANDS

Currently there is a following set of commands available:

  • pmempool-info(1) - Prints information and statistics in human-readable format about specified pool.

  • pmempool-check(1) - Checks pool’s consistency and repairs pool if it is not consistent.

  • pmempool-create(1) - Creates a pool of specified type with additional properties specific for this type of pool.

  • pmempool-dump(1) - Dumps usable data from pool in hexadecimal or binary format.

  • pmempool-rm(1) Removes pool file or all pool files listed in pool set configuration file.

  • pmempool-convert(1) - Updates the pool to the latest available layout version.

  • pmempool-sync(1) - Synchronizes replicas within a poolset.

  • pmempool-transform(1) - Modifies internal structure of a poolset.

In order to get more information about specific command you can use pmempool help .

SEE ALSO

libpmemlog(3), libpmemblk(3), libpmemobj(3) and http://pmem.io

The contents of this web site and the associated GitHub repositories are BSD-licensed open source.