VMware PowerCLI 12.4 Release Notes

VMware PowerCLI 12.4 Release Notes

This document contains the following information:

• About VMware PowerCLI
• What's New in This Release
• Resolved Issues
• Known Issues

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 12.4 User's Guide.

VMware PowerCLI Components

In VMware PowerCLI 12.4.1, 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.Storage: Provides cmdlets for managing vSphere policy-based storage.
• VMware.Vim: Provides vSphere low-level binding libraries. This module has no cmdlets.
• VMware.Sdk.VSphere.*: Provide functionality for the vSphere Automation SDK for PowerShell.
• VMware.PowerCLI.VCenter.*: Provide PowerShell-based cmdlets for automated administration of the vSphere environment.
• VMware.PowerCLI.Sdk.*: Provide help functionalities for the PowerShell-based cmdlets. These modules have no cmdlets but are required for other modules to function correctly.

In VMware PowerCLI 12.4.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.Vds: Provides cmdlets for managing vSphere distributed switches and distributed port groups.
• VMware.VimAutomation.Cis.Core: Provides cmdlets for managing vSphere Automation SDK servers.
• VMware.VimAutomation.Storage: Provides cmdlets for managing vSphere policy-based storage.
• VMware.VimAutomation.HorizonView: Provides cmdlets for automating VMware Horizon features.
• VMware.VimAutomation.Vmc: Provides cmdlets for managing VMware Cloud on AWS features.
• VMware.Vim: Provides vSphere low-level binding libraries. This module has no cmdlets.
• VMware.VimAutomation.Hcx: Provides cmdlets for managing VMware HCX features.
• VMware.VimAutomation.WorkloadManagement: Provides cmdlets for managing Project Pacific.
• VMware.CloudServices: Provides cmdlets for managing VMware Cloud Services.

In VMware PowerCLI 12.4.0, the following modules have been added:

• VMware.Sdk.VSphere.*: Provide functionality for the vSphere Automation SDK for PowerShell.
• VMware.PowerCLI.VCenter.*: Provide PowerShell-based cmdlets for automated administration of the vSphere environment.
• VMware.PowerCLI.Sdk.*: Provide help functionalities for the PowerShell-based cmdlets. These modules have no cmdlets but are required for other modules to function correctly.

Supported Platforms

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

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

What's New in This Release

New Features

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

• The VMware.Sdk.VSphere.* modules have been updated to support VMware vSphere 7.0 Update 3.
• The VMware.Vim module has been updated to support VMware vSphere 7.0 Update 3.
• The VMware.VimAutomation.Storage module has been updated to include the following improvements:
• The Get-VsanStat cmdlet has been extended to support more stats: vSAN cluster capacity and vSAN file share performance.
  
• The VMware.VimAutomation.Storage module has been updated to support VMware vSphere 7.0 Update 3.
  

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

• The VMware.Sdk.VSphere.* modules have been added to provide functionality for the vSphere Automation SDK for PowerShell, which enables you to manage the vSphere Automation API with VMware PowerCLI.
• A number of new cmdlets have been added to the VMware.PowerCLI.VCenter module.
  • New cmdlets to manage certificates on vCenter Server and ESXi.
    Get-VITrustedCertificate
Add-VITrustedCertificate
Remove-VITrustedCertificate
Get-VIMachineCertificate
Set-VIMachineCertificate
New-VIMachineCertificateSigningRequest
    
• The VMware.VimAutomation.Core module has been updated to include the following improvements:
• The Get-VMHostNetworkAdapter and Set-VMHostNetworkAdapter cmdlets have been extended to allow the enablement and disablement of the following services on a VMKernel port: provisioning, vSphere replication, vSphere replication NFC, and vSphere Backup NFC.
  
• The New-TagAssignment cmdlet has been extended to allow tagging content libraries and content library items.
  
• The Tag parameter has been added to the Get-TagAssignment cmdlet to allow filtering tag assignments by tag.
  
• The Copy-DatastoreItem cmdlet has been extended to support the copying of vmdk files to/from the vSAN datastore.
  
• The FriendlyName property has been added to the datastore folder object to display the friendly name of a vSAN datastore folder.
  
• The VMware.VimAutomation.Vmc module has been updated to include the following improvements:
• The Upsize parameter has been added to the Set-VmcSddc cmdlet to allow SDDC upsizing.
  
• The VMware.VimAutomation.Hcx module has been updated to include the following improvements:
• The BytesTransferred property of the HCXMobilityGroupMigration type has been added to reflect the amount of transferred data during migration. It replaces the UsedSize property, which has been deprecated.
  
• The VMware.VimAutomation.HorizonView module has been updated to support the API features of Horizon 8.3.

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

Resolved Issues

The following issues have been resolved in VMware PowerCLI 12.4.1:

• Get-VsanObject
  Get-VsanObject fails to execute when a linked clone VM is present in the vSAN datastore.

The following issues have been resolved in VMware PowerCLI 12.4.0:

• Get-TagAssignment
  Get-TagAssignment fails if you have assigned a tag on a VSS or VDS portgroup.
• Copy-VMGuestFile
  Copying a simlink file to the guest OS fails with a message of type Response status code does not indicate success: 500.
• New-VM
  New-VM occassionally fails when cloning a VM from NFS to VMFS6 datastore with a message of type The specified delta disk format 'redoLogFormat' is not supported.
• Get-SpbmReplicationGroup and Get-SpbmReplicationPair
  Get-SpbmReplicationGroup and Get-SpbmReplicationPair return data slower than expected.
• Start-HCXReplication
  Start-HCXReplication fails in a vCloud Director environment, when the TargetStorageProfile parameter is passed.
• Get-HCXMigration
  The TargetStorageProfile property of the returned object shows up as blank, even when you set it explicitly.
• Get-HCXMigration
  Get-HCXMigration throws an error when you pass the value Migrating for the State parameter.
• Other
  
  • When you disconnect from the server and connect again in the same PowerShell session, all cmdlets from the Workload Management module fail with a Server is not connected message.
  • When PowerCLI is installed on a computer with Turkish regional settings, some cmdlets don't work properly.

Known Issues

VMware PowerCLI 12.4.0 and 12.4.1 are 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 Administrator@VSPHERE.LOCAL.
• 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.
• 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: Use PowerShell 7 or use the vSphere Web Client to check the actual server-side error.
  • Certain methods in com.vmware.nsx.model.firewall_section enforce optional strings where they are not required.