blob: fc6838afea119b8422fd14e6ebdf94eb98fee644 (
plain)
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
|
<?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="sys.conf" xmlns:xi="http://www.w3.org/2001/XInclude">
<refentryinfo>
<title>sys.conf</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>sys.conf</refentrytitle>
<manvolnum>5</manvolnum>
</refmeta>
<refnamediv>
<refname>sys.conf</refname>
<refpurpose>
<citerefentry project="man-pages">
<refentrytitle>nvme-stas</refentrytitle>
<manvolnum>7</manvolnum>
</citerefentry>
configuration file
</refpurpose>
</refnamediv>
<refsynopsisdiv>
<para>
<filename>/etc/stas/sys.conf</filename>
</para>
</refsynopsisdiv>
<refsect1>
<title>Description</title>
<para>
When <citerefentry project="man-pages"><refentrytitle>stafd</refentrytitle>
<manvolnum>8</manvolnum></citerefentry> and
<citerefentry project="man-pages"><refentrytitle>stacd</refentrytitle>
<manvolnum>8</manvolnum></citerefentry> start up, they read the
system configuration from <filename>sys.conf</filename>.
</para>
</refsect1>
<refsect1>
<title>Configuration File Format</title>
<para>
<filename>sys.conf</filename> is a plain text file divided into
sections, with configuration entries in the style
<replaceable>key</replaceable>=<replaceable>value</replaceable>.
Whitespace immediately before or after the <literal>=</literal> is
ignored. Empty lines and lines starting with <literal>#</literal>
are ignored, which may be used for commenting.
</para>
</refsect1>
<refsect1>
<title>Options</title>
<refsect2>
<title>[Host] section</title>
<para>
The following options are available in the
<literal>[Host]</literal> section:
</para>
<variablelist>
<varlistentry>
<term><varname>nqn=</varname></term>
<listitem>
<para>
Takes a string argument identifying the Host NQN.
A value starting with <code>file://</code>
indicates that the Host NQN can be retrieved from
a separate file. This is a mandatory parameter.
Defaults to: <literal>file:///etc/nvme/hostnqn</literal>.
</para>
</listitem>
</varlistentry>
</variablelist>
<variablelist>
<varlistentry>
<term><varname>id=</varname></term>
<listitem>
<para>
Takes a string argument identifying the Host ID.
A value starting with <code>file://</code>
indicates that the Host ID can be retrieved from
a separate file. This is a mandatory parameter.
Defaults to: <literal>file:///etc/nvme/hostid</literal>.
</para>
</listitem>
</varlistentry>
</variablelist>
<variablelist>
<varlistentry>
<term><varname>symname=</varname></term>
<listitem>
<para>
Takes a string argument identifying the Host symbolic name.
A value starting with <code>file://</code>
indicates that the symbolic name can be retrieved from
a separate file. This is an optional parameter.
There is no default value.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect2>
</refsect1>
<refsect1>
<title>See Also</title>
<para>
<citerefentry>
<refentrytitle>nvme-stas</refentrytitle>
<manvolnum>7</manvolnum>
</citerefentry>
</para>
</refsect1>
</refentry>
|
