man1/na_iscsi(1) manual page

Manual Pages

Table of Contents

NAME

iscsi - manage iSCSI service and iSCSI adapters, and display iSCSI statistics

SYNOPSIS

iscsi config [ adapter [ up | down ] ]

iscsi nodename [ new_nodename ]

iscsi start | stop

iscsi show adapter [ adapter ]

iscsi show initiator [ adapter ... ]

iscsi stats [ -z ] [ adapter ... ]

iscsi status

iscsi security default -s CHAP -p inpassword -n inname [ -o outpassword -m outname ]

iscsi security default -s [ deny | none ]

iscsi security add -i initiator -s CHAP -p inpassword -n inname [ -o outpassword -m outname ]

iscsi security add -i initiator -s [ deny | none ]

iscsi security delete -i initiator

iscsi security show

iscsi security generate

iscsi isns config -i ip-addr

iscsi isns show

iscsi isns start

iscsi isns stop

iscsi isns update

DESCRIPTION

The iscsi command manages the iSCSI service, and the individual iSCSI adapters on a filer.

Using the iscsi command, you may start or stop the iSCSI service, configure iSCSI adapters, view the status of the iSCSI service, set the iSCSI nodename, show adapter status, display initiators currently connected to a given adapter, configure security and dump iSCSI statistics.

The iscsi command is available only if your filer has iSCSI licensed.

OPTIONS

config [ adapter [ up | down ] ]
Configures the iSCSI adapter adapter up or down. Without the optional up or down parameters, displays configurable information for specified adapter (or all adapters if adapter is omitted).

nodename [ new_nodename ]
If new_nodename is omitted, displays the current iSCSI nodename. If new_nodename is specified, sets the iSCSI target nodename to new_nodename.

start
Starts the iSCSI service if it is not already running. Using this option also attaches the iSCSI service to any iSCSI adapters configured for iSCSI usage.

stop
Stops the iSCSI service if it is running; this causes any active iSCSI sessions to be shutdown.

show adapter [ adapter ... ]
Display target adapter information for each adapter specified. Information displayed includes the physical slot, current status, description, and portal group information. If no adapter is specified, information is displayed for all adapters in the system.

show initiator [ adapter ... ]
Display list of initiators currently connected to any of the portal groups associated with each specified adapter. Information displayed for each initiator includes the target portal group number to which the initiator is connected, as well as the iSCSI initiator nodename and ISID. If no adapter is specified, information is displayed for all initiators connected through any adapter in the system.

stats [ -z ] [ adapter ... ]
Display the current iSCSI statistics for each adapter specified. Statistics displayed include the different iSCSI PDU types transmitted and received, SCSI CDB's processed, and various iSCSI errors which may occur. If no adapter is specified, statistics information is displayed for all adapters in the system.

If the -z option is given, the statistics are zeroed for each specified adapter, or for all adapters in the system if none are specified.

status
Displays current status of the iSCSI service.

security add -i initiator -s CHAP -p inpassword -n inusername [ -o outpassword -m outusername ]
Configure the iSCSI initiator initiator with CHAP as the authentication method. The -s option is used to specify the authentication method. The -p option is used to specify the Inbound CHAP password and the -n option to specify the Inbound CHAP username. The -o option is used to specify the outbound CHAP password and -m option is used to specify the Outbound CHAP name. The outbound CHAP password and username are optional and need to be configured if mutual authentication is desired. If the password is not specified on the command line then the admin is prompted for the password twice.

security add -i initiator -s [deny | none] Configure the iSCSI initiator initiator with the authentication method as deny or none. If the authentication method is deny then the specified initiator will be denied access. If the authentication method is choosen as none then no authentication would be done for the specified initiator.

security default -s CHAP -p inpassword -n inusername [ -o outpassword -m outusername ]
Configure the default authentication method as CHAP. The -p option is used to specify the Inbound CHAP password and the -n option to specify the Inbound CHAP name. The -o option is used to specify the Outbound CHAP password and -m option to specify the Outbound CHAP name. The outbound CHAP password and username are optional and need to be configured if mutual authentication is desired. If the password is not specified on the command line then the admin is prompted for the password twice.If an initiator is not configured with a specific authentication method using the `add' command the default authentication method will be applied to it.

security default -s [deny | none]
Configure the default authentication method as deny or none. If an initiator is not configured with a specific authentication method using the `add' command the default authentication method will be applied to it.

security delete -i initiator
Remove the iSCSI initiator initiator from the authentication list. The default authentication would now be applied for this initiator.

security show
Display the default authentication and all the initiator specific authentication information.

security generate
Generate a 128 bit Random password that can be used as a CHAP secret.

isns config -i ip-addr
Configure the iSNS service with the ip-address of the iSNS server The ip-addr should be entered in dotted quad format. Configuration of the isns service should take place before the isns service is started.

isns show
Show the isns service configuration. This includes the entity_id_string (EID), the ipaddr of the iSNS server and if the service is enabled.

isns start
Start the isns service. This will start the isns service and automatically register with the iSNS server. It is best to configure the isns service before starting it.

isns stop
Stop the isns service. This will disable the ability to register with the iSNS server and to be discovered by iSNS clients.

isns update
Force an update of the registration information with the iSNS server.

CLUSTER CONSIDERATIONS

iSCSI adapter names in a clustered configuration are denoted by appending a trailing `a' or `b' to the generic adapter name for local host and partner host respectively. For example, the iSCSI software target generic adapter name is `iswt', which implies the local host adapter name is `iswta' and the partner host adapter name is `iswtb'.

VFILER CONSIDERATIONS

When run from a vfiler context (e.g. via the vfiler run command), iscsi subcommands operate on the concerned vfiler with the following exceptions: the iscsi stats subcommand: the statistics displayed apply to the entire physical filer and not to individual vfilers; iscsi config subcommand: configuring the iscsi adapter up or down affect the entire filer.

EXAMPLES

Configure the localhost iSCSI software adapter, iswta, down:

       iscsi config iswta down

Set the iSCSI target nodename to a new value, iqn.1992-08.com.netapp:sn.mytarget:

       iscsi nodename iqn.1992-08.com.netapp:sn.mytarget

Start or stop the iSCSI service:

       iscsi start
       iscsi stop

Display information about all iSCSI adapters in the system:

       iscsi show adapter

might produce:

  Adapter:         iswta
  Slot:            N/A
  Description:     NetApp Software Implementation
  Status:          Online
  Target Portal Groups:
          portal group 0: inet 10.60.129.13 port 3260
          portal group 3: inet 10.60.129.34 port 3260
          portal group 4: inet 10.60.129.35 port 3260

Display all initiators currently connected to adapter iswta:

       iscsi show initiator iswta

might produce:

  Initiators connected on adapter iswta:
    Tgt_PG  iSCSI Initiator Name / ISID
       0    iqn.1992-08.com.vendor:host1 / 00:00:00:00:00:00

Display current iSCSI statistics for adapter iswta:

       iscsi stats iswta

might produce:

  Statistics for adapter iswta
  iSCSI PDUs Received
    SCSI-Cmd:   15236 | Nop-Out:      0  | SCSI TaskMgtCmd:      0
    LoginReq:       3 | LogoutReq:    1  | Text Req:             1
    DataOut:        0 | SNACK:        0  | Unknown:              0
    Total: 15241
  iSCSI PDUs Transmitted
    SCSI-Rsp:   15173 | Nop-In:       0  | SCSI TaskMgtRsp:      0
    LoginRsp:       3 | LogoutRsp:    1  | Text Rsp:             1
    Data_In:    60743 | R2T:          0  | Reject:               0
    Total: 75921
  iSCSI CDBs
    DataIn Blocks:     1942288  | DataOut Blocks:          0
    Error Status:            0  | Success Status:      15221
    Total CDBs: 15221
  iSCSI ERRORS
    Failed Logins:           1  | Failed TaskMgt:          0
    Failed Logouts:          0  | Failed TextCmd:          0
    Protocol:                1
    Unexpected session disconnects:      0
    PDU discards (outside CmdSN window): 0
    PDU discards (invalid header):       0
    Total: 2

Zero iSCSI statistics for iSCSI adapter iswta:

  iscsi stats -z iswta

Show current state of iSCSI service:

  iscsi status

Add initiator new_initiator to the configuration list with CHAP as the authentication method, pass as the CHAP password and name as the CHAP name:

  iscsi security add -i new_initiator -s CHAP -p pass -n name

Do not allow access to initiator bad_initiator:

  iscsi security add -i bad_initiator -s deny

Display the security configuration:

  iscsi security show

Set the default security method as CHAP with pass as the CHAP password and name as CHAP name:

  iscsi security default -s CHAP -p pass -n name.

Generate a 128 bit Random secret:

  iscsi security generate

Show the configuration of the iSNS service:

       iscsi isns show

might produce:

  iSNS Entity id:          entity1
  iSNS Server ip-addr:     192.168.1.1
  iSNS Status:             Enabled

Start or stop the iSNS service:

  iscsi isns start
  iscsi isns stop

Configure the iSNS service:

  iscsi isns config -i 192.168.1.1

Update registration with iSNS server:

  iscsi isns update

LIMITATIONS

The current iSCSI specification is subject to change, thus interoperability is not guaranteed in this release.