ONTAP 9.14.1 commands

vserver iscsi modify

Modify a Vserver’s iSCSI service

Availability: This command is available to cluster and Vserver administrators at the admin privilege level.


This command modifies the configuration for an iSCSI service.

Modifications take effect immediately after you execute the command. Making modifications to your service can result in traffic loss on a live system. Call technical support if you are unsure of the possible consequences.


-vserver <Vserver Name> - Vserver

Specifies the Vserver for the iSCSI service.

[-target-name <text>] - Target Name

Specifies an iSCSI target name of a Vserver. This name is unique and is not case sensitive. The target name must conform to this format iqn.1995-08.com.example:string and the following rules:

  • Contains up to 128 bytes.

  • Contains alphanumeric characters. The period ".", hyphen "-", and colon ":" are acceptable.

  • Does not contain the underscore character "_".

The iSCSI service must be down in order to change the target name.
{ [-target-alias <text>] - Target Alias

Specifies the new target alias of the iSCSI service.

| [-c, -clear <true>] - Clear the Target Alias }

Clears the current target alias from the iSCSI service configuration.

[-status-admin {down|up}] - Administrative Status

Specifies the configured administrative status of a service. If you set this parameter to up, the iSCSI service begins to accept login requests from iSCSI initiators. If you set this parameter to down, iSCSI initiators cannot log in.

[-retain-timeout <integer>] - RFC3720 DefaultTime2Retain Value (in sec)

Specifies the wait time before active task reassignment is possible after an unexpected connection termination. For example, a value of 0 means that the connection or task state is immediately discarded by the target.

[-login-timeout <integer>] - Login Phase Duration (in sec)

Specifies maximum time the login phase remains active until the iSCSI target terminates the connection.

[-max-conn-per-session <integer>] - Max Connections per Session

Specifies the maximum number of connections per session that the iSCSI target can accept.

[-max-ios-per-session <integer>] - Max Commands per Session

Specifies the maximum number of commands per session that the iSCSI target can accept.

[-tcp-window-size <integer>] - TCP Receive Window Size (in bytes)

Specifies the TCP receive window size (in bytes).

A change to the TCP receive window size value takes effect for all network interfaces when you restart the iSCSI service for the Vserver as follows:

vserver iscsi stop -vserver <vserver name>
vserver iscsi start -vserver <vserver name>

If you change an individual network interface from up to down back to up, as follows, the new value for TCP receive window size takes effect for that network interface:

network interface modify -vserver <vserver name> -lif <LIF name> -status-admin down
network interface modify -vserver <vserver name> -lif <LIF name> -status-admin up
[-f, -force <true>] - Allow Non-Vendor Target Name

Force the command to accept a target name that would normally be rejected as invalid.


cluster1::> vserver iscsi modify -vserver vs_1 -status-admin down

Modifies the status-admin of the iSCSI service for Vserver vs_1 to down.

Top of Page