1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
|
<?xml version="1.0" encoding="UTF-8"?>
<!--*-nxml-*-->
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
<!--
SPDX-License-Identifier: Apache-2.0
Copyright (c) 2021, Dell Inc. or its subsidiaries. All rights reserved.
-->
<refentry id="stafctl" xmlns:xi="http://www.w3.org/2001/XInclude">
<refentryinfo>
<title>stafctl</title>
<productname>nvme-stas</productname>
<author>
<personname>
<honorific>Mr</honorific>
<firstname>Martin</firstname>
<surname>Belanger</surname>
</personname>
<affiliation>
<orgname>Dell, Inc.</orgname>
</affiliation>
</author>
</refentryinfo>
<refmeta>
<refentrytitle>stafctl</refentrytitle>
<manvolnum>1</manvolnum>
</refmeta>
<refnamediv>
<refname>stafctl</refname>
<refpurpose>STorage Appliance Finder (STAF) utility program</refpurpose>
</refnamediv>
<refsynopsisdiv>
<cmdsynopsis>
<command>stafctl</command>
<arg choice="opt" rep="repeat">OPTIONS</arg>
<arg choice="req">COMMAND</arg>
<arg choice="opt" rep="repeat">OPTIONS</arg>
</cmdsynopsis>
</refsynopsisdiv>
<refsect1>
<title>Description</title>
<para>
<command>stafctl</command> is a tool that can be used to communicate
with the <citerefentry><refentrytitle>stafd</refentrytitle>
<manvolnum>8</manvolnum></citerefentry> daemon to retrieve
operational data.
</para>
</refsect1>
<refsect1>
<title>Commands</title>
<para>The following commands are understood:</para>
<variablelist>
<xi:include href="standard-options.xml" xpointer="tron"/>
<xi:include href="standard-options.xml" xpointer="troff"/>
<xi:include href="standard-options.xml" xpointer="status"/>
<varlistentry>
<term><command>ls</command></term>
<listitem>
<para>
Show the list of discovery controllers. This will list
all the controllers configured in
<citerefentry><refentrytitle>stafd.conf</refentrytitle>
<manvolnum>5</manvolnum></citerefentry> as well as those
discovered with mDNS service discovery.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>dlp</command></term>
<listitem>
<para>Show discovery log pages.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>adlp</command></term>
<listitem>
<para>Show all discovery log pages.</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1>
<title>Options</title>
<para>The following options are understood:</para>
<variablelist>
<xi:include href="standard-options.xml" xpointer="help"/>
<xi:include href="standard-options.xml" xpointer="version"/>
<xi:include href="standard-options.xml" xpointer="detailed"/>
<xi:include href="standard-options.xml" xpointer="transport"/>
<xi:include href="standard-options.xml" xpointer="traddr"/>
<xi:include href="standard-options.xml" xpointer="trsvcid"/>
<xi:include href="standard-options.xml" xpointer="host-traddr"/>
<xi:include href="standard-options.xml" xpointer="host-iface"/>
<xi:include href="standard-options.xml" xpointer="nqn"/>
</variablelist>
</refsect1>
<refsect1>
<title>Values</title>
<variablelist>
<xi:include href="standard-options.xml" xpointer="TRTYPE-value"/>
<xi:include href="standard-options.xml" xpointer="TRADDR-value"/>
<xi:include href="standard-options.xml" xpointer="TRSVCID-value"/>
<xi:include href="standard-options.xml" xpointer="IFACE-value"/>
<xi:include href="standard-options.xml" xpointer="NQN-value"/>
</variablelist>
</refsect1>
<refsect1>
<title>Exit status</title>
<para>
On success, 0 is returned; otherwise, a non-zero failure code is
returned.
</para>
</refsect1>
<refsect1>
<title>Examples</title>
<example>
<title>List all the discovery controllers</title>
<programlisting>$ stafctl ls
[{'device': 'nvme0',
'host-iface': '',
'host-traddr': '',
'subsysnqn': 'nqn.2014-08.org.nvmexpress.discovery',
'traddr': '::1',
'transport': 'tcp',
'trsvcid': '8009'}]</programlisting>
</example>
<example>
<title>Enable tracing</title>
<programlisting>$ stafctl tron</programlisting>
</example>
<example>
<title>
Show discovery log pages from a specific discovery controller
</title>
<programlisting>$ stafctl dlp --transport tcp --traddr ::1 --trsvcid 8009
[{'adrfam': 'ipv6',
'asqsz': '32',
'cntlid': '65535',
'portid': '1',
'subnqn': 'nqn.1988-11.com.dell:PowerSANxxx:01:20210225100113-454f73093ceb4847a7bdfc6e34ae8e28',
'subtype': 'nvme',
'traddr': '::1',
'treq': 'disable sqflow',
'trsvcid': '8009',
'trtype': 'tcp'},
{'adrfam': 'ipv6',
'asqsz': '32',
'cntlid': '65535',
'portid': '1',
'subnqn': 'nqn.1988-11.com.dell:PowerSANxxx:01:20210225100113-454f73093ceb4847a7bdfc6e34aedead',
'subtype': 'nvme',
'traddr': '::1',
'treq': 'disable sqflow',
'trsvcid': '8009',
'trtype': 'tcp'},
{'adrfam': 'ipv6',
'asqsz': '32',
'cntlid': '65535',
'portid': '1',
'subnqn': 'nqn.1988-11.com.dell:PowerSANxxx:01:20210225100113-454f73093ceb4847a7bdfc6e34aebeef',
'subtype': 'nvme',
'traddr': '::1',
'treq': 'disable sqflow',
'trsvcid': '8009',
'trtype': 'tcp'}]</programlisting>
</example>
</refsect1>
<refsect1>
<title>See Also</title>
<para>
<citerefentry>
<refentrytitle>stafd.conf</refentrytitle>
<manvolnum>5</manvolnum>
</citerefentry>,
<citerefentry>
<refentrytitle>stafd</refentrytitle>
<manvolnum>8</manvolnum>
</citerefentry>
<citerefentry project="man-pages"/>
</para>
</refsect1>
</refentry>
|
