Horizon - PowerCLI.ps1

<#
.SYNOPSIS
Samples Scripts Using the VMware Horizon API via PowerCLI
	
.NOTES
  Version:        1.0
  Author:         Chris Halstead - chalstead@vmware.com
  Creation Date:  7/18/2019
  Purpose/Change: Initial script development
 #>

#----------------------------------------------------------[Declarations]----------------------------------------------------------
[Net.ServicePointManager]::SecurityProtocol = [Net.SecurityProtocolType]::Tls12
#-----------------------------------------------------------[Functions]------------------------------------------------------------
Function LogintoHorizon {

#Capture Login Information
$script:HorizonServer = Read-Host -Prompt 'Enter the Horizon Server Name'
$Username = Read-Host -Prompt 'Enter the Username'
$Password = Read-Host -Prompt 'Enter the Password' -AsSecureString
$domain = read-host -Prompt 'Enter the Horizon Domain'

#Convert Password
$BSTR = [System.Runtime.InteropServices.Marshal]::SecureStringToBSTR($Password)
$UnsecurePassword = [System.Runtime.InteropServices.Marshal]::PtrToStringAuto($BSTR)

try {
    
    $script:hvServer = Connect-HVServer -Server $horizonserver -User $username -Password $UnsecurePassword -Domain $domain
    $script:hvServices = $hvServer.ExtensionData

    }

catch {
  Write-Host "An error occurred when logging on $_"
  break
}

write-host "Successfully Logged In"

} 

Function GetSessions {
    
    if ([string]::IsNullOrEmpty($hvServer))
    {
       write-host "You are not logged into Horizon"
        break   
       
    }
 
      
    try {

      $query = New-Object "Vmware.Hv.QueryDefinition"

      $query.queryEntityType = 'SessionLocalSummaryView'
      
      $qSrv = New-Object "Vmware.Hv.QueryServiceService"
      
      $sresult = $qSRv.QueryService_Query($hvServices,$query)
              
    }
    
    catch {
      Write-Host "An error occurred when getting sessions $_"
     break 
    }
    
  if ($sresult.results.count -eq 0)
   {
    write-host "No Sessions"
    break   
       
    }
  
write-host "Results will be logged to: "$sLogPath"\"$sLogName
write-host "There are" $sresult.results.Count "total sessions"

$sresult.Results | Format-table -AutoSize -Property @{Name = 'Username'; Expression = {$_.namesdata.username}},@{Name = 'Desktop Name'; Expression = {$_.namesdata.desktopname}},@{Name = 'Machine or RDS Server'; Expression = {$_.namesdata.machineorrdsservername}}`
,@{Name = 'Client Name'; Expression = {$_.namesdata.clientname}},@{Name = 'Client Type'; Expression = {$_.namesdata.clienttype}},@{Name = 'Client Version'; Expression = {$_.namesdata.clientversion}},@{Name = 'Client IP'; Expression = {$_.namesdata.clientaddress}}`
,@{Name = 'Session Type'; Expression = {$_.sessiondata.sessiontype}},@{Name = 'Session State'; Expression = {$_.sessiondata.sessionstate}},@{Name = 'Location'; Expression = {$_.namesdata.securitygatewaylocation}}
 
    
      } 

      
Function RebootDT {
    
if ([string]::IsNullOrEmpty($hvserver))
      {
        write-host "You are not logged into Horizon"
        break   
      }


GetMachines   

$thedesktop = Read-Host -Prompt 'Enter the Desktop Name'

if ($dtlookup.containskey($thedesktop) ) {
  
}

else {
  
write-host "Machine not found."
break

}

$dtencoded = $dtlookup[$thedesktop]

    Write-host "Would you like to reboot $thedesktop ? (Default is No)" -ForegroundColor Yellow 
    $Readhost = Read-Host " ( y / n ) " 
    Switch ($ReadHost) 
     { 
       Y {Write-host "Rebooting $thedesktop. This may take a few minutes.";Continue} 
       N {Write-Host "Doing Nothing"; break} 
       Default {Write-Host "Default, Do Nothing"; break} 
     } 
            
      try {
 
                   
            $hvServices.Machine.Machine_Reset($dtencoded)

            #$hvServer.Desktop_Refresh($dtencoded)
            
          }
        
        catch {
          Write-Host "An error occurred when logging on $_"
         break 
        }
        
               
}     
Function GetDtPools {
    
  if ([string]::IsNullOrEmpty($hvserver))
  {
     write-host "You are not logged into Horizon"
      break   
     
  }
      
  try {
   
    #Run PowerCLI Statements
   
    $query = New-Object "Vmware.Hv.QueryDefinition"

    $query.queryEntityType = 'DesktopSummaryView'

    $qSrv = New-Object "Vmware.Hv.QueryServiceService"

    $sresult = $qSRv.QueryService_Query($hvServices,$query)

    $qsrv.QueryService_Deleteall($hvservices)
         
    }
  
  catch {
    Write-Host "An error occurred when getting sessions $_"
    break 
  }
  
if ($sresult.results.Count -eq 0)
 {
  write-host "No Sessions"
  break   
     
  }
   
write-host "There are" $sresult.results.Count "pools"

$script:dtpool = @{}

foreach ($item in $sresult.Results) {

    $dtpool.add($item.DesktopSummaryData.name,$item.id)

}

$sresult.Results | Format-table -AutoSize -Property @{Name = 'Pool Name'; Expression = {$_.DesktopSummaryData.name}},@{Name = 'Enabled'; Expression = {$_.DesktopSummaryData.enabled}}`
,@{Name = 'Type'; Expression = {$_.DesktopSummaryData.type}},@{Name = 'Source'; Expression = {$_.DesktopSummaryData.source}}`
,@{Name = 'User Assignment'; Expression = {$_.DesktopSummaryData.userassignment}},@{Name = 'Machines'; Expression = {$_.DesktopSummaryData.nummachines}}`
,@{Name = 'Sessions'; Expression = {$_.DesktopSummaryData.numsessions}},@{Name = 'Deleting'; Expression = {$_.DesktopSummaryData.deleting}} 


} 

Function GetMachines {
    
        if ([string]::IsNullOrEmpty($hvserver))
        {
           write-host "You are not logged into Horizon"
            break   
           
        }
            
        try {
         
          #Run PowerCLI Statements
         
          $query = New-Object "Vmware.Hv.QueryDefinition"

          $query.queryEntityType = 'MachineNamesView'
      
          $qSrv = New-Object "Vmware.Hv.QueryServiceService"
      
          $sresult = $qSRv.QueryService_Query($hvServices,$query)

          $qsrv.QueryService_Deleteall($hvservices)
               
          }
        
        catch {
          Write-Host "An error occurred when getting sessions $_"
          break 
        }
        
      if ($sresult.results.Count -eq 0)
       {
        write-host "No Sessions"
        break   
           
        }
      
    $query = $sresult.id
         
    $killsession
    write-host "Results will be logged to: "$sLogPath"\"$sLogName
    write-host "There are" $sresult.results.Count "desktops"

  $script:dtlookup = @{}

  foreach ($item in $sresult.Results) {

    $dtlookup.add($item.base.name,$item.id)
  
}
    
    $sresult.Results | Format-table -AutoSize -Property @{Name = 'Machine'; Expression = {$_.base.name}},@{Name = 'Pool'; Expression = {$_.base.desktopname}},@{Name = 'OS'; Expression = {$_.base.operatingsystem}}`
    ,@{Name = 'Achitecture'; Expression = {$_.base.operatingsystemarchitecture}},@{Name = 'Agent Version'; Expression = {$_.base.agentversion}},@{Name = 'Status'; Expression = {$_.base.basicstate}}
         
          } 
Function GetCSInfo {

   
        if ([string]::IsNullOrEmpty($hvserver))
        {
           write-host "You are not logged into Horizon"
            break   
           
        }
    
                
        try {
            
             
          $cs = $hvservices.ConnectionServerHealth.ConnectionServerHealth_List()
    
       
          }
        
        catch {
          Write-Host "An error occurred when logging on $_"
          break 
        }
        
            $cs | Format-Table -AutoSize -Property @{Name = 'Connection Server'; Expression = {$_.Name}},@{Name = 'Status'; Expression = {$_.status}},@{Name = 'Version'; Expression = {$_.version}}`
            ,@{Name = 'Certificate Health'; Expression = {$_.certificatehealth.valid}}     
       
          } 
         
         
          Function GetUsage {

   
            if ([string]::IsNullOrEmpty($hvserver))
            {
               write-host "You are not logged into Horizon"
                break   
               
            }
        
                    
            try {
                
                 
              $usage = $hvservices.ConnectionServerHealth.ConnectionServerHealth_List()
                   
              }
            
            catch {
              Write-Host "An error occurred when logging on $_"
              break 
            }
            
                $usage | Format-List -Property @{Name = 'Connection Server'; Expression = {$_.Name}},@{Name = 'Connections'; Expression = {$_.connectiondata.numconnections}},@{Name = 'Max Connections'; Expression = {$_.connectiondata.numconnectionshigh}}`
                ,@{Name = 'Composer Connections'; Expression = {$_.connectiondata.numviewcomposerconnections}},@{Name = 'Max Composer Connections'; Expression = {$_.connectiondata.numviewcomposerconnectionshigh}},@{Name = 'Tunneled Connections'; Expression = {$_.connectiondata.numtunneledsessions}}`
                
           
              } 
 
Function GetApplications {

   
            if ([string]::IsNullOrEmpty($hvserver))
            {
               write-host "You are not logged into Horizon"
                break   
               
            }
        
         
               
            try {
                
              $query = New-Object "Vmware.Hv.QueryDefinition"
    
              $query.queryEntityType = 'ApplicationInfo'
          
              $qSrv = New-Object "Vmware.Hv.QueryServiceService"
          
              $sresult = $qSRv.QueryService_Query($hvServices,$query)
           
           
              }
            
            catch {
              Write-Host "An error occurred when logging on $_"
              break 
            }
            
            write-host "There are" $sresult.results.Count "total applications"
    
            $sresult.Results | Format-Table -autosize @{Name = 'Name'; Expression = {$_.data.name}}      
             
                     
           
              } 
     

function Show-Menu
  {
    param (
          [string]$Title = 'VMware Horizon API Menu'
          )
       Clear-Host
       Write-Host "================ $Title ================"
             
       Write-Host "Press '1' to Login to Horizon"
       Write-Host "Press '2' for a List of Sessions"
       Write-Host "Press '3' for a List of Applications"
       Write-Host "Press '4' for a List of Machines"
       Write-Host "Press '5' to Reboot a Desktop"
       Write-Host "Press '6' for a List of Desktop Pools"
       Write-Host "Press '7' for Connection Server Info"
       Write-Host "Press '8' for Usage Info"
       Write-Host "Press 'Q' to quit."
         }

do
 {
    Show-Menu
    $selection = Read-Host "Please make a selection"
    switch ($selection)
    {
    
    '1' {  

         LogintoHorizon
    } 
    
    '2' {
   
         GetSessions

    }
    
    '3' {
       
         GetApplications
      
    }

    '4' {
       
     GetMachines
   
 }


 '5' {
       
  RebootDT

}

'6' {
       
        GetDtPools
     
   }
   '7' {
       
    GetCSInfo
 
}
'8' {
       
  GetUsage

}

    }
    pause
 }
 
 until ($selection -eq 'q')