esxcli iscsi Commands

Command Description Options Help
iscsi adapter get List the iSCSI information for the iSCSI Host Bus Adapter.
--adapter | -A
The iSCSI adapter name. (required)
--help
Show the help message.
iscsi adapter list List all the iSCSI Host Bus Adapters on the system.
--adapter | -A
The iSCSI adapter name.
--help
Show the help message.
iscsi adapter set Set the iSCSI name and alias for the iSCSI Host Bus Adapter.
--adapter | -A
The iSCSI adapter name. (required)
--alias | -a
The iSCSI initiator alias.
--name | -n
The iSCSI initiator name.
--help
Show the help message.
iscsi adapter auth chap get Get the iSCSI CHAP authentication for the iSCSI Host Bus Adapter.
--adapter | -A
The iSCSI adapter name. (required)
--direction | -d
The iSCSI CHAP authentication direction. Options are: [uni, mutual]
--help
Show the help message.
iscsi adapter auth chap set Set the iSCSI CHAP authentication for the iSCSI Host Bus Adapter.
--adapter | -A
The iSCSI adapter name. (required)
--authname | -N
The iSCSI CHAP authentication name
--default | -D
Resetting iSCSI CHAP authenthication setting to default.
--direction | -d
The iSCSI CHAP authentication direction. Options are: [uni, mutual]
--level | -l
The iSCSI CHAP authentication level. Options are: [prohibited, discouraged, preferred, required]
--secret | -S
The iSCSI CHAP authentication secret (secret)
--help
Show the help message.
iscsi adapter capabilities get List the iSCSI details for the iSCSI Host Bus Adapter.
--adapter | -A
The iSCSI adapter name. (required)
--help
Show the help message.
iscsi adapter discovery rediscover Do the iSCSI Discovery for the iSCSI Host Bus Adapter.
--adapter | -A
The iSCSI adapter name. (required)
--help
Show the help message.
iscsi adapter discovery sendtarget add Add a sendtarget address
--adapter | -A
The iSCSI adapter name. (required)
--address | -a
The iSCSI sendtarget address: ip/dns[:port]. IPv6 address can be specified as [XX:XX:XX:XX::XX]:port or XX:XX:XX:XX::XX (required)
--help
Show the help message.
iscsi adapter discovery sendtarget list List sendtarget addresses
--adapter | -A
The iSCSI adapter name.
--help
Show the help message.
iscsi adapter discovery sendtarget remove Remove a sendtarget address
--adapter | -A
The iSCSI adapter name. (required)
--address | -a
The iSCSI sendtarget address: ip/dns[:port]. IPv6 address can be specified as [XX:XX:XX:XX::XX]:port or XX:XX:XX:XX::XX (required)
--help
Show the help message.
iscsi adapter discovery sendtarget auth chap get Get iSCSI CHAP authentication on a sendtarget address
--adapter | -A
The iSCSI adapter name. (required)
--address | -a
The iSCSI sendtarget address: ip/dns[:port] (required)
--direction | -d
The iSCSI authentication direction. Options are: [uni, mutual]
--help
Show the help message.
iscsi adapter discovery sendtarget auth chap set Set iSCSI CHAP authentication on a sendtarget address
--adapter | -A
The iSCSI adapter name. (required)
--address | -a
The iSCSI sendtarget address: ip/dns[:port] (required)
--authname | -N
The iSCSI authentication name
--default | -D
Resetting iSCSI authentication setting to default.
--direction | -d
The iSCSI authentication direction. Options are: [uni, mutual]
--inherit | -I
Inheriting iSCSI authentication setting from parent.
--level | -l
The iSCSI authentication level. Options are: [prohibited, discouraged, preferred, required]
--secret | -S
The iSCSI authentication secret (secret)
--help
Show the help message.
iscsi adapter discovery sendtarget param get Get iSCSI parameter on a sendtarget address
--adapter | -A
The iSCSI adapter name. (required)
--address | -a
The iSCSI sendtarget address: ip/dns[:port] (required)
--help
Show the help message.
iscsi adapter discovery sendtarget param set Set the iSCSI parameter for the iSCSI Sendtarget.
--adapter | -A
The iSCSI adapter name. (required)
--address | -a
The iSCSI sendtarget address: ip/dns[:port] (required)
--default | -D
Resetting iSCSI parameter setting to default.
--inherit | -I
Inheriting iSCSI parameter setting from parent.
--key | -k
The iSCSI parameter key (required)
--value | -v
The iSCSI parameter value
--help
Show the help message.
iscsi adapter discovery statictarget add Add a static target address
--adapter | -A
The iSCSI adapter name. (required)
--address | -a
The iSCSI target address: ip/dns[:port]. IPv6 address can be specified as [XX:XX:XX:XX::XX]:port or XX:XX:XX:XX::XX (required)
--name | -n
The iSCSI target name. (required)
--help
Show the help message.
iscsi adapter discovery statictarget list List static target addresses
--adapter | -A
The iSCSI adapter name.
--help
Show the help message.
iscsi adapter discovery statictarget remove Remove a static target
--adapter | -A
The iSCSI adapter name. (required)
--address | -a
The iSCSI target address: ip/dns[:port]. IPv6 address can be specified as [XX:XX:XX:XX::XX]:port or XX:XX:XX:XX::XX (required)
--name | -n
The iSCSI target name. (required)
--help
Show the help message.
iscsi adapter discovery status get Get the iSCSI adapter discovery status for the iSCSI Host Bus Adapter.
--adapter | -A
The iSCSI adapter name. (required)
--help
Show the help message.
iscsi adapter firmware get Validate the iSCSI firmware for the iSCSI Host Bus Adapter.
--adapter | -A
The iSCSI adapter name. (required)
--file | -f
Path to the firmware file to retrieve information from. (required)
--help
Show the help message.
iscsi adapter firmware set Upload the iSCSI firmware for the iSCSI Host Bus Adapter.
--adapter | -A
The iSCSI adapter name. (required)
--file | -f
Path to the firmware file to download. (required)
--help
Show the help message.
iscsi adapter param get Get the iSCSI parameters for the iSCSI Host Bus Adapter.
--adapter | -A
The iSCSI adapter name. (required)
--help
Show the help message.
iscsi adapter param set Set the iSCSI parameter for the iSCSI Host Bus Adapter.
--adapter | -A
The iSCSI adapter name. (required)
--default | -D
Resetting iSCSI parameter setting to default.
--key | -k
The iSCSI initiator parameter key. (required)
--value | -v
The iSCSI initiator parameter value.
--help
Show the help message.
iscsi adapter target list List iSCSI targets.
--adapter | -A
The iSCSI adapter name.
--name | -n
The iSCSI target name.
--help
Show the help message.
iscsi adapter target portal list List iSCSI target portals.
--adapter | -A
The iSCSI adapter name.
--name | -n
The iSCSI target name.
--help
Show the help message.
iscsi adapter target portal auth chap get Get iSCSI CHAP authentication on a target
--adapter | -A
The iSCSI adapter name. (required)
--address | -a
The iSCSI target address: ip/dns[:port] (required)
--direction | -d
The iSCSI authentication direction. Options are: [uni, mutual]
--method | -m
The iSCSI authentication method. Options are: [chap]
--name | -n
The iSCSI target name: iqn/eui (required)
--help
Show the help message.
iscsi adapter target portal auth chap set Set the iSCSI CHAP authentication for the iSCSI Target.
--adapter | -A
The iSCSI adapter name. (required)
--address | -a
The iSCSI target address: ip/dns[:port] (required)
--authname | -N
The iSCSI authentication name
--default | -D
Resetting iSCSI authentication setting to default.
--direction | -d
The iSCSI authentication direction. Options are: [uni, mutual]
--inherit | -I
Inheriting iSCSI authentication setting from parent.
--level | -l
The iSCSI authentication level. Options are: [prohibited, discouraged, preferred, required]
--name | -n
The iSCSI target name: iqn/eui (required)
--secret | -S
The iSCSI authentication password (secret)
--help
Show the help message.
iscsi adapter target portal param get Get iSCSI parameter on a target
--adapter | -A
The iSCSI adapter name. (required)
--address | -a
The iSCSI target address: ip/dns[:port] (required)
--name | -n
The iSCSI target name: iqn/eui (required)
--help
Show the help message.
iscsi adapter target portal param set Set the iSCSI parameter for the iSCSI Target.
--adapter | -A
The iSCSI adapter name. (required)
--address | -a
The iSCSI target address: ip/dns[:port] (required)
--default | -D
Resetting iSCSI parameter setting to default.
--inherit | -I
Inheriting iSCSI parameter setting from parent.
--key | -k
The iSCSI parameter key (required)
--name | -n
The iSCSI target name: iqn/eui (required)
--value | -v
The iSCSI parameter value
--help
Show the help message.
iscsi ibftboot get Get iSCSI IBFT Boot details.
--help
Show the help message.
iscsi ibftboot import Import iSCSI target configuration from iBFT to ESX iSCSI initiators. The boot target recorded in iBFT is added to all the eligible 'dependent' iSCSI adapters.
--help
Show the help message.
iscsi logicalnetworkportal list List Logical Network Portals for iSCSI Adapter
--adapter | -A
The iSCSI adapter name.
--help
Show the help message.
iscsi networkportal add Add a network portal for iSCSI adapter
--adapter | -A
The iSCSI adapter name. (required)
--force | -f
The force flag (force add of iSCSI vmknic even it's not compatible for iscsi multipathing)
--nic | -n
The iSCSI network portal (bound vmknic) (required)
--help
Show the help message.
iscsi networkportal list List Network Portal for iSCSI Adapter
--adapter | -A
The iSCSI adapter name.
--help
Show the help message.
iscsi networkportal remove Remove a network portal for iSCSI adapter
--adapter | -A
The iSCSI adapter name. (required)
--force | -f
The force flag (force removal of iSCSI vmknic when sessions are active using it)
--nic | -n
The iSCSI network portal (bound vmknic) (required)
--help
Show the help message.
iscsi networkportal ipconfig get Get iSCSI network portal ipv4 configuration
--adapter | -A
The iSCSI adapter name. (required)
--nic | -n
The iSCSI network portal (vmknic)
--help
Show the help message.
iscsi networkportal ipconfig set Set iSCSI network portal IPv4 configuration.
--adapter | -A
The iSCSI adapter name. (required)
--dns1 | -x
The iSCSI network portal primary DNS address
--dns2 | -y
The iSCSI network portal secondary DNS address
--enable | -e
Enable/Disable IPv4. All other options will be ignored if IPv4 is being disabled.
--enable-dhcpv4 | -d
Enable/Disable IPv4 configuration using DHCPv4. If DHCPv4 is being enabled, static configuration parameters (ip,subnet,gateway,dns1,dns2) are ignored.
--gateway | -g
The iSCSI network portal IPv4 gateway address
--ip | -i
The iSCSI network portal IPv4 address
--nic | -n
The iSCSI network portal (vmknic)
--subnet | -s
The iSCSI network portal IPv4 subnet mask
--help
Show the help message.
iscsi networkportal ipv6config get Get iSCSI network portal ipv6 configuration
--adapter | -A
The iSCSI adapter name. (required)
--help
Show the help message.
iscsi networkportal ipv6config set Set iSCSI network portal IPv6 configuration.
--adapter | -A
The iSCSI adapter name. (required)
--enable | -e
Enable/Disable IPv6
--enable-dhcpv6 | -d
Enable/Disable IPv6 configuration using DHCPv6
--enable-linklocal-autoconfiguration | -l
Enable/Disable auto configuration of linklocal address
--enable-router-advertisement | -r
Enable/Disable IPv6 configuration using Router Advertisement
--gateway6 | -g
The iSCSI network portal IPv6 gateway address
--help
Show the help message.
iscsi networkportal ipv6config address add Add IPv6 addresses to the given iSCSI network portal.
--adapter | -A
The iSCSI adapter name. (required)
--address-list | -a
An IPv6 address to add in X:X:X::/X format. Multiple addresses can be provided using format -a address1 -a address2 -a address3.
--remove-all-existing | -r
Remove all existing routable IPv6 addresses before adding the addresses specified by --address-list. If this flag is passed and --address-list is empty, all existing routable addresses are removed.
--help
Show the help message.
iscsi networkportal ipv6config address list List the IPv6 addresses assigned to the iSCSI network portal.
--adapter | -A
The iSCSI adapter name. (required)
--help
Show the help message.
iscsi networkportal ipv6config address remove Remove IPv6 addresses from the given iSCSI network portal.
--adapter | -A
The iSCSI adapter name. (required)
--address-list | -a
An IPv6 address to remove in X:X:X::/X format. Multiple addresses can be provided using format -a address1 -a address2 -a address3. (required)
--help
Show the help message.
iscsi physicalnetworkportal list List Physical Network Portal for iSCSI Adapter
--adapter | -A
The iSCSI adapter name.
--help
Show the help message.
iscsi physicalnetworkportal param get Get network parameters on a Physical Network Portal (vmnic)
--adapter | -A
The iSCSI adapter name. (required)
--nic | -n
The physical network portal name: vmnic
--help
Show the help message.
iscsi physicalnetworkportal param set Set network parameter on a Physical Network Portal
--adapter | -A
The iSCSI adapter name. (required)
--nic | -n
The physical network portal name: vmnic
--option | -o
The network parameter option. Supported options are [MTU, ArpRedirect]. (required)
--value | -v
Input value for a Physical Network Portal option (use 0/1 for bool, and number for int) (required)
--help
Show the help message.
iscsi plugin list List IMA plugins.
--adapter | -A
The iSCSI adapter name.
--plugin | -p
The IMA plugin file name.
--help
Show the help message.
iscsi session add Login sessions on current iSCSI configuration.
--adapter | -A
The iSCSI adapter name. (required)
--isid | -s
The isid of a session to duplicate for login.
--name | -n
The iSCSI target name.
--help
Show the help message.
iscsi session list List iSCSI Sessions.
--adapter | -A
The iSCSI adapter name.
--isid | -s
The iSCSI session identifier.
--name | -n
The iSCSI target name.
--help
Show the help message.
iscsi session remove Logout sessions on current iSCSI configuration.
--adapter | -A
The iSCSI adapter name. (required)
--isid | -s
The isid of a session to duplicate for login.
--name | -n
The name of the target to login to.
--help
Show the help message.
iscsi session connection list List iSCSI connections.
--adapter | -A
The iSCSI adapter name.
--cid | -c
The iSCSI connection identifier(CID).
--isid | -s
The iSCSI session identifier(ISID).
--name | -n
The iSCSI target name.
--help
Show the help message.
iscsi software get Software iSCSI information.
--help
Show the help message.
iscsi software set Enable or disable software iSCSI.
--enabled | -e
Enable or disable the module. (required)
--name | -n
The iSCSI initiator name. The initiator name must not be specified when disabling software iSCSI.
--help
Show the help message.