This site will be decommissioned on December 31st 2024. After that date content will be available at techdocs.broadcom.com.

Released 14 July 2022

Updated 06 October 2022

VMware PowerCLI 12.7.0. Build 20091289

Check frequently for additions and updates to these release notes.

VMware PowerCLI 12.7.0 Release Notes

About VMware PowerCLI

VMware PowerCLI is a suite of PowerShell modules to manage VMware products and services. VMware PowerCLI includes over 800 cmdlets to easily manage your infrastructure on a global scale.

Installation, Upgrade, and Removal of VMware PowerCLI

Management of the PowerCLI modules is provided by the PowerShell Gallery and by using the PowerShell default cmdlets for working with modules in the PowerShell Gallery. For detailed information on how to install, upgrade, or remove PowerCLI, refer to the VMware PowerCLI User's Guide.

VMware PowerCLI Components

In VMware PowerCLI 12.7.0, the following modules have been updated:

  • VMware.PowerCLI: Provides a root module which other modules are dependent on. This ensures the PowerCLI product can be installed, upgraded, and removed as a complete package if needed.
  • VMware.VimAutomation.Core: Provides cmdlets for automated administration of the vSphere environment.
  • VMware.VimAutomation.Common: Provides functionality that is common to all PowerCLI modules. This module has no cmdlets, but is required for other modules to function correctly.
  • VMware.VimAutomation.Sdk: Provides SDK functionality that is needed by all PowerCLI modules. This module has no cmdlets, but is required for other modules to function correctly.
  • VMware.VimAutomation.Vmc: Provides cmdlets for managing VMware Cloud on AWS features.
  • VMware.VimAutomation.Vds: Provides cmdlets for managing vSphere distributed switches and distributed port groups.
  • VMware.VimAutomation.HorizonView: Provides cmdlets for automating VMware Horizon features.
  • VMware.VimAutomation.Srm: Provides cmdlets for managing VMware Site Recovery Manager features.
  • VMware.VimAutomation.Storage: Provides cmdlets for managing vSphere policy-based storage.
  • VMware.VimAutomation.Hcx: Provides cmdlets for managing VMware HCX features.
  • VMware.Sdk.Nsx.Policy: Provides auto-generated cmdlets for accessing the NSX Policy API.

Supported Platforms

For a list of VMware PowerCLI 12.7.0 supported operating systems and PowerShell versions, see Compatibility Matrixes for VMware PowerCLI 12.7.0.

For a list of VMware products with which VMware PowerCLI 12.7.0 is compatible, see VMware Product Interoperability Matrixes.

What's New in This Release

New Features

VMware PowerCLI 12.7.0 introduces the following new features, changes, and improvements:

  • The VMware.VumAutomation module has been ported to work on macOS and Linux.
  • The VMware.Sdk.Nsx.Policy module has been updated to include the following improvements:
    • The UseRemoteAuthentication parameter has been added to the Connect-NsxServer cmdlet to enable remote authentication.
    • The Get-NsxOperation cmdlet has been modified to return only exact matches of the Path parameter and to accept target paths in various formats.
    • The VMware.Sdk.Nsx.Policy module has been updated with the latest NSX Policy API features.
  • A new cmdlet has been added to the VMware.VimAutomation.Storage module.
    • New cmdlet to specify a vSAN health check threshold.
      New-VsanHealthCheckThreshold
  • The VMware.VimAutomation.Storage module has been updated to include the following improvements:
    • The CapacityThreshold parameter has been added to the Set-VsanClusterConfiguration cmdlet to enable the setting of a vSAN health check threshold.
    • The CapacityThreshold property has been added to the VsanClusterConfiguration object to indicate a vSAN health check threshold.
  • The VMware.VimAutomation.HorizonView module has been updated to support the API features of Horizon 8.4.

For more information on changes made in VMware PowerCLI 12.7.0, including improvements, security enhancements, and deprecated features, see the VMware PowerCLI Change Log. For more information on specific product features, see the VMware PowerCLI User's Guide. For more information on specific cmdlets, see the VMware PowerCLI Cmdlet Reference. For the full list of PowerCLI documentation, visit the VMware PowerCLI 12.7.0 Home Page.

Resolved Issues

The following issues have been resolved in VMware PowerCLI 12.7.0:

  • Get-ApplianceBackupJob
    The behavior of the parameters StartDate and EndDate is swapped.
  • Connect-SrmServer
    • Connect-SrmServer fails on PowerShell 7.2.2 and later.
    • Connect-SrmServer performance on Linux is slow.
  • Export-VDSwitch and Export-VDPortGroup
    Export-VDSwitch and Export-VDPortGroup fail with an error message of type Could not load file or assembly ICSharpCode.SharpZipLib or one of its dependencies. The system cannot find the file specified.
  • Get-VsanClusterConfiguration
    Get-VsanClusterConfiguration does not return the full vSAN cluster configuration when remote datastores are mounted in a vSAN HCI Mesh architecture.
  • Set-VsanClusterConfiguration
    Set-VsanClusterConfiguration fails if there is a disk group present when configuring shared witness node.
  • New-HCXMigration
    New-HCXMigration requires target data center as a mandatory value for PCLI OSAM migrations.
  • Get-HCXVM
    There is a delay in getting response from Get-HCXVM.
  • Multiple VMC cmdlets
    Multiple VMC cmdlets use CisServer instead of VmcServer as input for the Server parameter.

Known Issues

VMware PowerCLI 12.7.0 is known to have the following issues:

  • Add-EsxSoftwareDepot
    On ESXi 8.0, Add-EsxSoftwareDepot fails with an error message of type System.TypeInitializationException,VMware.ImageBuilder.Commands.AddDepot.
    Workaround: None. The issue will be fixed with the next PowerCLI version.
  • Get-HCXMigration
    Тhe Username parameter of the Get-HCXMigration cmdlet is case-sensitive.
    Workaround: Use the username format supported by API. For example, use [email protected].
  • Import-Module
    If you try to import VMware.PowerCLI module on PowerShell Core, you receive an error message and the import process fails.
    Workaround: Import each module separately.
  • New-HCXServiceMesh
    When you run New-HCXServiceMesh, the Service Mesh object accepts destination as an input at the organization virtual datacenter level, but the Service Mesh object is created at an organization level.
  • Set-VsanClusterConfiguration
    When you run Set-VsanClusterConfiguration on vSAN 6.5 or vSAN 6.6, the AddSilentHealthCheck and RemoveSilentHealthCheck parameters do not update any values.
    Workaround: Update to vSAN 6.7.
  • Set-WMCluster
    The default value of the DefaultImageRegistryHostPort parameter is 443, but this is not implemented.
    Workaround: Always define the DefaultImageRegistryHostPort parameter when the DefaultImageRegistryHostname parameter is specified.
  • Test-HCXMigration
    Test-HCXMigration throws an exception instead of a warning. This might mislead you that running Start-HCXMigration is not possible.
  • Get-CustomCertificates, Add-CustomCertificate and Remove-CustomCertificates
    Get-CustomCertificates, Add-CustomCertificate, and Remove-CustomCertificates fail with a message of type Unsupported version URI.
  • Other
    • For Windows PowerShell 5.1, when you run a cmdlet and the operation fails on the server side, you might receive a There is an error in the XML document. error message. This is not a valid server error and it is returned when PowerShell is unable to read the actual server-side error.
      Workaround: Update to PowerShell 7 or use the vSphere Web Client to check the actual server-side error.
check-circle-line exclamation-circle-line close-line
Scroll to top icon