Most of the commands in this appendix are reserved for Technical Support use and are included for your reference only. In a few cases, however, these commands provide the only means of performing a configuration task for the host. Also, if you lose your connection to the host, executing certain of these commands through the command-line interface may be your only recourse—for example, if networking becomes nonfunctional and vSphere Client access is therefore unavailable.

Note

If you use the commands in this appendix, you must execute the service mgmt-vmware restart command to restart the vmware-hostd process and alert the vSphere Client and other management tools that the configuration has changed. In general, avoid executing the commands in this appendix if the host is currently under the vSphere Client or vCenter Server management.

The vSphere Client graphical user interface provides the preferred means of performing the configuration tasks described in this topic. You can use this topic to learn which vSphere Client commands to use in place of these commands. This topic provides a summary of the actions you take in vSphere Client, but does not give complete instructions. For details on using commands and performing configuration tasks through vSphere Client, see the online help.

You can find additional information on a number of ESX commands by logging in to the service console and using the man <esxcfg_command_name> command to display man pages.

ESX Technical Support Commands lists the Technical Support commands provided for ESX, summarizes the purpose of each command, and provides a vSphere Client alternative. You can perform most of the vSphere Client actions listed in the table only after you have selected an ESX host from the inventory panel and clicked the Configuration tab. These actions are preliminary to any procedure discussed below unless otherwise stated.

ESX Technical Support Commands

Command

Command Purpose and vSphere Client Procedure

esxcfg-advcfg

Configures advanced options for ESX.

To configure advanced options in vSphere Client, click Advanced Settings. When the Advanced Settings dialog box opens, use the list on the left to select the device type or activity you want to work with and then enter the appropriate settings.

esxcfg-auth

Configures authentication. You can use this command to switch between the pam_cracklib.so and pam_passwdqc.so plug-ins for password change rule enforcement. You also use this command to reset options for these two plug-ins.

There are no means of configuring these functions in the vSphere Client.

esxcfg-boot

Configures bootstrap settings. This command is used for the bootstrap process and is intended for VMware Technical Support use only. You should not issue this command unless instructed to do so by a VMware Technical Support representative.

There is no means of configuring these functions in vSphere Client.

esxcfg-dumppart

Configures a diagnostic partition or searches for existing diagnostic partitions.

When you install ESX, a diagnostic partition is created to store debugging information in the event of a system fault. You don’t need to create this partition manually unless you determine that there is no diagnostic partition for the host.

You can perform the following management activities for diagnostic partitions in vSphere Client:

Determine whether there is a diagnostic partition — Click Storage>AddStorage and check the first page of the Add Storage Wizard to see whether it includes the Diagnostic option. If Diagnostic is not one of the options, ESX already has a diagnostic partition.

Configure a diagnostic partition — Click Storage>Add Storage>Diagnostic and step through the wizard.

esxcfg-firewall

Configures the service console firewall ports.

To configure firewall ports for supported services and agents in vSphere Client, you select the Internet services that will be allowed to access the ESX host. Click Security Profile>Firewall>Properties and use the Firewall Properties dialog box to add services.

You cannot configure unsupported services through the vSphere Client. For these services, use the esxcfg-firewall.

esxcfg-info

Prints information about the state of the service console, VMkernel, various subsystems in the virtual network, and storage resource hardware.

vSphere Client doesn’t provide a method for printing this information, but you can obtain much of it through different tabs and functions in the user interface. For example, you can check the status of your virtual machines by reviewing the information on the Virtual Machines tab.

esxcfg-init

Performs internal initialization routines. This command is used for the bootstrap process you should not use it under any circumstances. Using this command can cause problems for ESX.

There is no vSphere Client equivalent for this command.

esxcfg-module

Sets driver parameters and modifies which drivers are loaded during startup. This command is used for the bootstrap process and is intended for VMware Technical Support use only. You should not issue this command unless instructed to do so by a VMware Technical Support representative.

There is no vSphere Client equivalent for this command.

esxcfg-mpath

Configures multipath settings for your Fibre Channel or iSCSI disks.

To configure multipath settings for your storage in vSphere Client, click Storage. Select a datastore or mapped LUN and click Properties. When the Properties dialog box opens, select the desired extent if necessary. Then, click Extent Device>Manage Paths and use the Manage Path dialog box to configure the paths.

esxcfg-nas

Manages NFS mounts. You use this command to create or unmount an NFS datastore.

To view NFS datastores in vSphere Client, click Storage > Datastores and scroll through the datastores list. You can also perform the following activities from the Storage > Datastores view:

Display the attributes of an NFS datastore – Click the datastore and review the information under Details.

Create an NFS datastore – Click Add Storage.

Unmount an NFS datastore – Click Remove, or right-click the datastore to unmount and select Unmount.

esxcfg-nics

Prints a list of physical network adapters along with information on the driver, PCI device, and link state of each NIC. You can also use this command to control a physical network adapter’s speed and duplexing.

To view information on the physical network adapters for the host in vSphere Client, click Network Adapters.

To change the speed and duplexing for a physical network adapter in the vSphere Client, click Networking>Properties for any of the virtual switches associated with the physical network adapter. In the Properties dialog box, click Network Adapters>Edit and select the speed and duplex combination.

esxcfg-resgrp

Restores resource group settings and lets you perform basic resource group management.

Select a resource pool from the inventory panel and click Edit Settings on the Summary tab to change the resource group settings.

esxcfg-route

Sets or retrieves the default VMkernel gateway route and adds, removes, or lists static routes.

To view the default VMkernel gateway route in vSphere Client, click DNS and Routing. To change the default routing, click Properties and update the information in both tabs of the DNS and Routing Configuration dialog box.

esxcfg-swiscsi

Configures your software iSCSI software adapter.

To configure your software iSCSI system in vSphere Client, click Storage Adapters, select the iSCSI adapter you want to configure, and click Properties. Use the iSCSI Initiator Properties dialog box to configure the adapter.

esxcfg-upgrade

Upgrades from ESX Server 2.x to ESX. This command is not for general use.

You complete the following three tasks when upgrading from 2.x to 3.x. Some of these can be performed in vSphere Client:

Upgrade the host — You upgrade the binaries, converting from ESX Server 2.x to ESX. You cannot perform this step from vSphere Client.

Upgrade the file system — To upgrade VMFS-2 to VMFS-3, suspend or power off your virtual machines and then click Inventory>Host>Enter Maintenance Mode. Click Storage, select a storage device, and click Upgrade to VMFS-3. You must perform this step for each storage device you want to upgrade.

Upgrade the virtual machines — To upgrade a virtual machine from VMS-2 to VMS-3, right-click the virtual machine in the inventory panel and choose Upgrade Virtual Machine.

esxcfg-scsidevs

Prints a map of VMkernel storage devices to service console devices. There is no vSphere Client equivalent for this command.

esxcfg-vmknic

Creates and updates VMkernel TCP/IP settings for vMotion, NAS, and iSCSI.

To set up vMotion, NFS, or iSCSI network connections in vSphere Client, click Networking > Add Networking. Select VMkernel and step through the Add Network Wizard. Define the IP address subnet mask and VMkernel default gateway in the Connection Settings step.

To review your settings, click the blue icon to the left of the vMotion, iSCSI, or NFS port. To edit any of these settings, click Properties for the switch. Select the port from the list on the switch Properties dialog box and click Edit to open the port Properties dialog box and change the settings for the port.

esxcfg-vswif

Creates and updates service console network settings. This command is used if you cannot manage the ESX host through the vSphere Client because of network configuration issues.

To set up connections for the service console in vSphere Client, click Networking > Add Networking. Select Service Console and step through the Add Network Wizard. Define the IP address subnet mask and the service console default gateway in the Connection Settings step.

To review your settings, click the blue icon to the left of the service console port. To edit any of these settings, click Properties for the switch. Select the service console port from the list on the switch Properties dialog box. Click Edit to open the port Properties dialog box and change the settings for the port.

esxcfg-vswitch

Creates and updates virtual machine network settings.

To set up connections for a virtual machine in vSphere Client, click Networking > Add Networking. Select Virtual Machine and step through the Add Network Wizard.

To review your settings, click the speech bubble icon to the left of the virtual machine port group. To edit any of these settings, click Properties for the switch. Select the virtual machine port from the list on the switch Properties dialog box, then click Edit to open the port Properties dialog box and change the settings for the port.