VMware vSphere PowerCLI 5.1 Release 1 Release Notes
Released 10 September 2012
Build 793510 is VMware vSphere PowerCLI 5.1 Release 1
About VMware vSphere PowerCLI
VMware vSphere PowerCLI is a command-line and scripting tool built on Windows PowerShell, and provides more than 360 cmdlets for managing and automating vSphere and vCloud.
VMware vSphere PowerCLI Components and Versioning
VMware vSphere PowerCLI 5.1 Release 1 consists of two components:
- vSphere PowerCLI 5.1 is the core component of the PowerCLI package. It contains four snapins with cmdlets for managing vSphere 5.1 features:
VMware.VimAutomation.Core: VMware vSphere PowerCLI 5.1 provides cmdlets for automated administration of the vSphere environment.
VMware.VimAutomation.License: VMware License PowerCLI 5.1 provides the
Get-LicenseDataManager cmdlet for managing VMware License components.
VMware.ImageBuilder: VMware ImageBuilder PowerCLI 5.1 provides cmdlets for managing depots, image profiles, and VIBs.
VMware.DeployAutomation: VMware Auto Deploy PowerCLI 5.1 provides cmdlets that provide an interface to VMware Auto Deploy for provisioning physical hosts with ESXi software.
vCloud Director PowerCLI 1.5 is an optional component that you can install during the PowerCLI installation. It provides the VMware vCloud Director PowerCLI 1.5 snapin (
VMware.VimAutomation.Cloud) with cmdlets for automating the vCloud Director 1.5.1 features.
To use VMware vSphere PowerCLI, you need to have installed the following software:
- Windows PowerShell 2.0
- A supported version of .NET Framework
- .NET Framework 2.0 with Service Pack 2
- .NET Framework 3.0 or .NET Framework 3.0 with Service Pack 1, or Service Pack 2
- .NET Framework 3.5 or .NET Framework 3.5 with Service Pack 1
VMware vSphere PowerCLI 5.1 Release 1 works on the following operating systems:
- Windows 7 Service Pack 1 (32-bit and 64-bit)
- Windows Server 2008 R2 Service Pack 1
- Windows Server 2008 Service Pack 1 (32-bit)
- Windows XP Service Pack 3 (32-bit)
- Windows XP Service Pack 2 (32-bit and 64-bit)
- Windows Server 2003 R2 (32-bit and 64-bit)
The following PowerCLI features are supported only on the 32-bit version of Windows PowerShell.
Set-VM (only when used for applying customization specifications)
When running against vCenter Server or ESX/ESXi versions earlier than 5.0, the following PowerCLI features are supported only on the 32-bit version of Windows PowerShell.
Set-HardDisk (only when used for resizing guest disk partitions)
VMware vSphere PowerCLI 5.1 Release 1 supports the following VMware environments:
- vCenter Server 5.1
- VMware ESXi 5.1
- vCenter Server 5.0 Update 1
- VMware ESXi 5.0 Update 1
- vCenter Server 4.1 Update 2
- VMware ESXi 4.1 Update 2
- vCenter Server 4.0 Update 4
- VMware ESX 4.0 Update 4
- VMware ESX 4.0i Update 4
vCloud Director PowerCLI 1.5 is compatible with VMware vCloud Director 1.5.1.
What's New in This Release?
This release of vSphere PowerCLI introduces a number of new capabilities.
- The vCloud Director PowerCLI snapin provides extended administration and management options.
- You can create, modify, manage, and remove organizations.
- You can create and manage permissions.
- You can assign computing and networking resources.
- You can create, modify, and remove organization networks.
- You can create, modify, and remove vApp networks.
- You can create, modify, manage, and remove vApps.
- You can manage virtual machines and their guest operating systems within vApps.
- The vSphere PowerCLI snapin introduces a number of improvements and new features.
- You can use Kerberos for pass-through authentication with vCenter Server, ESX/ESXi, and vCenter Virtual Appliance systems.
- You can create linked clones with
- You can pass datastore clusters to the
- You can retrieve vSphere objects from vCloud Director objects with the
- You can manage resources more efficiently with SDRS support added to a number of cmdlets.
- You can retrieve, create, modify, and remove VMHost, VM, and SDRS advanced settings with the the
- vSphere PowerCLI 5.1 Release 1 brings a set of improvements that enhance security and customization.
- You can set the scope of your settings with the
Scope parameter of
- You can initialize custom vSphere PowerCLI scripts automatically by storing them in the
Initialize-PowerCLIEnvironment_Custom.ps1 script configuration file.
For more information on changes made in vSphere PowerCLI 5.1 Release 1, including improvements, security enhancements, and deprecated features, see the vSphere PowerCLI Change Log.
For more information on specific product features, see the VMware vSphere PowerCLI 5.1 User's Guide. For more information on specific cmdlets, see the VMware vSphere PowerCLI 5.1 Cmdlet Reference.
VMware vSphere PowerCLI 5.1 Release 1 is known to have the following issues:
Apply-DrsRecommendation runs in asynchronous mode even when called without the
Connect-VIServer cannot use the Kerberos network authentication protocol to connect to vCenter Server systems that are installed under a custom user account on a Windows system.
Connect-VIServer uses NTLM instead.
Workaround: Install and run vCenter Server under the default system account. Alternatively, you can:
- Add another IP to the Windows system where vCenter Server is running.
- Register a new A DNS record for the IP.
- Run the
setspn tool to register an SPN for the new DNS record and associate it with the vCenter Server account under which vCenter Server was installed.
For example: To register an SPN for the vc-alias.domain.com DNS and the VCAccount account, run:
setspn -A -HOST/vc-alias.domain.com Domain\VCAccount
- Use the new DNS name to connect to the vCenter Server system.
For example: Run
Copy-DatastoreItem throws an error when uploading an item to the root folder of a Datastore Provider drive.
On vCenter Server 5.0,
Copy-HardDisk cannot change the storage format of the destination hard disk.
The value of the
Persistence property of the object returned by
Get-HardDisk is different depending on the way the hard disk is retrieved by the cmdlet.
When you use
Get-ScsiLun to retrieve Powerpath devices, the value of their
MultipathPolicy property is shown as
Location parameter of
Get-Template does not accept
Get-UsbDevice cannot obtain USB devices from snapshots.
If you run
Get-View with the
ViewType parameters and specify a property path for the
Property parameter, the linked view of the cmdlet output is not populated.
- If a nonexisting user is specified,
Get-VIEvent returns the events for all existing users.
- Objects returned by
ManagedObjectReference types that are not compatible with the
During the process of creating a template from a virtual machine,
Get-VM returns both the virtual machine and template objects.
On vCenter Server 5.0,
Get-VMHostProfileRequiredInput returns a result even if you pass a hashtable with inapplicable elements.
- On ESX 4.0, the
LocalPath parameter does not accept paths to
.vib files as arguments.
Install-VMHostPatch cannot install patches on diskless ESXi servers.
Install-VMHostPatch cannot apply VIB patches.
Invoke-VMScript to invoke multi-line BAT and BASH scripts, the command might not run all the script lines.
You can create a vApp network by specifying inconsistent network settings. While the settings of the newly created vApp network are inconsistent, you can only modify them to restore their consistency. To configure the vApp network, run
New-HardDisk does not prompt for confirmation when you try to create a VMDK anti-affinity rule that overwrites an existing one.
Set-ScsiController cannot set both the
BusSharing parameters at the same time.
Workaround: First run the cmdlet to set the type and then run it again to configure the bus sharing mode.
NoBlocksSwitch parameters of
Set-ScciLun do not work on ESX 4.0 and later.
- On Windows operating systems,
Set-VMGuestNetworkInterface becomes non-responsive if the provided IP address conflicts with an existing IP address on the network.
Set-VMGuestNetworkInterface cannot configure the DNS address correctly on Linux operating systems.
When an ESX/ESXi host is registered with multiple vCenter Server systems, you cannot change the state of the disconnected host to connected.
The operation authenticates you with the host and automatically changes its state to connected.
Remove-VMHost to remove the disconnected host from the vCenter Server system that it is registered with.
Add-VMHost to attach the host to the vCenter Server system again.
- (Optional) Run
Set-VMHost to restore the initial configuration of the host.
If you pass a collection of valid and invalid objects to the
Set-VMHostAccount throws an error when it encounters the first invalid object and stops processing the remaining objects.
Set-VMHostNetwork cannot clear the values of the
VMKernelV6Gateway properties of the input object.
If you have vMotion enabled on one VMKernel NIC and you enable it on a second NIC on the same switch by using
VMotionEnabled property of the second NIC might still report that vMotion is not enabled. This is because only one NIC can be selected for vMotion, but more than one can be candidate NICs for vMotion. To change the currently active vMotion NIC, first disable the current one and then enable the one you want.
Workaround: Run the command again.
- The default value of the
TargetPort parameter is a random number instead of the port number.
Set-VMHostSNMP skips the value of the
Set-VMHostSNMP fails to enable
VMHostSNMP and to set the
ReadOnlyCommunityString when called for the first time.
When you specify the
Get-CIDatastore might return incorrect results if multiple provider virtual datacenters share a datastore.
When you are logged in as SysAdmin, the
Get-CIVM cmdlet returns system vShield Edge virtual machines used to establish perimeter security in the NAT-routed network.
Get-CIVApp returns all virtual appliance objects in the inventory including expired ones.
Get-CIVAppTemplate returns all virtual appliance templates in the inventory including expired ones.
- Inventory Provider
When run within the Inventory Provider,
Get-Datacenter returns the datacenters from the default servers instead from the
VIServer folder of the Inventory Provider drive.
- On vCenter Server 5.0 or ESXi 5.0 platforms, all guest-related cmdlets have slow and unstable behavior due to the slow performance of VMware Tools.
VirtualMachine parameter of the PowerCLI cmdlets is defined with the deprecated
Description property of the
VirtualMachine type, instead of the new one named
Notes. As a result, the PowerShell auto-complete function works with the deprecated property name.
- The types labels in the
UpdateViewData property are case-sensitive.
- When running in 64-bit mode, PowerCLI cannot detect the registry key
HKEY_LOCAL_MACHINE\SOFTWARE\VMware, Inc.\VMware vSphere PowerCLI\, which is used for determining the PowerCLI installation folder. Instead, you can use the following key:
HKEY_LOCAL_MACHINE\SOFTWARE\Wow6432Node\VMware, Inc.\VMware vSphere PowerCLI.
- All VIX cmdlets support use of SSPI for Windows guest machines if the underlying vCenter Server is version 5.0. This might not be valid for users who are local, and not domain users. VIX cmdlets are
Set-HardDisk when used for guest disk resizing.
The following issues have been resolved in VMware vSphere PowerCLI 5.1 Release 1:
Get-NetworkAdapter does not throw an error message if you try to retrieve a nonexisting adapter.
Cloning a server-side customization specification with
New-OSCustomizationSpec changes the values of the
PlainText properties from
If you use
New-VIPermission to create a permission for a distributed switch, the
Entity property of the returned object is
Set-Annotation cannot set an annotation for a custom attribute if another custom attribute with the same name exists.
Increasing the size of a system partition on Windows 7 and Windows Server 2008 by using the
GuestDiskResize parameter of
Set-HardDisk is not supported.
On vCenter Server 5.0, when you use
Set-VM to upgrade the virtual machine hardware version, the output of the cmdlet displays the old value although the version has been updated successfully.
Set-VMHost might not populate the
VMSwapfileDatastoreId property of the returned
VMHost object when
VMSwapFileDatastore properties are modified.
Get-VMHost to retrieve the object returned by
Changing the value of the
IPPolicy parameter to
Set-VMGuestNetworkInterface changes the value of the
WinsPolicy parameter to
Static as well.
Vendor properties of the
ScsiLun objects are always filled up with whitespaces to 16 (for
Model) and 8 (for
Installing VMware vSphere PowerCLI
VMware provides a single installer for VMware vSphere PowerCLI.
To install VMware vSphere PowerCLI components
- Download VMware vSphere PowerCLI 5.1 Release 1.
- Navigate to the local folder that contains the PowerCLI installer file you downloaded and double-click the executable file.
- On the Welcome page, click Next.
- On the VMware Patents page click Next.
- Accept the license agreement terms and click Next.
- On the Custom Setup page, select the PowerCLI components you want to install.
- (Optional) To change the default location to install VMware vSphere PowerCLI, click Change and select a different Destination Folder.
- Click Next.
- On the Ready to Install the Program page, click Install to proceed with the installation.
- Click Finish to complete the installation process.
For more information about installing PowerCLI 5.1 Release 1, see the VMware vSphere PowerCLI 5.1 User's Guide.