VMware Infrastructure Toolkit (for Windows)
|
VMware Infrastructure Toolkit (for Windows) 1.0 Release NotesVMware Infrastructure Toolkit (for Windows) provides an easy-to-use Windows PowerShell interface to the VMware Infrastructure API (VI API). VI Toolkit (for Windows) includes numerous cmdlets, sample scripts, and a function library. This document contains the following information: |
About the VMware Infrastructure Toolkit (for Windows)
VI Toolkit (for Windows) is a command-line and scripting tool built on Windows PowerShell, and provides more than 120 cmdlets for managing and automating your VMware Infrastructure.
Requirements
To use the VI Toolkit (for Windows) console, you need to have installed the following software:
- .NET 2.0 Service Pack 1
- Windows PowerShell 1.0
If Service Pack 1 for .NET 2.0 is not installed, some operations might take long to complete.
Supported Platforms
VI Toolkit (for Windows) 1.0 works on the 32-bit and 64-bit versions of the following operating systems:
- Windows Vista
- Windows XP (Service Pack 2)
- Windows 2003 Server
VI Toolkit (for Windows) 1.0 supports the following VMware environments:
- VMware ESX Server 3.5
- VMware ESX Server 3i
- VMware VirtualCenter 2.5
- VMware ESX Server 3.0/VirtualCenter 2.0
Obtaining the Software
You can obtain the VI Toolkit (for Windows) 1.0 at:
http://www.vmware.com/go/powershell
Known Issues
The VI Toolkit (for Windows) 1.0 has the following known issues:
New-HardDisk
- The
New-HardDiskcmdlet cannot createNonPersistentandUndoabledisks. - When
New-HardDiskis run, theSplitparameter can not be applied to the hard disk. - Split hard disks can be created only from
Flatdisk type. However, when aRawdisk is created withNew-HardDiskand theSplitparameter is set, no error is generated. NonPersistentRawPhysicaldisks can not be created. However, whenNew-HardDiskis run with theRawPhysicalandNonPersistentparameters, no error is generated and the created disk isfrom RawPhysical IndependendPersistenttype.ThinProvisioneddisks can be created only fromFlatdisk type. However, when a raw disk is created usingNew-HardDiskand theThinProvisionedparameter is set, no error is generated.
Set-HardDisk
Set-HardDiskcannot move the hard disk to the specified datastore.Set-HardDiskcannot set the type of a raw virtual disk toNonPersistent.- When a single hard disk is modified using the
Set-HardDiskcmdlet, the result is a collection of one item instead of a single object.
Set-VMHostSNMPreturnsnullfor theReadOnlyCommunitieswhen invoked with an empty string or array forReadOnlyCommunities.Set-VMHostSNMPfails to enableVMHostSNMPand to set theReadOnlyCommunityStringwhen called for the first time.
Workaround: Run the command again.- The default value of the
Set-VMHostSNMPTargetPortparameter is a random number instead of the port number. Set-VMHostSNMPdoes not take in account the value of theTargetPortparameter.
New-VMHostNetworkAdapter cannot set the value of the MAC address on VirtualCenter 2.5 and ESX Server 3.5.
-
Updating an array of virtual NICs with
Set-VMHostNetworkAdapter might not return an array containing all modified virtual NICs.
Set-OsCustomizationSpec
- Modifying the
Domain,DomainUserNameandDomainPasswordparameters for a Windows OS customization specification usingSet-OSCustomizationSpecresults in an error. - On a Windows OS customization specification, running
Set-OsCustomizationSpecwrongly sets tonulltheFullNameandDeleteAccountsproperties . - On a Linux OS customization specification, running
Set-OsCustomizationSpecreturns an error. Set-OsCustomizationSpecallows to change the OS customization specification from Linux to Windows and from Windows to Linux, without generating an error.
-
The
OSCustomisationSpec parameter of the New-VM cmdlet can be applied only when the new virtual machine is deployed from a template.
Get-VM
-
During the process of creating a template from a virtual machine,
Get-VM returns both the virtual machine and template objects.
Get-Log
Get-Log cannot create a bundle log for an ESX Server host on a VirtualCenter connection.Workaround: Connect directly to the ESX Server host.
Get-Datastore
(Get-Datastore).FreeSpaceMB may not return the actual datastore free space after a virtual machine is powered on. A refresh should be made first.
Get-Event
-
When
Get-Event is run for entities other than virtual machines, an incorrect result is returned.
New-Snapshot
-
When invoked with the
Quiesced switch parameter on, New-Snapshot creates a snapshot with Quiesced parameter value false.
Update-Tools
Update-Tools might hang if the mouse, VGA, and network drivers are not signed. A standard Windows dialog appears and needs a manual interaction.
Get-CDDrive
Get-CDDrive does not work on snapshots.
Get-FloppyDrive
Get-FloppyDrive does not work on snapshots.
Inventory Provider
-
The output of the
dir command, run while the Inventory Provider is running, might be difficult to read.
Debugging
-
When working without administrator privileges, the user is not able to see debug messages in the VI Toolkit logs.
Workaround: Work as an administrator on the local machine where the VI Toolkit is installed.
Working on 64-bit Platforms
-
Operations with ESX or VirtualCenter take long to complete when working on 64-bit platforms.
Workaround: This is a .NET 2.0 issue and it is fixed in Service Pack 1. Install Service Pack 1 for .NET 2.0.
Resolved Issues
The following issues have been resolved in VI Toolkit (for Windows) 1.0:
-
A new cmdlet
Disconnect-VIServerfor closing VMware Infrastructure connections is available. -
Update-Tools,Mount-Tools, andDismount-Toolsnow return an error message when they are invoked without theVMorGuestparameters. -
New-Datastorecreates new datastores as expected when adding NFS, CIFS, VMFS, and local storages. -
Users can specify a datastore when
Move-VMis run between hosts. -
Set-VmHostNetworkcmdlet now works against an ESX Server 3i visor.
Installing the VI Toolkit (for Windows)
VMware provides a single installer for the VI Toolkit (for Windows).
To install the VI Toolkit (for Windows)
- Download and install PowerShell 1.0 from the Microsoft PowerShell 1.0 download page .
- Launch the VI Toolkit (for Windows) installer by double-clicking the executable file you downloaded from http://www.vmware.com/go/powershell .
- Follow the instructions of the wizard.
- To install the toolkit in location other than the default, click Change in the Destination Folder page and select a different directory.
- In the Ready to Install the Program page choose whether to create a desktop shortcut.
- Click Install to proceed with the installation.
- Click Finish to complete the installation process.
To find a more detailed description of the VI Toolkit (for Windows) installation process and prerequisites, see the Installation Guide.
Last updated 14-Jul-2008 10:30 am