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

 

Released 22 November 2022

VMware PowerCLI 13.0.0. Build 20829139

Check frequently for additions and updates to these release notes.

VMware PowerCLI 13.0.0 Release Notes

About VMware PowerCLI

VMware PowerCLI is a suite of PowerShell modules to manage VMware products and services. VMware PowerCLI includes over 7000 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 13.0.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.Cis.Core: Provides cmdlets for managing vSphere Automation SDK servers.
  • VMware.Vim: Provides vSphere low-level binding libraries. This module has no cmdlets.
  • 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.Storage: Provides cmdlets for managing vSphere policy-based storage.
  • VMware.VimAutomation.StorageUtility: Provides scripting cmdlet for updating Vmfs datastore.
  • VMware.VimAutomation.Hcx: Provides cmdlets for managing VMware HCX features.
  • VMware.ImageBuilder: Provides cmdlets for managing depots, image profiles, and VIBs.
  • VMware.DeployAutomation: Provides cmdlets that provide an interface to VMware Auto Deploy for provisioning physical hosts with ESXi software.
  • VMware.VimAutomation.Security: Provides cmdlets for managing vSphere Security, including virtual Trusted Platform Module.
  • VMware.VimAutomation.Cloud: Provides cmdlets for automating vCloud Director features.
  • VMware.VimAutomation.Nsxt: Provides cmdlets for managing NSX-T servers.
  • VMware.Sdk.Nsx.Policy: Provides auto-generated cmdlets for accessing the NSX Policy API.
  • VMware.Sdk.vSphere.*: Provides auto-generated cmdlets for accessing the vSphere Automation (REST) API.

Supported Platforms

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

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

What's New in This Release

New Features

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

  • The VMware.ImageBuilder and VMware.DeployAutomation modules have been ported to work on macOS and Linux.
  • The VMware.ImageBuilder module now requires Python 3.7 and the six, psutil, lxml, and pyopenssl Python packages as a prerequisite.
  • The VMware.VimAutomation.Cloud module has been updated to include the following improvements:
    • A new parameter set has been added to the New-CIVM cmdlet to allow the creation of an empty VM in a vApp.
    • The StorageProfile parameter has been added to the New-OrgVdc cmdlet to enable the creation of an organization virtual datacenter with a specified storage profile.
    • The Get/New/Set/Remove-OrgNetwork cmdlets have been removed. Use Get/New/Set/Remove-OrgVdcNetwork instead.
    • The VMHardwareVersion property has been added to the CIVM object to replace the VMVersion property which has been deprecated.
    • The HighestSupportedHardwareVersionString property has been added to the ProviderVdc object to replace the HighestSupportedHardwareVersion property which has been deprecated.
    • The VMware.VimAutomation.Cloud module has been updated to support the API features of VMware Cloud Director 10.4.
  • The VMware.VimAutomation.Core module has been updated to include the following improvements:
    • The PytonPath parameter has been added to the Set-PowerCLIConfiguration cmdlet to allow specifying the path to the Python version required by the VMware.ImageBuilder module.
    • The CustomizationScript parameter has been added to the New/Set-OsCustomizationSpec cmdlet to allow specifying a customization script to be executed during OS customization.
    • The Ipv6Prefix, Ipv6Address, Ipv6Mode, Ipv6VcApplicationArgument, Ipv6Gateway, and Ipv6AlternateGateway parameters have been added to the New/Set-OsCustomizationNicMapping cmdlets to allow specifying Ipv6 customization parameters.
    • The VsanEsaEnabled parameter has been added to the New-Cluster and Set-Cluster cmdlets to enable support for vSAN ESA enabled clusters.
  • A number of new cmdlets have been added to the VMware.VimAutomation.Storage module.
    • New cmdlets to enable vSAN ESA cluster disk management support.
      Get-VsanEsaEligibleDisk
      Add-VsanStoragePoolDisk
      Get-VsanStoragePoolDisk
      Remove-VsanStoragePoolDisk
  • The VMware.VimAutomation.Storage module has been updated to include the following improvements:
    • The VsanEsaEnabled parameter has been added to the Get-VsanClusterConfiguration cmdlet to check if a cluster is vSAN ESA enabled.
    • The Get/New/Set-SpbmStoragePolicy cmdlets have been updated to support consumption domain (availability zone) storage policy.
    • The VMware.VimAutomation.Storage module has been updated to support the API features of vSAN 8.0.
  • A new cmdlet has been added to the VMware.VimAutomation.Security module.
    • New cmdlet to retrieve Trusted Platform Module (TPM) devices from a specified host.
      Get-VMHostTPM
  • The VMware.VimAutomation.Security module has been updated to include the following improvements:
    • The VMHostTPM parameter has been added to the Get-Tpm2EndorsementKey cmdlet to allow getting TPM 2.0 endorsement key information.
  • The VMware.VimAutomation.Hcx module has been updated to include the following improvements:
    • The EnableSeedCheckpoint parameter has been added to the New-HCXMigration cmdlet to enable a seed checkpoint for Bulk migration.
    • The MigrateCustomAttributes parameter has been added to the New-HCXMigration and New-HCXMobilityGroupConfiguration cmdlets to enable migration of custom attributes.
  • The VMware.Sdk.Nsx.Policy module now accepts JSON and PowerShell objects as input for its client-side parameters (usually built with Initialize-* cmdlets).
  • The VMware.Vim and VMware.Sdk.vSphere.* modules have been updated to support the API features of VMware vSphere 8.0.
  • The VMware.VimAutomation.HorizonView module has been updated to support the API features of VMware Horizon 8 2209.
  • The Get-NsxtPolicyService, Get-NsxtGlobalManagerService, and Get-VmcSddcNetworkService cmdlets have been deprecated. Use the cmdlets from the VMware.Sdk.Nsx.Policy module instead.

For more information on changes made in VMware PowerCLI 13.0.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 13.0.0 Home Page.

Resolved Issues

The following issues have been resolved in VMware PowerCLI 13.0.0:

  • Get-NetworkPool
    Get-NetworkPool does not return NSX-backed network pools.
  • Connect-CIServer
    Get-NetworkPool fails when trying to connect to VMware Cloud Director 10.4 with a message of type NOT_ACCEPTABLE: The request has invalid accept header: Invalid API version requested.
  • New-VM
    • New-VM fails when trying to create a VM with a user with limited permissions to CryptoManager even if encryption is not requested.
    • The customization script in the VM customization spec is not applied when cloning a Linux VM by using PowerCLI.
  • Get-Tag
    Get-Tag fails when executed in a remote session with a message of type Failed to create RSA key: The requested operation cannot be completed. The computer must be trusted for delegation and the current user account must be configured to allow delegation.
  • Test-HCXMigration
    Test-HCXMigration throws an INVALID_REQUEST error when there are any errors or warnings in the migration request.
  • Test-HCXMobilityGroup
    Test-HCXMobilityGroup throws an INVALID_REQUEST error when there are any errors or warnings in the mobility group request.

Known Issues

VMware PowerCLI 13.0.0 is known to have the following issues:

  • 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].
  • 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-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.
  • 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