Using ESXi Shell in ESXi 6.x, 7.x and 8.x
search cancel

Using ESXi Shell in ESXi 6.x, 7.x and 8.x

book

Article ID: 311213

calendar_today

Updated On:

Products

VMware vSphere ESXi

Issue/Introduction

This article provides guidance on the recommended use of ESXi Shell for VMware ESXi 6.x, 7.x and 8.x.


Environment

VMware vSphere ESXi 5.5
VMware vSphere ESXi 8.0.x
VMware vSphere ESXi 6.5
VMware vSphere ESXi 7.0.0
VMware vSphere ESXi 6.0
VMware vSphere ESXi 6.7
VMware vSphere ESXi 7.x

Resolution


The ESXi Shell (formerly known as Tech Support Mode) provides essential maintenance commands. It can be used in exceptional cases that cannot be handled through standard remote management or CLI tools. The ESXi Shell is primarily intended for use in break-fix scenarios.

Enabling ESXi Shell access using the vSphere Client

Use the vSphere Client to enable local and remote access to the ESXi Shell:
  1. Log in to a vCenter Server system using the vSphere Client.
  2. Select the host in the Inventory panel.
  3. Click the Configuration tab and click Security Profile.
  4. In the Services section, click Properties.
  5. Select ESXi Shell from this list:

    ESXi Shell
    SSH
    Direct Console UI

     
  6. Click Options and select Start and stop manually.

    Note: When you select Start and stop manually, the service does not start when you reboot the host. If you want the service to start when you reboot the host, select Start and stop with host.
     
  7. Click Start to enable the service.
  8. Click OK.

Enabling ESXi Shell access using the Host Client in vSphere 6.x, 7.x and 8.x.

Use the Host Client to enable local and remote access to the ESXi Shell:
  1. Log in to a Host Client using IP address of the host in a browser
  2. Click on Manage under Navigator section
  3. Click the Services tab
  4. In the Services section, select TSM from the list:
  5. Click Actions and select Start to enable the ESXi shell.

Enabling ESXi Shell access using the Direct Console User Interface

Use the direct console user interface to enable the ESXi Shell:
  1. From the Direct Console User Interface, press F2 to access the System Customization menu.
  2. Select Troubleshooting Options and press Enter.
  3. From the Troubleshooting Mode Options menu, select Enable ESXi Shell.

    Enable ESXi Shell
    Enable SSH

     
  4. Press Enter to enable the service.

Configuring the timeout for the ESXi Shell

By default, the timeout setting for the ESXi Shell is 0 (disabled). The timeout setting is the number of minutes that can elapse before you must log in after the ESXi Shell is enabled. After the timeout period, if you have not logged in, the shell is disabled.

Note: If you are logged in when the timeout period elapses, your session persists. However, the ESXi Shell is disabled and it prevents other users from logging in.
  • To set the ESXi Shell timeout from the Direct Console User Interface:
     
    1. From the Direct Console User Interface, press F2 to access the System Customization menu.
    2. Click Troubleshooting Mode Options.
    3. Modify ESXi Shell and SSH timeouts and press Enter.
    4. Enter the timeout in minutes.
    5. Press Enter.
    6. Press Esc until you return to the main menu of the Direct Console User Interface.
       
  • To set the ESXi Shell timeout from vSphere Client:
     
    1. Log in to a vCenter Server system using the vSphere Client.
    2. Select the host in the Inventory panel and click Configuration tab.
    3. Under Software, click Advanced Settings.
    4. In the left panel, click UserVars.
    5. In the UserVars.ESXiShellTimeOut field, enter the timeout setting in seconds.
    6. Click OK.

Note: If ESXi Shell and SSH are enabled, the option to modify the timeout value is grayed out. To change the timeout value, ensure both ESXi Shell and SSH are disabled. This is by design and is intended to indicate when the timeout values would take effect.

Accessing the local ESXi Shell

  1. If you have direct access to the host, press Alt+F1 to open the log in page on the machine's physical console.
  2. Provide credentials when prompted.

    Note: To return to the Direct Console User Interface press Alt-F2.

Accessing the remote ESXi Shell

  1. Open an SSH client.
  2. Specify the IP address or domain name of the ESXi host.

    Notes:
    • Steps may vary depending on the SSH client you are using. For more information, consult the client documentation and support.
    • By default, SSH works on TCP port 22.
       
  3. Provide credentials when prompted.


Additional Information

For more information, see:
Cluster warning for ESXi Shell and SSH appear on an ESXi 5.x host
ESXi 5.x および 6.x での ESXi Shell の使い方
Como usar o ESXi Shell no ESXi 5.0
Usar ESXi Shell en ESXi 5.x
ESXi 5.1 にアップグレード後に、SSH を使用して ESXi 5.1 ホストに接続できなくなる
在 ESXi 5.x 和 6.0 中使用 ESXi Shell
ホストプロファイルの作成が次のエラーで失敗する:Call HostProfileManager.CreateProfile for object HostProfileManager on vCenter Value specified is out of range.Range:1 to maxValue
VMkernel ログに次のようなログが複数出力される:vmnicxx:qlcnic_free_rx_irq:2008:Freed vmnicxx_rx[1] irq
ネットワークの瞬断が発生すると、仮想マシンから NFS 上の ISO イメージへの接続が切れる
Active Directory ドメインのアカウントを使用して ESXi ホストにログインすることができない
vDGA で構成された Windows ゲスト OS で障害が発生して青色の診断画面が表示された後に、VMware ESXi 5.5.x ホストで障害が発生して紫色の診断画面が表示される
ESXi ホストの [サマリ] タブで次のエラーが表示される: 「vmkcore ディスク パーティションが存在しません」
NFS データストアのアンマウントが次のエラーで失敗する: Sysinfo set operation VSI_MODULE_NODE_mnt_umount failed with error status Busy
VMware vSAN 6.2 on disk upgrade fails due to CBT enabled virtual disks
Verwenden der ESXi Shell in ESXi 5.x und 6.0
Enabling root SSH login on an ESX host