add man page for tgt-admin Signed-off-by: Doron Shoham <dorons at voltaire.com> --- doc/manpages/tgt-admin.8 | 118 ++++++++++++++++++++++++++++++++++++++++++++++ 1 files changed, 118 insertions(+), 0 deletions(-) create mode 100644 doc/manpages/tgt-admin.8 diff --git a/doc/manpages/tgt-admin.8 b/doc/manpages/tgt-admin.8 new file mode 100644 index 0000000..4eaac20 --- /dev/null +++ b/doc/manpages/tgt-admin.8 @@ -0,0 +1,118 @@ +.IX Title "TGT-ADMIN 1" +.TH TGT-ADMIN 8 "2008-07-21" "TGT Configuration Tool" "TGT Configuration Tool" +.SH "NAME" +tgt-admin \- Linux SCSI Target Configuration Tool. +.SH "SYNOPSIS" +.IX Header "SYNOPSIS" +\&\fBtgt-admin \-[OPTION]...\fR +.SH "DESCRIPTION" +.IX Header "DESCRIPTION" +tgt-admin is a utility which allows a persistent configuration of targets and luns. +.br +It uses tgtadm commands to create, delete and show targets. + +.SH "OPTIONS" +.IX Header "OPTIONS" +\&\fB\-e, \-\-execute\fR +.PP +read /etc/tgt/targets.conf and execute tgtadm commands. +.br +if target already exists it will be deleted and a new instance will be created with the new parameters instead. +.PP +\&\fB\-d, \-\-delete\fR +.PP +delete all the targets +.PP +\&\fB\-s, \-\-show\fR +.PP +show all the targets +.PP +\&\fB\-f, \-\-force\fR +.PP +don't exit on tgtadm errors +.PP +\&\fB\-p, \-\-pretend\fR +.PP +only print tgtadm options +.PP +\&\fB\-v, \-\-verbose\fR +.PP +increase verbosity (no effect in "pretend" mode) +.PP +\&\fB\-c, \-\-conf <conf_file>\fR +.PP +specify an alternative configuration file instead of \fB/etc/tgt/target.conf\fR, which is the default. +.PP +\&\fB\-h, \-\-help\fR +.PP +display a list of available options and exits + +.SH CONFIGURATION FILE SYNTAX +The defualt configuration file is: \fB/etc/tgt/target.conf\fR. It defines all the targets and their properties. +.br +The configuration file is in XML format and uses tags. +Configuration file contains several target blocks, where each block contains target's proerties such as storage devices, +initator ACL and authorization information. You can include other config files using: +.br +\fBinclude /etc/tgt/xen/*.conf\fR. +.PP +There are 2 types of storage devices: +.PP +\&\fBbacking-store\fR - defines a virtual device on the target. +.PP +\&\fBdirect-store\fR - defines a direct mapped device with the same properties as the physical device (such as VENDOR_ID +, SERIAL_NUM, etc.) +.PP +\&\fBinitiator-address\fR - allows connections only from the specify IP address. defaults to ALL if no +"initiator-address" is specified +.PP +\&\fBincominguser\fR - define iscsi incoming authentication setting. if no "incominguser" is specified, it is not used. +.PP +\&\fBoutgoinguser\fR - define iscsi outgoing authentication setting. if no "outgoinguser" is specified, it is not used. +.PP +example for a configuration file: +.br +<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> + +.SH FILES +.PD 0 +.TP +.I /etc/tgt/target.conf +Configuration file for +.BR tgt-admin . + +.SH SEE ALSO +.BR tgtadm (8) + +.SH "REPORTING BUGS" +.IX Header "REPORTING BUGS" +Report bugs to <stgt-devel at lists.berlios.de> -- 1.5.3.8 |