Configuring advanced options for ESXi
search cancel

Configuring advanced options for ESXi

book

Article ID: 310338

calendar_today

Updated On:

Products

VMware vSphere ESXi

Issue/Introduction

VMware ESXi  provides advanced configuration options that affect the behavior of various components. This article provides steps to review and set new advanced configuration options using several methods. VMware recommends that you set these configuration options under the direction of VMware Technical Support or a VMware Knowledge Base article.

Numeric options have limited ranges (for example, 0-10). String options accept any value. Option values are not checked for validity beyond being in the proper range. Confirm all changes before applying them.

Caution: Some configuration options take effect immediately, whereas others require a reboot before taking effect. The impact of changing specific options is outside the scope of this article.

 

Environment

VMware vSphere ESXi 6.0
VMware vSphere ESXi 7.0
VMware vSphere ESXi 8.0

Resolution

Advanced configuration settings can be reviewed and modified on an ESXi host using the vSphere Web Client, vSphere Client, PowerCLI, Command-Line Interface, or local console.

All options are grouped into sections. A given method may visually group the sections or separate the section and option names using a forward slash or period. Options are usually documented using the form SectionName.OptionName. 

Setting advanced configuration options using the vSphere Client for ESXi 6.x, 7.x and 8.x

The vSphere Client lists configuration options grouped by sections on the left. The options list is not sorted.

To set advanced configuration options using the vSphere Client:

  1. Connect to the vCenter Server or the ESXi host using the vSphere Client.
  2. Select the ESXi host in the Inventory.
  3. Click the Configuration tab.
  4. Under the Software heading, click Advanced Settings.
  5. Select the section on the left corresponding the option's section name.
  6. Locate the option name in the list on the right, these names are usually similar to SectionName.OptionName.
  7. Specify a new value for setting.
  8. Click OK to accept the changes.

    Note: If an out-of-range value is specified, the vSphere Client reports the error: The value entered is not valid. Enter another value.

Setting advanced configuration options using the vSphere PowerCLI

The VMware vSphere PowerCLI is a powerful command-line tool used to automate aspects of vSphere management. PowerCLI is distributed as a Windows PowerShell snapin. Commands can be run directly against an ESXi host, or target any ESXi/ESX host that vCenter Server manages. Section and option names are separated by a period.

For more information on usage, see the vSphere PowerCLI documentation

To set advanced configuration options using the vSphere PowerCLI:

  1. Open a command prompt at the location where vSphere PowerCLI is installed.
  2. Connect to the ESXi host using the command:

    Connect-VIServer ESXHostnameOrIP
     
  3. Check the current value of an option using the Get-VMHostAdvancedConfiguration command:

    Get-VMHostAdvancedConfiguration -Name "SectionName.OptionName"

    For example:

    Name Value
    ---- -----
    SectionName.OptionName CurrentValue
     
  4. Specify a new value for an option using the Set-VMHostAdvancedConfiguration command:

    Set-VMHostAdvancedConfiguration -Name "SectionName.OptionName" -Value "NewValue"

    Note: If an out-of-range value is specified, the command fails with the fault: A specified parameter was not correct.

Setting advanced configuration options using esxcli for ESXi 6.x, 7.x and 8.x

The VMware vSphere ESX Command-Line Interface (esxcli) is use to run common system administration commands against ESXi hosts from any client with network access to those systems, or from the local ESXi host console. To set advanced configuration options using esxcli:

  1. Open a console at the location where esxcli is installed. For more information, see the VMware vSphere Command Line Interface documentation.
  2. Check the current value of an option using the esxcli command:
     
    • For runtime options:

      esxcli system settings advanced list -o "/SectionName/OptionName"
       
    • For boot-time options in the VMkernel.boot.* namespace:

      esxcli system settings kernel list -o "OptionName"
       
    You see output similar to:

    Path: /SectionName/OptionName
    Type: integer
    Int Value: n
    Default Int Value: 5
    Min Value: 0
    Max Value: 10
    String Value:
    Default String Value:
    Valid Characters:
    Description: Description of OptionName
     
  3. Specify a new value for an option using the esxcli command:
     
    • For runtime options:

      esxcli system settings advanced set -o "/SectionName/OptionName" [--int-value|--string-value] "NewValue"
       
    • For boot-time options in the VMkernel.boot.* namespace:

      esxcli system settings kernel set -o "OptionName" [--int-value|--string-value] "NewValue"

      Note: If an out-of-range value is specified, the command fails with the fault: Sysinfo error on operation returned status : Bad parameter.
Note: In vSphere 5.5, you must reboot the host for the VMkernel.boot configuration changes to take effect.

Setting advanced configuration options using the vSphere Command-Line Interface in ESXi 6.x, 7.x and 8.x

The VMware vSphere Command-Line Interface (vCLI) is used to run common system administration commands against ESXi hosts from any client with network access to those systems. Commands can be run directly against an ESXi host, or target any ESXi host that vCenter Server manages. Section and option names are separated by a period.

For more information on usage, see the vSphere Command-Line Interface Documentation.

To set advanced configuration options using the vCLI:

  1. Open a command prompt at the location where the vCLI is installed.
  2. Check the current value of an option using the vicfg-advcfg.pl command:
     
    • For runtime options:

      vicfg-advcfg.pl <connection options> --get SectionName.OptionName
       
    • For boot-time options in the VMkernel.boot.* namespace:

      vicfg-advcfg.pl <connection options> --get-kernel OptionName
       
    You see output similar to:

    Value of SectionName.OptionName is X
     
  3. Set a new value for an option using the vicfg-advcfg.pl command:
     
    • For runtime options:

      vicfg-advcfg.pl <connection options> --set "NewValue" SectionName.OptionName
       
    • For boot-time options in the VMkernel.boot.* namespace:

      vicfg-advcfg.pl <connection options> --set-kernel "NewValue" OptionName
       
    Note: If an out-of-range value is specified, the command fails with the fault: A specified parameter was not correct.

Setting advanced configuration options using the local console in ESXi 6.x, 7.x and 8.x

The local console of the ESXi host can be used to run common system administration commands if network connectivity is not available. The other methods are preferred. Section and option names are separated by a forward slash.

To set advanced configuration options using the local console:

  1. Open a console to the ESXi .
  2. Check the current value of an option using the esxcfg-advcfg command:
     
    • For runtime options:

      esxcfg-advcfg --get /SectionName/OptionName
       
    • For boot-time options in the VMkernel.boot.* namespace:

      esxcfg-advcfg --get-kernel OptionName

    For example:

    Value of SectionName.OptionName is X
     
  3. Set a new value for an option using the esxcfg-advcfg command:
     
    • For runtime options:

      esxcfg-advcfg --set "NewValue" /SectionName/OptionName
       
    • For boot-time options in the VMkernel.boot.* namespace:

      esxcfg-advcfg --set-kernel "NewValue" OptionName

    Note: If an out-of-range value is specified, the command fails with the error: A specified parameter was not correct.



Additional Information



Powered by Wolken Software