VMware Communities : Document List - Sample Code

hostOperations.pl

Wed, 25 Nov 2009 17:32:35 GMT

This script allows you to perform the following host operations enter_maintenance_mode and exit_maintenance_mode across set of ESX(i) hosts being managed by vCenter.

Requirements:
vCenter 2.5 or vCenter 4.0
ESX(i) hosts 3.5 or 4.0
vCLI 4.0 or vMA 4.0

Operations:

enter_maintenance_mode
exit_maintenance_mode

Sample Execution:

Create a file with list of hosts you want to perform certain operation on

[vi-admin@scofield ]$ cat hosts
everest.primp-industries.com

Enter maintenance mode (will vMotion off any powered on/off VMs to other available host if DRS is enabled with additional hosts):


[vi-admin@scofield ]$ ./hostOperations.pl --server reflex.primp-industries.com --hostfile hosts --operation ent_maint
Entering maintenance mode for host: "everest.primp-industries.com" and evacauating any VMs if host is part of DRS Cluster ...
        Successfully entered maintenance mode for host: "everest.primp-industries.com"!

Exit maintenance mode:

[vi-admin@scofield ]$ ./hostOperations.pl --server reflex.primp-industries.com --hostfile hosts --operation exi_maint
Exiting maintenance mode for host: "everest.primp-industries.com" ...
        Successfully exited maintenance mode for host: "everest.primp-industries.com"!

configureAdvHAClusterOptions.pl

Wed, 11 Nov 2009 20:44:10 GMT

This scripts allows you to configure advanced HA Cluster options such as some of the ones described on Duncan's HA Deep Dive page

The script accepts the name of a HA Cluster and a file that contains the advanced keys and values that you would like to update/overwrite. Make sure the format of each line is the following:

key="value"

Requirements:
vCenter 2.5 or 4.0
vSphere SDK for Perl or vMA 4.0

Sample Execution:

Here is a sample file containing 2 advanced options to configure:

[vi-admin@scofield ]$ cat ha_configs

das.allownetwork0="Service Console"
das.failuredetectiontime="20000"

Here is the actual execution:

[vi-admin@scofield ]$ ./configureAdvHAClusterOptions.pl --server reflex.primp-industries.com --cluster PRIMP-PROD --file ha_configs

Reconfiguring cluster: "PRIMP-PROD" with the following HA advanced configurations ...
        das.failuredetectiontime => 20000
        das.allownetwork0 => Service Console

Successfully added advanced HA configurations to cluster: "PRIMP-PROD"

vmdkManagement.pl

Wed, 11 Nov 2009 04:48:47 GMT

This script allows a user to add, remove and destroy existing VMDK for a given VM.

Requirements:
ESX(i) 3.5 or 4.0 or vCenter 2.5 or 4.0
vSphere SDK for Perl or vMA 4.0

Operations

Add
Remove
Destroy

Sample Execution:

Add Operation

[vi-admin@scofield ~]$ ./vmdkManagement.pl --server reflex.primp-industries.com --operation add --vmdkname vMA-2_1.vmdk --vmname vMA-2 --datastore himalaya-local-SAS.Constellation

Reconfiguring "vMA-2" to add VMDK: "[http://himalaya-local-SAS.Constellation|http://himalaya-local-SAS.Constellation] vMA-2/vMA-2_1.vmdk" ...
Sucessfully added VMDK to "vMA-2"!

Remove Operation

[vi-admin@scofield ~]$ ./vmdkManagement.pl --server reflex.primp-industries.com --operation remove --vmdkname vMA-2_1.vmdk --vmname vMA-2

Reconfiguring "vMA-2" to remove VMDK: "vMA-2_1.vmdk" ...
Sucessfully removed VMDK to "vMA-2"!

Destroy Operation

[vi-admin@scofield ~]]$ ./vmdkManagement.pl --server reflex.primp-industries.com --operation destroy --vmdkname vMA-2_1.vmdk --vmname vMA-2

Reconfiguring "vMA-2" to destroy VMDK: "vMA-2_1.vmdk" ...
Sucessfully destroyed VMDK to "vMA-2"!

findVMsWithRDMs.pl

Tue, 03 Nov 2009 05:56:04 GMT

This script locates VMs with RDMs (Virtual and Physical) and provides a list of the VM name, device name, filename and compatibility mode. The script can be pointed to either an individual ESX(i) or vCenter server.

Requirements:
ESX(i) 3.5 or 4.0 or vCenter 2.5 or 4.0
vSphere SDK for Perl or VI Perl Toolkit or vMA 4.0 or VIMA 1.0
VMs w/RDMs

Sample Execution:

Executing against a vCenter server:

[vi-admin@scofield ~]$ ./findVMsWithRDMs.pl --server ucsb-resnet-vcenter --username primp
Enter password:

iscsiBridge.12162008
        DeviceName: vmhba1:0:211:0
        FileName: [http://dlgCore-FC-LUN203.VMstorage3|http://dlgCore-FC-LUN203.VMstorage3] iscsiBridge.12162008/iscsiBridge.12162008_2.vmdk
        CompatMode: physicalMode

listHAClusterNodes.pl

Wed, 28 Oct 2009 17:34:42 GMT

Motivated by c_shanklin twitter message about http://www.hypervisor.fr/?p=1320 this morning about listing primary HA nodes within vCenter cluster using PowerCLI, I thought I provide an equivalent snippet of vSphere SDK for Perl script. In additional to listing the primary nodes, I'm also outputting the configuration and run state of each node in the cluster.

Unfortunately, the vSphere API does not provide information about the secondary nodes

Requirements:
vCenter 4.0
vSphere SDK for Perl or vMA 4.0

Operations:

Specific cluster (user --cluster)
All cluster (default)

Sample Execution:

Specific cluster:

./listHAClusterNodes.pl --server reflex.primp-industries.com --cluster 'R&D'

All cluster:

./listHAClusterNodes.pl --server reflex.primp-industries.com

Your output should be much more defined ... my development environment is under construction still hence the uninitialized and error messages

vmISOManagement.pl

Tue, 27 Oct 2009 18:55:26 GMT

This script allows you to mount and unmount ISO's that are visible to your ESX(i) servers to a particular VM.

Requirements:
ESX(i) 4.0 or vCenter 4.0
vSphere SDK for Perl or vMA 4.0
VM(s) that have a valid cdrom device

Operations:

queryiso
mount
umount

Sample Execution:

The queryiso operation allows you to search an ESX(i) host that the VM you're trying to perform the operation to locate valid ISO's and provide the user with the necessary input information to mount operation.

[vi-admin@scofield ~][http://reflex.primp-industries.com|http://reflex.primp-industries.com]$ ./vmISOManagement.pl --server reflex.primp-industries.com --vmname VCAP --operation queryiso

Datatstore Name & ISO Path:
-----------------------------------------------------------------
\[dlgCore-NFS-bigboi.VM-Backups\] archlinux-2009.02-core-i686.iso
\[himalaya-local-SATA.RE4-GP:Storage\] OSISO/ubuntu-9.04-server-i386.iso
\[himalaya-local-SATA.RE4-GP:Storage\] OSISO/client-10.53_sp41183.iso
\[himalaya-local-SATA.RE4-GP:Storage\] OSISO/gparted-livecd-0.3.4-11.iso
\[himalaya-local-SATA.RE4-GP:Storage\] OSISO/Archlinux-i686-2007.08-2.core.iso
\[himalaya-local-SATA.RE4-GP:Storage\] OSISO/echos-SWAK2004.iso
\[himalaya-local-SATA.RE4-GP:Storage\] OSISO/win2k3adv.iso
\[himalaya-local-SATA.RE4-GP:Storage\] OSISO/esx-kickstart.iso
\[himalaya-local-SATA.RE4-GP:Storage\] OSISO/ServerHyper_MUIx2-080912.iso
\[himalaya-local-SATA.RE4-GP:Storage\] OSISO/esx-DVD-4.0.0-164009.iso
\[himalaya-local-SATA.RE4-GP:Storage\] OSISO/ubuntu-9.04-server-amd64.iso
\[himalaya-local-SATA.RE4-GP:Storage\] OSISO/Memtest86_3.5.iso
\[himalaya-local-SATA.RE4-GP:Storage\] OSISO/VMware-VMvisor-Installer-4.0.0-171294.x86_64.iso
\[himalaya-local-SATA.RE4-GP:Storage\] OSISO/VMware-VMvisor-InstallerCD-3.5.0_Update_4-153875.i386.iso
\[himalaya-local-SATA.RE4-GP:Storage\] OSISO/OpenBSD/cdemu39.iso
\[himalaya-local-SATA.RE4-GP:Storage\] OSISO/OpenBSD/cd39.iso
\[himalaya-local-SATA.RE4-GP:Storage\] OSISO/VMware-ISOs/VMware-VMvisor-Installer-4.0.0-171294.x86_64.iso
\[himalaya-local-SATA.RE4-GP:Storage\] OSISO/VMware-ISOs/VMware-VMvisor-InstallerCD-3.5.0_Update_4-153875.i386.iso
\[himalaya-local-SATA.RE4-GP:Storage\] OSISO/VMware-ISOs/VMware-VIMSetup-all-4.0.0-162902.iso

This will provide you with both the --datastore name and the --filename path to the ISO that is required when using mount operation.

Let's say we want to mount [himalaya-local-SATA.RE4-GP:Storage] OSISO/VMware-ISOs/VMware-VMvisor-Installer-4.0.0-171294.x86_64.iso to a VM called VCAP

[vi-admin@scofield ~][http://reflex.primp-industries.com|http://reflex.primp-industries.com]$ ./vmISOManagement.pl --server reflex.primp-industries.com --vmname VCAP --operation mount --datastore himalaya-local-SATA.RE4-GP:Storage --filename OSISO/VMware-ISOs/VMware-VMvisor-Installer-4.0.0-171294.x86_64.iso

Mounting ISO: "[himalaya-local-SATA.RE4-GP:Storage] OSISO/VMware-ISOs/VMware-VMvisor-Installer-4.0.0-171294.x86_64.iso" to VM: "VCAP" ...
        Successfully added mounted ISO to VM!

Let's now unmount the ISO

[vi-admin@scofield ~][http://reflex.primp-industries.com|http://reflex.primp-industries.com]$ ./vmISOManagement.pl --server reflex.primp-industries.com --vmname VCAP --operation umount

Umounting ISO from VM: "VCAP" ...
        Successfully unmounted ISO from VM!

upgradeVMVirtualHardware.pl

Mon, 26 Oct 2009 19:16:34 GMT

Script to upgrade either a list of VMs to Virtual HW 7 OR all VMs on either ESX(i) or vCenter system. Prior to upgrading, the script will validate that the VM is poweredOff and the version of Virtual HW is not already configured on the VM. Also ensure that your VMs have the latest version of VMware Tools installed as there are changes to the vNIC when going from HW4 to HW7 which you'll get a question prompted if you don't have tools installed.

Requirements:
ESX(i) 4.0 or vCenter 4.0
vSphere SDK for Perl or vMA 4.0
VM(s) running Virtual HW Ver 4 and VMware Tools installed & are poweredOff prior to upgrade

Sample Execution:

[vi-admin@scofield ~][http://reflex.primp-industries.com|http://reflex.primp-industries.com]$ ./upgradeVMVirtualHardware.pl --server reflex.primp-industries.com --upgrade_type list --vmfile upgrade_list --hwversion 7

Upgrading VM: "hw-version-4-vm" Virtual HW from: 4 to 7
        Successfully upgraded Virtual HW for hw-version-4-vm
VM: "hw-version-7-vm" is already running Virtual HW version: 7

To upgrade all VMs, use --upgrade_type all and you don't --vmfile param

rdmManagmement.pl

Thu, 22 Oct 2009 03:50:03 GMT

This scripts allows you to create and add either physical or virtual RDM to a VM and also removing and deleting pRDM/vRDM to a VM. You must connect directly to the ESX(i) host that is housing the VM in which the RDM is to be added.

Requirements:
ESX(i) 3.5/4.0
vSphere SDK for Perl or vMA

Sample Execution:

Querying for available LUNS to be used as an RDM ( operation: query):

[vi-admin@scofield ~]$ ./rdmManagmement.pl --server esx40-1.primp-industries.com --username root --vmname rdmVM --operation query
Enter password:
Device Name: /vmfs/devices/disks/eui.caa68a778fc27982
Capacity: 30.00 GB

Device Name: /vmfs/devices/disks/eui.1f79d354801b3936
Capacity: 1000.00 MB

Device Name: /vmfs/devices/disks/eui.8f713e8e3c0a58d2
Capacity: 1.95 GB

Device Name: /vmfs/devices/disks/eui.c028c79e0ee07daa
Capacity: 28.00 GB

Let's create an physical RDM using 1.95gb LUN ( operation: add ):

[vi-admin@scofield ~]$ ./rdmManagmement.pl --server esx40-1.primp-industries.com --username root --vmname rdmVM --operation add --device /vmfs/devices/disks/eui.8f713e8e3c0a58d2 --compatmode physical --filename databaseRDM.vmdk
Enter password:
Creating and adding "physicalMode" RDM: "databaseRDM.vmdk" to rdmVM ...
        Successfully added RDM to VM!

Let's remove and delete the RDM from the VM ( operation: destroy ):

[vi-admin@scofield ~]$ ./rdmManagmement.pl --server esx40-1.primp-industries.com --username root --vmname rdmVM --operation destroy --filename databaseRDM.vmdk
Enter password:
Destroying RDM: "databaseRDM.vmdk" to rdmVM ...
        Successfully destroyed RDM to VM!

VITree - Display vCenter like Datacenter/folder tree and search all VMs in a folder

Tue, 13 Oct 2009 18:55:18 GMT

The attached Visual Basic 2008 solution is an example of how to use RetrieveProperties to p ull information from vCenter and populate a treeview with the results. Once populated, you can click on any folder and have the VMs in that folder populated into a grid with boottime displayed.

This project includes a VI.vb module that can easily be reused in other projects. It also includes partially optimized VimApi DLL files and a login form.

Known Issues:

If more than one Datacenter is present in vCenter, it will throw an exception that is trapped and continue working with only the single datacenter displayed.

If you click on anything other than a folder (datacenter for example) it will throw an error and not display the VMs

Screenshot of the populated project below:

If you want to turn it back on so that it shows VMs in the tree, you will need to:

Uncomment Lines 188-191 in VI.vb (Create VM Property Spec)
Uncomment Line 211 (setting propSet that includes the VMpSpec)
Comment out Line 212 (setting propSet that Does NOT include the VMpSpec)

getVMDiskInfo.pl

Mon, 12 Oct 2009 04:10:35 GMT

This scripts functions similar to that of PowerCLI equivalent at: http://ict-freak.nl/2009/10/11/powercli-virtual-machine-disk-vmdk-info-v2-analyze-data-with-excel/ which extracts all VMDK(s) for a given VM and displays the full VMDK path, whether or not the disk was thin provisioned or not and disk mode. There is an additional argument that can be passed on the commandline which will filter only thin provisioned VM(s) and the script can be executed against ESX(i) or vCenter system.

Update: Added Disk backing version info as found here

Requirements:
ESX(i) 3.5/4.0
vCenter 2.5/4.0
vSphere SDK for Perl or vMA

Sample Execution:

Display all VM(s):

Display all VM(s) with thin provisioned disks only:

useVIFastpassOnvMAToRunPerlScriptWithoutClearTextPassword.pl

Fri, 09 Oct 2009 03:56:37 GMT

This script makes use of the vi-fastpass library that is included in VMware vMA and allows you to execute a vSphere SDK for Perl or vCLI script without having to pass in credentials to each host upon execution. This script also does not require you to specify a .viperl configuration file containing the username/password nor relies on issuing of vifpinit on a target which has a huge security flaw in which the username/password is stored in plain text using environmental variables!!! I've been told this has been finally recognized as a bug/security issue and will be fixed in the near future.

This script does require that the targets are being managed by vMA that you would like to perform the operations on. Please refer to vMA documentation on how to setup targets to be managed by vMA.

Requirements:
VIMA 1.0 or vMA 4.0
ESX(i) 3.5/4.0 or vCenter 2.5/4.0
vSphere SDK for Perl/vCLI script

Sample Execution:

Let's say I would like to list all NFS datastores on a set of ESX(i) hosts, you would generally do something of the following using vCLI command esxcfg-nas:

[vi-admin@scofield ~]$ esxcfg-nas -l --server esxi40-1.primp-industries.com --username root
Enter password:
dlgCore-NFS-bigboi.VM-Backups is /exports/vm-backups from A.B.C.D mounted

and you would continue doing this for however many hosts you had, typing the password each time....

Now, let's see this script in action which only requires one argument which is a file containing the hosts that you want to perform the operation.

Note: Please make sure the name of the hosts is exactly the name in which it was added to vMA management system

My hostlist file:

[vi-admin@scofield ~]$ cat hostlist
esx40-1.primp-industries.com
esx40-2.primp-industries.com
esxi40-1.primp-industries.com

You'll need to edit the script to substitute the command you would like to run, look at line #44:

$command_to_execute = `esxcfg-nas -l --server $server --username $username --password $password`

Ensure when you're editing the script to preserve $server,$username and $password arguments along with the other params to the script

Now let's run the script on the 3 hosts:

[vi-admin@scofield ~]$ ./useVIFastpassOnvMAToRunPerlScriptWithoutClearTextPassword.pl --esxlist hostlist
Executing script on "esx40-1.primp-industries.com" ...
dlgCore-NFS-bigboi.VM-Backups is /exports/vm-backups from A.B.C.D mounted

Executing script on "esx40-2.primp-industries.com" ...
dlgCore-NFS-bigboi.VM-Backups is /exports/vm-backups from A.B.C.D mounted

Executing script on "esxi40-1.primp-industries.com" ...
dlgCore-NFS-bigboi.VM-Backups is /exports/vm-backups from A.B.C.D mounted

setUserDatastorePermission.pl

Thu, 08 Oct 2009 04:06:40 GMT

This script will apply a permission which contains a username and role to a specific datastore.

Requirements:
vCenter 4.0
ESX(i) 3.5 or 4.0
vSphere SDK for Perl or vMA 4.0

Default roles in vCenter (you can use your own):

NoAccess
Anonymous
View
ReadOnly
Admin
VirtualMachinePowerUser
VirtualMachineUser
ResourcePoolAdministrator
VMwareConsolidatedBackupUser
DatastoreConsumer
NetworkConsumer

Sample Execution:

[vi-admin@scofield ~]$ ./setUserDatastorePermission.pl --server reflex.primp-industries.com --username primp --datastore himalaya-iSCSI-starwind.esx-devCluster --user williamlam --rolename DatastoreConsumer
Searching for rolename: DatastoreConsumer...
Applying role: "DatastoreConsumer" to user: "williamlam" on datastore: "himalaya-iSCSI-starwind.esx-devCluster"

NTP, PowerShell, It's about time.

Tue, 06 Oct 2009 21:07:56 GMT

There's no doubt that time is critically important in a computing
environment. Given this sensitivity, and the recent recognition that we
had rogue hosts improperly configured, I decided to crank out a script
that would analyze our environment. I wanted to find whether the NTPD
service was running, what the NTP server configuration was, and provide
a report of this. Additionally I wanted to have the option (with
commenting) to automatically make corrections.

Always open to suggestions and improvements. I hope this helps you in your environment.

###----------FULL SCRIPT----------------------#####

Connect-VIServer -Server server.domain.com #Enter your vCenter Server

$NtpServer = "10.10.10.10" #Provide your default NTP Server. This will be used as default so entering a NTP server when prompted is not necessary

$OldNtpServer = "10.10.10.11" #Leave set as 127.127.1.0 as default unless you wish to change settings in your environment

$DefaultNtpServer = "127.127.1.0" #NTP Server Value that is set on a fresh ESX installation.

#Location based on Date
$date = Get-Date -UFormat %Y%m%d
$ExportLocation = "C:\NTP-$date.csv"

#Location where you would like report to be saved to.
#$ExportLocation = 'C:\NTPReport.csv'

$NTPHosts
= Get-VMHost | Select-Object Name,@{Name="NTPServer";Expression={$_ |
Get-VMHostNtpServer}}, @{Name="NTPRunning";Expression={($_ |
Get-VMHostService | Where-Object {$_.key -eq "ntpd"}).Running}} |
Sort-Object -Property "NTPRunning", "NTPServer"

$NTPHosts | Export-Csv $ExportLocation -NoTypeInformation
& $ExportLocation #Opens generated report file

$Restart = Read-Host "Would you like to start NTPD services or change NTP configurations on hosts? (y/n)"
#$Restart = "y" #Comment above line and uncomment this line if you wish to automatically restart services.
If ($Restart -eq "y"){
Import-Csv $ExportLocation | % {
$vmhost = $_.Name

#Checks the NTP configuration against a value previously determined at the top of script.
If (($_.NTPServer -eq $OldNtpServer) -or ($_.NTPServer -eq $DefaultNtpServer)){
$NtpInput
= Read-Host "Some servers are configured with NTP set as $OldNtpServer
or $DefaultNtpServer and may need their NTP settings reconfigured.
Please enter NTP Server FQDN or IP address. <$NtpServer> is
default."

If ($NtpInput -ne "") {
$NtpServer = $NtpInput
#Sets $NtpServer to the inputted value and does nothign if left blank.
This allows use of default when value is consistent in the environment.
}
Add-VMHostNtpServer -VMHost $vmhost -NtpServer $NtpServer | Where-Object {$_.NTPServer -eq $OldNtpServer}
Remove-VMHostNtpServer -VMHost $vmhost -NtpServer $OldNtpServer
}

#Now time to restart any NTPD services that are currently not running.
If ($_.NTPRunning -eq "False") {
Get-VmHostService -VMHost $vmhost | Where-Object {$_.key -eq "ntpd"} | Start-VMHostService
}
}
}
Write-Host "Process Complete"

Configure Switching for ESX host based on .CSV

Tue, 06 Oct 2009 17:32:12 GMT

A couple of weeks ago I was in need to configure several new ESX servers with multiple NICs, vSwitches, and VLANs. Since I'm not one to do the same thing over and over again I turned to scripting. To further complicate things I wanted to allow the same script to create vSwitches, configure vMotion switch, add port groups, and create NIC Teams all from a prepopulated .CSV file. I'm doing this primarily so that all configuration could be done before the server arrived and so that I could create "Switch Profiles" when I add new hosts to clusters.

In the end I developed a script that reads from a .CSV file and then creates the desired switching. The first column tells the script what type of addition it is and the script processes the information for that object accordingly. I've noticed a few others have been posting recently about scripts on setting up portgroups, etc. and thought it was time to no longer keep this to myself (i.e. finally found the time to post). I too would like to also credit Hal Rottenburg's book Managing VMware Infrastructure with Windows Powershell which was very helpful for this and many other scripting projects I will be posting soon. Mike Laverick's post linked below helped in configuring the vMotion switch.

I hope you find this helpful. It has been HUGE in my environment.

Download the files here:
ESX-ConfigureSwitchCSV-Generic.txt
esx_switching_generic.csv

Links where others discuss switch configuration with PowerCLI.
http://halr9000.com/article/828
http://www.holy-vm.com/2009/10/01/adding-port-groups-with-powercli/
http://www.rtfm-ed.co.uk/?p=1514

Text of Script w/out comments

$getinfo = Import-Csv "\\server\share\file.csv"
Connect-VIServer -Server vCenterServer

$getinfo | % {
$Type = $_.Type #!!!! Case Sensitive !!!!!!
$gethost = Get-VMHost -Name $_.HostName
$SwitchName = $_.SwitchName
$PortGroup = $_.PortGroupName
$Nic = $_.NIC
$VLAN = $_.VLAN
$IP = $_.IP
$Subnet = $_.Subnet
$kernelGW = $_.KernelGW

If ($Type -eq "Switch") {
$gethost | New-VirtualSwitch -Name $SwitchName -Nic $Nic
}
If ($Type -ne "vMotion") {
$getswitch = Get-VirtualSwitch -VMHost $gethost -Name $SwitchName
}
If ($Type -eq "Team"){
$getswitch | Set-VirtualSwitch -Nic $Nic
}
IF ($Type -eq "Portgroup") {
$getswitch | New-VirtualPortGroup $PortGroup -VLanId $VLAN
}
IF ($Type -eq "vMotion") {

$newvswitch = New-VirtualSwitch -VMHost $gethost -Name $SwitchName -Nic $Nic
$vmotion = New-VirtualPortGroup -VirtualSwitch $newvswitch -Name $PortGroup
New-VMHostNetworkAdapter -VMHost $gethost -PortGroup $PortGroup -VirtualSwitch $newvswitch -IP $IP -SubnetMask $subnet -VMotionEnabled: $true

$vmhostnetwork = get-vmhostnetwork $gethost
set-vmhostnetwork -network $vmhostnetwork -vmkernelgateway $kernelGW
}
}

Job-Rescan-ALL-HBA

Mon, 05 Oct 2009 14:57:13 GMT

This program will rescan all the HBA's in your vm enviroment, and instead of doing it one at a time, it creates a seperate job for each ESX host. Thus multithreading the rescan. For ESX 3.5 this is really handy, for vsphere 4 you can have it do a rescan of all HBA's through the vi interface. But this will work against vsphere as well.

I developed this script as I needed a quick way to rescan the HBA's when a failover of our HP EVA occurs. And I need the servers to rescan. I'll be working on another version which will suspend the vm's on a particular LUN, failover that particular LUN, rescan and then restart the vm.. As you can imagine this will be tricky and others have written it for other storage systems but not for HP EVA's.

#Rescan all HBA's creating 1 job for each ESX server


# Kyle Weir, jkw117@gmail.com, 10-05-09

#connects initially to get the list of ESX servers 



Connect-VIServer  "vcenter" -User Administrator -Password password 



vm=get-vmhost



#Passes the server names individually to different jobs. Thus allowing it to ask each ESX host to rescan itself. 



for ($x=0 ; $x -le $vm.length; $x++)
{
Start-Job -ArgumentList $vm[$x|http://communities.vmware.com/community-document-picker.jspa?communityID=3077&subject=%24x].name -ScriptBlock {
Add-PSSnapin VMware.VimAutomation.Core
Connect-VIServer  "vcenter" -User Administrator -Password $pasd
get-vmhost $args| Get-VMHostStorage -RescanAllHBA -rescanVMFS -refresh
} 
}

Any questions please email me, I am sure this can be updated to eliminate

pluginExtensionManager.pl

Sat, 03 Oct 2009 17:57:58 GMT

Script to retrieve the list of extensions installed on your vCenter server OR to unregister a specific plugin that has been installed.

Requirements:
vCenter 2.5 or 4.0
vSphere SDK for Perl or vMA 4.0

Sample Execution:

List installed plugins against vCenter

[vi-admin@scofield ~]$ ./pluginExtensionManager.pl --server reflex.primp-industries.com --username primp --operation list

------------------------------------------------------
Label: vCenter Hardware Status
Summary: Displays the hardware status of hosts (CIM monitoring)
Version: 4.0
Company: VMware, Inc.
Key: cim-ui
Server info:
        Admin Email: noreply@vmware.com -
        Company: VMware, Inc.
        Description:
        Type: com.vmware.vim.viClientScripts
        Url: https://reflex.primp-industries.com:8443/cim-ui/scriptConfig.xml


------------------------------------------------------
Label: vCenter Storage Monitoring
Summary: Storage Monitoring and Reporting
Version: 4.0
Company: VMware Inc.
Key: com.vmware.vim.sms

------------------------------------------------------
Label: report
Summary: report
Version: 1.0.0
Key: com.vmware.vim.stats.report
Server info:
        Company: VMware, Inc.
        Description:
        Type: HTTP
        Url: https://reflex.primp-industries.com:8443/statsreport/vicr.do


------------------------------------------------------
Label: vCenter Service Status
Summary: Displays the health status of vCenter services
Version: 4.0
Company: VMware, Inc.
Key: health-ui
Server info:
        Admin Email: noreply@vmware.com -
        Company: VMware, Inc.
        Description:
        Type: com.vmware.vim.viClientScripts
        Url: https://reflex.primp-industries.com:8443/health-ui/scriptConfig.xml


------------------------------------------------------
Label: hostdiag
Summary: hostdiag
Version: 1.0
Key: hostdiag

------------------------------------------------------
Label: VirtualCenter dynamic events and tasks
Summary: Extension for declaring dynamic events, tasks and faults from within the VirtualCenter server
Version: 1.0
Key: VirtualCenter

------------------------------------------------------
Label: com
Summary: com
Version: 4.0
Key: com.vmware.vSphereWebServicesSDK.primp-industries.com
Server info:
        Admin Email: william.lam@primp-industries.com -
        Company: primp-industries.com
        Description:
        Type: com.vmware.vim.viClientScripts
        Url: https://reflex.primp-industries.com/ui/plugin/primp.xml

Remove specific plugin from vCenter (use operation 'list' to figure out the key for plugin):

[vi-admin@scofield ~]]$ ./pluginExtensionManager.pl --server reflex.primp-industries.com --username primp --operation remove --key com.vmware.vSphereWebServicesSDK.primp-industries.com

Removing plugin key: "com.vmware.vSphereWebServicesSDK.primp-industries.com"

Alternatively, you can also remove any of the plugins by using the Manager Object Browser. You just need to point your web browser to your vCenter server:https://<your_vc_server>/mob

1. Click on content

2. Locate and click on ExtensionManager

3. Click on the plugin you're interested in removing

4. Record the plugin key id which is required to remove the plugin

5. Go back to the previous page and at the bottom click on the function UnregisterExtension, a new window will pop-up which will ask for the plugin key. Enter the key and then click on Invoke Method to remove the plugin.

6. You can refresh the page and you'll notice the plugin is no longer available and you can restart your vSphere Client to see the plugin has no been removed.

Deploy VM From Template

Wed, 30 Sep 2009 03:20:16 GMT

addVMAnnotation.pl

Mon, 28 Sep 2009 19:25:00 GMT

This script allows you to set 'annotation' field for a specific VM when connecting to either ESX9i) or vCenter host.

Note: This script was generated using the same snippet of code as addVMAdvParamOption.pl

Requirements:
ESX(i) 3.5 or 4.0 or vCenter 2.5 or 4.0
vSphere SDK for Perl or vMA

Sample Execution:

[vi-admin@scofield]$ ./addVMAnnotation.pl --server reflex.primp-industries.com --username primp --vmname vMA-2 --annotation "vMA-2 dev system"

Reconfiguring "vMA-2" with annotation: "vMA-2 dev system" ...
Sucessfully updated annotation for "vMA-2"!

getVMThinProvisionedSavings.pl

Sat, 26 Sep 2009 23:28:29 GMT

While looking around the forums, I noticed this thread: Script to determine disk space saved by thin provisioning which had an interesting request from the OP. This script will extract the total amount of provisioned space across all datastore(s) and consumed space for a VM and display in either the raw format in total bytes OR it's properly formatted disk consumption (B,KB,MB,GB,TB). This data is primarily useful when using thin provisioning

Requirements:
ESX(i) 4.0 or vCenter 4.0
vSphere SDK for Perl or vMA 4.0

Sample Execution:

Raw output (in bytes by default):

[vi-admin@scofield ~]./getVMThinProvisionedSavings.pl --server reflex.primp-industries.com --username primp

VM Name                                  Provisioned          Used                % Saved
-------------------------------------------------------------------------------------------
Auroa                                    4833604510           4288344990          11.3 %
-------------------------------------------------------------------------------------------
Bitsy                                    2686155138           1851488642          31.1 %
-------------------------------------------------------------------------------------------
Certiorari                               9395724427           8590418059          8.6 %
-------------------------------------------------------------------------------------------
Clifford                                 10766700317          10766700317         0 %
-------------------------------------------------------------------------------------------
ESX-Kickstart                            13423364683          7031259723          47.6 %
-------------------------------------------------------------------------------------------
ESX40-1                                  46171339531          4402363147          90.5 %
-------------------------------------------------------------------------------------------
ESX40-2                                  30065354586          4306036570          85.7 %
-------------------------------------------------------------------------------------------
ESXi40-1                                 30065197293          4318462189          85.6 %

.........

Formated output:

[vi-admin@scofield ~]$ ./getVMThinProvisionedSavings.pl --server reflex.primp-industries.com --username primp --format 1

VM Name                                  Provisioned          Used                % Saved
-------------------------------------------------------------------------------------------
Auroa                                    4.50 GB              3.99 GB             11.3 %
-------------------------------------------------------------------------------------------
Bitsy                                    2.50 GB              1.72 GB             31.1 %
-------------------------------------------------------------------------------------------
Certiorari                               8.75 GB              8.00 GB             8.6 %
-------------------------------------------------------------------------------------------
Clifford                                 10.03 GB             10.03 GB            0 %
-------------------------------------------------------------------------------------------
ESX-Kickstart                            12.50 GB             6.55 GB             47.6 %
-------------------------------------------------------------------------------------------
ESX40-1                                  43.00 GB             4.10 GB             90.5 %
-------------------------------------------------------------------------------------------
ESX40-2                                  28.00 GB             4.01 GB             85.7 %
-------------------------------------------------------------------------------------------
ESXi40-1                                 28.00 GB             4.02 GB             85.6 %
.....

generateVMRemoteConsoleURL.pl

Sat, 26 Sep 2009 04:33:39 GMT

Motivated by this thread: Programatically Generate Remote Console URL, here is a script that will generate the proper remote console URL for vSphere vCenter 4.0

Requirements:
vCenter 4.0
ESX(i) 4.0
vSphere SDK for Perl or vMA 4.0

Sample Execution:

Do not obfuscate URL:

[vi-admin@scofield ~][http://reflex.primp-industries.com|http://reflex.primp-industries.com]$ ./generateVMRemoteConsoleURL.pl --server reflex.primp-industries.com --username primp --obfuscate 0 --vmname William-XP
https://reflex.primp-industries.com/ui/?wsUrl=http://localhost:80/sdk&mo=VirtualMachine|vm-91&inventory=none&tabs=hide_

Obfuscate URL:

[vi-admin@scofield ~][http://reflex.primp-industries.com|http://reflex.primp-industries.com]$ ./generateVMRemoteConsoleURL.pl --server reflex.primp-industries.com --username primp --obfuscate 1 --vmname William-XP
https://reflex.primp-industries.com/ui/?view=aHR0cDovL2xvY2FsaG9zdDo4MC9zZGsmbW89VmlydHVhbE1hY2hpbmV8dm0tOTEmaW52ZW50b3J5PW5vbmUmdGFicz1oaWRlXw==

There are two other optional flags that can be set which are --limit_single_vm_view and --limit_workspace_view which is described in the vSphere Web Access for vCenter when generating the URL which can be set in this script to provide the correct permissions in the URL. By default both parameters have a default of 1 or enabled, you may set it to false by passing in the value of 0

getVMsPerDatastore.pl

Fri, 25 Sep 2009 04:16:11 GMT

I noticed Alan Renof's How many VMs on your Datastores ? article today and realized I had written something similar a few months back but forgot to publish. This script will retrieve all datastores from either ESX(i) or vCenter host and extract the number of VM(s), % free and the datastore type.

Requirements:
ESX(i) 3.5 or 4.0
vCenter 2.5 or 4.0
vSphere SDK for Perl or vMA 4.0

Sample Execution:

./getVMsPerDatastore.pl --server reflex.primp-industries.com --username primp

Datastore                                        % Free              # of VMs        Datastore Type
-----------------------------------------------------------------------------------------------------
dlgCore-NFS-bigboi.VM-Backups                    41.2                3               NFS
-----------------------------------------------------------------------------------------------------
dlgCore-iSCSI.test                               48.6                1               VMFS
-----------------------------------------------------------------------------------------------------
himalaya-local-SAS.Constellation                 20.5                10              VMFS
-----------------------------------------------------------------------------------------------------
himalaya-local-SAS.Savvio                        46.2                23              VMFS
-----------------------------------------------------------------------------------------------------
himalaya-local-SATA.RE4-GP:Boot                  48.2                0               VMFS
-----------------------------------------------------------------------------------------------------
himalaya-local-SATA.RE4-GP:Storage               49.3                31              VMFS
-----------------------------------------------------------------------------------------------------
dlgCore-NFS-bigboi.VM-Backups                    41.1                0               NFS
-----------------------------------------------------------------------------------------------------
esx40-1-local-storage                            98.7                0               VMFS
-----------------------------------------------------------------------------------------------------
esx40-2-local-storage                            98.1                0               VMFS
-----------------------------------------------------------------------------------------------------
esxi40-1-local-storage                           98.1                2               VMFS
-----------------------------------------------------------------------------------------------------
himalaya-iSCSI-starwind.esx-devCluster           97.6                2               VMFS
-----------------------------------------------------------------------------------------------------

listVMsInResourcePool.pl

Thu, 24 Sep 2009 16:35:48 GMT

Script to query VM(s) in a specific Resource Pool, this will work if the Resource Pool is nested.

Requirements:
vCenter 2.5 or 4.0
vSphere SDK for Perl or vMA 4.0

Sample Execution:

./listVMsInResourcePool.pl --server reflex.primp-industries.com --username primp --resource_pool production

vm-1
vm-2
vm-3
vm-4

Configure numDisplays using vmware.vim.dll

richard.judd@rbs.com — Thu, 24 Sep 2009 14:49:33 GMT

Private Function WriteVDI_VMXFile(ByVal VCClient As VMware.Vim.VimClient, ByVal textToUse As String, ByVal HWProfile As String, ByVal BindOU As DirectoryEntry, ByVal eucnotes As String)

Dim vmCenter As String = vce
Dim vmFilter, cluFilter As New NameValueCollection
vmFilter.Add("Runtime.PowerState", "PoweredOff")
vmFilter.Add("name", "^" & vma & "$")

Dim vmList As IList(Of EntityViewBase) = VCClient.FindEntityViews(GetType(VirtualMachine), Nothing, vmFilter, Nothing)
If vmList Is Nothing Then

Return False
End If

For Each vm As VirtualMachine In vmList ' Looping through all VMs found that match the filter
If vm.Name.ToUpper = vma Then 'The filter matches machines objects that has "StartsWith" <^value>..

Dim info As VMware.Vim.VirtualMachineConfigSpec
info = New VMware.Vim.VirtualMachineConfigSpec

With info
.NumCPUs = cpp
.MemoryMB = mep

If Me.cbx_GBM_BBP_NumDisplays.SelectedIndex -1 Then
If displyConfig IsNot Nothing Then
.ExtraConfig = New VMware.Vim.OptionValue(2) {}
.ExtraConfig(0) = New VMware.Vim.OptionValue()
.ExtraConfig(0).Key = maxWidthKey
.ExtraConfig(0).Value = maxWidthValue
.ExtraConfig(1) = New VMware.Vim.OptionValue()
.ExtraConfig(1).Key = maxHeightKey
.ExtraConfig(1).Value = maxHeightValue
.ExtraConfig(2) = New VMware.Vim.OptionValue()
.ExtraConfig(2).Key = numDisplaysKey
.ExtraConfig(2).Value = numDisplaysValue

Call ConfigureVirtualVideoRAMsize(vramSizeValue, vm)

End If

End If

End With
End Function

Public Sub ConfigureVirtualVideoRAMsize(ByVal vramInKB As Integer, ByVal vm As VirtualMachine)
Dim videoCard As VirtualMachineVideoCard = Nothing
' Get all the virtual devices of a VirtualMachine
Dim vDevices As VirtualDevice() = vm.Config.Hardware.Device
' Find the video card from available virtual devices
For x As Integer = 0 To vDevices.Length - 1
If TypeOf vDevices(x) Is VMware.Vim.VirtualMachineVideoCard Then
videoCard = DirectCast(vDevices(x), VirtualMachineVideoCard)
Exit For
End If
Next

If videoCard IsNot Nothing Then
' Set the new videoRamSize
videoCard.VideoRamSizeInKB = vramInKB
' Create the configuration spec to be passed in ReconfigVM method
Dim deviceSpec As New VirtualDeviceConfigSpec()
deviceSpec.Operation = VirtualDeviceConfigSpecOperation.edit
deviceSpec.Device = videoCard

Dim confSpec As New VirtualMachineConfigSpec()
confSpec.DeviceChange = New VirtualDeviceConfigSpec() {deviceSpec}
vm.ReconfigVM(confSpec)
End If
End Sub

Change Network Card on VM (Network0, Network1)

richard.judd@rbs.com — Thu, 24 Sep 2009 13:51:15 GMT

For Each vm As VirtualMachine In vmList ' Looping through all VMs found that match the filter
If vm.Name.ToUpper = vma Then 'The filter matches machines objects that has "StartsWith" <^value>..

If Me.cbx_GBM_BBP_NetworkConnection.SelectedIndex -1 Then ' Looking at a combo box control
For Each mor As ManagedObjectReference In vm.Network
Dim virtualDevices As VMware.Vim.VirtualDevice() = vm.Config.Hardware.Device
Dim nicList As New List(Of VMware.Vim.VirtualEthernetCard)()
For x As Integer = 0 To virtualDevices.Length - 1
If TypeOf virtualDevices(x) Is VMware.Vim.VirtualEthernetCard Then
Dim nic As VMware.Vim.VirtualEthernetCard = DirectCast(virtualDevices(x), VMware.Vim.VirtualEthernetCard)
nicList.Add(nic)
Dim NetworkType As String = Me.cbx_GBM_BBP_NetworkConnection.SelectedItem.ToString 'reading a value from combo box control
Dim _Network As String = Nothing
_Network = GetHashTableVal(_VMHardwareConfig, NetworkType) ' getting value from hash table

Call ConfigureVirtualNIC(_Network, nicList, mor, vm)

Exit For
End If
Next
Next
End If
End Function

Public Sub ConfigureVirtualNIC(ByVal NicName As String, ByVal niclist As List(Of VMware.Vim.VirtualEthernetCard), ByVal mor As ManagedObjectReference, ByVal vm As VirtualMachine)
Dim deviceSpec As VirtualDeviceConfigSpec() = New VirtualDeviceConfigSpec(niclist.Count - 1) {}

For x As Integer = 0 To niclist.Count - 1
deviceSpec(x) = New VMware.Vim.VirtualDeviceConfigSpec()
deviceSpec(x).Operation = VMware.Vim.VirtualDeviceConfigSpecOperation.edit
deviceSpec(x).Device = niclist(x)
Dim nicBacking As New VMware.Vim.VirtualEthernetCardNetworkBackingInfo()
nicBacking.Network = mor
nicBacking.DeviceName = NicName
niclist(x).Backing = nicBacking
Next

Dim newSpec As New VirtualMachineConfigSpec()
newSpec.DeviceChange = deviceSpec
Try
vm.ReconfigVM(newSpec)

Catch ex As Exception

End Try
End Sub

suspend.C Demonstrates how to power on, suspend, and resume a virtual machine

Wed, 23 Sep 2009 22:18:14 GMT

VIX API 1.7 Sample Code - from Documentation Website

* *********************************************************************
* Copyright (c) 2007 VMware, Inc.
* All rights not expressly granted to you by VMware, Inc. are reserved.
* *********************************************************************/

/* This demonstrates how to power on, suspend, and resume a virtual machine.
* The virtual machine will remain powered on at the end of this program.
*
* This uses the VixJob_Wait function to block after starting each
* asynchronous function. This effectively makes the asynchronous
* functions synchronous, because VixJob_Wait will not return until the
* asynchronous function has completed.
*/

#include <stdio.h>
#include <stdlib.h>

#include "vix.h"

/*
* Certain arguments differ when using VIX with VMware Server 2.0
* and VMware Workstation.
*
* Comment out this definition to use this code with VMware Server 2.0.
*/
#define USE_WORKSTATION

#ifdef USE_WORKSTATION

#define  CONNTYPE    VIX_SERVICEPROVIDER_VMWARE_WORKSTATION

#define  HOSTNAME ""
#define  HOSTPORT 0
#define  USERNAME ""
#define  PASSWORD ""

#define  VMPOWEROPTIONS   VIX_VMPOWEROP_LAUNCH_GUI   // Launches the VMware Workstaion UI
// when powering on the virtual machine.

#define VMXPATH_INFO "where vmxpath is an absolute path to the .vmx file " \
"for the virtual machine."

#else    // USE_WORKSTATION

/*
* For VMware Server 2.0
*/

#define CONNTYPE VIX_SERVICEPROVIDER_VMWARE_VI_SERVER

#define HOSTNAME "https://192.2.3.4:8333/sdk"
/*
* NOTE: HOSTPORT is ignored, so the port should be specified as part
* of the URL.
*/
#define HOSTPORT 0
#define USERNAME "root"
#define PASSWORD "hideme"

#define  VMPOWEROPTIONS VIX_VMPOWEROP_NORMAL

#define VMXPATH_INFO "where vmxpath is a datastore-relative path to the " \
".vmx file for the virtual machine, such as "        \
"\"[standard] ubuntu/ubuntu.vmx\"."

#endif    // USE_WORKSTATION

/*
* Global variables.
*/

static char *progName;



/*
* Local functions.
*/

////////////////////////////////////////////////////////////////////////////////
static void
usage()
{
fprintf(stderr, "Usage: %s <vmxpath>\n", progName);
fprintf(stderr, "%s", VMXPATH_INFO);
}

////////////////////////////////////////////////////////////////////////////////
int
main(int argc, char **argv)
{
VixError err;
char *vmxPath;
VixHandle hostHandle = VIX_INVALID_HANDLE;
VixHandle jobHandle = VIX_INVALID_HANDLE;
VixHandle vmHandle = VIX_INVALID_HANDLE;

progName = argv[0];
if (argc > 1) {
vmxPath = argv[1];
} else {
usage();
exit(EXIT_FAILURE);
}

jobHandle = VixHost_Connect(VIX_API_VERSION,
CONNTYPE,
HOSTNAME, // *hostName,
HOSTPORT, // hostPort,
USERNAME, // *userName,
PASSWORD, // *password,
0, // options,
VIX_INVALID_HANDLE, // propertyListHandle,
NULL, // *callbackProc,
NULL); // *clientData);

err = VixJob_Wait(jobHandle, 
VIX_PROPERTY_JOB_RESULT_HANDLE, 
&hostHandle,
VIX_PROPERTY_NONE);
if (VIX_FAILED(err)) {
goto abort;
}

Vix_ReleaseHandle(jobHandle);
jobHandle = VixVM_Open(hostHandle,
vmxPath,
NULL, // VixEventProc *callbackProc,
NULL); // void *clientData);
err = VixJob_Wait(jobHandle, 
VIX_PROPERTY_JOB_RESULT_HANDLE, 
&vmHandle,
VIX_PROPERTY_NONE);
if (VIX_FAILED(err)) {
goto abort;
}

Vix_ReleaseHandle(jobHandle);
jobHandle = VixVM_PowerOn(vmHandle,
VMPOWEROPTIONS,
VIX_INVALID_HANDLE,
NULL, // *callbackProc,
NULL); // *clientData);
err = VixJob_Wait(jobHandle, VIX_PROPERTY_NONE);
if (VIX_FAILED(err)) {
goto abort;
}

Vix_ReleaseHandle(jobHandle);
jobHandle = VixVM_Suspend(vmHandle,
VIX_VMPOWEROP_NORMAL,
NULL, // *callbackProc,
NULL); // *clientData);
err = VixJob_Wait(jobHandle, VIX_PROPERTY_NONE);
if (VIX_FAILED(err)) {
goto abort;
}

Vix_ReleaseHandle(jobHandle);

/*
* Calling VixVM_PowerOn() on a virtual machine that has been
* suspended will resume the virtual machine from the suspended state.
*/
jobHandle = VixVM_PowerOn(vmHandle,
VMPOWEROPTIONS,
VIX_INVALID_HANDLE,
NULL, // *callbackProc,
NULL); // *clientData);
err = VixJob_Wait(jobHandle, VIX_PROPERTY_NONE);
if (VIX_FAILED(err)) {
goto abort;
}

abort:
Vix_ReleaseHandle(jobHandle);
Vix_ReleaseHandle(vmHandle);

VixHost_Disconnect(hostHandle);



return 0;
}



/*If you have obtained this sample code as part of the VMware Server 1.0 SDK, or are using this sample code in conjunction with the VMware Server 1.0 SDK, the license terms of that SDK will govern your use of this sample code.

Otherwise, the sample code is provided "AS-IS" for use, modification, and redistribution in source and binary forms, provided that the copyright notice and this following list of conditions are retained and/or reproduced in your distribution. To the maximum extent permitted by law, VMware, Inc., its subsidiaries and affiliates hereby disclaim all express, implied and/or statutory warranties, including duties or conditions of merchantability, fitness for a particular purpose, and non-infringement of intellectual property rights. IN NO EVENT WILL VMWARE, ITS SUBSIDIARIES OR AFFILIATES BE LIABLE TO ANY OTHER PARTY FOR THE COST OF PROCURING SUBSTITUTE GOODS OR SERVICES, LOST PROFITS, LOSS OF USE, LOSS OF DATA, OR ANY INCIDENTAL, CONSEQUENTIAL, DIRECT, INDIRECT, OR SPECIAL DAMAGES, ARISING OUT OF THIS OR ANY OTHER AGREEMENT RELATING TO THE SAMPLE CODE.

You agree to defend, indemnify and hold harmless VMware, and any of its directors, officers, employees, agents, affiliates, or subsidiaries from and against all losses, damages, costs and liabilities arising from your use, modification and distribution of the sample code.

VMware does not certify or endorse your use of the sample code, nor is any support or other service provided in connection with the sample code.*/

powerOn.c - Shows how to open a virtual machine, power it on, and power it off.

Wed, 23 Sep 2009 22:14:36 GMT

/*Link to sample code from Documentation website Shows how to open a virtual machine, power it on, and power it off.*/

 

* *********************************************************************
* Copyright (c) 2007 VMware, Inc.
* All rights not expressly granted to you by VMware, Inc. are reserved.
* *********************************************************************/

/* This demonstrates how to open a virtual machine,
* power it on, and power it off.
*
* This uses the VixJob_Wait function to block after starting each
* asynchronous function. This effectively makes the asynchronous
* functions synchronous, because VixJob_Wait will not return until the
* asynchronous function has completed.
*/

#include <stdio.h>
#include <stdlib.h>

#include "vix.h"

/*
* Certain arguments differ when using VIX with VMware Server 2.0
* and VMware Workstation.
*
* Comment out this definition to use this code with VMware Server 2.0.
*/
#define USE_WORKSTATION

#ifdef USE_WORKSTATION

#define  CONNTYPE    VIX_SERVICEPROVIDER_VMWARE_WORKSTATION

#define  HOSTNAME ""
#define  HOSTPORT 0
#define  USERNAME ""
#define  PASSWORD ""

#define  VMPOWEROPTIONS   VIX_VMPOWEROP_LAUNCH_GUI   // Launches the VMware Workstaion UI
// when powering on the virtual machine.

#define VMXPATH_INFO "where vmxpath is an absolute path to the .vmx file " \
"for the virtual machine."

#else    // USE_WORKSTATION

/*
* For VMware Server 2.0
*/

#define CONNTYPE VIX_SERVICEPROVIDER_VMWARE_VI_SERVER

#define HOSTNAME "https://192.2.3.4:8333/sdk"
/*
* NOTE: HOSTPORT is ignored, so the port should be specified as part
* of the URL.
*/
#define HOSTPORT 0
#define USERNAME "root"
#define PASSWORD "hideme"

#define  VMPOWEROPTIONS VIX_VMPOWEROP_NORMAL

#define VMXPATH_INFO "where vmxpath is a datastore-relative path to the " \
".vmx file for the virtual machine, such as "        \
"\"[standard] ubuntu/ubuntu.vmx\"."

#endif    // USE_WORKSTATION

/*
* Global variables.
*/

static char *progName;



/*
* Local functions.
*/

////////////////////////////////////////////////////////////////////////////////
static void
usage()
{
fprintf(stderr, "Usage: %s <vmxpath>\n", progName);
fprintf(stderr, "%s\n", VMXPATH_INFO);
}



////////////////////////////////////////////////////////////////////////////////
int
main(int argc, char **argv)
{
VixError err;
char *vmxPath;
VixHandle hostHandle = VIX_INVALID_HANDLE;
VixHandle jobHandle = VIX_INVALID_HANDLE;
VixHandle vmHandle = VIX_INVALID_HANDLE;

progName = argv[0];
if (argc > 1) {
vmxPath = argv[1];
} else {
usage();
exit(EXIT_FAILURE);
}

jobHandle = VixHost_Connect(VIX_API_VERSION,
CONNTYPE,
HOSTNAME, // *hostName,
HOSTPORT, // hostPort,
USERNAME, // *userName,
PASSWORD, // *password,
0, // options,
VIX_INVALID_HANDLE, // propertyListHandle,
NULL, // *callbackProc,
NULL); // *clientData);
err = VixJob_Wait(jobHandle, 
VIX_PROPERTY_JOB_RESULT_HANDLE, 
&hostHandle,
VIX_PROPERTY_NONE);
if (VIX_FAILED(err)) {
goto abort;
}

Vix_ReleaseHandle(jobHandle);
jobHandle = VixVM_Open(hostHandle,
vmxPath,
NULL, // VixEventProc *callbackProc,
NULL); // void *clientData);
err = VixJob_Wait(jobHandle, 
VIX_PROPERTY_JOB_RESULT_HANDLE, 
&vmHandle,
VIX_PROPERTY_NONE);
if (VIX_FAILED(err)) {
goto abort;
}

Vix_ReleaseHandle(jobHandle);
jobHandle = VixVM_PowerOn(vmHandle,
VMPOWEROPTIONS,
VIX_INVALID_HANDLE,
NULL, // *callbackProc,
NULL); // *clientData);
err = VixJob_Wait(jobHandle, VIX_PROPERTY_NONE);
if (VIX_FAILED(err)) {
goto abort;
}

Vix_ReleaseHandle(jobHandle);
jobHandle = VixVM_PowerOff(vmHandle,
VIX_VMPOWEROP_NORMAL,
NULL, // *callbackProc,
NULL); // *clientData);
err = VixJob_Wait(jobHandle, VIX_PROPERTY_NONE);
if (VIX_FAILED(err)) {
goto abort;
}

abort:
Vix_ReleaseHandle(jobHandle);
Vix_ReleaseHandle(vmHandle);

VixHost_Disconnect(hostHandle);

return 0;
}



/*If you have obtained this sample code as part of the VMware Server 1.0 SDK, or are using this sample code in conjunction with the VMware Server 1.0 SDK, the license terms of that SDK will govern your use of this sample code.

Otherwise, the sample code is provided "AS-IS" for use, modification, and redistribution in source and binary forms, provided that the copyright notice and this following list of conditions are retained and/or reproduced in your distribution. To the maximum extent permitted by law, VMware, Inc., its subsidiaries and affiliates hereby disclaim all express, implied and/or statutory warranties, including duties or conditions of merchantability, fitness for a particular purpose, and non-infringement of intellectual property rights. IN NO EVENT WILL VMWARE, ITS SUBSIDIARIES OR AFFILIATES BE LIABLE TO ANY OTHER PARTY FOR THE COST OF PROCURING SUBSTITUTE GOODS OR SERVICES, LOST PROFITS, LOSS OF USE, LOSS OF DATA, OR ANY INCIDENTAL, CONSEQUENTIAL, DIRECT, INDIRECT, OR SPECIAL DAMAGES, ARISING OUT OF THIS OR ANY OTHER AGREEMENT RELATING TO THE SAMPLE CODE.

You agree to defend, indemnify and hold harmless VMware, and any of its directors, officers, employees, agents, affiliates, or subsidiaries from and against all losses, damages, costs and liabilities arising from your use, modification and distribution of the sample code.

VMware does not certify or endorse your use of the sample code, nor is any support or other service provided in connection with the sample code.*/

queryVMsCreated.pl

Tue, 22 Sep 2009 04:27:32 GMT

Script to query when VM(s) were created (cloned, deployed or created).

Requirements:
ESX(i) 3.5 or 4.0 & vCenter 2.5 or 4.0 (vCenter is a requirement)
vSphere SDK for Perl or vMA 4.0

Sample Execution:

[vi-admin@scofield ~]$ ./queryVMsCreated.pl --server reflex.primp-industries.com --username primp

Enter password:
VM                                                                                      | TIME                          | USERNAME
Created virtual machine vm-1 on esxi40-1.primp-industries.com in Primp-R&D              | 2009-09-21T00:29:24.576999Z   | root
Created virtual machine vm-2 on esxi40-1.primp-industries.com in Primp-R&D              | 2009-09-21T00:29:09.362999Z   | root
Created virtual machine test on esx40-2.primp-industries.com in Primp-R&D               | 2009-09-20T23:46:06.04Z       | PRIMP-IND\primp
Created virtual machine rdm-vm on himalaya.primp-industries.com in Primp-Production     | 2009-09-20T20:58:56.807Z      | PRIMP-IND\primp
Created virtual machine test on esxi40-1.primp-industries.com in Primp-R&D              | 2009-09-20T20:03:22.413Z      | PRIMP-IND\primp
Created virtual machine PROTECT-ME-PLEASE on esxi40-1.primp-industries.com in Primp-R&D | 2009-09-18T23:01:59.149999Z   | PRIMP-IND\primp
Created virtual machine ESXi40-1 on himalaya.primp-industries.com in Primp-Production   | 2009-09-18T20:58:52.353Z      | PRIMP-IND\primp

listDatastoreFiles.pl

Mon, 21 Sep 2009 16:58:17 GMT

This script lists the contents of a specific datastore on ESX(i) and all subsequent folders providing the fileName, owner, fileSize and the type of file. In the current form, the script is to be executed against a specific ESX(i) host, but can be extended to query against a vCenter host, I will leave that as an additional exercise for end users.

Requirements:
ESX(i) 3.5 or 4.0
vSphere SDK for Perl or vMA 4.0

Sample Execution:

[vi-admin@scofield ~]$ ./listDatastoreFiles.pl --server esxi40-1.primp-industries.com --username root --datastore esxi40-1-local-storage
Enter password:

Name                                    Owner                                   Size                    Type
vm-1                                     | root                              | 1.50 KB              | FolderFileInfo
vm-2                                     | root                              | 980 Bytes            | FolderFileInfo
vm-1.vmx                                 | root                              | 2.63 KB              | VmConfigFileInfo
vm-1.vmdk                                | root                              | 0                    | VmDiskFileInfo
vm-1.nvram                               | root                              | 8.48 KB              | VmNvramFileInfo
vmware-1.log                             | root                              | 31.62 KB             | VmLogFileInfo
vmware.log                               | root                              | 30.81 KB             | VmLogFileInfo
vm-1.vmxf                                | root                              | 259 Bytes            | FileInfo
vm-1.vmsd                                | root                              | 0                    | FileInfo
vm-1-13e373e7.vswp                       | root                              | 1.00 GB              | FileInfo
vm-2.vmx                                 | root                              | 1.73 KB              | VmConfigFileInfo
vm-2.vmdk                                | root                              | 0                    | VmDiskFileInfo
vm-2.vmxf                                | root                              | 259 Bytes            | FileInfo
vm-2.vmsd                                | root                              | 0                    | FileInfo

getAllVMsDiskFormatType.pl

Mon, 14 Sep 2009 22:14:55 GMT

Script to retrieve VMs disk format type, specifically either 'thick' or 'thin' from either an ESX(i) host or vCenter.

Requirements:
ESX(i) 3.5 or 4.0
vCenter 2.5 or 4.0
VIMA 1.0 or vMA 4.0
VI Perl Toolkit or vSphere SDK for Perl

Sample Execution:

[vi-admin@scofield ~]$ ./getAllVMsDiskFormatType.pl --server himalaya.primp-industries.com --username root 
Enter password:

vm-1
=============================================
[himalaya-local-storage-1] vm-1/vm-1.vmdk isThinProv: NO
=============================================

vm-2
=============================================
[himalaya-local-storage-1] vm-2/vm-2.vmdk isThinProv: NO
=============================================

vm-3
=============================================
[himalaya-local-storage-2] vm-3/vm-3.vmdk isThinProv: YES
=============================================

Sample to perform Netwoking related operations on VM NICs

Mon, 14 Sep 2009 20:58:28 GMT

Usage:
java VMNetworkingOps <server> <username> <password> <vmName> <print|add|change> <portGroupName> <adpaterType|vmNicNames>

Case 1:
Print the VMNic details (name, and the port group it is connected to)

Input:
https://10.20.140.47/sdk root password vMATemplate_vMAClone1 print

Output:

VM Name: vMATemplate_vMAClone1
MOR Type : VirtualMachine
ObjectContent Length : 1
config.hardware : com.vmware.vim25.VirtualHardware@98f2c13f
*******************************************************
vmnic Info (Label) : Network adapter 1
vmnic Port Group: VM Network

vmnic Info (Label) : Network adapter 2
vmnic Port Group: VM Network

vmnic Info (Label) : Network adapter 3
vmnic Port Group: PGroup1

vmnic Info (Label) : Network adapter 4
vmnic Port Group: PGroup1

*******************************************************

################################################################################

Case 2:
Change the vmnic port group

Input:
https://10.20.140.47/sdk root password vMATemplate_vMAClone1 change "Network adapter 3,Network adapter 4" "VM Network"

Output:
VM Name: vMATemplate_vMAClone1
vmnic adapters: Network adapter 3
vmnic adapters: Network adapter 4
MOR Type : VirtualMachine
ObjectContent Length : 1
config.hardware : com.vmware.vim25.VirtualHardware@98f2c13f
vmnic Info (Label) : Network adapter 1
vmnic Info (Label) : Network adapter 2
vmnic Info (Label) : Network adapter 3
vmnic Info (Label) : Network adapter 4
Success: VM Reconfiguration
Successfully changed the portgroup for the vmnic adapters

################################################################################

Case 3:
Print the VMNic details (name, and the port group it is connected to)

Input:
https://10.20.140.47/sdk root password vMATemplate_vMAClone1 print

Output:

VM Name: vMATemplate_vMAClone1
MOR Type : VirtualMachine
ObjectContent Length : 1
config.hardware : com.vmware.vim25.VirtualHardware@54a1587f
*******************************************************
vmnic Info (Label) : Network adapter 1
vmnic Port Group: VM Network

vmnic Info (Label) : Network adapter 2
vmnic Port Group: VM Network

vmnic Info (Label) : Network adapter 3
vmnic Port Group: VM Network

vmnic Info (Label) : Network adapter 4
vmnic Port Group: VM Network

*******************************************************

################################################################################

Case 4:
Add vmnic to a VM, and assign it to the given port group

Input:
https://10.20.140.47/sdk root password vMATemplate_vMAClone1 add e1000 PGroup1

Output:

VM Name: vMATemplate_vMAClone1
MOR Type : VirtualMachine
Success: VM Reconfiguration
Successfully added a vmnic adapter to the VM

################################################################################

Case 5:
Print the VMNic details (name, and the port group it is connected to)

Input:
https://10.20.140.47/sdk root password vMATemplate_vMAClone1 print

Output:

VM Name: vMATemplate_vMAClone1
MOR Type : VirtualMachine
ObjectContent Length : 1
config.hardware : com.vmware.vim25.VirtualHardware@ee6e956
*******************************************************
vmnic Info (Label) : Network adapter 1
vmnic Port Group: VM Network

vmnic Info (Label) : Network adapter 2
vmnic Port Group: VM Network

vmnic Info (Label) : Network adapter 3
vmnic Port Group: VM Network

vmnic Info (Label) : Network adapter 4
vmnic Port Group: VM Network

vmnic Info (Label) : Network adapter 5
vmnic Port Group: PGroup1

*******************************************************

################################################################################

Case 6:
Remove vmnic from a VM

Input:
https://10.20.140.47/sdk root password vMATemplate_vMAClone1 remove "Network adapter 5"

Output:

VM Name: vMATemplate_vMAClone1
MOR Type : VirtualMachine
ObjectContent Length : 1
config.hardware : com.vmware.vim25.VirtualHardware@54a1587f
vmnic Info (Label) : Network adapter 1
vmnic Info (Label) : Network adapter 2
vmnic Info (Label) : Network adapter 3
vmnic Info (Label) : Network adapter 4

################################################################################

Case 7:
Print the VMNic details (name, and the port group it is connected to)

Input:
https://10.20.140.47/sdk root password vMATemplate_vMAClone1 print

executeCommandUsingFastPass.pl

Sat, 12 Sep 2009 18:15:13 GMT

Execute vCLI/vSphere SDK for Perl scripts utilizing VMware vMA/VIMA vi-fastpass without user interaction or issuing vifpinit

Requirements:

Setup:
Here is the input file which contains the list of ESX(i) hosts that are being managed by VIMA/vMA

[vi-admin@scofield ~]$ cat hostlist
lazarus.primp-industries.com
kang.primp-industries.com

Here is just a dummy conf that is read in because of the default parsing/validation that is required for some of the perl modules that are written by default

[vi-admin@scofield ~]$ cat DUMMY_CONF
VI_USERNAME=dummy
VI_PASSWORD=dummy

Sample Execution:

Execute a vSphere SDK for Perl utility called viversion.pl across set of hosts:

[vi-admin@scofield ~]$ ./executeCommandUsingFastPass.pl --hostlist hostlist --config DUMMY_CONF
Executing viversion.pl on Server: lazarus.primp-industries.com 
================ RESULTS ================

This is  HostAgent 4.0

This is VMware ESX 4.0.0 build-164009 running on x86 ESX Server microkernel
The product Line ID is a unique identifier for a product line. This is VMware ESX Server product.

Short form of the product name is VMware ESX having version 4.0.0

System is running on x86 ESX Server microkernel


Executing viversion.pl on Server: kang.primp-industries.com
================ RESULTS ================

This is  HostAgent 2.5u2

This is VMware ESX Server 3i 3.5.0 build-110271 running on x86 ESX Server microkernel
The product Line ID is a unique identifier for a product line. product line id is embeddedEsx
Short form of the product name is VMware ESX Server 3i having version 3.5.0

System is running on x86 ESX Server microkernel

You can easily modify the script to execute additional commands or even write directly to the vSphere SDK for Perl and use the fastpass credentials to connect to your hosts.

getDatastoreUUID.pl

Fri, 11 Sep 2009 03:00:10 GMT

Retrieve datastore UUID from either ESX(i) host or vCenter.

Requirements:
ESX(i) 3.5 or 4.0
vCenter 2.5 or 4.0
vSphere SDK for Perl or vMA 4.0

Sample Execution:

[vi-admin@scofield ~]$ ./getDatastoreUUID.pl --server himalaya.primp-industries.com --username root --datastore himalaya-local-SAS.Constellation
Enter password:

Datastore: himalaya-local-SAS.Constellation     UUID: 4a30b278-33269041-4a07-003048d9586a

Host Profile Manager

Thu, 10 Sep 2009 22:10:07 GMT

getWWPN.pl

Wed, 09 Sep 2009 20:47:34 GMT

Script to extract WWPN from you vmhba's provided a list of ESX(i) hosts. This script could be re-written to query from a specific ESX(i) host but currently requires host to be connected and managed by vCenter. Useful script if you need to re-zone existing or new hosts

Requirements:
ESX(i) 3.5 or 4.0
vCenter 2.5 or 4.0
vSphere SDK for Perl or vMA 4.0

Sample Execution:

Input file which contains the list of ESX(i) hosts that is currently being managed by vCenter

[vi-admin@scofield ~]$ cat hosts
helga.primp-industries.com
bertha.primp-industries.com

Execute script against your vCenter that is managing the list of ESX(i) hosts

[vi-admin@scofield ~]$ ./getWWPN.pl --server refelex.primp-industries.com --username primp --list hosts
Enter password:

helga.primp-industries.com-vmhba1    10:00:00:00:c9:79:c9:84
helga.primp-industries.com-vmhba2    10:00:00:00:c9:79:c9:85
bertha.primp-industries.com-vmhba1    10:00:00:00:c9:7d:74:e8
bertha.primp-industries.com-vmhba2    10:00:00:00:c9:7d:74:e9

Server Hardware Health Monitoring - How to retrieve Health information using CIM / Perl

Thu, 03 Sep 2009 14:36:56 GMT

http://communities.vmware.com/docs/DOC-10665

Service status and email if down (as well as try to start it)

Mon, 31 Aug 2009 19:48:03 GMT

Here is a script I sorta came up with that checks common vmware services and then emails if any one of them aren't running (and trys to start them)(since our vsphere upgrade bombed a few times thanks to sql i was asked to try to write this), I am sure this has been done before and bits where taking from another place that I can't find again to give credit, so its not all mine, but somone might find this usefull, write back with questions or comments

Thanks!

getVMsResourcePools.pl

Mon, 31 Aug 2009 02:35:03 GMT

This script extracts all the Resource Pools for a given ESX(i) host or vCenter and provides a list of VMs under each resource pool. If you're not using any resource pools, then all VMs under a given host will be mapped to the root resource pool which is just called Resources

Requirements:
ESX(i) 3.5 or 4.0
vCenter 2.5 or 4.0
vSphere SDK for Perl or vMA 4.0

Sample Execution:

[vi-admin@scofield ~]$ ./getVMsResourcePools.pl --server reflex.primp-industries.com --username primp
Enter password:
Resource Pools:

Production -
        vm2
        sap2
        exchange2

Proof Of Concept -
        vm1
        sap1
        exchange1

Resources -
        vm01
        vm02
        vm03
        vm04

Retrieving Performance Statistics Info

Fri, 28 Aug 2009 23:04:59 GMT

This sample retrieves the performance statistics information using multi-threaded client program. It demonstrates using the best practices.

Usage:
java GetMultiPerfStats <host> <username> <password> <EntityName:EntityType[vm|host|rp|ccr]> <PerfGroup.PerfCounter.RollupType> [isCSVOutput]

################################################################################

Case 1:
Retrieved the past 1 hour samples (180 samples) for two entities.
One VM, and one Host. The VM is running on the specified Host.
All Perf stats are retrieved for each entity in one call, and for all entities
in one call. The times are recorded in both the cases.

Input:
https://10.20.140.70/sdk Administrator password ITSM701:vm,rkoganty-dev1.eng.vmware.com:host cpu,mem,net,disk,cpu.usagemhz.average,mem.overhead.average,net.packetsRx.summation,net.packetsTx.summation true

Output:

MOR Type : VirtualMachine

Managed entity: vm-27
Current supported: true
Refresh rate: 20
Summary supported: true

PerfCountersArr length: 8