stasadm(1)

1STASADM(1)                                                          STASADM(1)
2
3
4

NAME

6       stasadm - STorage Appliance Services admin functions
7

SYNOPSIS

9       stasadm [OPTIONS...] {COMMAND} [OPTIONS...]
10

DESCRIPTION

12       stasadm is used to configure nvme-stas. The configuration is saved to
13       /etc/stas/sys.conf.
14
15       Although nvme-stas' configuration is saved to /etc/stas/sys.conf, it's
16       still possible to interoperate with the configuration of nvme-cli and
17       libnvme.  nvme-stas allows to save individual parameters such as the
18       Host NQN and ID outside of /etc/stas/sys.conf. This allows, for
19       example, using the same default Host NQN and ID defined by nvme-cli and
20       libnvme in /etc/nvme/hostnqn and /etc/nvme/hostid respectively. To tell
21       nvme-stas that you want to use the those files, simply use stasadm's
22       --file=FILE option.
23

COMMANDS

25       The following commands are understood:
26
27       hostnqn
28           Generate the Host NQN. This is typically used as a post
29           installation step to generate /etc/nvme/hostnqn.
30
31           The NVMe base specifications says: “An NQN is permanent for the
32           lifetime of the host”. For this reason, the host NQN should only be
33           generated if /etc/nvme/hostnqn does not exist already.
34
35       hostid
36           Generate the Host ID. This is typically used as a post installation
37           step to generate /etc/nvme/hostid.
38
39           Although not explicitly specified in the NVMe specifications, the
40           Host ID, like the Host NQN, should be permanent for the lifetime of
41           the host. Only generate the Host ID if /etc/nvme/hostid does not
42           exist.
43
44       set-symname [SYMNAME]
45           Set the host symbolic name.
46
47           The symbolic name is an optional parameter that can be used for
48           explicit registration with a discovery controller.
49
50       clear-symname
51           Clear the host symbolic name.
52

OPTIONS

54       The following options are understood:
55
56       -h, --help
57           Print the help text and exit.
58
59       --version
60           Print the version string and exit.
61
62       -fFILE, --file=FILE
63           By default, hostnqn and hostid save the values to
64           /etc/stas/sys.conf. This option allows saving to a separate file.
65
66           Traditionally, nvme-cli and libnvme retrieve the default Host NQN
67           and ID from /etc/nvme/hostnqn and /etc/nvme/hostid respectively.
68           The --file=FILE option can be used to tell nvme-stas that it should
69           use those same configuration files.
70

EXIT STATUS

72       On success, 0 is returned; otherwise, a non-zero failure code is
73       returned.
74

EXAMPLES

76       Example 1. Generate /etc/nvme/hostnqn
77
78           $ stasadm hostnqn --file /etc/nvme/hostnqn
79
80       Example 2. Generate /etc/nvme/hostid
81
82           $ stasadm hostid -f /etc/nvme/hostid
83
84       Example 3. Configure the host's symbolic name
85
86           $ stasadm set-symname LukeSkywalker
87