ESXi - 6.7 iscsi
iscsi
VMware Internet Small Computer Systems Interface (iSCSI) commands.
adapter
- list
- List all the iSCSI Host Bus Adapters on the system.
esxcli iscsi adapter list
- get
- List the iSCSI information for the iSCSI Host Bus Adapter.
esxcli iscsi adapter get NAME
- set
- Set the iSCSI name and alias for the iSCSI Host Bus Adapter.
esxcli iscsi adapter set CMD_OPTIONS
- Set the iSCSI name and alias for the iSCSI Host Bus Adapter.
- List the iSCSI information for the iSCSI Host Bus Adapter.
NAME -A|--adapter=<str> The iSCSI adapter name. (required) CMD_OPTIONS -A|--adapter=<str> The iSCSI adapter name. (required) -a|--alias=<str> The iSCSI initiator alias. -n|--name=<str> The iSCSI initiator name. -s|--skip-if-session-active Do not change initiator name if a session is active on the adapter.
auth
chap
- get
- Get the iSCSI CHAP authentication for the iSCSI Host Bus Adapter.
esxcli iscsi adapter auth chap get CMD_OPTIONS
CMD_OPTIONS -A|--adapter=<str> The iSCSI adapter name. (required) -d|--direction=<str> The iSCSI CHAP authentication direction. Options are: [uni, mutual]
- set
- Set the iSCSI CHAP authentication for the iSCSI Host Bus Adapter.
esxcli iscsi adapter auth chap set CMD_OPTIONS
CMD_OPTIONS -A|--adapter=<str> The iSCSI adapter name. (required) -N|--authname=<str> The iSCSI CHAP authentication name -D|--default Resetting iSCSI CHAP authenthication setting to default. -d|--direction=<str> The iSCSI CHAP authentication direction. Options are: [uni, mutual] -l|--level=<str> The iSCSI CHAP authentication level. Options are: [prohibited, discouraged, preferred, required] -S|--secret=<str> The iSCSI CHAP authentication secret. The recommended length is at least 12 bytes. (secret) WARNING: Providing secret values on the command line is insecure because it may be logged or preserved in history files. Instead, specify this option with no value on the command line, and enter the value on the supplied prompt.
capabilities
- get
- List the iSCSI details for the iSCSI Host Bus Adapter.
esxcli iscsi adapter capabilities get NAME
NAME -A|--adapter=<str> The iSCSI adapter name. (required)
discovery
- rediscover
- Do the iSCSI Discovery for the iSCSI Host Bus Adapter.
esxcli iscsi adapter discovery rediscover NAME
NAME -A|--adapter=<str> The iSCSI adapter name. (required)
sendtarget
- list
- List sendtarget addresses
esxcli iscsi adapter discovery sendtarget list
- add
- Add a sendtarget address
esxcli iscsi adapter discovery sendtarget add CMD_OPTIONS
- remove
- Remove a sendtarget address
esxcli iscsi adapter discovery sendtarget remove CMD_OPTIONS
CMD_OPTIONS -A|--adapter=<str> The iSCSI adapter name. (required) -a|--address=<str> 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)
auth
chap
- get
- Get iSCSI CHAP authentication on a sendtarget address
esxcli iscsi adapter discovery sendtarget auth chap get CMD_OPTIONS
CMD_OPTIONS -A|--adapter=<str> The iSCSI adapter name. (required) -a|--address=<str> The iSCSI sendtarget address: <ip/dns[:port]> (required) -d|--direction=<str> The iSCSI authentication direction. Options are: [uni, mutual]
- set
- Set iSCSI CHAP authentication on a sendtarget address
esxcli iscsi adapter discovery sendtarget auth chap set CMD_OPTIONS
CMD_OPTIONS -A|--adapter=<str> The iSCSI adapter name. (required) -a|--address=<str> The iSCSI sendtarget address: <ip/dns[:port]> (required) -N|--authname=<str> The iSCSI authentication name -D|--default Resetting iSCSI authentication setting to default. -d|--direction=<str> The iSCSI authentication direction. Options are: [uni, mutual] -I|--inherit Inheriting iSCSI authentication setting from parent. -l|--level=<str> The iSCSI authentication level. Options are: [prohibited, discouraged, preferred, required] -S|--secret=<str> The iSCSI authentication secret. The recommended length is at least 12 bytes. (secret) WARNING: Providing secret values on the command line is insecure because it may be logged or preserved in history files. Instead, specify this option with no value on the command line, and enter the value on the supplied prompt.
param
- get
- Get iSCSI parameter on a sendtarget address
esxcli iscsi adapter discovery sendtarget param get CMD_OPTIONS
CMD_OPTIONS -A|--adapter=<str> The iSCSI adapter name. (required) -a|--address=<str> The iSCSI sendtarget address: <ip/dns[:port]> (required)
- set
- Set the iSCSI parameter for the iSCSI Sendtarget.
esxcli iscsi adapter discovery sendtarget param set CMD_OPTIONS
CMD_OPTIONS -A|--adapter=<str> The iSCSI adapter name. (required) -a|--address=<str> The iSCSI sendtarget address: <ip/dns[:port]> (required) -D|--default Resetting iSCSI parameter setting to default. -I|--inherit Inheriting iSCSI parameter setting from parent. -k|--key=<str> The iSCSI parameter key (required) -v|--value=<str> The iSCSI parameter value
statictarget
- list
- List static target addresses
esxcli iscsi adapter discovery statictarget list
- add
- Add a static target address
esxcli iscsi adapter discovery statictarget add CMD_OPTIONS
- remove
- Remove a static target
esxcli iscsi adapter discovery statictarget remove CMD_OPTIONS
CMD_OPTIONS -A|--adapter=<str> The iSCSI adapter name. (required) -a|--address=<str> 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) -n|--name=<str> The iSCSI target name. (required)
status
- get
- Get the iSCSI adapter discovery status for the iSCSI Host Bus Adapter.
esxcli iscsi adapter discovery status get CMD_OPTIONS
CMD_OPTIONS -A|--adapter=<str> The iSCSI adapter name. (required)
firmware
- get
- Validate the iSCSI firmware for the iSCSI Host Bus Adapter.
esxcli iscsi adapter firmware get CMD_OPTIONS
CMD_OPTIONS -A|--adapter=<str> The iSCSI adapter name. (required) -f|--file=<str> Path to the firmware file to retrieve information from. (required)
- set
- Upload the iSCSI firmware for the iSCSI Host Bus Adapter.
esxcli iscsi adapter firmware set CMD_OPTIONS
CMD_OPTIONS -A|--adapter=<str> The iSCSI adapter name. (required) -f|--file=<str> Path to the firmware file to download. (required)
param
- get
- Get the iSCSI parameters for the iSCSI Host Bus Adapter.
esxcli iscsi adapter param get CMD_OPTIONS
CMD_OPTIONS -A|--adapter=<str> The iSCSI adapter name. (required)
- set
- Set the iSCSI parameter for the iSCSI Host Bus Adapter.
esxcli iscsi adapter param set CMD_OPTIONS
CMD_OPTIONS -A|--adapter=<str> The iSCSI adapter name. (required) -D|--default Resetting iSCSI parameter setting to default. -k|--key=<str> The iSCSI initiator parameter key. (required) -v|--value=<str> The iSCSI initiator parameter value.
target
- list
- List iSCSI targets.
esxcli iscsi adapter target list
lun
- list
- Get iSCSI LUN information
esxcli iscsi adapter target lun list
portal
- list
- List iSCSI target portals.
esxcli iscsi adapter target portal list
auth
chap
- get
- Get iSCSI CHAP authentication on a target
esxcli iscsi adapter target portal auth chap get CMD_OPTIONS
CMD_OPTIONS -A|--adapter=<str> The iSCSI adapter name. (required) -a|--address=<str> The iSCSI target address: <ip/dns[:port]> (required) -d|--direction=<str> The iSCSI authentication direction. Options are: [uni, mutual] -m|--method=<str> The iSCSI authentication method. Options are: [chap] -n|--name=<str> The iSCSI target name: <iqn/eui> (required)
- set
- Set the iSCSI CHAP authentication for the iSCSI Target.
esxcli iscsi adapter target portal auth chap set CMD_OPTIONS
CMD_OPTIONS -A|--adapter=<str> The iSCSI adapter name. (required) -a|--address=<str> The iSCSI target address: <ip/dns[:port]> (required) -N|--authname=<str> The iSCSI authentication name -D|--default Resetting iSCSI authentication setting to default. -d|--direction=<str> The iSCSI authentication direction. Options are: [uni, mutual] -I|--inherit Inheriting iSCSI authentication setting from parent. -l|--level=<str> The iSCSI authentication level. Options are: [prohibited, discouraged, preferred, required] -n|--name=<str> The iSCSI target name: <iqn/eui> (required) -S|--secret=<str> The iSCSI authentication secret. The recommended length is at least 12 bytes. (secret) WARNING: Providing secret values on the command line is insecure because it may be logged or preserved in history files. Instead, specify this option with no value on the command line, and enter the value on the supplied prompt.
param
- get
- Get iSCSI parameter on a target
esxcli iscsi adapter target portal param get CMD_OPTIONS
CMD_OPTIONS -A|--adapter=<str> The iSCSI adapter name. (required) -a|--address=<str> The iSCSI target address: <ip/dns[:port]> (required) -n|--name=<str> The iSCSI target name: <iqn/eui> (required)
- set
- Set the iSCSI parameter for the iSCSI Target.
esxcli iscsi adapter target portal param set CMD_OPTIONS
CMD_OPTIONS -A|--adapter=<str> The iSCSI adapter name. (required) -a|--address=<str> The iSCSI target address: <ip/dns[:port]> (required) -D|--default Resetting iSCSI parameter setting to default. -I|--inherit Inheriting iSCSI parameter setting from parent. -k|--key=<str> The iSCSI parameter key (required) -n|--name=<str> The iSCSI target name: <iqn/eui> (required) -v|--value=<str> The iSCSI parameter value
ibftboot
- get
- Get iSCSI IBFT Boot details.
esxcli iscsi ibftboot get
- 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.
esxcli iscsi ibftboot import
logicalnetworkportal
- list
- List Logical Network Portals for iSCSI Adapter
esxcli iscsi logicalnetworkportal list
networkportal
- list
- List Network Portal for iSCSI Adapter
esxcli iscsi networkportal list
- add
- Add a network portal for iSCSI adapter
esxcli iscsi networkportal add CMD_OPTIONS
CMD_OPTIONS -A|--adapter=<str> The iSCSI adapter name. (required) -f|--force=<bool> The force flag (force add of iSCSI vmknic even it's not compatible for iscsi multipathing) -n|--nic=<str> The iSCSI network portal (bound vmknic) (required)
- remove
- Remove a network portal for iSCSI adapter
esxcli iscsi networkportal remove CMD_OPTIONS
CMD_OPTIONS -A|--adapter=<str> The iSCSI adapter name. (required) -f|--force=<bool> The force flag (force removal of iSCSI vmknic when sessions are active using it) -n|--nic=<str> The iSCSI network portal (bound vmknic) (required)