VMware PowerCLI | 25 JUL 2024 VMware PowerCLI 13.3 Build 24145081 Check for additions and updates to these 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.3, the following modules have been updated:

• VMware.VimAutomation.Storage

• VMware.VimAutomation.Core

• VMware.ImageBuilder

• VMware.DeployAutomation

• VMware.VimAutomation.Hcx

• VMware.Sdk.Vcf.SddcManager

Supported Platforms

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

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

What's New in This Release

New Features

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

• The VMware.ImageBuilder module is updated with support for Python version 3.12 and OpenSSL 3.0.

• The VMware.ImageBuilder and VMware.DeployAutomation modules are updated with an option to deactivate host seeding when exporting and deploying an image for the hosts in a cluster managed with a vSphere Lifecycle Manager image.

• The VMware.VimAutomation.Storage module is updated to support the vSAN APIs for vSphere 8.0 Update 3.

• The VMware.VimAutomation.Core module is updated to support alarm threshold customization.

• The VMware.VimAutomation.Core module is updated to support recording the privilege checks that occur for specified sessions during the execution of a specified script block

• The VMware.VimAutomation.Core module is updated to support removing components from the base image for a cluster or standalone host managed with a single image.

• The VMware.VimAutomation.Core module is updated to support managing OAuth 2.0 client registrations within the VMware Identity Broker service.

• The VMware.VimAutomation.Hcx module is updated to support Guest OS customization.

• The VMware.Sdk.Vcf.SddcManager module is updated to enable waiting for generic asynchronous VMware Cloud Foundation operations and for specific VMware Cloud Foundation validation operations.

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

Product Support Notices

• Deprecation of the Connect-AutoDeployServer cmdlet

  Starting with VMware PowerCLI 13.3, Connect-AutoDeployServer cmdlet is deprecated and will be removed is a future release. To connect to your vCenter Server instances and use the cmdlets from the VMware.DeployAutomation PowerCLI module, you must start using the Connect-VIServer cmdlet.

• Dropping support for OpenSSL 1.1 for the VMware.ImageBuilder module

  Staring with VMware PowerCLI 13.3, support for OpenSSL 1.1 is dropped due to the announced End Of Life (EOL) for the OpenSSL 1.1 on 11th September 2023.

Resolved Issues

The following issues have been resolved in VMware PowerCLI 13.3:

• Get-VsanStat

  Running the Get-VsanStat cmdlet without any filters fails in certain cases.

• Set-VsanClusterConfiguration

  When you try to deactivate ESA (Express Storage Architecture) on a vSAN cluster, the operation fails.

• Set-VsanClusterConfiguration

  When you try to enable vSAN max on a vSAN cluster created with activated ESA (Express Storage Architecture), the operation fails.

• Get-DepotInfo

  Get-DepotInfo returns the Vendor name and Vendor code as unknown.

• Get-HCXMigration

  Running the Get-HCXMigration cmdlet with the -MigrationType option fails.

• New-AdvancedSetting

  Running the New-AdvancedSetting cmdlet to create float values for an advanced setting, results in passing a wrong format to the vCenter Server system.

• Invoke-*

  Invoke-* commands in the SDK modules do not serialize default values, even when the values have been set explicitly.

• Invoke-ListServiceEntries

  Running the Invoke-ListServiceEntries cmdlet, does not return any information regarding Service Entries for the specific service.

• Invoke-SrmGet* and Invoke-VrGet*

  When you try to retrieve an SRM/VR object by ID for an object that no longer exists, the operation results in bad error output.

• Invoke-Srm* and Invoke-Vr*

  The VMware.Sdk.Srm and VMware.Sdk.Vr modules does not work with vCenter Server instances that have UUIDs containing upper case letters.

• New-OAuthSecurityContext and New-VcsOAuthSecurityContext

  Running the New-OAuthSecurityContext and New-VcsOAuthSecurityContext cmdlets on PowerShell Core fails for the browser-based authentication workflow.

• Get-WMNamespacePermission, Set-WMNamespacePermission, Remove-WMNamespacePermission, and New-WMNamespacePermission

  Running any of the listed cmdlets fails due to issues with the deserialization of the WMNamespacePermission attribute.

• Undesired version of the VMware.Powercli module is installed

  Attempts to install a lower than the latest version of the VMware.PowerCLI module with the Install-Module cmdlet instead completes with the installation of the latest released version of the module.

• VMware.ImageBuilder module

  The VMware.ImageBuilder PowerCLI module cannot be used with Python version 3.12 due to a bug within the zipfile system module. The bug interferes with reading compressed files which makes ISO generation impossible. The bug has been resolved in the 3.12.1 release so customers planning to upgrade to Python 3.12 should choose the latest option in order to generate ISO images successfully.

Known Issues

VMware PowerCLI 13.3 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].

• Get-Tag and Get-TagAssignment

  On vCenter Server version 6.5 and 7.0, the Name parameter is case-sensitive.

  Workaround: Use wildcard characters in your parameter value. For example, use Get-Tag -Name "[T]agName".

• New-HCXServiceMesh

  When you run New-HCXServiceMesh, the Service Mesh object accepts destination as an input at the organization virtual data center level, but the Service Mesh object is created at an organization level.

• Test-HCXMigration

  Test-HCXMigration throws an exception instead of a warning. This might mislead you that running Start-HCXMigration is not possible.

• ImageBuilder cmdlets

  If PowerCLI is configured to use Python 3.7.0 or 3.12.0, ImageBuilder cmdlets fail with a message that advises to upgrade to a later Python version.

  Workaround:

  Configure PowerCLI to use a later Python version. For example, if you use Python 3.12.0, you can either upgrade to version 3.12.1 or you can alternatively use Python 3.11.9.

• Other

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

  • On MacOS, downloading the PowerCLI ZIP file through Chrome fails with an error message of type "VibSign.so" cannot be opened because the developer cannot be verified.

    Workaround: Use Safari or the Mac Terminal to download the PowerCLI ZIP file.