NVME-EXCLUSION-EDI(1)

NAME
nvme-exclusion-edit - Edit an NVMe-oF exclusion list in an editor

SYNOPSIS

nvme [<global-options>] exclusion edit [--name=<NAME> | -N <NAME>]

DESCRIPTION

Open the NVMe-oF exclusion list named <NAME> in the editor named by the $EDITOR environment variable, in the same spirit as visudo or crontab -e. A missing list is created.

The list is edited through a private scratch copy and installed by name only when the editor exits. On save the result is validated; if it contains a bad entry you are offered the chance to re-open the editor and fix it. If the list changed on disk while you were editing, the save is refused so a concurrent editor’s changes are never silently overwritten. Whenever the changes are not saved, the scratch copy is kept and its path printed so your edits are recoverable.

This command requires root.

OPTIONS

-N <NAME>, --name=<NAME>
    Name of the exclusion list to edit. Omit to edit the default list (/etc/nvme/exclusions.conf).

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

    • Edit the user list:

        # nvme exclusion edit --name user

    • Use a specific editor:

        # EDITOR=vi nvme exclusion edit --name user

SEE ALSO

nvme-exclusion-add(1) nvme-exclusion-remove(1) nvme-exclusion-list(1) nvme-disconnect(1)

NVME

Part of the nvme-user suite