1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
|
.TH istgtcontrol 1 "Oct 07, 2011" "istgtcontrol"
.SH NAME
istgtcontrol \- istgt iSCSI target command utility
.SH SYNOPSIS
.B istgtcontrol
[options] <command> [<file>]
.SH DESCRIPTION
\fBistgtcontrol\fP is a command and control utility for \fBistgt\fP(1).
It can be used to query and change the status of a local or remote
\fBistgt\fP instance.
.PP
\fBistgtcontrol\fP supports the commands denoted below to interact with
the \fBistgt\fP instance. By default it connects and authenticates to
the iSCSI target portal specified in the \fBistgtcontrol.conf\fP
configuration file and uses CHAP credentials denoted there, if any.
Both can be overridden by using the respecitve command line arguments.
.SH COMMANDS
\fBistgtcontrol\fP understands the following commands which can be
forwarded to \fBistgt\fP:
.TP
.BI "noop"
Do not actually do anything, but test responsiveness of the portal and
test CHAP credentials only.
.TP
.BI "version"
Retrieve the \fBistgt\fP version number providing the iSCSI
portal \fBistgtcontrol\fP connected to.
.TP
.BI "list"
List all, or the specified targets only, which shared by the portal.
.TP
.BI "load"
Load a new media to the specified unit. This command issues the same
command as if a drive tray had been closed on a SCSI device.
.TP
.BI "unload"
Unload a media from the specified unit. This command issues the same
command as if the drive tray had been opened from a SCSI device.
.TP
.BI "change" " \fIfile\fP"
Change the loaded media by the specified unit. This command is
equivalent as if a new media (for example a DVD-ROM or tape cartridge) had
been inserted in the SCSI drive. The "\fIfile\fP" argument is interpreted
as filename to be loaded.
.TP
.BI "reset"
Reset the specified LUN of the portal.
.TP
.BI "info"
Display all connections of the portal
.SH OPTIONS
.TP
.BI \-c " \fIconfig\fP"
Use specified file as configuration file instead of the default file.
.TP
.BI -h " \fIhost\fP"
Override the target portal by the specified host name or IP address. This
defaults to "localhost" if no other host was specified in the
configuration file.
.TP
.BI -p " \fIport\fP"
Override the target portal port by the specified port number. This defaults
to "3261" if no other port was specified in the configuration file.
.TP
.BI -t " \fItarget\fP"
Specifies the target IQN which should be affected by the command given.
There may be a default given in the configuration file. The keyword
"\fIall\fP" is accepted by some commands and matches all exported volumes.
.TP
.BI -l " \fIlun\fP"
Specifies the target LUN which should be affected by the command given.
This defaults to "0" unless another default was provided in the configuration
file.
.TP
.BI -f " \fIflags\fP"
Specifies flags passed to the portal when loading a new media. This
defaults to "ro". Supported \fIflags\fP are: "ro", "rw", "extend" and
"dynamic".
.TP
.BI -s " \fIsize\fP"
Specifies the size of the meda to be loaded. The default is to auto-detect the
media size.
.TP
.BI -q
Quiet mode, supress non-critical outputs.
.TP
.BI -v
Verbose mode, gives more output during operations.
.TP
.BI -A " \fImethod\fP"
Sets the preferred authentication method for logging in to the portal. This
overrides any method specified in the configuration file. Supported
methods are either CHAP/Mutual or CHAP/Auto.
.TP
.BI -U " \fIuser\fP"
Sets the user to authenticate on the portal. This overrides any username
specified in the configuration file.
.TP
.BI -S " \fIsecret\fP"
Set the secret used to authenticate on the portal. This overrides any
secret specified in the configuration file.
.TP
.BI -M " \fImuser\fP"
Set the mutual authentication user. This overrides any user specified in
the configuration file.
.TP
.BI -R " \fImsecret\fP"
Set the mutual authentication secret. This overrides any secret
specified in the configuration file.
.TP
.BI -H
Display a brief usage summary and exit.
.TP
.BI -V
Display the \fBistgtcontrol\fP version number and exit.
.TP
.SH FILES
.PD 0
.TP
.I %%CONFIGDIR%%/istgtcontrol.conf
Configuration file
.PD
.SH SEE ALSO
\fBistgt\fP(1)
.PD
.SH AUTHORS
Daisuke Aoyama <aoyama@peach.ne.jp>
This manual page was written by Arno Töll (<debian@toell.net>) for the Debian
GNU/kFreeBSD system (but may be used by others).
|
