stafctl(1)

1STAFCTL(1)                                                          STAFCTL(1)
2
3
4

NAME

6       stafctl - STorage Appliance Finder (STAF) utility program
7

SYNOPSIS

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

DESCRIPTION

12       stafctl is a tool that can be used to communicate with the stafd(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 discovery controllers. This will list all the
30           controllers configured in stafd.conf(5) as well as those discovered
31           with mDNS service discovery.
32
33       dlp
34           Show discovery log pages.
35
36       adlp
37           Show all discovery log pages.
38

OPTIONS

40       The following options are understood:
41
42       -h, --help
43           Print the help text and exit.
44
45       --version
46           Print the version string and exit.
47
48       -d, --detailed
49           Print additional details.
50
51       -tTRTYPE, --transport=TRTYPE
52           NVMe-over-Fabrics fabric type (default: "tcp").
53
54       -aTRADDR, --traddr=TRADDR
55           Discovery controller's network address.
56
57       -sTRSVCID, --trsvcid=TRSVCID
58           Transport service id (for IP addressing, e.g. tcp, rdma, this field
59           is the port number).
60
61       -wTRADDR, --host-traddr=TRADDR
62           Network source address used on the host to connect to the
63           controller.
64
65       -fIFACE, --host-iface=IFACE
66           This field specifies the network interface used on the host to
67           connect to the controller.
68
69       -nNQN, --nqn=NQN
70           This field specifies the Controller's NVMe Qualified Name.
71
72           This field is mandatory for I/O Controllers, but is optional for
73           Discovery Controllers (DC). For the latter, the NQN will default to
74           the well-known DC NQN: nqn.2014-08.org.nvmexpress.discovery if left
75           undefined.
76

VALUES

78       TRTYPE
79           rdma, fc, tcp, loop.
80
81       TRADDR
82           IP or Fibre Channel address. E.g. 10.10.0.100.
83
84       TRSVCID
85           E.g., 8009.
86
87       IFACE
88           Network interface name. E.g., eth1, enp0s8, wlp0s20f3.
89
90       NQN
91           NVMe Qualified Name.
92

EXIT STATUS

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

EXAMPLES

98       Example 1. List all the discovery controllers
99
100           $ stafctl ls
101           [{'device':      'nvme0',
102             'host-iface':  '',
103             'host-traddr': '',
104             'subsysnqn':   'nqn.2014-08.org.nvmexpress.discovery',
105             'traddr':      '::1',
106             'transport':   'tcp',
107             'trsvcid':     '8009'}]
108
109       Example 2. Enable tracing
110
111           $ stafctl tron
112
113       Example 3.  Show discovery log pages from a specific discovery
114       controller
115
116           $ stafctl dlp --transport tcp --traddr ::1 --trsvcid 8009
117           [{'adrfam':  'ipv6',
118             'asqsz':   '32',
119             'cntlid':  '65535',
120             'portid':  '1',
121             'subnqn':  'nqn.1988-11.com.dell:PowerSANxxx:01:20210225100113-454f73093ceb4847a7bdfc6e34ae8e28',
122             'subtype': 'nvme',
123             'traddr':  '::1',
124             'treq':    'disable sqflow',
125             'trsvcid': '8009',
126             'trtype':  'tcp'},
127            {'adrfam':  'ipv6',
128             'asqsz':   '32',
129             'cntlid':  '65535',
130             'portid':  '1',
131             'subnqn':  'nqn.1988-11.com.dell:PowerSANxxx:01:20210225100113-454f73093ceb4847a7bdfc6e34aedead',
132             'subtype': 'nvme',
133             'traddr':  '::1',
134             'treq':    'disable sqflow',
135             'trsvcid': '8009',
136             'trtype':  'tcp'},
137            {'adrfam':  'ipv6',
138             'asqsz':   '32',
139             'cntlid':  '65535',
140             'portid':  '1',
141             'subnqn':  'nqn.1988-11.com.dell:PowerSANxxx:01:20210225100113-454f73093ceb4847a7bdfc6e34aebeef',
142             'subtype': 'nvme',
143             'traddr':  '::1',
144             'treq':    'disable sqflow',
145             'trsvcid': '8009',
146             'trtype':  'tcp'}]
147