Hello old friend, here we are again. It’s been a while but I’m (hopefully) getting back on track with this blog. I’ve been dabbling around with this idea for a while and it got fastracked after I got a request from someone in the Nutanix Services Organisation on how they could add a vGPU profile to the ‘Create a VM on AHV’ with Powershell.
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:
|
1 2 3 4 |
vm.create KBTestVM99 memory=2G num_vcpus=2 vm.nic_create KBTestVM99 network=VDI-Lan vm.disk_create KBTestVM99 create_size=50G container=VDI vm.gpu_assign KBTestVM99 gpu=Nvidia_GRID_M60-2Q |
Now, to do this with powershell it proved to be a little bit more challenging than I expected it to be as our native cmdlets didn’t seem to have a good way of doing this so I had to revert to good old REST APIs and Powershell so with some help from Michell and Dave here’s what I came up with:
|
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 |
# kees@nutanix.com # @kbaggerman on Twitter # http://blog.myvirtualvision.com # Created on January 25, 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 ) $nxPasswordSec = ConvertTo-SecureString $nxPassword -AsPlainText -Force # Adding PS cmdlets $loadedsnapins=(Get-PSSnapin -Registered | Select-Object name).name if(!($loadedsnapins.Contains("NutanixCmdletsPSSnapin"))){ Add-PSSnapin -Name NutanixCmdletsPSSnapin } if ($null -eq (Get-PSSnapin -Name NutanixCmdletsPSSnapin -ErrorAction SilentlyContinue)) { write-log -message "Nutanix CMDlets are not loaded, aborting the script" break } 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" } } # 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 } ## VM Creation # Setting Variables $Name = "KBTestVM99" $NumVcpus = "2" $MemoryMB = "2048" $VMname = $name $GPUName = "GRID M60-2Q" $debug = 2 # Creating the VM write-log -message "Creating $Name with $NumVcpus vCPUs and $MemoryMB MB RAM and a $GPUName profile" Try { new-ntnxvirtualmachine -Name $Name -NumVcpus $NumVcpus -MemoryMB $MemoryMB | out-null Start-Sleep -s 5 } Catch { write-log -message "Could not create the VM" } ## Network Settings # Get the VmID of the VM $vminfo = Get-NTNXVM | Where-Object {$_.vmName -eq $Name} $vmId = ($vminfo.vmid.split(":"))[2] write-log -message "Grabbing the UUID ($vmID) from $Name" # Set NIC for VM on default vlan (Get-NTNXNetwork -> NetworkUuid) Try { $nic = New-NTNXObject -Name VMNicSpecDTO $nic.networkUuid = "669f10d4-0c38-4a87-8660-5affa43956a1" $vlan = Get-NTNXNetwork # Adding a Nic Add-NTNXVMNic -Vmid $vmId -SpecList $nic write-log -message "Adding a NIC in vlan $($vlan.name) to $Name" } Catch { write-log -message "Failed to add a NIC in vlan $($vlan.name) to $Name" } ## Disk Creation Try { # Setting the SCSI disk of 50GB on Containner ID 1025 (get-ntnxcontainer -> ContainerId) $diskCreateSpec = New-NTNXObject -Name VmDiskSpecCreateDTO $diskcreatespec.containerid = 1265 $diskcreatespec.sizeMb = 51200 # Creating the Disk $vmDisk = New-NTNXObject –Name VMDiskDTO $vmDisk.vmDiskCreate = $diskCreateSpec # Adding the Disk to the VM Add-NTNXVMDisk -Vmid $vmId -Disks $vmDisk write-log -message "Adding a disk to $Name" } Catch { write-log -message "Failed to add a disk to $Name" } 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) items." 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" } write-log -message "Getting VM Detail for $Name" $URL = "https://$($nxIP):9440/api/nutanix/v3/vms/$($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 } Function Update-VM { <# .Synopsis This function is used to update the VM according to the specification in the script, the focus here is adding a GPU as other components are added via the native Powershell Commandlets. .Description This function will update the speficics of the VM we've specified using the parameters defined at the start of this script as input using REST API call based on Invoke-RestMethod #> Param ( [string] $uuid, [object] $VMObject, [string] $debug ) $credPair = "$($nxUser):$($nxPassword)" $encodedCredentials = [System.Convert]::ToBase64String([System.Text.Encoding]::ASCII.GetBytes($credPair)) $headers = @{ Authorization = "Basic $encodedCredentials" } $json = $VMObject | convertto-json -depth 50 $URL = "https://$($nxIP):9440/api/nutanix/v3/vms/$($uuid)" if ($debug -ge 2){ $json #| out-file c:\temp\VM.json } try { $task = Invoke-RestMethod -Uri $URL -method "put" -body $JSON -ContentType 'application/json' -headers $headers; } catch { Start-Sleep 10 $task = Invoke-RestMethod -Uri $URL -method "put" -body $JSON -ContentType 'application/json' -headers $headers; write-log -message "Going once" } Return $task } Function Get-DetailHosts { <# .Synopsis This function will collect the speficics of the Host we've specified using the Get-Hosts function as input. .Description This function will collect the speficics of the VM we've specified using the Get-Hosts 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/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 } #### GPU Device IDs list ####### #### Select the GPU from $GPU_List $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 $GPU_List, pick a GPU and create an object #### GPU Device IDs list ####### $GPU = $gpu_list | Where-Object {$_.name -eq $GPUName} | Select-Object -first 1 $VMs = Get-VMs -ClusterPC_IP $nxIP -nxPassword $nxPassword -clusername $nxUser -debug $debug $MyVM = $VMs.entities | Where-Object {$_.spec.name -match $VMname} $myvmdetail = Get-DetailVM -ClusterPC_IP $nxIP -nxPassword $nxPassword -clusername $nxUser -debug $debug -uuid $MyVM.metadata.uuid if (!$myvm.count -and $myvm){ write-log -message "We found 1 item." } else { write-log -message "We found $($MyVM.count) items." } write-log -message "The Full GPU list is available: $($GPU_list.count) items" write-log -message "Collecting vGPU profiles and Device IDs" ### Modifying set data to the GPU profile $GPU_Set = @" { "gpu_list": [ { "vendor": "$($gpu.Vendor)", "mode": "$($gpu.mode)", "device_id": $($gpu.device_id) } ] } "@ $newVMObject = $MyVMdetail $newVMObject.psobject.members.remove("Status") $newVMObject.spec.resources.gpu_list = ($GPU_Set | convertfrom-json).gpu_list Try { Update-VM -ClusterPC_IP $nxIP -nxPassword $nxPassword -clusername $nxUser -debug $debug -uuid $MyVM.metadata.uuid -VMObject $newVMObject | out-null write-log -message "Assigning $GPUName to $Name" } Catch { write-log -message "Failed to assing $GPUName to $Name" } 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 this into a C# application.
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
[…] Creating a VM including a vGPU profile on AHV with Powershell […]
[…] 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 […]