VMware vSphere SDKs and Tools 6.7

8.0 7.0 6.7 6.5

Set Up Software iSCSI with vicfg-iscsi
Last Updated December 19, 2024

Software iSCSI setup requires a number of high-level tasks.
You should be familiar with the corresponding command for each task. You can refer to the relevant documentation for each command. Specify one of the options listed in Connection Options for vCLI Host Management Commands in place of
<conn_options>
.
  1. Determine the HBA type and retrieve the HBA ID. 
    vicfg-iscsi <conn_options> --adapter --list
  2. Enable software iSCSI for the HBA. 
    vicfg-iscsi <conn_options> --swiscsi --enable
  3. Check the status. 
    vicfg-iscsi <conn_options> --swiscsi --list
    The system prints
    Software iSCSI is enabled
     or
    Software iSCSI is not enabled
    .
  4. Set the iSCSI name and alias. 
    vicfg-iscsi <conn_options> -I -n <iscsi_name> <adapter_name>
vicfg-iscsi <conn_options> --iscsiname - -name <iscsi_name> <adapter_name>
vicfg-iscsi <conn_options> -I -a <alias_name> <adapter_name>
vicfg-iscsi <conn_options> --iscsiname --alias <alias_name> <adapter_name>
  5. Add a dynamic discovery address or a static discovery address.
    • With dynamic discovery, all storage targets associated with a host name or IP address are discovered. You can run the following command. 
      vicfg-iscsi <conn_options> --discovery --add --ip <ip_addr | domain_name> <adapter_name>
    • With static discovery, you must specify the host name or IP address and the iSCSI name of the storage target. You can run the following command. 
      vicfg-iscsi <conn_options> --static --add --ip <ip_addr | domain_name> --name <iscsi_name> <adapter_name>
    When you later remove a discovery address, it might still be displayed as the parent of a static target. You can add the discovery address and rescan to display the correct parent for the static targets.
  6. Set the authentication information for CHAP. 
    vicfg-iscsi <conn_options> -A -c <level> -m <auth_method> -u <auth_u_name> -w <chap_password>
         [-i <stor_ip_addr|stor_hostname> [:<portnum>] [-n <iscsi_name]] <adapter_name>
vicfg-iscsi <conn_options> - -authentication - -level <level> - -method <auth_method>
         --chap_username <auth_u_name> --chap_password <chap_password>
         [--ip <stor_ip_addr|stor_hostname> [:<portnum>] [-name <iscsi_name]]
         <adapter_name>
    The target (
    -i
    ) and name (
    -n
    ) option determine what the command applies to.
    Option
    Result
    -i and -n
    Command applies to per-target CHAP for static targets.
    Only -i
    Command applies to the discovery address.
    Neither -i nor -n
    Command applies to per-adapter CHAP.
  7. Set the authentication information for mutual CHAP by running
    vicfg-iscsi -A
     again with the
    -b
     option and a different authentication user name and password.
    For
    <level>
    , specify
    chapProhibited
     or
    chapRequired
    .
    • chapProhibited
       – The host does not use CHAP authentication. If authentication is enabled, specify
      chapProhibited
       to disable it.
    • chapRequired
       – The host requires successful CHAP authentication. The connection fails if CHAP negotiation fails. You can set this value for mutual CHAP only if CHAP is set to
      chapRequired
      .
    For
    <auth_method>
    , CHAP is the only valid value.
    You are responsible for making sure that CHAP is set before you set mutual CHAP, and for using compatible levels for CHAP and mutual CHAP.
  8. Set iSCSI parameters by running
    vicfg-iscsi -W
    .
  9. After setup is complete, run
    vicfg-rescan
     to rescan all storage devices.

Content feedback and comments