summaryrefslogtreecommitdiffstats
path: root/Documentation/nvme-lnvm-create.txt
blob: 3c9109dd1b0d2727279964d79c5528d57dd34505 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
nvme-lnvm-create(1)
===================

NAME
----
nvme-lnvm-create - Instantiate a target on top of a LightNVM enabled device

SYNOPSIS
--------
[verse]
'nvme lnvm-create' [--device-name=<DEVICE> | -d <DEVICE>]
			[--target-name=<TARGET> | -n <TARGET>]
			[--target-type=<TARGETTYPE> | -t <TARGETTYPE>]
			[--lun-begin <NUM> | -b <NUM>]
			[--lun-end <NUM> | -e <NUM>]

DESCRIPTION
-----------
Instantiate a target on top of a LightNVM enabled device. This exposes the
physical for the user to use.

The target name is the name of which the media is exposed as in
/dev/<targetname>

The target type is the target to be instantiated. Typically pblk or rrpc.

LUN begin and end defines the range of LUNs to use for a target instantiation.

OPTIONS
-------
--device-name=<DEVICE>::
-d <DEVICE>::
	Device name to initialize.

--target-name=<TARGET>::
-n <TARGET>::
	Target name of the device to initialize. For example: target0.

--target-type=<TARGETTYPE>::
-t <TARGETTYPE>::
	Target type of the device to use. For example: pblk

--lun-begin <NUM>::
-b <NUM>::
	Begin LUN id offset to use for target

--lun-end <NUM>::
-e <NUM>::
	End LUN id offset to use for target

EXAMPLES
--------
* Initialize nvme0n1 with pblk target with 64 LUNs.
------------
# nvme lnvm-create -d nvme0n1 -t pblk -n target0 -b 0 -e 63
------------

NVME
----
Part of the nvme-user suite