diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/iscsi_discovery.8 | 12 | ||||
| -rw-r--r-- | doc/iscsiadm.8 | 194 |
2 files changed, 177 insertions, 29 deletions
diff --git a/doc/iscsi_discovery.8 b/doc/iscsi_discovery.8 index a4affc6..e28065c 100644 --- a/doc/iscsi_discovery.8 +++ b/doc/iscsi_discovery.8 @@ -8,7 +8,17 @@ .SH NAME iscsi_discovery \- discover iSCSI targets .SH SYNOPSIS -.B iscsi_discovery <IP> [-p <port>] [-d] [-t <tcp|iser> [-f]] [-m] [-l] +.B iscsi_discovery +.I <IP> +.RB [ -p +.IR <port> ] +.RB [ -d ] +.RB [\ -t +.IR <tcp|iser> +.RB [ -f ] +.R ] +.RB [ -m ] +.RB [ -l ] .SH DESCRIPTION Perform send-targets discovery to the specified IP. If a discovery record diff --git a/doc/iscsiadm.8 b/doc/iscsiadm.8 index 50fc7f8..c7d8c92 100644 --- a/doc/iscsiadm.8 +++ b/doc/iscsiadm.8 @@ -2,23 +2,161 @@ .SH NAME iscsiadm \- open-iscsi administration utility .SH SYNOPSIS -\fBiscsiadm\fR \-m discoverydb [ \-hV ] [ \-d debug_level ] [ \-P printlevel ] [ \-I iface \-t type \-p ip:port [ \-lD ] ] | [ [ -p ip:port -t type ] \ -[ \-o operation ] [ \-n name ] [ \-v value ] [ \-lD ] ] - -\fBiscsiadm\fR \-m discovery [ \-hV ] [ \-d debug_level ] [ \-P printlevel ] [ \-I iface \-t type \-p ip:port [ \-l ] ] | [ [ -p ip:port ] [ \-l | \-D ] ] - -\fBiscsiadm\fR \-m node [ \-hV ] [ \-d debug_level ] [ \-P printlevel ] [ \-L all,manual,automatic ] [ \-U all,manual,automatic ] [ \-S ] [ [ \-T targetname \-p ip:port \-I iface ] [ \-l | \-u | \-R | \-s] ] -[ [ \-o operation ] [ \-n name ] [ \-v value ] [ \-p ip:port ] ] - -\fBiscsiadm\fR \-m session [ \-hV ] [ \-d debug_level ] [ \-P printlevel ] [ \-r sessionid | sysfsdir [ \-R ] [ \-u | \-s | \-o new ] ] - -\fBiscsiadm\fR \-m iface [ \-hV ] [ \-d debug_level ] [ \-P printlevel ] [ \-I ifacename | \-H hostno|MAC ] [ [ \-o operation ] [ \-n name ] [ \-v value ] ] [ \-C ping [ \-a ip ] [ \-b packetsize ] [ \-c count ] [ \-i interval ] ] - -\fBiscsiadm\fR \-m fw [ \-d debug_level ] [\-l] - -\fBiscsiadm\fR \-m host [ \-P printlevel ] [ \-H hostno|MAC ] [ [ \-C chap [ \-x chap_tbl_idx ] ] | [ \-C flashnode [ \-A portal_type ] [ \-x flashnode_idx ] ] | [ \-C stats ] ] [ [ \-o operation ] [ \-n name ] [ \-v value ] ] - -\fBiscsiadm\fR \-k priority +.B iscsiadm +.B \-m discoverydb +.RB [ \-hV ] +.RB [ \-d +.IR debug_level ] +.RB [ \-P +.IR printlevel ] +.R [\ +.BI \-I\ iface\ \-t\ type\ \-p\ ip:port +.RB [ \-lD ] +.R ] | [ +.RB [ \-p +.I ip:port +.B \-t +.IR type ] +.RB [ \-o +.IR operation ] +.RB [ \-n +.IR name ] +.RB [ \-v +.IR value ] +.RB [ \-lD ] +.R ] + +.B iscsiadm +.B \-m discovery +.RB [ \-hV ] +.RB [ \-d +.IR debug_level ] +.RB [ \-P +.IR printlevel ] +.R [\ +.BI \-I\ iface\ \-t\ type\ \-p\ ip:port +.RB [ \-l ] +.R ] | [ +.RB [ \-p +.IR ip:port ] +.RB [ \-l | \-D ] +.R ] + +.B iscsiadm +.B \-m node +.RB [ \-hV ] +.RB [ \-d +.IR debug_level ] +.RB [ \-P +.IR printlevel ] +.RB [ \-L +.IR all,manual,automatic ] +.RB [ \-U +.IR all,manual,automatic ] +.RB [ \-S ] +.R [ +.RB [ \-T +.IB targetname\ \-p\ ip:port\ \-I\ iface +.R ] +.RB [ \-l | \-u | \-R | \-s ] +.R ] +.R [ +.RB [ \-o +.IR operation ] +.RB [ \-n +.IR name ] +.RB [ \-v +.IR value ] +.RB [ \-p +.IR ip:port ] +.R ] + +.B iscsiadm +.B \-m session +.RB[ \-hV ] +.RB [ \-d +.IR debug_level ] +.RB [ \-P +.IR printlevel ] +.R [ +.B \-r +.IR sessionid | sysfsdir +.RB [ \-R ] +.RB [ \-u | \-s | \-o +.IR new ] +.R ] + +.B iscsiadm +.B \-m iface +.RB [ \-hV ] +.RB [ \-d +.IR debug_level ] +.RB [ \-P +.IR printlevel ] +.R [ +.BI \-I\ ifacename +.R | +.BI \-H\ hostno|MAC +.R ] +.R [ +.RB [ \-o +.IR operation ] +.RB [ \-n +.IR name ] +.RB [ \-v +.IR value ] +.R ] +.R [ +.BI \-C\ ping +.RB [ \-a +.IR ip ] +.RB [ \-b +.IR packetsize ] +.RB [ \-c +.IR count ] +.RB [ \-i +.IR interval ] +.R ] + +.B iscsiadm +.B \-m fw +.RB [ \-d +.IR debug_level ] +.RB [ \-l ] + +.B iscsiadm +.B \-m host +.RB [ \-P +.IR printlevel ] +.RB [ \-H +.IR hostno|MAC ] +.R [ +.RB [\ \-C +.IR chap +.RB [ \-x +.IR chap_tbl_idx ] +.R ] | +.RB [\ \-C +.IR flashnode +.RB [ \-A +.IR portal_type ] +.RB [ \-x +.IR flashnode_idx ] +.R ] | +.RB [\ \-C +.IR stats \ ] +.R ] +.R [ +.RB [ \-o +.IR operation ] +.RB [ \-n +.IR name ] +.RB [ \-v +.IR value ] +.R ] + +.B iscsiadm +.B \-k priority .SH "DESCRIPTION" The iscsiadm utility is a command-line tool allowing discovery and login @@ -70,15 +208,15 @@ Specify the submode for mode. op must be name of submode. Currently iscsiadm support ping as submode for iface. For example, -iscsiadm -m iface -I ifacename -C ping -a ipaddr -b packetsize -c count -i interval +iscsiadm \-m iface \-I ifacename \-C ping \-a ipaddr \-b packetsize \-c count \-i interval For host, it supports chap , flashnode and stats as submodes. For example, -iscsiadm -m host -H hostno -C chap -x chap_tbl_idx -o operation +iscsiadm \-m host \-H hostno \-C chap \-x chap_tbl_idx \-o operation -iscsiadm -m host -H hostno -C flashnode -x flashnode_idx -o operation +iscsiadm \-m host \-H hostno \-C flashnode \-x flashnode_idx \-o operation -iscsiadm -m host -H hostno -C stats +iscsiadm \-m host \-H hostno \-C stats .TP \fB\-d\fR, \fB\-\-debug=\fIdebug_level\fP @@ -127,7 +265,7 @@ are experimental and the use is not supported as a stable interface yet. In discovery mode multiple interfaces can be specified by passing in multiple \-I/\-\-interface instances. For example, -"iscsiadm \-m discoverydb \-t st \-p ip:port \-I iface0 \-I iface2 --discover" +"iscsiadm \-m discoverydb \-t st \-p ip:port \-I iface0 \-I iface2 \-\-discover" Will direct iscsiadm to setup the node db to create records which will create sessions though the two intefaces passed in. @@ -174,13 +312,13 @@ for session mode). .TP \fB\-m, \-\-mode \fIop\fR specify the mode. \fIop\fR -must be one of \fIdiscoverydb\fR, \fInode\fR, \fIfw\fR, \fIhost\fR \fIiface\fR or \fIsession\fR. +must be one of \fIdiscovery\fR, \fIdiscoverydb\fR, \fInode\fR, \fIfw\fR, \fIhost\fR \fIiface\fR or \fIsession\fR. .IP -If no other options are specified: for \fIdiscoverydb\fR and \fInode\fR, all -of their respective records are displayed; for \fIsession\fR, all active -sessions and connections are displayed; for \fIfw\fR, all boot firmware -values are displayed; for \fIhost\fR, all iSCSI hosts are displayed; and -for \fIiface\fR, all ifaces setup in /etc/iscsi/ifaces are displayed. +If no other options are specified: for \fIdiscovery\fR, \fIdiscoverydb\fR and +\fInode\fR, all of their respective records are displayed; for \fIsession\fR, +all active sessions and connections are displayed; for \fIfw\fR, all boot +firmware values are displayed; for \fIhost\fR, all iSCSI hosts are displayed; +and for \fIiface\fR, all ifaces setup in /etc/iscsi/ifaces are displayed. .TP \fB\-n\fR, \fB\-\-name=\fIname\fR |