Using the CLI for managing gateway information

Get NVMe-oF gateway information and set log levels by using the command-line interface (CLI).

Before you begin

Managing NVMe-oF subsystems with the CLI requires the nvmeof-cli alias setup. For more information about defining the alias, see step 1 of Defining an NVMe-oF subsystem.

About this task

At any point, you can use the -h or --help parameters for command help.
The following parameters are interchangeable:
  • --level and -l
Use the commands listed here to manage your gateway information.

Getting the gateway version

Use the gw version command to retrieve the NVMe-oF gateway version.
nvmeof-cli --format FORMAT --server-address GATEWAY_IP --server-port SERVER_PORT gw version --output log
For example,
[root@host01 ~]# nvmeof-cli --format json --server-address 10.172.19.01 --server port 5500 gw version --output log

Getting gateway information

Use the gw info command to get information about the NVMe-oF gateway.
nvmeof-cli --server-address GATEWAY_IP --server-port SERVER_PORT gw info
For example,
[root@host01 ~]# nvmeof-cli --server-address 10.172.19.01 --server port 5500 gw info

Getting the gateway log level

Use the gw get_log_level command to get the log level for the NVMe-oF gateway.
nvmeof-cli --server-address GATEWAY_IP --server-port SERVER_PORT gw get_log_level
For example,
[root@host01 ~]# nvmeof-cli --server-address 10.172.19.01 --server port 5500 gw get_log_level

Setting the gateway log level

Use the gw set_log_level command to set the log level for the NVMe-oF gateway output.

The available log levels for input are: DEBUG, INFO, WARNING, ERROR, and CRITICAL.

nvmeof-cli --server-address GATEWAY_IP --server-port SERVER_PORT gw set_log_level --level LEVEL
The following example sets the log level to INFO.
[root@host01 ~]# nvmeof-cli --server-address 10.172.19.01 --server port 5500 gw set_log_level --level INFO