This patch adds a section iSNS to the manpage for tgtadm and how to use tgtadm to configure iSNS. Please apply. regards ronnie sahlberg
Attachment:
0001-Document-how-to-configure-iSNS-via-the-tgtadm-tool.patch.gz
Description: GNU Zip compressed data
From 03e480e3d74b331eb9a3e48608f6419bdd2da0c3 Mon Sep 17 00:00:00 2001
From: Ronnie Sahlberg <ronniesahlberg@xxxxxxxxx>
Date: Wed, 31 Mar 2010 16:38:04 +1100
Subject: [PATCH] Document how to configure iSNS via the tgtadm tool.
Signed-off-by: Ronnie Sahlberg <ronniesahlberg@xxxxxxxxx>
---
doc/htmlpages/tgt-admin.8.html | 102 +++++++++++++++++++++++++--------------
doc/htmlpages/tgtadm.8.html | 19 ++++++--
doc/manpages/tgtadm.8 | 61 +++++++++++++++++++++++-
doc/tgtadm.8.xml | 63 ++++++++++++++++++++++++
4 files changed, 202 insertions(+), 43 deletions(-)
diff --git a/doc/htmlpages/tgt-admin.8.html b/doc/htmlpages/tgt-admin.8.html
index d954750..b5b609d 100644
--- a/doc/htmlpages/tgt-admin.8.html
+++ b/doc/htmlpages/tgt-admin.8.html
@@ -1,18 +1,17 @@
-<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>tgt-admin</title><meta name="generator" content="DocBook XSL Stylesheets V1.73.2"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" lang="en"><a name="tgt-admin.8"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>tgt-admin — Linux SCSI Target Configuration Tool</p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><div class="cmdsynopsis"><p><code class="command">tgtadm</code> [-e --execute] [--delete <value>] [--offline <value>] [--ready <value>] [-s --show] [-c --conf <file>] [--ignore-errors] [-f --force] [-p --pretend] [--dump] [-v --verbose] [-h --help]</p></div></div><div class="refsect1" lang="en"><a name="id2476073"></a><h2>DESCRIPTION</h2><p>
+<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>tgt-admin</title><meta name="generator" content="DocBook XSL Stylesheets V1.73.2"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" lang="en"><a name="tgt-admin.8"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>tgt-admin — Linux SCSI Target Configuration Tool</p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><div class="cmdsynopsis"><p><code class="command">tgtadm</code> [-e --execute] [--delete <value>] [--offline <value>] [--ready <value>] [-s --show] [-c --conf <file>] [--ignore-errors] [-f --force] [-p --pretend] [--dump] [-v --verbose] [-h --help]</p></div></div><div class="refsect1" lang="en"><a name="id2476134"></a><h2>DESCRIPTION</h2><p>
tgt-admin is a utility which allows a persistent configuration of targets and luns.
It uses tgtadm commands to create, delete and show targets.
- </p></div><div class="refsect1" lang="en"><a name="id2476086"></a><h2>OPTIONS</h2><div class="variablelist"><dl><dt><span class="term"><code class="option">-e, --execute</code></span></dt><dd><p>
- Read /etc/tgt/targets.conf and execute tgtadm commands.
- If the target already exists, it won't be processed.
- See --update.
+ </p></div><div class="refsect1" lang="en"><a name="id2476147"></a><h2>OPTIONS</h2><div class="variablelist"><dl><dt><span class="term"><code class="option">-e, --execute</code></span></dt><dd><p>
+ Read /etc/tgt/targets.conf and execute tgtadm commands.
+ If the target already exists, it won't be processed.
+ See --update.
</p></dd><dt><span class="term"><code class="option">-d, --delete <value></code></span></dt><dd><p>
- Delete all or selected targets.
- The target will be deleted only if it's not used (no initiator
- is connected to it).
-
- If you want to delete targets which are in use, you have to add
- the "--force" flag.
-
+ Delete all or selected targets.
+ The target will be deleted only if it's not used (no initiator
+ is connected to it).
+ </p><p>
+ If you want to delete targets which are in use, you have to add
+ the "--force" flag.
</p><pre class="screen">
Example usage:
--delete ALL - delete all targets
@@ -21,44 +20,46 @@ Example usage:
--delete iqn.2008-08.com.example:some.target
- delete this target
</pre><p>
-
</p></dd><dt><span class="term"><code class="option">--offline</code></span></dt><dd><p>
Put all or selected targets in offline state.
-
</p><pre class="screen">
Example usage:
--offline ALL - offline all targets
- --offline tid=4 - offline target 4 (target with tid 4)
- --offline iqn.2008-08.com.example:some.target - offline this target
+ --offline tid=4 - offline target 4
+ (target with tid 4)
+ --offline iqn.2008-08.com.example:some.target
+ - offline this target
</pre><p>
-
</p></dd><dt><span class="term"><code class="option">--ready</code></span></dt><dd><p>
- Put all or selected targets in ready state.
- </p><pre class="screen">
+ Put all or selected targets in ready state.
+ </p><pre class="screen">
Example usage:
--ready ALL - ready all targets
- --ready tid=4 - ready target 4 (target with tid 4)
- --ready iqn.2008-08.com.example:some.target - ready this target
- </pre><p>
+ --ready tid=4 - ready target 4
+ (target with tid 4)
+ --ready iqn.2008-08.com.example:some.target
+ - ready this target
+ </pre><p>
</p></dd><dt><span class="term"><code class="option">--update <value></code></span></dt><dd><p>
- Update all or selected targets.
- The target will be updated only if it's not used (no initiator
- is connected to it).
-
- If you want to update targets which are in use, you have to add
- "--force" flag.
-
- </p><pre class="screen">
+ Update all or selected targets.
+ The target will be updated only if it's not used (no initiator
+ is connected to it).
+ </p><p>
+ If you want to update targets which are in use, you have to add
+ "--force" flag.
+ </p><pre class="screen">
Example usage:
--update ALL - ready all targets
- --update tid=4 - ready target 4 (target with tid 4)
- --update iqn.2008-08.com.example:some.target - update this target
- </pre><p>
+ --update tid=4 - ready target 4
+ (target with tid 4)
+ --update iqn.2008-08.com.example:some.target
+ - update this target
+ </pre><p>
</p></dd><dt><span class="term"><code class="option">-s, --show</code></span></dt><dd><p>
Show all the targets.
</p></dd><dt><span class="term"><code class="option">-c, --conf <configuration file></code></span></dt><dd><p>
- Specify an alternative configuration file instead of
- /etc/tgt/target.conf, which is the default.
+ Specify an alternative configuration file instead of
+ /etc/tgt/target.conf, which is the default.
</p></dd><dt><span class="term"><code class="option">--ignore-errors</code></span></dt><dd><p>
Continue even if tgtadm exits with non-zero code.
</p></dd><dt><span class="term"><code class="option">-f, --force</code></span></dt><dd><p>
@@ -74,9 +75,36 @@ Example usage:
Increase verbosity (show tgtadm commands used).
</p></dd><dt><span class="term"><code class="option">-h, --help</code></span></dt><dd><p>
Display a list of available options and exit.
- </p></dd></dl></div></div><div class="refsect1" lang="en"><a name="id2476335"></a><h2>SEE ALSO</h2><p>
+ </p></dd></dl></div></div><div class="refsect1" lang="en"><a name="id2476406"></a><h2>CONFIGURATION FILE SYNTAX</h2><p>
+ The defualt configuration file is /etc/tgt/target.conf. It defines all
+ the targets and their properties.
+ The configuration file is in XML format and uses tags.
+ Configuration file contains several target blocks, where each block
+ contains target's properties such as storage devices,
+ initator ACL and authorization information. You can include other
+ config files using:
+ include /etc/tgt/xen/*.conf.
+ </p><div class="variablelist"><dl><dt><span class="term"><code class="option">backing-store</code></span></dt><dd><p>
+ Defines a virtual device on the target.
+ </p></dd><dt><span class="term"><code class="option">direct-store</code></span></dt><dd><p>
+ Defines a direct mapped device with the same properties
+ as the physical device (such as VENDOR_ID, SERIAL_NUM, etc.)
+ </p></dd><dt><span class="term"><code class="option">initiator-address</code></span></dt><dd><p>
+ Allows connections only from the specified IP
+ address. Defaults to ALL if no "initiator-address" is specified.
+ </p></dd><dt><span class="term"><code class="option">incominguser</code></span></dt><dd><p>
+ Define iscsi incoming authentication setting. If no
+ "incominguser" is specified, it is not used.
+ </p></dd><dt><span class="term"><code class="option">outgoinguser</code></span></dt><dd><p>
+ Define iscsi outgoing authentication setting. If no
+ "outgoinguser" is specified, it is not used.
+ </p></dd></dl></div></div><div class="refsect1" lang="en"><a name="id2476522"></a><h2>FILES</h2><div class="variablelist"><dl><dt><span class="term"><code class="option">/etc/tgt/targets.conf</code></span></dt><dd><p>
+ Configuration file for tgt-admin.
+ </p></dd><dt><span class="term"><code class="option">/usr/share/doc/tgt/targets.conf.example</code></span></dt><dd><p>
+ Example configuration file for tgt-admin.
+ </p></dd></dl></div></div><div class="refsect1" lang="en"><a name="id2476559"></a><h2>SEE ALSO</h2><p>
tgtd(8), tgtadm(8), tgtimg(8), tgt-setup-lun(8).
<a class="ulink" href="http://stgt.sourceforge.net/"; target="_top">http://stgt.sourceforge.net/</a>
- </p></div><div class="refsect1" lang="en"><a name="id2476350"></a><h2>REPORTING BUGS</h2><p>
+ </p></div><div class="refsect1" lang="en"><a name="id2476574"></a><h2>REPORTING BUGS</h2><p>
Report bugs to <stgt@xxxxxxxxxxxxxxx>
</p></div></div></body></html>
diff --git a/doc/htmlpages/tgtadm.8.html b/doc/htmlpages/tgtadm.8.html
index 9b9c73c..673c8d8 100644
--- a/doc/htmlpages/tgtadm.8.html
+++ b/doc/htmlpages/tgtadm.8.html
@@ -1,7 +1,7 @@
-<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>tgtadm</title><meta name="generator" content="DocBook XSL Stylesheets V1.73.2"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" lang="en"><a name="tgtadm.8"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>tgtadm — Linux SCSI Target Administration Utility</p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><div class="cmdsynopsis"><p><code class="command">tgtadm [--control-port NNNN] --lld [driver] --op [operation] --mode [mode] [OPTION]...</code> </p></div></div><div class="refsect1" lang="en"><a name="id2475961"></a><h2>DESCRIPTION</h2><p>
+<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>tgtadm</title><meta name="generator" content="DocBook XSL Stylesheets V1.73.2"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" lang="en"><a name="tgtadm.8"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>tgtadm — Linux SCSI Target Administration Utility</p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><div class="cmdsynopsis"><p><code class="command">tgtadm [--control-port NNNN] --lld [driver] --op [operation] --mode [mode] [OPTION]...</code> </p></div></div><div class="refsect1" lang="en"><a name="id2476012"></a><h2>DESCRIPTION</h2><p>
tgtadm is used to monitor and modify everything about Linux SCSI target
software: targets, volumes, etc.
- </p></div><div class="refsect1" lang="en"><a name="id2475972"></a><h2>OPTIONS</h2><div class="variablelist"><dl><dt><span class="term"><code class="option">--control-port NNNN</code></span></dt><dd><p>
+ </p></div><div class="refsect1" lang="en"><a name="id2476023"></a><h2>OPTIONS</h2><div class="variablelist"><dl><dt><span class="term"><code class="option">--control-port NNNN</code></span></dt><dd><p>
It is possible to run multiple concurrent instances of tgtd
on a host. This argument is used to control which instance
the tgtadm command will operate on.
@@ -32,9 +32,20 @@
display version and exit.
</p></dd><dt><span class="term"><code class="option">--help</code></span></dt><dd><p>
display a list of available options and exits.
- </p></dd></dl></div></div><div class="refsect1" lang="en"><a name="id2476171"></a><h2>SEE ALSO</h2><p>
+ </p></dd></dl></div></div><div class="refsect1" lang="en"><a name="id2476223"></a><h2>iSNS</h2><p>
+ iSNS configuration for a target is by using the tgtadm command.
+ </p><div class="variablelist"><dl><dt><span class="term"><code class="option">iSNSServerIP</code></span></dt><dd><p>
+ This specifies the IP address of the iSNS server. TGTD only
+ supprots one iSNS server.
+ </p></dd><dt><span class="term"><code class="option">iSNS</code></span></dt><dd><p>
+ This setting enables(on)/disables(off) iSNS.
+ </p></dd><dt><span class="term"><code class="option">iSNSServerPort</code></span></dt><dd><p>
+ This setting specifies the port to use for iSNS.
+ </p></dd><dt><span class="term"><code class="option">iSNSAccessControl</code></span></dt><dd><p>
+ Enable/disable access control for iSNS.
+ </p></dd></dl></div></div><div class="refsect1" lang="en"><a name="id2476322"></a><h2>SEE ALSO</h2><p>
tgtd(8), tgt-admin(8), tgtimg(8), tgt-setup-lun(8).
<a class="ulink" href="http://stgt.sourceforge.net/"; target="_top">http://stgt.sourceforge.net/</a>
- </p></div><div class="refsect1" lang="en"><a name="id2476186"></a><h2>REPORTING BUGS</h2><p>
+ </p></div><div class="refsect1" lang="en"><a name="id2476336"></a><h2>REPORTING BUGS</h2><p>
Report bugs to <stgt@xxxxxxxxxxxxxxx>
</p></div></div></body></html>
diff --git a/doc/manpages/tgtadm.8 b/doc/manpages/tgtadm.8
index 92fef89..7b9a708 100644
--- a/doc/manpages/tgtadm.8
+++ b/doc/manpages/tgtadm.8
@@ -1,11 +1,11 @@
.\" Title: tgtadm
.\" Author:
.\" Generator: DocBook XSL Stylesheets v1.73.2 <http://docbook.sf.net/>
-.\" Date: 03/04/2010
+.\" Date: 03/31/2010
.\" Manual:
.\" Source:
.\"
-.TH "TGTADM" "8" "03/04/2010" "" ""
+.TH "TGTADM" "8" "03/31/2010" "" ""
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
@@ -79,6 +79,63 @@ display version and exit\.
.RS 4
display a list of available options and exits\.
.RE
+.SH "ISNS"
+.PP
+iSNS configuration for a target is by using the tgtadm command\.
+.PP
+\fBiSNSServerIP\fR
+.RS 4
+This specifies the IP address of the iSNS server\. TGTD only supprots one iSNS server\.
+.sp
+.RS 4
+.nf
+Example:
+
+tgtadm \-\-op update \-\-mode sys \-\-name iSNSServerIP \-v 192\.168\.11\.133
+
+.fi
+.RE
+.RE
+.PP
+\fBiSNS\fR
+.RS 4
+This setting enables(on)/disables(off) iSNS\.
+.sp
+.RS 4
+.nf
+Example activating iSNS once configured:
+
+tgtadm \-\-op update \-\-mode sys \-\-name iSNS \-v On
+
+.fi
+.RE
+.RE
+.PP
+\fBiSNSServerPort\fR
+.RS 4
+This setting specifies the port to use for iSNS\.
+.sp
+.RS 4
+.nf
+Example:
+
+tgtadm \-\-op update \-\-mode sys \-\-name iSNSServerPort \-v 3205
+
+.fi
+.RE
+.RE
+.PP
+\fBiSNSAccessControl\fR
+.RS 4
+Enable/disable access control for iSNS\.
+.sp
+.RS 4
+.nf
+tgtadm \-\-op update \-\-mode sys \-\-name iSNSAccessControl \-v Off
+
+.fi
+.RE
+.RE
.SH "SEE ALSO"
.PP
tgtd(8), tgt\-admin(8), tgtimg(8), tgt\-setup\-lun(8)\.
diff --git a/doc/tgtadm.8.xml b/doc/tgtadm.8.xml
index 22d96f1..7a53e4f 100644
--- a/doc/tgtadm.8.xml
+++ b/doc/tgtadm.8.xml
@@ -137,6 +137,69 @@
</variablelist>
</refsect1>
+ <refsect1><title>iSNS</title>
+ <para>
+ iSNS configuration for a target is by using the tgtadm command.
+ </para>
+ <variablelist>
+
+ <varlistentry><term><option>iSNSServerIP</option></term>
+ <listitem>
+ <para>
+ This specifies the IP address of the iSNS server. TGTD only
+ supprots one iSNS server.
+ </para>
+ </listitem>
+ <screen format="linespecific">
+Example:
+
+tgtadm --op update --mode sys --name iSNSServerIP -v 192.168.11.133
+ </screen>
+ </varlistentry>
+
+ <varlistentry><term><option>iSNS</option></term>
+ <listitem>
+ <para>
+ This setting enables(on)/disables(off) iSNS.
+ </para>
+ </listitem>
+ <screen format="linespecific">
+Example activating iSNS once configured:
+
+tgtadm --op update --mode sys --name iSNS -v On
+ </screen>
+ </varlistentry>
+
+ <varlistentry><term><option>iSNSServerPort</option></term>
+ <listitem>
+ <para>
+ This setting specifies the port to use for iSNS.
+ </para>
+ </listitem>
+ <screen format="linespecific">
+Example:
+
+tgtadm --op update --mode sys --name iSNSServerPort -v 3205
+ </screen>
+ </varlistentry>
+
+ <varlistentry><term><option>iSNSAccessControl</option></term>
+ <listitem>
+ <para>
+ Enable/disable access control for iSNS.
+ </para>
+ </listitem>
+ <screen format="linespecific">
+tgtadm --op update --mode sys --name iSNSAccessControl -v Off
+ </screen>
+ </varlistentry>
+
+ </variablelist>
+
+
+ </refsect1>
+
+
<refsect1><title>SEE ALSO</title>
<para>
tgtd(8), tgt-admin(8), tgtimg(8), tgt-setup-lun(8).
--
1.5.4.3
