VMware PowerCLI Change Log

This document lists all changes introduced in the following VMware PowerCLI releases:

VMware PowerCLI 13.2.1

Released 27 Nov 2023 | Documentation

Change type

Description

modification

Id properties and Id parameters has been changed from guid to string.For the vSphere Replication and Site Recovery Manager SDK cmdlets, the type of the object

bug fix

vSphere Replication and Site Recovery Manager SDK cmdlets

On some vCenter Server systems, cmdlets from the VMware.Sdk.Vr and VMware.Sdk.Srm modules fail because the Guid property is provided in upper-case letters.

VMware PowerCLI 13.2.0

Released 8 Nov 2023 | Documentation

Change type

Description

feature

The VMware.Sdk.Vcf.CloudBuilder and VMware.Sdk.Vcf.SddcManager modules have been added to provide functionality for managing the VMware Cloud Foundation REST API with VMware PowerCLI.

feature

New cmdlet to export the desired state of a vSphere Lifecycle Manager host has been added to the VMware.VimAutomation.Core module:

  • Export-LcmVMHostDesiredState

feature

New cmdlet to retrieve a list of the most impactful vSAN performance contributors has been added to the VMware.VimAutomation.Storage module.

  • Get-VsanPerformanceContributor

feature

New cmdlet to create a vLCM-compliant offline bundle based on input depots and a software specification has been added to the VMware.ImageBuilder module.

  • New-OfflineBundle

modification

The New-VmcSddc and New-VmcSddcCluster cmdlets have been extended to support a new host type - I4I.

modification

The Get-VsanSpaceUsage cmdlet has been modified to include an EsaOjectOverhead value in the returned object.

modification

The VMware.Vim and VMware.Sdk.vSphere.* modules have been updated to support the API features of VMware vSphere 8.0 Update 2.

modification

The VMware.VimAutomation.Storage module has been updated to support the API features of VMware vSAN 8.0 Update 2.

modification

The VMware.Sdk.Srm module has been updated to support the API features of VMware Site Recovery Manager 8.8.

modification

The VMware.Sdk.Vr module has been updated to support the API features of vSphere Replication 8.8.

modification

The VMware.Sdk.Nsx.Policy module has been updated to support the API features of NSX 4.1.2.

modification

The VMware.VimAutomation.HorizonView module has been updated to support the API features of VMware Horizon 8 2306

bug fix

Tagging and content library cmdlets

Certain cmdlets that use tagging or content library functionality (Get-TagAssignments, Get-SpbmStoragePolicy, and so on) stop working and the vCenter has to be rebooted.

bug fix

Remove-AlarmAction

Remove-AlarmAction does not remove all triggers for SNMP actions.

bug fix

Set-VMHostNetworkAdapter

When you run Set-VMHostNetworkAdapter -AutomaticIPv6 $false, a statically configured IPv6 address is also removed.

bug fix

Connect-VIServer

Reconnecting to an ESXi host after reboot with Connect-VIServer in the same PowerShell session fails with an error message of type Object reference not set to an instance of an object.

bug fix

Get-vSANStat

Get-vSANStat fails with an error message stating that a vSAN ESA feature is not available.

bug fix

All ImageBuilder Cmdlets

If you have installed on your machine the public distribution of pyVmomi through pip, all VMware.ImageBuilder cmdlets do not work.

bug fix

New-IsoImage, New-PxeImage, and Export-EsxImageProfile

An image generated through the VMware.ImageBuilder module when using Python version 3.8 or later fails to boot even if no issues were encountered during image creation.

bug fix

Remove-EsxSoftwarePackage

Remove-EsxSoftwarePackage doesn't throw a warning when removing an invalid software package from the image profile.

VMware PowerCLI 13.1.0

Released 19 Apr 2023 | Documentation

Change type

Description

feature

The VMware.Sdk.Vr module has been added to provide functionality for managing the VMware vSphere Replication REST API with VMware PowerCLI.

feature

The VMware.Sdk.Srm module has been added to provide functionality for managing the VMware Site Recovery Manager REST API with VMware PowerCLI.

feature

New cmdlets to manage Lifecycle Manager offline depots have been added to the VMware.VimAutomation.Core module.

  • Get-LcmOfflineDepot

  • New-LcmOfflineDepot

feature

New cmdlets for vCenter Server remote datastore management have been added to the VMware.VimAutomation.Storage module:

  • New-VsanHCIMeshDatastoreSource

  • Get-VsanHCIMeshDatastoreSource

  • Remove-VsanHCIMeshDatastoreSource

  • Get-VsanHCIMeshDatastore

feature

New cmdlets for vSAN direct disk management have been added to the VMware.VimAutomation.Storage module:

  • New-VsanDirectDisk

  • Get-VsanDirectDisk

  • Remove-VsanDirectDisk

feature

New cmdlets for vSAN cluster shutdown have been added to the VMware.VimAutomation.Storage module:

  • Get-VsanClusterPowerState

  • Start-VsanCluster

  • Stop-VsanCluster

feature

New cmdlet to start objects relayout has been added to the VMware.VimAutomation.Storage module:

Start-VsanRelayoutObjects

feature

New cmdlet to enable the mounting of remote vSAN datastores from vSAN stretched clusters has been added to the VMware.VimAutomation.Storage module:

New-RemoteVsanServerClusterConfig

modification

The MountXVCDatastoreUnmountXVCDatastore, and RemoteVsanClusterServerConfig parameters have been added to the Set-VsanClusterConfiguration cmdlet to support vCenter Server remote datastore management.

modification

The Perspective parameter has been added to the Test-VsanClusterHealth cmdlet to support the precheck for vSAN cluster shutdowns.

modification

The Connect-CIServer cmdlet has been modified for authentication through the new VMware Cloud Director API endpoint.

modification

The Import-CIVappTemplate cmdlet interface has been changed when importing from an OVF file: the Catalog parameter is now mandatory and the OrgVdc parameter has been removed.

modification

The SourcePath parameter of the Import-CIVappTemplate cmdlet is now mandatory when resuming import from an OVF file.

modification

A new URL parameter has been added to the Import-CIVappTemplate cmdlet to enable importing of vApp templates from an URL. 

modification

The BaseImageVendorAddOnComponentFirmwareAddon, and DepotOverride parameters have been added to the Set-VMHost cmdlet to enable vSphere Lifecycle Manager host image configuration.

modification

The FirmwareAddon property has been added to the cluster object to record the hardware support packages associated with the cluster.

modification

The performance of the Get-Stat cmdlet has been improved for the instances when you use the Start parameter. 

modification

A LastAttestedTime field has been added to the TrustAuthorityVMhostBaseImage object to represent the last attested time for Bluehost.

modification

The Export-VMHostImageDb cmdlet has been modified to warn you about an ESXi Quick Boot and download a boot_imgdb.tgz file instead of an image.tgz file.

modification

The VMware.ImageBuilder module has been updated to work with Python version 3.7.1 or later.

modification

The VMware.Vim and VMware.Sdk.vSphere.* modules have been updated to support the API features of VMware vSphere 8.0 Update 1.

modification

The VMware.Sdk.Nsx.Policy module has been updated to support the API features of NSX 4.1.0.

modification

The VMware.VimAutomation.HorizonView module has been updated to support the API features of VMware Horizon 8 2212.

bug fix

New-VM

New-VM cannot create a Windows 2019 virtual machine when the ESXi server default compatibility level is set to a version that does not support Windows 2019.

bug fix

Export-VDSwitch

In PowerShell 5.1, Export-VDSwitch generates a .ZIP file that cannot be imported through the vSphere Client.

bug fix

Get-VIPermission

Get-VIPermission fails with a message of type The given key ... was not present in the dictionary.

bug fix

Copy-VMGuestFile

Copy-VMGuestFile fails if the VM's guest OS information is not fully populated.

bug fix

Export-VDPortGroup

Portgroups exported by using Export-VDPortGroup cannot be restored with Set-VDPortGroup.

bug fix

Import-CIVappTemplate

Importing a vApp Template from a local OVF file with Import-CIVappTemplate does not work.

bug fix

Get-CNSVolume

Get-CNSVolume does not work when there is a mismatch between volume and vDisk.

bug fix

New-SpbmStoragePolicy

New-SpbmStoragePolicy fails with a message of type The parameter CommonRule should contain only VAIOfilter rules.

bug fix

Import-TrustAuthorityServiceInfo

Import-TrustAuthorityServiceInfo fails when a vSphere Trust Authority host is removed.

bug fix

Get-Tag and Get-TagAssignment

On vCenter Server version 8.0 and later, the Name parameter is case-sensitive.

bug fix

ImageBuilder cmdlets

  • On MacOS, ImageBuilder cmdlets fail with a message of type ModuleNotFoundError: No module named 'vmware.esximage'.

  • On MacOS, if Homebrew and Python are not run and installed through a Rosetta terminal, ImageBuilder cmdlets fail with a message related to importing the VibSign module.

VMware PowerCLI 13.0.0

Released 22 Nov 2022 | Documentation

Change type

Description

feature

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 sixpsutillxml, and pyopenssl Python packages as a prerequisite).

feature

New cmdlets have been added to the VMware.VimAutomation.Storage module to enable vSAN ESA cluster disk management support:

  • Get-VsanEsaEligibleDisk

  • Add-VsanStoragePoolDisk

  • Get-VsanStoragePoolDisk

  • Remove-VsanStoragePoolDisk

feature

New cmdlet has been added to the VMware.VimAutomation.Security module to retrieve Trusted Platform Module (TPM) devices from a specified host:

Get-VMHostTPM

modification

The VMware.VimAutomation.Cloud module has been updated to support the API features of VMware Cloud Director 10.4.

modification

A new parameter set has been added to the New-CIVM cmdlet to allow the creation of an empty VM in a vApp.

modification

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.

modification

The VMHardwareVersion property has been added to the CIVM object to replace the VMVersion property which has been deprecated.

modification

The HighestSupportedHardwareVersionString property has been added to the ProviderVdc object to replace the HighestSupportedHardwareVersion property which has been deprecated.

modification

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.

modification

The CustomizationScript parameter has been added to the New/Set-OsCustomizationSpec cmdlet to allow specifying a customization script to be executed during OS customization.

modification

The Ipv6PrefixIpv6AddressIpv6ModeIpv6VcApplicationArgumentIpv6Gateway, and Ipv6AlternateGateway parameters have been added to the New/Set-OsCustomizationNicMapping cmdlets to allow specifying Ipv6 customization parameters.

modification

The VsanEsaEnabled parameter has been added to the New-Cluster and Set-Cluster cmdlets to enable support for vSAN ESA enabled clusters.

modification

The VMHostTPM parameter has been added to the Get-Tpm2EndorsementKey cmdlet to allow getting TPM 2.0 endorsement key information.

modification

The VsanEsaEnabled parameter has been added to the Get-VsanClusterConfiguration cmdlet to check if a cluster is vSAN ESA enabled.

modification

The Get/New/Set-SpbmStoragePolicy cmdlets have been updated to support consumption domain (availability zone) storage policy.

modification

The VMware.VimAutomation.Storage module has been updated to support the API features of vSAN 8.0.

modification

The VMHostTPM parameter has been added to the Get-Tpm2EndorsementKey cmdlet to allow getting TPM 2.0 endorsement key information.

modification

The EnableSeedCheckpoint parameter has been added to the New-HCXMigration cmdlet to enable a seed checkpoint for Bulk migration.

modification

The MigrateCustomAttributes parameter has been added to the New-HCXMigration and New-HCXMobilityGroupConfiguration cmdlets to enable migration of custom attributes.

modification

The VMware.Sdk.Nsx.Policy module now accepts JSON and PowerShell objects as input for its client-side parameters (usually built with Initialize-* cmdlets).

modification

The VMware.Vim and VMware.Sdk.vSphere.* modules have been updated to support the API features of VMware vSphere 8.0.

modification

The VMware.VimAutomation.HorizonView module has been updated to support the API features of VMware Horizon 8 2209.

deprecation

The Get-NsxtPolicyServiceGet-NsxtGlobalManagerService, and Get-VmcSddcNetworkService cmdlets have been deprecated. Use the cmdlets from the VMware.Sdk.Nsx.Policy module instead.

deprecation

The Get/New/Set/Remove-OrgNetwork cmdlets have been removed. Use Get/New/Set/Remove-OrgVdcNetwork instead.

bug fix

Get-NetworkPool

Get-NetworkPool does not return NSX-backed network pools.

bug fix

Connect-CIServer

Connect-CIServer 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.

bug fix

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.

bug fix

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.

bug fix

Test-HCXMigration

Test-HCXMigration throws an INVALID_REQUEST error when there are any errors or warnings in the migration request.

bug fix

Test-HCXMobilityGroup

Test-HCXMobilityGroup throws an INVALID_REQUEST error when there are any errors or warnings in the mobility group

check-circle-line exclamation-circle-line close-line
Scroll to top icon