'\" t
.\"     Title: stasadm
.\"    Author: Mr. Martin Belanger
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
.\"      Date: 09/04/2023
.\"    Manual: stasadm
.\"    Source: nvme-stas
.\"  Language: English
.\"
.TH "STASADM" "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"
stasadm \- STorage Appliance Services admin functions
.SH "SYNOPSIS"
.HP \w'\fBstasadm\fR\ 'u
\fBstasadm\fR [OPTIONS...] {COMMAND} [OPTIONS...]
.SH "DESCRIPTION"
.PP
\fBstasadm\fR
is used to configure
nvme\-stas\&. The configuration is saved to
/etc/stas/sys\&.conf\&.
.PP
Although
nvme\-stas\*(Aq configuration is saved to
/etc/stas/sys\&.conf, it\*(Aqs still possible to interoperate with the configuration of
\fBnvme\-cli\fR
and
\fBlibnvme\fR\&.
nvme\-stas
allows one to save individual parameters such as the Host NQN and ID outside of
/etc/stas/sys\&.conf\&. This allows, for example, using the same default Host NQN and ID defined by
\fBnvme\-cli\fR
and
\fBlibnvme\fR
in
/etc/nvme/hostnqn
and
/etc/nvme/hostid
respectively\&. To tell
nvme\-stas
that you want to use the those files, simply use
\fBstasadm\fR\*(Aqs
\fB\-\-file=FILE\fR
option\&.
.SH "COMMANDS"
.PP
The following commands are understood:
.PP
\fBhostnqn\fR
.RS 4
Generate the Host NQN\&. This is typically used as a post installation step to generate
/etc/nvme/hostnqn\&.
.sp
The NVMe base specifications says:
\(lqAn NQN is permanent for the lifetime of the host\(rq\&. For this reason, the host NQN should only be generated if
/etc/nvme/hostnqn
does not exist already\&.
.RE
.PP
\fBhostid\fR
.RS 4
Generate the Host ID\&. This is typically used as a post installation step to generate
/etc/nvme/hostid\&.
.sp
Although not explicitly specified in the NVMe specifications, the Host ID, like the Host NQN, should be permanent for the lifetime of the host\&. Only generate the Host ID if
/etc/nvme/hostid
does not exist\&.
.RE
.PP
\fBset\-symname [SYMNAME]\fR
.RS 4
Set the host symbolic name\&.
.sp
The symbolic name is an optional parameter that can be used for explicit registration with a discovery controller\&.
.RE
.PP
\fBclear\-symname\fR
.RS 4
Clear the host symbolic name\&.
.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\-fFILE\fR, \fB\-\-file=FILE\fR
.RS 4
By default,
\fBhostnqn\fR
and
\fBhostid\fR
save the values to
/etc/stas/sys\&.conf\&. This option allows saving to a separate file\&.
.sp
Traditionally,
\fBnvme\-cli\fR
and
\fBlibnvme\fR
retrieve the default Host NQN and ID from
/etc/nvme/hostnqn
and
/etc/nvme/hostid
respectively\&. The
\fB\-\-file=FILE\fR
option can be used to tell
nvme\-stas
that it should use those same configuration files\&.
.RE
.SH "EXIT STATUS"
.PP
On success, 0 is returned; otherwise, a non\-zero failure code is returned\&.
.SH "EXAMPLES"
.PP
\fBExample\ \&1.\ \&Generate /etc/nvme/hostnqn\fR
.sp
.if n \{\
.RS 4
.\}
.nf
$ stasadm hostnqn \-\-file /etc/nvme/hostnqn
.fi
.if n \{\
.RE
.\}
.PP
\fBExample\ \&2.\ \&Generate /etc/nvme/hostid\fR
.sp
.if n \{\
.RS 4
.\}
.nf
$ stasadm hostid \-f /etc/nvme/hostid
.fi
.if n \{\
.RE
.\}
.PP
\fBExample\ \&3.\ \&Configure the host\*(Aqs symbolic name\fR
.sp
.if n \{\
.RS 4
.\}
.nf
$ stasadm set\-symname LukeSkywalker
.fi
.if n \{\
.RE
.\}
.SH "SEE ALSO"
.PP
\fBnvme-stas\fR(7)