It should still be relatively easy for users to generate docs by running 'make' and having xsltproc installed, or I've also found that Googling commands also tends to bring up the html versions that people have published online. Clean generated files in doc/Makefile. Signed-off-by: Andy Grover <agrover@xxxxxxxxxx> --- doc/Makefile | 2 + doc/htmlpages/tgt-admin.8.html | 114 ------- doc/htmlpages/tgtadm.8.html | 344 --------------------- doc/htmlpages/tgtd.8.html | 63 ---- doc/htmlpages/tgtimg.8.html | 66 ---- doc/manpages/tgt-admin.8 | 231 -------------- doc/manpages/tgt-setup-lun.8 | 46 --- doc/manpages/tgtadm.8 | 663 ---------------------------------------- doc/manpages/tgtd.8 | 145 --------- doc/manpages/tgtimg.8 | 130 -------- 10 files changed, 2 insertions(+), 1802 deletions(-) delete mode 100644 doc/htmlpages/tgt-admin.8.html delete mode 100644 doc/htmlpages/tgtadm.8.html delete mode 100644 doc/htmlpages/tgtd.8.html delete mode 100644 doc/htmlpages/tgtimg.8.html delete mode 100644 doc/manpages/tgt-admin.8 delete mode 100644 doc/manpages/tgt-setup-lun.8 delete mode 100644 doc/manpages/tgtadm.8 delete mode 100644 doc/manpages/tgtd.8 delete mode 100644 doc/manpages/tgtimg.8 diff --git a/doc/Makefile b/doc/Makefile index 791f887..4370fb2 100644 --- a/doc/Makefile +++ b/doc/Makefile @@ -29,6 +29,8 @@ install: $(MANPAGES) $(DOCS) .PHONY: clean clean: + rm -f $(XMLMAN) $(XMLHTML) + rmdir manpages htmlpages manpages/tgtd.8: tgtd.8.xml -test -z "$(XSLTPROC)" || $(XSLTPROC) -o $@ http://docbook.sourceforge.net/release/xsl/current/manpages/docbook.xsl $< diff --git a/doc/htmlpages/tgt-admin.8.html b/doc/htmlpages/tgt-admin.8.html deleted file mode 100644 index 63f462b..0000000 --- a/doc/htmlpages/tgt-admin.8.html +++ /dev/null @@ -1,114 +0,0 @@ -<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">tgt-admin</code> [-e --execute] [--delete <value>] [--offline <value>] [--ready <value>] [-s --show] [-C --control-port <NNNN>] [-c --conf <file>] [--ignore-errors] [-f --force] [-p --pretend] [--dump] [-v --verbose] [-h --help]</p></div></div><div class="refsect1" lang="en"><a name="id514662"></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="id514672"></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). - </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 - --delete tid=4 - delete target 4 - (target with tid 4) - --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 - </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"> -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> - </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). - </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> - </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, --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 tgt-admin command will operate on. - </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. - </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> - Force some operations even if the target is in use. - </p></dd><dt><span class="term"><code class="option">-p, --pretend</code></span></dt><dd><p> - Only print tgtadm options which would be used; don't execute any - actions. - Assumes -v. - </p></dd><dt><span class="term"><code class="option">--dump</code></span></dt><dd><p> - Dump current tgtd configuration. Note: does not include detailed - parameters, like write caching. - </p></dd><dt><span class="term"><code class="option">-v, --verbose</code></span></dt><dd><p> - 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="id514912"></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="id515009"></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="id515044"></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="id515057"></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 deleted file mode 100644 index be4da1c..0000000 --- a/doc/htmlpages/tgtadm.8.html +++ /dev/null @@ -1,344 +0,0 @@ -<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.75.2"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" title="tgtadm"><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" title="Synopsis"><h2>Synopsis</h2><div class="cmdsynopsis"><p><code class="command">tgtadm [OPTIONS]...</code> [-C --control-port <port>] [-L --lld <driver>] [-o --op <operation>] [-m --mode <mode>] [-t --tid <id>] [-T --targetname <targetname>] [-Y --device-type <type>] [-l --lun <lun>] [-b --backing-store <path>] [-E --bstype <type>] [-I --initiator-address <address>] [-n --name <parameter>] [-v --value <value>] [-P --para! ms <param=value[,param=value...]>] [-h --help]</p></div></div><div class="refsect1" title="DESCRIPTION"><a name="id269679"></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" title="OPTIONS"><a name="id269690"></a><h2>OPTIONS</h2><div class="variablelist"><pre class="screen"> -Possible device-types are: - disk : emulate a disk device - tape : emulate a tape reader - ssc : same as tape - cd : emulate a DVD drive - changer : emulate a media changer device - pt : passthrough type to export a /dev/sg device - </pre><pre class="screen"> -Possible backend types are: - rdwr : Use normal file I/O. This is the default for disk devices - aio : Use Asynchronous I/O - mmap : Use memory mapping for the backend file - - sg : Special backend type for passthrough devices - ssc : Special backend type for tape emulation - </pre><dl><dt><span class="term"><code class="option">-C, --control-port <port></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. - </p></dd><dt><span class="term"><code class="option">-Y, --device-type <type></code></span></dt><dd><p> - When creating a LUN, this parameter specifies the type of device - to create. Default is disk. - </p></dd><dt><span class="term"><code class="option">-E, --bstype <type></code></span></dt><dd><p> - When creating a LUN, this parameter specifies the type of backend storage - to to use. - </p></dd><dt><span class="term"><code class="option">--lld <driver> --op new --mode target --tid <id> --targetname <name></code></span></dt><dd><p> - Add a new target with <id> and <name>. - </p></dd><dt><span class="term"><code class="option">--lld <driver> --op delete --mode target --tid <id></code></span></dt><dd><p> - Delete specific target with <id>. The target must have no active I_T nexus. - </p></dd><dt><span class="term"><code class="option">--lld <driver> --op show --mode target</code></span></dt><dd><p> - Show all the targets. - </p></dd><dt><span class="term"><code class="option">--lld <driver> --op show --mode target --tid <id></code></span></dt><dd><p> - Show target parameters of a target with <id>. - </p></dd><dt><span class="term"><code class="option">--lld <driver> --op new --mode logicalunit --tid <id> --lun <lun> --backing-store <path></code></span></dt><dd><p> - Add a new logical unit with <lun> to specific target with <id>. The - logical unit is offered to the initiators. <path> must be block device - files (including LVM and RAID devices) or regular files. lun0 is - reserved for a special device automatically created. - </p></dd><dt><span class="term"><code class="option">--lld <driver> --op delete --mode logicalunit --tid <id> --lun <lun></code></span></dt><dd><p> - Delete specific logical unit with <lun> that the target with <id> has. - </p></dd><dt><span class="term"><code class="option">--lld <driver> --op bind --mode target --tid <id> --initiator-address <address></code></span></dt><dd><p> - Add the address to the access lists of the target with <id>. Initiators - with the address can access to the target. 'ALL' is a special address - to allow all initiators to access to a target. - </p></dd><dt><span class="term"><code class="option">--lld <driver> --op unbind --mode target --tid <id> --initiator-address <address></code></span></dt><dd><p> - Delete the address from the access lists of the target with <id>. - </p></dd><dt><span class="term"><code class="option">--lld <driver> --op update --mode target --tid <id> --name=<parameter> --value=<value></code></span></dt><dd><p> - Change the value of <parameter> of the target with <id> to <value>. - </p></dd><dt><span class="term"><code class="option">--lld <driver> --op update --mode target --tid <id> --params parameter=value<,...></code></span></dt><dd><p> - Sets/changes the value of one or more parameters. - </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" title="LUN PARAMETERS"><a name="id269935"></a><h2>LUN PARAMETERS</h2><p> - These parameters are only applicable for "--mode logicalunit". - </p><div class="variablelist"><pre class="screen"> -Example: - -tgtadm --lld iscsi --mode logicalunit --op update \ - --tid <TID> --lun <LUN> \ - --params vendor_id=TGTD,product_id=VirtualHD,product_rev=0103 - </pre><pre class="screen"> -Example: - -tgtadm --lld iscsi --mode logicalunit --op update \ - --tid 1 --lun 1 \ - --params removable=1,sense_format=1,online=1 - </pre><pre class="screen"> -Examples: - -Create mode page '2', subpage 0 and 14 bytes of data. -This is Disconnect-Reconnect mode page. - -tgtadm --mode logicalunit --op update --tid 1 --lun 2 \ - --params mode_page=2:0:14:0x80:0x80:0:0xa:0:0:0:0:0:0:0:0:0:0 - - -Create mode page '10', subpage 0 and 10 bytes of data. -This is Control Extension mode page. - -tgtadm --lld iscsi --mode logicalunit --op update --tid 1 --lun 2 \ - --params mode_page=10:0:10:2:0:0:0:0:0:0:0:2:0 - - -Create mode page '0x1c', subpage 0 and 10 bytes of data. -This is Informational Exceptions Control mode page. - -tgtadm --lld iscsi --mode logicalunit --op update --tid 1 --lun 2 \ - --params mode_page=0x1c:0:10:8:0:0:0:0:0:0:0:0:0 - </pre><pre class="screen"> -tgtadm --lld iscsi --mode logicalunit --op update --tid 1 --lun 1 \ - --params readonly=1 - </pre><dl><dt><span class="term"><code class="option">vendor_id=<string></code></span></dt><dd><p> - This parameter sets the Vendor Identification string that a LUN - will report in INQURY data. - </p></dd><dt><span class="term"><code class="option">product_id=<string></code></span></dt><dd><p> - This parameter sets the Product Identification string that a LUN - will report in INQURY data. - </p></dd><dt><span class="term"><code class="option">product_rev=<string></code></span></dt><dd><p> - This parameter sets the Product Revision string that a LUN - will report in INQURY data. - </p></dd><dt><span class="term"><code class="option">removable=<0|1></code></span></dt><dd><p> - This can be used to override/change the default setting for - the removable flag. Disk devices default to non-removable while - DVD and TAPE devices default to removable. - </p></dd><dt><span class="term"><code class="option">sense_format=<0|1></code></span></dt><dd><p> - This flag controls the format of sense data that the device will - return. 0 = Clasic sense format, 1 = Support descriptor format. - </p></dd><dt><span class="term"><code class="option">online=<0|1></code></span></dt><dd><p> - This controls whether a device is online or not. - </p><p> - Devices default to be online when created but can be brought offline - using this parameter. Behaviour of offline devices depend on device - type. An MMC/DVD device that is offline will report that there is - no disk in the unit but the actual MMC/DVD unit itself can still - be communicated with. All other device types will fail all I/O - with a sense code of Not Ready. - </p></dd><dt><span class="term"><code class="option">mode_page=<byte-string></code></span></dt><dd><p> - This parameter is used to set specific mode pages for the device - and the mode page contents. Most devices default to reasonable - default mode pages automatically when the LUN is created, but this - allows special settings. - </p></dd><dt><span class="term"><code class="option">readonly=<0|1></code></span></dt><dd><p> - This sets the read-only flag of a LUN. A read-only LUN will - refuse any attempts to write data to it. - </p><p> - This parameter only applies to DISK devices. - </p></dd></dl></div></div><div class="refsect1" title="SMC SPECIFIC LUN PARAMETERS"><a name="id270108"></a><h2>SMC SPECIFIC LUN PARAMETERS</h2><p> - These parameters are only applicable for luns that are of type "changer" - i.e. the media changer device for a DVD Jukebox or a Virtual Tape Library. - </p><div class="variablelist"><pre class="screen"> -Example: How to create a DVD jukebox with eight disk trays and -two empty DVD-R disks. - - -# Create a target -tgtadm --lld iscsi --mode target --op new --tid 1 --targetname iqn.2007-03:virtual-dvd:`hostname` - -# Create a DVD drive and give it a nice name -# The dvd starts out without a backing store file, i.e. no disk loaded -tgtadm --op new --mode logicalunit --tid 1 --lun 1 --device-type cd -tgtadm --lld iscsi --mode logicalunit --op update --tid 1 --lun 1 --params vendor_id=STGT_DVD,product_id=DVD101,product_rev=0010,scsi_sn=STGTDVD01,removable=1 - -# We need a backend store file for the media changer -if [ ! -f $HOME/smc ]; then - dd if=/dev/zero of=$HOME/smc bs=1k count=1 -fi - -# Create the SMC device and give it a nice name -tgtadm --lld iscsi --mode logicalunit --op new --tid 1 --lun 2 --backing-store $HOME/smc --device-type changer -tgtadm --lld iscsi --mode logicalunit --op update --tid 1 --lun 2 --params vendor_id=STK,product_id=L700,product_rev=0010,scsi_sn=XYZZY_0,removable=1 - -# Add a Data Transfer devices (1 drive) -tgtadm --lld iscsi --mode logicalunit --op update --tid 1 --lun 2 --params element_type=4,start_address=1,quantity=1 - -# Specify that the DVD above (LUN 1) is the data transfer device we created -tgtadm --lld iscsi --mode logicalunit --op update --tid 1 --lun 2 --params element_type=4,address=1,tid=1,lun=1 - -# Medium Transport Elements (robot arm / picker) -tgtadm --lld iscsi --mode logicalunit --op update --tid 1 --lun 2 --params element_type=1,start_address=16,quantity=1 - -# define path to virtual media -VTL=${HOME}/vtl -mkdir -p ${VTL} -tgtadm --lld iscsi --mode logicalunit --op update --tid 1 --lun 2 --params media_home=${VTL} - -# Storage Elements - 8 starting at addr 1024 -tgtadm --lld iscsi --mode logicalunit --op update --tid 1 --lun 2 --params element_type=2,start_address=1024,quantity=8 - -# Add 'media' to slots 1 and 2 and leave the other 6 slots empty -# slot 1 -# Create empty writeable virtual DVD-R media -tgtimg --op new --device-type cd --type dvd+r --file ${VTL}/DISK_001 -tgtadm --lld iscsi --mode logicalunit --op update --tid 1 --lun 2 --params element_type=2,address=1024,barcode=DISK_001,sides=1 - -# slot 2 -tgtimg --op new --device-type cd --type dvd+r --file ${VTL}/DISK_002 -tgtadm --lld iscsi --mode logicalunit --op update --tid 1 --lun 2 --params element_type=2,address=1025,barcode=DISK_002,sides=1 - -# Allow ALL initiators to connect to this target -tgtadm --lld iscsi --mode target --op bind --tid 1 --initiator-address ALL - -# Show all our good work. -tgtadm --lld iscsi --mode target --op show - </pre><dl><dt><span class="term"><code class="option">element_type=<1|2|3|4></code></span></dt><dd><p> - This controls which type of element a certain slot in the - jukebox/vtl is. - </p><pre class="screen"> -Slot types: - 1 -> Medium Transport (picker arm) - 2 -> Storage Element - 3 -> Import/Export Element - 4 -> Data Transfer device (CD drive, tape drive, MO drive etc) - </pre></dd><dt><span class="term"><code class="option">address=<1-65535></code></span></dt><dd><p> - This is used to create/operate on a single slot. - Address specifies the slot on which to perform the operation. - </p></dd><dt><span class="term"><code class="option">start_address=<1-65535>,quantity=<1--65535></code></span></dt><dd><p> - This is used to create/operate on an entire range of slots at once. - Start_address specifies the first address to operate on and - quantity specifies the number of consequtive slots. - </p></dd><dt><span class="term"><code class="option">sides=<1|2></code></span></dt><dd><p> - When creating storage elements, i.e. "element_type=2", this - parameter specifies if the media has 1 or two sides to hold data. - </p></dd><dt><span class="term"><code class="option">barcode=<string></code></span></dt><dd><p> - This is used to assign a barcode to an element. - </p></dd><dt><span class="term"><code class="option">media_home=<string></code></span></dt><dd><p> - This parameter specifies a directory where all virtual media - for the dvd/tape device elements are stored. - </p><p> - To assign a media image file to a storage element slot, - you assign "barcode" to be the name of the image file in - the "media_home" directory. - </p></dd></dl></div></div><div class="refsect1" title="Passthrough devices"><a name="id270268"></a><h2>Passthrough devices</h2><p> - In addition to device emulation TGTD also supports utilizing existing SG devices on the host and exporting these through a special passthrough device type. - </p><dt><span class="term"><code class="option">--bstype=sg</code></span></dt><dd><p> - This specifies that an SG devices is used. - </p></dd><dt><span class="term"><code class="option">--device-type=pt</code></span></dt><dd><p> - This specifies that passthrough device type is used. - </p></dd><dt><span class="term"><code class="option">--backing-store=</dev/sg4></code></span></dt><dd><p> - This specifies which device to export through TGTD. - </p></dd><pre class="screen"> -Example: -Make /dev/sg4 available to initiators connecting to TGTD. - -tgtadm --lld iscsi --op new --mode logicalunit --tid 1 --lun 1 --bstype=sg --device-type=pt --backing-store=/dev/sg4 - </pre></div><div class="refsect1" title="Header Digest and Data Digest"><a name="id270326"></a><h2>Header Digest and Data Digest</h2><p> - Header and data digests can be set on a per target parameter. - TGTD supports two modes, None and CRC32C. - When the digest is set to None, TDTD will negotiate that digests - will not be used, and when CRC32C is set, TGTD will force the - connection to use digest. - </p><div class="refsect2" title="Viewing the current settings"><a name="id270337"></a><h3>Viewing the current settings</h3><p> - This command is used to view the current settings for header/data - digest. - </p><pre class="screen"> -tgtadm --op show --mode target --tid 1 - ... - HeaderDigest=None - DataDigest=None - ... - </pre></div><div class="refsect2" title="Setting digest"><a name="id270353"></a><h3>Setting digest</h3><pre class="screen"> -Set header digest to CRC32C: -tgtadm --op update --mode target --tid 1 -n HeaderDigest -v CRC32C - -Set data digest to None: -tgtadm --op update --mode target --tid 1 -n DataDigest -v None - </pre></div></div><div class="refsect1" title="CHAP Authentication"><a name="id270367"></a><h2>CHAP Authentication</h2><p> - CHAP authentication is supported to require authentication before - an initiator is allowed to log in and access devices. - TGTD supports setting CHAP for normal log in sessions only, not - for discovery sessions. Discovery sessions are always possible - without authentication. - </p><p> - CHAP authentication is set on the target level. - To set up CHAP authentication we first need to create an account - and its associated password, then we bind the account to one or more - targets. - </p><div class="refsect2" title="Setting CHAP on a target"><a name="id270382"></a><h3>Setting CHAP on a target</h3><p> - These two commands create a user account and binds it to target 1. - </p><pre class="screen"> -tgtadm --lld iscsi --op new --mode account --user ronnie --password password -tgtadm --lld iscsi --op bind --mode account --tid 1 --user ronnie - </pre></div><div class="refsect2" title="List all accounts"><a name="id270399"></a><h3>List all accounts</h3><p> - This command is used to list all accounts that have been created. - </p><pre class="screen"> -tgtadm --lld iscsi --op show --mode account -Account list: - ronnie - </pre></div><div class="refsect2" title="Show if a target requires authentication"><a name="id270415"></a><h3>Show if a target requires authentication</h3><p> - When listing the targets, each target that has authantication enabled - will contain a listing of all accoutns bound to that target. - </p><pre class="screen"> -tgtadm --lld iscsi --op show --mode target -Target 1: iqn.ronnie.test -... -Account information: - ronnie -... - </pre></div></div><div class="refsect1" title="iSCSI PORTALS"><a name="id270433"></a><h2>iSCSI PORTALS</h2><p> - iSCSI portals can be viewed, added and removed at runtime. - </p><div class="refsect2" title="List portals"><a name="id270441"></a><h3>List portals</h3><p> - This command is used to list the current iSCSI portals defined on the target: - </p><pre class="screen"> -tgtadm --lld iscsi --op show --mode portal -Portal: 10.1.1.101:3260,1 -Portal: 127.0.0.1:3260,1 - </pre></div><div class="refsect2" title="Add portal"><a name="id270457"></a><h3>Add portal</h3><p> - This command is used to add a portal to the target : - </p><pre class="screen"> -tgtadm --lld iscsi --op new --mode portal --param portal=10.1.1.101:3260 - </pre></div><div class="refsect2" title="Remove portal"><a name="id270473"></a><h3>Remove portal</h3><p> - This command is used to remove a portal from the target : - </p><pre class="screen"> -tgtadm --lld iscsi --op delete --mode portal --param portal=10.1.1.101:3260 - </pre></div></div><div class="refsect1" title="iSCSI CONNECTIONS"><a name="id270490"></a><h2>iSCSI CONNECTIONS</h2><p> - iSCSI connections can be viewed and forced closed at runtime. - </p><div class="refsect2" title="List all active connections for a target"><a name="id270498"></a><h3>List all active connections for a target</h3><p> - This command is used to list the all the active iSCSI connections to the target with connection id, initiator name and ip address for the initiator : - </p><pre class="screen"> -tgtadm --lld iscsi --op show --mode conn --tid 1 -Session: 2 - Connection: 0 - Initiator: iqn.2008-11.org.linux-kvm: - IP Address: 127.0.0.1 - </pre></div><div class="refsect2" title="Close an existing connection"><a name="id270516"></a><h3>Close an existing connection</h3><p> - This command is used to close an iSCSI connection. Note that forcibly closing iSCSI connections can lead to data-loss. - </p><pre class="screen"> -tgtadm --lld iscsi --op delete --mode conn --tid 1 --sid 2 --cid 0 - </pre></div></div><div class="refsect1" title="iSNS PARAMETERS"><a name="id270533"></a><h2>iSNS PARAMETERS</h2><p> - iSNS configuration for a target is by using the tgtadm command. - </p><div class="variablelist"><pre class="screen"> -Example: - -tgtadm --op update --mode sys --name iSNSServerIP --value 192.168.11.133 - </pre><pre class="screen"> -Example: - -tgtadm --op update --mode sys --name iSNS --value On - </pre><pre class="screen"> -Example: - -tgtadm --op update --mode sys --name iSNSServerPort --value 3205 - </pre><pre class="screen"> -Example: - -tgtadm --op update --mode sys --name iSNSAccessControl --value Off - </pre><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" title="SEE ALSO"><a name="id270627"></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" title="REPORTING BUGS"><a name="id270641"></a><h2>REPORTING BUGS</h2><p> - Report bugs to <stgt@xxxxxxxxxxxxxxx> - </p></div></div></body></html> diff --git a/doc/htmlpages/tgtd.8.html b/doc/htmlpages/tgtd.8.html deleted file mode 100644 index 2e31297..0000000 --- a/doc/htmlpages/tgtd.8.html +++ /dev/null @@ -1,63 +0,0 @@ -<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>tgtd</title><meta name="generator" content="DocBook XSL Stylesheets V1.75.2"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" title="tgtd"><a name="tgtd.8"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>tgtd — The SCSI Target Daemon</p></div><div class="refsynopsisdiv" title="Synopsis"><h2>Synopsis</h2><div class="cmdsynopsis"><p><code class="command">tgtd</code> </p></div><div class="cmdsynopsis"><p><code class="command">tgtd</code> [-C --control-port <INTEGER>] [-d --debug <INTEGER>] [-f --foregound] [-h --help] [--iscsi <...>]</p></div></div><div class="refsect1" title="DESCRIPTION"><a name="id283058"></a><h2>DESCRIPTION</h2><p> - Tgtd is a SCSI Target daemon. It can be used to provide SCSI target - service to a network. The most common service is iSCSI but other services are also - supported. - </p></div><div class="refsect1" title="Device types"><a name="id283068"></a><h2>Device types</h2><p> - Tgtd provides support for both emulated and passthrough of real devices. - </p></div><pre class="screen"> - Tgtd can emulate the following types of devices: - - disk : Normal disk device. Emulates a SCSI harddisk. - tape : Tape device. Emulates a SCSI tape drive. - cd : CD device. Emulates a SCSI DVD burner. - changer : Media changer. Emulate the changer device for a virtual tape library or DVD jukebox. - </pre><div class="refsect1" title="OPTIONS"><a name="id283085"></a><h2>OPTIONS</h2><div class="variablelist"><dl><dt><span class="term">-d --debug <INTEGER></span></dt><dd><p> - Set to non-zero value to activate additional debugging messages to - be logged. - </p></dd><dt><span class="term">-f --foreground</span></dt><dd><p> - Run the daemon in the foreground. - </p></dd><dt><span class="term">-h --help</span></dt><dd><p> - Print help text to the screen. - </p></dd><dt><span class="term">-C --control-port <INTEGER></span></dt><dd><p> - This comamnd is used to specify the control port to use for - this instance of tgtd. This allows to run multiple instances of - TGTD on a host. - </p><p> - TGTADM has a matching argument to control which instance to connect - to. - </p></dd><dt><span class="term">--iscsi <...></span></dt><dd><p> - ISCSI specific options. - See the ISCSI section below for options specific to this frontend. - </p></dd></dl></div></div><div class="refsect1" title="ISCSI options"><a name="id283167"></a><h2>ISCSI options</h2><p> - These parameters apply only to the iSCSI frontend. - </p><div class="refsect2" title="portal=<ip-address[:port]>"><a name="id283175"></a><h3>portal=<ip-address[:port]></h3><p> - This option is used to bind tgtd to a specific ip-address/portal and/or - port. By default tgtd will bind to port 3260 on the wildcard address. - The ip-address part (before the ":") can be missing to designate the - wildcard address with a none-default port. - </p><p> - Example: to bind tgtd to a specific address and port - </p><pre class="screen"> - tgtd --iscsi portal=192.0.2.1:3260 - </pre><p> - Example: to bind tgtd to any address but a none-default port - </p><pre class="screen"> - tgtd --iscsi portal=:3251 - </pre><p> - </p></div></div><div class="refsect1" title="SEE ALSO"><a name="id283204"></a><h2>SEE ALSO</h2><p> - tgtadm(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" title="COPYRIGHT/LICENSE"><a name="id283218"></a><h2>COPYRIGHT/LICENSE</h2><div class="literallayout"><p><br> -This program is free software; you can redistribute it and/or modify<br> -it under the terms of the GNU General Public License as published by<br> -the Free Software Foundation; either version 2 of the License, or (at<br> -your option) any later version.<br> -<br> -This program is distributed in the hope that it will be useful, but<br> -WITHOUT ANY WARRANTY; without even the implied warranty of<br> -MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU<br> -General Public License for more details.<br> -<br> -You should have received a copy of the GNU General Public License<br> -along with this program; if not, see http://www.gnu.org/licenses/.<br> -</p></div></div></div></body></html> diff --git a/doc/htmlpages/tgtimg.8.html b/doc/htmlpages/tgtimg.8.html deleted file mode 100644 index f689149..0000000 --- a/doc/htmlpages/tgtimg.8.html +++ /dev/null @@ -1,66 +0,0 @@ -<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>tgtimg</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="tgtimg.8"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>tgtimg — Linux SCSI Target Framework Image File Utility</p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><div class="cmdsynopsis"><p><code class="command">tgtimg</code> [-o --op <operation>] [-Y --device-type <device-type>] [-b --barcode <barcode>] [-s --size <size>] [-t --type <media-type>] [-f --file <path>]</p></div><div class="cmdsynopsis"><p><code class="command">tgtimg --help</code> </p></div></div><div class="refsect1" lang="en"><a name="id2476008"></a><h2>DESCRIPTION</h2><p> - Tgtimg is a utility to create and manage the image files used by the - TGTD device emulation. - </p><p> - This command is used to initialize device image files with the additional - metadata, such as barcode, list of blocks, total size, etc that - the TGTD emulation needs. - </p></div><div class="refsect1" lang="en"><a name="id2476026"></a><h2>OPTIONS</h2><div class="variablelist"><pre class="screen"> -Supported device types are : - cd : to create media for a dvd device - disk : to create media for a disk device - tape : to create media for a tape device - </pre><pre class="screen"> -Supported media types for cd devices are : - dvd+r : create a blank writeable DVD+R disk - -Supported media types for disk devices are : - disk : create an empty disk - -Supported media types for tape devices are : - data : create a normal data tape - clean : create a cleaning tape - worm : create a worm - </pre><dl><dt><span class="term"><code class="option">-h, --help</code></span></dt><dd><p> - Show a help screen and exit. - </p></dd><dt><span class="term"><code class="option">-o, --op {new|show}</code></span></dt><dd><p> - Operation. Is either new to create a new image file or show to - show the content of an existing image file. - </p></dd><dt><span class="term"><code class="option">-Y, --device-type <type></code></span></dt><dd><p> - This specifies the type of image file. - </p></dd><dt><span class="term"><code class="option">-t, --type <media-type></code></span></dt><dd><p> - When creating a new image, this specifies the type of media to - emulate. The available mediatypes depend on the type of the - device. - </p></dd><dt><span class="term"><code class="option">-b, --barcode <barcode></code></span></dt><dd><p> - When creating a new image, this argument specifies the barcode - to use with this image file. Backup application software often - uses barcodes to identify specific tapes. When emulating a VTL, - make sure that all tape images use unique barcodes. - </p></dd><dt><span class="term"><code class="option">-s, --size <size></code></span></dt><dd><p> - When creating a new image, this specifies the size in megabytes - for the virtual tape image. - </p></dd><dt><span class="term"><code class="option">-f, --file <path></code></span></dt><dd><p> - The filename of the image file. - </p></dd></dl></div></div><div class="refsect1" lang="en"><a name="id2476166"></a><h2>EXAMPLES</h2><p> - To create a new 100MByte disk - </p><pre class="screen"> - tgtimg --op new --device-type disk --type disk --size 100 --file /data/hd001.raw - </pre><p> - To create a new tape image - </p><pre class="screen"> - tgtimg --op new --device-type tape --barcode 12345 --size 100 --type data --file /data/tape001.img - </pre><p> - To view the content of an existing image - </p><pre class="screen"> - tgtimg --op show --device-type tape --file /data/tape001.img - </pre><p> - To create a new blank DVD+R image - </p><pre class="screen"> - tgtimg --op new --device-type cd --type dvd+r --file /data/dvd001.iso - </pre></div><div class="refsect1" lang="en"><a name="id2476217"></a><h2>SEE ALSO</h2><p> - tgtd(8), tgtadm(8), tgt-admin(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="id2476232"></a><h2>REPORTING BUGS</h2><p> - Report bugs to <stgt@xxxxxxxxxxxxxxx> - </p></div></div></body></html> diff --git a/doc/manpages/tgt-admin.8 b/doc/manpages/tgt-admin.8 deleted file mode 100644 index e6c6b06..0000000 --- a/doc/manpages/tgt-admin.8 +++ /dev/null @@ -1,231 +0,0 @@ -.\" Title: tgt-admin -.\" Author: -.\" Generator: DocBook XSL Stylesheets v1.73.2 <http://docbook.sf.net/> -.\" Date: 07/29/2010 -.\" Manual: -.\" Source: -.\" -.TH "TGT\-ADMIN" "8" "07/29/2010" "" "" -.\" disable hyphenation -.nh -.\" disable justification (adjust text to left margin only) -.ad l -.SH "NAME" -tgt-admin \- Linux SCSI Target Configuration Tool -.SH "SYNOPSIS" -.HP 10 -\fBtgt\-admin\fR [\-e\ \-\-execute] [\-\-delete\ <value>] [\-\-offline\ <value>] [\-\-ready\ <value>] [\-s\ \-\-show] [\-C\ \-\-control\-port\ <NNNN>] [\-c\ \-\-conf\ <file>] [\-\-ignore\-errors] [\-f\ \-\-force] [\-p\ \-\-pretend] [\-\-dump] [\-v\ \-\-verbose] [\-h\ \-\-help] -.SH "DESCRIPTION" -.PP -tgt\-admin is a utility which allows a persistent configuration of targets and luns\&. It uses tgtadm commands to create, delete and show targets\&. -.SH "OPTIONS" -.PP -\fB\-e, \-\-execute\fR -.RS 4 -Read /etc/tgt/targets\&.conf and execute tgtadm commands\&. If the target already exists, it won\'t be processed\&. See \-\-update\&. -.RE -.PP -\fB\-d, \-\-delete <value>\fR -.RS 4 -Delete all or selected targets\&. The target will be deleted only if it\'s not used (no initiator is connected to it)\&. -.sp -If you want to delete targets which are in use, you have to add the "\-\-force" flag\&. -.sp -.RS 4 -.nf -Example usage: - \-\-delete ALL \- delete all targets - \-\-delete tid=4 \- delete target 4 - (target with tid 4) - \-\-delete iqn\&.2008\-08\&.com\&.example:some\&.target - \- delete this target - -.fi -.RE -.sp -.RE -.PP -\fB\-\-offline\fR -.RS 4 -Put all or selected targets in offline state\&. -.sp -.RS 4 -.nf -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 - -.fi -.RE -.sp -.RE -.PP -\fB\-\-ready\fR -.RS 4 -Put all or selected targets in ready state\&. -.sp -.RS 4 -.nf -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 - -.fi -.RE -.sp -.RE -.PP -\fB\-\-update <value>\fR -.RS 4 -Update all or selected targets\&. The target will be updated only if it\'s not used (no initiator is connected to it)\&. -.sp -If you want to update targets which are in use, you have to add "\-\-force" flag\&. -.sp -.RS 4 -.nf -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 - -.fi -.RE -.sp -.RE -.PP -\fB\-s, \-\-show\fR -.RS 4 -Show all the targets\&. -.RE -.PP -\fB\-C, \-\-control\-port <NNNN>\fR -.RS 4 -It is possible to run multiple concurrent instances of tgtd on a host\&. This argument is used to control which instance the tgt\-admin command will operate on\&. -.RE -.PP -\fB\-c, \-\-conf <configuration file>\fR -.RS 4 -Specify an alternative configuration file instead of /etc/tgt/target\&.conf, which is the default\&. -.RE -.PP -\fB\-\-ignore\-errors\fR -.RS 4 -Continue even if tgtadm exits with non\-zero code\&. -.RE -.PP -\fB\-f, \-\-force\fR -.RS 4 -Force some operations even if the target is in use\&. -.RE -.PP -\fB\-p, \-\-pretend\fR -.RS 4 -Only print tgtadm options which would be used; don\'t execute any actions\&. Assumes \-v\&. -.RE -.PP -\fB\-\-dump\fR -.RS 4 -Dump current tgtd configuration\&. Note: does not include detailed parameters, like write caching\&. -.RE -.PP -\fB\-v, \-\-verbose\fR -.RS 4 -Increase verbosity (show tgtadm commands used)\&. -.RE -.PP -\fB\-h, \-\-help\fR -.RS 4 -Display a list of available options and exit\&. -.RE -.SH "CONFIGURATION FILE SYNTAX" -.PP -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\&. -.PP -\fBbacking\-store\fR -.RS 4 -Defines a virtual device on the target\&. -.RE -.PP -\fBdirect\-store\fR -.RS 4 -Defines a direct mapped device with the same properties as the physical device (such as VENDOR_ID, SERIAL_NUM, etc\&.) -.RE -.PP -\fBinitiator\-address\fR -.RS 4 -Allows connections only from the specified IP address\&. Defaults to ALL if no "initiator\-address" is specified\&. -.RE -.PP -\fBincominguser\fR -.RS 4 -Define iscsi incoming authentication setting\&. If no "incominguser" is specified, it is not used\&. -.RE -.PP -\fBoutgoinguser\fR -.RS 4 -Define iscsi outgoing authentication setting\&. If no "outgoinguser" is specified, it is not used\&. -.sp -.RS 4 -.nf -Example configuration file: - -<target iqn\&.2007\-04\&.com\&.example:san\&.monitoring> -backing\-store /dev/san/monitoring - -# if no "incominguser" is specified, it is not used -incominguser backup secretpass12 - -# defaults to ALL if no "initiator\-address" is specified -initiator\-address 192\&.168\&.1\&.2 -</target> - -<target iqn\&.2007\-02\&.com\&.example:san\&.xen1> -backing\-store /dev/san/xen1\-disk1 # LUN1 -direct\-store /dev/san/xen1\-disk2 # LUN2 - -initiator\-address 192\&.168\&.1\&.2 # Allowed IP -initiator\-address 192\&.168\&.5\&.6 # Allowed IP - -incominguser user1 secretpass12 -incominguser user2 secretpass23 - -outgoinguser userA secretpassA -</target> - -<target iqn\&.2007\-02\&.com\&.example:san\&.xen2> -backing\-store /dev/san/xen2 -</target> - -<target iqn\&.2007\-06\&.com\&.example:san\&.vmware1> -backing\-store /dev/san/vmware1 -</target> - -.fi -.RE -.RE -.SH "FILES" -.PP -\fB/etc/tgt/targets\&.conf\fR -.RS 4 -Configuration file for tgt\-admin\&. -.RE -.PP -\fB/usr/share/doc/tgt/targets\&.conf\&.example\fR -.RS 4 -Example configuration file for tgt\-admin\&. -.RE -.SH "SEE ALSO" -.PP -tgtd(8), tgtadm(8), tgtimg(8), tgt\-setup\-lun(8)\&. -\fI\%http://stgt.sourceforge.net/\fR -.SH "REPORTING BUGS" -.PP -Report bugs to <stgt@vger\&.kernel\&.org> diff --git a/doc/manpages/tgt-setup-lun.8 b/doc/manpages/tgt-setup-lun.8 deleted file mode 100644 index c1045e8..0000000 --- a/doc/manpages/tgt-setup-lun.8 +++ /dev/null @@ -1,46 +0,0 @@ -.de Vb \" Begin verbatim text -.ft CW -.nf -.ne \\$1 -.. - -.TH "tgt-setup-lun" 8 -.SH NAME -tgt-setup-lun \- creates a target, adds a device to the target and defines initiators that can connect to the target -.SH SYNOPSIS -.B tgt-setup-lun -d device -n target_name [initiator_IP1 initiator_IP2 ...] [-h] - -.SH DESCRIPTION -Starts tgtd if necessary and creates a target according to the supplied target_name. The format of the target name is as follows: -.br -iqn.2001-04.com.<hostname>-<target_name> -The target name must be unique. - -The script then adds the requested device to the target. If specific IP addresses are defined, it adds them to the -list of allowed initiators for that target. If no IP addresses is defined, it defines that the target accepts any -initiator. - -.SH EXAMPLES -Create a target that uses /dev/sdb1 and allows connections only from 192.168.10.81: -.br -tgt-setup-lun -d /dev/sdb1 -n my_target 192.168.10.81 - -Create a target that uses /dev/sdb1 and allows connections only from 192.168.10.81 and 192.168.10.82: -.br -tgt-setup-lun -d /dev/sdb1 -n my_target 192.168.10.81 192.168.10.82 - -Create a target that uses /dev/sdb1 and allows connections from any initiator: -.br -tgt-setup-lun -d /dev/sdb1 -n my_target - -Display help: -.br -tgt-setup-lun -h - -.SH AUTHOR -Written by Erez Zilber -.SH "REPORTING BUGS" -.PP -Report bugs to <stgt@vger\&.kernel\&.org> -.SH COPYRIGHT -Copyright \(co Voltaire Ltd. 2008. diff --git a/doc/manpages/tgtadm.8 b/doc/manpages/tgtadm.8 deleted file mode 100644 index 7558ff0..0000000 --- a/doc/manpages/tgtadm.8 +++ /dev/null @@ -1,663 +0,0 @@ -'\" t -.\" Title: tgtadm -.\" Author: [FIXME: author] [see http://docbook.sf.net/el/author] -.\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/> -.\" Date: 05/08/2011 -.\" Manual: [FIXME: manual] -.\" Source: [FIXME: source] -.\" Language: English -.\" -.TH "TGTADM" "8" "05/08/2011" "[FIXME: source]" "[FIXME: manual]" -.\" ----------------------------------------------------------------- -.\" * 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" -tgtadm \- Linux SCSI Target Administration Utility -.SH "SYNOPSIS" -.HP \w'\fBtgtadm\ [OPTIONS]\&.\&.\&.\fR\ 'u -\fBtgtadm [OPTIONS]\&.\&.\&.\fR [\-C\ \-\-control\-port\ <port>] [\-L\ \-\-lld\ <driver>] [\-o\ \-\-op\ <operation>] [\-m\ \-\-mode\ <mode>] [\-t\ \-\-tid\ <id>] [\-T\ \-\-targetname\ <targetname>] [\-Y\ \-\-device\-type\ <type>] [\-l\ \-\-lun\ <lun>] [\-b\ \-\-backing\-store\ <path>] [\-E\ \-\-bstype\ <type>] [\-I\ \-\-initiator\-address\ <address>] [\-n\ \-\-name\ <parameter>] [\-v\ \-\-value\ <value>] [\-P\ \-\-params\ <param=value[,param=value\&.\&.\&.]>] [\-h\ \-\-help] -.SH "DESCRIPTION" -.PP -tgtadm is used to monitor and modify everything about Linux SCSI target software: targets, volumes, etc\&. -.SH "OPTIONS" -.PP -\fB\-C, \-\-control\-port <port>\fR -.RS 4 -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\&. -.RE -.PP -\fB\-Y, \-\-device\-type <type>\fR -.RS 4 -When creating a LUN, this parameter specifies the type of device to create\&. Default is disk\&. -.RE -.sp -.if n \{\ -.RS 4 -.\} -.nf -Possible device\-types are: - disk : emulate a disk device - tape : emulate a tape reader - ssc : same as tape - cd : emulate a DVD drive - changer : emulate a media changer device - pt : passthrough type to export a /dev/sg device - -.fi -.if n \{\ -.RE -.\} -.PP -\fB\-E, \-\-bstype <type>\fR -.RS 4 -When creating a LUN, this parameter specifies the type of backend storage to to use\&. -.RE -.sp -.if n \{\ -.RS 4 -.\} -.nf -Possible backend types are: - rdwr : Use normal file I/O\&. This is the default for disk devices - aio : Use Asynchronous I/O - mmap : Use memory mapping for the backend file - - sg : Special backend type for passthrough devices - ssc : Special backend type for tape emulation - -.fi -.if n \{\ -.RE -.\} -.PP -\fB\-\-lld <driver> \-\-op new \-\-mode target \-\-tid <id> \-\-targetname <name>\fR -.RS 4 -Add a new target with <id> and <name>\&. -.RE -.PP -\fB\-\-lld <driver> \-\-op delete \-\-mode target \-\-tid <id>\fR -.RS 4 -Delete specific target with <id>\&. The target must have no active I_T nexus\&. -.RE -.PP -\fB\-\-lld <driver> \-\-op show \-\-mode target\fR -.RS 4 -Show all the targets\&. -.RE -.PP -\fB\-\-lld <driver> \-\-op show \-\-mode target \-\-tid <id>\fR -.RS 4 -Show target parameters of a target with <id>\&. -.RE -.PP -\fB\-\-lld <driver> \-\-op new \-\-mode logicalunit \-\-tid <id> \-\-lun <lun> \-\-backing\-store <path>\fR -.RS 4 -Add a new logical unit with <lun> to specific target with <id>\&. The logical unit is offered to the initiators\&. <path> must be block device files (including LVM and RAID devices) or regular files\&. lun0 is reserved for a special device automatically created\&. -.RE -.PP -\fB\-\-lld <driver> \-\-op delete \-\-mode logicalunit \-\-tid <id> \-\-lun <lun>\fR -.RS 4 -Delete specific logical unit with <lun> that the target with <id> has\&. -.RE -.PP -\fB\-\-lld <driver> \-\-op bind \-\-mode target \-\-tid <id> \-\-initiator\-address <address>\fR -.RS 4 -Add the address to the access lists of the target with <id>\&. Initiators with the address can access to the target\&. \*(AqALL\*(Aq is a special address to allow all initiators to access to a target\&. -.RE -.PP -\fB\-\-lld <driver> \-\-op unbind \-\-mode target \-\-tid <id> \-\-initiator\-address <address>\fR -.RS 4 -Delete the address from the access lists of the target with <id>\&. -.RE -.PP -\fB\-\-lld <driver> \-\-op update \-\-mode target \-\-tid <id> \-\-name=<parameter> \-\-value=<value>\fR -.RS 4 -Change the value of <parameter> of the target with <id> to <value>\&. -.RE -.PP -\fB\-\-lld <driver> \-\-op update \-\-mode target \-\-tid <id> \-\-params parameter=value<,\&.\&.\&.>\fR -.RS 4 -Sets/changes the value of one or more parameters\&. -.RE -.PP -\fB\-\-help\fR -.RS 4 -Display a list of available options and exits\&. -.RE -.SH "LUN PARAMETERS" -.PP -These parameters are only applicable for "\-\-mode logicalunit"\&. -.PP -\fBvendor_id=<string>\fR -.RS 4 -This parameter sets the Vendor Identification string that a LUN will report in INQURY data\&. -.RE -.PP -\fBproduct_id=<string>\fR -.RS 4 -This parameter sets the Product Identification string that a LUN will report in INQURY data\&. -.RE -.PP -\fBproduct_rev=<string>\fR -.RS 4 -This parameter sets the Product Revision string that a LUN will report in INQURY data\&. -.RE -.sp -.if n \{\ -.RS 4 -.\} -.nf -Example: - -tgtadm \-\-lld iscsi \-\-mode logicalunit \-\-op update \e - \-\-tid <TID> \-\-lun <LUN> \e - \-\-params vendor_id=TGTD,product_id=VirtualHD,product_rev=0103 - -.fi -.if n \{\ -.RE -.\} -.PP -\fBremovable=<0|1>\fR -.RS 4 -This can be used to override/change the default setting for the removable flag\&. Disk devices default to non\-removable while DVD and TAPE devices default to removable\&. -.RE -.PP -\fBsense_format=<0|1>\fR -.RS 4 -This flag controls the format of sense data that the device will return\&. 0 = Clasic sense format, 1 = Support descriptor format\&. -.RE -.PP -\fBonline=<0|1>\fR -.RS 4 -This controls whether a device is online or not\&. -.sp -Devices default to be online when created but can be brought offline using this parameter\&. Behaviour of offline devices depend on device type\&. An MMC/DVD device that is offline will report that there is no disk in the unit but the actual MMC/DVD unit itself can still be communicated with\&. All other device types will fail all I/O with a sense code of Not Ready\&. -.RE -.sp -.if n \{\ -.RS 4 -.\} -.nf -Example: - -tgtadm \-\-lld iscsi \-\-mode logicalunit \-\-op update \e - \-\-tid 1 \-\-lun 1 \e - \-\-params removable=1,sense_format=1,online=1 - -.fi -.if n \{\ -.RE -.\} -.PP -\fBmode_page=<byte\-string>\fR -.RS 4 -This parameter is used to set specific mode pages for the device and the mode page contents\&. Most devices default to reasonable default mode pages automatically when the LUN is created, but this allows special settings\&. -.RE -.sp -.if n \{\ -.RS 4 -.\} -.nf -Examples: - -Create mode page \*(Aq2\*(Aq, subpage 0 and 14 bytes of data\&. -This is Disconnect\-Reconnect mode page\&. - -tgtadm \-\-mode logicalunit \-\-op update \-\-tid 1 \-\-lun 2 \e - \-\-params mode_page=2:0:14:0x80:0x80:0:0xa:0:0:0:0:0:0:0:0:0:0 - - -Create mode page \*(Aq10\*(Aq, subpage 0 and 10 bytes of data\&. -This is Control Extension mode page\&. - -tgtadm \-\-lld iscsi \-\-mode logicalunit \-\-op update \-\-tid 1 \-\-lun 2 \e - \-\-params mode_page=10:0:10:2:0:0:0:0:0:0:0:2:0 - - -Create mode page \*(Aq0x1c\*(Aq, subpage 0 and 10 bytes of data\&. -This is Informational Exceptions Control mode page\&. - -tgtadm \-\-lld iscsi \-\-mode logicalunit \-\-op update \-\-tid 1 \-\-lun 2 \e - \-\-params mode_page=0x1c:0:10:8:0:0:0:0:0:0:0:0:0 - -.fi -.if n \{\ -.RE -.\} -.PP -\fBreadonly=<0|1>\fR -.RS 4 -This sets the read\-only flag of a LUN\&. A read\-only LUN will refuse any attempts to write data to it\&. -.sp -This parameter only applies to DISK devices\&. -.RE -.sp -.if n \{\ -.RS 4 -.\} -.nf -tgtadm \-\-lld iscsi \-\-mode logicalunit \-\-op update \-\-tid 1 \-\-lun 1 \e - \-\-params readonly=1 - -.fi -.if n \{\ -.RE -.\} -.SH "SMC SPECIFIC LUN PARAMETERS" -.PP -These parameters are only applicable for luns that are of type "changer" i\&.e\&. the media changer device for a DVD Jukebox or a Virtual Tape Library\&. -.PP -\fBelement_type=<1|2|3|4>\fR -.RS 4 -This controls which type of element a certain slot in the jukebox/vtl is\&. -.sp -.if n \{\ -.RS 4 -.\} -.nf -Slot types: - 1 \-> Medium Transport (picker arm) - 2 \-> Storage Element - 3 \-> Import/Export Element - 4 \-> Data Transfer device (CD drive, tape drive, MO drive etc) - -.fi -.if n \{\ -.RE -.\} -.RE -.PP -\fBaddress=<1\-65535>\fR -.RS 4 -This is used to create/operate on a single slot\&. Address specifies the slot on which to perform the operation\&. -.RE -.PP -\fBstart_address=<1\-65535>,quantity=<1\-\-65535>\fR -.RS 4 -This is used to create/operate on an entire range of slots at once\&. Start_address specifies the first address to operate on and quantity specifies the number of consequtive slots\&. -.RE -.PP -\fBsides=<1|2>\fR -.RS 4 -When creating storage elements, i\&.e\&. "element_type=2", this parameter specifies if the media has 1 or two sides to hold data\&. -.RE -.PP -\fBbarcode=<string>\fR -.RS 4 -This is used to assign a barcode to an element\&. -.RE -.PP -\fBmedia_home=<string>\fR -.RS 4 -This parameter specifies a directory where all virtual media for the dvd/tape device elements are stored\&. -.sp -To assign a media image file to a storage element slot, you assign "barcode" to be the name of the image file in the "media_home" directory\&. -.RE -.sp -.if n \{\ -.RS 4 -.\} -.nf -Example: How to create a DVD jukebox with eight disk trays and -two empty DVD\-R disks\&. - - -# Create a target -tgtadm \-\-lld iscsi \-\-mode target \-\-op new \-\-tid 1 \-\-targetname iqn\&.2007\-03:virtual\-dvd:`hostname` - -# Create a DVD drive and give it a nice name -# The dvd starts out without a backing store file, i\&.e\&. no disk loaded -tgtadm \-\-op new \-\-mode logicalunit \-\-tid 1 \-\-lun 1 \-\-device\-type cd -tgtadm \-\-lld iscsi \-\-mode logicalunit \-\-op update \-\-tid 1 \-\-lun 1 \-\-params vendor_id=STGT_DVD,product_id=DVD101,product_rev=0010,scsi_sn=STGTDVD01,removable=1 - -# We need a backend store file for the media changer -if [ ! \-f $HOME/smc ]; then - dd if=/dev/zero of=$HOME/smc bs=1k count=1 -fi - -# Create the SMC device and give it a nice name -tgtadm \-\-lld iscsi \-\-mode logicalunit \-\-op new \-\-tid 1 \-\-lun 2 \-\-backing\-store $HOME/smc \-\-device\-type changer -tgtadm \-\-lld iscsi \-\-mode logicalunit \-\-op update \-\-tid 1 \-\-lun 2 \-\-params vendor_id=STK,product_id=L700,product_rev=0010,scsi_sn=XYZZY_0,removable=1 - -# Add a Data Transfer devices (1 drive) -tgtadm \-\-lld iscsi \-\-mode logicalunit \-\-op update \-\-tid 1 \-\-lun 2 \-\-params element_type=4,start_address=1,quantity=1 - -# Specify that the DVD above (LUN 1) is the data transfer device we created -tgtadm \-\-lld iscsi \-\-mode logicalunit \-\-op update \-\-tid 1 \-\-lun 2 \-\-params element_type=4,address=1,tid=1,lun=1 - -# Medium Transport Elements (robot arm / picker) -tgtadm \-\-lld iscsi \-\-mode logicalunit \-\-op update \-\-tid 1 \-\-lun 2 \-\-params element_type=1,start_address=16,quantity=1 - -# define path to virtual media -VTL=${HOME}/vtl -mkdir \-p ${VTL} -tgtadm \-\-lld iscsi \-\-mode logicalunit \-\-op update \-\-tid 1 \-\-lun 2 \-\-params media_home=${VTL} - -# Storage Elements \- 8 starting at addr 1024 -tgtadm \-\-lld iscsi \-\-mode logicalunit \-\-op update \-\-tid 1 \-\-lun 2 \-\-params element_type=2,start_address=1024,quantity=8 - -# Add \*(Aqmedia\*(Aq to slots 1 and 2 and leave the other 6 slots empty -# slot 1 -# Create empty writeable virtual DVD\-R media -tgtimg \-\-op new \-\-device\-type cd \-\-type dvd+r \-\-file ${VTL}/DISK_001 -tgtadm \-\-lld iscsi \-\-mode logicalunit \-\-op update \-\-tid 1 \-\-lun 2 \-\-params element_type=2,address=1024,barcode=DISK_001,sides=1 - -# slot 2 -tgtimg \-\-op new \-\-device\-type cd \-\-type dvd+r \-\-file ${VTL}/DISK_002 -tgtadm \-\-lld iscsi \-\-mode logicalunit \-\-op update \-\-tid 1 \-\-lun 2 \-\-params element_type=2,address=1025,barcode=DISK_002,sides=1 - -# Allow ALL initiators to connect to this target -tgtadm \-\-lld iscsi \-\-mode target \-\-op bind \-\-tid 1 \-\-initiator\-address ALL - -# Show all our good work\&. -tgtadm \-\-lld iscsi \-\-mode target \-\-op show - -.fi -.if n \{\ -.RE -.\} -.SH "PASSTHROUGH DEVICES" -.PP -In addition to device emulation TGTD also supports utilizing existing SG devices on the host and exporting these through a special passthrough device type\&. -.PP -\fB\-\-bstype=sg\fR -.RS 4 -This specifies that an SG devices is used\&. -.RE -.PP -\fB\-\-device\-type=pt\fR -.RS 4 -This specifies that passthrough device type is used\&. -.RE -.PP -\fB\-\-backing\-store=</dev/sg4>\fR -.RS 4 -This specifies which device to export through TGTD\&. -.RE -.sp -.if n \{\ -.RS 4 -.\} -.nf -Example: -Make /dev/sg4 available to initiators connecting to TGTD\&. - -tgtadm \-\-lld iscsi \-\-op new \-\-mode logicalunit \-\-tid 1 \-\-lun 1 \-\-bstype=sg \-\-device\-type=pt \-\-backing\-store=/dev/sg4 - -.fi -.if n \{\ -.RE -.\} -.SH "HEADER DIGEST AND DATA DIGEST" -.PP -Header and data digests can be set on a per target parameter\&. TGTD supports two modes, None and CRC32C\&. When the digest is set to None, TDTD will negotiate that digests will not be used, and when CRC32C is set, TGTD will force the connection to use digest\&. -.SS "Viewing the current settings" -.PP -This command is used to view the current settings for header/data digest\&. -.sp -.if n \{\ -.RS 4 -.\} -.nf -tgtadm \-\-op show \-\-mode target \-\-tid 1 - \&.\&.\&. - HeaderDigest=None - DataDigest=None - \&.\&.\&. - -.fi -.if n \{\ -.RE -.\} -.SS "Setting digest" -.sp -.if n \{\ -.RS 4 -.\} -.nf -Set header digest to CRC32C: -tgtadm \-\-op update \-\-mode target \-\-tid 1 \-n HeaderDigest \-v CRC32C - -Set data digest to None: -tgtadm \-\-op update \-\-mode target \-\-tid 1 \-n DataDigest \-v None - -.fi -.if n \{\ -.RE -.\} -.SH "CHAP AUTHENTICATION" -.PP -CHAP authentication is supported to require authentication before an initiator is allowed to log in and access devices\&. TGTD supports setting CHAP for normal log in sessions only, not for discovery sessions\&. Discovery sessions are always possible without authentication\&. -.PP -CHAP authentication is set on the target level\&. To set up CHAP authentication we first need to create an account and its associated password, then we bind the account to one or more targets\&. -.SS "Setting CHAP on a target" -.PP -These two commands create a user account and binds it to target 1\&. -.sp -.if n \{\ -.RS 4 -.\} -.nf -tgtadm \-\-lld iscsi \-\-op new \-\-mode account \-\-user ronnie \-\-password password -tgtadm \-\-lld iscsi \-\-op bind \-\-mode account \-\-tid 1 \-\-user ronnie - -.fi -.if n \{\ -.RE -.\} -.SS "List all accounts" -.PP -This command is used to list all accounts that have been created\&. -.sp -.if n \{\ -.RS 4 -.\} -.nf -tgtadm \-\-lld iscsi \-\-op show \-\-mode account -Account list: - ronnie - -.fi -.if n \{\ -.RE -.\} -.SS "Show if a target requires authentication" -.PP -When listing the targets, each target that has authantication enabled will contain a listing of all accoutns bound to that target\&. -.sp -.if n \{\ -.RS 4 -.\} -.nf -tgtadm \-\-lld iscsi \-\-op show \-\-mode target -Target 1: iqn\&.ronnie\&.test -\&.\&.\&. -Account information: - ronnie -\&.\&.\&. - -.fi -.if n \{\ -.RE -.\} -.SH "ISCSI PORTALS" -.PP -iSCSI portals can be viewed, added and removed at runtime\&. -.SS "List portals" -.PP -This command is used to list the current iSCSI portals defined on the target: -.sp -.if n \{\ -.RS 4 -.\} -.nf -tgtadm \-\-lld iscsi \-\-op show \-\-mode portal -Portal: 10\&.1\&.1\&.101:3260,1 -Portal: 127\&.0\&.0\&.1:3260,1 - -.fi -.if n \{\ -.RE -.\} -.SS "Add portal" -.PP -This command is used to add a portal to the target : -.sp -.if n \{\ -.RS 4 -.\} -.nf -tgtadm \-\-lld iscsi \-\-op new \-\-mode portal \-\-param portal=10\&.1\&.1\&.101:3260 - -.fi -.if n \{\ -.RE -.\} -.SS "Remove portal" -.PP -This command is used to remove a portal from the target : -.sp -.if n \{\ -.RS 4 -.\} -.nf -tgtadm \-\-lld iscsi \-\-op delete \-\-mode portal \-\-param portal=10\&.1\&.1\&.101:3260 - -.fi -.if n \{\ -.RE -.\} -.SH "ISCSI CONNECTIONS" -.PP -iSCSI connections can be viewed and forced closed at runtime\&. -.SS "List all active connections for a target" -.PP -This command is used to list the all the active iSCSI connections to the target with connection id, initiator name and ip address for the initiator : -.sp -.if n \{\ -.RS 4 -.\} -.nf -tgtadm \-\-lld iscsi \-\-op show \-\-mode conn \-\-tid 1 -Session: 2 - Connection: 0 - Initiator: iqn\&.2008\-11\&.org\&.linux\-kvm: - IP Address: 127\&.0\&.0\&.1 - -.fi -.if n \{\ -.RE -.\} -.SS "Close an existing connection" -.PP -This command is used to close an iSCSI connection\&. Note that forcibly closing iSCSI connections can lead to data\-loss\&. -.sp -.if n \{\ -.RS 4 -.\} -.nf -tgtadm \-\-lld iscsi \-\-op delete \-\-mode conn \-\-tid 1 \-\-sid 2 \-\-cid 0 - -.fi -.if n \{\ -.RE -.\} -.SH "ISNS PARAMETERS" -.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\&. -.RE -.sp -.if n \{\ -.RS 4 -.\} -.nf -Example: - -tgtadm \-\-op update \-\-mode sys \-\-name iSNSServerIP \-\-value 192\&.168\&.11\&.133 - -.fi -.if n \{\ -.RE -.\} -.PP -\fBiSNS\fR -.RS 4 -This setting enables(on)/disables(off) iSNS\&. -.RE -.sp -.if n \{\ -.RS 4 -.\} -.nf -Example: - -tgtadm \-\-op update \-\-mode sys \-\-name iSNS \-\-value On - -.fi -.if n \{\ -.RE -.\} -.PP -\fBiSNSServerPort\fR -.RS 4 -This setting specifies the port to use for iSNS\&. -.RE -.sp -.if n \{\ -.RS 4 -.\} -.nf -Example: - -tgtadm \-\-op update \-\-mode sys \-\-name iSNSServerPort \-\-value 3205 - -.fi -.if n \{\ -.RE -.\} -.PP -\fBiSNSAccessControl\fR -.RS 4 -Enable/disable access control for iSNS\&. -.RE -.sp -.if n \{\ -.RS 4 -.\} -.nf -Example: - -tgtadm \-\-op update \-\-mode sys \-\-name iSNSAccessControl \-\-value Off - -.fi -.if n \{\ -.RE -.\} -.SH "SEE ALSO" -.PP -tgtd(8), tgt\-admin(8), tgtimg(8), tgt\-setup\-lun(8)\&. -\m[blue]\fB\%http://stgt.sourceforge.net/\fR\m[] -.SH "REPORTING BUGS" -.PP -Report bugs to <stgt@vger\&.kernel\&.org> diff --git a/doc/manpages/tgtd.8 b/doc/manpages/tgtd.8 deleted file mode 100644 index d9c9336..0000000 --- a/doc/manpages/tgtd.8 +++ /dev/null @@ -1,145 +0,0 @@ -'\" t -.\" Title: tgtd -.\" Author: [FIXME: author] [see http://docbook.sf.net/el/author] -.\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/> -.\" Date: 10/02/2010 -.\" Manual: [FIXME: manual] -.\" Source: [FIXME: source] -.\" Language: English -.\" -.TH "TGTD" "8" "10/02/2010" "[FIXME: source]" "[FIXME: manual]" -.\" ----------------------------------------------------------------- -.\" * 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" -tgtd \- The SCSI Target Daemon -.SH "SYNOPSIS" -.HP \w'\fBtgtd\fR\ 'u -\fBtgtd\fR -.HP \w'\fBtgtd\fR\ 'u -\fBtgtd\fR [\-C\ \-\-control\-port\ <INTEGER>] [\-d\ \-\-debug\ <INTEGER>] [\-f\ \-\-foregound] [\-h\ \-\-help] [\-\-iscsi\ <\&.\&.\&.>] -.SH "DESCRIPTION" -.PP -Tgtd is a SCSI Target daemon\&. It can be used to provide SCSI target service to a network\&. The most common service is iSCSI but other services are also supported\&. -.SH "DEVICE TYPES" -.PP -Tgtd provides support for both emulated and passthrough of real devices\&. -.sp -.if n \{\ -.RS 4 -.\} -.nf - Tgtd can emulate the following types of devices: - - disk : Normal disk device\&. Emulates a SCSI harddisk\&. - tape : Tape device\&. Emulates a SCSI tape drive\&. - cd : CD device\&. Emulates a SCSI DVD burner\&. - changer : Media changer\&. Emulate the changer device for a virtual tape library or DVD jukebox\&. - -.fi -.if n \{\ -.RE -.\} -.SH "OPTIONS" -.PP -\-d \-\-debug <INTEGER> -.RS 4 -Set to non\-zero value to activate additional debugging messages to be logged\&. -.RE -.PP -\-f \-\-foreground -.RS 4 -Run the daemon in the foreground\&. -.RE -.PP -\-h \-\-help -.RS 4 -Print help text to the screen\&. -.RE -.PP -\-C \-\-control\-port <INTEGER> -.RS 4 -This comamnd is used to specify the control port to use for this instance of tgtd\&. This allows to run multiple instances of TGTD on a host\&. -.sp -TGTADM has a matching argument to control which instance to connect to\&. -.RE -.PP -\-\-iscsi <\&.\&.\&.> -.RS 4 -ISCSI specific options\&. See the ISCSI section below for options specific to this frontend\&. -.RE -.SH "ISCSI OPTIONS" -.PP -These parameters apply only to the iSCSI frontend\&. -.SS "portal=<ip\-address[:port]>" -.PP -This option is used to bind tgtd to a specific ip\-address/portal and/or port\&. By default tgtd will bind to port 3260 on the wildcard address\&. The ip\-address part (before the ":") can be missing to designate the wildcard address with a none\-default port\&. -.PP -Example: to bind tgtd to a specific address and port -.sp -.if n \{\ -.RS 4 -.\} -.nf - tgtd \-\-iscsi portal=192\&.0\&.2\&.1:3260 - -.fi -.if n \{\ -.RE -.\} -.sp -Example: to bind tgtd to any address but a none\-default port -.sp -.if n \{\ -.RS 4 -.\} -.nf - tgtd \-\-iscsi portal=:3251 - -.fi -.if n \{\ -.RE -.\} -.sp -.SH "SEE ALSO" -.PP -tgtadm(8), tgt\-admin(8), tgtimg(8), tgt\-setup\-lun(8)\&. -\m[blue]\fB\%http://stgt.sourceforge.net/\fR\m[] -.SH "COPYRIGHT/LICENSE" -.sp -.if n \{\ -.RS 4 -.\} -.nf -This program is free software; you can redistribute it and/or modify -it under the terms of the GNU General Public License as published by -the Free Software Foundation; either version 2 of the License, or (at -your option) any later version\&. - -This program is distributed in the hope that it will be useful, but -WITHOUT ANY WARRANTY; without even the implied warranty of -MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE\&. See the GNU -General Public License for more details\&. - -You should have received a copy of the GNU General Public License -along with this program; if not, see http://www\&.gnu\&.org/licenses/\&;. -.fi -.if n \{\ -.RE -.\} diff --git a/doc/manpages/tgtimg.8 b/doc/manpages/tgtimg.8 deleted file mode 100644 index 23af44c..0000000 --- a/doc/manpages/tgtimg.8 +++ /dev/null @@ -1,130 +0,0 @@ -.\" Title: tgtimg -.\" Author: -.\" Generator: DocBook XSL Stylesheets v1.73.2 <http://docbook.sf.net/> -.\" Date: 04/04/2010 -.\" Manual: -.\" Source: -.\" -.TH "TGTIMG" "8" "04/04/2010" "" "" -.\" disable hyphenation -.nh -.\" disable justification (adjust text to left margin only) -.ad l -.SH "NAME" -tgtimg - Linux SCSI Target Framework Image File Utility -.SH "SYNOPSIS" -.HP 7 -\fBtgtimg\fR [\-o\ \-\-op\ <operation>] [\-Y\ \-\-device\-type\ <device\-type>] [\-b\ \-\-barcode\ <barcode>] [\-s\ \-\-size\ <size>] [\-t\ \-\-type\ <media\-type>] [\-f\ \-\-file\ <path>] -.HP 14 -\fBtgtimg \-\-help\fR -.SH "DESCRIPTION" -.PP -Tgtimg is a utility to create and manage the image files used by the TGTD device emulation\. -.PP -This command is used to initialize device image files with the additional metadata, such as barcode, list of blocks, total size, etc that the TGTD emulation needs\. -.SH "OPTIONS" -.PP -\fB\-h, \-\-help\fR -.RS 4 -Show a help screen and exit\. -.RE -.PP -\fB\-o, \-\-op {new|show}\fR -.RS 4 -Operation\. Is either new to create a new image file or show to show the content of an existing image file\. -.RE -.PP -\fB\-Y, \-\-device\-type <type>\fR -.RS 4 -This specifies the type of image file\. -.RE -.sp -.RS 4 -.nf -Supported device types are : - cd : to create media for a dvd device - disk : to create media for a disk device - tape : to create media for a tape device - -.fi -.RE -.PP -\fB\-t, \-\-type <media\-type>\fR -.RS 4 -When creating a new image, this specifies the type of media to emulate\. The available mediatypes depend on the type of the device\. -.RE -.sp -.RS 4 -.nf -Supported media types for cd devices are : - dvd+r : create a blank writeable DVD+R disk - -Supported media types for disk devices are : - disk : create an empty disk - -Supported media types for tape devices are : - data : create a normal data tape - clean : create a cleaning tape - worm : create a worm - -.fi -.RE -.PP -\fB\-b, \-\-barcode <barcode>\fR -.RS 4 -When creating a new image, this argument specifies the barcode to use with this image file\. Backup application software often uses barcodes to identify specific tapes\. When emulating a VTL, make sure that all tape images use unique barcodes\. -.RE -.PP -\fB\-s, \-\-size <size>\fR -.RS 4 -When creating a new image, this specifies the size in megabytes for the virtual tape image\. -.RE -.PP -\fB\-f, \-\-file <path>\fR -.RS 4 -The filename of the image file\. -.RE -.SH "EXAMPLES" -.PP -To create a new 100MByte disk -.sp -.RS 4 -.nf - tgtimg \-\-op new \-\-device\-type disk \-\-type disk \-\-size 100 \-\-file /data/hd001\.raw - -.fi -.RE -.PP -To create a new tape image -.sp -.RS 4 -.nf - tgtimg \-\-op new \-\-device\-type tape \-\-barcode 12345 \-\-size 100 \-\-type data \-\-file /data/tape001\.img - -.fi -.RE -.PP -To view the content of an existing image -.sp -.RS 4 -.nf - tgtimg \-\-op show \-\-device\-type tape \-\-file /data/tape001\.img - -.fi -.RE -.PP -To create a new blank DVD+R image -.sp -.RS 4 -.nf - tgtimg \-\-op new \-\-device\-type cd \-\-type dvd+r \-\-file /data/dvd001\.iso - -.fi -.RE -.SH "SEE ALSO" -.PP -tgtd(8), tgtadm(8), tgt\-admin(8), tgt\-setup\-lun(8)\. -\fI\%http://stgt.sourceforge.net/\fR -.SH "REPORTING BUGS" -.PP -Report bugs to <stgt@vger\.kernel\.org> -- 1.7.1 -- To unsubscribe from this list: send the line "unsubscribe stgt" in the body of a message to majordomo@xxxxxxxxxxxxxxx More majordomo info at http://vger.kernel.org/majordomo-info.html
