stacctl - Man Page

STorage Appliance Connector (STAC) utility program

Synopsis

stacctl [Options...] {COMMAND} [Options...]

Description

stacctl is a tool that can be used to communicate with the stacd(8) daemon to retrieve operational data.

Commands

The following commands are understood:

tron

Trace ON. Enable code tracing, which is to say that lots of debug information will be printed to the syslog (e.g. systemd-journal).

troff

Trace OFF. Disable code tracing.

status

Show runtime status information.

ls

Show the list of I/O controllers. This will list all the I/O controllers configured in stacd.conf(5) as well as those discovered by the stafd(8) daemon.

Options

The following options are understood:

-h,  --help

Print the help text and exit.

--version

Print the version string and exit.

-d,  --detailed

Print additional details.

Exit Status

On success, 0 is returned; otherwise, a non-zero failure code is returned.

Examples

Example 1. List I/O controllers

$ stacctl ls --detailed
[{'connect attempts': 0,
  'device': 'nvme1',
  'host-iface': '',
  'host-traddr': '',
  'hostid': '3e518ec3-72ec-46a5-a603-2510e3140e29',
  'hostnqn': 'nqn.2014-08.org.nvmexpress:uuid:13730573-e8d7-446e-81f6-042a497846d5',
  'model': 'Linux',
  'retry connect timer': '60.0s [off]',
  'serial': '8d22fa96da912fb13f5a',
  'subsysnqn': 'nqn.1988-11.com.dell:PowerSANxxx:01:20210225100113-454f73093ceb4847a7bdfc6e34aedead',
  'traddr': '::1',
  'transport': 'tcp',
  'trsvcid': '8009'},
 {'connect attempts': 0,
  'device': 'nvme2',
  'host-iface': '',
  'host-traddr': '',
  'hostid': '3e518ec3-72ec-46a5-a603-2510e3140e29',
  'hostnqn': 'nqn.2014-08.org.nvmexpress:uuid:13730573-e8d7-446e-81f6-042a497846d5',
  'model': 'Linux',
  'retry connect timer': '60.0s [off]',
  'serial': 'a9987ae2fd173d100fd0',
  'subsysnqn': 'nqn.1988-11.com.dell:PowerSANxxx:01:20210225100113-454f73093ceb4847a7bdfc6e34aebeef',
  'traddr': '::1',
  'transport': 'tcp',
  'trsvcid': '8009'},
 {'connect attempts': 0,
  'device': 'nvme3',
  'host-iface': '',
  'host-traddr': '',
  'hostid': '3e518ec3-72ec-46a5-a603-2510e3140e29',
  'hostnqn': 'nqn.2014-08.org.nvmexpress:uuid:13730573-e8d7-446e-81f6-042a497846d5',
  'model': 'Linux',
  'retry connect timer': '60.0s [off]',
  'serial': '13e122f1a8122bed5a8d',
  'subsysnqn': 'nqn.1988-11.com.dell:PowerSANxxx:01:20210225100113-454f73093ceb4847a7bdfc6e34ae8e28',
  'traddr': '::1',
  'transport': 'tcp',
  'trsvcid': '8009'}]

Example 2. Disable tracing

$ stacctl troff

Example 3.  Show stacd(8) operational status.

$ stacctl status
{'config soak timer': '1.5s [off]',
 'controllers': [{'connect attempts': 0,
                  'device': 'nvme1',
                  'host-iface': '',
                  'host-traddr': '',
                  'hostid': '3e518ec3-72ec-46a5-a603-2510e3140e29',
                  'hostnqn': 'nqn.2014-08.org.nvmexpress:uuid:13730573-e8d7-446e-81f6-042a497846d5',
                  'model': 'Linux',
                  'retry connect timer': '60.0s [off]',
                  'serial': '8d22fa96da912fb13f5a',
                  'subsysnqn': 'nqn.1988-11.com.dell:PowerSANxxx:01:20210225100113-454f73093ceb4847a7bdfc6e34aedead',
                  'traddr': '::1',
                  'transport': 'tcp',
                  'trsvcid': '8009'},
                 {'connect attempts': 0,
                  'device': 'nvme2',
                  'host-iface': '',
                  'host-traddr': '',
                  'hostid': '3e518ec3-72ec-46a5-a603-2510e3140e29',
                  'hostnqn': 'nqn.2014-08.org.nvmexpress:uuid:13730573-e8d7-446e-81f6-042a497846d5',
                  'model': 'Linux',
                  'retry connect timer': '60.0s [off]',
                  'serial': 'a9987ae2fd173d100fd0',
                  'subsysnqn': 'nqn.1988-11.com.dell:PowerSANxxx:01:20210225100113-454f73093ceb4847a7bdfc6e34aebeef',
                  'traddr': '::1',
                  'transport': 'tcp',
                  'trsvcid': '8009'},
                 {'connect attempts': 0,
                  'device': 'nvme3',
                  'host-iface': '',
                  'host-traddr': '',
                  'hostid': '3e518ec3-72ec-46a5-a603-2510e3140e29',
                  'hostnqn': 'nqn.2014-08.org.nvmexpress:uuid:13730573-e8d7-446e-81f6-042a497846d5',
                  'model': 'Linux',
                  'retry connect timer': '60.0s [off]',
                  'serial': '13e122f1a8122bed5a8d',
                  'subsysnqn': 'nqn.1988-11.com.dell:PowerSANxxx:01:20210225100113-454f73093ceb4847a7bdfc6e34ae8e28',
                  'traddr': '::1',
                  'transport': 'tcp',
                  'trsvcid': '8009'}],
 'log-level': 'DEBUG',
 'tron': True}

See Also

stacd.conf(5), stacd(8) ()

Referenced By

nvme-stas(7), stacd(8).

nvme-stas 1.2-rc3