Options for the Aerospike Shared-Memory Tool (ASMT)

For the complete documentation index see: llms.txt

All documentation pages available in markdown.

The help option (-h) for asmt prints usage information. Key options and notes:

usage: asmt [-a] [-b] [-c] [-h] [-i <instance>] -n <name>[,<name>...]
            -p <pathdir> [-r] [-t <threads>] [-v] [-z]

-a analyze (advisory - goes with '-b' or '-r')
-b backup (operation or advisory with '-a')
-c compare crc32 values of segments and segment files
-h help
-i filter by instance (default is instance 0)
-n filter by namespace name
-p path of directory (mandatory)
-r restore (operation or advisory with '-a')
-t maximum number of threads for I/O
-v verbose output
-z compress files on backup

Notes:

1. The '-c' option has a significant performance cost, which is reduced when combined with the '-z' option.
2. Run ASMT in verbose mode ('-v') if possible.
3. You can provide a comma-separated list of namespaces to ASMT.

Possible primary option combinations:

-b     Perform backup operation ('-p' required).
-r     Perform restore operation ('-p' required).
-ba    Analyze backup operation ('-p' required).
-ra    Analyze restore operation ('-p' required).

Option	Description
-a	Analyzes whether an operation can be performed without running it.
-b	Backs up the indexes from shared memory to the file system. Can be combined with `-a`
-c	Computes a standard 32-bit cyclic redundancy check (CRC-32) to ensure that the contents of the index were not corrupted while being backed up or restored. Computing the CRC-32 can be computationally expensive; this cost is reduced when combined with `-z`, and is often negligible with compression enabled.
-h	Shows information about how to use ASMT.
-i	Selects the Aerospike Database instance index on this host (`0`–`15`). Use when multiple instances run on the same server. The default is `0`.
-n	(mandatory) Selects a particular namespace. Example: `-n namespace1`. You can specify multiple namespaces with a comma-separated list. Example: `-n namespace1,namespace2,namespace3`.
-p	(mandatory) Specifies the path to the index backup directory
-r	Restores the indexes from the file system to shared memory. Can be combined with `-a`
-t	Specifies the maximum number of I/O threads to use for backing up or restoring. Typically, ASMT creates one I/O thread per CPU core, but you can force it to use fewer threads. Increasing the value to an integer greater than the number of CPU cores on the current system has no effect.
-v	Specifies that ASMT should produce verbose output. This option is recommended.
-z	Compresses the index backup file. Compression can result in files that are 15-30% smaller and quicker to write, at the cost of a small amount of computation. When you restore a compressed index, you do not need to specify this option.

Options for the Aerospike Shared-Memory Tool (ASMT)

Related topics