Adding upstream version 2.2.1.upstream/2.2.1

Signed-off-by: Benjamin Drung <bdrung@debian.org>

1 files changed, 62 insertions, 0 deletions

diff --git a/etc/stas/sys.conf.doc b/etc/stas/sys.conf.doc
new file mode 100644
index 0000000..5850028
--- /dev/null
+++ b/etc/stas/sys.conf.doc
@@ -0,0 +1,62 @@
+# Copyright (c) 2022, Dell Inc. or its subsidiaries.  All rights reserved.
+# SPDX-License-Identifier: Apache-2.0
+# See the LICENSE file for details.
+#
+# This file is part of NVMe STorage Appliance Services (nvme-stas).
+
+# ==============================================================================
+# STorage Appliance Services (stas) - System configuration file
+#
+# In this file, options that are commented represent the default values used.
+# Uncommented options override the default value.
+
+
+[Host]
+# nqn:     The host's unique Non-Qualified Name. A value starting with "file://"
+#          indicates that the Host NQN can be retrieved from a separate file.
+#          Typically, nvme-cli saves the Host NQN in /etc/nvme/hostnqn. For
+#          compatibility with nvme-cli, nvme-stas defaults to looking for the
+#          existance of this file and will read the NQN from it. Otherwise, you
+#          can overwrite the default NQN by specifying its value here or
+#          specifying another file that contains the Host NQN to use.
+#          Type: string
+#          Default: file:///etc/nvme/hostnqn
+#nqn=file:///etc/nvme/hostnqn
+
+
+# id:      The host's unique Identifier (ID). A value starting with "file://"
+#          indicates that the Host ID can be retrieved from a separate file.
+#          Typically, nvme-cli saves the Host ID in /etc/nvme/hostid. For
+#          compatibility with nvme-cli, nvme-stas defaults to looking for the
+#          existance of this file and will read the ID from it. Otherwise, you
+#          can overwrite the default ID by specifying its value here or
+#          specifying another file that contains the Host ID to use.
+#          Type: string
+#          Default: file:///etc/nvme/hostid
+#id=file:///etc/nvme/hostid
+
+
+# key:     The host's DHCHAP key to be used for authentication. This is an
+#          optional parameter only required when authentication is needed.
+#          A value starting with "file://" indicates that the Host Key can
+#          be retrieved from a separate file. Typically, nvme-cli saves the
+#          Host Key in /etc/nvme/hostkey. For compatibility with nvme-cli,
+#          nvme-stas defaults to looking for the existance of this file and
+#          will read the Key from it. Otherwise, you can overwrite the default
+#          Key by specifying its value here or specifying another file that
+#          contains an alternate Host Key to use.
+#          Type: string
+#          Default: file:///etc/nvme/hostkey
+#key=file:///etc/nvme/hostkey
+
+
+# symname: The host's symbolic name. This can be a string or the name of a file
+#          containing the symbolic name. A value starting with "file://"
+#          indicates that the Symbolic Name can be retrieved from a separate
+#          file.
+#          Type: string
+#          Default: There is no default. The symbolic name is undefined by
+#                   default.
+#symname=
+
+