stacctl(1)

1STACCTL(1)                                                          STACCTL(1)
2
3
4

NAME

6       stacctl - STorage Appliance Connector (STAC) utility program
7

SYNOPSIS

9       stacctl [OPTIONS...] {COMMAND} [OPTIONS...]
10

DESCRIPTION

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

COMMANDS

16       The following commands are understood:
17
18       tron
19           Trace ON. Enable code tracing, which is to say that lots of debug
20           information will be printed to the syslog (e.g. systemd-journal).
21
22       troff
23           Trace OFF. Disable code tracing.
24
25       status
26           Show runtime status information.
27
28       ls
29           Show the list of I/O controllers. This will list all the I/O
30           controllers configured in stacd.conf(5) as well as those discovered
31           by the stafd(8) daemon.
32

OPTIONS

34       The following options are understood:
35
36       -h, --help
37           Print the help text and exit.
38
39       --version
40           Print the version string and exit.
41
42       -d, --detailed
43           Print additional details.
44

EXIT STATUS

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

EXAMPLES

50       Example 1. List I/O controllers
51
52           $ stacctl ls --detailed
53           [{'connect attempts': 0,
54             'device': 'nvme1',
55             'host-iface': '',
56             'host-traddr': '',
57             'hostid': '3e518ec3-72ec-46a5-a603-2510e3140e29',
58             'hostnqn': 'nqn.2014-08.org.nvmexpress:uuid:13730573-e8d7-446e-81f6-042a497846d5',
59             'model': 'Linux',
60             'retry connect timer': '60.0s [off]',
61             'serial': '8d22fa96da912fb13f5a',
62             'subsysnqn': 'nqn.1988-11.com.dell:PowerSANxxx:01:20210225100113-454f73093ceb4847a7bdfc6e34aedead',
63             'traddr': '::1',
64             'transport': 'tcp',
65             'trsvcid': '8009'},
66            {'connect attempts': 0,
67             'device': 'nvme2',
68             'host-iface': '',
69             'host-traddr': '',
70             'hostid': '3e518ec3-72ec-46a5-a603-2510e3140e29',
71             'hostnqn': 'nqn.2014-08.org.nvmexpress:uuid:13730573-e8d7-446e-81f6-042a497846d5',
72             'model': 'Linux',
73             'retry connect timer': '60.0s [off]',
74             'serial': 'a9987ae2fd173d100fd0',
75             'subsysnqn': 'nqn.1988-11.com.dell:PowerSANxxx:01:20210225100113-454f73093ceb4847a7bdfc6e34aebeef',
76             'traddr': '::1',
77             'transport': 'tcp',
78             'trsvcid': '8009'},
79            {'connect attempts': 0,
80             'device': 'nvme3',
81             'host-iface': '',
82             'host-traddr': '',
83             'hostid': '3e518ec3-72ec-46a5-a603-2510e3140e29',
84             'hostnqn': 'nqn.2014-08.org.nvmexpress:uuid:13730573-e8d7-446e-81f6-042a497846d5',
85             'model': 'Linux',
86             'retry connect timer': '60.0s [off]',
87             'serial': '13e122f1a8122bed5a8d',
88             'subsysnqn': 'nqn.1988-11.com.dell:PowerSANxxx:01:20210225100113-454f73093ceb4847a7bdfc6e34ae8e28',
89             'traddr': '::1',
90             'transport': 'tcp',
91             'trsvcid': '8009'}]
92
93       Example 2. Disable tracing
94
95           $ stacctl troff
96
97       Example 3.  Show stacd(8) operational status.
98
99           $ stacctl status
100           {'config soak timer': '1.5s [off]',
101            'controllers': [{'connect attempts': 0,
102                             'device': 'nvme1',
103                             'host-iface': '',
104                             'host-traddr': '',
105                             'hostid': '3e518ec3-72ec-46a5-a603-2510e3140e29',
106                             'hostnqn': 'nqn.2014-08.org.nvmexpress:uuid:13730573-e8d7-446e-81f6-042a497846d5',
107                             'model': 'Linux',
108                             'retry connect timer': '60.0s [off]',
109                             'serial': '8d22fa96da912fb13f5a',
110                             'subsysnqn': 'nqn.1988-11.com.dell:PowerSANxxx:01:20210225100113-454f73093ceb4847a7bdfc6e34aedead',
111                             'traddr': '::1',
112                             'transport': 'tcp',
113                             'trsvcid': '8009'},
114                            {'connect attempts': 0,
115                             'device': 'nvme2',
116                             'host-iface': '',
117                             'host-traddr': '',
118                             'hostid': '3e518ec3-72ec-46a5-a603-2510e3140e29',
119                             'hostnqn': 'nqn.2014-08.org.nvmexpress:uuid:13730573-e8d7-446e-81f6-042a497846d5',
120                             'model': 'Linux',
121                             'retry connect timer': '60.0s [off]',
122                             'serial': 'a9987ae2fd173d100fd0',
123                             'subsysnqn': 'nqn.1988-11.com.dell:PowerSANxxx:01:20210225100113-454f73093ceb4847a7bdfc6e34aebeef',
124                             'traddr': '::1',
125                             'transport': 'tcp',
126                             'trsvcid': '8009'},
127                            {'connect attempts': 0,
128                             'device': 'nvme3',
129                             'host-iface': '',
130                             'host-traddr': '',
131                             'hostid': '3e518ec3-72ec-46a5-a603-2510e3140e29',
132                             'hostnqn': 'nqn.2014-08.org.nvmexpress:uuid:13730573-e8d7-446e-81f6-042a497846d5',
133                             'model': 'Linux',
134                             'retry connect timer': '60.0s [off]',
135                             'serial': '13e122f1a8122bed5a8d',
136                             'subsysnqn': 'nqn.1988-11.com.dell:PowerSANxxx:01:20210225100113-454f73093ceb4847a7bdfc6e34ae8e28',
137                             'traddr': '::1',
138                             'transport': 'tcp',
139                             'trsvcid': '8009'}],
140            'log-level': 'DEBUG',
141            'tron': True}
142