1
0
Fork 0

Adding upstream version 2.7.1.

Signed-off-by: Daniel Baumann <daniel@debian.org>
This commit is contained in:
Daniel Baumann 2025-02-16 12:25:41 +01:00
parent 04338f02fe
commit d6e1a5d456
Signed by: daniel
GPG key ID: FBB4F0E80A80222F
663 changed files with 15529 additions and 6994 deletions

View file

@ -27,7 +27,6 @@ AppDir:
- sourceline: deb http://archive.ubuntu.com/ubuntu/ jammy-security main restricted universe multiverse - sourceline: deb http://archive.ubuntu.com/ubuntu/ jammy-security main restricted universe multiverse
include: include:
- libjson-c5 - libjson-c5
- libhugetlbfs0
- libssl3 - libssl3
files: files:
include: include:

3
.github/codeql/codeql-config.yml vendored Normal file
View file

@ -0,0 +1,3 @@
name: "CodeQL Config"
paths-ignore:
- subprojects/**

View file

@ -24,7 +24,7 @@ jobs:
uses: AppImageCrafters/build-appimage@v1.3 uses: AppImageCrafters/build-appimage@v1.3
with: with:
recipe: .github/AppImageBuilder.yml recipe: .github/AppImageBuilder.yml
- uses: actions/upload-artifact@v3 - uses: actions/upload-artifact@v4
name: upload artifacts to github name: upload artifacts to github
with: with:
name: AppImage name: AppImage
@ -34,10 +34,10 @@ jobs:
name: deploy AppImage name: deploy AppImage
runs-on: ubuntu-latest runs-on: ubuntu-latest
needs: build-appimage needs: build-appimage
if: ${{ github.event_name == 'push' && github.ref == 'refs/heads/master' }} if: ${{ github.event_name == 'push' && github.ref == 'refs/heads/master' && github.repository == 'linux-nvme/nvme-cli' }}
steps: steps:
- name: Download artifact - name: Download artifact
uses: dawidd6/action-download-artifact@v2 uses: dawidd6/action-download-artifact@v3
with: with:
workflow: ${{ github.event.workflow_run.workflow_id }} workflow: ${{ github.event.workflow_run.workflow_id }}
workflow_conclusion: success workflow_conclusion: success

View file

@ -23,7 +23,7 @@ jobs:
- name: build - name: build
run: | run: |
scripts/build.sh -b ${{ matrix.buildtype }} -c ${{ matrix.compiler }} scripts/build.sh -b ${{ matrix.buildtype }} -c ${{ matrix.compiler }}
- uses: actions/upload-artifact@v3 - uses: actions/upload-artifact@v4
name: upload logs name: upload logs
if: failure() if: failure()
with: with:
@ -53,7 +53,7 @@ jobs:
scripts/build.sh -b release -c gcc -t ${{ matrix.arch }} cross scripts/build.sh -b release -c gcc -t ${{ matrix.arch }} cross
params: "--platform linux/amd64" params: "--platform linux/amd64"
pull-params: "--platform linux/amd64" pull-params: "--platform linux/amd64"
- uses: actions/upload-artifact@v3 - uses: actions/upload-artifact@v4
name: upload logs name: upload logs
if: failure() if: failure()
with: with:
@ -72,7 +72,7 @@ jobs:
- name: build - name: build
run: | run: |
scripts/build.sh -b release -c gcc fallback scripts/build.sh -b release -c gcc fallback
- uses: actions/upload-artifact@v3 - uses: actions/upload-artifact@v4
if: failure() if: failure()
with: with:
name: log files name: log files
@ -89,3 +89,13 @@ jobs:
- name: build - name: build
run: | run: |
scripts/build.sh -m muon scripts/build.sh -m muon
build-make-static:
name: make static
runs-on: ubuntu-latest
container:
image: ghcr.io/igaw/linux-nvme/debian:latest
steps:
- uses: actions/checkout@v4
- name: build
run: |
make static

15
.github/workflows/checkpatch.yml vendored Normal file
View file

@ -0,0 +1,15 @@
name: checkpatch review
on: [pull_request]
jobs:
checkpatch:
name: checkpatch review
runs-on: ubuntu-latest
steps:
- name: 'Calculate PR commits + 1'
run: echo "PR_FETCH_DEPTH=$(( ${{ github.event.pull_request.commits }} + 1 ))" >> $GITHUB_ENV
- uses: actions/checkout@v4
with:
ref: ${{ github.event.pull_request.head.sha }}
fetch-depth: 0
- name: Run checkpatch review
uses: webispy/checkpatch-action@v9

71
.github/workflows/codeql.yml vendored Normal file
View file

@ -0,0 +1,71 @@
# CodeQL build configuration for nvme-cli
# Mostly based on auto-configuration with additions and tweaks for:
# * meson install
# * language detection
name: "CodeQL"
on:
push:
branches: [ "master" ]
pull_request:
# The branches below must be a subset of the branches above
branches: [ "master" ]
schedule:
- cron: '24 2 * * 5'
jobs:
analyze:
name: Analyze
# Runner size impacts CodeQL analysis time. To learn more, please see:
# - https://gh.io/recommended-hardware-resources-for-running-codeql
# - https://gh.io/supported-runners-and-hardware-resources
# - https://gh.io/using-larger-runners
# Consider using larger runners for possible analysis time improvements.
runs-on: 'ubuntu-latest'
timeout-minutes: 360
permissions:
actions: read
contents: read
security-events: write
strategy:
fail-fast: false
matrix:
language: [ 'c-cpp', 'python' ]
# CodeQL supports [ 'c-cpp', 'csharp', 'go', 'java-kotlin', 'javascript-typescript', 'python', 'ruby', 'swift' ]
# Use only 'java-kotlin' to analyze code written in Java, Kotlin or both
# Use only 'javascript-typescript' to analyze code written in JavaScript, TypeScript or both
# Learn more about CodeQL language support at https://aka.ms/codeql-docs/language-support
steps:
- name: Checkout repository
uses: actions/checkout@v4
- name: Install build tools
run: |
sudo apt-get update
sudo apt-get install meson
# Initializes the CodeQL tools for scanning.
- if: matrix.language == 'c-cpp'
name: Initialize CodeQL C
uses: github/codeql-action/init@v3
with:
languages: 'c-cpp'
- if: matrix.language == 'python'
name: Initialize CodeQL Python
uses: github/codeql-action/init@v3
with:
languages: 'python'
config-file: ./.github/codeql/codeql-config.yml
- name: meson build
run: |
meson setup --force-fallback-for=libnvme,json-c .build
ninja -C .build
- name: Perform CodeQL Analysis
uses: github/codeql-action/analyze@v3
with:
category: "/language:${{matrix.language}}"

View file

@ -7,6 +7,7 @@ on:
jobs: jobs:
code-coverage: code-coverage:
if: github.repository == 'linux-nvme/nvme-cli'
name: code coverage name: code coverage
runs-on: ubuntu-latest runs-on: ubuntu-latest
container: container:

View file

@ -10,7 +10,7 @@ on:
jobs: jobs:
build: build:
runs-on: ubuntu-latest runs-on: ubuntu-latest
if: startsWith(github.ref, 'refs/tags/v') if: startsWith(github.ref, 'refs/tags/v') && github.repository == 'linux-nvme/nvme-cli'
permissions: permissions:
contents: write contents: write
steps: steps:

1
.mailmap Normal file
View file

@ -0,0 +1 @@
Vigneshwaran Saravanan <s.vignesh@samsung.com>

View file

@ -2,12 +2,12 @@
.\" Title: nvme-admin-passthru .\" Title: nvme-admin-passthru
.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] .\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/> .\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
.\" Date: 06/30/2023 .\" Date: 12/21/2023
.\" Manual: NVMe Manual .\" Manual: NVMe Manual
.\" Source: NVMe .\" Source: NVMe
.\" Language: English .\" Language: English
.\" .\"
.TH "NVME\-ADMIN\-PASSTHR" "1" "06/30/2023" "NVMe" "NVMe Manual" .TH "NVME\-ADMIN\-PASSTHR" "1" "12/21/2023" "NVMe" "NVMe Manual"
.\" ----------------------------------------------------------------- .\" -----------------------------------------------------------------
.\" * Define some portability stuff .\" * Define some portability stuff
.\" ----------------------------------------------------------------- .\" -----------------------------------------------------------------
@ -32,23 +32,24 @@ nvme-admin-passthru \- Submit an arbitrary admin command, return results
.SH "SYNOPSIS" .SH "SYNOPSIS"
.sp .sp
.nf .nf
\fInvme\-admin\-passthru\fR <device> [\-\-opcode=<opcode> | \-o <opcode>] \fInvme\-admin\-passthru\fR <device> [\-\-opcode=<opcode> | \-O <opcode>]
[\-\-flags=<flags> | \-f <flags>] [\-rsvd=<rsvd> | \-R <rsvd>] [\-\-flags=<flags> | \-f <flags>] [\-rsvd=<rsvd> | \-R <rsvd>]
[\-\-namespace\-id=<nsid> | \-n <nsid>] [\-\-cdw2=<cdw2> | \-2 <cdw2>] [\-\-namespace\-id=<nsid> | \-n <nsid>] [\-\-cdw2=<cdw2> | \-2 <cdw2>]
[\-\-cdw3=<cdw3> | \-3 <cdw3>] [\-\-cdw10=<cdw10> | \-4 <cdw4>] [\-\-cdw3=<cdw3> | \-3 <cdw3>] [\-\-cdw10=<cdw10> | \-4 <cdw4>]
[\-\-cdw11=<cdw11> | \-5 <cdw5>] [\-\-cdw12=<cdw12> | \-6 <cdw6>] [\-\-cdw11=<cdw11> | \-5 <cdw5>] [\-\-cdw12=<cdw12> | \-6 <cdw6>]
[\-\-cdw13=<cdw13> | \-7 <cdw7>] [\-\-cdw14=<cdw14> | \-8 <cdw8>] [\-\-cdw13=<cdw13> | \-7 <cdw7>] [\-\-cdw14=<cdw14> | \-8 <cdw8>]
[\-\-cdw15=<cdw15> | \-9 <cdw9>] [\-\-cdw15=<cdw15> | \-9 <cdw9>]
[\-\-data\-len=<data\-len> | \-l <data\-len>] [\-\-data\-len=<data\-len> | \-l <data\-len>]
[\-\-metadata\-len=<len> | \-m <len>] [\-\-metadata\-len=<len> | \-m <len>]
[\-\-input\-file=<file> | \-i <file>] [\-\-input\-file=<file> | \-i <file>]
[\-\-read | \-r ] [\-\-write | \-w] [\-\-read | \-r] [\-\-write | \-w]
[\-\-timeout=<to> | \-t <to>] [\-\-timeout=<to> | \-t <to>]
[\-\-show\-command | \-s] [\-\-show\-command | \-s]
[\-\-dry\-run | \-d] [\-\-dry\-run | \-d]
[\-\-raw\-binary | \-b] [\-\-raw\-binary | \-b]
[\-\-prefill=<prefill> | \-p <prefill>] [\-\-prefill=<prefill> | \-p <prefill>]
[\-\-latency | \-T] [\-\-latency | \-T]
[\-\-output\-format=<fmt> | \-o <fmt>] [\-\-verbose | \-v]
.fi .fi
.SH "DESCRIPTION" .SH "DESCRIPTION"
.sp .sp
@ -59,7 +60,7 @@ The <device> parameter is mandatory and may be either the NVMe character device
On success, the returned structure (if applicable) may be returned in one of several ways depending on the option flags; the structure may printed by the program as a hex dump, or may be returned as a raw buffer printed to stdout for another program to parse\&. On success, the returned structure (if applicable) may be returned in one of several ways depending on the option flags; the structure may printed by the program as a hex dump, or may be returned as a raw buffer printed to stdout for another program to parse\&.
.SH "OPTIONS" .SH "OPTIONS"
.PP .PP
\-o <opcode>, \-\-opcode=<opcode> \-O <opcode>, \-\-opcode=<opcode>
.RS 4 .RS 4
The NVMe opcode to send to the device in the command The NVMe opcode to send to the device in the command
.RE .RE
@ -131,6 +132,20 @@ Prefill the buffer with a predetermined byte value\&. Defaults to 0\&. This may
.RS 4 .RS 4
Print out the latency the IOCTL took (in us)\&. Print out the latency the IOCTL took (in us)\&.
.RE .RE
.PP
\-o <fmt>, \-\-output\-format=<fmt>
.RS 4
Set the reporting format to
\fInormal\fR,
\fIjson\fR
or
\fIbinary\fR\&. Only one output format can be used at a time\&.
.RE
.PP
\-v, \-\-verbose
.RS 4
Increase the information detail in the output\&.
.RE
.SH "EXAMPLES" .SH "EXAMPLES"
.sp .sp
.RS 4 .RS 4

View file

@ -749,23 +749,24 @@ nvme-admin-passthru(1) Manual Page
<h2 id="_synopsis">SYNOPSIS</h2> <h2 id="_synopsis">SYNOPSIS</h2>
<div class="sectionbody"> <div class="sectionbody">
<div class="verseblock"> <div class="verseblock">
<pre class="content"><em>nvme-admin-passthru</em> &lt;device&gt; [--opcode=&lt;opcode&gt; | -o &lt;opcode&gt;] <pre class="content"><em>nvme-admin-passthru</em> &lt;device&gt; [--opcode=&lt;opcode&gt; | -O &lt;opcode&gt;]
[--flags=&lt;flags&gt; | -f &lt;flags&gt;] [-rsvd=&lt;rsvd&gt; | -R &lt;rsvd&gt;] [--flags=&lt;flags&gt; | -f &lt;flags&gt;] [-rsvd=&lt;rsvd&gt; | -R &lt;rsvd&gt;]
[--namespace-id=&lt;nsid&gt; | -n &lt;nsid&gt;] [--cdw2=&lt;cdw2&gt; | -2 &lt;cdw2&gt;] [--namespace-id=&lt;nsid&gt; | -n &lt;nsid&gt;] [--cdw2=&lt;cdw2&gt; | -2 &lt;cdw2&gt;]
[--cdw3=&lt;cdw3&gt; | -3 &lt;cdw3&gt;] [--cdw10=&lt;cdw10&gt; | -4 &lt;cdw4&gt;] [--cdw3=&lt;cdw3&gt; | -3 &lt;cdw3&gt;] [--cdw10=&lt;cdw10&gt; | -4 &lt;cdw4&gt;]
[--cdw11=&lt;cdw11&gt; | -5 &lt;cdw5&gt;] [--cdw12=&lt;cdw12&gt; | -6 &lt;cdw6&gt;] [--cdw11=&lt;cdw11&gt; | -5 &lt;cdw5&gt;] [--cdw12=&lt;cdw12&gt; | -6 &lt;cdw6&gt;]
[--cdw13=&lt;cdw13&gt; | -7 &lt;cdw7&gt;] [--cdw14=&lt;cdw14&gt; | -8 &lt;cdw8&gt;] [--cdw13=&lt;cdw13&gt; | -7 &lt;cdw7&gt;] [--cdw14=&lt;cdw14&gt; | -8 &lt;cdw8&gt;]
[--cdw15=&lt;cdw15&gt; | -9 &lt;cdw9&gt;] [--cdw15=&lt;cdw15&gt; | -9 &lt;cdw9&gt;]
[--data-len=&lt;data-len&gt; | -l &lt;data-len&gt;] [--data-len=&lt;data-len&gt; | -l &lt;data-len&gt;]
[--metadata-len=&lt;len&gt; | -m &lt;len&gt;] [--metadata-len=&lt;len&gt; | -m &lt;len&gt;]
[--input-file=&lt;file&gt; | -i &lt;file&gt;] [--input-file=&lt;file&gt; | -i &lt;file&gt;]
[--read | -r ] [--write | -w] [--read | -r] [--write | -w]
[--timeout=&lt;to&gt; | -t &lt;to&gt;] [--timeout=&lt;to&gt; | -t &lt;to&gt;]
[--show-command | -s] [--show-command | -s]
[--dry-run | -d] [--dry-run | -d]
[--raw-binary | -b] [--raw-binary | -b]
[--prefill=&lt;prefill&gt; | -p &lt;prefill&gt;] [--prefill=&lt;prefill&gt; | -p &lt;prefill&gt;]
[--latency | -T]</pre> [--latency | -T]
[--output-format=&lt;fmt&gt; | -o &lt;fmt&gt;] [--verbose | -v]</pre>
<div class="attribution"> <div class="attribution">
</div></div> </div></div>
</div> </div>
@ -790,7 +791,7 @@ printed to stdout for another program to parse.</p></div>
<div class="sectionbody"> <div class="sectionbody">
<div class="dlist"><dl> <div class="dlist"><dl>
<dt class="hdlist1"> <dt class="hdlist1">
-o &lt;opcode&gt; -O &lt;opcode&gt;
</dt> </dt>
<dt class="hdlist1"> <dt class="hdlist1">
--opcode=&lt;opcode&gt; --opcode=&lt;opcode&gt;
@ -961,6 +962,29 @@ printed to stdout for another program to parse.</p></div>
Print out the latency the IOCTL took (in us). Print out the latency the IOCTL took (in us).
</p> </p>
</dd> </dd>
<dt class="hdlist1">
-o &lt;fmt&gt;
</dt>
<dt class="hdlist1">
--output-format=&lt;fmt&gt;
</dt>
<dd>
<p>
Set the reporting format to <em>normal</em>, <em>json</em> or <em>binary</em>. Only one
output format can be used at a time.
</p>
</dd>
<dt class="hdlist1">
-v
</dt>
<dt class="hdlist1">
--verbose
</dt>
<dd>
<p>
Increase the information detail in the output.
</p>
</dd>
</dl></div> </dl></div>
</div> </div>
</div> </div>
@ -1003,7 +1027,7 @@ Or if you want to save that structure to a file:
<div id="footer"> <div id="footer">
<div id="footer-text"> <div id="footer-text">
Last updated Last updated
2023-09-29 08:33:07 CEST 2023-12-21 15:49:29 CET
</div> </div>
</div> </div>
</body> </body>

View file

@ -8,23 +8,24 @@ nvme-admin-passthru - Submit an arbitrary admin command, return results
SYNOPSIS SYNOPSIS
-------- --------
[verse] [verse]
'nvme-admin-passthru' <device> [--opcode=<opcode> | -o <opcode>] 'nvme-admin-passthru' <device> [--opcode=<opcode> | -O <opcode>]
[--flags=<flags> | -f <flags>] [-rsvd=<rsvd> | -R <rsvd>] [--flags=<flags> | -f <flags>] [-rsvd=<rsvd> | -R <rsvd>]
[--namespace-id=<nsid> | -n <nsid>] [--cdw2=<cdw2> | -2 <cdw2>] [--namespace-id=<nsid> | -n <nsid>] [--cdw2=<cdw2> | -2 <cdw2>]
[--cdw3=<cdw3> | -3 <cdw3>] [--cdw10=<cdw10> | -4 <cdw4>] [--cdw3=<cdw3> | -3 <cdw3>] [--cdw10=<cdw10> | -4 <cdw4>]
[--cdw11=<cdw11> | -5 <cdw5>] [--cdw12=<cdw12> | -6 <cdw6>] [--cdw11=<cdw11> | -5 <cdw5>] [--cdw12=<cdw12> | -6 <cdw6>]
[--cdw13=<cdw13> | -7 <cdw7>] [--cdw14=<cdw14> | -8 <cdw8>] [--cdw13=<cdw13> | -7 <cdw7>] [--cdw14=<cdw14> | -8 <cdw8>]
[--cdw15=<cdw15> | -9 <cdw9>] [--cdw15=<cdw15> | -9 <cdw9>]
[--data-len=<data-len> | -l <data-len>] [--data-len=<data-len> | -l <data-len>]
[--metadata-len=<len> | -m <len>] [--metadata-len=<len> | -m <len>]
[--input-file=<file> | -i <file>] [--input-file=<file> | -i <file>]
[--read | -r ] [--write | -w] [--read | -r] [--write | -w]
[--timeout=<to> | -t <to>] [--timeout=<to> | -t <to>]
[--show-command | -s] [--show-command | -s]
[--dry-run | -d] [--dry-run | -d]
[--raw-binary | -b] [--raw-binary | -b]
[--prefill=<prefill> | -p <prefill>] [--prefill=<prefill> | -p <prefill>]
[--latency | -T] [--latency | -T]
[--output-format=<fmt> | -o <fmt>] [--verbose | -v]
DESCRIPTION DESCRIPTION
----------- -----------
@ -43,7 +44,7 @@ printed to stdout for another program to parse.
OPTIONS OPTIONS
------- -------
-o <opcode>:: -O <opcode>::
--opcode=<opcode>:: --opcode=<opcode>::
The NVMe opcode to send to the device in the command The NVMe opcode to send to the device in the command
@ -113,6 +114,15 @@ OPTIONS
--latency:: --latency::
Print out the latency the IOCTL took (in us). Print out the latency the IOCTL took (in us).
-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 EXAMPLES
-------- --------
* The following will run the admin command with opcode=6 and cdw10=1, which * The following will run the admin command with opcode=6 and cdw10=1, which

View file

@ -2,12 +2,12 @@
.\" Title: nvme-ana-log .\" Title: nvme-ana-log
.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] .\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/> .\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
.\" Date: 06/30/2023 .\" Date: 12/21/2023
.\" Manual: NVMe Manual .\" Manual: NVMe Manual
.\" Source: NVMe .\" Source: NVMe
.\" Language: English .\" Language: English
.\" .\"
.TH "NVME\-ANA\-LOG" "1" "06/30/2023" "NVMe" "NVMe Manual" .TH "NVME\-ANA\-LOG" "1" "12/21/2023" "NVMe" "NVMe Manual"
.\" ----------------------------------------------------------------- .\" -----------------------------------------------------------------
.\" * Define some portability stuff .\" * Define some portability stuff
.\" ----------------------------------------------------------------- .\" -----------------------------------------------------------------
@ -32,7 +32,8 @@ nvme-ana-log \- Send NVMe ANA log page request, returns result and log
.SH "SYNOPSIS" .SH "SYNOPSIS"
.sp .sp
.nf .nf
\fInvme ana\-log\fR <device> [\-o <fmt> | \-\-output\-format=<fmt>] \fInvme ana\-log\fR <device> [\-\-groups | \-g]
[\-\-output\-format=<fmt> | \-o <fmt>] [\-\-verbose | \-v]
.fi .fi
.SH "DESCRIPTION" .SH "DESCRIPTION"
.sp .sp
@ -48,13 +49,19 @@ On success, the returned ANA log structure may be returned in one of several way
Return the list of ANA groups without the namespace listing\&. Return the list of ANA groups without the namespace listing\&.
.RE .RE
.PP .PP
\-o <format>, \-\-output\-format=<format> \-o <fmt>, \-\-output\-format=<fmt>
.RS 4 .RS 4
Set the reporting format to Set the reporting format to
\fInormal\fR, \fInormal\fR,
\fIjson\fR, or \fIjson\fR
or
\fIbinary\fR\&. Only one output format can be used at a time\&. \fIbinary\fR\&. Only one output format can be used at a time\&.
.RE .RE
.PP
\-v, \-\-verbose
.RS 4
Increase the information detail in the output\&.
.RE
.SH "EXAMPLES" .SH "EXAMPLES"
.sp .sp
.RS 4 .RS 4

View file

@ -749,7 +749,8 @@ nvme-ana-log(1) Manual Page
<h2 id="_synopsis">SYNOPSIS</h2> <h2 id="_synopsis">SYNOPSIS</h2>
<div class="sectionbody"> <div class="sectionbody">
<div class="verseblock"> <div class="verseblock">
<pre class="content"><em>nvme ana-log</em> &lt;device&gt; [-o &lt;fmt&gt; | --output-format=&lt;fmt&gt;]</pre> <pre class="content"><em>nvme ana-log</em> &lt;device&gt; [--groups | -g]
[--output-format=&lt;fmt&gt; | -o &lt;fmt&gt;] [--verbose | -v]</pre>
<div class="attribution"> <div class="attribution">
</div></div> </div></div>
</div> </div>
@ -778,19 +779,30 @@ printed to stdout for another program to parse.</p></div>
</dt> </dt>
<dd> <dd>
<p> <p>
Return the list of ANA groups without the namespace listing. Return the list of ANA groups without the namespace listing.
</p> </p>
</dd> </dd>
<dt class="hdlist1"> <dt class="hdlist1">
-o &lt;format&gt; -o &lt;fmt&gt;
</dt> </dt>
<dt class="hdlist1"> <dt class="hdlist1">
--output-format=&lt;format&gt; --output-format=&lt;fmt&gt;
</dt> </dt>
<dd> <dd>
<p> <p>
Set the reporting format to <em>normal</em>, <em>json</em>, or Set the reporting format to <em>normal</em>, <em>json</em> or <em>binary</em>. Only one
<em>binary</em>. Only one output format can be used at a time. output format can be used at a time.
</p>
</dd>
<dt class="hdlist1">
-v
</dt>
<dt class="hdlist1">
--verbose
</dt>
<dd>
<p>
Increase the information detail in the output.
</p> </p>
</dd> </dd>
</dl></div> </dl></div>
@ -823,7 +835,7 @@ Print the ANA log page in a human readable format:
<div id="footer"> <div id="footer">
<div id="footer-text"> <div id="footer-text">
Last updated Last updated
2023-09-29 08:33:07 CEST 2023-12-21 15:49:29 CET
</div> </div>
</div> </div>
</body> </body>

View file

@ -8,7 +8,8 @@ nvme-ana-log - Send NVMe ANA log page request, returns result and log
SYNOPSIS SYNOPSIS
-------- --------
[verse] [verse]
'nvme ana-log' <device> [-o <fmt> | --output-format=<fmt>] 'nvme ana-log' <device> [--groups | -g]
[--output-format=<fmt> | -o <fmt>] [--verbose | -v]
DESCRIPTION DESCRIPTION
----------- -----------
@ -26,12 +27,16 @@ OPTIONS
------- -------
-g:: -g::
--groups:: --groups::
Return the list of ANA groups without the namespace listing. Return the list of ANA groups without the namespace listing.
-o <format>:: -o <fmt>::
--output-format=<format>:: --output-format=<fmt>::
Set the reporting format to 'normal', 'json', or Set the reporting format to 'normal', 'json' or 'binary'. Only one
'binary'. Only one output format can be used at a time. output format can be used at a time.
-v::
--verbose::
Increase the information detail in the output.
EXAMPLES EXAMPLES
-------- --------

View file

@ -2,12 +2,12 @@
.\" Title: nvme-attach-ns .\" Title: nvme-attach-ns
.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] .\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/> .\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
.\" Date: 06/30/2023 .\" Date: 12/21/2023
.\" Manual: NVMe Manual .\" Manual: NVMe Manual
.\" Source: NVMe .\" Source: NVMe
.\" Language: English .\" Language: English
.\" .\"
.TH "NVME\-ATTACH\-NS" "1" "06/30/2023" "NVMe" "NVMe Manual" .TH "NVME\-ATTACH\-NS" "1" "12/21/2023" "NVMe" "NVMe Manual"
.\" ----------------------------------------------------------------- .\" -----------------------------------------------------------------
.\" * Define some portability stuff .\" * Define some portability stuff
.\" ----------------------------------------------------------------- .\" -----------------------------------------------------------------
@ -34,6 +34,7 @@ nvme-attach-ns \- Send NVMe attach namespace, return result\&.
.nf .nf
\fInvme attach\-ns\fR <device> [\-\-namespace\-id=<nsid> | \-n <nsid>] \fInvme attach\-ns\fR <device> [\-\-namespace\-id=<nsid> | \-n <nsid>]
[\-\-controllers=<ctrl\-list,> | \-c <ctrl\-list,>] [\-\-controllers=<ctrl\-list,> | \-c <ctrl\-list,>]
[\-\-output\-format=<fmt> | \-o <fmt>] [\-\-verbose | \-v]
.fi .fi
.SH "DESCRIPTION" .SH "DESCRIPTION"
.sp .sp
@ -49,6 +50,20 @@ The namespace identifier to attach\&.
.RS 4 .RS 4
The comma separated list of controller identifiers to attach the namespace too\&. The comma separated list of controller identifiers to attach the namespace too\&.
.RE .RE
.PP
\-o <fmt>, \-\-output\-format=<fmt>
.RS 4
Set the reporting format to
\fInormal\fR,
\fIjson\fR
or
\fIbinary\fR\&. Only one output format can be used at a time\&.
.RE
.PP
\-v, \-\-verbose
.RS 4
Increase the information detail in the output\&.
.RE
.SH "EXAMPLES" .SH "EXAMPLES"
.sp .sp
.if n \{\ .if n \{\
@ -65,7 +80,7 @@ Attach namespace to the controller:
.RS 4 .RS 4
.\} .\}
.nf .nf
# nvme attach\-ns /dev/nvme1 \-n 0x2 \-c 0x21 # nvme attach\-ns /dev/nvme1 \-n 0x2 \-c 0x21
.fi .fi
.if n \{\ .if n \{\
.RE .RE

View file

@ -750,7 +750,8 @@ nvme-attach-ns(1) Manual Page
<div class="sectionbody"> <div class="sectionbody">
<div class="verseblock"> <div class="verseblock">
<pre class="content"><em>nvme attach-ns</em> &lt;device&gt; [--namespace-id=&lt;nsid&gt; | -n &lt;nsid&gt;] <pre class="content"><em>nvme attach-ns</em> &lt;device&gt; [--namespace-id=&lt;nsid&gt; | -n &lt;nsid&gt;]
[--controllers=&lt;ctrl-list,&gt; | -c &lt;ctrl-list,&gt;]</pre> [--controllers=&lt;ctrl-list,&gt; | -c &lt;ctrl-list,&gt;]
[--output-format=&lt;fmt&gt; | -o &lt;fmt&gt;] [--verbose | -v]</pre>
<div class="attribution"> <div class="attribution">
</div></div> </div></div>
</div> </div>
@ -790,6 +791,29 @@ controller identifiers.</p></div>
the namespace too. the namespace too.
</p> </p>
</dd> </dd>
<dt class="hdlist1">
-o &lt;fmt&gt;
</dt>
<dt class="hdlist1">
--output-format=&lt;fmt&gt;
</dt>
<dd>
<p>
Set the reporting format to <em>normal</em>, <em>json</em> or <em>binary</em>. Only one
output format can be used at a time.
</p>
</dd>
<dt class="hdlist1">
-v
</dt>
<dt class="hdlist1">
--verbose
</dt>
<dd>
<p>
Increase the information detail in the output.
</p>
</dd>
</dl></div> </dl></div>
</div> </div>
</div> </div>
@ -802,7 +826,7 @@ controller identifiers.</p></div>
</div></div> </div></div>
<div class="literalblock"> <div class="literalblock">
<div class="content"> <div class="content">
<pre><code># nvme attach-ns /dev/nvme1 -n 0x2 -c 0x21</code></pre> <pre><code># nvme attach-ns /dev/nvme1 -n 0x2 -c 0x21</code></pre>
</div></div> </div></div>
</div> </div>
</div> </div>
@ -817,7 +841,7 @@ controller identifiers.</p></div>
<div id="footer"> <div id="footer">
<div id="footer-text"> <div id="footer-text">
Last updated Last updated
2023-09-29 08:33:07 CEST 2023-12-21 15:49:29 CET
</div> </div>
</div> </div>
</body> </body>

View file

@ -10,6 +10,7 @@ SYNOPSIS
[verse] [verse]
'nvme attach-ns' <device> [--namespace-id=<nsid> | -n <nsid>] 'nvme attach-ns' <device> [--namespace-id=<nsid> | -n <nsid>]
[--controllers=<ctrl-list,> | -c <ctrl-list,>] [--controllers=<ctrl-list,> | -c <ctrl-list,>]
[--output-format=<fmt> | -o <fmt>] [--verbose | -v]
DESCRIPTION DESCRIPTION
----------- -----------
@ -28,11 +29,20 @@ OPTIONS
The comma separated list of controller identifiers to attach The comma separated list of controller identifiers to attach
the namespace too. the namespace too.
-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 EXAMPLES
-------- --------
Attach namespace to the controller: Attach namespace to the controller:
# nvme attach-ns /dev/nvme1 -n 0x2 -c 0x21 # nvme attach-ns /dev/nvme1 -n 0x2 -c 0x21
NVME NVME
---- ----

View file

@ -2,12 +2,12 @@
.\" Title: nvme-boot-part-log .\" Title: nvme-boot-part-log
.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] .\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/> .\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
.\" Date: 06/30/2023 .\" Date: 12/21/2023
.\" Manual: NVMe Manual .\" Manual: NVMe Manual
.\" Source: NVMe .\" Source: NVMe
.\" Language: English .\" Language: English
.\" .\"
.TH "NVME\-BOOT\-PART\-LO" "1" "06/30/2023" "NVMe" "NVMe Manual" .TH "NVME\-BOOT\-PART\-LO" "1" "12/21/2023" "NVMe" "NVMe Manual"
.\" ----------------------------------------------------------------- .\" -----------------------------------------------------------------
.\" * Define some portability stuff .\" * Define some portability stuff
.\" ----------------------------------------------------------------- .\" -----------------------------------------------------------------
@ -33,8 +33,8 @@ nvme-boot-part-log \- Retrieves a Boot Partition log page from an NVMe device
.sp .sp
.nf .nf
\fInvme boot\-part\-log\fR <device> [\-\-lsp=<field> | \-s <field>] \fInvme boot\-part\-log\fR <device> [\-\-lsp=<field> | \-s <field>]
[\-\-output\-file=<file> | \-o <file>] [\-\-output\-file=<file> | \-f <file>]
[\-\-output\-format=<fmt> | \-o <fmt>] [\-\-output\-format=<fmt> | \-o <fmt>] [\-\-verbose | \-v]
.fi .fi
.SH "DESCRIPTION" .SH "DESCRIPTION"
.sp .sp
@ -50,18 +50,24 @@ On success, the returned log structure will be in raw binary format \fIonly\fR w
The log specified field of LID\&. The log specified field of LID\&.
.RE .RE
.PP .PP
\-o <file>, \-\-output\-file=<file> \-f <file>, \-\-output\-file=<file>
.RS 4 .RS 4
File name to which raw binary data will be saved to\&. File name to which raw binary data will be saved to\&.
.RE .RE
.PP .PP
\-o <format>, \-\-output\-format=<format> \-o <fmt>, \-\-output\-format=<fmt>
.RS 4 .RS 4
Set the reporting format to Set the reporting format to
\fInormal\fR, \fInormal\fR,
\fIjson\fR, or \fIjson\fR
or
\fIbinary\fR\&. Only one output format can be used at a time\&. \fIbinary\fR\&. Only one output format can be used at a time\&.
.RE .RE
.PP
\-v, \-\-verbose
.RS 4
Increase the information detail in the output\&.
.RE
.SH "EXAMPLES" .SH "EXAMPLES"
.sp .sp
.RS 4 .RS 4

View file

@ -750,8 +750,8 @@ nvme-boot-part-log(1) Manual Page
<div class="sectionbody"> <div class="sectionbody">
<div class="verseblock"> <div class="verseblock">
<pre class="content"><em>nvme boot-part-log</em> &lt;device&gt; [--lsp=&lt;field&gt; | -s &lt;field&gt;] <pre class="content"><em>nvme boot-part-log</em> &lt;device&gt; [--lsp=&lt;field&gt; | -s &lt;field&gt;]
[--output-file=&lt;file&gt; | -o &lt;file&gt;] [--output-file=&lt;file&gt; | -f &lt;file&gt;]
[--output-format=&lt;fmt&gt; | -o &lt;fmt&gt;]</pre> [--output-format=&lt;fmt&gt; | -o &lt;fmt&gt;] [--verbose | -v]</pre>
<div class="attribution"> <div class="attribution">
</div></div> </div></div>
</div> </div>
@ -783,7 +783,7 @@ device (ex: /dev/nvme0), or a namespace block device (ex: /dev/nvme0n1).</p></di
</p> </p>
</dd> </dd>
<dt class="hdlist1"> <dt class="hdlist1">
-o &lt;file&gt; -f &lt;file&gt;
</dt> </dt>
<dt class="hdlist1"> <dt class="hdlist1">
--output-file=&lt;file&gt; --output-file=&lt;file&gt;
@ -794,15 +794,26 @@ device (ex: /dev/nvme0), or a namespace block device (ex: /dev/nvme0n1).</p></di
</p> </p>
</dd> </dd>
<dt class="hdlist1"> <dt class="hdlist1">
-o &lt;format&gt; -o &lt;fmt&gt;
</dt> </dt>
<dt class="hdlist1"> <dt class="hdlist1">
--output-format=&lt;format&gt; --output-format=&lt;fmt&gt;
</dt> </dt>
<dd> <dd>
<p> <p>
Set the reporting format to <em>normal</em>, <em>json</em>, or Set the reporting format to <em>normal</em>, <em>json</em> or <em>binary</em>. Only one
<em>binary</em>. Only one output format can be used at a time. output format can be used at a time.
</p>
</dd>
<dt class="hdlist1">
-v
</dt>
<dt class="hdlist1">
--verbose
</dt>
<dd>
<p>
Increase the information detail in the output.
</p> </p>
</dd> </dd>
</dl></div> </dl></div>
@ -835,7 +846,7 @@ Retrieve Boot Partition data to boot_part_log.bin
<div id="footer"> <div id="footer">
<div id="footer-text"> <div id="footer-text">
Last updated Last updated
2023-09-29 08:33:07 CEST 2023-12-21 15:49:29 CET
</div> </div>
</div> </div>
</body> </body>

View file

@ -9,8 +9,8 @@ SYNOPSIS
-------- --------
[verse] [verse]
'nvme boot-part-log' <device> [--lsp=<field> | -s <field>] 'nvme boot-part-log' <device> [--lsp=<field> | -s <field>]
[--output-file=<file> | -o <file>] [--output-file=<file> | -f <file>]
[--output-format=<fmt> | -o <fmt>] [--output-format=<fmt> | -o <fmt>] [--verbose | -v]
DESCRIPTION DESCRIPTION
----------- -----------
@ -29,14 +29,18 @@ OPTIONS
--lsp=<field>:: --lsp=<field>::
The log specified field of LID. The log specified field of LID.
-o <file>:: -f <file>::
--output-file=<file>:: --output-file=<file>::
File name to which raw binary data will be saved to. File name to which raw binary data will be saved to.
-o <format>:: -o <fmt>::
--output-format=<format>:: --output-format=<fmt>::
Set the reporting format to 'normal', 'json', or Set the reporting format to 'normal', 'json' or 'binary'. Only one
'binary'. Only one output format can be used at a time. output format can be used at a time.
-v::
--verbose::
Increase the information detail in the output.
EXAMPLES EXAMPLES
-------- --------

View file

@ -2,12 +2,12 @@
.\" Title: nvme-capacity-mgmt .\" Title: nvme-capacity-mgmt
.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] .\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/> .\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
.\" Date: 06/30/2023 .\" Date: 12/21/2023
.\" Manual: NVMe Manual .\" Manual: NVMe Manual
.\" Source: NVMe .\" Source: NVMe
.\" Language: English .\" Language: English
.\" .\"
.TH "NVME\-CAPACITY\-MGMT" "1" "06/30/2023" "NVMe" "NVMe Manual" .TH "NVME\-CAPACITY\-MGMT" "1" "12/21/2023" "NVMe" "NVMe Manual"
.\" ----------------------------------------------------------------- .\" -----------------------------------------------------------------
.\" * Define some portability stuff .\" * Define some portability stuff
.\" ----------------------------------------------------------------- .\" -----------------------------------------------------------------
@ -32,10 +32,11 @@ nvme-capacity-mgmt \- Send capacity management command to configure/create/delet
.SH "SYNOPSIS" .SH "SYNOPSIS"
.sp .sp
.nf .nf
\fInvme capacity\-mgmt\fR <device> [\-\-operation=<operation> | \-o <operation>] \fInvme capacity\-mgmt\fR <device> [\-\-operation=<operation> | \-O <operation>]
[\-\-element\-id=<element\-id> | \-i <element\-id>] [\-\-element\-id=<element\-id> | \-i <element\-id>]
[\-\-cap\-lower=<cap\-lower> | \-l <cap\-lower>] [\-\-cap\-lower=<cap\-lower> | \-l <cap\-lower>]
[\-\-cap\-upper=<cap\-upper> | \-u <cap\-upper>] [\-\-cap\-upper=<cap\-upper> | \-u <cap\-upper>]
[\-\-output\-format=<fmt> | \-o <fmt>] [\-\-verbose | \-v]
.fi .fi
.SH "DESCRIPTION" .SH "DESCRIPTION"
.sp .sp
@ -44,7 +45,7 @@ For the NVMe device given, sends a capacity management command to configure/crea
The <device> parameter is mandatory and may be either the NVMe character device (ex: /dev/nvme0), or a namespace block device (ex: /dev/nvme0n1)\&. The <device> parameter is mandatory and may be either the NVMe character device (ex: /dev/nvme0), or a namespace block device (ex: /dev/nvme0n1)\&.
.SH "OPTIONS" .SH "OPTIONS"
.PP .PP
\-o <operation>, \-\-operation=<operation> \-O <operation>, \-\-operation=<operation>
.RS 4 .RS 4
Operation to be performed by the controller Operation to be performed by the controller
.RE .RE
@ -63,6 +64,20 @@ Least significant 32 bits of the capacity in bytes of the Endurance Group or NVM
.RS 4 .RS 4
Most significant 32 bits of the capacity in bytes of the Endurance Group or NVM Set to be created Most significant 32 bits of the capacity in bytes of the Endurance Group or NVM Set to be created
.RE .RE
.PP
\-o <fmt>, \-\-output\-format=<fmt>
.RS 4
Set the reporting format to
\fInormal\fR,
\fIjson\fR
or
\fIbinary\fR\&. Only one output format can be used at a time\&.
.RE
.PP
\-v, \-\-verbose
.RS 4
Increase the information detail in the output\&.
.RE
.SH "EXAMPLES" .SH "EXAMPLES"
.sp .sp
No examples provided yet\&. No examples provided yet\&.

View file

@ -740,7 +740,7 @@ nvme-capacity-mgmt(1) Manual Page
<h2>NAME</h2> <h2>NAME</h2>
<div class="sectionbody"> <div class="sectionbody">
<p>nvme-capacity-mgmt - <p>nvme-capacity-mgmt -
Send capacity management command to configure/create/delete Endurance Groups or NVM Sets, returns results. Send capacity management command to configure/create/delete Endurance Groups or NVM Sets, returns results.
</p> </p>
</div> </div>
</div> </div>
@ -749,10 +749,11 @@ nvme-capacity-mgmt(1) Manual Page
<h2 id="_synopsis">SYNOPSIS</h2> <h2 id="_synopsis">SYNOPSIS</h2>
<div class="sectionbody"> <div class="sectionbody">
<div class="verseblock"> <div class="verseblock">
<pre class="content"><em>nvme capacity-mgmt</em> &lt;device&gt; [--operation=&lt;operation&gt; | -o &lt;operation&gt;] <pre class="content"><em>nvme capacity-mgmt</em> &lt;device&gt; [--operation=&lt;operation&gt; | -O &lt;operation&gt;]
[--element-id=&lt;element-id&gt; | -i &lt;element-id&gt;] [--element-id=&lt;element-id&gt; | -i &lt;element-id&gt;]
[--cap-lower=&lt;cap-lower&gt; | -l &lt;cap-lower&gt;] [--cap-lower=&lt;cap-lower&gt; | -l &lt;cap-lower&gt;]
[--cap-upper=&lt;cap-upper&gt; | -u &lt;cap-upper&gt;]</pre> [--cap-upper=&lt;cap-upper&gt; | -u &lt;cap-upper&gt;]
[--output-format=&lt;fmt&gt; | -o &lt;fmt&gt;] [--verbose | -v]</pre>
<div class="attribution"> <div class="attribution">
</div></div> </div></div>
</div> </div>
@ -774,14 +775,14 @@ device (ex: /dev/nvme0), or a namespace block device (ex: /dev/nvme0n1).</p></di
<div class="sectionbody"> <div class="sectionbody">
<div class="dlist"><dl> <div class="dlist"><dl>
<dt class="hdlist1"> <dt class="hdlist1">
-o &lt;operation&gt; -O &lt;operation&gt;
</dt> </dt>
<dt class="hdlist1"> <dt class="hdlist1">
--operation=&lt;operation&gt; --operation=&lt;operation&gt;
</dt> </dt>
<dd> <dd>
<p> <p>
Operation to be performed by the controller Operation to be performed by the controller
</p> </p>
</dd> </dd>
<dt class="hdlist1"> <dt class="hdlist1">
@ -792,7 +793,7 @@ device (ex: /dev/nvme0), or a namespace block device (ex: /dev/nvme0n1).</p></di
</dt> </dt>
<dd> <dd>
<p> <p>
Value specific to the value of the Operation field. Value specific to the value of the Operation field.
</p> </p>
</dd> </dd>
<dt class="hdlist1"> <dt class="hdlist1">
@ -804,7 +805,7 @@ device (ex: /dev/nvme0), or a namespace block device (ex: /dev/nvme0n1).</p></di
<dd> <dd>
<p> <p>
Least significant 32 bits of the capacity in bytes of the Endurance Group or Least significant 32 bits of the capacity in bytes of the Endurance Group or
NVM Set to be created NVM Set to be created
</p> </p>
</dd> </dd>
<dt class="hdlist1"> <dt class="hdlist1">
@ -816,7 +817,30 @@ device (ex: /dev/nvme0), or a namespace block device (ex: /dev/nvme0n1).</p></di
<dd> <dd>
<p> <p>
Most significant 32 bits of the capacity in bytes of the Endurance Group or Most significant 32 bits of the capacity in bytes of the Endurance Group or
NVM Set to be created NVM Set to be created
</p>
</dd>
<dt class="hdlist1">
-o &lt;fmt&gt;
</dt>
<dt class="hdlist1">
--output-format=&lt;fmt&gt;
</dt>
<dd>
<p>
Set the reporting format to <em>normal</em>, <em>json</em> or <em>binary</em>. Only one
output format can be used at a time.
</p>
</dd>
<dt class="hdlist1">
-v
</dt>
<dt class="hdlist1">
--verbose
</dt>
<dd>
<p>
Increase the information detail in the output.
</p> </p>
</dd> </dd>
</dl></div> </dl></div>
@ -839,7 +863,7 @@ device (ex: /dev/nvme0), or a namespace block device (ex: /dev/nvme0n1).</p></di
<div id="footer"> <div id="footer">
<div id="footer-text"> <div id="footer-text">
Last updated Last updated
2023-09-29 08:33:07 CEST 2023-12-21 15:49:29 CET
</div> </div>
</div> </div>
</body> </body>

View file

@ -4,15 +4,16 @@ nvme-capacity-mgmt(1)
NAME NAME
---- ----
nvme-capacity-mgmt - Send capacity management command to configure/create/delete nvme-capacity-mgmt - Send capacity management command to configure/create/delete
Endurance Groups or NVM Sets, returns results. Endurance Groups or NVM Sets, returns results.
SYNOPSIS SYNOPSIS
-------- --------
[verse] [verse]
'nvme capacity-mgmt' <device> [--operation=<operation> | -o <operation>] 'nvme capacity-mgmt' <device> [--operation=<operation> | -O <operation>]
[--element-id=<element-id> | -i <element-id>] [--element-id=<element-id> | -i <element-id>]
[--cap-lower=<cap-lower> | -l <cap-lower>] [--cap-lower=<cap-lower> | -l <cap-lower>]
[--cap-upper=<cap-upper> | -u <cap-upper>] [--cap-upper=<cap-upper> | -u <cap-upper>]
[--output-format=<fmt> | -o <fmt>] [--verbose | -v]
DESCRIPTION DESCRIPTION
----------- -----------
@ -27,23 +28,32 @@ device (ex: /dev/nvme0), or a namespace block device (ex: /dev/nvme0n1).
OPTIONS OPTIONS
------- -------
-o <operation>:: -O <operation>::
--operation=<operation>:: --operation=<operation>::
Operation to be performed by the controller Operation to be performed by the controller
-i <element-id>:: -i <element-id>::
--element-id=<element-id>:: --element-id=<element-id>::
Value specific to the value of the Operation field. Value specific to the value of the Operation field.
-l <cap-lower>:: -l <cap-lower>::
--cap-lower=<cap-lower>:: --cap-lower=<cap-lower>::
Least significant 32 bits of the capacity in bytes of the Endurance Group or Least significant 32 bits of the capacity in bytes of the Endurance Group or
NVM Set to be created NVM Set to be created
-u <cap-upper>:: -u <cap-upper>::
--cap-upper=<cap-upper>:: --cap-upper=<cap-upper>::
Most significant 32 bits of the capacity in bytes of the Endurance Group or Most significant 32 bits of the capacity in bytes of the Endurance Group or
NVM Set to be created NVM Set to be created
-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 EXAMPLES
-------- --------

View file

@ -2,12 +2,12 @@
.\" Title: nvme-changed-ns-list-log .\" Title: nvme-changed-ns-list-log
.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] .\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/> .\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
.\" Date: 06/30/2023 .\" Date: 12/21/2023
.\" Manual: NVMe Manual .\" Manual: NVMe Manual
.\" Source: NVMe .\" Source: NVMe
.\" Language: English .\" Language: English
.\" .\"
.TH "NVME\-CHANGED\-NS\-L" "1" "06/30/2023" "NVMe" "NVMe Manual" .TH "NVME\-CHANGED\-NS\-L" "1" "12/21/2023" "NVMe" "NVMe Manual"
.\" ----------------------------------------------------------------- .\" -----------------------------------------------------------------
.\" * Define some portability stuff .\" * Define some portability stuff
.\" ----------------------------------------------------------------- .\" -----------------------------------------------------------------
@ -33,7 +33,7 @@ nvme-changed-ns-list-log \- Send NVMe Changed Namespace List log page request, r
.sp .sp
.nf .nf
\fInvme changed\-ns\-list\-log\fR <device> [\-\-raw\-binary | \-b] \fInvme changed\-ns\-list\-log\fR <device> [\-\-raw\-binary | \-b]
[\-\-output\-format=<fmt> | \-o <fmt>] [\-\-output\-format=<fmt> | \-o <fmt>] [\-\-verbose | \-v]
.fi .fi
.SH "DESCRIPTION" .SH "DESCRIPTION"
.sp .sp
@ -49,13 +49,19 @@ On success, the returned Changed Namespace List log structure may be returned in
Print the raw Changed Namespace List log buffer to stdout\&. Print the raw Changed Namespace List log buffer to stdout\&.
.RE .RE
.PP .PP
\-o <format>, \-\-output\-format=<format> \-o <fmt>, \-\-output\-format=<fmt>
.RS 4 .RS 4
Set the reporting format to Set the reporting format to
\fInormal\fR, \fInormal\fR,
\fIjson\fR, or \fIjson\fR
or
\fIbinary\fR\&. Only one output format can be used at a time\&. \fIbinary\fR\&. Only one output format can be used at a time\&.
.RE .RE
.PP
\-v, \-\-verbose
.RS 4
Increase the information detail in the output\&.
.RE
.SH "EXAMPLES" .SH "EXAMPLES"
.sp .sp
.RS 4 .RS 4

View file

@ -740,7 +740,7 @@ nvme-changed-ns-list-log(1) Manual Page
<h2>NAME</h2> <h2>NAME</h2>
<div class="sectionbody"> <div class="sectionbody">
<p>nvme-changed-ns-list-log - <p>nvme-changed-ns-list-log -
Send NVMe Changed Namespace List log page request, returns result and log. Send NVMe Changed Namespace List log page request, returns result and log.
</p> </p>
</div> </div>
</div> </div>
@ -750,7 +750,7 @@ nvme-changed-ns-list-log(1) Manual Page
<div class="sectionbody"> <div class="sectionbody">
<div class="verseblock"> <div class="verseblock">
<pre class="content"><em>nvme changed-ns-list-log</em> &lt;device&gt; [--raw-binary | -b] <pre class="content"><em>nvme changed-ns-list-log</em> &lt;device&gt; [--raw-binary | -b]
[--output-format=&lt;fmt&gt; | -o &lt;fmt&gt;]</pre> [--output-format=&lt;fmt&gt; | -o &lt;fmt&gt;] [--verbose | -v]</pre>
<div class="attribution"> <div class="attribution">
</div></div> </div></div>
</div> </div>
@ -784,15 +784,26 @@ the raw buffer may be printed to stdout for another program to parse.</p></div>
</p> </p>
</dd> </dd>
<dt class="hdlist1"> <dt class="hdlist1">
-o &lt;format&gt; -o &lt;fmt&gt;
</dt> </dt>
<dt class="hdlist1"> <dt class="hdlist1">
--output-format=&lt;format&gt; --output-format=&lt;fmt&gt;
</dt> </dt>
<dd> <dd>
<p> <p>
Set the reporting format to <em>normal</em>, <em>json</em>, or Set the reporting format to <em>normal</em>, <em>json</em> or <em>binary</em>. Only one
<em>binary</em>. Only one output format can be used at a time. output format can be used at a time.
</p>
</dd>
<dt class="hdlist1">
-v
</dt>
<dt class="hdlist1">
--verbose
</dt>
<dd>
<p>
Increase the information detail in the output.
</p> </p>
</dd> </dd>
</dl></div> </dl></div>
@ -835,7 +846,7 @@ Print the raw Changed Namespace List log to a file:
<div id="footer"> <div id="footer">
<div id="footer-text"> <div id="footer-text">
Last updated Last updated
2023-09-29 08:33:07 CEST 2023-12-21 15:49:29 CET
</div> </div>
</div> </div>
</body> </body>

View file

@ -4,13 +4,13 @@ nvme-changed-ns-list-log(1)
NAME NAME
---- ----
nvme-changed-ns-list-log - Send NVMe Changed Namespace List log page nvme-changed-ns-list-log - Send NVMe Changed Namespace List log page
request, returns result and log. request, returns result and log.
SYNOPSIS SYNOPSIS
-------- --------
[verse] [verse]
'nvme changed-ns-list-log' <device> [--raw-binary | -b] 'nvme changed-ns-list-log' <device> [--raw-binary | -b]
[--output-format=<fmt> | -o <fmt>] [--output-format=<fmt> | -o <fmt>] [--verbose | -v]
DESCRIPTION DESCRIPTION
----------- -----------
@ -31,10 +31,14 @@ OPTIONS
--raw-binary:: --raw-binary::
Print the raw Changed Namespace List log buffer to stdout. Print the raw Changed Namespace List log buffer to stdout.
-o <format>:: -o <fmt>::
--output-format=<format>:: --output-format=<fmt>::
Set the reporting format to 'normal', 'json', or Set the reporting format to 'normal', 'json' or 'binary'. Only one
'binary'. Only one output format can be used at a time. output format can be used at a time.
-v::
--verbose::
Increase the information detail in the output.
EXAMPLES EXAMPLES
-------- --------

View file

@ -8,7 +8,8 @@ nvme-check-dhchap-key - Check a generated host DH-HMAC-CHAP key
SYNOPSIS SYNOPSIS
-------- --------
[verse] [verse]
'nvme check-dhchap-key' [--key=<key> ] 'nvme check-dhchap-key' [--key=<key>]
[--output-format=<fmt> | -o <fmt>] [--verbose | -v]
DESCRIPTION DESCRIPTION
----------- -----------
@ -22,6 +23,15 @@ OPTIONS
--key=<key>:: --key=<key>::
Key to be checked. Key to be checked.
-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 EXAMPLES
-------- --------
No Examples No Examples

View file

@ -8,17 +8,22 @@ nvme-check-tls-key - Check a generated NVMe TLS PSK
SYNOPSIS SYNOPSIS
-------- --------
[verse] [verse]
'nvme check-tls-key' [--keyring=<name> | -k <name> ] 'nvme check-tls-key' [--keyring=<name> | -k <name>]
[--keytype=<type> | -t <type> ] [--keytype=<type> | -t <type>]
[--hostnqn=<nqn> | -n <nqn> ] [--hostnqn=<nqn> | -n <nqn>]
[--subsysnqn=<nqn> | -c <nqn> ] [--subsysnqn=<nqn> | -c <nqn>]
[--keydata=<key> | -d <key> ] [--keydata=<key> | -d <key>]
[--output-format=<fmt> | -o <fmt>]
[--identity=<id-vers> | -I <id-vers>]
[--insert | -i ]
[--verbose | -v]
DESCRIPTION DESCRIPTION
----------- -----------
Checks if the key is a valid NVMe TLS PSK in the PSK interchange format Checks if the key is a valid NVMe TLS PSK in the PSK interchange format
'NVMeTLSkey-1:01:<base64-encoded data>:', and stores the derived 'retained' 'NVMeTLSkey-1:01:<base64-encoded data>:'. If '--insert' is specified the
TLS key in the keyring if the subsystem NQN is specified. the derived 'retained' TLS key is stored in the keyring, otherwise the
TLS identity of the key is printed out.
OPTIONS OPTIONS
------- -------
@ -46,6 +51,25 @@ OPTIONS
--keydata=<key>:: --keydata=<key>::
Key to be checked. Key to be checked.
-I <id-vers>::
--identity=<id-vers>::
NVMe TLS key identity version to be used; '0' for the default
identity, and '1' for the TLS identity suffixed by the PSK hash
as specified in TP8018.
-i:
--insert:
Insert the derived 'retained' key in the keyring.
-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 EXAMPLES
-------- --------
No Examples No Examples

View file

@ -2,12 +2,12 @@
.\" Title: nvme-cmdset-ind-id-ns .\" Title: nvme-cmdset-ind-id-ns
.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] .\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/> .\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
.\" Date: 06/30/2023 .\" Date: 12/21/2023
.\" Manual: NVMe Manual .\" Manual: NVMe Manual
.\" Source: NVMe .\" Source: NVMe
.\" Language: English .\" Language: English
.\" .\"
.TH "NVME\-CMDSET\-IND\-I" "1" "06/30/2023" "NVMe" "NVMe Manual" .TH "NVME\-CMDSET\-IND\-I" "1" "12/21/2023" "NVMe" "NVMe Manual"
.\" ----------------------------------------------------------------- .\" -----------------------------------------------------------------
.\" * Define some portability stuff .\" * Define some portability stuff
.\" ----------------------------------------------------------------- .\" -----------------------------------------------------------------
@ -33,9 +33,8 @@ nvme-cmdset-ind-id-ns \- Send NVMe I/O Command Set Independent Identify Namespac
.sp .sp
.nf .nf
\fInvme cmdset\-ind\-id\-ns\fR <device> [\-\-namespace\-id=<nsid> | \-n <nsid>] \fInvme cmdset\-ind\-id\-ns\fR <device> [\-\-namespace\-id=<nsid> | \-n <nsid>]
[\-b | \-\-raw\-binary] [\-\-raw\-binary | \-b] [\-\-human\-readable | \-H]
[\-\-human\-readable | \-H] [\-\-output\-format=<fmt> | \-o <fmt>] [\-\-verbose | \-v]
[\-\-output\-format=<fmt> | \-o <fmt>]
.fi .fi
.SH "DESCRIPTION" .SH "DESCRIPTION"
.sp .sp
@ -61,13 +60,19 @@ Print the raw buffer to stdout\&. Structure is not parsed by program\&. This ove
This option will parse and format many of the bit fields into human\-readable formats\&. This option will parse and format many of the bit fields into human\-readable formats\&.
.RE .RE
.PP .PP
\-o <format>, \-\-output\-format=<format> \-o <fmt>, \-\-output\-format=<fmt>
.RS 4 .RS 4
Set the reporting format to Set the reporting format to
\fInormal\fR, \fInormal\fR,
\fIjson\fR, or \fIjson\fR
or
\fIbinary\fR\&. Only one output format can be used at a time\&. \fIbinary\fR\&. Only one output format can be used at a time\&.
.RE .RE
.PP
\-v, \-\-verbose
.RS 4
Increase the information detail in the output\&.
.RE
.SH "EXAMPLES" .SH "EXAMPLES"
.sp .sp
.RS 4 .RS 4

View file

@ -750,9 +750,8 @@ nvme-cmdset-ind-id-ns(1) Manual Page
<div class="sectionbody"> <div class="sectionbody">
<div class="verseblock"> <div class="verseblock">
<pre class="content"><em>nvme cmdset-ind-id-ns</em> &lt;device&gt; [--namespace-id=&lt;nsid&gt; | -n &lt;nsid&gt;] <pre class="content"><em>nvme cmdset-ind-id-ns</em> &lt;device&gt; [--namespace-id=&lt;nsid&gt; | -n &lt;nsid&gt;]
[-b | --raw-binary] [--raw-binary | -b] [--human-readable | -H]
[--human-readable | -H] [--output-format=&lt;fmt&gt; | -o &lt;fmt&gt;] [--verbose | -v]</pre>
[--output-format=&lt;fmt&gt; | -o &lt;fmt&gt;]</pre>
<div class="attribution"> <div class="attribution">
</div></div> </div></div>
</div> </div>
@ -815,15 +814,26 @@ raw buffer may be printed to stdout.</p></div>
</p> </p>
</dd> </dd>
<dt class="hdlist1"> <dt class="hdlist1">
-o &lt;format&gt; -o &lt;fmt&gt;
</dt> </dt>
<dt class="hdlist1"> <dt class="hdlist1">
--output-format=&lt;format&gt; --output-format=&lt;fmt&gt;
</dt> </dt>
<dd> <dd>
<p> <p>
Set the reporting format to <em>normal</em>, <em>json</em>, or Set the reporting format to <em>normal</em>, <em>json</em> or <em>binary</em>. Only one
<em>binary</em>. Only one output format can be used at a time. output format can be used at a time.
</p>
</dd>
<dt class="hdlist1">
-v
</dt>
<dt class="hdlist1">
--verbose
</dt>
<dd>
<p>
Increase the information detail in the output.
</p> </p>
</dd> </dd>
</dl></div> </dl></div>
@ -879,7 +889,7 @@ Have the program return the raw structure in binary:
<div id="footer"> <div id="footer">
<div id="footer-text"> <div id="footer-text">
Last updated Last updated
2023-09-29 08:33:07 CEST 2023-12-21 15:49:29 CET
</div> </div>
</div> </div>
</body> </body>

View file

@ -9,9 +9,8 @@ SYNOPSIS
-------- --------
[verse] [verse]
'nvme cmdset-ind-id-ns' <device> [--namespace-id=<nsid> | -n <nsid>] 'nvme cmdset-ind-id-ns' <device> [--namespace-id=<nsid> | -n <nsid>]
[-b | --raw-binary] [--raw-binary | -b] [--human-readable | -H]
[--human-readable | -H] [--output-format=<fmt> | -o <fmt>] [--verbose | -v]
[--output-format=<fmt> | -o <fmt>]
DESCRIPTION DESCRIPTION
----------- -----------
@ -47,11 +46,14 @@ OPTIONS
This option will parse and format many of the bit fields This option will parse and format many of the bit fields
into human-readable formats. into human-readable formats.
-o <format>:: -o <fmt>::
--output-format=<format>:: --output-format=<fmt>::
Set the reporting format to 'normal', 'json', or Set the reporting format to 'normal', 'json' or 'binary'. Only one
'binary'. Only one output format can be used at a time. output format can be used at a time.
-v::
--verbose::
Increase the information detail in the output.
EXAMPLES EXAMPLES
-------- --------

View file

@ -2,12 +2,12 @@
.\" Title: nvme-compare .\" Title: nvme-compare
.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] .\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/> .\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
.\" Date: 06/30/2023 .\" Date: 12/21/2023
.\" Manual: NVMe Manual .\" Manual: NVMe Manual
.\" Source: NVMe .\" Source: NVMe
.\" Language: English .\" Language: English
.\" .\"
.TH "NVME\-COMPARE" "1" "06/30/2023" "NVMe" "NVMe Manual" .TH "NVME\-COMPARE" "1" "12/21/2023" "NVMe" "NVMe Manual"
.\" ----------------------------------------------------------------- .\" -----------------------------------------------------------------
.\" * Define some portability stuff .\" * Define some portability stuff
.\" ----------------------------------------------------------------- .\" -----------------------------------------------------------------
@ -47,12 +47,13 @@ nvme-compare \- Send an NVMe Compare command, provide results
[\-\-dir\-type=<type> | \-T <type>] [\-\-dir\-type=<type> | \-T <type>]
[\-\-dir\-spec=<spec> | \-S <spec>] [\-\-dir\-spec=<spec> | \-S <spec>]
[\-\-dsm=<dsm> | \-D <dsm>] [\-\-dsm=<dsm> | \-D <dsm>]
[\-\-show\-command | \-v] [\-\-show\-command | \-V]
[\-\-dry\-run | \-w] [\-\-dry\-run | \-w]
[\-\-latency | \-t] [\-\-latency | \-t]
[\-\-storage\-tag<storage\-tag> | \-g <storage\-tag>] [\-\-storage\-tag<storage\-tag> | \-g <storage\-tag>]
[\-\-storage\-tag\-check | \-C] [\-\-storage\-tag\-check | \-C]
[\-\-force] [\-\-force]
[\-\-output\-format=<fmt> | \-o <fmt>] [\-\-verbose | \-v]
.fi .fi
.SH "DESCRIPTION" .SH "DESCRIPTION"
.sp .sp
@ -97,9 +98,6 @@ Metadata file\&.
\-p <prinfo>, \-\-prinfo=<prinfo> \-p <prinfo>, \-\-prinfo=<prinfo>
.RS 4 .RS 4
Protection Information and check field\&. Protection Information and check field\&.
.RE
.sp
+
.TS .TS
allbox tab(:); allbox tab(:);
lt lt lt lt
@ -109,49 +107,38 @@ lt lt
lt lt lt lt
lt lt. lt lt.
T{ T{
.sp
Bit Bit
T}:T{ T}:T{
.sp
Description Description
T} T}
T{ T{
.sp
3 3
T}:T{ T}:T{
.sp
PRACT: Protection Information Action\&. When set to 1, PI is stripped/inserted on read/write when the block format\(cqs metadata size is 8\&. When set to 0, metadata is passes\&. PRACT: Protection Information Action\&. When set to 1, PI is stripped/inserted on read/write when the block format\(cqs metadata size is 8\&. When set to 0, metadata is passes\&.
T} T}
T{ T{
.sp
2:0 2:0
T}:T{ T}:T{
.sp
PRCHK: Protection Information Check: PRCHK: Protection Information Check:
T} T}
T{ T{
.sp
2 2
T}:T{ T}:T{
.sp
Set to 1 enables checking the guard tag Set to 1 enables checking the guard tag
T} T}
T{ T{
.sp
1 1
T}:T{ T}:T{
.sp
Set to 1 enables checking the application tag Set to 1 enables checking the application tag
T} T}
T{ T{
.sp
0 0
T}:T{ T}:T{
.sp
Set to 1 enables checking the reference tag Set to 1 enables checking the reference tag
T} T}
.TE .TE
.sp 1 .sp 1
.RE
.PP .PP
\-m <appmask>, \-\-app\-tag\-mask=<appmask> \-m <appmask>, \-\-app\-tag\-mask=<appmask>
.RS 4 .RS 4
@ -188,7 +175,7 @@ Optional field for directive specifics\&. When used with write streams, this val
The optional data set management attributes for this command\&. The argument for this is the least significant 8 bits of the DSM field in a write command; the most significant 16 bits of the field come from the directive specific field, if used\&. This may be used to set attributes for the LBAs being written, like access frequency, type, latency, among other things, as well as yet to be defined types\&. Please consult the NVMe specification for detailed breakdown of how to use this field\&. The optional data set management attributes for this command\&. The argument for this is the least significant 8 bits of the DSM field in a write command; the most significant 16 bits of the field come from the directive specific field, if used\&. This may be used to set attributes for the LBAs being written, like access frequency, type, latency, among other things, as well as yet to be defined types\&. Please consult the NVMe specification for detailed breakdown of how to use this field\&.
.RE .RE
.PP .PP
\-v, \-\-show\-cmd \-V, \-\-show\-cmd
.RS 4 .RS 4
Print out the command to be sent\&. Print out the command to be sent\&.
.RE .RE
@ -220,6 +207,20 @@ This flag enables Storage Tag field checking as part of end\-to\-end data protec
.RS 4 .RS 4
Ignore namespace is currently busy and performed the operation even though\&. Ignore namespace is currently busy and performed the operation even though\&.
.RE .RE
.PP
\-o <fmt>, \-\-output\-format=<fmt>
.RS 4
Set the reporting format to
\fInormal\fR,
\fIjson\fR
or
\fIbinary\fR\&. Only one output format can be used at a time\&.
.RE
.PP
\-v, \-\-verbose
.RS 4
Increase the information detail in the output\&.
.RE
.SH "EXAMPLES" .SH "EXAMPLES"
.sp .sp
No examples yet\&. No examples yet\&.

View file

@ -764,12 +764,13 @@ nvme-compare(1) Manual Page
[--dir-type=&lt;type&gt; | -T &lt;type&gt;] [--dir-type=&lt;type&gt; | -T &lt;type&gt;]
[--dir-spec=&lt;spec&gt; | -S &lt;spec&gt;] [--dir-spec=&lt;spec&gt; | -S &lt;spec&gt;]
[--dsm=&lt;dsm&gt; | -D &lt;dsm&gt;] [--dsm=&lt;dsm&gt; | -D &lt;dsm&gt;]
[--show-command | -v] [--show-command | -V]
[--dry-run | -w] [--dry-run | -w]
[--latency | -t] [--latency | -t]
[--storage-tag&lt;storage-tag&gt; | -g &lt;storage-tag&gt;] [--storage-tag&lt;storage-tag&gt; | -g &lt;storage-tag&gt;]
[--storage-tag-check | -C] [--storage-tag-check | -C]
[--force]</pre> [--force]
[--output-format=&lt;fmt&gt; | -o &lt;fmt&gt;] [--verbose | -v]</pre>
<div class="attribution"> <div class="attribution">
</div></div> </div></div>
</div> </div>
@ -877,9 +878,6 @@ provided, then a comparison is also performed for the metadata.</p></div>
<p> <p>
Protection Information and check field. Protection Information and check field.
</p> </p>
</dd>
</dl></div>
<div class="paragraph"><p>+</p></div>
<div class="tableblock"> <div class="tableblock">
<table rules="all" <table rules="all"
width="100%" width="100%"
@ -917,7 +915,7 @@ metadata is passes.</p></td>
</tbody> </tbody>
</table> </table>
</div> </div>
<div class="dlist"><dl> </dd>
<dt class="hdlist1"> <dt class="hdlist1">
-m &lt;appmask&gt; -m &lt;appmask&gt;
</dt> </dt>
@ -1009,7 +1007,7 @@ metadata is passes.</p></td>
</p> </p>
</dd> </dd>
<dt class="hdlist1"> <dt class="hdlist1">
-v -V
</dt> </dt>
<dt class="hdlist1"> <dt class="hdlist1">
--show-cmd --show-cmd
@ -1071,8 +1069,31 @@ metadata is passes.</p></td>
</dt> </dt>
<dd> <dd>
<p> <p>
Ignore namespace is currently busy and performed the operation Ignore namespace is currently busy and performed the operation
even though. even though.
</p>
</dd>
<dt class="hdlist1">
-o &lt;fmt&gt;
</dt>
<dt class="hdlist1">
--output-format=&lt;fmt&gt;
</dt>
<dd>
<p>
Set the reporting format to <em>normal</em>, <em>json</em> or <em>binary</em>. Only one
output format can be used at a time.
</p>
</dd>
<dt class="hdlist1">
-v
</dt>
<dt class="hdlist1">
--verbose
</dt>
<dd>
<p>
Increase the information detail in the output.
</p> </p>
</dd> </dd>
</dl></div> </dl></div>
@ -1095,7 +1116,7 @@ metadata is passes.</p></td>
<div id="footer"> <div id="footer">
<div id="footer-text"> <div id="footer-text">
Last updated Last updated
2023-09-29 08:33:07 CEST 2023-12-21 15:49:29 CET
</div> </div>
</div> </div>
</body> </body>

View file

@ -23,12 +23,13 @@ SYNOPSIS
[--dir-type=<type> | -T <type>] [--dir-type=<type> | -T <type>]
[--dir-spec=<spec> | -S <spec>] [--dir-spec=<spec> | -S <spec>]
[--dsm=<dsm> | -D <dsm>] [--dsm=<dsm> | -D <dsm>]
[--show-command | -v] [--show-command | -V]
[--dry-run | -w] [--dry-run | -w]
[--latency | -t] [--latency | -t]
[--storage-tag<storage-tag> | -g <storage-tag>] [--storage-tag<storage-tag> | -g <storage-tag>]
[--storage-tag-check | -C] [--storage-tag-check | -C]
[--force] [--force]
[--output-format=<fmt> | -o <fmt>] [--verbose | -v]
DESCRIPTION DESCRIPTION
----------- -----------
@ -73,7 +74,6 @@ OPTIONS
-p <prinfo>:: -p <prinfo>::
--prinfo=<prinfo>:: --prinfo=<prinfo>::
Protection Information and check field. Protection Information and check field.
+ +
[] []
|================= |=================
@ -127,7 +127,7 @@ metadata is passes.
among other things, as well as yet to be defined types. Please among other things, as well as yet to be defined types. Please
consult the NVMe specification for detailed breakdown of how to consult the NVMe specification for detailed breakdown of how to
use this field. use this field.
-v:: -V::
--show-cmd:: --show-cmd::
Print out the command to be sent. Print out the command to be sent.
@ -151,8 +151,17 @@ metadata is passes.
data protection processing. data protection processing.
--force:: --force::
Ignore namespace is currently busy and performed the operation Ignore namespace is currently busy and performed the operation
even though. even though.
-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 EXAMPLES
-------- --------

View file

@ -8,33 +8,28 @@ nvme-config - NVMe-over-Fabrics configuration.
SYNOPSIS SYNOPSIS
-------- --------
[verse] [verse]
'nvme config' 'nvme config' [--scan | -R] [--modify | -M] [--update | -U] [--dump | -O]
[--scan | -R] [--config=<cfg> | -J <cfg>]
[--modify | -M] [--transport=<trtype> | -t <trtype>]
[--update | -U] [--nqn=<subnqn> | -n <subnqn>]
[--dump | -O] [--traddr=<traddr> | -a <traddr>]
[--config=<cfg> | -J <cfg> ] [--trsvcid=<trsvcid> | -s <trsvcid>]
[--transport=<trtype> | -t <trtype>] [--host-traddr=<traddr> | -w <traddr>]
[--nqn=<subnqn> | -n <subnqn>] [--host-iface=<iface> | -f <iface>]
[--traddr=<traddr> | -a <traddr>] [--hostnqn=<hostnqn> | -q <hostnqn>]
[--trsvcid=<trsvcid> | -s <trsvcid>] [--hostid=<hostid> | -I <hostid>]
[--host-traddr=<traddr> | -w <traddr>] [--dhchap-secret=<secret> | -S <secret>]
[--host-iface=<iface> | -f <iface>] [--dhchap-ctrl-secret=<secret> | -C <secret>]
[--hostnqn=<hostnqn> | -q <hostnqn>] [--nr-io-queues=<#> | -i <#>]
[--hostid=<hostid> | -I <hostid>] [--nr-write-queues=<#> | -W <#>]
[--dhchap-secret=<secret> | -S <secret>] [--nr-poll-queues=<#> | -P <#>]
[--dhchap-ctrl-secret=<secret> | -C <secret>] [--queue-size=<#> | -Q <#>]
[--nr-io-queues=<#> | -i <#>] [--keep-alive-tmo=<#> | -k <#>]
[--nr-write-queues=<#> | -W <#>] [--reconnect-delay=<#> | -c <#>]
[--nr-poll-queues=<#> | -P <#>] [--ctrl-loss-tmo=<#> | -l <#>]
[--queue-size=<#> | -Q <#>] [--duplicate-connect | -D] [--disable-sqflow | -d]
[--keep-alive-tmo=<#> | -k <#>] [--hdr-digest | -g] [--data-digest | -G]
[--reconnect-delay=<#> | -c <#>] [--output-format=<fmt> | -o <fmt>] [--verbose | -v]
[--ctrl-loss-tmo=<#> | -l <#>]
[--duplicate-connect | -D]
[--disable-sqflow | -d]
[--hdr-digest | -g]
[--data-digest | -G]
DESCRIPTION DESCRIPTION
----------- -----------
@ -52,7 +47,7 @@ OPTIONS
-M:: -M::
--modify:: --modify::
Add or modify entries in the configuration based on the values from Add or modify entries in the configuration based on the values from
the commandline. the commandline.
-U:: -U::
--update:: --update::
@ -71,7 +66,7 @@ OPTIONS
-t <trtype>:: -t <trtype>::
--transport=<trtype>:: --transport=<trtype>::
This field specifies the network fabric being used for This field specifies the network fabric being used for
a NVMe-over-Fabrics network. Current string values include: a NVMe-over-Fabrics network. Current string values include:
+ +
[] []
|================= |=================
@ -94,7 +89,7 @@ OPTIONS
-s <trsvcid>:: -s <trsvcid>::
--trsvcid=<trsvcid>:: --trsvcid=<trsvcid>::
This field specifies the transport service id. For transports using IP This field specifies the transport service id. For transports using IP
addressing (e.g. rdma) this field is the port number. By default, the IP addressing (e.g. rdma) this field is the port number. By default, the IP
port number for the RDMA transport is 4420. port number for the RDMA transport is 4420.
@ -186,6 +181,15 @@ OPTIONS
--data-digest:: --data-digest::
Generates/verifies data digest (TCP). Generates/verifies data digest (TCP).
-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 EXAMPLES
-------- --------
* Read the current system configuration and write the contents to /tmp/config.json: * Read the current system configuration and write the contents to /tmp/config.json:
@ -200,7 +204,6 @@ nvme-discover(1)
nvme-connect(1) nvme-connect(1)
https://github.com/linux-nvme/libnvme/doc/config-schema.json https://github.com/linux-nvme/libnvme/doc/config-schema.json
AUTHORS AUTHORS
------- -------
This was written by mailto:hare@suse.com[Hannes Reinecke] This was written by mailto:hare@suse.com[Hannes Reinecke]

View file

@ -2,12 +2,12 @@
.\" Title: nvme-connect-all .\" Title: nvme-connect-all
.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] .\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/> .\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
.\" Date: 06/30/2023 .\" Date: 12/21/2023
.\" Manual: NVMe Manual .\" Manual: NVMe Manual
.\" Source: NVMe .\" Source: NVMe
.\" Language: English .\" Language: English
.\" .\"
.TH "NVME\-CONNECT\-ALL" "1" "06/30/2023" "NVMe" "NVMe Manual" .TH "NVME\-CONNECT\-ALL" "1" "12/21/2023" "NVMe" "NVMe Manual"
.\" ----------------------------------------------------------------- .\" -----------------------------------------------------------------
.\" * Define some portability stuff .\" * Define some portability stuff
.\" ----------------------------------------------------------------- .\" -----------------------------------------------------------------
@ -32,37 +32,29 @@ nvme-connect-all \- Discover and Connect to Fabrics controllers\&.
.SH "SYNOPSIS" .SH "SYNOPSIS"
.sp .sp
.nf .nf
\fInvme connect\-all\fR \fInvme connect\-all\fR [\-\-transport=<trtype> | \-t <trtype>]
[\-\-transport=<trtype> | \-t <trtype>] [\-\-nqn=<subnqn> | \-n <subnqn>]
[\-\-nqn=<subnqn> | \-n <subnqn>] [\-\-traddr=<traddr> | \-a <traddr>]
[\-\-traddr=<traddr> | \-a <traddr>] [\-\-trsvcid=<trsvcid> | \-s <trsvcid>]
[\-\-trsvcid=<trsvcid> | \-s <trsvcid>] [\-\-host\-traddr=<traddr> | \-w <traddr>]
[\-\-host\-traddr=<traddr> | \-w <traddr>] [\-\-host\-iface=<iface> | \-f <iface>]
[\-\-host\-iface=<iface> | \-f <iface>] [\-\-hostnqn=<hostnqn> | \-q <hostnqn>]
[\-\-hostnqn=<hostnqn> | \-q <hostnqn>] [\-\-hostid=<hostid> | \-I <hostid>]
[\-\-hostid=<hostid> | \-I <hostid>] [\-\-raw=<filename> | \-r <filename>]
[\-\-raw=<filename> | \-r <filename>] [\-\-device=<device> | \-d <device>]
[\-\-device=<device> | \-d <device>] [\-\-cfg\-file=<cfg> | \-C <cfg>]
[\-\-cfg\-file=<cfg> | \-C <cfg>] [\-\-keep\-alive\-tmo=<sec> | \-k <sec>]
[\-\-keep\-alive\-tmo=<sec> | \-k <sec>] [\-\-reconnect\-delay=<#> | \-c <#>]
[\-\-reconnect\-delay=<#> | \-c <#>] [\-\-ctrl\-loss\-tmo=<#> | \-l <#>]
[\-\-ctrl\-loss\-tmo=<#> | \-l <#>] [\-\-nr\-io\-queues=<#> | \-i <#>]
[\-\-nr\-io\-queues=<#> | \-i <#>] [\-\-nr\-write\-queues=<#> | \-W <#>]
[\-\-nr\-write\-queues=<#> | \-W <#>] [\-\-nr\-poll\-queues=<#> | \-P <#>]
[\-\-nr\-poll\-queues=<#> | \-P <#>] [\-\-queue\-size=<#> | \-Q <#>] [\-\-keyring=<#>]
[\-\-queue\-size=<#> | \-Q <#>] [\-\-tls_key=<#>] [\-\-hdr\-digest | \-g] [\-\-data\-digest | \-G]
[\-\-keyring=<#> ] [\-\-persistent | \-p] [\-\-tls] [\-\-quiet | \-S]
[\-\-tls_key=<#> ] [\-\-dump\-config | \-O] [\-\-nbft] [\-\-no\-nbft]
[\-\-hdr\-digest | \-g] [\-\-nbft\-path=<STR>] [\-\-context=<STR>]
[\-\-data\-digest | \-G] [\-\-output\-format=<fmt> | \-o <fmt>] [\-\-verbose | \-v]
[\-\-persistent | \-p]
[\-\-tls ]
[\-\-quiet | \-S]
[\-\-dump\-config | \-O]
[\-\-nbft]
[\-\-no\-nbft]
[\-\-nbft\-path=<STR>]
[\-\-context=<STR>]
.fi .fi
.SH "DESCRIPTION" .SH "DESCRIPTION"
.sp .sp
@ -266,6 +258,20 @@ Use a user\-defined path to the NBFT tables
.RS 4 .RS 4
Set the execution context to <STR>\&. This allows to coordinate the management of the global resources\&. Set the execution context to <STR>\&. This allows to coordinate the management of the global resources\&.
.RE .RE
.PP
\-o <fmt>, \-\-output\-format=<fmt>
.RS 4
Set the reporting format to
\fInormal\fR,
\fIjson\fR
or
\fIbinary\fR\&. Only one output format can be used at a time\&.
.RE
.PP
\-v, \-\-verbose
.RS 4
Increase the information detail in the output\&.
.RE
.SH "EXAMPLES" .SH "EXAMPLES"
.sp .sp
.RS 4 .RS 4
@ -352,9 +358,9 @@ command using a /usr/local/etc/nvme/discovery\&.conf file:
.RS 4 .RS 4
.\} .\}
.nf .nf
# Machine default \*(Aqnvme discover\*(Aq commands\&. Query the # Machine default \*(Aqnvme discover\*(Aq commands\&. Query the
# Discovery Controller\*(Aqs two ports (some resources may only # Discovery Controller\*(Aqs two ports (some resources may only
# be accessible on a single port)\&. Note an official # be accessible on a single port)\&. Note an official
# nqn (Host) name defined in the NVMe specification is being used # nqn (Host) name defined in the NVMe specification is being used
# in this example\&. # in this example\&.
\-t rdma \-a 192\&.168\&.69\&.33 \-s 4420 \-q nqn\&.2014\-08\&.com\&.example:nvme:nvm\-subsystem\-sn\-d78432 \-t rdma \-a 192\&.168\&.69\&.33 \-s 4420 \-q nqn\&.2014\-08\&.com\&.example:nvme:nvm\-subsystem\-sn\-d78432

View file

@ -749,37 +749,29 @@ nvme-connect-all(1) Manual Page
<h2 id="_synopsis">SYNOPSIS</h2> <h2 id="_synopsis">SYNOPSIS</h2>
<div class="sectionbody"> <div class="sectionbody">
<div class="verseblock"> <div class="verseblock">
<pre class="content"><em>nvme connect-all</em> <pre class="content"><em>nvme connect-all</em> [--transport=&lt;trtype&gt; | -t &lt;trtype&gt;]
[--transport=&lt;trtype&gt; | -t &lt;trtype&gt;] [--nqn=&lt;subnqn&gt; | -n &lt;subnqn&gt;]
[--nqn=&lt;subnqn&gt; | -n &lt;subnqn&gt;] [--traddr=&lt;traddr&gt; | -a &lt;traddr&gt;]
[--traddr=&lt;traddr&gt; | -a &lt;traddr&gt;] [--trsvcid=&lt;trsvcid&gt; | -s &lt;trsvcid&gt;]
[--trsvcid=&lt;trsvcid&gt; | -s &lt;trsvcid&gt;] [--host-traddr=&lt;traddr&gt; | -w &lt;traddr&gt;]
[--host-traddr=&lt;traddr&gt; | -w &lt;traddr&gt;] [--host-iface=&lt;iface&gt; | -f &lt;iface&gt;]
[--host-iface=&lt;iface&gt; | -f &lt;iface&gt;] [--hostnqn=&lt;hostnqn&gt; | -q &lt;hostnqn&gt;]
[--hostnqn=&lt;hostnqn&gt; | -q &lt;hostnqn&gt;] [--hostid=&lt;hostid&gt; | -I &lt;hostid&gt;]
[--hostid=&lt;hostid&gt; | -I &lt;hostid&gt;] [--raw=&lt;filename&gt; | -r &lt;filename&gt;]
[--raw=&lt;filename&gt; | -r &lt;filename&gt;] [--device=&lt;device&gt; | -d &lt;device&gt;]
[--device=&lt;device&gt; | -d &lt;device&gt;] [--cfg-file=&lt;cfg&gt; | -C &lt;cfg&gt;]
[--cfg-file=&lt;cfg&gt; | -C &lt;cfg&gt;] [--keep-alive-tmo=&lt;sec&gt; | -k &lt;sec&gt;]
[--keep-alive-tmo=&lt;sec&gt; | -k &lt;sec&gt;] [--reconnect-delay=&lt;#&gt; | -c &lt;#&gt;]
[--reconnect-delay=&lt;#&gt; | -c &lt;#&gt;] [--ctrl-loss-tmo=&lt;#&gt; | -l &lt;#&gt;]
[--ctrl-loss-tmo=&lt;#&gt; | -l &lt;#&gt;] [--nr-io-queues=&lt;#&gt; | -i &lt;#&gt;]
[--nr-io-queues=&lt;#&gt; | -i &lt;#&gt;] [--nr-write-queues=&lt;#&gt; | -W &lt;#&gt;]
[--nr-write-queues=&lt;#&gt; | -W &lt;#&gt;] [--nr-poll-queues=&lt;#&gt; | -P &lt;#&gt;]
[--nr-poll-queues=&lt;#&gt; | -P &lt;#&gt;] [--queue-size=&lt;#&gt; | -Q &lt;#&gt;] [--keyring=&lt;#&gt;]
[--queue-size=&lt;#&gt; | -Q &lt;#&gt;] [--tls_key=&lt;#&gt;] [--hdr-digest | -g] [--data-digest | -G]
[--keyring=&lt;#&gt; ] [--persistent | -p] [--tls] [--quiet | -S]
[--tls_key=&lt;#&gt; ] [--dump-config | -O] [--nbft] [--no-nbft]
[--hdr-digest | -g] [--nbft-path=&lt;STR&gt;] [--context=&lt;STR&gt;]
[--data-digest | -G] [--output-format=&lt;fmt&gt; | -o &lt;fmt&gt;] [--verbose | -v]</pre>
[--persistent | -p]
[--tls ]
[--quiet | -S]
[--dump-config | -O]
[--nbft]
[--no-nbft]
[--nbft-path=&lt;STR&gt;]
[--context=&lt;STR&gt;]</pre>
<div class="attribution"> <div class="attribution">
</div></div> </div></div>
</div> </div>
@ -813,7 +805,7 @@ background.</p></div>
<dd> <dd>
<p> <p>
This field specifies the network fabric being used for This field specifies the network fabric being used for
a NVMe-over-Fabrics network. Current string values include: a NVMe-over-Fabrics network. Current string values include:
</p> </p>
<div class="tableblock"> <div class="tableblock">
<table rules="all" <table rules="all"
@ -879,7 +871,7 @@ cellspacing="0" cellpadding="4">
</dt> </dt>
<dd> <dd>
<p> <p>
This field specifies the transport service id. For transports using IP This field specifies the transport service id. For transports using IP
addressing (e.g. rdma) this field is the port number. By default, the IP addressing (e.g. rdma) this field is the port number. By default, the IP
port number for the RDMA transport is 4420. port number for the RDMA transport is 4420.
</p> </p>
@ -1178,6 +1170,29 @@ cellspacing="0" cellpadding="4">
the management of the global resources. the management of the global resources.
</p> </p>
</dd> </dd>
<dt class="hdlist1">
-o &lt;fmt&gt;
</dt>
<dt class="hdlist1">
--output-format=&lt;fmt&gt;
</dt>
<dd>
<p>
Set the reporting format to <em>normal</em>, <em>json</em> or <em>binary</em>. Only one
output format can be used at a time.
</p>
</dd>
<dt class="hdlist1">
-v
</dt>
<dt class="hdlist1">
--verbose
</dt>
<dd>
<p>
Increase the information detail in the output.
</p>
</dd>
</dl></div> </dl></div>
</div> </div>
</div> </div>
@ -1221,9 +1236,9 @@ Issue a <em>nvme connect-all</em> command using a /usr/local/etc/nvme/discovery.
</p> </p>
<div class="listingblock"> <div class="listingblock">
<div class="content"> <div class="content">
<pre><code># Machine default 'nvme discover' commands. Query the <pre><code># Machine default 'nvme discover' commands. Query the
# Discovery Controller's two ports (some resources may only # Discovery Controller's two ports (some resources may only
# be accessible on a single port). Note an official # be accessible on a single port). Note an official
# nqn (Host) name defined in the NVMe specification is being used # nqn (Host) name defined in the NVMe specification is being used
# in this example. # in this example.
-t rdma -a 192.168.69.33 -s 4420 -q nqn.2014-08.com.example:nvme:nvm-subsystem-sn-d78432 -t rdma -a 192.168.69.33 -s 4420 -q nqn.2014-08.com.example:nvme:nvm-subsystem-sn-d78432
@ -1253,7 +1268,7 @@ nvme-connect(1)</p></div>
<div id="footer"> <div id="footer">
<div id="footer-text"> <div id="footer-text">
Last updated Last updated
2023-09-29 08:33:07 CEST 2023-12-21 15:49:29 CET
</div> </div>
</div> </div>
</body> </body>

View file

@ -8,37 +8,29 @@ nvme-connect-all - Discover and Connect to Fabrics controllers.
SYNOPSIS SYNOPSIS
-------- --------
[verse] [verse]
'nvme connect-all' 'nvme connect-all' [--transport=<trtype> | -t <trtype>]
[--transport=<trtype> | -t <trtype>] [--nqn=<subnqn> | -n <subnqn>]
[--nqn=<subnqn> | -n <subnqn>] [--traddr=<traddr> | -a <traddr>]
[--traddr=<traddr> | -a <traddr>] [--trsvcid=<trsvcid> | -s <trsvcid>]
[--trsvcid=<trsvcid> | -s <trsvcid>] [--host-traddr=<traddr> | -w <traddr>]
[--host-traddr=<traddr> | -w <traddr>] [--host-iface=<iface> | -f <iface>]
[--host-iface=<iface> | -f <iface>] [--hostnqn=<hostnqn> | -q <hostnqn>]
[--hostnqn=<hostnqn> | -q <hostnqn>] [--hostid=<hostid> | -I <hostid>]
[--hostid=<hostid> | -I <hostid>] [--raw=<filename> | -r <filename>]
[--raw=<filename> | -r <filename>] [--device=<device> | -d <device>]
[--device=<device> | -d <device>] [--cfg-file=<cfg> | -C <cfg>]
[--cfg-file=<cfg> | -C <cfg>] [--keep-alive-tmo=<sec> | -k <sec>]
[--keep-alive-tmo=<sec> | -k <sec>] [--reconnect-delay=<#> | -c <#>]
[--reconnect-delay=<#> | -c <#>] [--ctrl-loss-tmo=<#> | -l <#>]
[--ctrl-loss-tmo=<#> | -l <#>] [--nr-io-queues=<#> | -i <#>]
[--nr-io-queues=<#> | -i <#>] [--nr-write-queues=<#> | -W <#>]
[--nr-write-queues=<#> | -W <#>] [--nr-poll-queues=<#> | -P <#>]
[--nr-poll-queues=<#> | -P <#>] [--queue-size=<#> | -Q <#>] [--keyring=<#>]
[--queue-size=<#> | -Q <#>] [--tls_key=<#>] [--hdr-digest | -g] [--data-digest | -G]
[--keyring=<#> ] [--persistent | -p] [--tls] [--quiet | -S]
[--tls_key=<#> ] [--dump-config | -O] [--nbft] [--no-nbft]
[--hdr-digest | -g] [--nbft-path=<STR>] [--context=<STR>]
[--data-digest | -G] [--output-format=<fmt> | -o <fmt>] [--verbose | -v]
[--persistent | -p]
[--tls ]
[--quiet | -S]
[--dump-config | -O]
[--nbft]
[--no-nbft]
[--nbft-path=<STR>]
[--context=<STR>]
DESCRIPTION DESCRIPTION
----------- -----------
@ -62,13 +54,13 @@ OPTIONS
-t <trtype>:: -t <trtype>::
--transport=<trtype>:: --transport=<trtype>::
This field specifies the network fabric being used for This field specifies the network fabric being used for
a NVMe-over-Fabrics network. Current string values include: a NVMe-over-Fabrics network. Current string values include:
+ +
[] []
|================= |=================
|Value|Definition |Value|Definition
|rdma|The network fabric is an rdma network (RoCE, iWARP, Infiniband, basic rdma, etc) |rdma|The network fabric is an rdma network (RoCE, iWARP, Infiniband, basic rdma, etc)
|fc |*WIP* The network fabric is a Fibre Channel network. |fc |*WIP* The network fabric is a Fibre Channel network.
|tcp |The network fabric is a TCP/IP network. |tcp |The network fabric is a TCP/IP network.
|loop|Connect to a NVMe over Fabrics target on the local host |loop|Connect to a NVMe over Fabrics target on the local host
|================= |=================
@ -85,7 +77,7 @@ OPTIONS
-s <trsvcid>:: -s <trsvcid>::
--trsvcid=<trsvcid>:: --trsvcid=<trsvcid>::
This field specifies the transport service id. For transports using IP This field specifies the transport service id. For transports using IP
addressing (e.g. rdma) this field is the port number. By default, the IP addressing (e.g. rdma) this field is the port number. By default, the IP
port number for the RDMA transport is 4420. port number for the RDMA transport is 4420.
@ -203,18 +195,27 @@ OPTIONS
Print out resulting JSON configuration file to stdout. Print out resulting JSON configuration file to stdout.
--nbft:: --nbft::
Only look at NBFT tables Only look at NBFT tables
--no-nbft:: --no-nbft::
Do not look at NBFT tables Do not look at NBFT tables
--nbft-path=<STR>:: --nbft-path=<STR>::
Use a user-defined path to the NBFT tables Use a user-defined path to the NBFT tables
--context <STR>:: --context <STR>::
Set the execution context to <STR>. This allows to coordinate Set the execution context to <STR>. This allows to coordinate
the management of the global resources. the management of the global resources.
-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 EXAMPLES
-------- --------
* Connect to all records returned by the Discover Controller with IP4 address * Connect to all records returned by the Discover Controller with IP4 address
@ -241,9 +242,9 @@ the RDMA network. Port 4420 is used by default:
* Issue a 'nvme connect-all' command using a @SYSCONFDIR@/nvme/discovery.conf file: * Issue a 'nvme connect-all' command using a @SYSCONFDIR@/nvme/discovery.conf file:
+ +
----------- -----------
# Machine default 'nvme discover' commands. Query the # Machine default 'nvme discover' commands. Query the
# Discovery Controller's two ports (some resources may only # Discovery Controller's two ports (some resources may only
# be accessible on a single port). Note an official # be accessible on a single port). Note an official
# nqn (Host) name defined in the NVMe specification is being used # nqn (Host) name defined in the NVMe specification is being used
# in this example. # in this example.
-t rdma -a 192.168.69.33 -s 4420 -q nqn.2014-08.com.example:nvme:nvm-subsystem-sn-d78432 -t rdma -a 192.168.69.33 -s 4420 -q nqn.2014-08.com.example:nvme:nvm-subsystem-sn-d78432

View file

@ -2,12 +2,12 @@
.\" Title: nvme-connect .\" Title: nvme-connect
.\" Author: [see the "AUTHORS" section] .\" Author: [see the "AUTHORS" section]
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/> .\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
.\" Date: 06/30/2023 .\" Date: 12/21/2023
.\" Manual: NVMe Manual .\" Manual: NVMe Manual
.\" Source: NVMe .\" Source: NVMe
.\" Language: English .\" Language: English
.\" .\"
.TH "NVME\-CONNECT" "1" "06/30/2023" "NVMe" "NVMe Manual" .TH "NVME\-CONNECT" "1" "12/21/2023" "NVMe" "NVMe Manual"
.\" ----------------------------------------------------------------- .\" -----------------------------------------------------------------
.\" * Define some portability stuff .\" * Define some portability stuff
.\" ----------------------------------------------------------------- .\" -----------------------------------------------------------------
@ -32,36 +32,29 @@ nvme-connect \- Connect to a Fabrics controller\&.
.SH "SYNOPSIS" .SH "SYNOPSIS"
.sp .sp
.nf .nf
\fInvme connect\fR \fInvme connect\fR [\-\-transport=<trtype> | \-t <trtype>]
[\-\-transport=<trtype> | \-t <trtype>] [\-\-nqn=<subnqn> | \-n <subnqn>]
[\-\-nqn=<subnqn> | \-n <subnqn>] [\-\-traddr=<traddr> | \-a <traddr>]
[\-\-traddr=<traddr> | \-a <traddr>] [\-\-trsvcid=<trsvcid> | \-s <trsvcid>]
[\-\-trsvcid=<trsvcid> | \-s <trsvcid>] [\-\-host\-traddr=<traddr> | \-w <traddr>]
[\-\-host\-traddr=<traddr> | \-w <traddr>] [\-\-host\-iface=<iface> | \-f <iface>]
[\-\-host\-iface=<iface> | \-f <iface>] [\-\-hostnqn=<hostnqn> | \-q <hostnqn>]
[\-\-hostnqn=<hostnqn> | \-q <hostnqn>] [\-\-hostid=<hostid> | \-I <hostid>]
[\-\-hostid=<hostid> | \-I <hostid>] [\-\-config\-file=<cfg> | \-J <cfg>]
[\-\-config\-file=<cfg> | \-J <cfg> ] [\-\-dhchap\-secret=<secret> | \-S <secret>]
[\-\-dhchap\-secret=<secret> | \-S <secret>] [\-\-dhchap\-ctrl\-secret=<secret> | \-C <secret>]
[\-\-dhchap\-ctrl\-secret=<secret> | \-C <secret>] [\-\-nr\-io\-queues=<#> | \-i <#>]
[\-\-nr\-io\-queues=<#> | \-i <#>] [\-\-nr\-write\-queues=<#> | \-W <#>]
[\-\-nr\-write\-queues=<#> | \-W <#>] [\-\-nr\-poll\-queues=<#> | \-P <#>]
[\-\-nr\-poll\-queues=<#> | \-P <#>] [\-\-queue\-size=<#> | \-Q <#>]
[\-\-queue\-size=<#> | \-Q <#>] [\-\-keep\-alive\-tmo=<#> | \-k <#>]
[\-\-keep\-alive\-tmo=<#> | \-k <#>] [\-\-reconnect\-delay=<#> | \-c <#>]
[\-\-reconnect\-delay=<#> | \-c <#>] [\-\-ctrl\-loss\-tmo=<#> | \-l <#>] [\-\-tos=<#> | \-T <#>]
[\-\-ctrl\-loss\-tmo=<#> | \-l <#>] [\-\-keyring=<#>] [\-\-tls_key=<#>]
[\-\-tos=<#> | \-T <#>] [\-\-duplicate\-connect | \-D] [\-\-disable\-sqflow | \-d]
[\-\-keyring=<#> ] [\-\-hdr\-digest | \-g] [\-\-data\-digest | \-G] [\-\-tls]
[\-\-tls_key=<#> ] [\-\-dump\-config | \-O] [\-\-application=<id>]
[\-\-duplicate\-connect | \-D] [\-\-output\-format=<fmt> | \-o <fmt>] [\-\-verbose | \-v]
[\-\-disable\-sqflow | \-d]
[\-\-hdr\-digest | \-g]
[\-\-data\-digest | \-G]
[\-\-tls ]
[\-\-dump\-config | \-O]
[\-\-output\-format=<fmt> | \-o <fmt>]
[\-\-application=<id> ]
.fi .fi
.SH "DESCRIPTION" .SH "DESCRIPTION"
.sp .sp
@ -154,7 +147,7 @@ to not read in an existing configuration file\&. The JSON configuration file for
\-S <secret>, \-\-dhchap\-secret=<secret> \-S <secret>, \-\-dhchap\-secret=<secret>
.RS 4 .RS 4
NVMe In\-band authentication secret; needs to be in ASCII format as specified in NVMe 2\&.0 section 8\&.13\&.5\&.8 NVMe In\-band authentication secret; needs to be in ASCII format as specified in NVMe 2\&.0 section 8\&.13\&.5\&.8
\fISecret representation\fR\&. If this option is not specified, the default is read from /usr/local/etc/nvme/hostkey\&. If that does not exist no in\-band authentication is attempted\&. \fISecret representation\fR\&.
.RE .RE
.PP .PP
\-C <secret>, \-\-dhchap\-ctrl\-secret=<secret> \-C <secret>, \-\-dhchap\-ctrl\-secret=<secret>
@ -243,18 +236,24 @@ Enable TLS encryption (TCP)\&.
Print out resulting JSON configuration file to stdout\&. Print out resulting JSON configuration file to stdout\&.
.RE .RE
.PP .PP
\-o <format>, \-\-output\-format=<format>
.RS 4
Set the reporting format to
\fInormal\fR
or
\fIjson\fR\&. Only one output format can be used at a time\&. When this option is specified, the device associated with the connection will be printed\&. Nothing is printed otherwise\&.
.RE
.PP
\-\-context <STR> \-\-context <STR>
.RS 4 .RS 4
Set the execution context to <STR>\&. This allows to coordinate the management of the global resources\&. Set the execution context to <STR>\&. This allows to coordinate the management of the global resources\&.
.RE .RE
.PP
\-o <fmt>, \-\-output\-format=<fmt>
.RS 4
Set the reporting format to
\fInormal\fR,
\fIjson\fR
or
\fIbinary\fR\&. Only one output format can be used at a time\&.
.RE
.PP
\-v, \-\-verbose
.RS 4
Increase the information detail in the output\&.
.RE
.SH "EXAMPLES" .SH "EXAMPLES"
.sp .sp
.RS 4 .RS 4

View file

@ -749,36 +749,29 @@ nvme-connect(1) Manual Page
<h2 id="_synopsis">SYNOPSIS</h2> <h2 id="_synopsis">SYNOPSIS</h2>
<div class="sectionbody"> <div class="sectionbody">
<div class="verseblock"> <div class="verseblock">
<pre class="content"><em>nvme connect</em> <pre class="content"><em>nvme connect</em> [--transport=&lt;trtype&gt; | -t &lt;trtype&gt;]
[--transport=&lt;trtype&gt; | -t &lt;trtype&gt;] [--nqn=&lt;subnqn&gt; | -n &lt;subnqn&gt;]
[--nqn=&lt;subnqn&gt; | -n &lt;subnqn&gt;] [--traddr=&lt;traddr&gt; | -a &lt;traddr&gt;]
[--traddr=&lt;traddr&gt; | -a &lt;traddr&gt;] [--trsvcid=&lt;trsvcid&gt; | -s &lt;trsvcid&gt;]
[--trsvcid=&lt;trsvcid&gt; | -s &lt;trsvcid&gt;] [--host-traddr=&lt;traddr&gt; | -w &lt;traddr&gt;]
[--host-traddr=&lt;traddr&gt; | -w &lt;traddr&gt;] [--host-iface=&lt;iface&gt; | -f &lt;iface&gt;]
[--host-iface=&lt;iface&gt; | -f &lt;iface&gt;] [--hostnqn=&lt;hostnqn&gt; | -q &lt;hostnqn&gt;]
[--hostnqn=&lt;hostnqn&gt; | -q &lt;hostnqn&gt;] [--hostid=&lt;hostid&gt; | -I &lt;hostid&gt;]
[--hostid=&lt;hostid&gt; | -I &lt;hostid&gt;] [--config-file=&lt;cfg&gt; | -J &lt;cfg&gt;]
[--config-file=&lt;cfg&gt; | -J &lt;cfg&gt; ] [--dhchap-secret=&lt;secret&gt; | -S &lt;secret&gt;]
[--dhchap-secret=&lt;secret&gt; | -S &lt;secret&gt;] [--dhchap-ctrl-secret=&lt;secret&gt; | -C &lt;secret&gt;]
[--dhchap-ctrl-secret=&lt;secret&gt; | -C &lt;secret&gt;] [--nr-io-queues=&lt;#&gt; | -i &lt;#&gt;]
[--nr-io-queues=&lt;#&gt; | -i &lt;#&gt;] [--nr-write-queues=&lt;#&gt; | -W &lt;#&gt;]
[--nr-write-queues=&lt;#&gt; | -W &lt;#&gt;] [--nr-poll-queues=&lt;#&gt; | -P &lt;#&gt;]
[--nr-poll-queues=&lt;#&gt; | -P &lt;#&gt;] [--queue-size=&lt;#&gt; | -Q &lt;#&gt;]
[--queue-size=&lt;#&gt; | -Q &lt;#&gt;] [--keep-alive-tmo=&lt;#&gt; | -k &lt;#&gt;]
[--keep-alive-tmo=&lt;#&gt; | -k &lt;#&gt;] [--reconnect-delay=&lt;#&gt; | -c &lt;#&gt;]
[--reconnect-delay=&lt;#&gt; | -c &lt;#&gt;] [--ctrl-loss-tmo=&lt;#&gt; | -l &lt;#&gt;] [--tos=&lt;#&gt; | -T &lt;#&gt;]
[--ctrl-loss-tmo=&lt;#&gt; | -l &lt;#&gt;] [--keyring=&lt;#&gt;] [--tls_key=&lt;#&gt;]
[--tos=&lt;#&gt; | -T &lt;#&gt;] [--duplicate-connect | -D] [--disable-sqflow | -d]
[--keyring=&lt;#&gt; ] [--hdr-digest | -g] [--data-digest | -G] [--tls]
[--tls_key=&lt;#&gt; ] [--dump-config | -O] [--application=&lt;id&gt;]
[--duplicate-connect | -D] [--output-format=&lt;fmt&gt; | -o &lt;fmt&gt;] [--verbose | -v]</pre>
[--disable-sqflow | -d]
[--hdr-digest | -g]
[--data-digest | -G]
[--tls ]
[--dump-config | -O]
[--output-format=&lt;fmt&gt; | -o &lt;fmt&gt;]
[--application=&lt;id&gt; ]</pre>
<div class="attribution"> <div class="attribution">
</div></div> </div></div>
</div> </div>
@ -804,7 +797,7 @@ specified by the --nqn option.</p></div>
<dd> <dd>
<p> <p>
This field specifies the network fabric being used for This field specifies the network fabric being used for
a NVMe-over-Fabrics network. Current string values include: a NVMe-over-Fabrics network. Current string values include:
</p> </p>
<div class="tableblock"> <div class="tableblock">
<table rules="all" <table rules="all"
@ -870,7 +863,7 @@ cellspacing="0" cellpadding="4">
</dt> </dt>
<dd> <dd>
<p> <p>
This field specifies the transport service id. For transports using IP This field specifies the transport service id. For transports using IP
addressing (e.g. rdma) this field is the port number. By default, the IP addressing (e.g. rdma) this field is the port number. By default, the IP
port number for the RDMA transport is 4420. port number for the RDMA transport is 4420.
</p> </p>
@ -953,9 +946,6 @@ cellspacing="0" cellpadding="4">
<p> <p>
NVMe In-band authentication secret; needs to be in ASCII format as NVMe In-band authentication secret; needs to be in ASCII format as
specified in NVMe 2.0 section 8.13.5.8 <em>Secret representation</em>. specified in NVMe 2.0 section 8.13.5.8 <em>Secret representation</em>.
If this option is not specified, the default is read from
/usr/local/etc/nvme/hostkey. If that does not exist no in-band authentication
is attempted.
</p> </p>
</dd> </dd>
<dt class="hdlist1"> <dt class="hdlist1">
@ -1144,19 +1134,6 @@ cellspacing="0" cellpadding="4">
</p> </p>
</dd> </dd>
<dt class="hdlist1"> <dt class="hdlist1">
-o &lt;format&gt;
</dt>
<dt class="hdlist1">
--output-format=&lt;format&gt;
</dt>
<dd>
<p>
Set the reporting format to <em>normal</em> or <em>json</em>. Only one output format can
be used at a time. When this option is specified, the device associated with
the connection will be printed. Nothing is printed otherwise.
</p>
</dd>
<dt class="hdlist1">
--context &lt;STR&gt; --context &lt;STR&gt;
</dt> </dt>
<dd> <dd>
@ -1165,6 +1142,29 @@ cellspacing="0" cellpadding="4">
the management of the global resources. the management of the global resources.
</p> </p>
</dd> </dd>
<dt class="hdlist1">
-o &lt;fmt&gt;
</dt>
<dt class="hdlist1">
--output-format=&lt;fmt&gt;
</dt>
<dd>
<p>
Set the reporting format to <em>normal</em>, <em>json</em> or <em>binary</em>. Only one
output format can be used at a time.
</p>
</dd>
<dt class="hdlist1">
-v
</dt>
<dt class="hdlist1">
--verbose
</dt>
<dd>
<p>
Increase the information detail in the output.
</p>
</dd>
</dl></div> </dl></div>
</div> </div>
</div> </div>
@ -1211,7 +1211,7 @@ and <a href="mailto:hch@lst.de">Christoph Hellwig</a></p></div>
<div id="footer"> <div id="footer">
<div id="footer-text"> <div id="footer-text">
Last updated Last updated
2023-09-29 08:33:07 CEST 2023-12-21 15:49:29 CET
</div> </div>
</div> </div>
</body> </body>

View file

@ -8,36 +8,29 @@ nvme-connect - Connect to a Fabrics controller.
SYNOPSIS SYNOPSIS
-------- --------
[verse] [verse]
'nvme connect' 'nvme connect' [--transport=<trtype> | -t <trtype>]
[--transport=<trtype> | -t <trtype>] [--nqn=<subnqn> | -n <subnqn>]
[--nqn=<subnqn> | -n <subnqn>] [--traddr=<traddr> | -a <traddr>]
[--traddr=<traddr> | -a <traddr>] [--trsvcid=<trsvcid> | -s <trsvcid>]
[--trsvcid=<trsvcid> | -s <trsvcid>] [--host-traddr=<traddr> | -w <traddr>]
[--host-traddr=<traddr> | -w <traddr>] [--host-iface=<iface> | -f <iface>]
[--host-iface=<iface> | -f <iface>] [--hostnqn=<hostnqn> | -q <hostnqn>]
[--hostnqn=<hostnqn> | -q <hostnqn>] [--hostid=<hostid> | -I <hostid>]
[--hostid=<hostid> | -I <hostid>] [--config-file=<cfg> | -J <cfg>]
[--config-file=<cfg> | -J <cfg> ] [--dhchap-secret=<secret> | -S <secret>]
[--dhchap-secret=<secret> | -S <secret>] [--dhchap-ctrl-secret=<secret> | -C <secret>]
[--dhchap-ctrl-secret=<secret> | -C <secret>] [--nr-io-queues=<#> | -i <#>]
[--nr-io-queues=<#> | -i <#>] [--nr-write-queues=<#> | -W <#>]
[--nr-write-queues=<#> | -W <#>] [--nr-poll-queues=<#> | -P <#>]
[--nr-poll-queues=<#> | -P <#>] [--queue-size=<#> | -Q <#>]
[--queue-size=<#> | -Q <#>] [--keep-alive-tmo=<#> | -k <#>]
[--keep-alive-tmo=<#> | -k <#>] [--reconnect-delay=<#> | -c <#>]
[--reconnect-delay=<#> | -c <#>] [--ctrl-loss-tmo=<#> | -l <#>] [--tos=<#> | -T <#>]
[--ctrl-loss-tmo=<#> | -l <#>] [--keyring=<#>] [--tls_key=<#>]
[--tos=<#> | -T <#>] [--duplicate-connect | -D] [--disable-sqflow | -d]
[--keyring=<#> ] [--hdr-digest | -g] [--data-digest | -G] [--tls]
[--tls_key=<#> ] [--dump-config | -O] [--application=<id>]
[--duplicate-connect | -D] [--output-format=<fmt> | -o <fmt>] [--verbose | -v]
[--disable-sqflow | -d]
[--hdr-digest | -g]
[--data-digest | -G]
[--tls ]
[--dump-config | -O]
[--output-format=<fmt> | -o <fmt>]
[--application=<id> ]
DESCRIPTION DESCRIPTION
----------- -----------
@ -50,7 +43,7 @@ OPTIONS
-t <trtype>:: -t <trtype>::
--transport=<trtype>:: --transport=<trtype>::
This field specifies the network fabric being used for This field specifies the network fabric being used for
a NVMe-over-Fabrics network. Current string values include: a NVMe-over-Fabrics network. Current string values include:
+ +
[] []
|================= |=================
@ -73,7 +66,7 @@ OPTIONS
-s <trsvcid>:: -s <trsvcid>::
--trsvcid=<trsvcid>:: --trsvcid=<trsvcid>::
This field specifies the transport service id. For transports using IP This field specifies the transport service id. For transports using IP
addressing (e.g. rdma) this field is the port number. By default, the IP addressing (e.g. rdma) this field is the port number. By default, the IP
port number for the RDMA transport is 4420. port number for the RDMA transport is 4420.
@ -114,9 +107,6 @@ OPTIONS
--dhchap-secret=<secret>:: --dhchap-secret=<secret>::
NVMe In-band authentication secret; needs to be in ASCII format as NVMe In-band authentication secret; needs to be in ASCII format as
specified in NVMe 2.0 section 8.13.5.8 'Secret representation'. specified in NVMe 2.0 section 8.13.5.8 'Secret representation'.
If this option is not specified, the default is read from
@SYSCONFDIR@/nvme/hostkey. If that does not exist no in-band authentication
is attempted.
-C <secret>:: -C <secret>::
--dhchap-ctrl-secret=<secret>:: --dhchap-ctrl-secret=<secret>::
@ -190,16 +180,19 @@ OPTIONS
--dump-config:: --dump-config::
Print out resulting JSON configuration file to stdout. Print out resulting JSON configuration file to stdout.
-o <format>::
--output-format=<format>::
Set the reporting format to 'normal' or 'json'. Only one output format can
be used at a time. When this option is specified, the device associated with
the connection will be printed. Nothing is printed otherwise.
--context <STR>:: --context <STR>::
Set the execution context to <STR>. This allows to coordinate Set the execution context to <STR>. This allows to coordinate
the management of the global resources. the management of the global resources.
-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 EXAMPLES
-------- --------
* Connect to a subsystem named nqn.2014-08.com.example:nvme:nvm-subsystem-sn-d78432 * Connect to a subsystem named nqn.2014-08.com.example:nvme:nvm-subsystem-sn-d78432
@ -215,7 +208,6 @@ SEE ALSO
nvme-discover(1) nvme-discover(1)
nvme-connect-all(1) nvme-connect-all(1)
AUTHORS AUTHORS
------- -------
This was co-written by mailto:james.p.freyensee@intel.com[Jay Freyensee] This was co-written by mailto:james.p.freyensee@intel.com[Jay Freyensee]

View file

@ -2,12 +2,12 @@
.\" Title: nvme-copy .\" Title: nvme-copy
.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] .\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/> .\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
.\" Date: 06/30/2023 .\" Date: 12/21/2023
.\" Manual: NVMe Manual .\" Manual: NVMe Manual
.\" Source: NVMe .\" Source: NVMe
.\" Language: English .\" Language: English
.\" .\"
.TH "NVME\-COPY" "1" "06/30/2023" "NVMe" "NVMe Manual" .TH "NVME\-COPY" "1" "12/21/2023" "NVMe" "NVMe Manual"
.\" ----------------------------------------------------------------- .\" -----------------------------------------------------------------
.\" * Define some portability stuff .\" * Define some portability stuff
.\" ----------------------------------------------------------------- .\" -----------------------------------------------------------------
@ -35,6 +35,8 @@ nvme-copy \- Send an NVMe Simple Copy command, provide results
\fInvme\-copy\fR <device> [\-\-sdlba=<sdlba> | \-d <sdlba>] \fInvme\-copy\fR <device> [\-\-sdlba=<sdlba> | \-d <sdlba>]
[\-\-blocks=<nlb\-list,> | \-b <nlb\-list,>] [\-\-blocks=<nlb\-list,> | \-b <nlb\-list,>]
[\-\-slbs=<slbas,> | \-s <slbas,>] [\-\-slbs=<slbas,> | \-s <slbas,>]
[\-\-snsids=<snsids,> | \-N <snsids,>]
[\-\-sopts=<sopts,> | \-O <sopts,>]
[\-\-limited\-retry | \-l] [\-\-limited\-retry | \-l]
[\-\-force\-unit\-access | \-f] [\-\-force\-unit\-access | \-f]
[\-\-prinfow=<prinfow> | \-p <prinfow>] [\-\-prinfow=<prinfow> | \-p <prinfow>]
@ -48,91 +50,116 @@ nvme-copy \- Send an NVMe Simple Copy command, provide results
[\-\-dir\-type=<type> | \-T <type>] [\-\-dir\-type=<type> | \-T <type>]
[\-\-dir\-spec=<spec> | \-S <spec>] [\-\-dir\-spec=<spec> | \-S <spec>]
[\-\-format=<entry\-format> | \-F <entry\-format>] [\-\-format=<entry\-format> | \-F <entry\-format>]
[\-\-output\-format=<fmt> | \-o <fmt>] [\-\-verbose | \-v]
.fi .fi
.SH "DESCRIPTION" .SH "DESCRIPTION"
.sp .sp
The Copy command is used by the host to copy data from one or more source logical block ranges to a single consecutive destination logical block range\&. The Copy command is used by the host to copy data from one or more source logical block ranges to a single consecutive destination logical block range\&.
.SH "OPTIONS" .SH "OPTIONS"
.PP .PP
\-\-sdlba=<sdlba>, \-d <sdlba> \-d <sdlba>, \-\-sdlba=<sdlba>
.RS 4 .RS 4
64\-bit addr of first destination logical block 64\-bit addr of first destination logical block
.RE .RE
.PP .PP
\-\-blocks=<nlb\-list,>, \-b <nlb\-list,> \-b <nlb\-list,>, \-\-blocks=<nlb\-list,>
.RS 4 .RS 4
Comma separated list of the number of blocks in each range Comma separated list of the number of blocks in each range
.RE .RE
.PP .PP
\-\-slbs=<slbas,>, \-s <slbas,> \-s <slbas,>, \-\-slbs=<slbas,>
.RS 4 .RS 4
Comma separated list of the starting blocks in each range Comma separated list of the starting blocks in each range
.RE .RE
.PP .PP
\-\-limited\-retry, \-l \-\-snsids=<snsids,>, \-N <snsids,>
.RS 4
Comma separated list of the source namespace identifiers in each range
.RE
.PP
\-\-sopts=<sopts,>, \-O <sopts,>
.RS 4
Comma separated list of the source options in each range
.RE
.PP
\-l, \-\-limited\-retry
.RS 4 .RS 4
Sets the limited retry flag\&. Sets the limited retry flag\&.
.RE .RE
.PP .PP
\-\-force\-unit\-access, \-f \-f, \-\-force\-unit\-access
.RS 4 .RS 4
Set the force\-unit access flag\&. Set the force\-unit access flag\&.
.RE .RE
.PP .PP
\-\-prinfow=<prinfow>, \-p <prinfow> \-p <prinfow>, \-\-prinfow=<prinfow>
.RS 4 .RS 4
Protection Information field write definition\&. Protection Information field write definition\&.
.RE .RE
.PP .PP
\-\-prinfor=<prinfor>, \-P <prinfor> \-P <prinfor>, \-\-prinfor=<prinfor>
.RS 4 .RS 4
Protection Information field read definition\&. Protection Information field read definition\&.
.RE .RE
.PP .PP
\-\-ref\-tag=<reftag>, \-r <reftag> \-r <reftag>, \-\-ref\-tag=<reftag>
.RS 4 .RS 4
initial lba reference tag\&. initial lba reference tag\&.
.RE .RE
.PP .PP
\-\-expected\-ref\-tags=<reftag,>, \-R <reftag,> \-R <reftag,>, \-\-expected\-ref\-tags=<reftag,>
.RS 4 .RS 4
expected lba reference tags (comma\-separated list)\&. expected lba reference tags (comma\-separated list)\&.
.RE .RE
.PP .PP
\-\-app\-tag=<apptag>, \-a <apptag> \-a <apptag>, \-\-app\-tag=<apptag>
.RS 4 .RS 4
lba app tag lba app tag
.RE .RE
.PP .PP
\-\-expected\-app\-tags=<apptag,>, \-A <apptag,> \-A <apptag,>, \-\-expected\-app\-tags=<apptag,>
.RS 4 .RS 4
expected lba app tags (comma\-separated list) expected lba app tags (comma\-separated list)
.RE .RE
.PP .PP
\-\-app\-mask=<appmask>, \-m <appmask> \-m <appmask>, \-\-app\-mask=<appmask>
.RS 4 .RS 4
lba tag mask lba tag mask
.RE .RE
.PP .PP
\-\-expected\-app\-masks=<appmask,>, \-M <appmask,> \-M <appmask,>, \-\-expected\-app\-masks=<appmask,>
.RS 4 .RS 4
expected lba tag masks (comma\-separated list) expected lba tag masks (comma\-separated list)
.RE .RE
.PP .PP
\-\-dir\-type=<type>, \-T <type> \-T <type>, \-\-dir\-type=<type>
.RS 4 .RS 4
Optional directive type\&. The nvme\-cli only enforces the value be in the defined range for the directive type, though the NVMe specification (1\&.3a) defines only one directive, 01h, for write stream identifiers\&. Optional directive type\&. The nvme\-cli only enforces the value be in the defined range for the directive type, though the NVMe specification (1\&.3a) defines only one directive, 01h, for write stream identifiers\&.
.RE .RE
.PP .PP
\-\-dir\-spec=<spec>, \-S <spec> \-S <spec>, \-\-dir\-spec=<spec>
.RS 4 .RS 4
Optional field for directive specifics\&. When used with write streams, this value is defined to be the write stream identifier\&. The nvme\-cli will not validate the stream requested is within the controller\(cqs capabilities\&. Optional field for directive specifics\&. When used with write streams, this value is defined to be the write stream identifier\&. The nvme\-cli will not validate the stream requested is within the controller\(cqs capabilities\&.
.RE .RE
.PP .PP
\-\-format=<entry\-format>, \-F <entry\-format> \-F <entry\-format>, \-\-format=<entry\-format>
.RS 4 .RS 4
source range entry format source range entry format
.RE .RE
.PP
\-o <fmt>, \-\-output\-format=<fmt>
.RS 4
Set the reporting format to
\fInormal\fR,
\fIjson\fR
or
\fIbinary\fR\&. Only one output format can be used at a time\&.
.RE
.PP
\-v, \-\-verbose
.RS 4
Increase the information detail in the output\&.
.RE
.SH "EXAMPLES" .SH "EXAMPLES"
.sp .sp
No examples yet\&. No examples yet\&.

View file

@ -752,6 +752,8 @@ nvme-copy(1) Manual Page
<pre class="content"><em>nvme-copy</em> &lt;device&gt; [--sdlba=&lt;sdlba&gt; | -d &lt;sdlba&gt;] <pre class="content"><em>nvme-copy</em> &lt;device&gt; [--sdlba=&lt;sdlba&gt; | -d &lt;sdlba&gt;]
[--blocks=&lt;nlb-list,&gt; | -b &lt;nlb-list,&gt;] [--blocks=&lt;nlb-list,&gt; | -b &lt;nlb-list,&gt;]
[--slbs=&lt;slbas,&gt; | -s &lt;slbas,&gt;] [--slbs=&lt;slbas,&gt; | -s &lt;slbas,&gt;]
[--snsids=&lt;snsids,&gt; | -N &lt;snsids,&gt;]
[--sopts=&lt;sopts,&gt; | -O &lt;sopts,&gt;]
[--limited-retry | -l] [--limited-retry | -l]
[--force-unit-access | -f] [--force-unit-access | -f]
[--prinfow=&lt;prinfow&gt; | -p &lt;prinfow&gt;] [--prinfow=&lt;prinfow&gt; | -p &lt;prinfow&gt;]
@ -764,7 +766,8 @@ nvme-copy(1) Manual Page
[--expected-app-masks=&lt;appmask,&gt; | -M &lt;appmask,&gt;] [--expected-app-masks=&lt;appmask,&gt; | -M &lt;appmask,&gt;]
[--dir-type=&lt;type&gt; | -T &lt;type&gt;] [--dir-type=&lt;type&gt; | -T &lt;type&gt;]
[--dir-spec=&lt;spec&gt; | -S &lt;spec&gt;] [--dir-spec=&lt;spec&gt; | -S &lt;spec&gt;]
[--format=&lt;entry-format&gt; | -F &lt;entry-format&gt;]</pre> [--format=&lt;entry-format&gt; | -F &lt;entry-format&gt;]
[--output-format=&lt;fmt&gt; | -o &lt;fmt&gt;] [--verbose | -v]</pre>
<div class="attribution"> <div class="attribution">
</div></div> </div></div>
</div> </div>
@ -781,10 +784,10 @@ logical block ranges to a single consecutive destination logical block range.</p
<div class="sectionbody"> <div class="sectionbody">
<div class="dlist"><dl> <div class="dlist"><dl>
<dt class="hdlist1"> <dt class="hdlist1">
--sdlba=&lt;sdlba&gt; -d &lt;sdlba&gt;
</dt> </dt>
<dt class="hdlist1"> <dt class="hdlist1">
-d &lt;sdlba&gt; --sdlba=&lt;sdlba&gt;
</dt> </dt>
<dd> <dd>
<p> <p>
@ -792,10 +795,10 @@ logical block ranges to a single consecutive destination logical block range.</p
</p> </p>
</dd> </dd>
<dt class="hdlist1"> <dt class="hdlist1">
--blocks=&lt;nlb-list,&gt; -b &lt;nlb-list,&gt;
</dt> </dt>
<dt class="hdlist1"> <dt class="hdlist1">
-b &lt;nlb-list,&gt; --blocks=&lt;nlb-list,&gt;
</dt> </dt>
<dd> <dd>
<p> <p>
@ -803,10 +806,10 @@ logical block ranges to a single consecutive destination logical block range.</p
</p> </p>
</dd> </dd>
<dt class="hdlist1"> <dt class="hdlist1">
--slbs=&lt;slbas,&gt; -s &lt;slbas,&gt;
</dt> </dt>
<dt class="hdlist1"> <dt class="hdlist1">
-s &lt;slbas,&gt; --slbs=&lt;slbas,&gt;
</dt> </dt>
<dd> <dd>
<p> <p>
@ -814,21 +817,43 @@ logical block ranges to a single consecutive destination logical block range.</p
</p> </p>
</dd> </dd>
<dt class="hdlist1"> <dt class="hdlist1">
--limited-retry --snsids=&lt;snsids,&gt;
</dt> </dt>
<dt class="hdlist1"> <dt class="hdlist1">
-N &lt;snsids,&gt;
</dt>
<dd>
<p>
Comma separated list of the source namespace identifiers in each range
</p>
</dd>
<dt class="hdlist1">
--sopts=&lt;sopts,&gt;
</dt>
<dt class="hdlist1">
-O &lt;sopts,&gt;
</dt>
<dd>
<p>
Comma separated list of the source options in each range
</p>
</dd>
<dt class="hdlist1">
-l -l
</dt> </dt>
<dt class="hdlist1">
--limited-retry
</dt>
<dd> <dd>
<p> <p>
Sets the limited retry flag. Sets the limited retry flag.
</p> </p>
</dd> </dd>
<dt class="hdlist1"> <dt class="hdlist1">
--force-unit-access -f
</dt> </dt>
<dt class="hdlist1"> <dt class="hdlist1">
-f --force-unit-access
</dt> </dt>
<dd> <dd>
<p> <p>
@ -836,10 +861,10 @@ logical block ranges to a single consecutive destination logical block range.</p
</p> </p>
</dd> </dd>
<dt class="hdlist1"> <dt class="hdlist1">
--prinfow=&lt;prinfow&gt; -p &lt;prinfow&gt;
</dt> </dt>
<dt class="hdlist1"> <dt class="hdlist1">
-p &lt;prinfow&gt; --prinfow=&lt;prinfow&gt;
</dt> </dt>
<dd> <dd>
<p> <p>
@ -847,10 +872,10 @@ logical block ranges to a single consecutive destination logical block range.</p
</p> </p>
</dd> </dd>
<dt class="hdlist1"> <dt class="hdlist1">
--prinfor=&lt;prinfor&gt; -P &lt;prinfor&gt;
</dt> </dt>
<dt class="hdlist1"> <dt class="hdlist1">
-P &lt;prinfor&gt; --prinfor=&lt;prinfor&gt;
</dt> </dt>
<dd> <dd>
<p> <p>
@ -858,10 +883,10 @@ logical block ranges to a single consecutive destination logical block range.</p
</p> </p>
</dd> </dd>
<dt class="hdlist1"> <dt class="hdlist1">
--ref-tag=&lt;reftag&gt; -r &lt;reftag&gt;
</dt> </dt>
<dt class="hdlist1"> <dt class="hdlist1">
-r &lt;reftag&gt; --ref-tag=&lt;reftag&gt;
</dt> </dt>
<dd> <dd>
<p> <p>
@ -869,10 +894,10 @@ logical block ranges to a single consecutive destination logical block range.</p
</p> </p>
</dd> </dd>
<dt class="hdlist1"> <dt class="hdlist1">
--expected-ref-tags=&lt;reftag,&gt; -R &lt;reftag,&gt;
</dt> </dt>
<dt class="hdlist1"> <dt class="hdlist1">
-R &lt;reftag,&gt; --expected-ref-tags=&lt;reftag,&gt;
</dt> </dt>
<dd> <dd>
<p> <p>
@ -880,10 +905,10 @@ logical block ranges to a single consecutive destination logical block range.</p
</p> </p>
</dd> </dd>
<dt class="hdlist1"> <dt class="hdlist1">
--app-tag=&lt;apptag&gt; -a &lt;apptag&gt;
</dt> </dt>
<dt class="hdlist1"> <dt class="hdlist1">
-a &lt;apptag&gt; --app-tag=&lt;apptag&gt;
</dt> </dt>
<dd> <dd>
<p> <p>
@ -891,10 +916,10 @@ logical block ranges to a single consecutive destination logical block range.</p
</p> </p>
</dd> </dd>
<dt class="hdlist1"> <dt class="hdlist1">
--expected-app-tags=&lt;apptag,&gt; -A &lt;apptag,&gt;
</dt> </dt>
<dt class="hdlist1"> <dt class="hdlist1">
-A &lt;apptag,&gt; --expected-app-tags=&lt;apptag,&gt;
</dt> </dt>
<dd> <dd>
<p> <p>
@ -902,10 +927,10 @@ logical block ranges to a single consecutive destination logical block range.</p
</p> </p>
</dd> </dd>
<dt class="hdlist1"> <dt class="hdlist1">
--app-mask=&lt;appmask&gt; -m &lt;appmask&gt;
</dt> </dt>
<dt class="hdlist1"> <dt class="hdlist1">
-m &lt;appmask&gt; --app-mask=&lt;appmask&gt;
</dt> </dt>
<dd> <dd>
<p> <p>
@ -913,10 +938,10 @@ logical block ranges to a single consecutive destination logical block range.</p
</p> </p>
</dd> </dd>
<dt class="hdlist1"> <dt class="hdlist1">
--expected-app-masks=&lt;appmask,&gt; -M &lt;appmask,&gt;
</dt> </dt>
<dt class="hdlist1"> <dt class="hdlist1">
-M &lt;appmask,&gt; --expected-app-masks=&lt;appmask,&gt;
</dt> </dt>
<dd> <dd>
<p> <p>
@ -924,10 +949,10 @@ logical block ranges to a single consecutive destination logical block range.</p
</p> </p>
</dd> </dd>
<dt class="hdlist1"> <dt class="hdlist1">
--dir-type=&lt;type&gt; -T &lt;type&gt;
</dt> </dt>
<dt class="hdlist1"> <dt class="hdlist1">
-T &lt;type&gt; --dir-type=&lt;type&gt;
</dt> </dt>
<dd> <dd>
<p> <p>
@ -938,10 +963,10 @@ logical block ranges to a single consecutive destination logical block range.</p
</p> </p>
</dd> </dd>
<dt class="hdlist1"> <dt class="hdlist1">
--dir-spec=&lt;spec&gt; -S &lt;spec&gt;
</dt> </dt>
<dt class="hdlist1"> <dt class="hdlist1">
-S &lt;spec&gt; --dir-spec=&lt;spec&gt;
</dt> </dt>
<dd> <dd>
<p> <p>
@ -952,16 +977,39 @@ logical block ranges to a single consecutive destination logical block range.</p
</p> </p>
</dd> </dd>
<dt class="hdlist1"> <dt class="hdlist1">
--format=&lt;entry-format&gt; -F &lt;entry-format&gt;
</dt> </dt>
<dt class="hdlist1"> <dt class="hdlist1">
-F &lt;entry-format&gt; --format=&lt;entry-format&gt;
</dt> </dt>
<dd> <dd>
<p> <p>
source range entry format source range entry format
</p> </p>
</dd> </dd>
<dt class="hdlist1">
-o &lt;fmt&gt;
</dt>
<dt class="hdlist1">
--output-format=&lt;fmt&gt;
</dt>
<dd>
<p>
Set the reporting format to <em>normal</em>, <em>json</em> or <em>binary</em>. Only one
output format can be used at a time.
</p>
</dd>
<dt class="hdlist1">
-v
</dt>
<dt class="hdlist1">
--verbose
</dt>
<dd>
<p>
Increase the information detail in the output.
</p>
</dd>
</dl></div> </dl></div>
</div> </div>
</div> </div>
@ -982,7 +1030,7 @@ logical block ranges to a single consecutive destination logical block range.</p
<div id="footer"> <div id="footer">
<div id="footer-text"> <div id="footer-text">
Last updated Last updated
2023-09-29 08:33:07 CEST 2023-12-21 15:49:29 CET
</div> </div>
</div> </div>
</body> </body>

View file

@ -11,6 +11,8 @@ SYNOPSIS
'nvme-copy' <device> [--sdlba=<sdlba> | -d <sdlba>] 'nvme-copy' <device> [--sdlba=<sdlba> | -d <sdlba>]
[--blocks=<nlb-list,> | -b <nlb-list,>] [--blocks=<nlb-list,> | -b <nlb-list,>]
[--slbs=<slbas,> | -s <slbas,>] [--slbs=<slbas,> | -s <slbas,>]
[--snsids=<snsids,> | -N <snsids,>]
[--sopts=<sopts,> | -O <sopts,>]
[--limited-retry | -l] [--limited-retry | -l]
[--force-unit-access | -f] [--force-unit-access | -f]
[--prinfow=<prinfow> | -p <prinfow>] [--prinfow=<prinfow> | -p <prinfow>]
@ -24,6 +26,7 @@ SYNOPSIS
[--dir-type=<type> | -T <type>] [--dir-type=<type> | -T <type>]
[--dir-spec=<spec> | -S <spec>] [--dir-spec=<spec> | -S <spec>]
[--format=<entry-format> | -F <entry-format>] [--format=<entry-format> | -F <entry-format>]
[--output-format=<fmt> | -o <fmt>] [--verbose | -v]
DESCRIPTION DESCRIPTION
----------- -----------
@ -32,76 +35,93 @@ logical block ranges to a single consecutive destination logical block range.
OPTIONS OPTIONS
------- -------
--sdlba=<sdlba>::
-d <sdlba>:: -d <sdlba>::
--sdlba=<sdlba>::
64-bit addr of first destination logical block 64-bit addr of first destination logical block
--blocks=<nlb-list,>::
-b <nlb-list,>:: -b <nlb-list,>::
--blocks=<nlb-list,>::
Comma separated list of the number of blocks in each range Comma separated list of the number of blocks in each range
--slbs=<slbas,>::
-s <slbas,>:: -s <slbas,>::
--slbs=<slbas,>::
Comma separated list of the starting blocks in each range Comma separated list of the starting blocks in each range
--limited-retry:: --snsids=<snsids,>::
-N <snsids,>::
Comma separated list of the source namespace identifiers in each range
--sopts=<sopts,>::
-O <sopts,>::
Comma separated list of the source options in each range
-l:: -l::
--limited-retry::
Sets the limited retry flag. Sets the limited retry flag.
--force-unit-access::
-f:: -f::
--force-unit-access::
Set the force-unit access flag. Set the force-unit access flag.
--prinfow=<prinfow>::
-p <prinfow>:: -p <prinfow>::
--prinfow=<prinfow>::
Protection Information field write definition. Protection Information field write definition.
--prinfor=<prinfor>::
-P <prinfor>:: -P <prinfor>::
--prinfor=<prinfor>::
Protection Information field read definition. Protection Information field read definition.
--ref-tag=<reftag>::
-r <reftag>:: -r <reftag>::
--ref-tag=<reftag>::
initial lba reference tag. initial lba reference tag.
--expected-ref-tags=<reftag,>::
-R <reftag,>:: -R <reftag,>::
--expected-ref-tags=<reftag,>::
expected lba reference tags (comma-separated list). expected lba reference tags (comma-separated list).
--app-tag=<apptag>::
-a <apptag>:: -a <apptag>::
--app-tag=<apptag>::
lba app tag lba app tag
--expected-app-tags=<apptag,>::
-A <apptag,>:: -A <apptag,>::
--expected-app-tags=<apptag,>::
expected lba app tags (comma-separated list) expected lba app tags (comma-separated list)
--app-mask=<appmask>::
-m <appmask>:: -m <appmask>::
--app-mask=<appmask>::
lba tag mask lba tag mask
--expected-app-masks=<appmask,>::
-M <appmask,>:: -M <appmask,>::
--expected-app-masks=<appmask,>::
expected lba tag masks (comma-separated list) expected lba tag masks (comma-separated list)
--dir-type=<type>::
-T <type>:: -T <type>::
--dir-type=<type>::
Optional directive type. The nvme-cli only enforces the value Optional directive type. The nvme-cli only enforces the value
be in the defined range for the directive type, though the NVMe be in the defined range for the directive type, though the NVMe
specification (1.3a) defines only one directive, 01h, for write specification (1.3a) defines only one directive, 01h, for write
stream identifiers. stream identifiers.
--dir-spec=<spec>::
-S <spec>:: -S <spec>::
--dir-spec=<spec>::
Optional field for directive specifics. When used with Optional field for directive specifics. When used with
write streams, this value is defined to be the write stream write streams, this value is defined to be the write stream
identifier. The nvme-cli will not validate the stream requested identifier. The nvme-cli will not validate the stream requested
is within the controller's capabilities. is within the controller's capabilities.
--format=<entry-format>::
-F <entry-format>:: -F <entry-format>::
--format=<entry-format>::
source range entry format source range entry format
-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 EXAMPLES
-------- --------
No examples yet. No examples yet.

View file

@ -2,12 +2,12 @@
.\" Title: nvme-create-ns .\" Title: nvme-create-ns
.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] .\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/> .\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
.\" Date: 06/30/2023 .\" Date: 12/21/2023
.\" Manual: NVMe Manual .\" Manual: NVMe Manual
.\" Source: NVMe .\" Source: NVMe
.\" Language: English .\" Language: English
.\" .\"
.TH "NVME\-CREATE\-NS" "1" "06/30/2023" "NVMe" "NVMe Manual" .TH "NVME\-CREATE\-NS" "1" "12/21/2023" "NVMe" "NVMe Manual"
.\" ----------------------------------------------------------------- .\" -----------------------------------------------------------------
.\" * Define some portability stuff .\" * Define some portability stuff
.\" ----------------------------------------------------------------- .\" -----------------------------------------------------------------
@ -39,6 +39,7 @@ nvme-create-ns \- Send NVMe Namespace management command to create namespace, re
[\-\-nmic=<nmic> | \-m <nmic>] [\-\-nmic=<nmic> | \-m <nmic>]
[\-\-anagrp\-id=<anagrpid> | \-a <anagrpid>] [\-\-anagrp\-id=<anagrpid> | \-a <anagrpid>]
[\-\-nvmset\-id=<nvmsetid> | \-i <nvmsetid>] [\-\-nvmset\-id=<nvmsetid> | \-i <nvmsetid>]
[\-\-endg\-id=<endgid> | \-e <endgid>]
[\-\-csi=<command_set_identifier> | \-y <command_set_identifier>] [\-\-csi=<command_set_identifier> | \-y <command_set_identifier>]
[\-\-lbstm=<lbstm> | \-l <lbstm>] [\-\-lbstm=<lbstm> | \-l <lbstm>]
[\-\-nphndls=<nphndls> | \-n <nphndls>] [\-\-nphndls=<nphndls> | \-n <nphndls>]
@ -48,9 +49,10 @@ nvme-create-ns \- Send NVMe Namespace management command to create namespace, re
[\-\-ncap\-si=<ncap\-si> | \-C <ncap\-si>] [\-\-ncap\-si=<ncap\-si> | \-C <ncap\-si>]
[\-\-azr | \-z] [\-\-azr | \-z]
[\-\-rar=<rar> | \-r <rar>] [\-\-rar=<rar> | \-r <rar>]
[\-\-ror=<ror> | \-o <ror>] [\-\-ror=<ror> | \-O <ror>]
[\-\-rnumzrwa=<rnumzrwa> | \-u <rnumzrwa>] [\-\-rnumzrwa=<rnumzrwa> | \-u <rnumzrwa>]
[\-\-phndls=<placement\-handle\-list,> | \-p <placement\-handle\-list,>] [\-\-phndls=<placement\-handle\-list,> | \-p <placement\-handle\-list,>]
[\-\-output\-format=<fmt> | \-o <fmt>] [\-\-verbose | \-v]
.fi .fi
.SH "DESCRIPTION" .SH "DESCRIPTION"
.sp .sp
@ -94,6 +96,11 @@ ANA Group Identifier\&. If this value is 0h specifies that the controller determ
This field specifies the identifier of the NVM Set\&. This field specifies the identifier of the NVM Set\&.
.RE .RE
.PP .PP
\-e <endgid>, \-\-endg\-id=<endgid>
.RS 4
This field specifies the identifier of the endurance group\&.
.RE
.PP
\-y <command_set_identifier>, \-\-csi=<command_set_identifier> \-y <command_set_identifier>, \-\-csi=<command_set_identifier>
.RS 4 .RS 4
This field specifies the identifier of command set\&. if not issued, NVM Command Set will be selected\&. This field specifies the identifier of command set\&. if not issued, NVM Command Set will be selected\&.
@ -134,7 +141,7 @@ Allocate ZRWA Resources\&. If set to 1, then the namespace is to be created with
Requested Active Resources\&. This field specifies the number of active resources to be allocated to the created namespace\&. Requested Active Resources\&. This field specifies the number of active resources to be allocated to the created namespace\&.
.RE .RE
.PP .PP
\-o <ror>, \-\-ror=<ror> \-O <ror>, \-\-ror=<ror>
.RS 4 .RS 4
Requested Open Resources\&. This field specifies the number of open resources to be allocated to the created namespace\&. Requested Open Resources\&. This field specifies the number of open resources to be allocated to the created namespace\&.
.RE .RE
@ -148,6 +155,20 @@ Requested Number of ZRWA Resources\&. This field specifies the number of ZRWA re
.RS 4 .RS 4
The comma separated list of Reclaim Unit Handle Identifier to be associated with each Placement Handle\&. The comma separated list of Reclaim Unit Handle Identifier to be associated with each Placement Handle\&.
.RE .RE
.PP
\-o <fmt>, \-\-output\-format=<fmt>
.RS 4
Set the reporting format to
\fInormal\fR,
\fIjson\fR
or
\fIbinary\fR\&. Only one output format can be used at a time\&.
.RE
.PP
\-v, \-\-verbose
.RS 4
Increase the information detail in the output\&.
.RE
.SH "EXAMPLES" .SH "EXAMPLES"
.sp .sp
.RS 4 .RS 4

View file

@ -766,9 +766,10 @@ nvme-create-ns(1) Manual Page
[--ncap-si=&lt;ncap-si&gt; | -C &lt;ncap-si&gt;] [--ncap-si=&lt;ncap-si&gt; | -C &lt;ncap-si&gt;]
[--azr | -z] [--azr | -z]
[--rar=&lt;rar&gt; | -r &lt;rar&gt;] [--rar=&lt;rar&gt; | -r &lt;rar&gt;]
[--ror=&lt;ror&gt; | -o &lt;ror&gt;] [--ror=&lt;ror&gt; | -O &lt;ror&gt;]
[--rnumzrwa=&lt;rnumzrwa&gt; | -u &lt;rnumzrwa&gt;] [--rnumzrwa=&lt;rnumzrwa&gt; | -u &lt;rnumzrwa&gt;]
[--phndls=&lt;placement-handle-list,&gt; | -p &lt;placement-handle-list,&gt;]</pre> [--phndls=&lt;placement-handle-list,&gt; | -p &lt;placement-handle-list,&gt;]
[--output-format=&lt;fmt&gt; | -o &lt;fmt&gt;] [--verbose | -v]</pre>
<div class="attribution"> <div class="attribution">
</div></div> </div></div>
</div> </div>
@ -922,8 +923,8 @@ device (ex: /dev/nvme0), or a namespace block device (ex: /dev/nvme0n1).</p></di
<dd> <dd>
<p> <p>
Target block size the new namespace should be formatted as. Potential FLBAS Target block size the new namespace should be formatted as. Potential FLBAS
values will be values will be scanned and the lowest numbered will be values will be values will be scanned and the lowest numbered will be
selected for the create-ns operation. Conflicts with --flbas argument. selected for the create-ns operation. Conflicts with --flbas argument.
</p> </p>
</dd> </dd>
<dt class="hdlist1"> <dt class="hdlist1">
@ -979,7 +980,7 @@ device (ex: /dev/nvme0), or a namespace block device (ex: /dev/nvme0n1).</p></di
</p> </p>
</dd> </dd>
<dt class="hdlist1"> <dt class="hdlist1">
-o &lt;ror&gt; -O &lt;ror&gt;
</dt> </dt>
<dt class="hdlist1"> <dt class="hdlist1">
--ror=&lt;ror&gt; --ror=&lt;ror&gt;
@ -1014,6 +1015,29 @@ device (ex: /dev/nvme0), or a namespace block device (ex: /dev/nvme0n1).</p></di
with each Placement Handle. with each Placement Handle.
</p> </p>
</dd> </dd>
<dt class="hdlist1">
-o &lt;fmt&gt;
</dt>
<dt class="hdlist1">
--output-format=&lt;fmt&gt;
</dt>
<dd>
<p>
Set the reporting format to <em>normal</em>, <em>json</em> or <em>binary</em>. Only one
output format can be used at a time.
</p>
</dd>
<dt class="hdlist1">
-v
</dt>
<dt class="hdlist1">
--verbose
</dt>
<dd>
<p>
Increase the information detail in the output.
</p>
</dd>
</dl></div> </dl></div>
</div> </div>
</div> </div>
@ -1045,7 +1069,7 @@ Create a namespace:
<div id="footer"> <div id="footer">
<div id="footer-text"> <div id="footer-text">
Last updated Last updated
2023-09-29 08:33:07 CEST 2023-12-21 15:49:29 CET
</div> </div>
</div> </div>
</body> </body>

View file

@ -25,9 +25,10 @@ SYNOPSIS
[--ncap-si=<ncap-si> | -C <ncap-si>] [--ncap-si=<ncap-si> | -C <ncap-si>]
[--azr | -z] [--azr | -z]
[--rar=<rar> | -r <rar>] [--rar=<rar> | -r <rar>]
[--ror=<ror> | -o <ror>] [--ror=<ror> | -O <ror>]
[--rnumzrwa=<rnumzrwa> | -u <rnumzrwa>] [--rnumzrwa=<rnumzrwa> | -u <rnumzrwa>]
[--phndls=<placement-handle-list,> | -p <placement-handle-list,>] [--phndls=<placement-handle-list,> | -p <placement-handle-list,>]
[--output-format=<fmt> | -o <fmt>] [--verbose | -v]
DESCRIPTION DESCRIPTION
----------- -----------
@ -92,8 +93,8 @@ OPTIONS
-b:: -b::
--block-size:: --block-size::
Target block size the new namespace should be formatted as. Potential FLBAS Target block size the new namespace should be formatted as. Potential FLBAS
values will be values will be scanned and the lowest numbered will be values will be values will be scanned and the lowest numbered will be
selected for the create-ns operation. Conflicts with --flbas argument. selected for the create-ns operation. Conflicts with --flbas argument.
-S:: -S::
--nsze-si:: --nsze-si::
@ -119,7 +120,7 @@ OPTIONS
Requested Active Resources. This field specifies the number of active Requested Active Resources. This field specifies the number of active
resources to be allocated to the created namespace. resources to be allocated to the created namespace.
-o <ror>:: -O <ror>::
--ror=<ror>:: --ror=<ror>::
Requested Open Resources. This field specifies the number of open resources Requested Open Resources. This field specifies the number of open resources
to be allocated to the created namespace. to be allocated to the created namespace.
@ -134,6 +135,15 @@ OPTIONS
The comma separated list of Reclaim Unit Handle Identifier to be associated The comma separated list of Reclaim Unit Handle Identifier to be associated
with each Placement Handle. with each Placement Handle.
-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 EXAMPLES
-------- --------
* Create a namespace: * Create a namespace:

View file

@ -2,12 +2,12 @@
.\" Title: nvme-id-ns .\" Title: nvme-id-ns
.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] .\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/> .\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
.\" Date: 06/30/2023 .\" Date: 12/21/2023
.\" Manual: NVMe Manual .\" Manual: NVMe Manual
.\" Source: NVMe .\" Source: NVMe
.\" Language: English .\" Language: English
.\" .\"
.TH "NVME\-ID\-NS" "1" "06/30/2023" "NVMe" "NVMe Manual" .TH "NVME\-ID\-NS" "1" "12/21/2023" "NVMe" "NVMe Manual"
.\" ----------------------------------------------------------------- .\" -----------------------------------------------------------------
.\" * Define some portability stuff .\" * Define some portability stuff
.\" ----------------------------------------------------------------- .\" -----------------------------------------------------------------
@ -33,6 +33,7 @@ nvme-delete-ns \- Send NVMe Namespace Management delete namespace command, retur
.sp .sp
.nf .nf
\fInvme delete\-ns\fR <device> [\-\-namespace\-id=<nsid> | \-n <nsid>] \fInvme delete\-ns\fR <device> [\-\-namespace\-id=<nsid> | \-n <nsid>]
[\-\-output\-format=<fmt> | \-o <fmt>] [\-\-verbose | \-v]
.fi .fi
.SH "DESCRIPTION" .SH "DESCRIPTION"
.sp .sp
@ -45,6 +46,20 @@ The <device> parameter is mandatory and may be either the NVMe character device
.RS 4 .RS 4
The namespace identifier to delete\&. The namespace identifier to delete\&.
.RE .RE
.PP
\-o <fmt>, \-\-output\-format=<fmt>
.RS 4
Set the reporting format to
\fInormal\fR,
\fIjson\fR
or
\fIbinary\fR\&. Only one output format can be used at a time\&.
.RE
.PP
\-v, \-\-verbose
.RS 4
Increase the information detail in the output\&.
.RE
.SH "EXAMPLES" .SH "EXAMPLES"
.sp .sp
No examples yet\&. No examples yet\&.

View file

@ -749,7 +749,8 @@ nvme-id-ns(1) Manual Page
<h2 id="_synopsis">SYNOPSIS</h2> <h2 id="_synopsis">SYNOPSIS</h2>
<div class="sectionbody"> <div class="sectionbody">
<div class="verseblock"> <div class="verseblock">
<pre class="content"><em>nvme delete-ns</em> &lt;device&gt; [--namespace-id=&lt;nsid&gt; | -n &lt;nsid&gt;]</pre> <pre class="content"><em>nvme delete-ns</em> &lt;device&gt; [--namespace-id=&lt;nsid&gt; | -n &lt;nsid&gt;]
[--output-format=&lt;fmt&gt; | -o &lt;fmt&gt;] [--verbose | -v]</pre>
<div class="attribution"> <div class="attribution">
</div></div> </div></div>
</div> </div>
@ -779,6 +780,29 @@ The <code>'--namespace-id'</code> option is mandatory.</p></div>
The namespace identifier to delete. The namespace identifier to delete.
</p> </p>
</dd> </dd>
<dt class="hdlist1">
-o &lt;fmt&gt;
</dt>
<dt class="hdlist1">
--output-format=&lt;fmt&gt;
</dt>
<dd>
<p>
Set the reporting format to <em>normal</em>, <em>json</em> or <em>binary</em>. Only one
output format can be used at a time.
</p>
</dd>
<dt class="hdlist1">
-v
</dt>
<dt class="hdlist1">
--verbose
</dt>
<dd>
<p>
Increase the information detail in the output.
</p>
</dd>
</dl></div> </dl></div>
</div> </div>
</div> </div>
@ -799,7 +823,7 @@ The <code>'--namespace-id'</code> option is mandatory.</p></div>
<div id="footer"> <div id="footer">
<div id="footer-text"> <div id="footer-text">
Last updated Last updated
2023-09-29 08:33:07 CEST 2023-12-21 15:49:29 CET
</div> </div>
</div> </div>
</body> </body>

View file

@ -9,6 +9,7 @@ SYNOPSIS
-------- --------
[verse] [verse]
'nvme delete-ns' <device> [--namespace-id=<nsid> | -n <nsid>] 'nvme delete-ns' <device> [--namespace-id=<nsid> | -n <nsid>]
[--output-format=<fmt> | -o <fmt>] [--verbose | -v]
DESCRIPTION DESCRIPTION
----------- -----------
@ -25,6 +26,15 @@ OPTIONS
--namespace-id=<nsid>:: --namespace-id=<nsid>::
The namespace identifier to delete. The namespace identifier to delete.
-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 EXAMPLES
-------- --------
No examples yet. No examples yet.

View file

@ -2,12 +2,12 @@
.\" Title: nvme-dera-stat .\" Title: nvme-dera-stat
.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] .\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/> .\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
.\" Date: 06/30/2023 .\" Date: 12/21/2023
.\" Manual: NVMe Manual .\" Manual: NVMe Manual
.\" Source: NVMe .\" Source: NVMe
.\" Language: English .\" Language: English
.\" .\"
.TH "NVME\-DERA\-STAT" "1" "06/30/2023" "NVMe" "NVMe Manual" .TH "NVME\-DERA\-STAT" "1" "12/21/2023" "NVMe" "NVMe Manual"
.\" ----------------------------------------------------------------- .\" -----------------------------------------------------------------
.\" * Define some portability stuff .\" * Define some portability stuff
.\" ----------------------------------------------------------------- .\" -----------------------------------------------------------------

View file

@ -797,7 +797,7 @@ Print the Dera Device status and Additional SMART log page in a human readable f
<div id="footer"> <div id="footer">
<div id="footer-text"> <div id="footer-text">
Last updated Last updated
2023-09-29 08:33:07 CEST 2023-12-21 15:49:29 CET
</div> </div>
</div> </div>
</body> </body>

View file

@ -24,7 +24,6 @@ OPTIONS
------- -------
none none
EXAMPLES EXAMPLES
-------- --------
* Print the Dera Device status and Additional SMART log page in a human readable format: * Print the Dera Device status and Additional SMART log page in a human readable format:

View file

@ -2,12 +2,12 @@
.\" Title: nvme-detach-ns .\" Title: nvme-detach-ns
.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] .\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/> .\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
.\" Date: 06/30/2023 .\" Date: 12/21/2023
.\" Manual: NVMe Manual .\" Manual: NVMe Manual
.\" Source: NVMe .\" Source: NVMe
.\" Language: English .\" Language: English
.\" .\"
.TH "NVME\-DETACH\-NS" "1" "06/30/2023" "NVMe" "NVMe Manual" .TH "NVME\-DETACH\-NS" "1" "12/21/2023" "NVMe" "NVMe Manual"
.\" ----------------------------------------------------------------- .\" -----------------------------------------------------------------
.\" * Define some portability stuff .\" * Define some portability stuff
.\" ----------------------------------------------------------------- .\" -----------------------------------------------------------------
@ -34,6 +34,7 @@ nvme-detach-ns \- Send NVMe detach namespace, return result\&.
.nf .nf
\fInvme detach\-ns\fR <device> [\-\-namespace\-id=<nsid> | \-n <nsid>] \fInvme detach\-ns\fR <device> [\-\-namespace\-id=<nsid> | \-n <nsid>]
[\-\-controllers=<ctrl\-list,> | \-c <ctrl\-list,> [\-\-controllers=<ctrl\-list,> | \-c <ctrl\-list,>
[\-\-output\-format=<fmt> | \-o <fmt>] [\-\-verbose | \-v]
.fi .fi
.SH "DESCRIPTION" .SH "DESCRIPTION"
.sp .sp
@ -45,10 +46,24 @@ For the NVMe device given, sends the nvme namespace detach command for the provi
The namespace identifier to detach\&. The namespace identifier to detach\&.
.RE .RE
.PP .PP
\-c <ctrl\-list,>, \-controllers=<ctrl\-list,> \-c <ctrl\-list,>, \-\-controllers=<ctrl\-list,>
.RS 4 .RS 4
The comma separated list of controller identifiers to detach the namespace from\&. The comma separated list of controller identifiers to detach the namespace from\&.
.RE .RE
.PP
\-o <fmt>, \-\-output\-format=<fmt>
.RS 4
Set the reporting format to
\fInormal\fR,
\fIjson\fR
or
\fIbinary\fR\&. Only one output format can be used at a time\&.
.RE
.PP
\-v, \-\-verbose
.RS 4
Increase the information detail in the output\&.
.RE
.SH "EXAMPLES" .SH "EXAMPLES"
.sp .sp
No examples yet\&. No examples yet\&.

View file

@ -750,7 +750,8 @@ nvme-detach-ns(1) Manual Page
<div class="sectionbody"> <div class="sectionbody">
<div class="verseblock"> <div class="verseblock">
<pre class="content"><em>nvme detach-ns</em> &lt;device&gt; [--namespace-id=&lt;nsid&gt; | -n &lt;nsid&gt;] <pre class="content"><em>nvme detach-ns</em> &lt;device&gt; [--namespace-id=&lt;nsid&gt; | -n &lt;nsid&gt;]
[--controllers=&lt;ctrl-list,&gt; | -c &lt;ctrl-list,&gt;</pre> [--controllers=&lt;ctrl-list,&gt; | -c &lt;ctrl-list,&gt;
[--output-format=&lt;fmt&gt; | -o &lt;fmt&gt;] [--verbose | -v]</pre>
<div class="attribution"> <div class="attribution">
</div></div> </div></div>
</div> </div>
@ -782,7 +783,7 @@ controller identifiers.</p></div>
-c &lt;ctrl-list,&gt; -c &lt;ctrl-list,&gt;
</dt> </dt>
<dt class="hdlist1"> <dt class="hdlist1">
-controllers=&lt;ctrl-list,&gt; --controllers=&lt;ctrl-list,&gt;
</dt> </dt>
<dd> <dd>
<p> <p>
@ -790,6 +791,29 @@ controller identifiers.</p></div>
the namespace from. the namespace from.
</p> </p>
</dd> </dd>
<dt class="hdlist1">
-o &lt;fmt&gt;
</dt>
<dt class="hdlist1">
--output-format=&lt;fmt&gt;
</dt>
<dd>
<p>
Set the reporting format to <em>normal</em>, <em>json</em> or <em>binary</em>. Only one
output format can be used at a time.
</p>
</dd>
<dt class="hdlist1">
-v
</dt>
<dt class="hdlist1">
--verbose
</dt>
<dd>
<p>
Increase the information detail in the output.
</p>
</dd>
</dl></div> </dl></div>
</div> </div>
</div> </div>
@ -810,7 +834,7 @@ controller identifiers.</p></div>
<div id="footer"> <div id="footer">
<div id="footer-text"> <div id="footer-text">
Last updated Last updated
2023-09-29 08:33:07 CEST 2023-12-21 15:49:29 CET
</div> </div>
</div> </div>
</body> </body>

View file

@ -10,6 +10,7 @@ SYNOPSIS
[verse] [verse]
'nvme detach-ns' <device> [--namespace-id=<nsid> | -n <nsid>] 'nvme detach-ns' <device> [--namespace-id=<nsid> | -n <nsid>]
[--controllers=<ctrl-list,> | -c <ctrl-list,> [--controllers=<ctrl-list,> | -c <ctrl-list,>
[--output-format=<fmt> | -o <fmt>] [--verbose | -v]
DESCRIPTION DESCRIPTION
----------- -----------
@ -24,10 +25,19 @@ OPTIONS
The namespace identifier to detach. The namespace identifier to detach.
-c <ctrl-list,>:: -c <ctrl-list,>::
-controllers=<ctrl-list,>:: --controllers=<ctrl-list,>::
The comma separated list of controller identifiers to detach The comma separated list of controller identifiers to detach
the namespace from. the namespace from.
-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 EXAMPLES
-------- --------
No examples yet. No examples yet.

View file

@ -2,12 +2,12 @@
.\" Title: nvme-device-self-test .\" Title: nvme-device-self-test
.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] .\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/> .\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
.\" Date: 06/30/2023 .\" Date: 12/21/2023
.\" Manual: NVMe Manual .\" Manual: NVMe Manual
.\" Source: NVMe .\" Source: NVMe
.\" Language: English .\" Language: English
.\" .\"
.TH "NVME\-DEVICE\-SELF\-" "1" "06/30/2023" "NVMe" "NVMe Manual" .TH "NVME\-DEVICE\-SELF\-" "1" "12/21/2023" "NVMe" "NVMe Manual"
.\" ----------------------------------------------------------------- .\" -----------------------------------------------------------------
.\" * Define some portability stuff .\" * Define some portability stuff
.\" ----------------------------------------------------------------- .\" -----------------------------------------------------------------
@ -33,7 +33,8 @@ nvme-device-self-test \- Perform the necessary tests to observe the performance
.sp .sp
.nf .nf
\fInvme device\-self\-test\fR <device> [\-\-namespace\-id=<NUM> | \-n <NUM>] \fInvme device\-self\-test\fR <device> [\-\-namespace\-id=<NUM> | \-n <NUM>]
[\-\-self\-test\-code=<NUM> | \-s <NUM>] [\-\-wait | \-w] [\-\-self\-test\-code=<NUM> | \-s <NUM>] [\-\-wait | \-w]
[\-\-output\-format=<fmt> | \-o <fmt>] [\-\-verbose | \-v]
.fi .fi
.SH "DESCRIPTION" .SH "DESCRIPTION"
.sp .sp
@ -58,6 +59,20 @@ This field specifies the action taken by the device self\-test command : 0h: Sho
.RS 4 .RS 4
Wait for the device self test to complete before exiting The device self\-test is aborted by SIGINT signal interrupt for the wait The option is ignored if the abort self\-test code option specified\&. Wait for the device self test to complete before exiting The device self\-test is aborted by SIGINT signal interrupt for the wait The option is ignored if the abort self\-test code option specified\&.
.RE .RE
.PP
\-o <fmt>, \-\-output\-format=<fmt>
.RS 4
Set the reporting format to
\fInormal\fR,
\fIjson\fR
or
\fIbinary\fR\&. Only one output format can be used at a time\&.
.RE
.PP
\-v, \-\-verbose
.RS 4
Increase the information detail in the output\&.
.RE
.SH "EXAMPLES" .SH "EXAMPLES"
.sp .sp
.RS 4 .RS 4

View file

@ -750,7 +750,8 @@ nvme-device-self-test(1) Manual Page
<div class="sectionbody"> <div class="sectionbody">
<div class="verseblock"> <div class="verseblock">
<pre class="content"><em>nvme device-self-test</em> &lt;device&gt; [--namespace-id=&lt;NUM&gt; | -n &lt;NUM&gt;] <pre class="content"><em>nvme device-self-test</em> &lt;device&gt; [--namespace-id=&lt;NUM&gt; | -n &lt;NUM&gt;]
[--self-test-code=&lt;NUM&gt; | -s &lt;NUM&gt;] [--wait | -w]</pre> [--self-test-code=&lt;NUM&gt; | -s &lt;NUM&gt;] [--wait | -w]
[--output-format=&lt;fmt&gt; | -o &lt;fmt&gt;] [--verbose | -v]</pre>
<div class="attribution"> <div class="attribution">
</div></div> </div></div>
</div> </div>
@ -809,6 +810,29 @@ device (ex: /dev/nvme0), or a namespace block device (ex: /dev/nvme0n1).</p></di
The option is ignored if the abort self-test code option specified. The option is ignored if the abort self-test code option specified.
</p> </p>
</dd> </dd>
<dt class="hdlist1">
-o &lt;fmt&gt;
</dt>
<dt class="hdlist1">
--output-format=&lt;fmt&gt;
</dt>
<dd>
<p>
Set the reporting format to <em>normal</em>, <em>json</em> or <em>binary</em>. Only one
output format can be used at a time.
</p>
</dd>
<dt class="hdlist1">
-v
</dt>
<dt class="hdlist1">
--verbose
</dt>
<dd>
<p>
Increase the information detail in the output.
</p>
</dd>
</dl></div> </dl></div>
</div> </div>
</div> </div>
@ -848,7 +872,7 @@ Abort the device self-test operation in the namespace-id 1:
<div id="footer"> <div id="footer">
<div id="footer-text"> <div id="footer-text">
Last updated Last updated
2023-09-29 08:33:07 CEST 2023-12-21 15:49:29 CET
</div> </div>
</div> </div>
</body> </body>

View file

@ -9,7 +9,8 @@ SYNOPSIS
-------- --------
[verse] [verse]
'nvme device-self-test' <device> [--namespace-id=<NUM> | -n <NUM>] 'nvme device-self-test' <device> [--namespace-id=<NUM> | -n <NUM>]
[--self-test-code=<NUM> | -s <NUM>] [--wait | -w] [--self-test-code=<NUM> | -s <NUM>] [--wait | -w]
[--output-format=<fmt> | -o <fmt>] [--verbose | -v]
DESCRIPTION DESCRIPTION
----------- -----------
@ -28,12 +29,12 @@ OPTIONS
-s <NUM>:: -s <NUM>::
--self-test-code=<NUM>:: --self-test-code=<NUM>::
This field specifies the action taken by the device self-test command : This field specifies the action taken by the device self-test command :
0h: Show current state of device self-test operation 0h: Show current state of device self-test operation
1h: Start a short device self-test operation 1h: Start a short device self-test operation
2h: Start a extended device self-test operation 2h: Start a extended device self-test operation
eh: Start a vendor specific device self-test operation eh: Start a vendor specific device self-test operation
fh: Abort the device self-test operation fh: Abort the device self-test operation
Default is 0h. Default is 0h.
-w:: -w::
@ -42,6 +43,15 @@ OPTIONS
The device self-test is aborted by SIGINT signal interrupt for the wait The device self-test is aborted by SIGINT signal interrupt for the wait
The option is ignored if the abort self-test code option specified. The option is ignored if the abort self-test code option specified.
-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 EXAMPLES
-------- --------
* Start a short device self-test in the namespace-id 1: * Start a short device self-test in the namespace-id 1:

View file

@ -2,12 +2,12 @@
.\" Title: nvme-dim .\" Title: nvme-dim
.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] .\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/> .\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
.\" Date: 06/30/2023 .\" Date: 12/21/2023
.\" Manual: NVMe Manual .\" Manual: NVMe Manual
.\" Source: NVMe .\" Source: NVMe
.\" Language: English .\" Language: English
.\" .\"
.TH "NVME\-DIM" "1" "06/30/2023" "NVMe" "NVMe Manual" .TH "NVME\-DIM" "1" "12/21/2023" "NVMe" "NVMe Manual"
.\" ----------------------------------------------------------------- .\" -----------------------------------------------------------------
.\" * Define some portability stuff .\" * Define some portability stuff
.\" ----------------------------------------------------------------- .\" -----------------------------------------------------------------
@ -32,10 +32,9 @@ nvme-dim \- Send Discovery Information Management command to one or more Discove
.SH "SYNOPSIS" .SH "SYNOPSIS"
.sp .sp
.nf .nf
\fInvme dim\fR \fInvme dim\fR [\-\-task=<task> | \-t <task>] [\-\-nqn=<nqn> | \-n <nqn>]
[\-\-task=<task> | \-t <task>] [\-\-device=<device> | \-d <device>]
[\-\-nqn=<nqn> | \-n <nqn>] [\-\-output\-format=<fmt> | \-o <fmt>] [\-\-verbose | \-v]
[\-\-device=<device> | \-d <device>]
.fi .fi
.SH "DESCRIPTION" .SH "DESCRIPTION"
.sp .sp
@ -62,6 +61,20 @@ The DIM command will be sent to the Discovery Controller (DC) matching this NQN\
.RS 4 .RS 4
The DIM command will be sent to the Discovery Controllers (DC) associated with this NVMe device handle\&. A list of comma\-separated device handles can be supplied to apply the command to more than one DC\&. The DIM command will be sent to the Discovery Controllers (DC) associated with this NVMe device handle\&. A list of comma\-separated device handles can be supplied to apply the command to more than one DC\&.
.RE .RE
.PP
\-o <fmt>, \-\-output\-format=<fmt>
.RS 4
Set the reporting format to
\fInormal\fR,
\fIjson\fR
or
\fIbinary\fR\&. Only one output format can be used at a time\&.
.RE
.PP
\-v, \-\-verbose
.RS 4
Increase the information detail in the output\&.
.RE
.SH "EXAMPLES" .SH "EXAMPLES"
.sp .sp
.RS 4 .RS 4

View file

@ -749,10 +749,9 @@ nvme-dim(1) Manual Page
<h2 id="_synopsis">SYNOPSIS</h2> <h2 id="_synopsis">SYNOPSIS</h2>
<div class="sectionbody"> <div class="sectionbody">
<div class="verseblock"> <div class="verseblock">
<pre class="content"><em>nvme dim</em> <pre class="content"><em>nvme dim</em> [--task=&lt;task&gt; | -t &lt;task&gt;] [--nqn=&lt;nqn&gt; | -n &lt;nqn&gt;]
[--task=&lt;task&gt; | -t &lt;task&gt;] [--device=&lt;device&gt; | -d &lt;device&gt;]
[--nqn=&lt;nqn&gt; | -n &lt;nqn&gt;] [--output-format=&lt;fmt&gt; | -o &lt;fmt&gt;] [--verbose | -v]</pre>
[--device=&lt;device&gt; | -d &lt;device&gt;]</pre>
<div class="attribution"> <div class="attribution">
</div></div> </div></div>
</div> </div>
@ -817,6 +816,29 @@ with the nvme-discover(1) command using the --persistent option.</p></div>
be supplied to apply the command to more than one DC. be supplied to apply the command to more than one DC.
</p> </p>
</dd> </dd>
<dt class="hdlist1">
-o &lt;fmt&gt;
</dt>
<dt class="hdlist1">
--output-format=&lt;fmt&gt;
</dt>
<dd>
<p>
Set the reporting format to <em>normal</em>, <em>json</em> or <em>binary</em>. Only one
output format can be used at a time.
</p>
</dd>
<dt class="hdlist1">
-v
</dt>
<dt class="hdlist1">
--verbose
</dt>
<dd>
<p>
Increase the information detail in the output.
</p>
</dd>
</dl></div> </dl></div>
</div> </div>
</div> </div>
@ -863,7 +885,7 @@ Deregister from Central Discovery Controller (CDC) associated with nvme4
<div id="footer"> <div id="footer">
<div id="footer-text"> <div id="footer-text">
Last updated Last updated
2023-09-29 08:33:07 CEST 2023-12-21 15:49:29 CET
</div> </div>
</div> </div>
</body> </body>

View file

@ -3,15 +3,15 @@ nvme-dim(1)
NAME NAME
---- ----
nvme-dim - Send Discovery Information Management command to one or more Discovery Controllers. nvme-dim - Send Discovery Information Management command to one or more
Discovery Controllers.
SYNOPSIS SYNOPSIS
-------- --------
[verse] [verse]
'nvme dim' 'nvme dim' [--task=<task> | -t <task>] [--nqn=<nqn> | -n <nqn>]
[--task=<task> | -t <task>] [--device=<device> | -d <device>]
[--nqn=<nqn> | -n <nqn>] [--output-format=<fmt> | -o <fmt>] [--verbose | -v]
[--device=<device> | -d <device>]
DESCRIPTION DESCRIPTION
----------- -----------
@ -51,6 +51,15 @@ OPTIONS
with this NVMe device handle. A list of comma-separated device handles can with this NVMe device handle. A list of comma-separated device handles can
be supplied to apply the command to more than one DC. be supplied to apply the command to more than one DC.
-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 EXAMPLES
-------- --------
* Register with the Central Discovery Controller (CDC) named * Register with the Central Discovery Controller (CDC) named

View file

@ -2,12 +2,12 @@
.\" Title: nvme-dir-receive .\" Title: nvme-dir-receive
.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] .\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/> .\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
.\" Date: 06/30/2023 .\" Date: 12/21/2023
.\" Manual: NVMe Manual .\" Manual: NVMe Manual
.\" Source: NVMe .\" Source: NVMe
.\" Language: English .\" Language: English
.\" .\"
.TH "NVME\-DIR\-RECEIVE" "1" "06/30/2023" "NVMe" "NVMe Manual" .TH "NVME\-DIR\-RECEIVE" "1" "12/21/2023" "NVMe" "NVMe Manual"
.\" ----------------------------------------------------------------- .\" -----------------------------------------------------------------
.\" * Define some portability stuff .\" * Define some portability stuff
.\" ----------------------------------------------------------------- .\" -----------------------------------------------------------------
@ -33,13 +33,13 @@ nvme-dir-receive \- Send a directive receive command, returns applicable results
.sp .sp
.nf .nf
\fInvme dir\-receive\fR <device> [\-\-namespace\-id=<nsid> | \-n <nsid>] \fInvme dir\-receive\fR <device> [\-\-namespace\-id=<nsid> | \-n <nsid>]
[\-\-data\-len=<data\-len> | \-l <data\-len>] [\-\-data\-len=<data\-len> | \-l <data\-len>]
[\-\-dir\-type=<dtype> | \-D <dtype>] [\-\-dir\-type=<dtype> | \-D <dtype>]
[\-\-dir\-spec=<dspec> | \-S <dspec>] [\-\-dir\-spec=<dspec> | \-S <dspec>]
[\-\-dir\-oper=<doper> | \-O <doper>] [\-\-dir\-oper=<doper> | \-O <doper>]
[\-\-req\-resource=<nsr> | \-r <nsr>] [\-\-req\-resource=<nsr> | \-r <nsr>]
[\-\-human\-readable | \-H] [\-\-human\-readable | \-H] [\-\-raw\-binary | \-b]
[\-\-raw\-binary | \-b] [\-\-output\-format=<fmt> | \-o <fmt>] [\-\-verbose | \-v]
.fi .fi
.SH "DESCRIPTION" .SH "DESCRIPTION"
.sp .sp
@ -73,9 +73,6 @@ Directive operation
\-r <nsr>, \-\-req\-resource=<nsr> \-r <nsr>, \-\-req\-resource=<nsr>
.RS 4 .RS 4
Directive requested resource count Directive requested resource count
.RE
.sp
+
.TS .TS
allbox tab(:); allbox tab(:);
lt lt lt lt
@ -85,49 +82,38 @@ lt lt
lt lt lt lt
lt lt. lt lt.
T{ T{
.sp
Select Select
T}:T{ T}:T{
.sp
Description Description
T} T}
T{ T{
.sp
0 0
T}:T{ T}:T{
.sp
Current Current
T} T}
T{ T{
.sp
1 1
T}:T{ T}:T{
.sp
Default Default
T} T}
T{ T{
.sp
2 2
T}:T{ T}:T{
.sp
Saved Saved
T} T}
T{ T{
.sp
3 3
T}:T{ T}:T{
.sp
Supported capabilities Supported capabilities
T} T}
T{ T{
.sp
4\(en7 4\(en7
T}:T{ T}:T{
.sp
Reserved Reserved
T} T}
.TE .TE
.sp 1 .sp 1
.RE
.PP .PP
\-l <data\-len>, \-\-data\-len=<data\-len> \-l <data\-len>, \-\-data\-len=<data\-len>
.RS 4 .RS 4
@ -143,6 +129,20 @@ Print the raw receive buffer to stdout if the command returns a structure\&.
.RS 4 .RS 4
Print the decoded receive buffer to stdout if the command returns a structure\&. Print the decoded receive buffer to stdout if the command returns a structure\&.
.RE .RE
.PP
\-o <fmt>, \-\-output\-format=<fmt>
.RS 4
Set the reporting format to
\fInormal\fR,
\fIjson\fR
or
\fIbinary\fR\&. Only one output format can be used at a time\&.
.RE
.PP
\-v, \-\-verbose
.RS 4
Increase the information detail in the output\&.
.RE
.SH "EXAMPLES" .SH "EXAMPLES"
.sp .sp
.RS 4 .RS 4

View file

@ -750,13 +750,13 @@ nvme-dir-receive(1) Manual Page
<div class="sectionbody"> <div class="sectionbody">
<div class="verseblock"> <div class="verseblock">
<pre class="content"><em>nvme dir-receive</em> &lt;device&gt; [--namespace-id=&lt;nsid&gt; | -n &lt;nsid&gt;] <pre class="content"><em>nvme dir-receive</em> &lt;device&gt; [--namespace-id=&lt;nsid&gt; | -n &lt;nsid&gt;]
[--data-len=&lt;data-len&gt; | -l &lt;data-len&gt;] [--data-len=&lt;data-len&gt; | -l &lt;data-len&gt;]
[--dir-type=&lt;dtype&gt; | -D &lt;dtype&gt;] [--dir-type=&lt;dtype&gt; | -D &lt;dtype&gt;]
[--dir-spec=&lt;dspec&gt; | -S &lt;dspec&gt;] [--dir-spec=&lt;dspec&gt; | -S &lt;dspec&gt;]
[--dir-oper=&lt;doper&gt; | -O &lt;doper&gt;] [--dir-oper=&lt;doper&gt; | -O &lt;doper&gt;]
[--req-resource=&lt;nsr&gt; | -r &lt;nsr&gt;] [--req-resource=&lt;nsr&gt; | -r &lt;nsr&gt;]
[--human-readable | -H] [--human-readable | -H] [--raw-binary | -b]
[--raw-binary | -b]</pre> [--output-format=&lt;fmt&gt; | -o &lt;fmt&gt;] [--verbose | -v]</pre>
<div class="attribution"> <div class="attribution">
</div></div> </div></div>
</div> </div>
@ -835,9 +835,6 @@ printed to stdout for another program to parse.</p></div>
<p> <p>
Directive requested resource count Directive requested resource count
</p> </p>
</dd>
</dl></div>
<div class="paragraph"><p>+</p></div>
<div class="tableblock"> <div class="tableblock">
<table rules="all" <table rules="all"
width="100%" width="100%"
@ -873,7 +870,7 @@ cellspacing="0" cellpadding="4">
</tbody> </tbody>
</table> </table>
</div> </div>
<div class="dlist"><dl> </dd>
<dt class="hdlist1"> <dt class="hdlist1">
-l &lt;data-len&gt; -l &lt;data-len&gt;
</dt> </dt>
@ -911,6 +908,29 @@ cellspacing="0" cellpadding="4">
a structure. a structure.
</p> </p>
</dd> </dd>
<dt class="hdlist1">
-o &lt;fmt&gt;
</dt>
<dt class="hdlist1">
--output-format=&lt;fmt&gt;
</dt>
<dd>
<p>
Set the reporting format to <em>normal</em>, <em>json</em> or <em>binary</em>. Only one
output format can be used at a time.
</p>
</dd>
<dt class="hdlist1">
-v
</dt>
<dt class="hdlist1">
--verbose
</dt>
<dd>
<p>
Increase the information detail in the output.
</p>
</dd>
</dl></div> </dl></div>
</div> </div>
</div> </div>
@ -969,7 +989,7 @@ Get streams directive status :
<div id="footer"> <div id="footer">
<div id="footer-text"> <div id="footer-text">
Last updated Last updated
2023-09-29 08:33:07 CEST 2023-12-21 15:49:29 CET
</div> </div>
</div> </div>
</body> </body>

View file

@ -9,13 +9,13 @@ SYNOPSIS
-------- --------
[verse] [verse]
'nvme dir-receive' <device> [--namespace-id=<nsid> | -n <nsid>] 'nvme dir-receive' <device> [--namespace-id=<nsid> | -n <nsid>]
[--data-len=<data-len> | -l <data-len>] [--data-len=<data-len> | -l <data-len>]
[--dir-type=<dtype> | -D <dtype>] [--dir-type=<dtype> | -D <dtype>]
[--dir-spec=<dspec> | -S <dspec>] [--dir-spec=<dspec> | -S <dspec>]
[--dir-oper=<doper> | -O <doper>] [--dir-oper=<doper> | -O <doper>]
[--req-resource=<nsr> | -r <nsr>] [--req-resource=<nsr> | -r <nsr>]
[--human-readable | -H] [--human-readable | -H] [--raw-binary | -b]
[--raw-binary | -b] [--output-format=<fmt> | -o <fmt>] [--verbose | -v]
DESCRIPTION DESCRIPTION
----------- -----------
@ -41,20 +41,19 @@ OPTIONS
-D <dtype>:: -D <dtype>::
--dir-type=<dtype>:: --dir-type=<dtype>::
Directive type Directive type
-S <dspec>:: -S <dspec>::
--dir-spec=<dspec>:: --dir-spec=<dspec>::
Directive specific Directive specific
-O <doper>:: -O <doper>::
--dir-oper=<doper>:: --dir-oper=<doper>::
Directive operation Directive operation
-r <nsr>:: -r <nsr>::
--req-resource=<nsr>:: --req-resource=<nsr>::
Directive requested resource count Directive requested resource count
+ +
[] []
|================== |==================
@ -82,6 +81,15 @@ OPTIONS
Print the decoded receive buffer to stdout if the command returns Print the decoded receive buffer to stdout if the command returns
a structure. a structure.
-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 EXAMPLES
-------- --------
* Identify directive type supported : * Identify directive type supported :

View file

@ -2,12 +2,12 @@
.\" Title: nvme-dir-send .\" Title: nvme-dir-send
.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] .\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/> .\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
.\" Date: 06/30/2023 .\" Date: 12/21/2023
.\" Manual: NVMe Manual .\" Manual: NVMe Manual
.\" Source: NVMe .\" Source: NVMe
.\" Language: English .\" Language: English
.\" .\"
.TH "NVME\-DIR\-SEND" "1" "06/30/2023" "NVMe" "NVMe Manual" .TH "NVME\-DIR\-SEND" "1" "12/21/2023" "NVMe" "NVMe Manual"
.\" ----------------------------------------------------------------- .\" -----------------------------------------------------------------
.\" * Define some portability stuff .\" * Define some portability stuff
.\" ----------------------------------------------------------------- .\" -----------------------------------------------------------------
@ -33,14 +33,14 @@ nvme-dir-send \- Issue a directive send command, returns applicable results
.sp .sp
.nf .nf
\fInvme dir\-send\fR <device> [\-\-namespace\-id=<nsid> | \-n <nsid>] \fInvme dir\-send\fR <device> [\-\-namespace\-id=<nsid> | \-n <nsid>]
[\-\-data\-len=<data\-len> | \-l <data\-len>] [\-\-data\-len=<data\-len> | \-l <data\-len>]
[\-\-dir\-type=<dtype> | \-D <dtype>] [\-\-dir\-type=<dtype> | \-D <dtype>]
[\-\-dir\-spec=<dspec> | \-S <dspec>] [\-\-dir\-spec=<dspec> | \-S <dspec>]
[\-\-dir\-oper=<doper> | \-O <doper>] [\-\-dir\-oper=<doper> | \-O <doper>]
[\-\-endir=<endir> | \-e <endir>] [\-\-endir=<endir> | \-e <endir>]
[\-\-target\-dir=<tdir> | \-T <tdir>] [\-\-target\-dir=<tdir> | \-T <tdir>]
[\-\-human\-readable | \-H] [\-\-human\-readable | \-H] [\-\-raw\-binary | \-b]
[\-\-raw\-binary | \-b] [\-\-output\-format=<fmt> | \-o <fmt>] [\-\-verbose | \-v]
.fi .fi
.SH "DESCRIPTION" .SH "DESCRIPTION"
.sp .sp
@ -79,9 +79,6 @@ Target directive of the operation
\-e <endir>, \-\-endir=<endir> \-e <endir>, \-\-endir=<endir>
.RS 4 .RS 4
Target directive enable(1) or disable (0) operation Target directive enable(1) or disable (0) operation
.RE
.sp
+
.TS .TS
allbox tab(:); allbox tab(:);
lt lt lt lt
@ -91,49 +88,38 @@ lt lt
lt lt lt lt
lt lt. lt lt.
T{ T{
.sp
Select Select
T}:T{ T}:T{
.sp
Description Description
T} T}
T{ T{
.sp
0 0
T}:T{ T}:T{
.sp
Current Current
T} T}
T{ T{
.sp
1 1
T}:T{ T}:T{
.sp
Default Default
T} T}
T{ T{
.sp
2 2
T}:T{ T}:T{
.sp
Saved Saved
T} T}
T{ T{
.sp
3 3
T}:T{ T}:T{
.sp
Supported capabilities Supported capabilities
T} T}
T{ T{
.sp
4\(en7 4\(en7
T}:T{ T}:T{
.sp
Reserved Reserved
T} T}
.TE .TE
.sp 1 .sp 1
.RE
.PP .PP
\-l <data\-len>, \-\-data\-len=<data\-len> \-l <data\-len>, \-\-data\-len=<data\-len>
.RS 4 .RS 4
@ -149,6 +135,20 @@ Print the raw receive buffer to stdout if the command returns a structure\&.
.RS 4 .RS 4
Print the decoded receive buffer to stdout if the command returns a structure\&. Print the decoded receive buffer to stdout if the command returns a structure\&.
.RE .RE
.PP
\-o <fmt>, \-\-output\-format=<fmt>
.RS 4
Set the reporting format to
\fInormal\fR,
\fIjson\fR
or
\fIbinary\fR\&. Only one output format can be used at a time\&.
.RE
.PP
\-v, \-\-verbose
.RS 4
Increase the information detail in the output\&.
.RE
.SH "EXAMPLES" .SH "EXAMPLES"
.sp .sp
.RS 4 .RS 4

View file

@ -750,14 +750,14 @@ nvme-dir-send(1) Manual Page
<div class="sectionbody"> <div class="sectionbody">
<div class="verseblock"> <div class="verseblock">
<pre class="content"><em>nvme dir-send</em> &lt;device&gt; [--namespace-id=&lt;nsid&gt; | -n &lt;nsid&gt;] <pre class="content"><em>nvme dir-send</em> &lt;device&gt; [--namespace-id=&lt;nsid&gt; | -n &lt;nsid&gt;]
[--data-len=&lt;data-len&gt; | -l &lt;data-len&gt;] [--data-len=&lt;data-len&gt; | -l &lt;data-len&gt;]
[--dir-type=&lt;dtype&gt; | -D &lt;dtype&gt;] [--dir-type=&lt;dtype&gt; | -D &lt;dtype&gt;]
[--dir-spec=&lt;dspec&gt; | -S &lt;dspec&gt;] [--dir-spec=&lt;dspec&gt; | -S &lt;dspec&gt;]
[--dir-oper=&lt;doper&gt; | -O &lt;doper&gt;] [--dir-oper=&lt;doper&gt; | -O &lt;doper&gt;]
[--endir=&lt;endir&gt; | -e &lt;endir&gt;] [--endir=&lt;endir&gt; | -e &lt;endir&gt;]
[--target-dir=&lt;tdir&gt; | -T &lt;tdir&gt;] [--target-dir=&lt;tdir&gt; | -T &lt;tdir&gt;]
[--human-readable | -H] [--human-readable | -H] [--raw-binary | -b]
[--raw-binary | -b]</pre> [--output-format=&lt;fmt&gt; | -o &lt;fmt&gt;] [--verbose | -v]</pre>
<div class="attribution"> <div class="attribution">
</div></div> </div></div>
</div> </div>
@ -848,9 +848,6 @@ printed to stdout for another program to parse.</p></div>
<p> <p>
Target directive enable(1) or disable (0) operation Target directive enable(1) or disable (0) operation
</p> </p>
</dd>
</dl></div>
<div class="paragraph"><p>+</p></div>
<div class="tableblock"> <div class="tableblock">
<table rules="all" <table rules="all"
width="100%" width="100%"
@ -886,7 +883,7 @@ cellspacing="0" cellpadding="4">
</tbody> </tbody>
</table> </table>
</div> </div>
<div class="dlist"><dl> </dd>
<dt class="hdlist1"> <dt class="hdlist1">
-l &lt;data-len&gt; -l &lt;data-len&gt;
</dt> </dt>
@ -924,6 +921,29 @@ cellspacing="0" cellpadding="4">
a structure. a structure.
</p> </p>
</dd> </dd>
<dt class="hdlist1">
-o &lt;fmt&gt;
</dt>
<dt class="hdlist1">
--output-format=&lt;fmt&gt;
</dt>
<dd>
<p>
Set the reporting format to <em>normal</em>, <em>json</em> or <em>binary</em>. Only one
output format can be used at a time.
</p>
</dd>
<dt class="hdlist1">
-v
</dt>
<dt class="hdlist1">
--verbose
</dt>
<dd>
<p>
Increase the information detail in the output.
</p>
</dd>
</dl></div> </dl></div>
</div> </div>
</div> </div>
@ -982,7 +1002,7 @@ Release stream ID 3 :
<div id="footer"> <div id="footer">
<div id="footer-text"> <div id="footer-text">
Last updated Last updated
2023-09-29 08:33:07 CEST 2023-12-21 15:49:29 CET
</div> </div>
</div> </div>
</body> </body>

View file

@ -9,14 +9,14 @@ SYNOPSIS
-------- --------
[verse] [verse]
'nvme dir-send' <device> [--namespace-id=<nsid> | -n <nsid>] 'nvme dir-send' <device> [--namespace-id=<nsid> | -n <nsid>]
[--data-len=<data-len> | -l <data-len>] [--data-len=<data-len> | -l <data-len>]
[--dir-type=<dtype> | -D <dtype>] [--dir-type=<dtype> | -D <dtype>]
[--dir-spec=<dspec> | -S <dspec>] [--dir-spec=<dspec> | -S <dspec>]
[--dir-oper=<doper> | -O <doper>] [--dir-oper=<doper> | -O <doper>]
[--endir=<endir> | -e <endir>] [--endir=<endir> | -e <endir>]
[--target-dir=<tdir> | -T <tdir>] [--target-dir=<tdir> | -T <tdir>]
[--human-readable | -H] [--human-readable | -H] [--raw-binary | -b]
[--raw-binary | -b] [--output-format=<fmt> | -o <fmt>] [--verbose | -v]
DESCRIPTION DESCRIPTION
----------- -----------
@ -43,15 +43,15 @@ OPTIONS
-D <dtype>:: -D <dtype>::
--dir-type=<dtype>:: --dir-type=<dtype>::
Directive type Directive type
-S <dspec>:: -S <dspec>::
--dir-spec=<dspec>:: --dir-spec=<dspec>::
Directive specific Directive specific
-O <doper>:: -O <doper>::
--dir-oper=<doper>:: --dir-oper=<doper>::
Directive operation Directive operation
-T <tdir>:: -T <tdir>::
--target-dir=<nsr>:: --target-dir=<nsr>::
@ -60,7 +60,6 @@ OPTIONS
-e <endir>:: -e <endir>::
--endir=<endir>:: --endir=<endir>::
Target directive enable(1) or disable (0) operation Target directive enable(1) or disable (0) operation
+ +
[] []
|================== |==================
@ -88,6 +87,15 @@ OPTIONS
Print the decoded receive buffer to stdout if the command returns Print the decoded receive buffer to stdout if the command returns
a structure. a structure.
-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 EXAMPLES
-------- --------
* Enable streams directive : * Enable streams directive :

View file

@ -2,12 +2,12 @@
.\" Title: nvme-disconnect-all .\" Title: nvme-disconnect-all
.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] .\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/> .\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
.\" Date: 06/30/2023 .\" Date: 12/21/2023
.\" Manual: NVMe Manual .\" Manual: NVMe Manual
.\" Source: NVMe .\" Source: NVMe
.\" Language: English .\" Language: English
.\" .\"
.TH "NVME\-DISCONNECT\-AL" "1" "06/30/2023" "NVMe" "NVMe Manual" .TH "NVME\-DISCONNECT\-AL" "1" "12/21/2023" "NVMe" "NVMe Manual"
.\" ----------------------------------------------------------------- .\" -----------------------------------------------------------------
.\" * Define some portability stuff .\" * Define some portability stuff
.\" ----------------------------------------------------------------- .\" -----------------------------------------------------------------
@ -32,13 +32,28 @@ nvme-disconnect-all \- Disconnect from all connected Fabrics controllers\&.
.SH "SYNOPSIS" .SH "SYNOPSIS"
.sp .sp
.nf .nf
\fInvme disconnect\-all\fR \fInvme disconnect\-all\fR [\-\-output\-format=<fmt> | \-o <fmt>] [\-\-verbose | \-v]
.fi .fi
.SH "DESCRIPTION" .SH "DESCRIPTION"
.sp .sp
Disconnects and removes all existing NVMe over Fabrics controllers\&. Disconnects and removes all existing NVMe over Fabrics controllers\&.
.sp .sp
See the documentation for the nvme\-disconnect(1) command for further background\&. See the documentation for the nvme\-disconnect(1) command for further background\&.
.SH "OPTIONS"
.PP
\-o <fmt>, \-\-output\-format=<fmt>
.RS 4
Set the reporting format to
\fInormal\fR,
\fIjson\fR
or
\fIbinary\fR\&. Only one output format can be used at a time\&.
.RE
.PP
\-v, \-\-verbose
.RS 4
Increase the information detail in the output\&.
.RE
.SH "EXAMPLES" .SH "EXAMPLES"
.sp .sp
.RS 4 .RS 4

View file

@ -749,7 +749,7 @@ nvme-disconnect-all(1) Manual Page
<h2 id="_synopsis">SYNOPSIS</h2> <h2 id="_synopsis">SYNOPSIS</h2>
<div class="sectionbody"> <div class="sectionbody">
<div class="verseblock"> <div class="verseblock">
<pre class="content"><em>nvme disconnect-all</em></pre> <pre class="content"><em>nvme disconnect-all</em> [--output-format=&lt;fmt&gt; | -o &lt;fmt&gt;] [--verbose | -v]</pre>
<div class="attribution"> <div class="attribution">
</div></div> </div></div>
</div> </div>
@ -763,6 +763,36 @@ background.</p></div>
</div> </div>
</div> </div>
<div class="sect1"> <div class="sect1">
<h2 id="_options">OPTIONS</h2>
<div class="sectionbody">
<div class="dlist"><dl>
<dt class="hdlist1">
-o &lt;fmt&gt;
</dt>
<dt class="hdlist1">
--output-format=&lt;fmt&gt;
</dt>
<dd>
<p>
Set the reporting format to <em>normal</em>, <em>json</em> or <em>binary</em>. Only one
output format can be used at a time.
</p>
</dd>
<dt class="hdlist1">
-v
</dt>
<dt class="hdlist1">
--verbose
</dt>
<dd>
<p>
Increase the information detail in the output.
</p>
</dd>
</dl></div>
</div>
</div>
<div class="sect1">
<h2 id="_examples">EXAMPLES</h2> <h2 id="_examples">EXAMPLES</h2>
<div class="sectionbody"> <div class="sectionbody">
<div class="ulist"><ul> <div class="ulist"><ul>
@ -795,7 +825,7 @@ Disconnect all existing nvme controllers:
<div id="footer"> <div id="footer">
<div id="footer-text"> <div id="footer-text">
Last updated Last updated
2023-09-29 08:33:07 CEST 2023-12-21 15:49:29 CET
</div> </div>
</div> </div>
</body> </body>

View file

@ -8,7 +8,7 @@ nvme-disconnect-all - Disconnect from all connected Fabrics controllers.
SYNOPSIS SYNOPSIS
-------- --------
[verse] [verse]
'nvme disconnect-all' 'nvme disconnect-all' [--output-format=<fmt> | -o <fmt>] [--verbose | -v]
DESCRIPTION DESCRIPTION
----------- -----------
@ -17,6 +17,17 @@ Disconnects and removes all existing NVMe over Fabrics controllers.
See the documentation for the nvme-disconnect(1) command for further See the documentation for the nvme-disconnect(1) command for further
background. background.
OPTIONS
-------
-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 EXAMPLES
-------- --------
* Disconnect all existing nvme controllers: * Disconnect all existing nvme controllers:

View file

@ -2,12 +2,12 @@
.\" Title: nvme-disconnect .\" Title: nvme-disconnect
.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] .\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/> .\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
.\" Date: 06/30/2023 .\" Date: 12/21/2023
.\" Manual: NVMe Manual .\" Manual: NVMe Manual
.\" Source: NVMe .\" Source: NVMe
.\" Language: English .\" Language: English
.\" .\"
.TH "NVME\-DISCONNECT" "1" "06/30/2023" "NVMe" "NVMe Manual" .TH "NVME\-DISCONNECT" "1" "12/21/2023" "NVMe" "NVMe Manual"
.\" ----------------------------------------------------------------- .\" -----------------------------------------------------------------
.\" * Define some portability stuff .\" * Define some portability stuff
.\" ----------------------------------------------------------------- .\" -----------------------------------------------------------------
@ -32,9 +32,9 @@ nvme-disconnect \- Disconnect one or more Fabrics controller(s)\&.
.SH "SYNOPSIS" .SH "SYNOPSIS"
.sp .sp
.nf .nf
\fInvme disconnect\fR \fInvme disconnect\fR [\-\-nqn=<subnqn> | \-n <subnqn>]
[\-\-nqn=<subnqn> | \-n <subnqn>] [\-\-device=<device> | \-d <device>]
[\-\-device=<device> | \-d <device>] [\-\-output\-format=<fmt> | \-o <fmt>] [\-\-verbose | \-v]
.fi .fi
.SH "DESCRIPTION" .SH "DESCRIPTION"
.sp .sp
@ -50,6 +50,20 @@ Indicates that all controllers for the NVMe subsystems specified should be remov
.RS 4 .RS 4
Indicates that the controller with the specified name should be removed\&. Indicates that the controller with the specified name should be removed\&.
.RE .RE
.PP
\-o <fmt>, \-\-output\-format=<fmt>
.RS 4
Set the reporting format to
\fInormal\fR,
\fIjson\fR
or
\fIbinary\fR\&. Only one output format can be used at a time\&.
.RE
.PP
\-v, \-\-verbose
.RS 4
Increase the information detail in the output\&.
.RE
.SH "EXAMPLES" .SH "EXAMPLES"
.sp .sp
.RS 4 .RS 4

View file

@ -749,9 +749,9 @@ nvme-disconnect(1) Manual Page
<h2 id="_synopsis">SYNOPSIS</h2> <h2 id="_synopsis">SYNOPSIS</h2>
<div class="sectionbody"> <div class="sectionbody">
<div class="verseblock"> <div class="verseblock">
<pre class="content"><em>nvme disconnect</em> <pre class="content"><em>nvme disconnect</em> [--nqn=&lt;subnqn&gt; | -n &lt;subnqn&gt;]
[--nqn=&lt;subnqn&gt; | -n &lt;subnqn&gt;] [--device=&lt;device&gt; | -d &lt;device&gt;]
[--device=&lt;device&gt; | -d &lt;device&gt;]</pre> [--output-format=&lt;fmt&gt; | -o &lt;fmt&gt;] [--verbose | -v]</pre>
<div class="attribution"> <div class="attribution">
</div></div> </div></div>
</div> </div>
@ -761,7 +761,7 @@ nvme-disconnect(1) Manual Page
<div class="sectionbody"> <div class="sectionbody">
<div class="paragraph"><p>Disconnects and removes one or more existing NVMe over Fabrics controllers. <div class="paragraph"><p>Disconnects and removes one or more existing NVMe over Fabrics controllers.
If the --nqn option is specified all controllers connecting to the Subsystem If the --nqn option is specified all controllers connecting to the Subsystem
identified by subnqn will be removed. If the --device option is specified identified by subnqn will be removed. If the --device option is specified
the controller specified by the --device option will be removed.</p></div> the controller specified by the --device option will be removed.</p></div>
</div> </div>
</div> </div>
@ -793,6 +793,29 @@ the controller specified by the --device option will be removed.</p></div>
removed. removed.
</p> </p>
</dd> </dd>
<dt class="hdlist1">
-o &lt;fmt&gt;
</dt>
<dt class="hdlist1">
--output-format=&lt;fmt&gt;
</dt>
<dd>
<p>
Set the reporting format to <em>normal</em>, <em>json</em> or <em>binary</em>. Only one
output format can be used at a time.
</p>
</dd>
<dt class="hdlist1">
-v
</dt>
<dt class="hdlist1">
--verbose
</dt>
<dd>
<p>
Increase the information detail in the output.
</p>
</dd>
</dl></div> </dl></div>
</div> </div>
</div> </div>
@ -839,7 +862,7 @@ Disconnect the controller nvme4
<div id="footer"> <div id="footer">
<div id="footer-text"> <div id="footer-text">
Last updated Last updated
2023-09-29 08:33:07 CEST 2023-12-21 15:49:29 CET
</div> </div>
</div> </div>
</body> </body>

View file

@ -8,15 +8,15 @@ nvme-disconnect - Disconnect one or more Fabrics controller(s).
SYNOPSIS SYNOPSIS
-------- --------
[verse] [verse]
'nvme disconnect' 'nvme disconnect' [--nqn=<subnqn> | -n <subnqn>]
[--nqn=<subnqn> | -n <subnqn>] [--device=<device> | -d <device>]
[--device=<device> | -d <device>] [--output-format=<fmt> | -o <fmt>] [--verbose | -v]
DESCRIPTION DESCRIPTION
----------- -----------
Disconnects and removes one or more existing NVMe over Fabrics controllers. Disconnects and removes one or more existing NVMe over Fabrics controllers.
If the --nqn option is specified all controllers connecting to the Subsystem If the --nqn option is specified all controllers connecting to the Subsystem
identified by subnqn will be removed. If the --device option is specified identified by subnqn will be removed. If the --device option is specified
the controller specified by the --device option will be removed. the controller specified by the --device option will be removed.
OPTIONS OPTIONS
@ -31,6 +31,15 @@ OPTIONS
Indicates that the controller with the specified name should be Indicates that the controller with the specified name should be
removed. removed.
-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 EXAMPLES
-------- --------
* Disconnect all controllers for a subsystem named * Disconnect all controllers for a subsystem named
@ -50,7 +59,6 @@ SEE ALSO
-------- --------
nvme-connect(1) nvme-connect(1)
NVME NVME
---- ----
Part of the nvme-user suite Part of the nvme-user suite

View file

@ -2,12 +2,12 @@
.\" Title: nvme-discover .\" Title: nvme-discover
.\" Author: [see the "AUTHORS" section] .\" Author: [see the "AUTHORS" section]
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/> .\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
.\" Date: 06/30/2023 .\" Date: 12/21/2023
.\" Manual: NVMe Manual .\" Manual: NVMe Manual
.\" Source: NVMe .\" Source: NVMe
.\" Language: English .\" Language: English
.\" .\"
.TH "NVME\-DISCOVER" "1" "06/30/2023" "NVMe" "NVMe Manual" .TH "NVME\-DISCOVER" "1" "12/21/2023" "NVMe" "NVMe Manual"
.\" ----------------------------------------------------------------- .\" -----------------------------------------------------------------
.\" * Define some portability stuff .\" * Define some portability stuff
.\" ----------------------------------------------------------------- .\" -----------------------------------------------------------------
@ -32,39 +32,30 @@ nvme-discover \- Send Get Log Page request to Discovery Controller\&.
.SH "SYNOPSIS" .SH "SYNOPSIS"
.sp .sp
.nf .nf
\fInvme discover\fR \fInvme discover\fR [\-\-transport=<trtype> | \-t <trtype>]
[\-\-transport=<trtype> | \-t <trtype>] [\-\-nqn=<subnqn> | \-n <subnqn>]
[\-\-nqn=<subnqn> | \-n <subnqn>] [\-\-traddr=<traddr> | \-a <traddr>]
[\-\-traddr=<traddr> | \-a <traddr>] [\-\-trsvcid=<trsvcid> | \-s <trsvcid>]
[\-\-trsvcid=<trsvcid> | \-s <trsvcid>] [\-\-host\-traddr=<traddr> | \-w <traddr>]
[\-\-host\-traddr=<traddr> | \-w <traddr>] [\-\-host\-iface=<iface> | \-f <iface>]
[\-\-host\-iface=<iface> | \-f <iface>] [\-\-hostnqn=<hostnqn> | \-q <hostnqn>]
[\-\-hostnqn=<hostnqn> | \-q <hostnqn>] [\-\-hostid=<hostid> | \-I <hostid>]
[\-\-hostid=<hostid> | \-I <hostid>] [\-\-raw=<filename> | \-r <filename>]
[\-\-raw=<filename> | \-r <filename>] [\-\-device=<device> | \-d <device>]
[\-\-device=<device> | \-d <device>] [\-\-cfg\-file=<cfg> | \-C <cfg>]
[\-\-cfg\-file=<cfg> | \-C <cfg> ] [\-\-keep\-alive\-tmo=<sec> | \-k <sec>]
[\-\-keep\-alive\-tmo=<sec> | \-k <sec>] [\-\-reconnect\-delay=<#> | \-c <#>]
[\-\-reconnect\-delay=<#> | \-c <#>] [\-\-ctrl\-loss\-tmo=<#> | \-l <#>]
[\-\-ctrl\-loss\-tmo=<#> | \-l <#>] [\-\-nr\-io\-queues=<#> | \-i <#>]
[\-\-nr\-io\-queues=<#> | \-i <#>] [\-\-nr\-write\-queues=<#> | \-W <#>]
[\-\-nr\-write\-queues=<#> | \-W <#>] [\-\-nr\-poll\-queues=<#> | \-P <#>]
[\-\-nr\-poll\-queues=<#> | \-P <#>] [\-\-queue\-size=<#> | \-Q <#>] [\-\-keyring=<#>]
[\-\-queue\-size=<#> | \-Q <#>] [\-\-tls_key=<#>] [\-\-hdr\-digest | \-g] [\-\-data\-digest | \-G]
[\-\-keyring=<#> ] [\-\-persistent | \-p] [\-\-quiet | \-S] [\-\-tls]
[\-\-tls_key=<#> ] [\-\-dump\-config | \-O] [\-\-output\-format=<fmt> | \-o <fmt>]
[\-\-hdr\-digest | \-g] [\-\-force] [\-\-nbft] [\-\-no\-nbft] [\-\-nbft\-path=<STR>]
[\-\-data\-digest | \-G] [\-\-context=<STR>]
[\-\-persistent | \-p] [\-\-output\-format=<fmt> | \-o <fmt>] [\-\-verbose | \-v]
[\-\-quiet | \-S]
[\-\-tls ]
[\-\-dump\-config | \-O]
[\-\-output\-format=<fmt> | \-o <fmt>]
[\-\-force]
[\-\-nbft]
[\-\-no\-nbft]
[\-\-nbft\-path=<STR>]
[\-\-context=<STR>]
.fi .fi
.SH "DESCRIPTION" .SH "DESCRIPTION"
.sp .sp
@ -254,11 +245,12 @@ Suppress already connected errors\&.
Print out resulting JSON configuration file to stdout\&. Print out resulting JSON configuration file to stdout\&.
.RE .RE
.PP .PP
\-o <format>, \-\-output\-format=<format> \-o <fmt>, \-\-output\-format=<fmt>
.RS 4 .RS 4
Set the reporting format to Set the reporting format to
\fInormal\fR, \fInormal\fR,
\fIjson\fR, or \fIjson\fR
or
\fIbinary\fR\&. Only one output format can be used at a time\&. \fIbinary\fR\&. Only one output format can be used at a time\&.
.RE .RE
.PP .PP
@ -286,6 +278,20 @@ Use a user\-defined path to the NBFT tables
.RS 4 .RS 4
Set the execution context to <STR>\&. This allows to coordinate the management of the global resources\&. Set the execution context to <STR>\&. This allows to coordinate the management of the global resources\&.
.RE .RE
.PP
\-o <fmt>, \-\-output\-format=<fmt>
.RS 4
Set the reporting format to
\fInormal\fR,
\fIjson\fR
or
\fIbinary\fR\&. Only one output format can be used at a time\&.
.RE
.PP
\-v, \-\-verbose
.RS 4
Increase the information detail in the output\&.
.RE
.SH "EXAMPLES" .SH "EXAMPLES"
.sp .sp
.RS 4 .RS 4
@ -372,9 +378,9 @@ command using a /usr/local/etc/nvme/discovery\&.conf file:
.RS 4 .RS 4
.\} .\}
.nf .nf
# Machine default \*(Aqnvme discover\*(Aq commands\&. Query the # Machine default \*(Aqnvme discover\*(Aq commands\&. Query the
# Discovery Controller\*(Aqs two ports (some resources may only # Discovery Controller\*(Aqs two ports (some resources may only
# be accessible on a single port)\&. Note an official # be accessible on a single port)\&. Note an official
# nqn (Host) name defined in the NVMe specification is being used # nqn (Host) name defined in the NVMe specification is being used
# in this example\&. # in this example\&.
\-t rdma \-a 192\&.168\&.69\&.33 \-s 4420 \-q nqn\&.2014\-08\&.com\&.example:nvme:nvm\-subsystem\-sn\-d78432 \-t rdma \-a 192\&.168\&.69\&.33 \-s 4420 \-q nqn\&.2014\-08\&.com\&.example:nvme:nvm\-subsystem\-sn\-d78432

View file

@ -749,39 +749,30 @@ nvme-discover(1) Manual Page
<h2 id="_synopsis">SYNOPSIS</h2> <h2 id="_synopsis">SYNOPSIS</h2>
<div class="sectionbody"> <div class="sectionbody">
<div class="verseblock"> <div class="verseblock">
<pre class="content"><em>nvme discover</em> <pre class="content"><em>nvme discover</em> [--transport=&lt;trtype&gt; | -t &lt;trtype&gt;]
[--transport=&lt;trtype&gt; | -t &lt;trtype&gt;] [--nqn=&lt;subnqn&gt; | -n &lt;subnqn&gt;]
[--nqn=&lt;subnqn&gt; | -n &lt;subnqn&gt;] [--traddr=&lt;traddr&gt; | -a &lt;traddr&gt;]
[--traddr=&lt;traddr&gt; | -a &lt;traddr&gt;] [--trsvcid=&lt;trsvcid&gt; | -s &lt;trsvcid&gt;]
[--trsvcid=&lt;trsvcid&gt; | -s &lt;trsvcid&gt;] [--host-traddr=&lt;traddr&gt; | -w &lt;traddr&gt;]
[--host-traddr=&lt;traddr&gt; | -w &lt;traddr&gt;] [--host-iface=&lt;iface&gt; | -f &lt;iface&gt;]
[--host-iface=&lt;iface&gt; | -f &lt;iface&gt;] [--hostnqn=&lt;hostnqn&gt; | -q &lt;hostnqn&gt;]
[--hostnqn=&lt;hostnqn&gt; | -q &lt;hostnqn&gt;] [--hostid=&lt;hostid&gt; | -I &lt;hostid&gt;]
[--hostid=&lt;hostid&gt; | -I &lt;hostid&gt;] [--raw=&lt;filename&gt; | -r &lt;filename&gt;]
[--raw=&lt;filename&gt; | -r &lt;filename&gt;] [--device=&lt;device&gt; | -d &lt;device&gt;]
[--device=&lt;device&gt; | -d &lt;device&gt;] [--cfg-file=&lt;cfg&gt; | -C &lt;cfg&gt;]
[--cfg-file=&lt;cfg&gt; | -C &lt;cfg&gt; ] [--keep-alive-tmo=&lt;sec&gt; | -k &lt;sec&gt;]
[--keep-alive-tmo=&lt;sec&gt; | -k &lt;sec&gt;] [--reconnect-delay=&lt;#&gt; | -c &lt;#&gt;]
[--reconnect-delay=&lt;#&gt; | -c &lt;#&gt;] [--ctrl-loss-tmo=&lt;#&gt; | -l &lt;#&gt;]
[--ctrl-loss-tmo=&lt;#&gt; | -l &lt;#&gt;] [--nr-io-queues=&lt;#&gt; | -i &lt;#&gt;]
[--nr-io-queues=&lt;#&gt; | -i &lt;#&gt;] [--nr-write-queues=&lt;#&gt; | -W &lt;#&gt;]
[--nr-write-queues=&lt;#&gt; | -W &lt;#&gt;] [--nr-poll-queues=&lt;#&gt; | -P &lt;#&gt;]
[--nr-poll-queues=&lt;#&gt; | -P &lt;#&gt;] [--queue-size=&lt;#&gt; | -Q &lt;#&gt;] [--keyring=&lt;#&gt;]
[--queue-size=&lt;#&gt; | -Q &lt;#&gt;] [--tls_key=&lt;#&gt;] [--hdr-digest | -g] [--data-digest | -G]
[--keyring=&lt;#&gt; ] [--persistent | -p] [--quiet | -S] [--tls]
[--tls_key=&lt;#&gt; ] [--dump-config | -O] [--output-format=&lt;fmt&gt; | -o &lt;fmt&gt;]
[--hdr-digest | -g] [--force] [--nbft] [--no-nbft] [--nbft-path=&lt;STR&gt;]
[--data-digest | -G] [--context=&lt;STR&gt;]
[--persistent | -p] [--output-format=&lt;fmt&gt; | -o &lt;fmt&gt;] [--verbose | -v]</pre>
[--quiet | -S]
[--tls ]
[--dump-config | -O]
[--output-format=&lt;fmt&gt; | -o &lt;fmt&gt;]
[--force]
[--nbft]
[--no-nbft]
[--nbft-path=&lt;STR&gt;]
[--context=&lt;STR&gt;]</pre>
<div class="attribution"> <div class="attribution">
</div></div> </div></div>
</div> </div>
@ -793,7 +784,7 @@ nvme-discover(1) Manual Page
Controller.</p></div> Controller.</p></div>
<div class="paragraph"><p>If no parameters are given, then <em>nvme discover</em> will attempt to <div class="paragraph"><p>If no parameters are given, then <em>nvme discover</em> will attempt to
find a /usr/local/etc/nvme/discovery.conf file to use to supply a list of find a /usr/local/etc/nvme/discovery.conf file to use to supply a list of
Discovery commands to run. If no /usr/local/etc/nvme/discovery.conf file Discovery commands to run. If no /usr/local/etc/nvme/discovery.conf file
exists, the command will quit with an error.</p></div> exists, the command will quit with an error.</p></div>
<div class="paragraph"><p>Otherwise, a specific Discovery Controller should be specified using the <div class="paragraph"><p>Otherwise, a specific Discovery Controller should be specified using the
--transport, --traddr, and if necessary the --trsvcid flags. A Discovery --transport, --traddr, and if necessary the --trsvcid flags. A Discovery
@ -806,7 +797,7 @@ request will then be sent to the specified Discovery Controller.</p></div>
<div class="paragraph"><p>The NVMe-over-Fabrics specification defines the concept of a <div class="paragraph"><p>The NVMe-over-Fabrics specification defines the concept of a
Discovery Controller that an NVMe Host can query on a fabric Discovery Controller that an NVMe Host can query on a fabric
network to discover NVMe subsystems contained in NVMe Targets network to discover NVMe subsystems contained in NVMe Targets
which it can connect to on the network. The Discovery Controller which it can connect to on the network. The Discovery Controller
will return Discovery Log Pages that provide the NVMe Host will return Discovery Log Pages that provide the NVMe Host
with specific information (such as network address and unique with specific information (such as network address and unique
subsystem NQN) the NVMe Host can use to issue an subsystem NQN) the NVMe Host can use to issue an
@ -819,7 +810,7 @@ In particular, the Host NQN uniquely identifies the NVMe Host, and
may be used by the Discovery Controller to control what NVMe Target may be used by the Discovery Controller to control what NVMe Target
resources are allocated to the NVMe Host for a connection.</p></div> resources are allocated to the NVMe Host for a connection.</p></div>
<div class="paragraph"><p>A Discovery Controller has it&#8217;s own NQN defined in the NVMe-over-Fabrics <div class="paragraph"><p>A Discovery Controller has it&#8217;s own NQN defined in the NVMe-over-Fabrics
specification, <strong>nqn.2014-08.org.nvmexpress.discovery</strong>. All Discovery specification, <strong>nqn.2014-08.org.nvmexpress.discovery</strong>. All Discovery
Controllers must use this NQN name. This NQN is used by default by Controllers must use this NQN name. This NQN is used by default by
nvme-cli for the <em>discover</em> command.</p></div> nvme-cli for the <em>discover</em> command.</p></div>
</div> </div>
@ -837,7 +828,7 @@ nvme-cli for the <em>discover</em> command.</p></div>
<dd> <dd>
<p> <p>
This field specifies the network fabric being used for This field specifies the network fabric being used for
a NVMe-over-Fabrics network. Current string values include: a NVMe-over-Fabrics network. Current string values include:
</p> </p>
<div class="tableblock"> <div class="tableblock">
<table rules="all" <table rules="all"
@ -903,7 +894,7 @@ cellspacing="0" cellpadding="4">
</dt> </dt>
<dd> <dd>
<p> <p>
This field specifies the transport service id. For transports using IP This field specifies the transport service id. For transports using IP
addressing (e.g. rdma) this field is the port number. By default, the IP addressing (e.g. rdma) this field is the port number. By default, the IP
port number for the RDMA transport is 4420. port number for the RDMA transport is 4420.
</p> </p>
@ -1168,15 +1159,15 @@ cellspacing="0" cellpadding="4">
</p> </p>
</dd> </dd>
<dt class="hdlist1"> <dt class="hdlist1">
-o &lt;format&gt; -o &lt;fmt&gt;
</dt> </dt>
<dt class="hdlist1"> <dt class="hdlist1">
--output-format=&lt;format&gt; --output-format=&lt;fmt&gt;
</dt> </dt>
<dd> <dd>
<p> <p>
Set the reporting format to <em>normal</em>, <em>json</em>, or Set the reporting format to <em>normal</em>, <em>json</em> or <em>binary</em>. Only one
<em>binary</em>. Only one output format can be used at a time. output format can be used at a time.
</p> </p>
</dd> </dd>
<dt class="hdlist1"> <dt class="hdlist1">
@ -1222,6 +1213,29 @@ cellspacing="0" cellpadding="4">
the management of the global resources. the management of the global resources.
</p> </p>
</dd> </dd>
<dt class="hdlist1">
-o &lt;fmt&gt;
</dt>
<dt class="hdlist1">
--output-format=&lt;fmt&gt;
</dt>
<dd>
<p>
Set the reporting format to <em>normal</em>, <em>json</em> or <em>binary</em>. Only one
output format can be used at a time.
</p>
</dd>
<dt class="hdlist1">
-v
</dt>
<dt class="hdlist1">
--verbose
</dt>
<dd>
<p>
Increase the information detail in the output.
</p>
</dd>
</dl></div> </dl></div>
</div> </div>
</div> </div>
@ -1265,9 +1279,9 @@ Issue a <em>nvme discover</em> command using a /usr/local/etc/nvme/discovery.con
</p> </p>
<div class="listingblock"> <div class="listingblock">
<div class="content"> <div class="content">
<pre><code># Machine default 'nvme discover' commands. Query the <pre><code># Machine default 'nvme discover' commands. Query the
# Discovery Controller's two ports (some resources may only # Discovery Controller's two ports (some resources may only
# be accessible on a single port). Note an official # be accessible on a single port). Note an official
# nqn (Host) name defined in the NVMe specification is being used # nqn (Host) name defined in the NVMe specification is being used
# in this example. # in this example.
-t rdma -a 192.168.69.33 -s 4420 -q nqn.2014-08.com.example:nvme:nvm-subsystem-sn-d78432 -t rdma -a 192.168.69.33 -s 4420 -q nqn.2014-08.com.example:nvme:nvm-subsystem-sn-d78432
@ -1303,7 +1317,7 @@ nvme-connect-all(1)</p></div>
<div id="footer"> <div id="footer">
<div id="footer-text"> <div id="footer-text">
Last updated Last updated
2023-09-29 08:33:07 CEST 2023-12-21 15:49:29 CET
</div> </div>
</div> </div>
</body> </body>

View file

@ -8,39 +8,30 @@ nvme-discover - Send Get Log Page request to Discovery Controller.
SYNOPSIS SYNOPSIS
-------- --------
[verse] [verse]
'nvme discover' 'nvme discover' [--transport=<trtype> | -t <trtype>]
[--transport=<trtype> | -t <trtype>] [--nqn=<subnqn> | -n <subnqn>]
[--nqn=<subnqn> | -n <subnqn>] [--traddr=<traddr> | -a <traddr>]
[--traddr=<traddr> | -a <traddr>] [--trsvcid=<trsvcid> | -s <trsvcid>]
[--trsvcid=<trsvcid> | -s <trsvcid>] [--host-traddr=<traddr> | -w <traddr>]
[--host-traddr=<traddr> | -w <traddr>] [--host-iface=<iface> | -f <iface>]
[--host-iface=<iface> | -f <iface>] [--hostnqn=<hostnqn> | -q <hostnqn>]
[--hostnqn=<hostnqn> | -q <hostnqn>] [--hostid=<hostid> | -I <hostid>]
[--hostid=<hostid> | -I <hostid>] [--raw=<filename> | -r <filename>]
[--raw=<filename> | -r <filename>] [--device=<device> | -d <device>]
[--device=<device> | -d <device>] [--cfg-file=<cfg> | -C <cfg>]
[--cfg-file=<cfg> | -C <cfg> ] [--keep-alive-tmo=<sec> | -k <sec>]
[--keep-alive-tmo=<sec> | -k <sec>] [--reconnect-delay=<#> | -c <#>]
[--reconnect-delay=<#> | -c <#>] [--ctrl-loss-tmo=<#> | -l <#>]
[--ctrl-loss-tmo=<#> | -l <#>] [--nr-io-queues=<#> | -i <#>]
[--nr-io-queues=<#> | -i <#>] [--nr-write-queues=<#> | -W <#>]
[--nr-write-queues=<#> | -W <#>] [--nr-poll-queues=<#> | -P <#>]
[--nr-poll-queues=<#> | -P <#>] [--queue-size=<#> | -Q <#>] [--keyring=<#>]
[--queue-size=<#> | -Q <#>] [--tls_key=<#>] [--hdr-digest | -g] [--data-digest | -G]
[--keyring=<#> ] [--persistent | -p] [--quiet | -S] [--tls]
[--tls_key=<#> ] [--dump-config | -O] [--output-format=<fmt> | -o <fmt>]
[--hdr-digest | -g] [--force] [--nbft] [--no-nbft] [--nbft-path=<STR>]
[--data-digest | -G] [--context=<STR>]
[--persistent | -p] [--output-format=<fmt> | -o <fmt>] [--verbose | -v]
[--quiet | -S]
[--tls ]
[--dump-config | -O]
[--output-format=<fmt> | -o <fmt>]
[--force]
[--nbft]
[--no-nbft]
[--nbft-path=<STR>]
[--context=<STR>]
DESCRIPTION DESCRIPTION
----------- -----------
@ -49,7 +40,7 @@ Controller.
If no parameters are given, then 'nvme discover' will attempt to If no parameters are given, then 'nvme discover' will attempt to
find a @SYSCONFDIR@/nvme/discovery.conf file to use to supply a list of find a @SYSCONFDIR@/nvme/discovery.conf file to use to supply a list of
Discovery commands to run. If no @SYSCONFDIR@/nvme/discovery.conf file Discovery commands to run. If no @SYSCONFDIR@/nvme/discovery.conf file
exists, the command will quit with an error. exists, the command will quit with an error.
Otherwise, a specific Discovery Controller should be specified using the Otherwise, a specific Discovery Controller should be specified using the
@ -61,7 +52,7 @@ BACKGROUND
The NVMe-over-Fabrics specification defines the concept of a The NVMe-over-Fabrics specification defines the concept of a
Discovery Controller that an NVMe Host can query on a fabric Discovery Controller that an NVMe Host can query on a fabric
network to discover NVMe subsystems contained in NVMe Targets network to discover NVMe subsystems contained in NVMe Targets
which it can connect to on the network. The Discovery Controller which it can connect to on the network. The Discovery Controller
will return Discovery Log Pages that provide the NVMe Host will return Discovery Log Pages that provide the NVMe Host
with specific information (such as network address and unique with specific information (such as network address and unique
subsystem NQN) the NVMe Host can use to issue an subsystem NQN) the NVMe Host can use to issue an
@ -76,7 +67,7 @@ may be used by the Discovery Controller to control what NVMe Target
resources are allocated to the NVMe Host for a connection. resources are allocated to the NVMe Host for a connection.
A Discovery Controller has it's own NQN defined in the NVMe-over-Fabrics A Discovery Controller has it's own NQN defined in the NVMe-over-Fabrics
specification, *nqn.2014-08.org.nvmexpress.discovery*. All Discovery specification, *nqn.2014-08.org.nvmexpress.discovery*. All Discovery
Controllers must use this NQN name. This NQN is used by default by Controllers must use this NQN name. This NQN is used by default by
nvme-cli for the 'discover' command. nvme-cli for the 'discover' command.
@ -85,7 +76,7 @@ OPTIONS
-t <trtype>:: -t <trtype>::
--transport=<trtype>:: --transport=<trtype>::
This field specifies the network fabric being used for This field specifies the network fabric being used for
a NVMe-over-Fabrics network. Current string values include: a NVMe-over-Fabrics network. Current string values include:
+ +
[] []
|================= |=================
@ -108,7 +99,7 @@ OPTIONS
-s <trsvcid>:: -s <trsvcid>::
--trsvcid=<trsvcid>:: --trsvcid=<trsvcid>::
This field specifies the transport service id. For transports using IP This field specifies the transport service id. For transports using IP
addressing (e.g. rdma) this field is the port number. By default, the IP addressing (e.g. rdma) this field is the port number. By default, the IP
port number for the RDMA transport is 4420. port number for the RDMA transport is 4420.
@ -223,10 +214,10 @@ OPTIONS
--dump-config:: --dump-config::
Print out resulting JSON configuration file to stdout. Print out resulting JSON configuration file to stdout.
-o <format>:: -o <fmt>::
--output-format=<format>:: --output-format=<fmt>::
Set the reporting format to 'normal', 'json', or Set the reporting format to 'normal', 'json' or 'binary'. Only one
'binary'. Only one output format can be used at a time. output format can be used at a time.
--force:: --force::
Disable the built-in persistent discover connection rules. Disable the built-in persistent discover connection rules.
@ -234,18 +225,27 @@ OPTIONS
persistent discovery connection. persistent discovery connection.
--nbft:: --nbft::
Only look at NBFT tables Only look at NBFT tables
--no-nbft:: --no-nbft::
Do not look at NBFT tables Do not look at NBFT tables
--nbft-path=<STR>:: --nbft-path=<STR>::
Use a user-defined path to the NBFT tables Use a user-defined path to the NBFT tables
--context <STR>:: --context <STR>::
Set the execution context to <STR>. This allows to coordinate Set the execution context to <STR>. This allows to coordinate
the management of the global resources. the management of the global resources.
-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 EXAMPLES
-------- --------
* Query the Discover Controller with IP4 address 192.168.1.3 for all * Query the Discover Controller with IP4 address 192.168.1.3 for all
@ -272,9 +272,9 @@ Port 4420 is used by default:
* Issue a 'nvme discover' command using a @SYSCONFDIR@/nvme/discovery.conf file: * Issue a 'nvme discover' command using a @SYSCONFDIR@/nvme/discovery.conf file:
+ +
----------- -----------
# Machine default 'nvme discover' commands. Query the # Machine default 'nvme discover' commands. Query the
# Discovery Controller's two ports (some resources may only # Discovery Controller's two ports (some resources may only
# be accessible on a single port). Note an official # be accessible on a single port). Note an official
# nqn (Host) name defined in the NVMe specification is being used # nqn (Host) name defined in the NVMe specification is being used
# in this example. # in this example.
-t rdma -a 192.168.69.33 -s 4420 -q nqn.2014-08.com.example:nvme:nvm-subsystem-sn-d78432 -t rdma -a 192.168.69.33 -s 4420 -q nqn.2014-08.com.example:nvme:nvm-subsystem-sn-d78432

View file

@ -2,12 +2,12 @@
.\" Title: nvme-dsm .\" Title: nvme-dsm
.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] .\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/> .\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
.\" Date: 06/30/2023 .\" Date: 12/21/2023
.\" Manual: NVMe Manual .\" Manual: NVMe Manual
.\" Source: NVMe .\" Source: NVMe
.\" Language: English .\" Language: English
.\" .\"
.TH "NVME\-DSM" "1" "06/30/2023" "NVMe" "NVMe Manual" .TH "NVME\-DSM" "1" "12/21/2023" "NVMe" "NVMe Manual"
.\" ----------------------------------------------------------------- .\" -----------------------------------------------------------------
.\" * Define some portability stuff .\" * Define some portability stuff
.\" ----------------------------------------------------------------- .\" -----------------------------------------------------------------
@ -32,12 +32,14 @@ nvme-dsm \- Send NVMe Data Set Management, return results
.SH "SYNOPSIS" .SH "SYNOPSIS"
.sp .sp
.nf .nf
\fInvme dsm\fR <device> [ \-\-namespace\-id=<nsid> | \-n <nsid> ] \fInvme dsm\fR <device> [\-\-namespace\-id=<nsid> | \-n <nsid>]
[ \-\-ctx\-attrs=<attribute\-list,> | \-a <attribute\-list,> ] [\-\-ctx\-attrs=<attribute\-list,> | \-a <attribute\-list,>]
[ \-\-blocks=<nlb\-list,> | \-b <nlb\-list,> ] [\-\-blocks=<nlb\-list,> | \-b <nlb\-list,>]
[ \-\-slbs=<slba\-list,> | \-s <slba\-list,> ] [\-\-slbs=<slba\-list,> | \-s <slba\-list,>]
[ \-\-ad | \-d ] [ \-\-idw | \-w ] [ \-\-idr | \-r ] [\-\-ad=<deallocate> | \-d <deallocate>]
[ \-\-cdw11=<cdw11> | \-c <cdw11> ] [\-\-idw=<write> | \-w <write>] [\-\-idr=<read> | \-r <read>]
[\-\-cdw11=<cdw11> | \-c <cdw11>]
[\-\-output\-format=<fmt> | \-o <fmt>] [\-\-verbose | \-v]
.fi .fi
.SH "DESCRIPTION" .SH "DESCRIPTION"
.sp .sp
@ -89,6 +91,20 @@ Attribute Integral Dataset for Read\&.
.RS 4 .RS 4
All the command command dword 11 attributes\&. Use exclusive from specifying individual attributes All the command command dword 11 attributes\&. Use exclusive from specifying individual attributes
.RE .RE
.PP
\-o <fmt>, \-\-output\-format=<fmt>
.RS 4
Set the reporting format to
\fInormal\fR,
\fIjson\fR
or
\fIbinary\fR\&. Only one output format can be used at a time\&.
.RE
.PP
\-v, \-\-verbose
.RS 4
Increase the information detail in the output\&.
.RE
.SH "EXAMPLES" .SH "EXAMPLES"
.sp .sp
No examples yet No examples yet

View file

@ -749,12 +749,14 @@ nvme-dsm(1) Manual Page
<h2 id="_synopsis">SYNOPSIS</h2> <h2 id="_synopsis">SYNOPSIS</h2>
<div class="sectionbody"> <div class="sectionbody">
<div class="verseblock"> <div class="verseblock">
<pre class="content"><em>nvme dsm</em> &lt;device&gt; [ --namespace-id=&lt;nsid&gt; | -n &lt;nsid&gt; ] <pre class="content"><em>nvme dsm</em> &lt;device&gt; [--namespace-id=&lt;nsid&gt; | -n &lt;nsid&gt;]
[ --ctx-attrs=&lt;attribute-list,&gt; | -a &lt;attribute-list,&gt; ] [--ctx-attrs=&lt;attribute-list,&gt; | -a &lt;attribute-list,&gt;]
[ --blocks=&lt;nlb-list,&gt; | -b &lt;nlb-list,&gt; ] [--blocks=&lt;nlb-list,&gt; | -b &lt;nlb-list,&gt;]
[ --slbs=&lt;slba-list,&gt; | -s &lt;slba-list,&gt; ] [--slbs=&lt;slba-list,&gt; | -s &lt;slba-list,&gt;]
[ --ad | -d ] [ --idw | -w ] [ --idr | -r ] [--ad=&lt;deallocate&gt; | -d &lt;deallocate&gt;]
[ --cdw11=&lt;cdw11&gt; | -c &lt;cdw11&gt; ]</pre> [--idw=&lt;write&gt; | -w &lt;write&gt;] [--idr=&lt;read&gt; | -r &lt;read&gt;]
[--cdw11=&lt;cdw11&gt; | -c &lt;cdw11&gt;]
[--output-format=&lt;fmt&gt; | -o &lt;fmt&gt;] [--verbose | -v]</pre>
<div class="attribution"> <div class="attribution">
</div></div> </div></div>
</div> </div>
@ -873,6 +875,29 @@ any settings from the flags may have provided.</p></div>
specifying individual attributes specifying individual attributes
</p> </p>
</dd> </dd>
<dt class="hdlist1">
-o &lt;fmt&gt;
</dt>
<dt class="hdlist1">
--output-format=&lt;fmt&gt;
</dt>
<dd>
<p>
Set the reporting format to <em>normal</em>, <em>json</em> or <em>binary</em>. Only one
output format can be used at a time.
</p>
</dd>
<dt class="hdlist1">
-v
</dt>
<dt class="hdlist1">
--verbose
</dt>
<dd>
<p>
Increase the information detail in the output.
</p>
</dd>
</dl></div> </dl></div>
</div> </div>
</div> </div>
@ -893,7 +918,7 @@ any settings from the flags may have provided.</p></div>
<div id="footer"> <div id="footer">
<div id="footer-text"> <div id="footer-text">
Last updated Last updated
2023-09-29 08:33:07 CEST 2023-12-21 15:49:29 CET
</div> </div>
</div> </div>
</body> </body>

View file

@ -8,13 +8,14 @@ nvme-dsm - Send NVMe Data Set Management, return results
SYNOPSIS SYNOPSIS
-------- --------
[verse] [verse]
'nvme dsm' <device> [ --namespace-id=<nsid> | -n <nsid> ] 'nvme dsm' <device> [--namespace-id=<nsid> | -n <nsid>]
[ --ctx-attrs=<attribute-list,> | -a <attribute-list,> ] [--ctx-attrs=<attribute-list,> | -a <attribute-list,>]
[ --blocks=<nlb-list,> | -b <nlb-list,> ] [--blocks=<nlb-list,> | -b <nlb-list,>]
[ --slbs=<slba-list,> | -s <slba-list,> ] [--slbs=<slba-list,> | -s <slba-list,>]
[ --ad | -d ] [ --idw | -w ] [ --idr | -r ] [--ad=<deallocate> | -d <deallocate>]
[ --cdw11=<cdw11> | -c <cdw11> ] [--idw=<write> | -w <write>] [--idr=<read> | -r <read>]
[--cdw11=<cdw11> | -c <cdw11>]
[--output-format=<fmt> | -o <fmt>] [--verbose | -v]
DESCRIPTION DESCRIPTION
----------- -----------
@ -73,6 +74,15 @@ OPTIONS
All the command command dword 11 attributes. Use exclusive from All the command command dword 11 attributes. Use exclusive from
specifying individual attributes specifying individual attributes
-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 EXAMPLES
-------- --------
No examples yet No examples yet

View file

@ -2,12 +2,12 @@
.\" Title: nvme-effects-log .\" Title: nvme-effects-log
.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] .\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/> .\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
.\" Date: 06/30/2023 .\" Date: 12/21/2023
.\" Manual: NVMe Manual .\" Manual: NVMe Manual
.\" Source: NVMe .\" Source: NVMe
.\" Language: English .\" Language: English
.\" .\"
.TH "NVME\-EFFECTS\-LOG" "1" "06/30/2023" "NVMe" "NVMe Manual" .TH "NVME\-EFFECTS\-LOG" "1" "12/21/2023" "NVMe" "NVMe Manual"
.\" ----------------------------------------------------------------- .\" -----------------------------------------------------------------
.\" * Define some portability stuff .\" * Define some portability stuff
.\" ----------------------------------------------------------------- .\" -----------------------------------------------------------------
@ -32,9 +32,8 @@ nvme-effects-log \- Send NVMe Command Effects log page request, returns result a
.SH "SYNOPSIS" .SH "SYNOPSIS"
.sp .sp
.nf .nf
\fInvme effects\-log\fR <device> [\-\-output\-format=<fmt> | \-o <fmt>] \fInvme effects\-log\fR <device> [\-\-human\-readable | \-H] [\-\-raw\-binary | \-b]
[\-\-human\-readable | \-H] [\-\-output\-format=<fmt> | \-o <fmt>] [\-\-verbose | \-v]
[\-\-raw\-binary | \-b]
.fi .fi
.SH "DESCRIPTION" .SH "DESCRIPTION"
.sp .sp
@ -45,11 +44,6 @@ The <device> parameter is mandatory and should be the NVMe character device (ex:
On success, the returned command effects log structure will be printed for each command that is supported\&. On success, the returned command effects log structure will be printed for each command that is supported\&.
.SH "OPTIONS" .SH "OPTIONS"
.PP .PP
\-o <format>, \-\-output\-format=<format>
.RS 4
This option will set the reporting format to normal, json, or binary\&. Only one output format can be used at a time\&.
.RE
.PP
\-H, \-\-human\-readable \-H, \-\-human\-readable
.RS 4 .RS 4
This option will parse and format many of the bit fields into a human\-readable format\&. This option will parse and format many of the bit fields into a human\-readable format\&.
@ -59,6 +53,20 @@ This option will parse and format many of the bit fields into a human\-readable
.RS 4 .RS 4
This option will print the raw buffer to stdout\&. Structure is not parsed by program\&. This overrides the human\-readable option\&. This option will print the raw buffer to stdout\&. Structure is not parsed by program\&. This overrides the human\-readable option\&.
.RE .RE
.PP
\-o <fmt>, \-\-output\-format=<fmt>
.RS 4
Set the reporting format to
\fInormal\fR,
\fIjson\fR
or
\fIbinary\fR\&. Only one output format can be used at a time\&.
.RE
.PP
\-v, \-\-verbose
.RS 4
Increase the information detail in the output\&.
.RE
.SH "EXAMPLES" .SH "EXAMPLES"
.sp .sp
.RS 4 .RS 4

View file

@ -749,9 +749,8 @@ nvme-effects-log(1) Manual Page
<h2 id="_synopsis">SYNOPSIS</h2> <h2 id="_synopsis">SYNOPSIS</h2>
<div class="sectionbody"> <div class="sectionbody">
<div class="verseblock"> <div class="verseblock">
<pre class="content"><em>nvme effects-log</em> &lt;device&gt; [--output-format=&lt;fmt&gt; | -o &lt;fmt&gt;] <pre class="content"><em>nvme effects-log</em> &lt;device&gt; [--human-readable | -H] [--raw-binary | -b]
[--human-readable | -H] [--output-format=&lt;fmt&gt; | -o &lt;fmt&gt;] [--verbose | -v]</pre>
[--raw-binary | -b]</pre>
<div class="attribution"> <div class="attribution">
</div></div> </div></div>
</div> </div>
@ -772,18 +771,6 @@ for each command that is supported.</p></div>
<div class="sectionbody"> <div class="sectionbody">
<div class="dlist"><dl> <div class="dlist"><dl>
<dt class="hdlist1"> <dt class="hdlist1">
-o &lt;format&gt;
</dt>
<dt class="hdlist1">
--output-format=&lt;format&gt;
</dt>
<dd>
<p>
This option will set the reporting format to normal, json, or binary.
Only one output format can be used at a time.
</p>
</dd>
<dt class="hdlist1">
-H -H
</dt> </dt>
<dt class="hdlist1"> <dt class="hdlist1">
@ -804,7 +791,30 @@ for each command that is supported.</p></div>
<dd> <dd>
<p> <p>
This option will print the raw buffer to stdout. Structure is not This option will print the raw buffer to stdout. Structure is not
parsed by program. This overrides the human-readable option. parsed by program. This overrides the human-readable option.
</p>
</dd>
<dt class="hdlist1">
-o &lt;fmt&gt;
</dt>
<dt class="hdlist1">
--output-format=&lt;fmt&gt;
</dt>
<dd>
<p>
Set the reporting format to <em>normal</em>, <em>json</em> or <em>binary</em>. Only one
output format can be used at a time.
</p>
</dd>
<dt class="hdlist1">
-v
</dt>
<dt class="hdlist1">
--verbose
</dt>
<dd>
<p>
Increase the information detail in the output.
</p> </p>
</dd> </dd>
</dl></div> </dl></div>
@ -847,7 +857,7 @@ Have the program return the raw structure in binary:
<div id="footer"> <div id="footer">
<div id="footer-text"> <div id="footer-text">
Last updated Last updated
2023-09-29 08:33:07 CEST 2023-12-21 15:49:29 CET
</div> </div>
</div> </div>
</body> </body>

View file

@ -3,14 +3,14 @@ nvme-effects-log(1)
NAME NAME
---- ----
nvme-effects-log - Send NVMe Command Effects log page request, returns result and log nvme-effects-log - Send NVMe Command Effects log page request, returns result
and log
SYNOPSIS SYNOPSIS
-------- --------
[verse] [verse]
'nvme effects-log' <device> [--output-format=<fmt> | -o <fmt>] 'nvme effects-log' <device> [--human-readable | -H] [--raw-binary | -b]
[--human-readable | -H] [--output-format=<fmt> | -o <fmt>] [--verbose | -v]
[--raw-binary | -b]
DESCRIPTION DESCRIPTION
----------- -----------
@ -26,11 +26,6 @@ for each command that is supported.
OPTIONS OPTIONS
------- -------
-o <format>::
--output-format=<format>::
This option will set the reporting format to normal, json, or binary.
Only one output format can be used at a time.
-H:: -H::
--human-readable:: --human-readable::
This option will parse and format many of the bit fields into a This option will parse and format many of the bit fields into a
@ -39,7 +34,16 @@ OPTIONS
-b:: -b::
--raw-binary:: --raw-binary::
This option will print the raw buffer to stdout. Structure is not This option will print the raw buffer to stdout. Structure is not
parsed by program. This overrides the human-readable option. parsed by program. This overrides the human-readable option.
-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 EXAMPLES
-------- --------

View file

@ -2,12 +2,12 @@
.\" Title: nvme-endurance-event-agg-log .\" Title: nvme-endurance-event-agg-log
.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] .\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/> .\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
.\" Date: 06/30/2023 .\" Date: 12/21/2023
.\" Manual: NVMe Manual .\" Manual: NVMe Manual
.\" Source: NVMe .\" Source: NVMe
.\" Language: English .\" Language: English
.\" .\"
.TH "NVME\-ENDURANCE\-EVE" "1" "06/30/2023" "NVMe" "NVMe Manual" .TH "NVME\-ENDURANCE\-EVE" "1" "12/21/2023" "NVMe" "NVMe Manual"
.\" ----------------------------------------------------------------- .\" -----------------------------------------------------------------
.\" * Define some portability stuff .\" * Define some portability stuff
.\" ----------------------------------------------------------------- .\" -----------------------------------------------------------------
@ -34,7 +34,7 @@ nvme-endurance-event-agg-log \- Send NVMe Endurance log page request, returns re
.nf .nf
\fInvme endurance\-event\-agg\-log\fR <device> [\-\-log\-entries=<log_entries> | \-e <log_entries>] \fInvme endurance\-event\-agg\-log\fR <device> [\-\-log\-entries=<log_entries> | \-e <log_entries>]
[\-\-rae | \-r] [\-\-raw\-binary | \-b] [\-\-rae | \-r] [\-\-raw\-binary | \-b]
[\-\-output\-format=<fmt> | \-o <fmt>] [\-\-output\-format=<fmt> | \-o <fmt>] [\-\-verbose | \-v]
.fi .fi
.SH "DESCRIPTION" .SH "DESCRIPTION"
.sp .sp
@ -55,13 +55,19 @@ Retrieve the Endurance Group Event Aggregate Log pending entries\&. This argumen
Retain an Asynchronous Event\&. Retain an Asynchronous Event\&.
.RE .RE
.PP .PP
\-o <format>, \-\-output\-format=<format> \-o <fmt>, \-\-output\-format=<fmt>
.RS 4 .RS 4
Set the reporting format to Set the reporting format to
\fInormal\fR, \fInormal\fR,
\fIjson\fR, or \fIjson\fR
or
\fIbinary\fR\&. Only one output format can be used at a time\&. \fIbinary\fR\&. Only one output format can be used at a time\&.
.RE .RE
.PP
\-v, \-\-verbose
.RS 4
Increase the information detail in the output\&.
.RE
.SH "EXAMPLES" .SH "EXAMPLES"
.sp .sp
.RS 4 .RS 4

View file

@ -751,7 +751,7 @@ nvme-endurance-event-agg-log(1) Manual Page
<div class="verseblock"> <div class="verseblock">
<pre class="content"><em>nvme endurance-event-agg-log</em> &lt;device&gt; [--log-entries=&lt;log_entries&gt; | -e &lt;log_entries&gt;] <pre class="content"><em>nvme endurance-event-agg-log</em> &lt;device&gt; [--log-entries=&lt;log_entries&gt; | -e &lt;log_entries&gt;]
[--rae | -r] [--raw-binary | -b] [--rae | -r] [--raw-binary | -b]
[--output-format=&lt;fmt&gt; | -o &lt;fmt&gt;]</pre> [--output-format=&lt;fmt&gt; | -o &lt;fmt&gt;] [--verbose | -v]</pre>
<div class="attribution"> <div class="attribution">
</div></div> </div></div>
</div> </div>
@ -781,11 +781,11 @@ printed to stdout for another program to parse, or reported in json format.</p><
</dt> </dt>
<dd> <dd>
<p> <p>
Retrieve the Endurance Group Event Aggregate Log pending entries. Retrieve the Endurance Group Event Aggregate Log pending entries.
This argument is mandatory and its success may depend on the device&#8217;s This argument is mandatory and its success may depend on the device&#8217;s
statistics to provide this log For More details see NVM Express 1.4 Spec. statistics to provide this log For More details see NVM Express 1.4 Spec.
Section 5.14.1.15. The maximum number of log entries supported is 2044 Section 5.14.1.15. The maximum number of log entries supported is 2044
for the device. for the device.
</p> </p>
</dd> </dd>
<dt class="hdlist1"> <dt class="hdlist1">
@ -800,15 +800,26 @@ printed to stdout for another program to parse, or reported in json format.</p><
</p> </p>
</dd> </dd>
<dt class="hdlist1"> <dt class="hdlist1">
-o &lt;format&gt; -o &lt;fmt&gt;
</dt> </dt>
<dt class="hdlist1"> <dt class="hdlist1">
--output-format=&lt;format&gt; --output-format=&lt;fmt&gt;
</dt> </dt>
<dd> <dd>
<p> <p>
Set the reporting format to <em>normal</em>, <em>json</em>, or Set the reporting format to <em>normal</em>, <em>json</em> or <em>binary</em>. Only one
<em>binary</em>. Only one output format can be used at a time. output format can be used at a time.
</p>
</dd>
<dt class="hdlist1">
-v
</dt>
<dt class="hdlist1">
--verbose
</dt>
<dd>
<p>
Increase the information detail in the output.
</p> </p>
</dd> </dd>
</dl></div> </dl></div>
@ -851,7 +862,7 @@ Print the raw Endurance log to a file:
<div id="footer"> <div id="footer">
<div id="footer-text"> <div id="footer-text">
Last updated Last updated
2023-09-29 08:33:07 CEST 2023-12-21 15:49:29 CET
</div> </div>
</div> </div>
</body> </body>

View file

@ -10,7 +10,7 @@ SYNOPSIS
[verse] [verse]
'nvme endurance-event-agg-log' <device> [--log-entries=<log_entries> | -e <log_entries>] 'nvme endurance-event-agg-log' <device> [--log-entries=<log_entries> | -e <log_entries>]
[--rae | -r] [--raw-binary | -b] [--rae | -r] [--raw-binary | -b]
[--output-format=<fmt> | -o <fmt>] [--output-format=<fmt> | -o <fmt>] [--verbose | -v]
DESCRIPTION DESCRIPTION
----------- -----------
@ -29,20 +29,24 @@ OPTIONS
------- -------
-e <log_entries>:: -e <log_entries>::
--log-entries=<log_entries>:: --log-entries=<log_entries>::
Retrieve the Endurance Group Event Aggregate Log pending entries. Retrieve the Endurance Group Event Aggregate Log pending entries.
This argument is mandatory and its success may depend on the device's This argument is mandatory and its success may depend on the device's
statistics to provide this log For More details see NVM Express 1.4 Spec. statistics to provide this log For More details see NVM Express 1.4 Spec.
Section 5.14.1.15. The maximum number of log entries supported is 2044 Section 5.14.1.15. The maximum number of log entries supported is 2044
for the device. for the device.
-r:: -r::
--rae:: --rae::
Retain an Asynchronous Event. Retain an Asynchronous Event.
-o <format>:: -o <fmt>::
--output-format=<format>:: --output-format=<fmt>::
Set the reporting format to 'normal', 'json', or Set the reporting format to 'normal', 'json' or 'binary'. Only one
'binary'. Only one output format can be used at a time. output format can be used at a time.
-v::
--verbose::
Increase the information detail in the output.
EXAMPLES EXAMPLES
-------- --------

View file

@ -2,12 +2,12 @@
.\" Title: nvme-endurance-log .\" Title: nvme-endurance-log
.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] .\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/> .\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
.\" Date: 06/30/2023 .\" Date: 12/21/2023
.\" Manual: NVMe Manual .\" Manual: NVMe Manual
.\" Source: NVMe .\" Source: NVMe
.\" Language: English .\" Language: English
.\" .\"
.TH "NVME\-ENDURANCE\-LOG" "1" "06/30/2023" "NVMe" "NVMe Manual" .TH "NVME\-ENDURANCE\-LOG" "1" "12/21/2023" "NVMe" "NVMe Manual"
.\" ----------------------------------------------------------------- .\" -----------------------------------------------------------------
.\" * Define some portability stuff .\" * Define some portability stuff
.\" ----------------------------------------------------------------- .\" -----------------------------------------------------------------
@ -33,7 +33,7 @@ nvme-endurance-log \- Send NVMe Endurance log page request, returns result and l
.sp .sp
.nf .nf
\fInvme endurance\-log\fR <device> [\-\-group\-id=<group> | \-g <group>] \fInvme endurance\-log\fR <device> [\-\-group\-id=<group> | \-g <group>]
[\-\-output\-format=<fmt> | \-o <fmt>] [\-\-output\-format=<fmt> | \-o <fmt>] [\-\-verbose | \-v]
.fi .fi
.SH "DESCRIPTION" .SH "DESCRIPTION"
.sp .sp
@ -49,13 +49,19 @@ On success, the returned endurance log structure may be returned in one of sever
The endurance group identifier\&. The endurance group identifier\&.
.RE .RE
.PP .PP
\-o <format>, \-\-output\-format=<format> \-o <fmt>, \-\-output\-format=<fmt>
.RS 4 .RS 4
Set the reporting format to Set the reporting format to
\fInormal\fR, \fInormal\fR,
\fIjson\fR, or \fIjson\fR
or
\fIbinary\fR\&. Only one output format can be used at a time\&. \fIbinary\fR\&. Only one output format can be used at a time\&.
.RE .RE
.PP
\-v, \-\-verbose
.RS 4
Increase the information detail in the output\&.
.RE
.SH "EXAMPLES" .SH "EXAMPLES"
.sp .sp
.RS 4 .RS 4

View file

@ -750,7 +750,7 @@ nvme-endurance-log(1) Manual Page
<div class="sectionbody"> <div class="sectionbody">
<div class="verseblock"> <div class="verseblock">
<pre class="content"><em>nvme endurance-log</em> &lt;device&gt; [--group-id=&lt;group&gt; | -g &lt;group&gt;] <pre class="content"><em>nvme endurance-log</em> &lt;device&gt; [--group-id=&lt;group&gt; | -g &lt;group&gt;]
[--output-format=&lt;fmt&gt; | -o &lt;fmt&gt;]</pre> [--output-format=&lt;fmt&gt; | -o &lt;fmt&gt;] [--verbose | -v]</pre>
<div class="attribution"> <div class="attribution">
</div></div> </div></div>
</div> </div>
@ -783,15 +783,26 @@ printed to stdout for another program to parse, or reported in json format.</p><
</p> </p>
</dd> </dd>
<dt class="hdlist1"> <dt class="hdlist1">
-o &lt;format&gt; -o &lt;fmt&gt;
</dt> </dt>
<dt class="hdlist1"> <dt class="hdlist1">
--output-format=&lt;format&gt; --output-format=&lt;fmt&gt;
</dt> </dt>
<dd> <dd>
<p> <p>
Set the reporting format to <em>normal</em>, <em>json</em>, or Set the reporting format to <em>normal</em>, <em>json</em> or <em>binary</em>. Only one
<em>binary</em>. Only one output format can be used at a time. output format can be used at a time.
</p>
</dd>
<dt class="hdlist1">
-v
</dt>
<dt class="hdlist1">
--verbose
</dt>
<dd>
<p>
Increase the information detail in the output.
</p> </p>
</dd> </dd>
</dl></div> </dl></div>
@ -834,7 +845,7 @@ Print the raw Endurance log to a file:
<div id="footer"> <div id="footer">
<div id="footer-text"> <div id="footer-text">
Last updated Last updated
2023-09-29 08:33:07 CEST 2023-12-21 15:49:29 CET
</div> </div>
</div> </div>
</body> </body>

View file

@ -9,7 +9,7 @@ SYNOPSIS
-------- --------
[verse] [verse]
'nvme endurance-log' <device> [--group-id=<group> | -g <group>] 'nvme endurance-log' <device> [--group-id=<group> | -g <group>]
[--output-format=<fmt> | -o <fmt>] [--output-format=<fmt> | -o <fmt>] [--verbose | -v]
DESCRIPTION DESCRIPTION
----------- -----------
@ -29,10 +29,14 @@ OPTIONS
--group-id=<group>:: --group-id=<group>::
The endurance group identifier. The endurance group identifier.
-o <format>:: -o <fmt>::
--output-format=<format>:: --output-format=<fmt>::
Set the reporting format to 'normal', 'json', or Set the reporting format to 'normal', 'json' or 'binary'. Only one
'binary'. Only one output format can be used at a time. output format can be used at a time.
-v::
--verbose::
Increase the information detail in the output.
EXAMPLES EXAMPLES
-------- --------

View file

@ -2,12 +2,12 @@
.\" Title: nvme-error-log .\" Title: nvme-error-log
.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] .\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/> .\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
.\" Date: 06/30/2023 .\" Date: 12/21/2023
.\" Manual: NVMe Manual .\" Manual: NVMe Manual
.\" Source: NVMe .\" Source: NVMe
.\" Language: English .\" Language: English
.\" .\"
.TH "NVME\-ERROR\-LOG" "1" "06/30/2023" "NVMe" "NVMe Manual" .TH "NVME\-ERROR\-LOG" "1" "12/21/2023" "NVMe" "NVMe Manual"
.\" ----------------------------------------------------------------- .\" -----------------------------------------------------------------
.\" * Define some portability stuff .\" * Define some portability stuff
.\" ----------------------------------------------------------------- .\" -----------------------------------------------------------------
@ -32,9 +32,9 @@ nvme-error-log \- Send NVME Error log page request, return result and log
.SH "SYNOPSIS" .SH "SYNOPSIS"
.sp .sp
.nf .nf
\fInvme error\-log\fR <device> [\-\-log\-entries=<entries> | \-e <entries>] \fInvme error\-log\fR <device> [\-\-log\-entries=<entries> | \-e <entries>]
[\-\-raw\-binary | \-b] [\-\-raw\-binary | \-b]
[\-\-output\-format=<fmt> | \-o <fmt>] [\-\-output\-format=<fmt> | \-o <fmt>] [\-\-verbose | \-v]
.fi .fi
.SH "DESCRIPTION" .SH "DESCRIPTION"
.sp .sp
@ -55,13 +55,19 @@ Specifies how many log entries the program should request from the device\&. Thi
Print the raw error log buffer to stdout\&. Print the raw error log buffer to stdout\&.
.RE .RE
.PP .PP
\-o <format>, \-\-output\-format=<format> \-o <fmt>, \-\-output\-format=<fmt>
.RS 4 .RS 4
Set the reporting format to Set the reporting format to
\fInormal\fR, \fInormal\fR,
\fIjson\fR, or \fIjson\fR
or
\fIbinary\fR\&. Only one output format can be used at a time\&. \fIbinary\fR\&. Only one output format can be used at a time\&.
.RE .RE
.PP
\-v, \-\-verbose
.RS 4
Increase the information detail in the output\&.
.RE
.SH "EXAMPLES" .SH "EXAMPLES"
.sp .sp
.RS 4 .RS 4

View file

@ -749,9 +749,9 @@ nvme-error-log(1) Manual Page
<h2 id="_synopsis">SYNOPSIS</h2> <h2 id="_synopsis">SYNOPSIS</h2>
<div class="sectionbody"> <div class="sectionbody">
<div class="verseblock"> <div class="verseblock">
<pre class="content"><em>nvme error-log</em> &lt;device&gt; [--log-entries=&lt;entries&gt; | -e &lt;entries&gt;] <pre class="content"><em>nvme error-log</em> &lt;device&gt; [--log-entries=&lt;entries&gt; | -e &lt;entries&gt;]
[--raw-binary | -b] [--raw-binary | -b]
[--output-format=&lt;fmt&gt; | -o &lt;fmt&gt;]</pre> [--output-format=&lt;fmt&gt; | -o &lt;fmt&gt;] [--verbose | -v]</pre>
<div class="attribution"> <div class="attribution">
</div></div> </div></div>
</div> </div>
@ -798,15 +798,26 @@ printed to stdout for another program to parse.</p></div>
</p> </p>
</dd> </dd>
<dt class="hdlist1"> <dt class="hdlist1">
-o &lt;format&gt; -o &lt;fmt&gt;
</dt> </dt>
<dt class="hdlist1"> <dt class="hdlist1">
--output-format=&lt;format&gt; --output-format=&lt;fmt&gt;
</dt> </dt>
<dd> <dd>
<p> <p>
Set the reporting format to <em>normal</em>, <em>json</em>, or Set the reporting format to <em>normal</em>, <em>json</em> or <em>binary</em>. Only one
<em>binary</em>. Only one output format can be used at a time. output format can be used at a time.
</p>
</dd>
<dt class="hdlist1">
-v
</dt>
<dt class="hdlist1">
--verbose
</dt>
<dd>
<p>
Increase the information detail in the output.
</p> </p>
</dd> </dd>
</dl></div> </dl></div>
@ -849,7 +860,7 @@ Print the raw output to a file:
<div id="footer"> <div id="footer">
<div id="footer-text"> <div id="footer-text">
Last updated Last updated
2023-09-29 08:33:07 CEST 2023-12-21 15:49:29 CET
</div> </div>
</div> </div>
</body> </body>

View file

@ -8,9 +8,9 @@ nvme-error-log - Send NVME Error log page request, return result and log
SYNOPSIS SYNOPSIS
-------- --------
[verse] [verse]
'nvme error-log' <device> [--log-entries=<entries> | -e <entries>] 'nvme error-log' <device> [--log-entries=<entries> | -e <entries>]
[--raw-binary | -b] [--raw-binary | -b]
[--output-format=<fmt> | -o <fmt>] [--output-format=<fmt> | -o <fmt>] [--verbose | -v]
DESCRIPTION DESCRIPTION
----------- -----------
@ -37,11 +37,14 @@ OPTIONS
--raw-binary:: --raw-binary::
Print the raw error log buffer to stdout. Print the raw error log buffer to stdout.
-o <format>:: -o <fmt>::
--output-format=<format>:: --output-format=<fmt>::
Set the reporting format to 'normal', 'json', or Set the reporting format to 'normal', 'json' or 'binary'. Only one
'binary'. Only one output format can be used at a time. output format can be used at a time.
-v::
--verbose::
Increase the information detail in the output.
EXAMPLES EXAMPLES
-------- --------

View file

@ -2,12 +2,12 @@
.\" Title: nvme-fdp-configs .\" Title: nvme-fdp-configs
.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] .\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/> .\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
.\" Date: 06/30/2023 .\" Date: 12/21/2023
.\" Manual: NVMe Manual .\" Manual: NVMe Manual
.\" Source: NVMe .\" Source: NVMe
.\" Language: English .\" Language: English
.\" .\"
.TH "NVME\-FDP\-CONFIGS" "1" "06/30/2023" "NVMe" "NVMe Manual" .TH "NVME\-FDP\-CONFIGS" "1" "12/21/2023" "NVMe" "NVMe Manual"
.\" ----------------------------------------------------------------- .\" -----------------------------------------------------------------
.\" * Define some portability stuff .\" * Define some portability stuff
.\" ----------------------------------------------------------------- .\" -----------------------------------------------------------------
@ -33,9 +33,8 @@ nvme-fdp-configs \- Get Flexible Data Placement Configurations
.sp .sp
.nf .nf
\fInvme fdp configs\fR <device> [\-\-endgrp\-id=<NUM> | \-e <NUM>] \fInvme fdp configs\fR <device> [\-\-endgrp\-id=<NUM> | \-e <NUM>]
[\-\-human\-readable | \-H] [\-\-human\-readable | \-H] [\-\-raw\-binary | \-b]
[\-\-raw\-binary | \-b] [\-\-output\-format=<fmt> | \-o <fmt>]
[\-\-output\-format=<FMT> | \-o <FMT>]
.fi .fi
.SH "DESCRIPTION" .SH "DESCRIPTION"
.sp .sp
@ -57,7 +56,7 @@ Parse, print and describe individual parts of bitfields\&.
Print the raw buffer to the standard output stream\&. Print the raw buffer to the standard output stream\&.
.RE .RE
.PP .PP
\-o <format>, \-\-output\-format=<format> \-o <fmt>, \-\-output\-format=<fmt>
.RS 4 .RS 4
Set the reporting format to Set the reporting format to
\fInormal\fR, \fInormal\fR,

View file

@ -750,9 +750,8 @@ nvme-fdp-configs(1) Manual Page
<div class="sectionbody"> <div class="sectionbody">
<div class="verseblock"> <div class="verseblock">
<pre class="content"><em>nvme fdp configs</em> &lt;device&gt; [--endgrp-id=&lt;NUM&gt; | -e &lt;NUM&gt;] <pre class="content"><em>nvme fdp configs</em> &lt;device&gt; [--endgrp-id=&lt;NUM&gt; | -e &lt;NUM&gt;]
[--human-readable | -H] [--human-readable | -H] [--raw-binary | -b]
[--raw-binary | -b] [--output-format=&lt;fmt&gt; | -o &lt;fmt&gt;]</pre>
[--output-format=&lt;FMT&gt; | -o &lt;FMT&gt;]</pre>
<div class="attribution"> <div class="attribution">
</div></div> </div></div>
</div> </div>
@ -802,10 +801,10 @@ the possible configurations for Flexible Data Placement.</p></div>
</p> </p>
</dd> </dd>
<dt class="hdlist1"> <dt class="hdlist1">
-o &lt;format&gt; -o &lt;fmt&gt;
</dt> </dt>
<dt class="hdlist1"> <dt class="hdlist1">
--output-format=&lt;format&gt; --output-format=&lt;fmt&gt;
</dt> </dt>
<dd> <dd>
<p> <p>
@ -827,7 +826,7 @@ the possible configurations for Flexible Data Placement.</p></div>
<div id="footer"> <div id="footer">
<div id="footer-text"> <div id="footer-text">
Last updated Last updated
2023-09-29 08:33:07 CEST 2023-12-21 15:49:29 CET
</div> </div>
</div> </div>
</body> </body>

View file

@ -9,9 +9,8 @@ SYNOPSIS
-------- --------
[verse] [verse]
'nvme fdp configs' <device> [--endgrp-id=<NUM> | -e <NUM>] 'nvme fdp configs' <device> [--endgrp-id=<NUM> | -e <NUM>]
[--human-readable | -H] [--human-readable | -H] [--raw-binary | -b]
[--raw-binary | -b] [--output-format=<fmt> | -o <fmt>]
[--output-format=<FMT> | -o <FMT>]
DESCRIPTION DESCRIPTION
----------- -----------
@ -32,8 +31,8 @@ OPTIONS
--raw-binary:: --raw-binary::
Print the raw buffer to the standard output stream. Print the raw buffer to the standard output stream.
-o <format>:: -o <fmt>::
--output-format=<format>:: --output-format=<fmt>::
Set the reporting format to 'normal', 'json', or 'binary'. Only one Set the reporting format to 'normal', 'json', or 'binary'. Only one
output format can be used at a time. output format can be used at a time.

View file

@ -2,12 +2,12 @@
.\" Title: nvme-fdp-events .\" Title: nvme-fdp-events
.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] .\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/> .\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
.\" Date: 06/30/2023 .\" Date: 12/21/2023
.\" Manual: NVMe Manual .\" Manual: NVMe Manual
.\" Source: NVMe .\" Source: NVMe
.\" Language: English .\" Language: English
.\" .\"
.TH "NVME\-FDP\-EVENTS" "1" "06/30/2023" "NVMe" "NVMe Manual" .TH "NVME\-FDP\-EVENTS" "1" "12/21/2023" "NVMe" "NVMe Manual"
.\" ----------------------------------------------------------------- .\" -----------------------------------------------------------------
.\" * Define some portability stuff .\" * Define some portability stuff
.\" ----------------------------------------------------------------- .\" -----------------------------------------------------------------
@ -32,10 +32,8 @@ nvme-fdp-events \- Get Flexible Data Placement Events
.SH "SYNOPSIS" .SH "SYNOPSIS"
.sp .sp
.nf .nf
\fInvme fdp events\fR <device> [\-\-endgrp\-id=<NUM> | \-e <NUM>] \fInvme fdp events\fR <device> [\-\-endgrp\-id=<NUM> | \-e <NUM>] [\-\-host\-events | \-E]
[\-\-host\-events | \-E] [\-\-raw\-binary | \-b] [\-\-output\-format=<fmt> | \-o <fmt>]
[\-\-raw\-binary | \-b]
[\-\-output\-format=<FMT> | \-o <FMT>]
.fi .fi
.SH "DESCRIPTION" .SH "DESCRIPTION"
.sp .sp
@ -57,7 +55,7 @@ Request the controller to report host events\&.
Print the raw buffer to the standard output stream\&. Print the raw buffer to the standard output stream\&.
.RE .RE
.PP .PP
\-o <format>, \-\-output\-format=<format> \-o <fmt>, \-\-output\-format=<fmt>
.RS 4 .RS 4
Set the reporting format to Set the reporting format to
\fInormal\fR, \fInormal\fR,

View file

@ -749,10 +749,8 @@ nvme-fdp-events(1) Manual Page
<h2 id="_synopsis">SYNOPSIS</h2> <h2 id="_synopsis">SYNOPSIS</h2>
<div class="sectionbody"> <div class="sectionbody">
<div class="verseblock"> <div class="verseblock">
<pre class="content"><em>nvme fdp events</em> &lt;device&gt; [--endgrp-id=&lt;NUM&gt; | -e &lt;NUM&gt;] <pre class="content"><em>nvme fdp events</em> &lt;device&gt; [--endgrp-id=&lt;NUM&gt; | -e &lt;NUM&gt;] [--host-events | -E]
[--host-events | -E] [--raw-binary | -b] [--output-format=&lt;fmt&gt; | -o &lt;fmt&gt;]</pre>
[--raw-binary | -b]
[--output-format=&lt;FMT&gt; | -o &lt;FMT&gt;]</pre>
<div class="attribution"> <div class="attribution">
</div></div> </div></div>
</div> </div>
@ -802,10 +800,10 @@ Units and media usage in an Endurance Group.</p></div>
</p> </p>
</dd> </dd>
<dt class="hdlist1"> <dt class="hdlist1">
-o &lt;format&gt; -o &lt;fmt&gt;
</dt> </dt>
<dt class="hdlist1"> <dt class="hdlist1">
--output-format=&lt;format&gt; --output-format=&lt;fmt&gt;
</dt> </dt>
<dd> <dd>
<p> <p>
@ -827,7 +825,7 @@ Units and media usage in an Endurance Group.</p></div>
<div id="footer"> <div id="footer">
<div id="footer-text"> <div id="footer-text">
Last updated Last updated
2023-09-29 08:33:07 CEST 2023-12-21 15:49:29 CET
</div> </div>
</div> </div>
</body> </body>

View file

@ -8,10 +8,8 @@ nvme-fdp-events - Get Flexible Data Placement Events
SYNOPSIS SYNOPSIS
-------- --------
[verse] [verse]
'nvme fdp events' <device> [--endgrp-id=<NUM> | -e <NUM>] 'nvme fdp events' <device> [--endgrp-id=<NUM> | -e <NUM>] [--host-events | -E]
[--host-events | -E] [--raw-binary | -b] [--output-format=<fmt> | -o <fmt>]
[--raw-binary | -b]
[--output-format=<FMT> | -o <FMT>]
DESCRIPTION DESCRIPTION
----------- -----------
@ -32,8 +30,8 @@ OPTIONS
--raw-binary:: --raw-binary::
Print the raw buffer to the standard output stream. Print the raw buffer to the standard output stream.
-o <format>:: -o <fmt>::
--output-format=<format>:: --output-format=<fmt>::
Set the reporting format to 'normal', 'json', or 'binary'. Only one Set the reporting format to 'normal', 'json', or 'binary'. Only one
output format can be used at a time. output format can be used at a time.

View file

@ -2,12 +2,12 @@
.\" Title: nvme-fdp-set-events .\" Title: nvme-fdp-set-events
.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] .\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/> .\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
.\" Date: 06/30/2023 .\" Date: 12/21/2023
.\" Manual: NVMe Manual .\" Manual: NVMe Manual
.\" Source: NVMe .\" Source: NVMe
.\" Language: English .\" Language: English
.\" .\"
.TH "NVME\-FDP\-SET\-EVEN" "1" "06/30/2023" "NVMe" "NVMe Manual" .TH "NVME\-FDP\-SET\-EVEN" "1" "12/21/2023" "NVMe" "NVMe Manual"
.\" ----------------------------------------------------------------- .\" -----------------------------------------------------------------
.\" * Define some portability stuff .\" * Define some portability stuff
.\" ----------------------------------------------------------------- .\" -----------------------------------------------------------------
@ -33,9 +33,8 @@ nvme-fdp-set-events \- Enable or disable FDP events
.sp .sp
.nf .nf
\fInvme fdp set\-events\fR <device> [\-\-namespace\-id=<NUM> | \-n <NUM>] \fInvme fdp set\-events\fR <device> [\-\-namespace\-id=<NUM> | \-n <NUM>]
[\-\-placement\-handle=<NUM> | \-p <NUM>] [\-\-placement\-handle=<NUM> | \-p <NUM>] [\-\-enable | \-e]
[\-\-enable | \-e] [\-\-event\-types=<NUM,> | \-t <NUM,>]
[\-\-event\-types=<NUM,> | \-t <NUM,>]
.fi .fi
.SH "DESCRIPTION" .SH "DESCRIPTION"
.sp .sp
@ -52,7 +51,7 @@ Namespace identifier\&.
Print the raw buffer to the standard output stream\&. Print the raw buffer to the standard output stream\&.
.RE .RE
.PP .PP
\-o <format>, \-\-output\-format=<format> \-o <fmt>, \-\-output\-format=<fmt>
.RS 4 .RS 4
Set the reporting format to Set the reporting format to
\fInormal\fR, \fInormal\fR,

Some files were not shown because too many files have changed in this diff Show more