All Cmdlets by Product VMware vSphere and vSAN VMHost

Install-VMHostPatch

This cmdlet updates the specified hosts. The cmdlet installs patches on the host. The patches that can be located locally, on a Web location, or in a host file system. When using the LocalPath or WebPath parameters, the ESX/ESXi host attempts to store the patch contents in its local temporary directory. Because ESXi hosts might not have enough free space on their local drives, this cannot apply to large size patches. The best practice for upgrading an ESXi host is to upload the patch contents on the host's datastore and to run Install-VMHostPatch with the HostPath parameter. If you want to install patches packaged in a ZIP archive, you must extract them and use one of the HostPatch, LocalPath, or WebPath parameters. If you use the HostPath parameter, you must extract each patch to a temporary folder that is named after the patch ID (for example, c:emp\ESX400-200906001\), and copy the folder in the root folder of a datastore. Note that the datastore path is case-sensitive. If you use the LocalPath parameter, you must extract each patch to a folder. The name of the folder must contain the patch ID (for example, "ESX400-200906001"). If you use the WebPath parameter, you must extract each patch to a folder that is published on a Web server. The patch URL address must contain the patch ID (for example, http://myInternalWebServer/esx40/ESX400-200906001/). Depending on the component to be upgraded, you might have to set the host into a maintenance mode and to restart the host or the hostd management service after applying the patch.

Syntax

Install-VMHostPatch
-HostPath  <String[]>
-VMHost  <VMHost[]>
[-RunAsync]
[-Server  <VIServer[]>]
[CommonParameters]

Parameters

Required Parameter Name Type Position Features Description
required
HostPath
String[] named Specifies a file path on the ESX/ESXi host to the patches you want to install.
required
VMHost
VMHost[] named
  • wildcards
  • pipeline
    •      		Specifies the hosts you want to update.
    optional
    RunAsync
    		SwitchParameter named Indicates that the command returns immediately without waiting for the task to complete. In this mode, the output of the cmdlet is a Task object. For more information about the RunAsync parameter run "help About_RunAsync" in the VMware PowerCLI console.
    optional
    Server
    		VIServer[] named
  • wildcards
    •      		Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is provided or $null value is passed to this parameter, the command runs on the default servers. For more information about default servers, see the description of Connect-VIServer.

    Install-VMHostPatch
    -LocalPath  <String[]>
    -VMHost  <VMHost[]>
    [-HostCredential  <PSCredential>]
    [-HostPassword  <SecureString>]
    [-HostUsername  <String>]
    [-RunAsync]
    [-Server  <VIServer[]>]
    [CommonParameters]

    Parameters

    Required Parameter Name Type Position Features Description
    required
    LocalPath
    		String[] named Specifies the local file system path to the patches you want to install. Providing credentials when installing a patch from a local path is mandatory.
    required
    VMHost
    		VMHost[] named
  • wildcards
  • pipeline
    •      		Specifies the hosts you want to update.
    optional
    HostCredential
    		PSCredential named Specifies a PSCredential object that contains credentials for authenticating with the host.
    optional
    HostPassword
    		SecureString named Specifies the password you want to use to authenticate with the host.
    optional
    HostUsername
    		String named Specifies the username you want to use to authenticate with the host.
    optional
    RunAsync
    		SwitchParameter named Indicates that the command returns immediately without waiting for the task to complete. In this mode, the output of the cmdlet is a Task object. For more information about the RunAsync parameter run "help About_RunAsync" in the VMware PowerCLI console.
    optional
    Server
    		VIServer[] named
  • wildcards
    •      		Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is provided or $null value is passed to this parameter, the command runs on the default servers. For more information about default servers, see the description of Connect-VIServer.

    Install-VMHostPatch
    -VMHost  <VMHost[]>
    -WebPath  <String[]>
    [-RunAsync]
    [-Server  <VIServer[]>]
    [CommonParameters]

    Parameters

    Required Parameter Name Type Position Features Description
    required
    VMHost
    		VMHost[] named
  • wildcards
  • pipeline
    •      		Specifies the hosts you want to update.
    required
    WebPath
    		String[] named Specifies the Web location of the patches you want to install.
    optional
    RunAsync
    		SwitchParameter named Indicates that the command returns immediately without waiting for the task to complete. In this mode, the output of the cmdlet is a Task object. For more information about the RunAsync parameter run "help About_RunAsync" in the VMware PowerCLI console.
    optional
    Server
    		VIServer[] named
  • wildcards
    •      		Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is provided or $null value is passed to this parameter, the command runs on the default servers. For more information about default servers, see the description of Connect-VIServer.

    Output

    VMware.VimAutomation.ViCore.Types.V1.Host.VMHostPatchResult

    Examples

    Example 1

    Install-VMHostPatch -VMHost $vmhost1,$vmhost2 -LocalPath c:\esx40\patches\ESX400-200906001\metadata.zip -HostUsername admin -HostPassword pass

    Updates ESX servers using a local file. Before running the cmdlet, you must download the patch file locally and extract to a folder. The name of the folder must contain the patch ID (for example, "ESX400-200906001"). Providing credentials when installing a patch from a local path is mandatory.

    Example 2

    $vmhost | Install-VMHostPatch -WebPath http://myInternalWebServer/esx40/ESX400-200906001/metadata.zip

    Upgrades an ESX server using a Web location. Before running the cmdlet, you must download the patch file and extract it to a folder that is published on a Web server. The patch URL address must contain the patch ID (for example, http://myInternalWebServer/esx40/ESX400-200906001/).

    Example 3

    $datastore = Get-Datastore -Name Datastore
    Copy-DatastoreItem c:\temp\ESX400-200906001\
    $datastore.DatastoreBrowserPath -Recurse
    $vmhost1,$vmhost2 | Install-VMHostPatch -HostPath
    /vmfs/volumes/datastore/ESX400-200906001/metadata.zip

    Upgrades ESX servers using the -HostPath parameter. First, you must download the patch file and extract its contents to a temporary folder that is named after the patch ID (for example, c:\temp\ESX400-200906001\). Copy the folder in the root folder of the Datastore datastore and run Install-VMHostPatch providing the datastore path to the patch. Note that the datastore path is case-sensitive.

    Related Commands

    VMHost

    Get-VMHost
    This cmdlet retrieves the hosts on a vCenter Server system.
    Add-VMHost
    This cmdlet adds a host to be managed by a vCenter Server system.
    Move-VMHost
    This cmdlet moves hosts to another location.
    Restart-VMHost
    This cmdlet restarts the specified hosts.
    Set-VMHost
    This cmdlet modifies the configuration of the host.
    Start-VMHost
    This cmdlet starts the specified hosts.
    Stop-VMHost
    This cmdlet powers off the specified hosts.
    Suspend-VMHost
    This cmdlet suspends hosts.
    Remove-VMHost
    This cmdlet removes the specified hosts from the inventory.

    VMHostAccount

    Get-VMHostAccount
    This cmdlet retrieves the host accounts available on a vCenter Server system.
    Set-VMHostAccount
    This cmdlet configures a host account.
    Remove-VMHostAccount
    This cmdlet removes the specified host accounts.
    New-VMHostAccount
    This cmdlet creates a new host user or group account.

    VMHostAdvancedConfiguration

    Get-VMHostAdvancedConfiguration
    This cmdlet retrieves the advanced configuration of the hosts.
    Set-VMHostAdvancedConfiguration
    This cmdlet modifies the advanced configuration settings of a host.

    VMHostAuthentication

    Get-VMHostAuthentication
    This cmdlet retrieves authentication information for the specified hosts.
    Set-VMHostAuthentication
    This cmdlet modifies the host authentication information.

    VMHostAvailableTimeZone

    Get-VMHostAvailableTimeZone
    This cmdlet retrieves the time zones available on the specified host.

    VMHostDiagnosticPartition

    Get-VMHostDiagnosticPartition
    This cmdlet retrieves a list of the diagnostic partitions on the specified hosts.
    Set-VMHostDiagnosticPartition
    This cmdlet activates or deactivates the diagnostic partitions of hosts.

    VMHostDisk

    Get-VMHostDisk
    This cmdlet retrieves information about the specified SCSI LUN disk.

    VMHostDiskPartition

    Get-VMHostDiskPartition
    This cmdlet retrieves the partitions of a host disk (LUN).
    Format-VMHostDiskPartition
    This cmdlet formats a new VMFS (Virtual Machine File System) on each of the specified host disk partitions.

    VMHostFirewallDefaultPolicy

    Get-VMHostFirewallDefaultPolicy
    This cmdlet retrieves the firewall default policy of the specified hosts.
    Set-VMHostFirewallDefaultPolicy
    This cmdlet sets the default policy for the specified host firewall.

    VMHostFirewallException

    Get-VMHostFirewallException
    This cmdlet retrieves the exceptions from the firewall policy on the specified hosts.
    Set-VMHostFirewallException
    This cmdlet activates or deactivates host firewall exceptions.

    VMHostFirmware

    Get-VMHostFirmware
    This cmdlet retrieves hosts firmware information.
    Set-VMHostFirmware
    This cmdlet configures hosts firmware settings.

    VMHostHardware

    Get-VMHostHardware
    This cmdlet retrieves ESXi host hardware and firmware information.

    VMHostHba

    Get-VMHostHba
    This cmdlet retrieves information about the available HBAs (Host Bus Adapter).
    Set-VMHostHba
    This cmdlet configures the CHAP properties of the specified iSCSI HBAs.

    VMHostModule

    Get-VMHostModule
    This cmdlet retrieves the option strings of the specified host modules.
    Set-VMHostModule
    This cmdlet overrides the host module options with the given ones.

    VMHostNetwork

    Get-VMHostNetwork
    THis cmdlet retrieves the host networks on a vCenter Server system.
    Set-VMHostNetwork
    This cmdlet updates the specified virtual network.

    VMHostNetworkAdapter

    Get-VMHostNetworkAdapter
    This cmdlet retrieves the host network adapters on a vCenter Server system.
    Set-VMHostNetworkAdapter
    This cmdlet configures the specified host network adapter.
    Remove-VMHostNetworkAdapter
    This cmdlet removes the specified host network adapters.
    New-VMHostNetworkAdapter
    This cmdlet creates a new HostVirtualNIC (Service Console or VMKernel) on the specified host.

    VMHostNetworkStack

    Get-VMHostNetworkStack
    This cmdlet retrieves the host network stacks on a vCenter Server system.
    Set-VMHostNetworkStack
    This cmdlet modifies the specified host network stack.

    VMHostNtpServer

    Get-VMHostNtpServer
    This cmdlet retrieves the NTP servers on the specified hosts.
    Add-VMHostNtpServer
    This cmdlet adds the specified NTP servers to the NTP server list of the specified hosts.
    Remove-VMHostNtpServer
    This cmdlet removes the specified NTP servers from the NTP server list of the specified hosts.

    VMHostPatch

    Get-VMHostPatch
    This cmdlet retrieves information about the host patches installed on the specified hosts. This cmdlet is deprecated and will not return any results for ESX hosts version 5.0 and later. Use (Get-ESXCli).software.vib.list() as an alternative.
    Install-VMHostPatch
    This cmdlet updates the specified hosts.

    VMHostPciDevice

    Get-VMHostPciDevice
    This cmdlet retrieves the PCI devices on the specified hosts.

    VMHostProfile

    Get-VMHostProfile
    This cmdlet retrieves the available host profiles.
    Export-VMHostProfile
    This cmdlet exports the specified host profile to a file.
    Import-VMHostProfile
    This cmdlet imports a host profile from a file. The file path must be accessible from the VMware PowerCLI client side.
    Invoke-VMHostProfile
    This cmdlet applies a host profile to the specified host or cluster.
    Set-VMHostProfile
    This cmdlet modifies the specified host profile.
    Remove-VMHostProfile
    This cmdlet removes the specified host profiles.
    New-VMHostProfile
    This cmdlet creates a new host profile based on a reference host.

    VMHostProfileCompliance

    Test-VMHostProfileCompliance
    This cmdlet tests hosts for profile compliance.

    VMHostProfileImageCacheConfiguration

    Get-VMHostProfileImageCacheConfiguration
    Retrieves an image cache configuration for the given host profile.
    Set-VMHostProfileImageCacheConfiguration
    This cmdlet modifies image cache configuration for given host profile.

    VMHostProfileRequiredInput

    Get-VMHostProfileRequiredInput
    This cmdlet performs a check whether the available information is sufficient to apply a host profile.

    VMHostProfileStorageDeviceConfiguration

    Get-VMHostProfileStorageDeviceConfiguration
    Retrieves the storage device configuration for the given host profile.
    Set-VMHostProfileStorageDeviceConfiguration
    This cmdlet modifies the storage device configuration for the given host profile.

    VMHostProfileUserConfiguration

    Get-VMHostProfileUserConfiguration
    This cmdlet retrieves the user password configuration for the given host profile.
    Set-VMHostProfileUserConfiguration
    This cmdlet modifies the user password configuration for the specified account within a host profile.

    VMHostProfileVmPortGroupConfiguration

    Get-VMHostProfileVmPortGroupConfiguration
    Retrieves the virtual machine port group configuration for the given host profile.
    Set-VMHostProfileVmPortGroupConfiguration
    This cmdlet modifies the virtual machine port group configuration for the given host profile.
    Remove-VMHostProfileVmPortGroupConfiguration
    Removes the given virtual machine port group configuration from the host profile.
    New-VMHostProfileVmPortGroupConfiguration
    This cmdlet creates a new virtual machine port group configuration.

    VMHostRoute

    Get-VMHostRoute
    This cmdlet retrieves the routes from the routing table of the specified hosts.
    Set-VMHostRoute
    This cmdlet modifies a route in the host routing table.
    Remove-VMHostRoute
    This cmdlet removes host routes.
    New-VMHostRoute
    This cmdlet creates a new route in the routing table of a host.

    VMHostService

    Get-VMHostService
    This cmdlet retrieves information about a host service.
    Restart-VMHostService
    This cmdlet restarts the specified host services.
    Set-VMHostService
    This cmdlet modifies a host service.
    Start-VMHostService
    This cmdlet starts the specified host services.
    Stop-VMHostService
    This cmdlet stops the specified host services.

    VMHostSnmp

    Get-VMHostSnmp
    This cmdlet retrieves hosts SNMP configuration.
    Set-VMHostSnmp
    This cmdlet modifies the host SNMP configuration.
    Test-VMHostSnmp
    This cmdlet tests the host SNMP.

    VMHostStartPolicy

    Get-VMHostStartPolicy
    This cmdlet retrieves the start policy of hosts.
    Set-VMHostStartPolicy
    This cmdlet modifies the host default start policy.

    VMHostStorage

    Get-VMHostStorage
    This cmdlet retrieves the host storages on a vCenter Server system.
    Set-VMHostStorage
    This cmdlet configures a host storage.

    VMHostSysLogServer

    Get-VMHostSysLogServer
    This cmdlet displays the remote syslog servers of the specified hosts.
    Set-VMHostSysLogServer
    This cmdlet configures the remote syslog server of the specified hosts.
    Feedback

    Was this page helpful?

    ©2023 VMware Inc. Terms of Use Privacy Your California Privacy Rights Accessibility Trademarks Glossary Help Contact Us