Public/New-AGMLibSystemStateToVM.ps1
|
# Copyright 2022 Google Inc. All Rights Reserved. # # Licensed under the Apache License, Version 2.0 (the "License"); # you may not use this file except in compliance with the License. # You may obtain a copy of the License at # # http://www.apache.org/licenses/LICENSE-2.0 # # Unless required by applicable law or agreed to in writing, software # distributed under the License is distributed on an "AS IS" BASIS, # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. # See the License for the specific language governing permissions and # limitations under the License. Function New-AGMLibSystemStateToVM ([string]$appid,[string]$mountapplianceid,[string]$appname,[string]$imageid,[string]$vmname,[string]$imagename,[int]$cpu,[int]$memory,[string]$ostype,[string]$datastore,[string]$poweroffvm,[string]$esxhostid,[string]$vcenterid,[string]$dhcpnetworks,[string]$fixedipnetworks,[switch][alias("g")]$guided) { <# .SYNOPSIS Mounts a system state image as a new VM .EXAMPLE New-AGMLibSystemStateToVM -g Runs a guided menu to create a new VMware VM from a system state image. .EXAMPLE New-AGMLibSystemStateToVM -imageid 56410933 -vmname "avtest21" -datastore "LSI_FC" -vcenterid 5552150 -esxhostid 5552164 -dhcpnetworks "VM Network,VMXNet3" This mounts the specified imageid The Network is "VM Network" and the interface type is VMXNet3 .EXAMPLE New-AGMLibSystemStateToVM -appid 32885776 -mountapplianceid 1415019931 -vmname "avtest21" -datastore "LSI_FC" -vcenterid 5552150 -esxhostid 5552164 -dhcpnetworks "VM Network,VMXNet3" This mounts the latest image for the specified appid using the specified cluster ID. The Network is "VM Network" and the interface type is VMXNet3 .DESCRIPTION A function to create a new VMware VM from a System State Image Image selection can be done three ways: 1) Run this command in guided mode to learn the available images and select one 2) Learn the image ID and specify that as part of the command with -imageid 3) Learn the Appid and Cluster ID for the appliance that will mount the image and then use -appid and -mountapplianceid This will use the latest snapshot, dedupasync, streamsnap or OnVault image on that appliance poweroffvm - by default is not set and VM is left powered on selectedobjects - currently not cated for cpu - autolearned from the image so they should only be issued if you want to vary them from the per image default memory - autolearned from the image so they should only be issued if you want to vary them from the per image default ostype - autolearned from the image so they should only be issued if you want to vary them from the per image default dhcpnetworks - each network is semi-colon separated with two comma separated variables, the network name and the NIC Type format example, single network: "Network1,E10000" format example, two networks: "Network1,E10000;Network2,VMXNet3" fixedipnetworks - each network is semi-colon separated with six comma separated variables, the network name, the NIC Type, IP Address, Subnet, Gateway, DNS format example, single network: "Network1,VMXNet3,10.0.0.100,10.0.0.1,255.255.255.0,8.8.8.8" format example, two networks: "Network1,VMXNet3,10.0.0.100,10.0.0.1,255.255.255.0,8.8.8.8;Network2,VMXNet3,10.1.0.100,10.1.0.1,255.255.255.0,8.8.8.8" Note image defaults can be shown with: Get-AGMImageSystemStateOptions -imageid $imageid -target VMware #> if ( (!($AGMSESSIONID)) -or (!($AGMIP)) ) { Get-AGMErrorMessage -messagetoprint "Not logged in or session expired. Please login using Connect-AGM" return } $sessiontest = Get-AGMVersion if ($sessiontest.errormessage) { Get-AGMErrorMessage -messagetoprint "AGM session has expired. Please login again using Connect-AGM" return } # if the user gave us nothing to start work, then ask for a VMware VM name if ( (!($appname)) -and (!($imagename)) -and (!($imageid)) -and (!($appid)) ) { $guided = $TRUE Clear-Host $appliancegrab = Get-AGMAppliance | select-object name,clusterid | sort-object name if ($appliancegrab.count -eq 0) { Get-AGMErrorMessage -messagetoprint "Failed to find any appliances to list" return } if ($appliancegrab.name.count -eq 1) { $mountapplianceid = $appliancegrab.clusterid $mountappliancename = $appliancegrab.name } else { Clear-Host write-host "Appliance selection menu - which Appliance will run this mount" Write-host "" $i = 1 foreach ($appliance in $appliancegrab) { Write-Host -Object "$i`: $($appliance.name)" $i++ } While ($true) { Write-host "" $listmax = $appliancegrab.name.count [int]$appselection = Read-Host "Please select an Appliance to mount from (1-$listmax)" if ($appselection -lt 1 -or $appselection -gt $listmax) { Write-Host -Object "Invalid selection. Please enter a number in range [1-$($listmax)]" } else { break } } $mountapplianceid = $appliancegrab.clusterid[($appselection - 1)] $mountappliancename = $appliancegrab.name[($appselection - 1)] } Write-host "" write-host "Select application status for SystemState apps with images on $mountappliancename" Write-host "" Write-Host "1`: Managed local apps(default)" Write-Host "2`: Unmanaged local apps" Write-Host "3`: Imported apps (from other Appliances)" Write-Host "" [int]$userselectionapps = Read-Host "Please select from this list (1-3)" if ($userselectionapps -eq "" -or $userselectionapps -eq 1) { $vmgrab = Get-AGMApplication -filtervalue "managed=true&apptype=SystemState&clusterid=$mountapplianceid" | sort-object appname } if ($userselectionapps -eq 2) { $vmgrab = Get-AGMApplication -filtervalue "managed=false&apptype=SystemState&&sourcecluster=$mountapplianceid" | sort-object appname } if ($userselectionapps -eq 3) { $vmgrab = Get-AGMApplication -filtervalue "apptype=SystemState&sourcecluster!$mountapplianceid&clusterid=$mountapplianceid" | sort-object appname } if ($vmgrab.count -eq 0) { if ($userselectionapps -eq "" -or $userselectionapps -eq 1) { Get-AGMErrorMessage -messagetoprint "There are no managed System State apps to list." } if ($userselectionapps -eq 2) { Get-AGMErrorMessage -messagetoprint "There are no unmanaged System State apps to list." } if ($userselectionapps -eq 3) { Get-AGMErrorMessage -messagetoprint "There are no imported System State apps to list. You may need to run Import-AGMLibOnVault first" } return } if ($vmgrab.count -eq 1) { $appname = $vmgrab.appname $appid = $vmgrab.id write-host "Found one SystemState app $appname" write-host "" } else { write-host "VM Selection menu" Write-host "" $i = 1 foreach ($vm in $vmgrab) { $vmlistname = $vm.appname $appliance = $vm.cluster.name Write-Host -Object "$i`: $vmlistname ($appliance)" $i++ } While ($true) { Write-host "" $listmax = $vmgrab.appname.count [int]$vmselection = Read-Host "Please select an application (1-$listmax)" if ($vmselection -lt 1 -or $vmselection -gt $listmax) { Write-Host -Object "Invalid selection. Please enter a number in range [1-$($listmax)]" } else { break } } $appname = $vmgrab.appname[($vmselection - 1)] $appid = $vmgrab.id[($vmselection - 1)] } } if ( ($appname) -and (!($appid)) ) { $appgrab = Get-AGMApplication -filtervalue "appname=$appname&apptype=SystemState" if ($appgrab.id.count -ne 1) { Get-AGMErrorMessage -messagetoprint "Failed to resolve $appname to a unique valid SystemState app. Use Get-AGMLibApplicationID and try again specifying -appid." return } else { $appid = $appgrab.id } } # learn name of new VM if (!($vmname)) { While ($true) { if ($vmname -eq "") { [string]$vmname= Read-Host "Name of New VM you want to create using an image of $appname" } else { break } } } # learn about the image if ($imagename) { $imagegrab = Get-AGMImage -filtervalue backupname=$imagename if ($imagegrab.count -eq 0) { Get-AGMErrorMessage -messagetoprint "Failed to find $imagename using: Get-AGMImage -filtervalue backupname=$imagename" return } else { $imageid = $imagegrab.id } } # this if for guided menu if ($guided) { if (!($imageid)) { write-host "Fetching Image list from AGM for Appid $appid" $imagelist = Get-AGMImage -filtervalue "appid=$appid&jobclass=snapshot&jobclass=dedupasync&jobclass=StreamSnap&jobclass=OnVault&clusterid=$mountapplianceid" | Sort-Object consistencydate if ($imagelist.id.count -eq 0) { Get-AGMErrorMessage -messagetoprint "Failed to fetch any Images for appid $appid" return } Clear-Host Write-Host "Image list. Choose based on the best consistency date, location and jobclass." $i = 1 foreach ($image in $imagelist) { if ($image.jobclass -eq "OnVault") { $target = $image.diskpool.name Write-Host -Object "$i`: $($image.consistencydate) $($image.jobclass) (Diskpool: $target)" } else { $target = $image.cluster.name Write-Host -Object "$i`: $($image.consistencydate) $($image.jobclass) (Appliance: $target)" } $i++ } While ($true) { Write-host "" $listmax = $imagelist.Length [int]$imageselection = Read-Host "Please select an image (1-$listmax)" if ($imageselection -lt 1 -or $imageselection -gt $imagelist.Length) { Write-Host -Object "Invalid selection. Please enter a number in range [1-$($imagelist.Length)]" } else { break } } # onvault images get stacked if ($imagelist[($imageselection - 1)].copies) { $copies = $imagelist[($imageselection - 1)].copies $imageid = ($copies | where-object {$_.targetuds -eq $mountapplianceid}).id } else { $imageid = $imagelist[($imageselection - 1)].id } } } if (($appid) -and ($mountapplianceid) -and (!($imageid))) { # if we are not running guided mode but we have an appid without imageid, then lets get the latest image on the mountappliance ID $imagegrab = Get-AGMImage -filtervalue "appid=$appid&targetuds=$mountapplianceid&jobclass=snapshot&jobclass=dedupasync&jobclass=StreamSnap&jobclass=OnVault" -sort "consistencydate:desc,jobclasscode:asc" -limit 1 if ($imagegrab.count -eq 1) { $imageid = $imagegrab.id } else { Get-AGMErrorMessage -messagetoprint "Failed to fetch a snapshot, dedupasync, StreamSnap or OnVault Image for appid $appid on appliance with clusterID $mountapplianceid" return } } $systemstateoptions = Get-AGMImageSystemStateOptions -imageid $imageid -target GCP $cpudefault = $ostype = ($systemstateoptions| where-object {$_.name -eq "CPU"}).defaultvalue $memorydefault = $ostype = ($systemstateoptions| where-object {$_.name -eq "Memory"}).defaultvalue $ostype = ($systemstateoptions| where-object {$_.name -eq "OSType"}).defaultvalue if ($guided) { Clear-Host #using the image we learn which appliance it is on. We need this so we can list only the vCenters known to that appliance #$clusterid = (Get-AGMImage -id $imageid).clusterid #if (!($clusterid)) #{ ## Get-AGMErrorMessage -messagetoprint "Failed to find details about $imageid" # return #} # we now learn what vcenters are on that appliance and build a list, if there is more than 1 We were using cluster ID from image, but that can point to source cluster, $vclist = Get-AGMHost -filtervalue "clusterid=$mountapplianceid&isvcenterhost=true&hosttype=vcenter" | select-object -Property name, srcid, id | Sort-Object name if ($vclist.name.count -eq 0) { Get-AGMErrorMessage -messagetoprint "Failed to fetch any vCenters" return } elseif ($vclist.name.count -eq 1) { $vcenterid = ($vclist).id $srcid = ($vclist).srcid write-host "Only one vCenter found, using "$vclist.name } else { write-host "" Write-Host "vCenter list" $i = 1 foreach ($item in $vclist.name) { Write-Host -Object "$i`: $item" $i++ } While ($true) { Write-host "" $listmax = $vclist.Length [int]$userselection = Read-Host "Please select from this list (1-$listmax)" if ($userselection -lt 1 -or $userselection -gt $vclist.Length) { Write-Host -Object "Invalid selection. Please enter a number in range [1-$($vclist.Length)]" } else { break } } $srcid = $vclist[($userselection - 1)].srcid $vcenterid = $vclist[($userselection - 1)].id } # we now learn what ESX hosts are known to the selected vCenter $esxlist = Get-AGMHost -filtervalue "vcenterhostid=$srcid&isesxhost=true&originalhostid=0" | select-object -Property id, name | Sort-Object name if ($esxlist.name.count -eq 0) { Get-AGMErrorMessage -messagetoprint "Failed to fetch any ESX Servers" return } elseif ($esxlist.name.count -eq 1) { $esxhostid = ($esxlist).id write-host "Only one ESXi host found, using "$esxlist.name } else { write-host "" Write-Host "ESX Server list" $i = 1 foreach ($server in $esxlist.name) { Write-Host -Object "$i`: $server" $i++ } While ($true) { Write-host "" $listmax = $esxlist.Length [int]$esxserverselection = Read-Host "Please select an ESX Server (1-$listmax)" if ($esxserverselection -lt 1 -or $esxserverselection -gt $esxlist.Length) { Write-Host -Object "Invalid selection. Please enter a number in range [1-$($esxlist.Length)]" } else { break } } $esxhostid = $esxlist[($esxserverselection - 1)].id } # we now learn what datastores are known to the selected ESX host $dslist = (Get-AGMHost -id $esxhostid).sources.datastorelist | select-object name,freespace | sort-object name | Get-Unique -asstring if ($dslist.count -eq 0) { Get-AGMErrorMessage -messagetoprint "Failed to fetch any DataStores" return } elseif ($dslist.count -eq 1) { $datastore = ($dslist).name write-host "Only one Datastore found, using "$dslist.name } else { write-host "" Write-Host "Datastore list" $i = 1 foreach ($item in $dslist) { $diskname = $item.name $freespace = [math]::Round($item.freespace / 1073741824,0) Write-Host -Object "$i`: $diskname ($freespace GiB Free)" $i++ } While ($true) { Write-host "" $listmax = $dslist.Length [int]$userselection = Read-Host "Please select from this list (1-$listmax)" if ($userselection -lt 1 -or $userselection -gt $dslist.Length) { Write-Host -Object "Invalid selection. Please enter a number in range [1-$($dslist.Length)]" } else { break } } $datastore = $dslist[($userselection - 1)].name } Write-host "" Write-Host "Power off after recovery?" Write-Host "1`: Do not power off after recovery(default)" Write-Host "2`: Power off after recovery" Write-Host "" [int]$userselection = Read-Host "Please select from this list (1-2)" if ($userselection -eq "") { $userselection = 1 } if ($userselection -eq 1) { $poweroffvm = $FALSE } if ($userselection -eq 2) { $poweroffvm = $TRUE } $systemstateoptions = Get-AGMImageSystemStateOptions -imageid $imageid -target VMware $cpudefault = $ostype = ($systemstateoptions| where-object {$_.name -eq "CPU"}).defaultvalue $memorydefault = $ostype = ($systemstateoptions| where-object {$_.name -eq "Memory"}).defaultvalue $ostype = ($systemstateoptions| where-object {$_.name -eq "OSType"}).defaultvalue $nicinfo = ($systemstateoptions | where-object {$_.name -eq "NICInfo"}).structure Write-Host "" # get CPU and memory [int]$cpu = read-host "CPU (vCPU) (default $cpudefault)" [int]$memory = read-host "Memory (GB) (default $memorydefault)" # this shouldn't be needed if (!($ostype)) { Write-Host "" Write-Host "OS TYPE?" Write-Host "1`: Windows(default)" Write-Host "2`: Linux" Write-Host "" [int]$userselection = Read-Host "Please select from this list (1-2)" if ($userselection -eq "") { $userselection = 1 } if ($userselection -eq 1) { $ostype = "Windows" } if ($userselection -eq 2) { $ostype = "Linux" } } else { write-host "`nOS type: $ostype" } Write-Host "" [int]$networkcount = Read-Host "Number of network interfaces (default is 1)" if (!($networkcount)) { $networkcount = 1 } $dhcpnetworks = "" $fixedipnetworks = "" foreach ($net in 1..$networkcount) { clear-host Write-host "Network $net settings" Write-Host "" Write-Host "DHCP Selection" Write-Host "1`: Use DHCP(default)" Write-Host "2`: Set IP Addresses" Write-Host "" [int]$userselection = Read-Host "Please select from this list (1-2)" if ($userselection -eq "") { $userselection = 1 } if ($userselection -eq "1") { $networkname = Read-Host "VMware Network Name" Write-Host "" Write-Host "NIC Type" Write-Host "1`: Use VMXNet3(default)" Write-Host "2`: Use E10000" Write-Host "" [int]$usernicselection = Read-Host "Please select from this list (1-2)" if ($usernicselection -eq "2") { $dhcpnetworks = $dhcpnetworks + ";" + $networkname + "," + "E10000" } else { $dhcpnetworks = $dhcpnetworks + ";" + $networkname + "," + "VMXNet3" } } if ($userselection -eq "2") { $networkname = Read-Host "VMware Network Name" Write-Host "" Write-Host "NIC Type" Write-Host "1`: Use VMXNet3(default)" Write-Host "2`: Use E10000" Write-Host "" [int]$usernicselection = Read-Host "Please select from this list (1-2)" write-host "" $ipaddress = Read-Host "IP Address" $subnet = Read-Host "Subnet" $gateway = Read-Host "Gateway" $dns = Read-Host "DNS" if ($usernicselection -eq "2") { $fixedipnetworks = $fixedipnetworks + ";" + $networkname + "," + "E10000" + "," + $ipaddress + "," + $subnet + "," + $gateway + "," + $dns } else { $fixedipnetworks = $fixedipnetworks + ";" + $networkname + "," + "VMXNet3" + "," + $ipaddress + "," + $subnet + "," + $gateway + "," + $dns} } } if ($dhcpnetworks -ne "") { $dhcpnetworks = $dhcpnetworks.substring(1) } if ($fixedipnetworks -ne "") { $fixedipnetworks = $fixedipnetworks.substring(1) } } if (!($cpu)) { $cpu = $cpudefault } if (!($memory)) { $memory = $memorydefault } if (!($ostype)) { $ostype = ($systemstateoptions| where-object {$_.name -eq "OSType"}).defaultvalue } if ($guided) { Clear-Host Write-Host "Guided selection is complete. The values entered resulted in the following command:" Write-Host "" Write-Host -nonewline "New-AGMLibSystemStateToVM -imageid $imageid -appid $appid -mountapplianceid $mountapplianceid -vmname `"$vmname`" -cpu $cpu -memory $memory -ostype `"$OSType`" -datastore `"$datastore`" -vcenterid $vcenterid -esxhostid $esxhostid" if ($poweroffvm) { Write-Host -nonewline " -poweroffvm" } if ($dhcpnetworks -ne "") { Write-Host " -dhcpnetworks `"$dhcpnetworks`"" } if ($fixedipnetworks -ne "") { Write-Host " -fixedipnetworks `"$fixedipnetworks`"" } Write-Host "" Write-Host "1`: Run the command now (default)" Write-Host "2`: Show the JSON used to run this command, but don't run it" Write-Host "3`: Exit without running the command" $userchoice = Read-Host "Please select from this list (1-3)" if ($userchoice -eq 2) { $jsonprint = "yes" } if ($userchoice -eq 3) { return } } if (!($imageid)) { [string]$imageid = Read-Host "ImageID to mount" } if ( (!($datastore)) -or (!($esxhostid)) -or (!($vcenterid)) ) { Get-AGMErrorMessage -messagetoprint "Please supply -datastore -esxhostid and -vcenterid or use -g to build the command" return } $body = [ordered]@{} $body += [ordered]@{ datastore = $datastore; hypervisor = @{id=$esxhostid} mgmtserver = @{id=$vcenterid} hostname = $vmname; } if ($poweroffvm) { $body += [ordered]@{ poweronvm = "false" } } else { $body += [ordered]@{ poweronvm = "true" } } $systemstateoptions = @() if ($ostype) { $systemstateoptions += @( [ordered]@{ name = 'CPU'; value = $cpu } [ordered]@{ name = 'Memory'; value = $memory } [ordered]@{ name = 'OSType'; value = $ostype } [ordered]@{ name = 'CloudType'; value = "VMware" } ) } else { $systemstateoptions += @( [ordered]@{ name = 'CPU'; value = $cpu } [ordered]@{ name = 'Memory'; value = $memory } [ordered]@{ name = 'CloudType'; value = "VMware" } ) } if ($dhcpnetworks) { $nicinfo = @() foreach ($nic in $dhcpnetworks.split(";")) { $nicinfo += @( [ordered]@{ name = 'DHCP'; value = "true" } [ordered]@{ name = 'NICNetwork'; value = $nic.split(",")[0] } [ordered]@{ name = 'NICType'; value = $nic.split(",")[1] } ) $systemstateoptions += @( [ordered]@{ name = 'NICInfo'; structurevalue = $nicinfo } ) } } if ($fixedipnetworks) { $nicinfo = @() foreach ($nic in $fixedipnetworks.split(";")) { $nicinfo += @( [ordered]@{ name = 'DHCP'; value = "false" } [ordered]@{ name = 'NICNetwork'; value = $nic.split(",")[0] } [ordered]@{ name = 'NICType'; value = $nic.split(",")[1] } [ordered]@{ name = 'NICIP'; value = $nic.split(",")[2] } [ordered]@{ name = 'NICSubnet'; value = $nic.split(",")[3] } [ordered]@{ name = 'NICGateway'; value = $nic.split(",")[4] } [ordered]@{ name = 'NICDNS'; value = $nic.split(",")[5] } ) $systemstateoptions += @( [ordered]@{ name = 'NICInfo'; structurevalue = $nicinfo } ) } } $body += [ordered]@{ systemstateoptions = $systemstateoptions } $body += [ordered]@{ migratevm = "false" } $json = $body | ConvertTo-Json -depth 4 if ($jsonprint -eq "yes") { $compressedjson = $body | ConvertTo-Json -compress -depth 4 Write-host "This is the final command:" Write-host "" Write-host "Post-AGMAPIData -endpoint /backup/$imageid/mount -body `'$compressedjson`'" return } Post-AGMAPIData -endpoint /backup/$imageid/mount -body $json } |