iSCSI Storage Setup with vicfg-iscsi

You can set up iSCSI storage using the vSphere Web Client, commands in the esxcli iscsi namespace (see iSCSI Storage Setup with ESXCLI) or the vicfg-iscsi command.

Setting Up Software iSCSI with vicfg-iscsi

Software iSCSI setup requires a number of high-level tasks. For each task, see the discussion of the corresponding command-line option in this chapter or the reference information. Specify one of the options listed in Connection Options 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	(Optional) Check the status.

vicfg-iscsi <conn_options> - -swiscsi - -list

The system prints Software iSCSI is enabled or Software iSCSI is not enabled.

4	(Optional) 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.

The two types of target differ as follows:

■	With dynamic discovery, all storage targets associated with a host name or IP address are discovered. You 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 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	(Optional) Set the authentication information for CHAP (see Setting iSCSI CHAP and Enabling iSCSI Authentication).

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	(Optional) 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.

Important 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	(Optional) Set iSCSI parameters by running vicfg-iscsi -W.

9	After setup is complete, run vicfg-rescan to rescan all storage devices.

Setting Up Dependent Hardware iSCSI with vicfg-iscsi

Dependent hardware iSCSI setup requires a number of high-level tasks. For each task, see the discussion of the corresponding command-line option in this chapter, or the reference information. Specify one of the options listed in Connection Options in place of <conn_options>.

1	Determine the HBA type and retrieve the HBA ID.

vicf-iscsi <conn_options> - -adapter - -list

2	(Optional) 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>

3	Set up port binding by following these steps:

a	Identify the VMkernel port of the dependent hardware iSCSI adapter.

esxcli <conn_options> swiscsi vmknic list -d <vmhba>

b	Connect the dependent hardware iSCSI initiator to the iSCSI VMkernel ports by running the following command for each port.

esxcli <conn_options> swiscsi nic add -n <port_name> -d <vmhba>

c	Verify that the ports were added to the dependent hardware iSCSI initiator.

esxcli <conn_options> swiscsi nic list -d <vmhba>

d	Rescan the dependent hardware SCSI initiator.

vicfg-rescan <conn_options> <vmhba>

4	Add a dynamic discovery address or a static discovery address.

The two types of target differ as follows:

■	With dynamic discovery, all storage targets associated with a host name or IP address are discovered. You 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 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.

5	(Optional) Set the authentication information for CHAP (see Setting iSCSI CHAP and Enabling iSCSI Authentication).

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.

6	(Optional) 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.

Important 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.

7	(Optional) Set iSCSI parameters by running vicfg-iscsi -W.

8	After setup is complete, run vicfg-rescan to rescan all storage devices.

Setting Up Independent Hardware iSCSI with vicfg-iscsi

With independent hardware-based iSCSI storage, you use a specialized third-party adapter capable of accessing iSCSI storage over TCP/IP. This iSCSI initiator handles all iSCSI and network processing and management for your ESXi system.

You must install and configure the independent hardware iSCSI adapter for your host before you can access the iSCSI storage device. For installation information, see vendor documentation.

Hardware iSCSI setup requires a number of high-level tasks. For each task, see the discussion of the corresponding command-line option in this chapter, the manpage (Linux), or the reference information. Specify one of the options listed in Connection Options in place of <conn_options>.

1	Determine the HBA type and retrieve the HBA ID.

vicf-iscsi <conn_options> - -adapter - -list

2	Configure the hardware initiator (HBA) by running vicfg-iscsi -N with one or more of the following options.

■	--list – List network properties.

■	--ip <ip_addr> – Set HBA IPv4 address.

■	--subnetmask <subnet_mask> – Set HBA network mask.

■	--gateway <default_gateway> – Set HBA gateway.

■	--set ARP=true|false – Enable or disable ARP redirect.

You can also set the HBA IPv4 address and network mask and gateway in one command.

vicfg-iscsi <conn_options> --ip <ip_addr> --subnetmask <subnet_mask> --gateway <default_gateway>

3	(Optional) 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>

4	Add a dynamic discovery address or a static discovery address.

The two types of target differ as follows:

■	With dynamic discovery, all storage targets associated with an IP address are discovered. Run the following command:

vicfg-iscsi <conn_options> --discovery --add --ip <ip_addr> <adapter_name>

■	With static discovery, you must specify the IP address and the iSCSI name of the storage target to be added. Run the following command:

vicfg-iscsi <conn_options> --static --add --ip <ip_addr>

--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 later add the discovery address and rescan to display the correct parent for the static targets.

5	(Optional) Set the authentication information for CHAP by running vicfg-iscsi -A.

You can set the information for per adapter, per discovery, and per target CHAP. See Setting iSCSI CHAP and Enabling iSCSI Authentication.

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.

Mutual CHAP is not supported for independent hardware iSCSI storage.

6	(Optional) Set additional iSCSI parameters by running vicfg-iscsi -W.

7	After setup is complete, call vicfg-rescan to rescan all storage devices.