Blame Documentation/nvme-wdc-namespace-resize.1

Packit dd4ba5
'\" t
Packit dd4ba5
.\"     Title: nvme-wdc-namespace-resize
Packit dd4ba5
.\"    Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
Packit dd4ba5
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
Packit dd4ba5
.\"      Date: 04/24/2020
Packit dd4ba5
.\"    Manual: NVMe Manual
Packit dd4ba5
.\"    Source: NVMe
Packit dd4ba5
.\"  Language: English
Packit dd4ba5
.\"
Packit dd4ba5
.TH "NVME\-WDC\-NAMESPACE" "1" "04/24/2020" "NVMe" "NVMe Manual"
Packit dd4ba5
.\" -----------------------------------------------------------------
Packit dd4ba5
.\" * Define some portability stuff
Packit dd4ba5
.\" -----------------------------------------------------------------
Packit dd4ba5
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Packit dd4ba5
.\" http://bugs.debian.org/507673
Packit dd4ba5
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
Packit dd4ba5
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Packit dd4ba5
.ie \n(.g .ds Aq \(aq
Packit dd4ba5
.el       .ds Aq '
Packit dd4ba5
.\" -----------------------------------------------------------------
Packit dd4ba5
.\" * set default formatting
Packit dd4ba5
.\" -----------------------------------------------------------------
Packit dd4ba5
.\" disable hyphenation
Packit dd4ba5
.nh
Packit dd4ba5
.\" disable justification (adjust text to left margin only)
Packit dd4ba5
.ad l
Packit dd4ba5
.\" -----------------------------------------------------------------
Packit dd4ba5
.\" * MAIN CONTENT STARTS HERE *
Packit dd4ba5
.\" -----------------------------------------------------------------
Packit dd4ba5
.SH "NAME"
Packit dd4ba5
nvme-wdc-namespace-resize \- Resizes the device\*(Aqs namespace\&.
Packit dd4ba5
.SH "SYNOPSIS"
Packit dd4ba5
.sp
Packit dd4ba5
.nf
Packit dd4ba5
\fInvme wdc namespace\-resize\fR <device> [\-\-nsid=<NAMSPACE ID>, \-n <NAMSPACE ID>] [\-\-op_option=<OP OPTION>, \-o <OP OPTION>]
Packit dd4ba5
.fi
Packit dd4ba5
.SH "DESCRIPTION"
Packit dd4ba5
.sp
Packit dd4ba5
For the NVMe device given, sends the WDC Vendor Specific Command that modifies the namespace size reported by the device\&.
Packit dd4ba5
.sp
Packit dd4ba5
The <device> parameter is mandatory NVMe character device (ex: /dev/nvme0)\&.
Packit dd4ba5
.sp
Packit dd4ba5
This will only work on WDC devices supporting this feature\&. Results for any other device are undefined\&.
Packit dd4ba5
.SH "OPTIONS"
Packit dd4ba5
.PP
Packit dd4ba5
\-n <NAMSPACE ID>, \-\-namespace\-id=<NAMSPACE_ID>
Packit dd4ba5
.RS 4
Packit dd4ba5
Namespace ID; ID of the namespace to resize
Packit dd4ba5
.RE
Packit dd4ba5
.PP
Packit dd4ba5
\-o <OP OPTION>, \-\-op\-option=<OP OPTION>
Packit dd4ba5
.RS 4
Packit dd4ba5
Overprovisioning Option; defaults to 0xF
Packit dd4ba5
.sp
Packit dd4ba5
.if n \{\
Packit dd4ba5
.RS 4
Packit dd4ba5
.\}
Packit dd4ba5
.nf
Packit dd4ba5
Valid Values:
Packit dd4ba5
0x1 \- 7% of Original TNVMCAP reported value
Packit dd4ba5
0x2 \- 28% of Original TNVMCAP reported value
Packit dd4ba5
0x3 \- 50% of Original TNVMCAP reported value
Packit dd4ba5
0xF \- 0% of Original TNVMCAP reported value (original config)
Packit dd4ba5
All other values \- reserved
Packit dd4ba5
.fi
Packit dd4ba5
.if n \{\
Packit dd4ba5
.RE
Packit dd4ba5
.\}
Packit dd4ba5
.RE
Packit dd4ba5
.SH "EXAMPLES"
Packit dd4ba5
.sp
Packit dd4ba5
.RS 4
Packit dd4ba5
.ie n \{\
Packit dd4ba5
\h'-04'\(bu\h'+03'\c
Packit dd4ba5
.\}
Packit dd4ba5
.el \{\
Packit dd4ba5
.sp -1
Packit dd4ba5
.IP \(bu 2.3
Packit dd4ba5
.\}
Packit dd4ba5
Resizes namespace 1 to 50% of the orginal TNVMCAP reported value:
Packit dd4ba5
.sp
Packit dd4ba5
.if n \{\
Packit dd4ba5
.RS 4
Packit dd4ba5
.\}
Packit dd4ba5
.nf
Packit dd4ba5
# nvme wdc namespace\-resize /dev/nvme0 \-n 1 \-o 3
Packit dd4ba5
.fi
Packit dd4ba5
.if n \{\
Packit dd4ba5
.RE
Packit dd4ba5
.\}
Packit dd4ba5
.RE
Packit dd4ba5
.sp
Packit dd4ba5
.RS 4
Packit dd4ba5
.ie n \{\
Packit dd4ba5
\h'-04'\(bu\h'+03'\c
Packit dd4ba5
.\}
Packit dd4ba5
.el \{\
Packit dd4ba5
.sp -1
Packit dd4ba5
.IP \(bu 2.3
Packit dd4ba5
.\}
Packit dd4ba5
Resizes namespace 2 to 7% of the orginal TNVMCAP reported value:
Packit dd4ba5
.sp
Packit dd4ba5
.if n \{\
Packit dd4ba5
.RS 4
Packit dd4ba5
.\}
Packit dd4ba5
.nf
Packit dd4ba5
# nvme wdc namespace\-resize /dev/nvme0 \-\-namespace\-id=2 \-\-op\-option=1
Packit dd4ba5
.fi
Packit dd4ba5
.if n \{\
Packit dd4ba5
.RE
Packit dd4ba5
.\}
Packit dd4ba5
.RE
Packit dd4ba5
.SH "NVME"
Packit dd4ba5
.sp
Packit dd4ba5
Part of the nvme\-user suite\&.