Move-VMHVVirtualMachine.ps1

#Requires -Version 4.0
# Requires -Modules VMware.PowerCLI

<#
.SYNOPSIS
    Move the virtual machine to another location

.DESCRIPTION

.NOTES
    This PowerShell script was developed and optimized for ScriptRunner. The use of the scripts requires ScriptRunner. 
    The customer or user is authorized to copy the script from the repository and use them in ScriptRunner. 
    The terms of use for ScriptRunner do not apply to this script. In particular, ScriptRunner Software GmbH assumes no liability for the function, 
    the use and the consequences of the use of this freely available script.
    PowerShell is a product of Microsoft Corporation. ScriptRunner is a product of ScriptRunner Software GmbH.
    © ScriptRunner Software GmbH

.COMPONENT
    Requires Module VMware.PowerCLI

.LINK
    https://github.com/scriptrunner/ActionPacks/tree/master/VMware/VMs

.Parameter VIServer
    Specifies the IP address or the DNS name of the vSphere server to which you want to connect

.Parameter VICredential
    Specifies a PSCredential object that contains credentials for authenticating with the server

.Parameter VMName
    Specifies the name of the virtual machine you want to move another location

.Parameter DatastoreName
    Specifies the datastore where you want to move the virtual machine

.Parameter FolderName
    Specifies a virtual machine folder where you want to move the virtual machine

.Parameter DatacenterName
    Specifies a datacenter where you want to move the virtual machine

.Parameter ResourcePoolName
    Specifies the resource pool where you want to move the virtual machine

.Parameter HostName
    Specifies the host where you want to move the virtual machine

.Parameter DiskStorageFormat
    Specifies a new storage format for the hard disk of the virtual machine you want to move
#>
#>

[CmdLetBinding()]
Param(
    [Parameter(Mandatory = $true,ParameterSetName = "toDatastore")]
    [Parameter(Mandatory = $true,ParameterSetName = "toDatacenter")]
    [Parameter(Mandatory = $true,ParameterSetName = "toFolder")]
    [Parameter(Mandatory = $true,ParameterSetName = "toHost")]
    [Parameter(Mandatory = $true,ParameterSetName = "toResourcePool")]
    [string]$VIServer,
    [Parameter(Mandatory = $true,ParameterSetName = "toDatastore")]
    [Parameter(Mandatory = $true,ParameterSetName = "toDatacenter")]
    [Parameter(Mandatory = $true,ParameterSetName = "toFolder")]
    [Parameter(Mandatory = $true,ParameterSetName = "toHost")]
    [Parameter(Mandatory = $true,ParameterSetName = "toResourcePool")]
    [pscredential]$VICredential,
    [Parameter(Mandatory = $true,ParameterSetName = "toDatastore")]
    [Parameter(Mandatory = $true,ParameterSetName = "toDatacenter")]
    [Parameter(Mandatory = $true,ParameterSetName = "toFolder")]
    [Parameter(Mandatory = $true,ParameterSetName = "toHost")]
    [Parameter(Mandatory = $true,ParameterSetName = "toResourcePool")]
    [string]$VMName,
    [Parameter(Mandatory = $true,ParameterSetName = "toDatastore")]
    [string]$DatastoreName,    
    [Parameter(Mandatory = $true,ParameterSetName = "toDatacenter")]
    [string]$DatacenterName,
    [Parameter(Mandatory = $true,ParameterSetName = "toFolder")]
    [string]$FolderName,
    [Parameter(Mandatory = $true,ParameterSetName = "toHost")]
    [string]$HostName,
    [Parameter(Mandatory = $true,ParameterSetName = "toResourcePool")]
    [string]$ResourcePoolName,
    [Parameter(ParameterSetName = "toDatastore")]
    [ValidateSet("Thin", "Thick","EagerZeroedThick")]
    [string]$DiskStorageFormat = "Thick"
)

Import-Module VMware.PowerCLI

try{
    [string[]]$Properties = @('Name','Id','PowerState','NumCpu','Notes','Guest','GuestId','MemoryMB','UsedSpaceGB','ProvisionedSpaceGB','Folder')
    $Script:vmServer = Connect-VIServer -Server $VIServer -Credential $VICredential -ErrorAction Stop

    $Script:machine = Get-VM -Server $Script:vmServer -Name $VMName -ErrorAction Stop
    [hashtable]$cmdArgs = @{'ErrorAction' = 'Stop'
                            'Server' = $Script:vmServer
                            'VM' = $Script:machine
                            'Confirm' = $false
                            }

    if($PSCmdlet.ParameterSetName  -eq "toFolder"){
        $folder = Get-Folder -Server $Script:vmServer -Name $FolderName -Type VM -ErrorAction Stop 
        $cmdArgs.Add('InventoryLocation', $folder)
    }
    if($PSCmdlet.ParameterSetName  -eq "toDatacenter"){
        $center = Get-Datacenter -Server $Script:vmServer -Name $DatacenterName -ErrorAction Stop 
        $cmdArgs.Add('InventoryLocation', $center)
    }
    if($PSCmdlet.ParameterSetName  -eq "toHost"){
        $Script:destination = Get-VMHost -Server $Script:vmServer -Name $HostName -ErrorAction Stop
        $cmdArgs.Add('Destination',  $Script:destination)
    }
    if($PSCmdlet.ParameterSetName  -eq "toResourcePool"){
        $Script:destination = Get-ResourcePool -Server $Script:vmServer -Name $ResourcePoolName -ErrorAction Stop
        $cmdArgs.Add('Destination',  $Script:destination)
    }
    if($PSCmdlet.ParameterSetName  -eq "toDatastore"){
        $store = Get-Datastore -Server $Script:vmServer -Name $DatastoreName -ErrorAction Stop
        $cmdArgs.Add('Datastore', $store)
        $cmdArgs.Add('DiskStorageFormat', $DiskStorageFormat)
    }
    $result = Move-VM @cmdArgs | Select-Object $Properties
    
    if($SRXEnv) {
        $SRXEnv.ResultMessage = $result
    }
    else{
        Write-Output $result
    }
}
catch{
    throw
}
finally{    
    if($null -ne $Script:vmServer){
        Disconnect-VIServer -Server $Script:vmServer -Force -Confirm:$false
    }
}