Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Rg log doc #2700

Merged
merged 2 commits into from
Feb 11, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
56 changes: 56 additions & 0 deletions Documentation/nvme-reachability-groups-log.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,56 @@
nvme-reachability-groups-log(1)
===============================

NAME
----
nvme-reachability-groups-log - Retrieve Reachability Groups Log, show it

SYNOPSIS
--------
[verse]
'nvme reachability-groups-log' <device> [--groups-only | -g] [--rae | -r]
[--verbose | -v] [--output-format=<fmt> | -o <fmt>]
[--timeout=<timeout>]

DESCRIPTION
-----------
Retrieve Reachability Groups Log, show it

The <device> parameter is mandatory NVMe character device (ex: /dev/nvme0).

On success it returns 0, error code otherwise.

OPTIONS
-------
-g::
--groups-only::
Return Groups Only.

-r::
--rae::
Retain an Asynchronous Event.

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

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

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

EXAMPLES
--------
* Has the program issue a reachability-groups-log
+
------------
# nvme reachability-groups-log /dev/nvme0
------------

NVME
----
Part of the nvme-user suite.
19 changes: 19 additions & 0 deletions completions/_nvme
Original file line number Diff line number Diff line change
Expand Up @@ -113,6 +113,7 @@ _nvme () {
'mgmt-addr-list-log:retrieve management address list log'
'changed-ns-list-log:retrieve changed allocated namespaces log'
'dispersed-ns-participating-nss-log:retrieve dispersed namespace participating NVM subsystems log'
'reachability-groups-log:retrieve reachability groups log'
'version:show the program version'
'ocp:OCP cloud SSD extensions'
'solidigm:Solidigm plug-in extensions'
Expand Down Expand Up @@ -2674,6 +2675,24 @@ _nvme () {
_arguments '*:: :->subcmds'
_describe -t commands "nvme dispersed-ns-participating-nss-log" _dns_psub_log
;;
(reachability-groups-log)
local _rg_log
_caplog=(
/dev/nvme':supply a device to use (required)'
--groups-only':Return Groups Only'
-g':alias for --groups-only'
--rae':Retain an Asynchronous Event'
-r':alias for --rae'
--verbose':Increase the information detail in the output.'
-v':alias for --verbose'
--output-format=':Output format: normal|json|binary'
-o ':alias for --output-format'
--timeout=':value for timeout'
-t ':alias for --timeout'
)
_arguments '*:: :->subcmds'
_describe -t commands "nvme reachability-groups-log" _rg_log
;;
(version)
local _version
_version=(
Expand Down
7 changes: 6 additions & 1 deletion completions/bash-nvme-completion.sh
Original file line number Diff line number Diff line change
Expand Up @@ -504,6 +504,10 @@ nvme_list_opts () {
opts+=" --namespace-id= -n --verbose -v --output-format= -o \
--timeout= -t"
;;
"reachability-groups-log")
opts+=" --groups-only -g --rae -r --verbose -v \
--output-format= -o --timeout= -t"
;;
"version")
opts+=$NO_OPTS
;;
Expand Down Expand Up @@ -1696,7 +1700,8 @@ _nvme_subcmds () {
supported-cap-config-log dim show-topology list-endgrp \
nvme-mi-recv nvme-mi-send get-reg set-reg mgmt-addr-list-log \
rotational-media-info-log changed-alloc-ns-list-log \
io-mgmt-recv io-mgmt-send dispersed-ns-participating-nss-log"
io-mgmt-recv io-mgmt-send dispersed-ns-participating-nss-log \
reachability-groups-log"

# Add plugins:
for plugin in "${!_plugin_subcmds[@]}"; do
Expand Down