Clone-VirtualMachine

VMware: Creates a new virtual machine from a linked clone

Script

#Requires -Version 5.1
#Requires -Modules VMware.VimAutomation.Core
[CmdletBinding(DefaultParameterSetName = "onDatastore")]
Param(
    [Parameter(Mandatory = $true, ParameterSetName = "onDatastore")]
    [Parameter(Mandatory = $true, ParameterSetName = "onCluster")]
    [string]$VIServer,
    [Parameter(Mandatory = $true, ParameterSetName = "onDatastore")]
    [Parameter(Mandatory = $true, ParameterSetName = "onCluster")]
    [pscredential]$VICredential,
    [Parameter(Mandatory = $true, ParameterSetName = "onDatastore")]
    [Parameter(Mandatory = $true, ParameterSetName = "onCluster")]
    [string]$SourceVMName,
    [Parameter(Mandatory = $true, ParameterSetName = "onDatastore")]
    [Parameter(Mandatory = $true, ParameterSetName = "onCluster")]
    [string]$HostName,
    [Parameter(Mandatory = $true, ParameterSetName = "onDatastore")]
    [Parameter(Mandatory = $true, ParameterSetName = "onCluster")]
    [string]$VMName,
    [Parameter(Mandatory = $true, ParameterSetName = "onDatastore")]
    [string]$DatastoreName,
    [Parameter(Mandatory = $true, ParameterSetName = "onCluster")]
    [string]$ClusterName,
    [Parameter(Mandatory = $true, ParameterSetName = "onDatastore")]
    [Parameter(Mandatory = $true, ParameterSetName = "onCluster")]
    [string]$SnapshotName,
    [Parameter(ParameterSetName = "onDatastore")]
    [Parameter(ParameterSetName = "onCluster")]
    [string]$Notes,
    [Parameter(ParameterSetName = "onDatastore")]
    [Parameter(ParameterSetName = "onCluster")]
    [ValidateSet("Thin", "Thick", "EagerZeroedThick")]
    [string]$DiskStorageFormat = "Thick",
    [Parameter(ParameterSetName = "onDatastore")]
    [Parameter(ParameterSetName = "onCluster")]
    [string]$Location,
    [Parameter(ParameterSetName = "onDatastore")]
    [Parameter(ParameterSetName = "onCluster")]
    [ValidateSet("NonPersistent", "Persistent")]
    [string]$OSCustomizationSpec,
    [Parameter(ParameterSetName = "onCluster")]
    [ValidateSet("FullyAutomated", "Manual", "PartiallyAutomated", "AsSpecifiedByCluster", "Disabled")]
    [string]$DrsAutomationLevel,
    [Parameter(ParameterSetName = "onCluster")]
    [ValidateSet("AsSpecifiedByCluster", "PowerOff", "DoNothing")]
    [string]$HAIsolationResponse,
    [Parameter(ParameterSetName = "onCluster")]
    [ValidateSet("Disabled", "Low", "Medium", "High", "ClusterRestartPriority")]
    [string]$HARestartPriority
)
Process {
    $vmServer = $null
    try {
        [string[]]$Properties = @('Name', 'Id', 'NumCpu', 'CoresPerSocket', 'Notes', 'GuestId', 'MemoryGB', 'VMSwapfilePolicy', 'ProvisionedSpaceGB', 'Folder')
        if ([System.String]::IsNullOrWhiteSpace($Notes)) { $Notes = " " }
        $vmServer = Connect-VIServer -Server $VIServer -Credential $VICredential -ErrorAction Stop
        $timestamp = Get-Date -Format "yyyy-MM-dd HH:mm:ss"
        if ($PSCmdlet.ParameterSetName -eq "onDatastore") {
            $store = Get-Datastore -Server $vmServer -Name $DatastoreName -ErrorAction Stop
        }
        else {
            $store = Get-Cluster -Server $vmServer -Name $ClusterName -ErrorAction Stop
        }
        $source = Get-VM -Server $vmServer -Name $SourceVMName -ErrorAction Stop
        $snapshot = Get-Snapshot -Server $vmServer -Name $SnapshotName -ErrorAction Stop
        $vmHost = Get-VMHost -Server $vmServer -Name $HostName -ErrorAction Stop
        $cmdArgs = @{ ErrorAction = 'Stop'; Server = $vmServer; Name = $VMName; LinkedClone = $null; ReferenceSnapshot = $snapshot; VM = $source; Datastore = $store; DiskStorageFormat = $DiskStorageFormat; VMHost = $vmHost; Notes = $Notes; Confirm = $false }
        if (-not [System.String]::IsNullOrEmpty($Location)) {
            $folder = Get-Folder -Server $vmServer -Name $Location -ErrorAction Stop
            $cmdArgs.Add('Location', $folder)
        }
        $machine = New-VM @cmdArgs | Select-Object $Properties
        if ($PSBoundParameters.ContainsKey('OSCustomizationSpec')) { $null = Set-VM -Server $vmServer -VM $machine -OSCustomizationSpec $OSCustomizationSpec -Confirm:$False -ErrorAction Stop }
        if ($PSCmdlet.ParameterSetName -eq "onCluster") {
            if ($PSBoundParameters.ContainsKey('DrsAutomationLevel')) { $null = Set-VM -Server $vmServer -VM $machine -DrsAutomationLevel $DrsAutomationLevel -Confirm:$False -ErrorAction Stop }
            if ($PSBoundParameters.ContainsKey('HAIsolationResponse')) { $null = Set-VM -Server $vmServer -VM $machine -HAIsolationResponse $HAIsolationResponse -Confirm:$False -ErrorAction Stop }
            if ($PSBoundParameters.ContainsKey('HARestartPriority')) { $null = Set-VM -Server $vmServer -VM $machine -HARestartPriority $HARestartPriority -Confirm:$False -ErrorAction Stop }
        }
        $result = Get-VM -Server $vmServer -Name $VMName | Select-Object $Properties
        foreach ($item in $result) {
            $item | Add-Member -NotePropertyName 'Timestamp' -NotePropertyValue $timestamp -Force
            Write-Output $item
        }
    }
    catch { throw }
    finally { if ($null -ne $vmServer) { Disconnect-VIServer -Server $vmServer -Force -Confirm:$false -ErrorAction SilentlyContinue } }
}

Customize

VIServer string

IP address or DNS name of the vSphere server

VICredential pscredential

PSCredential object for authenticating with the server

SourceVMName string

Virtual machine to clone

HostName string

Host on which to create the new VM

VMName string

Name for the new virtual machine

DatastoreName string

Datastore where to place the new VM

ClusterName string

Datastore cluster where to place the new VM

SnapshotName string

Source snapshot for the linked clone

Notes string

Description of the new VM

DiskStorageFormat string

Storage format of the disks

Location string

Folder where to place the new VM

OSCustomizationSpec string

Customization specification to apply

DrsAutomationLevel string

DRS automation level

HAIsolationResponse string

HA isolation response

HARestartPriority string

HA restart priority