After writing the script to create VM on AHV with a vGPU profile I was wondering what else I could do with the code I had written. When I was looking at some of my older blogposts I realized I had a VM inventory script and wanted to update that to include the GPU profiles. Before I could update the inventory script I had to gobble together the code to actually report the VMs that are vGPU enabled and the configured profiles.
From that older blog, the following interfaces are available:
- REST API
- HTML5 GUI
- CLI – ACLI & NCLI
- Scripting interfaces (PowerShell)
The following definitions are from the Nutanix Bible as Steve Poitras already explained this:
| REST API The REST API exposes every capability and data point of the Prism UI and allows for orchestration or automation tools to easily drive Nutanix action. This enables tools like Saltstack, Puppet, vRealize Operations, System Center Orchestrator, Ansible, etc. to easily create custom workflows for Nutanix. Also, this means that any third-party developer could create their own custom UI and pull in Nutanix data via REST. HTML5 GUI (Prism UI) The HTML5 UI is a key part to Prism to provide a simple, easy to use management interface. However, another core ability are the APIs which are available for automation. All functionality exposed through the Prism UI is also exposed through a full set of REST APIs to allow for the ability to programmatically interface with the Nutanix platform. This allow customers and partners to enable automation, 3rd-party tools, or even create their own UI. CLI – ACLI & NCLI The Acropolis CLI (ACLI) is the CLI for managing the Acropolis portion of the Nutanix product. These capabilities were enabled in releases after 4.1.2. The Nutanix CLI is the CLI for managing the Nutanix product and is more heterogeneous across hypervisors. PowerShell Windows PowerShell is a powerful shell (hence the name ;P) and scripting language built on the .NET framework. It is a very simple to use language and is built to be intuitive and interactive. |
As a reminder, when creating a VM via ACLI all you’d need is a few lines to create a VM, assign a nic to the VM on a specific network and do the same with a disk (create/assign). Now adding a GPU is another oneliner. Searching for them turned out to be more difficult, there’s no direct command in ACLI to do this but here’s how I managed to do it with Powershell:
|
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 |
# kees@nutanix.com # @kbaggerman on Twitter # http://blog.myvirtualvision.com # Created on March 13, 2019 # With great help of Michell Grauwmans and Dave Brett # Setting parameters for the connection [CmdletBinding(SupportsShouldProcess = $False, ConfirmImpact = "None") ] Param( # Nutanix cluster IP address [Parameter(Mandatory = $true)] [Alias('IP')] [string] $nxIP, # Nutanix cluster username [Parameter(Mandatory = $true)] [Alias('User')] [string] $nxUser, # Nutanix cluster password [Parameter(Mandatory = $true)] [Alias('Password')] [string] $nxPassword ) Function write-log { <# .Synopsis Write logs for debugging purposes .Description This function writes logs based on the message including a time stamp for debugging purposes. #> param ( $message, $sev = "INFO" ) if ($sev -eq "INFO") { write-host "$(get-date -format "hh:mm:ss") | INFO | $message" } elseif ($sev -eq "WARN") { write-host "$(get-date -format "hh:mm:ss") | WARN | $message" } elseif ($sev -eq "ERROR") { write-host "$(get-date -format "hh:mm:ss") | ERROR | $message" } elseif ($sev -eq "CHAPTER") { write-host "`n`n### $message`n`n" } } $nxPasswordSec = ConvertTo-SecureString $nxPassword -AsPlainText -Force # Adding PS cmdlets $loadedsnapins = (Get-PSSnapin -Registered | Select-Object name).name if (!($loadedsnapins.Contains("NutanixCmdletsPSSnapin"))) { Add-PSSnapin Nutanix* } if ($null -eq (Get-PSSnapin -Name NutanixCmdletsPSSnapin -ErrorAction SilentlyContinue)) { write-log -message "Nutanix CMDlets are not loaded, aborting the script" break } # Connecting to the Nutanix Cluster $nxServerObj = Connect-NTNXCluster -Server $nxIP -UserName $nxUser -Password $nxPasswordSec -AcceptInvalidSSLCerts if ($null -eq (get-ntnxclusterinfo)) { write-log -message "Cluster connection isn't available, abborting the script" break } $debug = 2 Function Get-Hosts { <# .Synopsis This function will collect the hosts within the specified cluster. .Description This function will collect the hosts within the specified cluster using REST API call based on Invoke-RestMethod #> Param ( [string] $debug ) $credPair = "$($nxUser):$($nxPassword)" $encodedCredentials = [System.Convert]::ToBase64String([System.Text.Encoding]::ASCII.GetBytes($credPair)) $headers = @{ Authorization = "Basic $encodedCredentials" } $URL = "https://$($nxIP):9440/api/nutanix/v3/hosts/list" $Payload = @{ kind = "host" offset = 0 length = 999 } $JSON = $Payload | convertto-json try { $task = Invoke-RestMethod -Uri $URL -method "post" -body $JSON -ContentType 'application/json' -headers $headers; } catch { Start-Sleep 10 write-log -message "Going once" $task = Invoke-RestMethod -Uri $URL -method "post" -body $JSON -ContentType 'application/json' -headers $headers; } write-log -message "We found $($task.entities.count) hosts in this cluster." Return $task } Function Get-VMs { <# .Synopsis This function will collect the VMs within the specified cluster. .Description This function will collect the VMs within the specified cluster using REST API call based on Invoke-RestMethod #> Param ( [string] $debug ) $credPair = "$($nxUser):$($nxPassword)" $encodedCredentials = [System.Convert]::ToBase64String([System.Text.Encoding]::ASCII.GetBytes($credPair)) $headers = @{ Authorization = "Basic $encodedCredentials" } write-log -message "Executing VM List Query" $URL = "https://$($nxIP):9440/api/nutanix/v3/vms/list" $Payload = @{ kind = "vm" offset = 0 length = 999 } $JSON = $Payload | convertto-json try { $task = Invoke-RestMethod -Uri $URL -method "post" -body $JSON -ContentType 'application/json' -headers $headers; } catch { Start-Sleep 10 write-log -message "Going once" $task = Invoke-RestMethod -Uri $URL -method "post" -body $JSON -ContentType 'application/json' -headers $headers; } write-log -message "We found $($task.entities.count) VMs." Return $task } Function Get-DetailVM { <# .Synopsis This function will collect the speficics of the VM we've specified using the Get-VMs function as input. .Description This function will collect the speficics of the VM we've specified using the Get-VMs function as input using REST API call based on Invoke-RestMethod #> Param ( [string] $uuid, [string] $debug ) $credPair = "$($nxUser):$($nxPassword)" $encodedCredentials = [System.Convert]::ToBase64String([System.Text.Encoding]::ASCII.GetBytes($credPair)) $headers = @{ Authorization = "Basic $encodedCredentials" } $URL = "https://$($nxIP):9440/api/nutanix/v3/vms/$($uuid)" try { $task = Invoke-RestMethod -Uri $URL -method "get" -headers $headers; } catch { Start-Sleep 10 write-log -message "Going once" } Return $task } Function Get-DetailHosts { Param ( [string] $uuid, [string] $debug ) $credPair = "$($nxUser):$($nxPassword)" $encodedCredentials = [System.Convert]::ToBase64String([System.Text.Encoding]::ASCII.GetBytes($credPair)) $headers = @{ Authorization = "Basic $encodedCredentials" } $URL = "https://$($nxIP):9440/api/nutanix/v3/hosts/$($uuid)" try { $task = Invoke-RestMethod -Uri $URL -method "get" -headers $headers; } catch { Start-Sleep 10 $task = Invoke-RestMethod -Uri $URL -method "get" -headers $headers; write-log -message "Going once" } Return $task } # Selecting all the GPUs and their devices IDs in the cluster $GPU_List = $null $hosts = Get-Hosts -ClusterPC_IP $nxIP -nxPassword $nxPassword -clusername $nxUser -debug $debug Foreach ($Hypervisor in $hosts.entities) { $detail = Get-DetailHosts -ClusterPC_IP $nxIP -nxPassword $nxPassword -clusername $nxUser -debug $debug -uuid $Hypervisor.metadata.uuid [array]$GPU_List += $detail.status.resources.gpu_list } write-log -message "Collecting vGPU profiles and Device IDs" # Grabbing the VMs with a GPU and reporting back $VMs = Get-NTNXVM | Where-Object {$_.gpusInUse -Match "true"} Foreach ($vm in $VMs) { $myvmdetail = Get-DetailVM -ClusterPC_IP $nxIP -nxPassword $nxPassword -clusername $nxUser -debug $debug -uuid $vm.uuid $newVMObject = $MyVMdetail $devid = $newVMObject.spec.resources.gpu_list $GPUUsed = $GPU_List | Where-Object {$_.device_id -eq $devid.device_id} $VMGPU = $GPUUsed | select-object {$_.name} -unique $VMGPU1 = $VMGPU.'$_.name' write-log -message "Found $($VM.vmName) with $VMGPU1" } Disconnect-NTNXCluster * write-log -message "Disconnecting from the cluster" |
Hopefully this helped you guys as I’m off to my next challenge (Thanks Dave) to write my previous script into a C# application which turns out to be even more challenging than I thought.
The following two tabs change content below.
Kees Baggerman
Kees Baggerman is a Staff Solutions Architect for End User Computing at Nutanix. Kees has driven numerous Microsoft and Citrix, and RES infrastructures functional/technical designs, migrations, implementations engagements over the years.
Latest posts by Kees Baggerman (see all)
- Nutanix AHV and Citrix MCS: Adding a persistent disk via Powershell – v2 - November 19, 2019
- Recovering a Protection Domain snapshot to a VM - September 13, 2019
- Checking power settings on VMs using powershell - September 11, 2019
- Updated: VM Reporting Script for Nutanix with Powershell - July 3, 2019
- Updated (again!): VM Reporting Script for Nutanix AHV/vSphere with Powershell - June 17, 2019
[…] I was on a roll with powershell scripts anyway I looked at the Reporting vGPU enabled VMs on AHV.I wrote earlier this month and wanted to reuse that script for the VM Inventory script I had written […]