summaryrefslogtreecommitdiffstats
path: root/Documentation/nvme-resv-report.txt
blob: 2e12826ed1b15bcb93075a4c3576fc78c6b077e6 (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
nvme-resv-report(1)
===================

NAME
----
nvme-resv-report - Send NVMe Reservation Report, parse the result

SYNOPSIS
--------
[verse]
'nvme resv-report' <device> [--namespace-id=<nsid> | -n <nsid>]
			[--numd=<num-dwords> | -d <num-dwords>] [--eds | -e]
			[--raw-binary | -b]
			[--output-format=<fmt> | -o <fmt>] [--verbose | -v]

DESCRIPTION
-----------
The Reservation Report command returns a Reservation Status data structure
to host memory that describes the registration and reservation status
of a namespace.

The size of the Reservation Status data structure is a function of the
number of controllers in the NVM Subsystem that are associated with
hosts that are registrants of the namespace (i.e., there is a Registered
Controller data structure for each such controller).

OPTIONS
-------
-n <nsid>::
--namespace-id=<nsid>::
	Retrieve the reservation report structure for the given nsid. This
	is required for the character devices, or overrides the block nsid
	if given.

-d <num-dwords>::
--numd=<num-dwords>::
	Specify the number of Dwords of the Reservation Status structure
	to transfer. Defaults to 4k.

-e::
--eds::
	Request extended Data Structure: If this bit is set to a '1', then the
	controller returns the Extended Data Structure.

-b::
--raw-binary::
	Print the raw buffer to stdout. Structure is not parsed by
	program.

-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.

EXAMPLES
--------
No examples yet.

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