summaryrefslogtreecommitdiffstats
path: root/Documentation/nvme-wdc-namespace-resize.1
blob: ea0235abd7710579233d8489135acb0b5b897ca2 (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
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
'\" t
.\"     Title: nvme-wdc-namespace-resize
.\"    Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
.\"      Date: 04/24/2020
.\"    Manual: NVMe Manual
.\"    Source: NVMe
.\"  Language: English
.\"
.TH "NVME\-WDC\-NAMESPACE" "1" "04/24/2020" "NVMe" "NVMe Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
nvme-wdc-namespace-resize \- Resizes the device\*(Aqs namespace\&.
.SH "SYNOPSIS"
.sp
.nf
\fInvme wdc namespace\-resize\fR <device> [\-\-nsid=<NAMSPACE ID>, \-n <NAMSPACE ID>] [\-\-op_option=<OP OPTION>, \-o <OP OPTION>]
.fi
.SH "DESCRIPTION"
.sp
For the NVMe device given, sends the WDC Vendor Specific Command that modifies the namespace size reported by the device\&.
.sp
The <device> parameter is mandatory NVMe character device (ex: /dev/nvme0)\&.
.sp
This will only work on WDC devices supporting this feature\&. Results for any other device are undefined\&.
.SH "OPTIONS"
.PP
\-n <NAMSPACE ID>, \-\-namespace\-id=<NAMSPACE_ID>
.RS 4
Namespace ID; ID of the namespace to resize
.RE
.PP
\-o <OP OPTION>, \-\-op\-option=<OP OPTION>
.RS 4
Overprovisioning Option; defaults to 0xF
.sp
.if n \{\
.RS 4
.\}
.nf
Valid Values:
0x1 \- 7% of Original TNVMCAP reported value
0x2 \- 28% of Original TNVMCAP reported value
0x3 \- 50% of Original TNVMCAP reported value
0xF \- 0% of Original TNVMCAP reported value (original config)
All other values \- reserved
.fi
.if n \{\
.RE
.\}
.RE
.SH "EXAMPLES"
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
Resizes namespace 1 to 50% of the orginal TNVMCAP reported value:
.sp
.if n \{\
.RS 4
.\}
.nf
# nvme wdc namespace\-resize /dev/nvme0 \-n 1 \-o 3
.fi
.if n \{\
.RE
.\}
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
Resizes namespace 2 to 7% of the orginal TNVMCAP reported value:
.sp
.if n \{\
.RS 4
.\}
.nf
# nvme wdc namespace\-resize /dev/nvme0 \-\-namespace\-id=2 \-\-op\-option=1
.fi
.if n \{\
.RE
.\}
.RE
.SH "NVME"
.sp
Part of the nvme\-user suite\&.