'\" t
.\"     Title: stacctl
.\"    Author: Mr. Martin Belanger
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
.\"      Date: 09/04/2023
.\"    Manual: stacctl
.\"    Source: nvme-stas
.\"  Language: English
.\"
.TH "STACCTL" "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"
stacctl \- STorage Appliance Connector (STAC) utility program
.SH "SYNOPSIS"
.HP \w'\fBstacctl\fR\ 'u
\fBstacctl\fR [OPTIONS...] {COMMAND} [OPTIONS...]
.SH "DESCRIPTION"
.PP
\fBstacctl\fR
is a tool that can be used to communicate with the
\fBstacd\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 I/O controllers\&. This will list all the I/O controllers configured in
\fBstacd.conf\fR(5)
as well as those discovered by the
\fBstafd\fR(8)
daemon\&.
.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
.SH "EXIT STATUS"
.PP
On success, 0 is returned; otherwise, a non\-zero failure code is returned\&.
.SH "EXAMPLES"
.PP
\fBExample\ \&1.\ \&List I/O controllers\fR
.sp
.if n \{\
.RS 4
.\}
.nf
$ stacctl ls \-\-detailed
[{\*(Aqconnect attempts\*(Aq: 0,
  \*(Aqdevice\*(Aq: \*(Aqnvme1\*(Aq,
  \*(Aqhost\-iface\*(Aq: \*(Aq\*(Aq,
  \*(Aqhost\-traddr\*(Aq: \*(Aq\*(Aq,
  \*(Aqhostid\*(Aq: \*(Aq3e518ec3\-72ec\-46a5\-a603\-2510e3140e29\*(Aq,
  \*(Aqhostnqn\*(Aq: \*(Aqnqn\&.2014\-08\&.org\&.nvmexpress:uuid:13730573\-e8d7\-446e\-81f6\-042a497846d5\*(Aq,
  \*(Aqmodel\*(Aq: \*(AqLinux\*(Aq,
  \*(Aqretry connect timer\*(Aq: \*(Aq60\&.0s [off]\*(Aq,
  \*(Aqserial\*(Aq: \*(Aq8d22fa96da912fb13f5a\*(Aq,
  \*(Aqsubsysnqn\*(Aq: \*(Aqnqn\&.1988\-11\&.com\&.dell:PowerSANxxx:01:20210225100113\-454f73093ceb4847a7bdfc6e34aedead\*(Aq,
  \*(Aqtraddr\*(Aq: \*(Aq::1\*(Aq,
  \*(Aqtransport\*(Aq: \*(Aqtcp\*(Aq,
  \*(Aqtrsvcid\*(Aq: \*(Aq8009\*(Aq},
 {\*(Aqconnect attempts\*(Aq: 0,
  \*(Aqdevice\*(Aq: \*(Aqnvme2\*(Aq,
  \*(Aqhost\-iface\*(Aq: \*(Aq\*(Aq,
  \*(Aqhost\-traddr\*(Aq: \*(Aq\*(Aq,
  \*(Aqhostid\*(Aq: \*(Aq3e518ec3\-72ec\-46a5\-a603\-2510e3140e29\*(Aq,
  \*(Aqhostnqn\*(Aq: \*(Aqnqn\&.2014\-08\&.org\&.nvmexpress:uuid:13730573\-e8d7\-446e\-81f6\-042a497846d5\*(Aq,
  \*(Aqmodel\*(Aq: \*(AqLinux\*(Aq,
  \*(Aqretry connect timer\*(Aq: \*(Aq60\&.0s [off]\*(Aq,
  \*(Aqserial\*(Aq: \*(Aqa9987ae2fd173d100fd0\*(Aq,
  \*(Aqsubsysnqn\*(Aq: \*(Aqnqn\&.1988\-11\&.com\&.dell:PowerSANxxx:01:20210225100113\-454f73093ceb4847a7bdfc6e34aebeef\*(Aq,
  \*(Aqtraddr\*(Aq: \*(Aq::1\*(Aq,
  \*(Aqtransport\*(Aq: \*(Aqtcp\*(Aq,
  \*(Aqtrsvcid\*(Aq: \*(Aq8009\*(Aq},
 {\*(Aqconnect attempts\*(Aq: 0,
  \*(Aqdevice\*(Aq: \*(Aqnvme3\*(Aq,
  \*(Aqhost\-iface\*(Aq: \*(Aq\*(Aq,
  \*(Aqhost\-traddr\*(Aq: \*(Aq\*(Aq,
  \*(Aqhostid\*(Aq: \*(Aq3e518ec3\-72ec\-46a5\-a603\-2510e3140e29\*(Aq,
  \*(Aqhostnqn\*(Aq: \*(Aqnqn\&.2014\-08\&.org\&.nvmexpress:uuid:13730573\-e8d7\-446e\-81f6\-042a497846d5\*(Aq,
  \*(Aqmodel\*(Aq: \*(AqLinux\*(Aq,
  \*(Aqretry connect timer\*(Aq: \*(Aq60\&.0s [off]\*(Aq,
  \*(Aqserial\*(Aq: \*(Aq13e122f1a8122bed5a8d\*(Aq,
  \*(Aqsubsysnqn\*(Aq: \*(Aqnqn\&.1988\-11\&.com\&.dell:PowerSANxxx:01:20210225100113\-454f73093ceb4847a7bdfc6e34ae8e28\*(Aq,
  \*(Aqtraddr\*(Aq: \*(Aq::1\*(Aq,
  \*(Aqtransport\*(Aq: \*(Aqtcp\*(Aq,
  \*(Aqtrsvcid\*(Aq: \*(Aq8009\*(Aq}]
.fi
.if n \{\
.RE
.\}
.PP
\fBExample\ \&2.\ \&Disable tracing\fR
.sp
.if n \{\
.RS 4
.\}
.nf
$ stacctl troff
.fi
.if n \{\
.RE
.\}
.PP
\fBExample\ \&3.\ \& Show stacd(8) operational status\&.\fR
.sp
.if n \{\
.RS 4
.\}
.nf
$ stacctl status
{\*(Aqconfig soak timer\*(Aq: \*(Aq1\&.5s [off]\*(Aq,
 \*(Aqcontrollers\*(Aq: [{\*(Aqconnect attempts\*(Aq: 0,
                  \*(Aqdevice\*(Aq: \*(Aqnvme1\*(Aq,
                  \*(Aqhost\-iface\*(Aq: \*(Aq\*(Aq,
                  \*(Aqhost\-traddr\*(Aq: \*(Aq\*(Aq,
                  \*(Aqhostid\*(Aq: \*(Aq3e518ec3\-72ec\-46a5\-a603\-2510e3140e29\*(Aq,
                  \*(Aqhostnqn\*(Aq: \*(Aqnqn\&.2014\-08\&.org\&.nvmexpress:uuid:13730573\-e8d7\-446e\-81f6\-042a497846d5\*(Aq,
                  \*(Aqmodel\*(Aq: \*(AqLinux\*(Aq,
                  \*(Aqretry connect timer\*(Aq: \*(Aq60\&.0s [off]\*(Aq,
                  \*(Aqserial\*(Aq: \*(Aq8d22fa96da912fb13f5a\*(Aq,
                  \*(Aqsubsysnqn\*(Aq: \*(Aqnqn\&.1988\-11\&.com\&.dell:PowerSANxxx:01:20210225100113\-454f73093ceb4847a7bdfc6e34aedead\*(Aq,
                  \*(Aqtraddr\*(Aq: \*(Aq::1\*(Aq,
                  \*(Aqtransport\*(Aq: \*(Aqtcp\*(Aq,
                  \*(Aqtrsvcid\*(Aq: \*(Aq8009\*(Aq},
                 {\*(Aqconnect attempts\*(Aq: 0,
                  \*(Aqdevice\*(Aq: \*(Aqnvme2\*(Aq,
                  \*(Aqhost\-iface\*(Aq: \*(Aq\*(Aq,
                  \*(Aqhost\-traddr\*(Aq: \*(Aq\*(Aq,
                  \*(Aqhostid\*(Aq: \*(Aq3e518ec3\-72ec\-46a5\-a603\-2510e3140e29\*(Aq,
                  \*(Aqhostnqn\*(Aq: \*(Aqnqn\&.2014\-08\&.org\&.nvmexpress:uuid:13730573\-e8d7\-446e\-81f6\-042a497846d5\*(Aq,
                  \*(Aqmodel\*(Aq: \*(AqLinux\*(Aq,
                  \*(Aqretry connect timer\*(Aq: \*(Aq60\&.0s [off]\*(Aq,
                  \*(Aqserial\*(Aq: \*(Aqa9987ae2fd173d100fd0\*(Aq,
                  \*(Aqsubsysnqn\*(Aq: \*(Aqnqn\&.1988\-11\&.com\&.dell:PowerSANxxx:01:20210225100113\-454f73093ceb4847a7bdfc6e34aebeef\*(Aq,
                  \*(Aqtraddr\*(Aq: \*(Aq::1\*(Aq,
                  \*(Aqtransport\*(Aq: \*(Aqtcp\*(Aq,
                  \*(Aqtrsvcid\*(Aq: \*(Aq8009\*(Aq},
                 {\*(Aqconnect attempts\*(Aq: 0,
                  \*(Aqdevice\*(Aq: \*(Aqnvme3\*(Aq,
                  \*(Aqhost\-iface\*(Aq: \*(Aq\*(Aq,
                  \*(Aqhost\-traddr\*(Aq: \*(Aq\*(Aq,
                  \*(Aqhostid\*(Aq: \*(Aq3e518ec3\-72ec\-46a5\-a603\-2510e3140e29\*(Aq,
                  \*(Aqhostnqn\*(Aq: \*(Aqnqn\&.2014\-08\&.org\&.nvmexpress:uuid:13730573\-e8d7\-446e\-81f6\-042a497846d5\*(Aq,
                  \*(Aqmodel\*(Aq: \*(AqLinux\*(Aq,
                  \*(Aqretry connect timer\*(Aq: \*(Aq60\&.0s [off]\*(Aq,
                  \*(Aqserial\*(Aq: \*(Aq13e122f1a8122bed5a8d\*(Aq,
                  \*(Aqsubsysnqn\*(Aq: \*(Aqnqn\&.1988\-11\&.com\&.dell:PowerSANxxx:01:20210225100113\-454f73093ceb4847a7bdfc6e34ae8e28\*(Aq,
                  \*(Aqtraddr\*(Aq: \*(Aq::1\*(Aq,
                  \*(Aqtransport\*(Aq: \*(Aqtcp\*(Aq,
                  \*(Aqtrsvcid\*(Aq: \*(Aq8009\*(Aq}],
 \*(Aqlog\-level\*(Aq: \*(AqDEBUG\*(Aq,
 \*(Aqtron\*(Aq: True}
.fi
.if n \{\
.RE
.\}
.SH "SEE ALSO"
.PP
\fBstacd.conf\fR(5),
\fBstacd\fR(8)
()