summaryrefslogtreecommitdiffstats
path: root/Documentation/nvme-virt-mgmt.txt
blob: e4d14e293dbbeae2d8b1fef375f6c53ef08b2954 (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
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
nvme-virt-mgmt(1)
=================

NAME
----
nvme-virt-mgmt - Manage flexible resources between primary and secondary
controller

SYNOPSIS
--------
[verse]
'nvme virt-mgmt' <device> [--cntlid=<cntlid> | -c <cntlid>]
			[--rt=<rt> | -r <rt>] [--act=<act> | -a <act>]
			[--nr=<nr> | -n <nr>]
			[--output-format=<fmt> | -o <fmt>] [--verbose | -v]
			[--timeout=<timeout> | -t <timeout>]

DESCRIPTION
-----------
Manage flexible resources between primary and secondary controller, return
results.

The <device> parameter is mandatory and may be either the NVMe character
device (ex: /dev/nvme0) or block device (ex: /dev/nvme0n1).

On success it returns 0, error code otherwise.

OPTIONS
-------
-c <cntlid>::
--cntlid=<cntlid>::
	Controller identifier (CNTLID)

-r <rt>::
--rt=<rt>::
	Resource Type (RT): [0,1]
	0h: VQ Resources
	1h: VI Resources

-a <act>::
--act=<act>::
	Action(ACT): [1,7,8,9]
	1h: Primary Flexible
	7h: Secondary Offline
	8h: Secondary Assign
	9h: Secondary Online

-n <nr>::
--nr=<nr>::
	Number of controller resources (NR)

-o <fmt>::
--output-format=<fmt>::
	Set the reporting format to 'normal', 'json' or 'binary'. Only one
	output format can be used at a time.

-v::
--verbose::
	Increase the information detail in the output.

-t <timeout>::
--timeout=<timeout>::
	Override default timeout value. In milliseconds.

EXAMPLES
--------
* Has the program issue a virt-mgmt to manage flexible resources.
+
------------
# nvme virt-mgmt /dev/nvme0 -c 0 -r 1 -a 1 -n 0
------------

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