1NVME-DIM(1)                       NVMe Manual                      NVME-DIM(1)
2
3
4

NAME

6       nvme-dim - Send Discovery Information Management command to one or more
7       Discovery Controllers.
8

SYNOPSIS

10       nvme dim
11                       [--task=<task>     | -t <task>]
12                       [--nqn=<nqn>       | -n <nqn>]
13                       [--device=<device> | -d <device>]
14

DESCRIPTION

16       Send Discovery Information Management (DIM) command to one or more
17       Discovery Controllers. The DIM command allows performing two types of
18       tasks: register or deregister.
19
20       The DIM command is used to explicitly register with Discovery
21       Controllers (DC), especially with Central Discovery Controllers (CDC).
22       CDCs maintain a database (DB) of all the Hosts and Storage Subsystems
23       in a network. The register task is used to add a host to the CDC’s DB.
24       The deregister task is used to remove a host from the CDC’s DB.
25
26       During a register operation the host will send mandatory information
27       such as the Host’s NQN and ID, as well as the Host’s hostname and the
28       Operating System’s version that it is running on. There is also an
29       optional Host Symbolic Name that can be registered with the CDC.
30
31       This command can only be applied to existing DC connections previously
32       created with the nvme-discover(1) command using the --persistent
33       option.
34

OPTIONS

36       -t <task>, --task <task>
37           The task to perform: "register" or "deregister".
38
39       -n <subnqn>, --nqn <nqn>
40           The DIM command will be sent to the Discovery Controller (DC)
41           matching this NQN. A list of comma-separated NQNs can be supplied
42           to apply the command to more than one DC.
43
44       -d <device>, --device <device>
45           The DIM command will be sent to the Discovery Controllers (DC)
46           associated with this NVMe device handle. A list of comma-separated
47           device handles can be supplied to apply the command to more than
48           one DC.
49

EXAMPLES

51       •   Register with the Central Discovery Controller (CDC) named
52           nqn.1988-11.com.dell:SFSS:1:20220118125153e8:
53
54               # nvme dim --task=register --nqn=nqn.1988-11.com.dell:SFSS:1:20220118125153e8
55
56       •   Deregister from Central Discovery Controller (CDC) associated with
57           nvme4
58
59               # nvme dim --task=deregister --device=nvme4
60

SEE ALSO

62       nvme-discover(1)
63

NVME

65       Part of the nvme-user suite
66
67
68
69NVMe                              10/06/2023                       NVME-DIM(1)