Skip to main content
SANtricity commands

Set iSCSI initiator

Contributors netapp-driley

The set iscsiInitiator command sets the attributes for an iSCSI initiator.

Supported Arrays

This command applies to any individual storage array, including the E4000, E2700, E5600, E2800, E5700, EF600 and EF300 arrays, as long as all SMcli packages are installed.

Roles

To execute this command on an E4000, E2800, E5700, EF600, or EF300 storage array, you must have the Storage Admin role.

Note

This command is deprecated and is replaced by the Set initiator command.

Syntax

set iscsiInitiator (["initiatorUserLabel"] | <"_iscsiInitiatorName_">)
(userLabel="newName" |
host="newHostName" |
chapSecret="newSecurityKey")

Parameters

Parameter Description

initiatorUserLabel

The iscsi Initiator user label of the iSCSI initiator for which you want to set attributes. Enclose the iSCSI initiator user label in double quotation marks (" ") inside square brackets ([ ]).

Note

Begin the initiator user label with the host name to which the host port is connected. Because there can be more than one host port identifier on a host, use a unique suffix for the host port ID. If the host name is ICTM1590S02H1 the initiator label appears as follows:

set iscsiInitiator ["ICTM1590S02H1_AA"]

iscsiInitiatorName

The name of the initiator for which you want to set attributes. Enclose the iscsiInitiatorName in double quotation marks (" ") inside angle brackets (< >).

Note

The iscsiInitiatorName is the iSCSI Qualified Name (iqn). An example:

set iscsiInitiator <"iqn.2016-11.com.vmware.iscsi:ictm1509s02h1">

userLabel

The new user label that you want to use for the iSCSI initiator. Enclose the new user label in double quotation marks (" ").

Note

A best practice is to begin the initiator user label with the host name to which the host port is connected. Because there can be more than one host port identifier on a host, use a unique suffix for the host port ID. If the host name is ICTM1590S02H1 then an example of the initiator user label is shown below:

set iscsiInitiator ["ICTM1590S02H1_AA"]

host

The name of the new host to which the host port is connected. Enclose the host name in double quotation marks (" "). An example is shown below:

["ICTM1590S02H2"]

chapSecret

The security key that you want to use to authenticate a peer connection. Enclose the security key in double quotation marks (" ").

Notes

You can use any combination of alphanumeric characters, hyphens, and underscores for the names. Names can have a maximum of 30 characters.

Challenge Handshake Authentication Protocol (CHAP) is a protocol that authenticates the peer of a connection. CHAP is based upon the peers sharing a secret. A secret is a security key that is similar to a password.

Use the chapSecret parameter to set up the security keys for initiators that require a mutual authentication. The CHAP secret must be between 12 characters and 57 characters. This table lists the valid characters.

Space

!

"

#

$

%

&

'

(

)

*

,

-

.

/

0

1

2

3

4

5

6

7

8

9

:

;

<

=

>

?

@

A

B

C

D

E

F

G

H

I

J

K

L

M

N

O

P

Q

R

S

T

U

V

W

X

Y

Z

[

\

]

^

_

'

a

b

c

d

e

f

g

h

i

j

k

l

m

n

o

p

q

r

s

t

u

v

w

x

y

z

{

|

}

~

Minimum firmware level

7.10

8.41 This command is deprecated.