plugins/vmware/src/Plugin.ps1

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
Function Global:Get-vClusterCapacity {
    <#
    .SYNOPSIS
 
        Connect to vSphere vCenter Server and return the vSphere Cluster and
        vSphere SDRS Cluster resources capacity information.
     
    .DESCRIPTION
 
        Allows the administrator to connect to vSphere vCenter Server and
        retrieve the cluster resources capacity information based on
        calculating the actual resources capacity, usable available resources
        capacity, consumed resources capacity, virtual vs physical resource ratio
        and overcommit percentage.
     
    .PARAMETER vCenterName
         
        Specify VMware vSphere vCenter Hostname
         
    .PARAMETER Username
         
        Specify the Username for VMware vSphere vCenter Server
             
    .PARAMETER Password
         
        Specify the Password for VMware vSphere vCenter Server
     
    .PARAMETER Cluster
         
        Specify the VMware vSphere Cluster Name
     
    .PARAMETER DatastoreCluster
         
        Specify the VMware vSphere Datastore Cluster Name
             
    .EXAMPLE
     
        C:\> Import-Module `
                -Global D:\Temp\Get-vClusterCapacity.psm1 ;
 
        C:\> Get-vClusterCapacity `
                -vCenterName vCenter.vmware.local `
                -Cluster vSphereCluster `
                -DatastoreCluster vSphere_Datastore_Cluster `
                -Username vmware.local\username `
                -Password Password123 ;
    .INPUTS
 
        The Get-vClusterCapacity Cmdlet will accept all string inputs from pipeline.
 
    .OUTPUTS
 
        The Get-vClusterCapacity Cmdlet will output following details below:
 
        Cluster Name : vSphereCluster
        Cluster ESXi Host Names : {vsphere-esx022.vmware.local,
                                                                    vsphere-esx057.vmware.local,
                                                                    vsphere-esx038.vmware.local,
                                                                    vsphere-esx051.vmware.local...}
        Cluster CPU Cores : 96
        Cluster Total Allocated vCPUs : 537
        Cluster Total PoweredOn vCPUs : 315
        Cluster Total PoweredOff vCPUs :
        Cluster vCPU/Core Ratio : 3.281
        Cluster CPU Overcommit (%) : 228.125
        Cluster Physical RAM (GB) : 1535.59
        Cluster Total Allocated vRAM (GB) : 1792.98
        Cluster Total PoweredOn vRAM (GB) : 1063
        Cluster vRAM/Physical RAM Ratio : 0.692
        Cluster RAM Overcommit (%) : -30.78
        Datastore Cluster Name : vSphere_Datastore_Cluster
        Datastore Cluster Datastore Names : {vSphere_Datastore_VMFS0001_00, vSphere_Datastore_VMFS0001_01,
                                                                    vSphere_Datastore_VMFS0001_02, vSphere_Datastore_VMFS0001_03...}
        Datastore Cluster Capacity (GB) : 47098.25
        Datastore Cluster Reservation (GB) : 4709.82
        Datastore Cluster Usable Capacity (GB) : 42388.42
        Datastore Cluster PoweredOn Guest Used Space (GB) : 18885.69
        Datastore Cluster PoweredOff Guest Used Space (GB) : 28212.56
        Datastore Cluster Used Space (GB) : 31410.96
        Datastore Cluster Provisioned Space (GB) : 32197.46
        Datastore Cluster Provisioned / Capacity Ratio : 0.684
        Datastore Cluster Provisioned / Capacity Ratio - Reservation : 0.76
        Datastore Cluster Storage Overcommit (%) : -31.64
 
    .COMPONENT
 
        This Get-vClusterCapacity Cmdlet requires VMware PowerCLI to be installed in order to provide the PowerShell capabilities to
        connect to vSphere vCenter and interrogate the environment.
         
    .NOTES
     
        Title : PowerShell Get VMWare vSphere Cluster and Datastore Cluster Capacity
        FileName: Get-vClusterCapacity.psm1
        Author : Ryen Kia Zhi Tang
        Date : 22/06/2016
        Blog : ryentang.wordpress.com
        Version : 1.0
 
    .LINK
 
        Microsoft TechNet Gallery - Get-vClusterCapacity Cmdlet for VMware vSphere vCenter: https://gallery.technet.microsoft.com/Get-vClusterCapacity-a2ab9755
         
    #>
 
    Param( 

        [Parameter( 
            Mandatory=$True, 
            ValueFromPipeline=$True, 
            ValueFromPipelineByPropertyName=$True)] 
        [Alias('VIServer')] 
        [String] $vCenterName = $env:COMPUTERNAME ,

        [Parameter( 
            Mandatory=$True, 
            ValueFromPipeline=$True, 
            ValueFromPipelineByPropertyName=$True)] 
        [Alias('U')] 
        [String] $Username, 

        [Parameter( 
            Mandatory=$True, 
            ValueFromPipeline=$True, 
            ValueFromPipelineByPropertyName=$True)] 
        [Alias('P')] 
        [String] $Password, 

        [Parameter( 
            Mandatory=$True, 
            ValueFromPipeline=$True, 
            ValueFromPipelineByPropertyName=$True)] 
        [Alias('HClu')] 
        [String] $Cluster, 

        [Parameter( 
            Mandatory=$True, 
            ValueFromPipeline=$True, 
            ValueFromPipelineByPropertyName=$True)] 
        [Alias('DataClu')] 
        [String] $DatastoreCluster

    ) ;

    BEGIN {

        # Display progress
        Write-Progress `
            -Id 1 `
            -Activity 'Working on adding VMware PowerCLI PSSnapin...' `
            -Status 'Validating VMware PowerCLI is installed.' ;

        if((Get-PSSnapin -Name VMware.VIMAutomation.Core -Registered) -ne (Out-Null)) {

            # Display progress
            Write-Progress `
                -Id 1 `
                -Activity 'Working on adding VMware PowerCLI PSSnapin...' `
                -Status 'Adding VMware PowerCLI PSSnapin. Please wait...' ;

            Try {

                # Add VMware PowerShell CLI Snapin
                Add-PSSnapin `
                    -Name VMware.VIMAutomation.Core `
                    -ErrorAction Stop ;
            
            }Catch{
                
                Write-Host 'Oops. Something went wrong. Please kindly ensure that VMware PowerCLI is installed properly.' `
                    -ForegroundColor Red ;

                Return (Out-Null) ;
            
            } ;
            
            # Display progress
            Write-Progress `
                -Id 1 `
                -Activity 'Working on adding VMware PowerCLI PSSnapin...' `
                -Status 'Added VMware PowerShell CLI Snapin.' ;

        }else{

            # Display progress
            Write-Progress `
                -Id 1 `
                -Activity 'Working on adding VMware PowerCLI PSSnapin...' `
                -Status 'Adding VMware PowerShell CLI PSSnapin failed. VMware.VIMAutomation.Core is not registered.' `
                -Completed ;

            Write-Host 'Please kindly ensure that VMware PowerCLI is installed' `
                -ForegroundColor Red ;

            Exit ;

        } ;

        # Create an array collection to store information for each individual ESXi host
        $ClusterPropertiesCollection = @() ;


        # Display progress
        Write-Progress `
            -Id 1 `
            -Activity 'Working on connecting to vCenter Server...' `
            -Status ('Attempting to connect to vCenter Server [' + $vCenterName + ']. Please wait...') ;

        # Connect to vSphere vCenter
        $ObjConnection = Connect-VIServer `
                            -Server $vCenterName `
                            -User $Username `
                            -Password $Password ;

        if($ObjConnection.IsConnected -eq "True") {

            # Display progress
            Write-Progress `
                -Id 1 `
                -Activity 'Working on connecting to vCenter Server...' `
                -Status ('Connected to vCenter Server [' + $vCenterName + ']') ;

        }else{

            # Display progress
            Write-Progress `
                -Id 1 `
                -Activity 'Working on connecting to vCenter Server...' `
                -Status ('Connection to vCenter Server [' + $vCenterName + '] failed') `
                -Completed ;

            Write-Host 'Please kindly ensure that VMware vCenter Server is available' `
            -ForegroundColor Red ;

            Exit ;

        } ;

    } ;

    PROCESS {
        
        # Display progress
        Write-Progress `
            -Id 1 `
            -Activity 'Working on collecting ESXi Hosts information...' `
            -Status 'Attempting to collect ESXi Hosts properties. Please wait...' ;

        # Get a collection of ESXi hosts properties within the cluster
        $VMhosts = Get-Cluster `
                        -Name $Cluster | `
                            Get-VMHost ;
        
        if($VMhosts -ne (Out-Null)) {

            # Display progress
            Write-Progress `
                -Id 1 `
                -Activity 'Working on collecting ESXi Hosts information...' `
                -Status 'Collected ESXi Hosts properties' ;
        
        }else{

            # Display progress
            Write-Progress `
                -Id 1 `
                -Activity 'Working on collecting ESXi Hosts information...' `
                -Status 'Collecting ESXi Hosts properties failed. Found no ESXi Host in Cluster.' `
                -Completed ;
            
            # Exit
            Return (Out-Null) ;

        } ;

        # Create an array collection to store information for each individual ESXi host
        $VMHostPropertiesCollection = @() ;


        # Display progress
        Write-Progress `
            -Id 1 `
            -Activity 'Working on each ESXi Host information...' `
            -Status 'Calculating every ESXi Host capacity. Please wait...' ;

        ForEach($VMhost in $VMhosts) {
            
            # Progress Bar
            $intProgressCount++ ;
            
            # Display progress
            Write-Progress `
                -Id 100 `
                -ParentId 1 `
                -Activity 'Working on each ESXi Host information...' `
                -Status ('Calculating each ESXi Host [' + $VMhost.Name + '] capacity. Please wait...') `
                -PercentComplete (($intProgressCount/($VMhosts | Measure-Object).Count)*100) `
                -CurrentOperation ([String] ([Math]::Round(($intProgressCount/($VMhosts | Measure-Object).Count)*100, 2)) + '% complete') ;

            # Get total amount of Powered On VM guest vCPUs per host
            $VMHostTotalPoweredOnVMGuestvCPUs = (Get-VM `
                                                    -Location $VMhost | `
                                                        Where-Object { $_.PowerState -eq "PoweredOn" } | `
                                                            Measure-Object NumCpu -Sum).Sum ;
        
            $VMHostPhysicalRAM = [Math]::Round($VMhost.MemoryTotalGB, 2) ;

            $VMHostTotalPoweredOnVMGuestvRAM = [Math]::Round((Get-VM `
                                                    -Location $VMhost | `
                                                        Where-Object { $_.PowerState -eq "PoweredOn" } | `
                                                            Measure-Object MemoryGB -Sum).Sum, 2) ;


            # Construct the properties for our custom object
            $VMHostProperties = `
                    @{

                    'ESXi Hostname' = $VMhost.Name ;
                
                    'CPU Cores' = $VMhost.NumCpu ;

                    'Total Allocated vCPUs' = (Get-VM `
                                                    -Location $VMhost | `
                                                        Measure-Object NumCpu -Sum).Sum ;

                    'Total PoweredOn vCPUs' = If($VMHostTotalPoweredOnVMGuestvCPUs) { `
                                                $VMHostTotalPoweredOnVMGuestvCPUs ; `
                                                } Else { [Int] "0" ; } ;
                
                    'vCPU/Core Ratio' = If($VMHostTotalPoweredOnVMGuestvCPUs) { `
                                            [Math]::Round(($VMHostTotalPoweredOnVMGuestvCPUs / $VMhost.NumCpu), 3) ; `
                                        } Else { Out-Null ; } ;

                    'CPU Overcommit (%)' = If($VMHostTotalPoweredOnVMGuestvCPUs) { `
                                                [Math]::Round(100*(($VMHostTotalPoweredOnVMGuestvCPUs - $VMhost.NumCpu) / $VMhost.NumCpu), 3) ; `
                                            } Else { Out-Null ; } ;

                    'Physical RAM (GB)' = $VMHostPhysicalRAM ;

                    'Total Allocated vRAM (GB)' = [Math]::Round((Get-VM `
                                                                    -Location $VMhost | `
                                                                    Measure-Object MemoryGB -Sum).Sum, 2) ;

                    'Total PoweredOn vRAM (GB)' = If($VMHostTotalPoweredOnVMGuestvRAM) { `
                                                    $VMHostTotalPoweredOnVMGuestvRAM ; `
                                                    } Else { [Int] "0" ; } ;

                    'vRAM/Physical RAM Ratio' = If($VMHostTotalPoweredOnVMGuestvRAM) { `
                                                    [Math]::Round(($VMHostTotalPoweredOnVMGuestvRAM / $VMHostPhysicalRAM), 3) ; `
                                                } Else { Out-Null ; } ;

                    'RAM Overcommit (%)' = If($VMHostTotalPoweredOnVMGuestvRAM) { `
                                                [Math]::Round(100*(($VMHostTotalPoweredOnVMGuestvRAM - $VMHostPhysicalRAM) / $VMHostPhysicalRAM), 2) ; `
                                            } Else { Out-Null ; } ;

                    } ;

            # Construct a custom object contain the list of properties above
            $ObjVMHostProperties = New-Object `
                                        -TypeName PSObject `
                                        -Property $VMHostProperties ;

            # Store each ESXi Host properties to a collection
            $VMHostPropertiesCollection += $ObjVMHostProperties ;

            # Display progress
            Write-Progress `
                -Id 100 `
                -ParentId 1 `
                -Activity 'Working on each ESXi Host information...' `
                -Status ('Calculated ESXi Host [' + $VMhost.Name + '] capacity.') `
                -Completed ;

        } ;

        # Display progress
        Write-Progress `
            -Id 1 `
            -Activity 'Working on vSphere Cluster information...' `
            -Status ('Calculating Cluster [' + $Cluster + '] resource capacity. Please wait...') ;

        $ClusterTotalPoweredOnGuestvCPUs = (Get-VM `
                                                -Location $Cluster | `
                                                Where-Object { $_.PowerState -eq "PoweredOn" } | `
                                                Measure-Object NumCpu -Sum).Sum ;

        $ClusterTotalCPUCores = ($VMhosts | `
                                    Measure-Object NumCpu -Sum).Sum ;

        $ClusterTotalPoweredOnGuestvRAM = [Math]::Round((Get-VM `
                                                -Location $Cluster | `
                                                Where-Object { $_.PowerState -eq "PoweredOn" } | `
                                                Measure-Object MemoryGB -Sum).Sum, 2) ;

        $ClusterTotalPhysicalRAM = [Math]::Round(($VMhosts | `
                                            Measure-Object MemoryTotalGB -Sum).Sum, 2) ;

        # Display progress
        Write-Progress `
            -Id 1 `
            -Activity 'Working on vSphere Datastore Cluster information...' `
            -Status ('Calculating Datastore Cluster [' + $Cluster + '] resource capacity. Please wait...') ;
        
        $DatastoreClusterCapacity = [Math]::Round(((Get-DatastoreCluster `
                                            -Name $DatastoreCluster).CapacityGB | `
                                                Measure-Object -Sum).Sum, 2) ;

        $VMDatastoreProperties = Get-VM `
                                    -Datastore $DatastoreCluster ;

        $DatastoresProperties = Get-Datastore `
                                    -Location $DatastoreCluster ;

        $DatastoreClusterUsedSpace = [Math]::Round((($VMDatastoreProperties | Select -Expand UsedSpaceGB) | `
                                                Measure-Object -Sum).Sum, 2) ;

        $DatastoreClusterPoweredOnGuestUsedSpace = [Math]::Round((($VMDatastoreProperties | `
                                                Where-Object { $_.PowerState -eq "PoweredOn" } | Select -Expand UsedSpaceGB) | `
                                                Measure-Object -Sum).Sum, 2) ;

        $DatastoreClusterProvisionedSpace = [Math]::Round((($VMDatastoreProperties | Select -Expand ProvisionedSpaceGB) | `
                                                    Measure-Object -Sum).Sum, 2) ;

        # Building a custom object specific to the -Cluster parameter
        $ClusterProperties = [Ordered] `
                @{

                'Cluster Name' = $Cluster ;

                'Cluster ESXi Host Names' = $VMHostPropertiesCollection.'ESXi Hostname' ;
            
                'Cluster CPU Cores' = $ClusterTotalCPUCores ;
            
                'Cluster Total Allocated vCPUs' = ($VMHostPropertiesCollection.'Total Allocated vCPUs' | `
                                                    Measure-Object -Sum).Sum ;
            
                'Cluster Total PoweredOn vCPUs' = If($ClusterTotalPoweredOnGuestvCPUs) { `
                                                    $ClusterTotalPoweredOnGuestvCPUs ; `
                                                    } Else { [Int] "0" ; } ;

                'Cluster Total PoweredOff vCPUs' = If($ClusterTotalPoweredOnGuestvCPUs) { `
                                                    (($VMHostPropertiesCollection.'Total Allocated vCPUs' | `
                                                        Measure-Object -Sum).Sum - $ClusterTotalPoweredOnGuestvCPUs) ; `
                                                    } Else { [Int] "0" ; } ;

                'Cluster vCPU/Core Ratio' = If($ClusterTotalPoweredOnGuestvCPUs) { `
                                                [Math]::Round(($ClusterTotalPoweredOnGuestvCPUs / $ClusterTotalCPUCores), 3) ; `
                                            } Else { Out-Null ; } ;

                'Cluster CPU Overcommit (%)' = If($ClusterTotalPoweredOnGuestvCPUs) { `
                                                    [Math]::Round(100*(( $ClusterTotalPoweredOnGuestvCPUs - $ClusterTotalCPUCores) / $ClusterTotalCPUCores), 3) ; `
                                                } Else { Out-Null ; } ;

                'Cluster Physical RAM (GB)' = $ClusterTotalPhysicalRAM ;

                'Cluster Total Allocated vRAM (GB)' = [Math]::Round(($VMHostPropertiesCollection.'Total Allocated vRAM (GB)' | `
                                                        Measure-Object -Sum).Sum, 2) ;
            
                'Cluster Total PoweredOn vRAM (GB)' = If($ClusterTotalPoweredOnGuestvRAM) { `
                                                        $ClusterTotalPoweredOnGuestvRAM `
                                                        } Else { [Int] "0" ; } ;

                'Cluster vRAM/Physical RAM Ratio' = If($ClusterTotalPoweredOnGuestvRAM) { `
                                                        [Math]::Round(($ClusterTotalPoweredOnGuestvRAM / $ClusterTotalPhysicalRAM), 3) ; `
                                                    } Else { Out-Null ; } ;
            
                'Cluster RAM Overcommit (%)' = If($ClusterTotalPoweredOnGuestvRAM) { `
                                                    [Math]::Round(100*(( $ClusterTotalPoweredOnGuestvRAM - $ClusterTotalPhysicalRAM) / $ClusterTotalPhysicalRAM), 2) ; `
                                                } Else { Out-Null ; } ;
            
                'Datastore Cluster Name' = $DatastoreCluster ;

                'Datastore Cluster Datastore Names' = $DatastoresProperties.Name ;

                'Datastore Cluster Capacity (GB)' = $DatastoreClusterCapacity ;
            
                'Datastore Cluster Reservation (GB)' = [Math]::Round(($DatastoreClusterCapacity * 0.1), 2) ;

                'Datastore Cluster Usable Capacity (GB)' = [Math]::Round(($DatastoreClusterCapacity - ($DatastoreClusterCapacity * 0.1)), 2) ;
                            
                'Datastore Cluster PoweredOn Guest Used Space (GB)' = $DatastoreClusterPoweredOnGuestUsedSpace ;

                'Datastore Cluster PoweredOff Guest Used Space (GB)' = [Math]::Round(($DatastoreClusterCapacity - $DatastoreClusterPoweredOnGuestUsedSpace), 2) ;

                'Datastore Cluster Used Space (GB)' = If($DatastoreClusterUsedSpace){ `
                                                        $DatastoreClusterUsedSpace ; `
                                                        } Else { [Int] "0" ; } ;
            
                'Datastore Cluster Provisioned Space (GB)' = If($DatastoreClusterProvisionedSpace) { `
                                                                $DatastoreClusterProvisionedSpace ; `
                                                                } Else { [Int] "0" ; } ;

                'Datastore Cluster Provisioned / Capacity Ratio' = If($DatastoreClusterProvisionedSpace) { `
                                                                        [Math]::Round(($DatastoreClusterProvisionedSpace / $DatastoreClusterCapacity), 3) ; `
                                                                    } Else { Out-Null ; } ;
                
                'Datastore Cluster Provisioned / Capacity Ratio - Reservation' = If($DatastoreClusterProvisionedSpace) { `
                                                                                    [Math]::Round(($DatastoreClusterProvisionedSpace / ($DatastoreClusterCapacity - ($DatastoreClusterCapacity * 0.1 ))), 3) ; `
                                                                                    } Else { Out-Null ; } ;

                'Datastore Cluster Storage Overcommit (%)' = If($DatastoreClusterProvisionedSpace) { `
                                                                [Math]::Round(100*(( $DatastoreClusterProvisionedSpace - $DatastoreClusterCapacity) / $DatastoreClusterCapacity), 2) ; `
                                                                } Else { Out-Null ; } ;

                } ;

        # Construct a custom object contain the list of properties above
        $ObjClusterProperties = New-Object `
                                    -TypeName PSObject `
                                    -Property $ClusterProperties ;

        #$ClusterPropertiesCollection += $ObjClusterProperties ;
        Return $ObjClusterProperties ;

    } ;

    END {

        # Disconnect from the vSphere vCenter
        Disconnect-VIServer `
            -Server $vCenterName `
            -Confirm:$False ;

        # Remove VMware PowerShell CLI Snapin
        Remove-PSSnapin `
            -Name VMware.VimAutomation.Core `
            -Confirm:$False ;

    } ;
}