'\" t
.\"     Title: stafctl
.\"    Author: Mr. Martin Belanger
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
.\"      Date: 09/04/2023
.\"    Manual: stafctl
.\"    Source: nvme-stas
.\"  Language: English
.\"
.TH "STAFCTL" "1" "" "nvme-stas 2.3-rc5" ""
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
stafctl \- STorage Appliance Finder (STAF) utility program
.SH "SYNOPSIS"
.HP \w'\fBstafctl\fR\ 'u
\fBstafctl\fR [OPTIONS...] {COMMAND} [OPTIONS...]
.SH "DESCRIPTION"
.PP
\fBstafctl\fR
is a tool that can be used to communicate with the
\fBstafd\fR(8)
daemon to retrieve operational data\&.
.SH "COMMANDS"
.PP
The following commands are understood:
.PP
\fBtron\fR
.RS 4
Trace ON\&. Enable code tracing, which is to say that lots of debug information will be printed to the syslog (e\&.g\&. systemd\-journal)\&.
.RE
.PP
\fBtroff\fR
.RS 4
Trace OFF\&. Disable code tracing\&.
.RE
.PP
\fBstatus\fR
.RS 4
Show runtime status information\&.
.RE
.PP
\fBls\fR
.RS 4
Show the list of discovery controllers\&. This will list all the controllers configured in
\fBstafd.conf\fR(5)
as well as those discovered with mDNS service discovery\&.
.RE
.PP
\fBdlp\fR
.RS 4
Show discovery log pages\&.
.RE
.PP
\fBadlp\fR
.RS 4
Show all discovery log pages\&.
.RE
.SH "OPTIONS"
.PP
The following options are understood:
.PP
\fB\-h\fR, \fB\-\-help\fR
.RS 4
Print the help text and exit\&.
.RE
.PP
\fB\-\-version\fR
.RS 4
Print the version string and exit\&.
.RE
.PP
\fB\-d\fR, \fB\-\-detailed\fR
.RS 4
Print additional details\&.
.RE
.PP
\fB\-tTRTYPE\fR, \fB\-\-transport=TRTYPE\fR
.RS 4
NVMe\-over\-Fabrics fabric type (default: "tcp")\&.
.RE
.PP
\fB\-aTRADDR\fR, \fB\-\-traddr=TRADDR\fR
.RS 4
Discovery controller\*(Aqs network address\&.
.RE
.PP
\fB\-sTRSVCID\fR, \fB\-\-trsvcid=TRSVCID\fR
.RS 4
Transport service id (for IP addressing, e\&.g\&. tcp, rdma, this field is the port number)\&.
.RE
.PP
\fB\-wTRADDR\fR, \fB\-\-host\-traddr=TRADDR\fR
.RS 4
Network source address used on the host to connect to the controller\&.
.RE
.PP
\fB\-fIFACE\fR, \fB\-\-host\-iface=IFACE\fR
.RS 4
This field specifies the network interface used on the host to connect to the controller\&.
.RE
.PP
\fB\-nNQN\fR, \fB\-\-nqn=NQN\fR
.RS 4
This field specifies the Controller\*(Aqs NVMe Qualified Name\&.
.sp
This field is mandatory for I/O Controllers, but is optional for Discovery Controllers (DC)\&. For the latter, the NQN will default to the well\-known DC NQN:
nqn\&.2014\-08\&.org\&.nvmexpress\&.discovery
if left undefined\&.
.RE
.SH "VALUES"
.PP
\fITRTYPE\fR
.RS 4
rdma, fc, tcp, loop\&.
.RE
.PP
\fITRADDR\fR
.RS 4
IP or Fibre Channel address\&. E\&.g\&. 10\&.10\&.0\&.100\&.
.RE
.PP
\fITRSVCID\fR
.RS 4
E\&.g\&., 8009\&.
.RE
.PP
\fIIFACE\fR
.RS 4
Network interface name\&. E\&.g\&., eth1, enp0s8, wlp0s20f3\&.
.RE
.PP
\fINQN\fR
.RS 4
NVMe Qualified Name\&.
.RE
.SH "EXIT STATUS"
.PP
On success, 0 is returned; otherwise, a non\-zero failure code is returned\&.
.SH "EXAMPLES"
.PP
\fBExample\ \&1.\ \&List all the discovery controllers\fR
.sp
.if n \{\
.RS 4
.\}
.nf
$ stafctl ls
[{\*(Aqdevice\*(Aq:      \*(Aqnvme0\*(Aq,
  \*(Aqhost\-iface\*(Aq:  \*(Aq\*(Aq,
  \*(Aqhost\-traddr\*(Aq: \*(Aq\*(Aq,
  \*(Aqsubsysnqn\*(Aq:   \*(Aqnqn\&.2014\-08\&.org\&.nvmexpress\&.discovery\*(Aq,
  \*(Aqtraddr\*(Aq:      \*(Aq::1\*(Aq,
  \*(Aqtransport\*(Aq:   \*(Aqtcp\*(Aq,
  \*(Aqtrsvcid\*(Aq:     \*(Aq8009\*(Aq}]
.fi
.if n \{\
.RE
.\}
.PP
\fBExample\ \&2.\ \&Enable tracing\fR
.sp
.if n \{\
.RS 4
.\}
.nf
$ stafctl tron
.fi
.if n \{\
.RE
.\}
.PP
\fBExample\ \&3.\ \& Show discovery log pages from a specific discovery controller\fR
.sp
.if n \{\
.RS 4
.\}
.nf
$ stafctl dlp \-\-transport tcp \-\-traddr ::1 \-\-trsvcid 8009
[{\*(Aqadrfam\*(Aq:  \*(Aqipv6\*(Aq,
  \*(Aqasqsz\*(Aq:   \*(Aq32\*(Aq,
  \*(Aqcntlid\*(Aq:  \*(Aq65535\*(Aq,
  \*(Aqportid\*(Aq:  \*(Aq1\*(Aq,
  \*(Aqsubnqn\*(Aq:  \*(Aqnqn\&.1988\-11\&.com\&.dell:PowerSANxxx:01:20210225100113\-454f73093ceb4847a7bdfc6e34ae8e28\*(Aq,
  \*(Aqsubtype\*(Aq: \*(Aqnvme\*(Aq,
  \*(Aqtraddr\*(Aq:  \*(Aq::1\*(Aq,
  \*(Aqtreq\*(Aq:    \*(Aqdisable sqflow\*(Aq,
  \*(Aqtrsvcid\*(Aq: \*(Aq8009\*(Aq,
  \*(Aqtrtype\*(Aq:  \*(Aqtcp\*(Aq},
 {\*(Aqadrfam\*(Aq:  \*(Aqipv6\*(Aq,
  \*(Aqasqsz\*(Aq:   \*(Aq32\*(Aq,
  \*(Aqcntlid\*(Aq:  \*(Aq65535\*(Aq,
  \*(Aqportid\*(Aq:  \*(Aq1\*(Aq,
  \*(Aqsubnqn\*(Aq:  \*(Aqnqn\&.1988\-11\&.com\&.dell:PowerSANxxx:01:20210225100113\-454f73093ceb4847a7bdfc6e34aedead\*(Aq,
  \*(Aqsubtype\*(Aq: \*(Aqnvme\*(Aq,
  \*(Aqtraddr\*(Aq:  \*(Aq::1\*(Aq,
  \*(Aqtreq\*(Aq:    \*(Aqdisable sqflow\*(Aq,
  \*(Aqtrsvcid\*(Aq: \*(Aq8009\*(Aq,
  \*(Aqtrtype\*(Aq:  \*(Aqtcp\*(Aq},
 {\*(Aqadrfam\*(Aq:  \*(Aqipv6\*(Aq,
  \*(Aqasqsz\*(Aq:   \*(Aq32\*(Aq,
  \*(Aqcntlid\*(Aq:  \*(Aq65535\*(Aq,
  \*(Aqportid\*(Aq:  \*(Aq1\*(Aq,
  \*(Aqsubnqn\*(Aq:  \*(Aqnqn\&.1988\-11\&.com\&.dell:PowerSANxxx:01:20210225100113\-454f73093ceb4847a7bdfc6e34aebeef\*(Aq,
  \*(Aqsubtype\*(Aq: \*(Aqnvme\*(Aq,
  \*(Aqtraddr\*(Aq:  \*(Aq::1\*(Aq,
  \*(Aqtreq\*(Aq:    \*(Aqdisable sqflow\*(Aq,
  \*(Aqtrsvcid\*(Aq: \*(Aq8009\*(Aq,
  \*(Aqtrtype\*(Aq:  \*(Aqtcp\*(Aq}]
.fi
.if n \{\
.RE
.\}
.SH "SEE ALSO"
.PP
\fBstafd.conf\fR(5),
\fBstafd\fR(8)
()