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 is an optional field that specifies the Discovery Controller's
71           NVMe Qualified Name. If not specified, this will default to the
72           well-known DC NQN: nqn.2014-08.org.nvmexpress.discovery.
73

VALUES

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

EXIT STATUS

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

EXAMPLES

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