Poster of Linux kernelThe best gift for a Linux geek
IETADM

IETADM

Section: User Manuals (8) Updated: 2006-06-06
Local index Up
 

NAME

ietadm - iSCSI Enterprise Target Administration Utility.  

SYNOPSIS

ietadm --op [operation] --tid=[id] [--sid [id]] [--params [key=value,...]]  

DESCRIPTION

ietadm is used to monitor and modify in real-time the iSCSI Enterprise Target targets and volumes.  

USAGE

You'll have to get target ids from /proc/net/iet/volumes and sessions ids from /proc/net/iet/session. Some usage examples can be :

ietadm --op show --tid=1

display status of target 1 (see /proc/net/iet/volumes to get the matching target name)

ietadm --op new --tid=2

create dynamically a new target, numbered 2. CAUTION : the target will disappear if you restart ietd, you'll have to edit /etc/ietd.conf to make it permanent!  

ERROR MESSAGES

ietadm misses error messages. Look carefully at the STDERR output : in case of error it will send a 3 number error code, ending with -1, for instance :

ietd_request 203 3 -1  

OPTIONS

--op new --tid=[id] --params Name=[name]

add a new target with [id]. If [id] is zero, the lowest free [id] is allocated automatically to the new target.

--op delete --tid=[id]

delete specific target with [id]. The target must have no active sessions.

--op show --tid=[id]

show target parameters of target with [id].

--op show --tid=[id] --sid=[sid]

show iSCSI parameters in effect for session [sid]. If [sid] is ``0'' (zero), the configured parameters will be displayed.

--op new --tid=[id] --lun=[lun] --params Path=[path]

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.

--op delete --tid=[id] --lun=[lun]

delete specific logical unit with [lun] that the target with [id] has.

--op delete --tid=[id] --sid=[sid] --cid=[cid]

delete specific connection with [cid] in a session with [sid] that the target with [id] has. If the session has no connections after the operation, the session will be deleted automatically.

--op delete

stop all activity.

--op update --tid=[id] --params=key1=value1,key2=value2,...

change iSCSI IET target parameters of specific target with [id]. You can use parameters in ietd.conf as a key.

--op update --tid=[id] --redirect=[destination]

set a temporary target redirection for target [id]. [destination] MUST be in the form <ip address>:port where :port is optional and if not specified port 3260 is assumed. IPv6 addresses must be surrounded by square brackets, e.g. [<ipv6 address>]:port. If the destination is empty then any existing redirection is cleared.

--op new --tid=[id] --user --params=[user]=[name],Password=[pass]

add a new account with [pass] for specific target. [user] could be [IncomingUser] or [OutgoingUser]. If you don't specify a target (omit --tid option), you add a new account for discovery sessions.

--op show --tid=[id] --user

show a list of CHAP accounts. If --tid is omitted or [id] is ``0'' (zero), discovery accounts are displayed.

--op show --tid=[id] --user --params=[user]=[name]

show CHAP account information for the account specified by [name]. [user] can be [IncomingUser] or [OutgoingUser]. If --tid is omitted or [id] is ``0'' (zero), [name] is supposed to be a discovery account name.

--op delete --tid=[id] --user --params=[user]=[name]

delete specific account having [name] of specific target. [user] could be [IncomingUser] or [OutgoingUser]. If you don't specify a target (omit --tid option), you delete the account for discovery sessions.

--version

display version and exit

--help

display a list of available options and exits  

KNOWN ISSUES

ietdadm doesn't return any human-readable error message, only error codes.
ietadm doesn't modify or read the /etc/ietd.conf ietd configuration file.
ietadm can't use target names or aliases, only the tid found in /proc/net/iet/volumes.
/proc/net/iet/session may list inactive sessions if the initiator doesn't logout properly.

Report bugs to <iscsitarget-devel@sourceforge.net>.  

FILES

/proc/net/iet/session, /proc/net/iet/volumes  

SEE ALSO

ietd(8),ietd.conf(5)


 

Index

NAME
SYNOPSIS
DESCRIPTION
USAGE
ERROR MESSAGES
OPTIONS
KNOWN ISSUES
FILES
SEE ALSO

This document was created by man2html, using the manual pages.
Time: 22:01:46 GMT, April 16, 2011