diff --git a/Documentation/nvme-reachability-groups-log.txt b/Documentation/nvme-reachability-groups-log.txt new file mode 100644 index 0000000000..6d5379eefe --- /dev/null +++ b/Documentation/nvme-reachability-groups-log.txt @@ -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' [--groups-only | -g] [--rae | -r] + [--verbose | -v] [--output-format= | -o ] + [--timeout=] + +DESCRIPTION +----------- +Retrieve Reachability Groups Log, show it + +The 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 :: +--output-format=:: + Set the reporting format to 'normal', 'json' or 'binary'. Only one + output format can be used at a time. + +-t :: +--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. diff --git a/completions/_nvme b/completions/_nvme index 827b89f5ee..68e97a88e3 100644 --- a/completions/_nvme +++ b/completions/_nvme @@ -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' @@ -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=( diff --git a/completions/bash-nvme-completion.sh b/completions/bash-nvme-completion.sh index c0dfd5b14f..9903603fa2 100644 --- a/completions/bash-nvme-completion.sh +++ b/completions/bash-nvme-completion.sh @@ -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 ;; @@ -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