Script Extracts and Examples (PowerCLI): Difference between revisions

From vwiki
Jump to navigation Jump to search
m (→‎Getting Started: Added Syntax Highlighting)
m (Typo fix)
 
(74 intermediate revisions by the same user not shown)
Line 1: Line 1:
== Getting Started ==
#REDIRECT [[:Category:PowerCLI]]
Before being able to use any the following script you need to install...
* [http://www.microsoft.com/windowsserver2003/technologies/management/powershell/download.mspx Windows PowerShell V1]
* [http://support.microsoft.com/kb/968929 Windows Powershell V2]
* [http://www.vmware.com/go/powershell VI Toolkit]
 
On the first run you need to allow the Toolkit to run properly by running (you need to run this command as an administrator, so if you're using Windows 7, for example, you'll need to start the Powershell console as an administrator, regardless of whether you're currently logged in as an admin)...
<source lang="powershell"> Set-ExecutionPolicy RemoteSigned </source>
 
Connect to the Virtual Centre (or ESX) server using the following command using your normal username and password (same as you'd use to log into the VI Client).  You will need access to the servers on TCP 443.
<source lang="powershell"> Connect-VIServer -Server <server> -User <user> -Password <pass> </source>
 
Once connected you can do real work with the PowerCLI, to see what's available, login to https://server/mob.  This is effectively where you end up once you've completed the <source lang="powershell"> Connect-VIServer </source> command.
 
Be aware that PowerShell commands generally return objects, rather than text, and that the textual representation of the return object is often abbreviated for simplicity.  To see the entire return for a command, pipe the result into <source lang="powershell">Format-List</source>.  To complicate matters further, some return objects contain further objects, see examples below
 
<source lang="powershell">
[vSphere PowerCLI] E:\> get-vm -name "winstg"
 
Name                PowerState Num CPUs Memory (MB)
----                ---------- -------- -----------
winstg              PoweredOn  1        756
 
 
[vSphere PowerCLI] E:\> get-vm -name "winstg" | Format-List *
 
PowerState          : PoweredOn
Description        :
Guest              : VMware.VimAutomation.Client20.VMGuestImpl
NumCpu              : 1
MemoryMB            : 756
CDDrives            : {CD/DVD Drive 1}
FloppyDrives        : {Floppy Drive 1}
HardDisks          : {Hard Disk 1}
NetworkAdapters    : {Network Adapter 1}
Host                : uklonesxt1.datastream.com
HostId              : HostSystem-host-301
HARestartPriority  : ClusterRestartPriority
HAIsolationResponse : AsSpecifiedByCluster
DrsAutomationLevel  : AsSpecifiedByCluster
CustomFields        : {}
Id                  : VirtualMachine-vm-25136
Name                : winstg
 
 
[vSphere PowerCLI] E:\> get-vm -name "ukt1ewapilp1" | Format-List *
 
PowerState          : PoweredOff
Description        :
Guest              : VMware.VimAutomation.Client20.VMGuestImpl
NumCpu              : 2
MemoryMB            : 2048
CDDrives            : {CD/DVD Drive 1}
FloppyDrives        : {Floppy Drive 1}
HardDisks          : {Hard Disk 1}
NetworkAdapters    : {Network Adapter 1, Network Adapter 2, Network Adapter 3}
Host                : uklonesxtml1.datastream.com
HostId              : HostSystem-host-662
HARestartPriority  : ClusterRestartPriority
HAIsolationResponse : AsSpecifiedByCluster
DrsAutomationLevel  : AsSpecifiedByCluster
CustomFields        : {}
Id                  : VirtualMachine-vm-697
Name                : ukt1ewapilp1
 
 
[vSphere PowerCLI] E:\> get-vm -name "ukt1ewapilp1" | ForEach-Object {$_.NetworkAdapters}
 
MacAddress      : 00:50:56:89:40:59
WakeOnLanEnabled : True
NetworkName      : PubLBFE2_52.128
Type            : Flexible
ConnectionState  : VMware.VimAutomation.Client20.ConnectInfoImpl
Id              : VirtualMachine-vm-697/4000
Name            : Network Adapter 1
 
MacAddress      : 00:50:56:89:55:40
WakeOnLanEnabled : True
NetworkName      : PubLBBE1_52.192
Type            : Flexible
ConnectionState  : VMware.VimAutomation.Client20.ConnectInfoImpl
Id              : VirtualMachine-vm-697/4001
Name            : Network Adapter 2
 
MacAddress      : 00:50:56:89:56:da
WakeOnLanEnabled : True
NetworkName      : PubHostBE2_49.192
Type            : Flexible
ConnectionState  : VMware.VimAutomation.Client20.ConnectInfoImpl
Id              : VirtualMachine-vm-697/4002
Name            : Network Adapter 3
</source>
 
== Useful CmdLets etc ==
=== Virtual Machine ===
 
{|cellpadding="2" cellspacing="0" border="1"
! Command    !! Description
|-
| <code> get-vm </code>
| Get list of VM's
|-
| <code> get-vm <nowiki>|</nowiki> sort -property Name </code>
| Get list of VM's, sorted by name
|-
| <code> get-vmguest -VM (get-vm -name "winstg") </code>
| Get VM guest info (IP address, OS)
|-
| <code> Get-VM "winstg" <nowiki>|</nowiki> %{(Get-View $_.Id).config.uuid} </code>
| Get VM's UUID
|-
| <code> Shutdown-VMGuest -VM (get-vm -name "winstg") </code>
| Sends OS shutdown command via VM Tools
|}
 
=== ESX Host ===
 
{|cellpadding="2" cellspacing="0" border="1"
! Command    !! Description
|-
| <code> get-vmhost -name uklonesxt1* <nowiki>|</nowiki> %{(Get-View $_.ID).Config.Product} </code>
| Get ESX software version (inc build no)
|-
| <code> Get-ScsiLun -VMHost uklonesxt1* -LunType disk </code>
| Get ESX disk VML ID's (SAN ID are a part of the VML - useful for identifying LUN's with SAN team)
|-
| <code> Get-ScsiLun -VMHost uklonesxt1* -LunType disk <nowiki>|</nowiki> Get-ScsiLunPath </code>
| Get ESX SCSI paths info
|}
 
== Performance Statistics ==
The full wealth of performance metrics that are collated by virtual centre are available via the PowerCLI.  This can be very useful for creating custom reports, feeding data into other tools etc.
 
It's important to understand how ESX's generate and manage performance data before going any further...
# An ESX collects performance metrics every 20 sec (know as the Realtime interval), this is retained on the server for 1 hour.
# The ESX rolls the Realtime data up into 5 min interval data
#* [Stand-alone ESX] This 5 min data is retained for 1 day
#* [VC managed ESX] The data is uploaded to the VC database
 
Once in the Virtual Centre database, the data is then rolled up into Historical Interval tables via SQL jobs...
* 5 min interval, 1 day retention
* 30 min interval, 1 week retention
* 2 hr interval, 1 month retention
* 1 day interval, 1 year retention
 
Note that the following are configurable (to a varying degree) via the VI Client.
* The VC rollup intervals and retention periods
* The statistics depth (typically certain metrics are discarded as the retention period grows)
 
To see the available intervals for which metrics are available, use the following command (the results will vary depending on whether you're connected to an ESX or a Virtual Centre).
<source lang="powershell">[vSphere PowerCLI] E:\> Get-StatInterval
 
Name                          SamplingPeriodSecs          StorageTimeSecs Client
----                          ------------------          --------------- ------
Past Day                                      300                    86400 VMware.VimAutomation....
Past Week                                    1800                  604800 VMware.VimAutomation....
Past Month                                  7200                  2592000 VMware.VimAutomation....
Past Year                                  86400                31536000 VMware.VimAutomation....</source>
 
=== Available Metrics ===
Metrics are available for each of the following types of object
* Virtual Machines
* Virtual machines Hosts (ESX's)
* Resource Pools
* Datastores
 
The easiest way to ascertain what metric is available for what object is to use Get-StatType...
<source lang="powershell">[vSphere PowerCLI] E:\> Get-vm "winstg" | Get-StatType
cpu.usage.average
cpu.usagemhz.average
mem.usage.average
mem.granted.average
mem.active.average
mem.shared.average
mem.zero.average
mem.swapped.average
mem.swaptarget.average
mem.swapin.average
mem.swapout.average
mem.vmmemctl.average
mem.vmmemctltarget.average
mem.overhead.average
disk.usage.average
net.usage.average
sys.uptime.latest
sys.heartbeat.summation
mem.consumed.average
 
[vSphere PowerCLI] E:\> Get-vmHost "uklonesxt1*" | Get-StatType
cpu.usage.average
cpu.usagemhz.average
mem.usage.average
mem.granted.average
mem.active.average
mem.shared.average
mem.zero.average
mem.unreserved.average
mem.swapused.average
mem.sharedcommon.average
mem.heap.average
mem.heapfree.average
mem.state.latest
mem.swapin.average
mem.swapout.average
mem.vmmemctl.average
mem.overhead.average
disk.usage.average
net.usage.average
sys.uptime.latest
clusterServices.cpufairness.latest
clusterServices.memfairness.latest
cpu.reservedCapacity.average
mem.reservedCapacity.average
mem.consumed.average
mem.sysUsage.average</source>
 
== Script Extracts ==
=== VM's with Datastores List ===
List of Virtual Machines, and their datastores (with usage)
$datastoreExp = @{N="Datastore"; E={ ($_ | get-datastore | select-object -first 1).Name }}
$diskSizeExp = @{N="Total Disk"; E={ ($_ | get-harddisk | measure-object -property CapacityKB -sum).Sum }}
get-vm | select Name, $datastoreExp, $diskSizeExp | sort -property Datastore,"Total Disk"
 
=== VM's with Host and Cluster List ===
$vms = Get-VM | sort -property Name
foreach ($vm in $vms)
{
$vm | Get-Cluster | Select-Object @{Name="VM"; Expression={$vm.name}},@{Name="Current Host"; Expression={$vm.host}},Name
}
 
=== VM's Inventory CSV ===
 
<pre>
$start = Get-Date
 
# Create table for output
# Name DC OS UUID IP Cluster ESX's
 
$table = New-Object system.Data.DataTable "Results"
 
$col1 = New-Object system.Data.DataColumn Name,([string])
$col2 = New-Object system.Data.DataColumn DC,([string])
$col3 = New-Object system.Data.DataColumn OS,([string])
$col4 = New-Object system.Data.DataColumn UUID,([string])
$col5 = New-Object system.Data.DataColumn MgmtIP,([string])
$col6 = New-Object system.Data.DataColumn Cluster,([string])
#$col7 = New-Object system.Data.DataColumn ESXs,([string])
 
$table.columns.add($col1)
$table.columns.add($col2)
$table.columns.add($col3)
$table.columns.add($col4)
$table.columns.add($col5)
$table.columns.add($col6)
#$table.columns.add($col7)
 
$duration = (New-TimeSpan $start (Get-Date)).TotalSeconds
"Created table after $duration secs"
 
# Get VMs object
$vms = Get-VM | Sort -property Name
 
$duration = (New-TimeSpan $start (Get-Date)).TotalSeconds
"Got object list of VM's after $duration secs"
 
foreach ($vm in $vms)
{
$row = $table.NewRow()
$row.Name = (Get-VM -Name $vm).Name
$row.DC = (Get-Datacenter -VM $vm).Name
$row.OS = (Get-VMGuest -VM $vm).OSFullName
$row.UUID = %{(Get-View $vm.Id).config.uuid}
$row.MgmtIP =  [string]::join(" ", ((Get-VMGuest -VM $vm).IPAddress)) # Need to join potential list of IP's
$row.Cluster = (Get-Cluster -VM $vm).Name
$table.Rows.Add($row)
"Added row for $vm"
}
 
$duration = (New-TimeSpan $start (Get-Date)).TotalSeconds
"Populated table after $duration secs"
 
$table | Format-Table
$table | Export-Csv -path result.csv
</pre>
 
 
[[Category:VMware]]
[[Category:PowerShell]]

Latest revision as of 15:36, 4 October 2016

Redirect to:

Retrieved from ‘http://vwiki.co.uk/index.php?title=Script_Extracts_and_Examples_(PowerCLI)&oldid=2645’