96 lines
3.4 KiB
Groff
96 lines
3.4 KiB
Groff
'\" t
|
|
.\" Title: iscsi-ls
|
|
.\" Author: [FIXME: author] [see http://docbook.sf.net/el/author]
|
|
.\" Generator: DocBook XSL Stylesheets v1.79.1 <http://docbook.sf.net/>
|
|
.\" Date: 06/03/2017
|
|
.\" Manual: iscsi-ls: list iSCSI targets and LUNs
|
|
.\" Source: iscsi-ls
|
|
.\" Language: English
|
|
.\"
|
|
.TH "ISCSI\-LS" "1" "06/03/2017" "iscsi\-ls" "iscsi\-ls: list iSCSI targets"
|
|
.\" -----------------------------------------------------------------
|
|
.\" * 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"
|
|
iscsi-ls \- Utility to list iSCSI targets and LUNs
|
|
.SH "SYNOPSIS"
|
|
.HP \w'\fBiscsi\-ls\ [\ OPTIONS\ ]\ <ISCSI\-PORTAL>\fR\ 'u
|
|
\fBiscsi\-ls [ OPTIONS ] <ISCSI\-PORTAL>\fR
|
|
.HP \w'\fBiscsi\-ls\fR\ 'u
|
|
\fBiscsi\-ls\fR [\-i\ \-\-initiator\-name=<IQN>] [\-s\ \-\-show\-luns] [\-d\ \-\-debug] [\-?\ \-\-help] [\-\-usage]
|
|
.SH "DESCRIPTION"
|
|
.PP
|
|
iscsi\-ls is a utility to list all targets and LUNs for an iSCSI portal\&.
|
|
.SH "ISCSI PORTAL URL FORMAT"
|
|
.PP
|
|
iSCSI portal format is \*(Aqiscsi://[<username>[%<password>]@]<host>[:<port>]\*(Aq
|
|
.PP
|
|
Username and password are only required if the target requires CHAP authentication\&. Optionally you can specify the username and password via the environment variables LIBISCSI_CHAP_USERNAME and LIBISCSI_CHAP_PASSWORD\&.
|
|
.PP
|
|
Host can be specified either as a hostname, an IPv4 address or an IPv6 address\&. Examples:
|
|
.sp
|
|
.if n \{\
|
|
.RS 4
|
|
.\}
|
|
.nf
|
|
iscsi://192\&.0\&.2\&.1
|
|
iscsi://[2001:DB8::1]:3261
|
|
iscsi://ronnie%password@iscsi\&.example\&.com
|
|
|
|
.fi
|
|
.if n \{\
|
|
.RE
|
|
.\}
|
|
.PP
|
|
Port is the TCP port on the target to connect to\&. Default is 3260\&.
|
|
.SH "OPTIONS"
|
|
.PP
|
|
\-i \-\-initiator\-name=<IQN>
|
|
.RS 4
|
|
This specifies the initiator\-name that iscsi\-ls will use when logging in to the target\&.
|
|
.sp
|
|
The default name is \*(Aqiqn\&.2007\-10\&.com\&.github:sahlberg:libiscsi:iscsi\-ls\*(Aq but you can use this argument to override this\&. This is mainly needed for cases where the target is configured with access\-control to only allow discovery logins from known initiator\-names\&.
|
|
.RE
|
|
.PP
|
|
\-s \-\-show\-luns
|
|
.RS 4
|
|
In addition to listing all the targets at the specified portal also list all the LUNs and their types on each discovered target\&.
|
|
.sp
|
|
In order to display the type of LUN iscsi\-ls need to be able to perform a normal login on the targets\&. If the target is using access\-control you will need to specify an initiator\-name that allows normal logins to the target\&.
|
|
.RE
|
|
.PP
|
|
\-d \-\-debug
|
|
.RS 4
|
|
Print debug information\&.
|
|
.RE
|
|
.PP
|
|
\-? \-\-help
|
|
.RS 4
|
|
Display basic help text\&.
|
|
.RE
|
|
.PP
|
|
\-\-usage
|
|
.RS 4
|
|
Display basic usage text\&.
|
|
.RE
|
|
.SH "SEE ALSO"
|
|
.PP
|
|
iscsi\-inq(1)
|
|
\m[blue]\fB\%http://github.com/sahlberg/libiscsi\fR\m[]
|