Difference between revisions of "ESXi - 6.7 iscsi"
Jump to navigation
Jump to search
| (One intermediate revision by the same user not shown) | |||
| Line 1: | Line 1: | ||
VMware Internet Small Computer Systems Interface (iSCSI) commands. | VMware Internet Small Computer Systems Interface (iSCSI) commands. | ||
| Line 11: | Line 10: | ||
:: '''set''' | :: '''set''' | ||
::: Set the iSCSI name and alias for the iSCSI Host Bus Adapter. | ::: Set the iSCSI name and alias for the iSCSI Host Bus Adapter. | ||
:::* <code>esxcli iscsi adapter set ''' | :::* <code>esxcli iscsi adapter set '''OPTIONS'''</code> | ||
'''NAME''' | '''NAME''' | ||
-A{{!}}--adapter=<str> The iSCSI adapter name. (required) | -A{{!}}--adapter=<str> The iSCSI adapter name. (required) | ||
''' | '''OPTIONS''' | ||
-A{{!}}--adapter=<str> The iSCSI adapter name. (required) | -A{{!}}--adapter=<str> The iSCSI adapter name. (required) | ||
-a{{!}}--alias=<str> The iSCSI initiator alias. | -a{{!}}--alias=<str> The iSCSI initiator alias. | ||
| Line 24: | Line 23: | ||
::* '''get''' | ::* '''get''' | ||
::: Get the iSCSI CHAP authentication for the iSCSI Host Bus Adapter. | ::: Get the iSCSI CHAP authentication for the iSCSI Host Bus Adapter. | ||
:::* <code>esxcli iscsi adapter auth chap get ''' | :::* <code>esxcli iscsi adapter auth chap get '''OPTIONS'''</code> | ||
''' | '''OPTIONS''' | ||
-A{{!}}--adapter=<str> The iSCSI adapter name. (required) | -A{{!}}--adapter=<str> The iSCSI adapter name. (required) | ||
-d{{!}}--direction=<str> The iSCSI CHAP authentication direction. Options are: [uni, mutual] | -d{{!}}--direction=<str> The iSCSI CHAP authentication direction. Options are: [uni, mutual] | ||
::* '''set''' | ::* '''set''' | ||
::: Set the iSCSI CHAP authentication for the iSCSI Host Bus Adapter. | ::: Set the iSCSI CHAP authentication for the iSCSI Host Bus Adapter. | ||
:::* <code>esxcli iscsi adapter auth chap set ''' | :::* <code>esxcli iscsi adapter auth chap set '''OPTIONS'''</code> | ||
''' | '''OPTIONS''' | ||
-A{{!}}--adapter=<str> The iSCSI adapter name. (required) | -A{{!}}--adapter=<str> The iSCSI adapter name. (required) | ||
-N{{!}}--authname=<str> The iSCSI CHAP authentication name | -N{{!}}--authname=<str> The iSCSI CHAP authentication name | ||
| Line 67: | Line 66: | ||
* '''add''' | * '''add''' | ||
: Add a sendtarget address | : Add a sendtarget address | ||
:* <code>esxcli iscsi adapter discovery sendtarget add ''' | :* <code>esxcli iscsi adapter discovery sendtarget add '''OPTIONS'''</code> | ||
* '''remove''' | * '''remove''' | ||
: Remove a sendtarget address | : Remove a sendtarget address | ||
:* <code>esxcli iscsi adapter discovery sendtarget remove ''' | :* <code>esxcli iscsi adapter discovery sendtarget remove '''OPTIONS'''</code> | ||
''' | '''OPTIONS''' | ||
-A|--adapter=<str> The iSCSI adapter name. (required) | -A|--adapter=<str> The iSCSI adapter name. (required) | ||
-a|--address=<str> The iSCSI sendtarget address: <ip/dns[:port]>. IPv6 address can be | -a|--address=<str> The iSCSI sendtarget address: <ip/dns[:port]>. IPv6 address can be | ||
| Line 82: | Line 81: | ||
* '''get''' | * '''get''' | ||
: Get iSCSI CHAP authentication on a sendtarget address | : Get iSCSI CHAP authentication on a sendtarget address | ||
:* <code>esxcli iscsi adapter discovery sendtarget auth chap get ''' | :* <code>esxcli iscsi adapter discovery sendtarget auth chap get '''OPTIONS'''</code> | ||
''' | '''OPTIONS''' | ||
-A|--adapter=<str> The iSCSI adapter name. (required) | -A|--adapter=<str> The iSCSI adapter name. (required) | ||
-a|--address=<str> The iSCSI sendtarget address: <ip/dns[:port]> (required) | -a|--address=<str> The iSCSI sendtarget address: <ip/dns[:port]> (required) | ||
| Line 90: | Line 89: | ||
* '''set''' | * '''set''' | ||
: Set iSCSI CHAP authentication on a sendtarget address | : Set iSCSI CHAP authentication on a sendtarget address | ||
:* <code>esxcli iscsi adapter discovery sendtarget auth chap set ''' | :* <code>esxcli iscsi adapter discovery sendtarget auth chap set '''OPTIONS'''</code> | ||
''' | '''OPTIONS''' | ||
-A|--adapter=<str> The iSCSI adapter name. (required) | -A|--adapter=<str> The iSCSI adapter name. (required) | ||
-a|--address=<str> The iSCSI sendtarget address: <ip/dns[:port]> (required) | -a|--address=<str> The iSCSI sendtarget address: <ip/dns[:port]> (required) | ||
| Line 110: | Line 109: | ||
* '''get''' | * '''get''' | ||
: Get iSCSI parameter on a sendtarget address | : Get iSCSI parameter on a sendtarget address | ||
:* <code>esxcli iscsi adapter discovery sendtarget param get ''' | :* <code>esxcli iscsi adapter discovery sendtarget param get '''OPTIONS'''</code> | ||
''' | '''OPTIONS''' | ||
-A|--adapter=<str> The iSCSI adapter name. (required) | -A|--adapter=<str> The iSCSI adapter name. (required) | ||
-a|--address=<str> The iSCSI sendtarget address: <ip/dns[:port]> (required) | -a|--address=<str> The iSCSI sendtarget address: <ip/dns[:port]> (required) | ||
| Line 117: | Line 116: | ||
* '''set''' | * '''set''' | ||
: Set the iSCSI parameter for the iSCSI Sendtarget. | : Set the iSCSI parameter for the iSCSI Sendtarget. | ||
:* <code>esxcli iscsi adapter discovery sendtarget param set ''' | :* <code>esxcli iscsi adapter discovery sendtarget param set '''OPTIONS'''</code> | ||
''' | '''OPTIONS''' | ||
-A|--adapter=<str> The iSCSI adapter name. (required) | -A|--adapter=<str> The iSCSI adapter name. (required) | ||
-a|--address=<str> The iSCSI sendtarget address: <ip/dns[:port]> (required) | -a|--address=<str> The iSCSI sendtarget address: <ip/dns[:port]> (required) | ||
| Line 132: | Line 131: | ||
* '''add''' | * '''add''' | ||
: Add a static target address | : Add a static target address | ||
:* <code>esxcli iscsi adapter discovery statictarget add ''' | :* <code>esxcli iscsi adapter discovery statictarget add '''OPTIONS'''</code> | ||
* '''remove''' | * '''remove''' | ||
: Remove a static target | : Remove a static target | ||
:* <code>esxcli iscsi adapter discovery statictarget remove ''' | :* <code>esxcli iscsi adapter discovery statictarget remove '''OPTIONS'''</code> | ||
''' | '''OPTIONS''' | ||
-A|--adapter=<str> The iSCSI adapter name. (required) | -A|--adapter=<str> The iSCSI adapter name. (required) | ||
-a|--address=<str> The iSCSI target address: <ip/dns[:port]>. IPv6 address can be specified as | -a|--address=<str> The iSCSI target address: <ip/dns[:port]>. IPv6 address can be specified as | ||
| Line 146: | Line 145: | ||
* '''get''' | * '''get''' | ||
: Get the iSCSI adapter discovery status for the iSCSI Host Bus Adapter. | : Get the iSCSI adapter discovery status for the iSCSI Host Bus Adapter. | ||
:* <code>esxcli iscsi adapter discovery status get ''' | :* <code>esxcli iscsi adapter discovery status get '''OPTIONS'''</code> | ||
''' | '''OPTIONS''' | ||
-A|--adapter=<str> The iSCSI adapter name. (required) | -A|--adapter=<str> The iSCSI adapter name. (required) | ||
| Line 153: | Line 152: | ||
* '''get''' | * '''get''' | ||
: Validate the iSCSI firmware for the iSCSI Host Bus Adapter. | : Validate the iSCSI firmware for the iSCSI Host Bus Adapter. | ||
:* <code>esxcli iscsi adapter firmware get ''' | :* <code>esxcli iscsi adapter firmware get '''OPTIONS'''</code> | ||
''' | '''OPTIONS''' | ||
-A|--adapter=<str> The iSCSI adapter name. (required) | -A|--adapter=<str> The iSCSI adapter name. (required) | ||
-f|--file=<str> Path to the firmware file to retrieve information from. (required) | -f|--file=<str> Path to the firmware file to retrieve information from. (required) | ||
| Line 160: | Line 159: | ||
* '''set''' | * '''set''' | ||
: Upload the iSCSI firmware for the iSCSI Host Bus Adapter. | : Upload the iSCSI firmware for the iSCSI Host Bus Adapter. | ||
:* <code>esxcli iscsi adapter firmware set ''' | :* <code>esxcli iscsi adapter firmware set '''OPTIONS'''</code> | ||
''' | '''OPTIONS''' | ||
-A|--adapter=<str> The iSCSI adapter name. (required) | -A|--adapter=<str> The iSCSI adapter name. (required) | ||
-f|--file=<str> Path to the firmware file to download. (required) | -f|--file=<str> Path to the firmware file to download. (required) | ||
| Line 168: | Line 167: | ||
* '''get''' | * '''get''' | ||
: Get the iSCSI parameters for the iSCSI Host Bus Adapter. | : Get the iSCSI parameters for the iSCSI Host Bus Adapter. | ||
:* <code>esxcli iscsi adapter param get ''' | :* <code>esxcli iscsi adapter param get '''OPTIONS'''</code> | ||
''' | '''OPTIONS''' | ||
-A|--adapter=<str> The iSCSI adapter name. (required) | -A|--adapter=<str> The iSCSI adapter name. (required) | ||
* '''set''' | * '''set''' | ||
: Set the iSCSI parameter for the iSCSI Host Bus Adapter. | : Set the iSCSI parameter for the iSCSI Host Bus Adapter. | ||
:* <code>esxcli iscsi adapter param set ''' | :* <code>esxcli iscsi adapter param set '''OPTIONS'''</code> | ||
''' | '''OPTIONS''' | ||
-A|--adapter=<str> The iSCSI adapter name. (required) | -A|--adapter=<str> The iSCSI adapter name. (required) | ||
-D|--default Resetting iSCSI parameter setting to default. | -D|--default Resetting iSCSI parameter setting to default. | ||
| Line 200: | Line 199: | ||
* '''get''' | * '''get''' | ||
: Get iSCSI CHAP authentication on a target | : Get iSCSI CHAP authentication on a target | ||
:* <code>esxcli iscsi adapter target portal auth chap get ''' | :* <code>esxcli iscsi adapter target portal auth chap get '''OPTIONS'''</code> | ||
''' | '''OPTIONS''' | ||
-A|--adapter=<str> The iSCSI adapter name. (required) | -A|--adapter=<str> The iSCSI adapter name. (required) | ||
-a|--address=<str> The iSCSI target address: <ip/dns[:port]> (required) | -a|--address=<str> The iSCSI target address: <ip/dns[:port]> (required) | ||
| Line 210: | Line 209: | ||
* '''set''' | * '''set''' | ||
: Set the iSCSI CHAP authentication for the iSCSI Target. | : Set the iSCSI CHAP authentication for the iSCSI Target. | ||
:* <code>esxcli iscsi adapter target portal auth chap set ''' | :* <code>esxcli iscsi adapter target portal auth chap set '''OPTIONS'''</code> | ||
''' | '''OPTIONS''' | ||
-A|--adapter=<str> The iSCSI adapter name. (required) | -A|--adapter=<str> The iSCSI adapter name. (required) | ||
-a|--address=<str> The iSCSI target address: <ip/dns[:port]> (required) | -a|--address=<str> The iSCSI target address: <ip/dns[:port]> (required) | ||
| Line 231: | Line 230: | ||
* '''get''' | * '''get''' | ||
: Get iSCSI parameter on a target | : Get iSCSI parameter on a target | ||
:* <code>esxcli iscsi adapter target portal param get ''' | :* <code>esxcli iscsi adapter target portal param get '''OPTIONS'''</code> | ||
''' | '''OPTIONS''' | ||
-A|--adapter=<str> The iSCSI adapter name. (required) | -A|--adapter=<str> The iSCSI adapter name. (required) | ||
-a|--address=<str> The iSCSI target address: <ip/dns[:port]> (required) | -a|--address=<str> The iSCSI target address: <ip/dns[:port]> (required) | ||
| Line 239: | Line 238: | ||
* '''set''' | * '''set''' | ||
: Set the iSCSI parameter for the iSCSI Target. | : Set the iSCSI parameter for the iSCSI Target. | ||
:* <code>esxcli iscsi adapter target portal param set ''' | :* <code>esxcli iscsi adapter target portal param set '''OPTIONS'''</code> | ||
''' | '''OPTIONS''' | ||
-A|--adapter=<str> The iSCSI adapter name. (required) | -A|--adapter=<str> The iSCSI adapter name. (required) | ||
-a|--address=<str> The iSCSI target address: <ip/dns[:port]> (required) | -a|--address=<str> The iSCSI target address: <ip/dns[:port]> (required) | ||
| Line 268: | Line 267: | ||
* '''add''' | * '''add''' | ||
: Add a network portal for iSCSI adapter | : Add a network portal for iSCSI adapter | ||
:* <code>esxcli iscsi networkportal add ''' | :* <code>esxcli iscsi networkportal add '''OPTIONS'''</code> | ||
''' | '''OPTIONS''' | ||
-A|--adapter=<str> The iSCSI adapter name. (required) | -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 | -f|--force=<bool> The force flag (force add of iSCSI vmknic even it's not compatible for | ||
| Line 277: | Line 276: | ||
* '''remove''' | * '''remove''' | ||
: Remove a network portal for iSCSI adapter | : Remove a network portal for iSCSI adapter | ||
:* <code>esxcli iscsi networkportal remove ''' | :* <code>esxcli iscsi networkportal remove '''OPTIONS'''</code> | ||
''' | '''OPTIONS''' | ||
-A|--adapter=<str> The iSCSI adapter name. (required) | -A|--adapter=<str> The iSCSI adapter name. (required) | ||
-f|--force=<bool> The force flag (force removal of iSCSI vmknic when sessions are active | -f|--force=<bool> The force flag (force removal of iSCSI vmknic when sessions are active | ||
| Line 287: | Line 286: | ||
* '''get''' | * '''get''' | ||
: Get iSCSI network portal ipv4 configuration | : Get iSCSI network portal ipv4 configuration | ||
:* <code>esxcli iscsi networkportal ipconfig get ''' | :* <code>esxcli iscsi networkportal ipconfig get '''OPTIONS'''</code> | ||
''' | '''OPTIONS''' | ||
-A|--adapter=<str> The iSCSI adapter name. (required) | -A|--adapter=<str> The iSCSI adapter name. (required) | ||
-n|--nic=<str> The iSCSI network portal (vmknic) | -n|--nic=<str> The iSCSI network portal (vmknic) | ||
| Line 294: | Line 293: | ||
* '''set''' | * '''set''' | ||
: Set iSCSI network portal IPv4 configuration. | : Set iSCSI network portal IPv4 configuration. | ||
:* <code>esxcli iscsi networkportal ipconfig set ''' | :* <code>esxcli iscsi networkportal ipconfig set '''OPTIONS'''</code> | ||
''' | '''OPTIONS''' | ||
-A|--adapter=<str> The iSCSI adapter name. (required) | -A|--adapter=<str> The iSCSI adapter name. (required) | ||
-x|--dns1=<str> The iSCSI network portal primary DNS address | -x|--dns1=<str> The iSCSI network portal primary DNS address | ||
| Line 312: | Line 311: | ||
* '''get''' | * '''get''' | ||
: Get iSCSI network portal ipv6 configuration | : Get iSCSI network portal ipv6 configuration | ||
:* <code>esxcli iscsi networkportal ipv6config get ''' | :* <code>esxcli iscsi networkportal ipv6config get '''OPTIONS'''</code> | ||
''' | '''OPTIONS''' | ||
-A|--adapter=<str> The iSCSI adapter name. (required) | -A|--adapter=<str> The iSCSI adapter name. (required) | ||
* '''set''' | * '''set''' | ||
: Set iSCSI network portal IPv6 configuration. | : Set iSCSI network portal IPv6 configuration. | ||
:* <code>esxcli iscsi networkportal ipv6config set ''' | :* <code>esxcli iscsi networkportal ipv6config set '''OPTIONS'''</code> | ||
''' | '''OPTIONS''' | ||
-A|--adapter=<str> The iSCSI adapter name. (required) | -A|--adapter=<str> The iSCSI adapter name. (required) | ||
-e|--enable=<bool> Enable/Disable IPv6 | -e|--enable=<bool> Enable/Disable IPv6 | ||
| Line 333: | Line 332: | ||
* '''list''' | * '''list''' | ||
: List the IPv6 addresses assigned to the iSCSI network portal. | : List the IPv6 addresses assigned to the iSCSI network portal. | ||
:* <code>esxcli iscsi networkportal ipv6config address list ''' | :* <code>esxcli iscsi networkportal ipv6config address list '''OPTIONS'''</code> | ||
''' | '''OPTIONS''' | ||
-A|--adapter=<str> The iSCSI adapter name. (required) | -A|--adapter=<str> The iSCSI adapter name. (required) | ||
* '''add''' | * '''add''' | ||
: Add IPv6 addresses to the given iSCSI network portal. | : Add IPv6 addresses to the given iSCSI network portal. | ||
:* <code>esxcli iscsi networkportal ipv6config address add ''' | :* <code>esxcli iscsi networkportal ipv6config address add '''OPTIONS'''</code> | ||
''' | '''OPTIONS''' | ||
-A|--adapter=<str> The iSCSI adapter name. (required) | -A|--adapter=<str> The iSCSI adapter name. (required) | ||
-a|--address-list=[ <str> ... ] | -a|--address-list=[ <str> ... ] | ||
| Line 352: | Line 351: | ||
* '''remove''' | * '''remove''' | ||
: Remove IPv6 addresses from the given iSCSI network portal. | : Remove IPv6 addresses from the given iSCSI network portal. | ||
:* <code>esxcli iscsi networkportal ipv6config address remove ''' | :* <code>esxcli iscsi networkportal ipv6config address remove '''OPTIONS'''</code> | ||
''' | '''OPTIONS''' | ||
-A|--adapter=<str> The iSCSI adapter name. (required) | -A|--adapter=<str> The iSCSI adapter name. (required) | ||
-a|--address-list=[ <str> ... ] | -a|--address-list=[ <str> ... ] | ||
| Line 367: | Line 366: | ||
* '''get''' | * '''get''' | ||
: Get network parameters on a Physical Network Portal (vmnic) | : Get network parameters on a Physical Network Portal (vmnic) | ||
:* <code>esxcli iscsi physicalnetworkportal param get ''' | :* <code>esxcli iscsi physicalnetworkportal param get '''OPTIONS'''</code> | ||
''' | '''OPTIONS''' | ||
-A|--adapter=<str> The iSCSI adapter name. (required) | -A|--adapter=<str> The iSCSI adapter name. (required) | ||
-n|--nic=<str> The physical network portal name: <vmnic> | -n|--nic=<str> The physical network portal name: <vmnic> | ||
| Line 374: | Line 373: | ||
* '''set''' | * '''set''' | ||
: Set network parameter on a Physical Network Portal | : Set network parameter on a Physical Network Portal | ||
:* <code>esxcli iscsi physicalnetworkportal param set ''' | :* <code>esxcli iscsi physicalnetworkportal param set '''OPTIONS'''</code> | ||
''' | '''OPTIONS''' | ||
-A|--adapter=<str> The iSCSI adapter name. (required) | -A|--adapter=<str> The iSCSI adapter name. (required) | ||
-n|--nic=<str> The physical network portal name: <vmnic> | -n|--nic=<str> The physical network portal name: <vmnic> | ||
| Line 394: | Line 393: | ||
* '''add''' | * '''add''' | ||
: Login sessions on current iSCSI configuration. | : Login sessions on current iSCSI configuration. | ||
:* <code>esxcli iscsi session add ''' | :* <code>esxcli iscsi session add '''OPTIONS'''</code> | ||
''' | '''OPTIONS''' | ||
-A|--adapter=<str> The iSCSI adapter name. (required) | -A|--adapter=<str> The iSCSI adapter name. (required) | ||
-s|--isid=<str> The isid of a session to duplicate for login. | -s|--isid=<str> The isid of a session to duplicate for login. | ||
| Line 402: | Line 401: | ||
* '''remove''' | * '''remove''' | ||
: Logout sessions on current iSCSI configuration. | : Logout sessions on current iSCSI configuration. | ||
:* <code>esxcli iscsi session remove ''' | :* <code>esxcli iscsi session remove '''OPTIONS'''</code> | ||
''' | '''OPTIONS''' | ||
-A|--adapter=<str> The iSCSI adapter name. (required) | -A|--adapter=<str> The iSCSI adapter name. (required) | ||
-s|--isid=<str> The isid of a session to duplicate for login. | -s|--isid=<str> The isid of a session to duplicate for login. | ||
| Line 419: | Line 418: | ||
* '''set''' | * '''set''' | ||
: Enable or disable software iSCSI. | : Enable or disable software iSCSI. | ||
:* <code>esxcli iscsi software set ''' | :* <code>esxcli iscsi software set '''OPTIONS'''</code> | ||
''' | '''OPTIONS''' | ||
-e|--enabled=<bool> Enable or disable the module. (required) | -e|--enabled=<bool> Enable or disable the module. (required) | ||
-n|--name=<str> The iSCSI initiator name. | -n|--name=<str> The iSCSI initiator name. | ||
The initiator name must not be specified when disabling software iSCSI. | The initiator name must not be specified when disabling software iSCSI. | ||
Latest revision as of 20:06, 10 February 2022
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 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) 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 OPTIONS
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 OPTIONS
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 OPTIONS
- remove
- Remove a sendtarget address
esxcli iscsi adapter discovery sendtarget remove OPTIONS
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 OPTIONS
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 OPTIONS
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 OPTIONS
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 OPTIONS
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 OPTIONS
- remove
- Remove a static target
esxcli iscsi adapter discovery statictarget remove OPTIONS
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 OPTIONS
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 OPTIONS
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 OPTIONS
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 OPTIONS
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 OPTIONS
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 OPTIONS
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 OPTIONS
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 OPTIONS
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 OPTIONS
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 OPTIONS
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 OPTIONS
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)
ipconfig
- get
- Get iSCSI network portal ipv4 configuration
esxcli iscsi networkportal ipconfig get OPTIONS
OPTIONS -A|--adapter=<str> The iSCSI adapter name. (required) -n|--nic=<str> The iSCSI network portal (vmknic)
- set
- Set iSCSI network portal IPv4 configuration.
esxcli iscsi networkportal ipconfig set OPTIONS
OPTIONS
-A|--adapter=<str> The iSCSI adapter name. (required)
-x|--dns1=<str> The iSCSI network portal primary DNS address
-y|--dns2=<str> The iSCSI network portal secondary DNS address
-e|--enable=<bool> Enable/Disable IPv4. All other options will be ignored if IPv4 is being
disabled.
-d|--enable-dhcpv4=<bool>
Enable/Disable IPv4 configuration using DHCPv4. If DHCPv4 is being enabled,
static configuration parameters (ip,subnet,gateway,dns1,dns2) are ignored.
-g|--gateway=<str> The iSCSI network portal IPv4 gateway address
-i|--ip=<str> The iSCSI network portal IPv4 address
-n|--nic=<str> The iSCSI network portal (vmknic)
-s|--subnet=<str> The iSCSI network portal IPv4 subnet mask
ipv6config
- get
- Get iSCSI network portal ipv6 configuration
esxcli iscsi networkportal ipv6config get OPTIONS
OPTIONS -A|--adapter=<str> The iSCSI adapter name. (required)
- set
- Set iSCSI network portal IPv6 configuration.
esxcli iscsi networkportal ipv6config set OPTIONS
OPTIONS
-A|--adapter=<str> The iSCSI adapter name. (required)
-e|--enable=<bool> Enable/Disable IPv6
-d|--enable-dhcpv6=<bool>
Enable/Disable IPv6 configuration using DHCPv6
-l|--enable-linklocal-autoconfiguration=<bool>
Enable/Disable auto configuration of linklocal address
-r|--enable-router-advertisement=<bool>
Enable/Disable IPv6 configuration using Router Advertisement
-g|--gateway6=<str> The iSCSI network portal IPv6 gateway address
address
- list
- List the IPv6 addresses assigned to the iSCSI network portal.
esxcli iscsi networkportal ipv6config address list OPTIONS
OPTIONS -A|--adapter=<str> The iSCSI adapter name. (required)
- add
- Add IPv6 addresses to the given iSCSI network portal.
esxcli iscsi networkportal ipv6config address add OPTIONS
OPTIONS
-A|--adapter=<str> The iSCSI adapter name. (required)
-a|--address-list=[ <str> ... ]
An IPv6 address to add in X:X:X::/X format. Multiple addresses can be
provided using format -a address1 -a address2 -a address3.
-r|--remove-all-existing
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.
- remove
- Remove IPv6 addresses from the given iSCSI network portal.
esxcli iscsi networkportal ipv6config address remove OPTIONS
OPTIONS
-A|--adapter=<str> The iSCSI adapter name. (required)
-a|--address-list=[ <str> ... ]
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)
physicalnetworkportal
- list
- List Physical Network Portal for iSCSI Adapter
esxcli iscsi physicalnetworkportal list
param
- get
- Get network parameters on a Physical Network Portal (vmnic)
esxcli iscsi physicalnetworkportal param get OPTIONS
OPTIONS -A|--adapter=<str> The iSCSI adapter name. (required) -n|--nic=<str> The physical network portal name: <vmnic>
- set
- Set network parameter on a Physical Network Portal
esxcli iscsi physicalnetworkportal param set OPTIONS
OPTIONS
-A|--adapter=<str> The iSCSI adapter name. (required)
-n|--nic=<str> The physical network portal name: <vmnic>
-o|--option=<str> The network parameter option. Supported options are [MTU, ArpRedirect].
(required)
-v|--value=<long> Input value for a Physical Network Portal option (use 0/1 for bool, and
number for int) (required)
plugin
- list
- List IMA plugins.
esxcli iscsi plugin list
session
- list
- List iSCSI Sessions.
esxcli iscsi session list
- add
- Login sessions on current iSCSI configuration.
esxcli iscsi session add OPTIONS
OPTIONS -A|--adapter=<str> The iSCSI adapter name. (required) -s|--isid=<str> The isid of a session to duplicate for login. -n|--name=<str> The iSCSI target name.
- remove
- Logout sessions on current iSCSI configuration.
esxcli iscsi session remove OPTIONS
OPTIONS -A|--adapter=<str> The iSCSI adapter name. (required) -s|--isid=<str> The isid of a session to duplicate for login. -n|--name=<str> The name of the target to login to.
connection
- list
- List iSCSI connections.
esxcli iscsi session connection list
software
- get
- Software iSCSI information.
esxcli iscsi software get
- set
- Enable or disable software iSCSI.
esxcli iscsi software set OPTIONS
OPTIONS
-e|--enabled=<bool> Enable or disable the module. (required)
-n|--name=<str> The iSCSI initiator name.
The initiator name must not be specified when disabling software iSCSI.