AutomatedLab

5.0.2.4

AutomatedLab.psm1

                                #region Enable-LabHostRemoting

function Enable-LabHostRemoting

{

    # .ExternalHelp AutomatedLab.Help.xml

    Write-LogFunctionEntry

    if (-not (Test-IsAdministrator))

    {

        throw 'This function needs to be called in an elevated PowerShell session.'

    }

    if ((Get-Service -Name WinRM).Status -ne 'Running')

    {

        Start-Service -Name WinRM

        Start-Sleep -Seconds 5

    }

    if ((-not (Get-WSManCredSSP)[0].Contains('The machine is configured to') -and -not (Get-WSManCredSSP)[0].Contains('WSMAN/*')) -or (Get-Item -Path WSMan:\localhost\Client\Auth\CredSSP).Value -eq $false)

    {

        Write-Verbose "Enabling CredSSP on the host machine for role 'Client'. Delegated computers = *"

        Enable-WSManCredSSP -Role Client -DelegateComputer * -Force | Out-Null

    }

    else

    {

        Write-Verbose 'Remoting is enabled on the host machine'

    }

    $trustedHostsList = @((Get-Item -Path Microsoft.WSMan.Management\WSMan::localhost\Client\TrustedHosts).Value -split ',' |

        ForEach-Object { $_.Trim() } |

        Where-Object { $_ }

    )

    if (-not ($trustedHostsList -contains '*'))

    {

        Write-ScreenInfo -Message "TrustedHosts does not include '*'. Replacing the current value '$($trustedHostsList -join ', ')' with '*'" -Type Warning

        Set-Item -Path Microsoft.WSMan.Management\WSMan::localhost\Client\TrustedHosts -Value '*' -Force

    }

    else

    {

        Write-Verbose '''*'' added to TrustedHosts'

    }

    $value = [GPO.Helper]::GetGroupPolicy($true, 'SOFTWARE\Policies\Microsoft\Windows\CredentialsDelegation\AllowFreshCredentials', '1')

    if ($value -ne '*' -and $value -ne 'WSMAN/*')

    {

        Write-ScreenInfo 'Configuring the local policy for allowing credentials to be delegated to all machines (*). You can find the modified policy using gpedit.msc by navigating to: Computer Configuration -> Administrative Templates -> System -> Credentials Delegation -> Allow Delegating Fresh Credentials' -Type Warning

        [GPO.Helper]::SetGroupPolicy($true, 'SOFTWARE\Policies\Microsoft\Windows\CredentialsDelegation', 'AllowFreshCredentials', 1) | Out-Null

        [GPO.Helper]::SetGroupPolicy($true, 'SOFTWARE\Policies\Microsoft\Windows\CredentialsDelegation', 'ConcatenateDefaults_AllowFresh', 1) | Out-Null

        [GPO.Helper]::SetGroupPolicy($true, 'SOFTWARE\Policies\Microsoft\Windows\CredentialsDelegation\AllowFreshCredentials', '1', 'WSMAN/*') | Out-Null

    }

    else

    {

        Write-Verbose "Local policy 'Computer Configuration -> Administrative Templates -> System -> Credentials Delegation -> Allow Delegating Fresh Credentials' configured correctly"

    }

    $value = [GPO.Helper]::GetGroupPolicy($true, 'SOFTWARE\Policies\Microsoft\Windows\CredentialsDelegation\AllowSavedCredentials', '1')

    if ($value -ne '*' -and $value -ne 'TERMSRV/*')

    {

        Write-ScreenInfo 'Configuring the local policy for allowing credentials to be delegated to all machines (*). You can find the modified policy using gpedit.msc by navigating to: Computer Configuration -> Administrative Templates -> System -> Credentials Delegation -> Allow Delegating Fresh Credentials' -Type Warning

        [GPO.Helper]::SetGroupPolicy($true, 'SOFTWARE\Policies\Microsoft\Windows\CredentialsDelegation', 'AllowSavedCredentials', 1) | Out-Null

        [GPO.Helper]::SetGroupPolicy($true, 'SOFTWARE\Policies\Microsoft\Windows\CredentialsDelegation', 'ConcatenateDefaults_AllowSaved', 1) | Out-Null

        [GPO.Helper]::SetGroupPolicy($true, 'SOFTWARE\Policies\Microsoft\Windows\CredentialsDelegation\AllowSavedCredentials', '1', 'TERMSRV/*') | Out-Null

    }

    else

    {

        Write-Verbose "Local policy 'Computer Configuration -> Administrative Templates -> System -> Credentials Delegation -> Allow Delegating Saved Credentials' configured correctly"

    }

    $value = [GPO.Helper]::GetGroupPolicy($true, 'SOFTWARE\Policies\Microsoft\Windows\CredentialsDelegation\AllowFreshCredentialsWhenNTLMOnly', '1')

    if ($value -ne '*' -and $value -ne 'WSMAN/*')

    {

        Write-ScreenInfo 'Configuring the local policy for allowing credentials to be delegated to all machines (*). You can find the modified policy using gpedit.msc by navigating to: Computer Configuration -> Administrative Templates -> System -> Credentials Delegation -> Allow Delegating Fresh Credentials with NTLM-only server authentication' -Type Warning

        [GPO.Helper]::SetGroupPolicy($true, 'SOFTWARE\Policies\Microsoft\Windows\CredentialsDelegation', 'AllowFreshCredentialsWhenNTLMOnly', 1) | Out-Null

        [GPO.Helper]::SetGroupPolicy($true, 'SOFTWARE\Policies\Microsoft\Windows\CredentialsDelegation', 'ConcatenateDefaults_AllowFreshNTLMOnly', 1) | Out-Null

        [GPO.Helper]::SetGroupPolicy($true, 'SOFTWARE\Policies\Microsoft\Windows\CredentialsDelegation\AllowFreshCredentialsWhenNTLMOnly', '1', 'WSMAN/*') | Out-Null

    }

    else

    {

        Write-Verbose "Local policy 'Computer Configuration -> Administrative Templates -> System -> Credentials Delegation -> Allow Delegating Fresh Credentials when NTLM only' configured correctly"

    }

    $value = [GPO.Helper]::GetGroupPolicy($true, 'SOFTWARE\Policies\Microsoft\Windows\CredentialsDelegation\AllowSavedCredentialsWhenNTLMOnly', '1')

    if ($value -ne '*' -and $value -ne 'TERMSRV/*')

    {

        Write-ScreenInfo 'Configuring the local policy for allowing credentials to be delegated to all machines (*). You can find the modified policy using gpedit.msc by navigating to: Computer Configuration -> Administrative Templates -> System -> Credentials Delegation -> Allow Delegating Fresh Credentials with NTLM-only server authentication' -Type Warning

        [GPO.Helper]::SetGroupPolicy($true, 'SOFTWARE\Policies\Microsoft\Windows\CredentialsDelegation', 'AllowSavedCredentialsWhenNTLMOnly', 1) | Out-Null

        [GPO.Helper]::SetGroupPolicy($true, 'SOFTWARE\Policies\Microsoft\Windows\CredentialsDelegation', 'ConcatenateDefaults_AllowSavedNTLMOnly', 1) | Out-Null

        [GPO.Helper]::SetGroupPolicy($true, 'SOFTWARE\Policies\Microsoft\Windows\CredentialsDelegation\AllowSavedCredentialsWhenNTLMOnly', '1', 'TERMSRV/*') | Out-Null

    }

    else

    {

        Write-Verbose "Local policy 'Computer Configuration -> Administrative Templates -> System -> Credentials Delegation -> Allow Delegating Saved Credentials when NTLM only' configured correctly"

    }

    Write-LogFunctionExit

}

#endregion Enable-LabHostRemoting

#region Import-Lab

function Import-Lab

{

    #.ExternalHelp AutomatedLab.help.xml

    [CmdletBinding(DefaultParameterSetName = 'ByName')]

    param (

        [Parameter(Mandatory, ParameterSetName = 'ByPath', Position = 1)]

        [string]$Path,

        [Parameter(Mandatory, ParameterSetName = 'ByName', Position = 1)]

        [string]$Name,

        [Parameter(Mandatory, ParameterSetName = 'ByValue', Position = 1)]

        [byte[]]$LabBytes,

        [switch]$PassThru,

        [switch]$NoValidation,

        [switch]$NoDisplay

    )

    Write-LogFunctionEntry

    Clear-Lab

    if ($PSCmdlet.ParameterSetName -in 'ByPath', 'ByName')

    {

        if ($Name)

        {

            $Path = "$([System.Environment]::GetFolderPath([System.Environment+SpecialFolder]::CommonApplicationData))\AutomatedLab\Labs\$Name"

        }

        if (Test-Path -Path $Path -PathType Container)

        {

            $newPath = Join-Path -Path $Path -ChildPath Lab.xml

            if (-not (Test-Path -Path $newPath -PathType Leaf))

            {

                throw "The file '$newPath' is missing. Please point to an existing lab file / folder."

            }

            else

            {

                $Path = $newPath

            }

        }

        elseif (Test-Path -Path $Path -PathType Leaf)

        {

            #file is there, no nothing

        }

        else

        {

            throw "The file '$Path' is missing. Please point to an existing lab file / folder."

        }

        if (Get-PSsession)

        {

            Get-PSSession | Remove-PSSession -ErrorAction SilentlyContinue

        }

        Enable-LabHostRemoting

        if (-not (Test-IsAdministrator))

        {

            throw 'This function needs to be called in an elevated PowerShell session.'

        }

        if ((Get-Item -Path Microsoft.WSMan.Management\WSMan::localhost\Client\TrustedHosts -Force).Value -ne '*')

        {

            Write-ScreenInfo 'The host system is not prepared yet. Call the cmdlet Set-LabHost to set the requirements' -Type Warning

            Write-ScreenInfo 'After installing the lab you should undo the changes for security reasons' -Type Warning

            throw "TrustedHosts need to be set to '*' in order to be able to connect to the new VMs. Please run the cmdlet 'Set-LabHostRemoting' to make the required changes."

        }

        $value = [GPO.Helper]::GetGroupPolicy($true, 'SOFTWARE\Policies\Microsoft\Windows\CredentialsDelegation\AllowFreshCredentials', '1')

        if ($value -ne '*' -and $value -ne 'WSMAN/*')

        {

            throw "Please configure the local policy for allowing credentials to be delegated. Use gpedit.msc and look at the following policy: Computer Configuration -> Administrative Templates -> System -> Credentials Delegation -> Allow Delegating Fresh Credentials. Just add '*' to the server list to be able to delegate credentials to all machines."

        }

        if (-not $NoValidation)

        {

            Write-ScreenInfo -Message 'Validating lab definition' -TaskStart

            foreach ($machine in (Get-LabMachineDefinition | Where-Object HostType -in 'HyperV', 'VMware' ))

            {

                if ((Get-HostEntry -HostName $machine) -and (Get-HostEntry -HostName $machine).IpAddress.IPAddressToString -ne $machine.IpV4Address)

                {

                    throw "There is already an entry for machine '$($machine.Name)' in the hosts file pointing to other IP address(es) ($((Get-HostEntry -HostName $machine).IpAddress.IPAddressToString -join ',')) than the machine '$($machine.Name)' in this lab will have ($($machine.IpV4Address)). Cannot continue."

                }

            }

            $validation = Test-LabDefinition -Path $Path -Quiet

            if ($validation)

            {

                Write-ScreenInfo -Message 'Success' -TaskEnd -Type Info

            }

            else

            {

                break

            }

        }

        if (Test-Path -Path $Path)

        {

            $Script:data = [AutomatedLab.Lab]::Import((Resolve-Path -Path $Path))

            $Script:data | Add-Member -MemberType ScriptMethod -Name GetMachineTargetPath -Value {

                param (

                    [string]$MachineName

                )

                (Join-Path -Path $this.Target.Path -ChildPath $MachineName)

            }

        }

        else

        {

            throw 'Lab Definition File not found'

        }

        #import all the machine files referenced in the lab.xml

        $type = Get-Type -GenericType AutomatedLab.ListXmlStore -T AutomatedLab.Machine

        $importMethodInfo = $type.GetMethod('Import',[System.Reflection.BindingFlags]::Public -bor [System.Reflection.BindingFlags]::Static, [System.Type]::DefaultBinder, [Type[]]@([string]), $null)

        try

        {

            $Script:data.Machines = $importMethodInfo.Invoke($null, $Script:data.MachineDefinitionFiles[0].Path)

            if ($Script:data.MachineDefinitionFiles.Count -gt 1)

            {

                foreach ($machineDefinitionFile in $Script:data.MachineDefinitionFiles[1..($Script:data.MachineDefinitionFiles.Count - 1)])

                {

                    $Script:data.Machines.AddFromFile($machineDefinitionFile.Path)

                }

            }

            if ($Script:data.Machines)

            {

                $Script:data.Machines | Add-Member -MemberType ScriptProperty -Name UnattendedXmlContent -Value {

                    if ($this.OperatingSystem.Version -lt '6.2')

                    {

                        $Path = Join-Path -Path (Get-Lab).Sources.UnattendedXml.Value -ChildPath 'Unattended2008.xml'

                    }

                    else

                    {

                        $Path = Join-Path -Path (Get-Lab).Sources.UnattendedXml.Value -ChildPath 'Unattended2012.xml'

                    }

                    if ($this.OperatingSystemType -eq 'Linux' -and $this.LinuxType -eq 'RedHat')

                    {

                        $Path = Join-Path -Path (Get-Lab).Sources.UnattendedXml.Value -ChildPath ks.cfg

                    }

                    if ($this.OperatingSystemType -eq 'Linux' -and $this.LinuxType -eq 'Suse')

                    {

                        $Path = Join-Path -Path (Get-Lab).Sources.UnattendedXml.Value -ChildPath autoinst.xml

                    }

                    return (Get-Content -Path $Path)

                }

            }

        }

        catch

        {

            Write-Error -Message "No machines imported from file $machineDefinitionFile" -Exception $_.Exception -ErrorAction Stop

        }

        $minimumAzureModuleVersion = $MyInvocation.MyCommand.Module.PrivateData.MinimumAzureModuleVersion

        if (($Script:data.Machines | Where-Object HostType -eq Azure) -and -not (Get-Module -Name AzureRm -ListAvailable | Where-Object Version -ge $minimumAzureModuleVersion))

        {

            throw "The Azure PowerShell module version $($minimumAzureModuleVersion) or greater is not available. Please install it using the command 'Install-Module -Name AzureRm -Force'"

        }

        if (($Script:data.Machines | Where-Object HostType -eq VMWare) -and ((Get-PSSnapin -Name VMware.VimAutomation.*).Count -ne 1))

        {

            throw 'The VMWare snapin was not loaded. Maybe it is missing'

        }

        #import all the disk files referenced in the lab.xml

        $type = Get-Type -GenericType AutomatedLab.ListXmlStore -T AutomatedLab.Disk

        $importMethodInfo = $type.GetMethod('Import',[System.Reflection.BindingFlags]::Public -bor [System.Reflection.BindingFlags]::Static, [System.Type]::DefaultBinder, [Type[]]@([string]), $null)

        try

        {

            $Script:data.Disks = $importMethodInfo.Invoke($null, $Script:data.DiskDefinitionFiles[0].Path)

            if ($Script:data.DiskDefinitionFiles.Count -gt 1)

            {

                foreach ($diskDefinitionFile in $Script:data.DiskDefinitionFiles[1..($Script:data.DiskDefinitionFiles.Count - 1)])

                {

                    $Script:data.Disks.AddFromFile($diskDefinitionFile.Path)

                }

            }

        }

        catch

        {

            Write-ScreenInfo "No disks imported from file '$diskDefinitionFile': $($_.Exception.Message)" -Type Warning

        }

        if($Script:data.AzureSettings.AzureProfilePath -and (Test-Path -Path $Script:data.AzureSettings.AzureProfilePath))

        {

            Add-LabAzureSubscription -Path $Script:data.AzureSettings.AzureProfilePath -DefaultLocationName $Script:data.AzureSettings.DefaultLocation.DisplayName `

            -DefaultStorageAccountName $Script:data.AzureSettings.DefaultStorageAccount `

            -SubscriptionName $Script:data.AzureSettings.DefaultSubscription `

            -DefaultResourceGroupName $script:data.Name

        }

        elseif ($Script:data.AzureSettings.SubscriptionFileContent)

        {

            $tempFilePath = [System.IO.Path]::GetTempFileName()

            $Script:data.AzureSettings.SubscriptionFileContent | Out-File -FilePath $tempFilePath -Encoding ascii

            Add-LabAzureSubscription -Path $tempFilePath -DefaultLocationName $Script:data.AzureSettings.DefaultLocation.DisplayName `

            -DefaultStorageAccountName $Script:data.AzureSettings.DefaultStorageAccount `

            -SubscriptionName $Script:data.AzureSettings.DefaultSubscription `

            -DefaultResourceGroupName $script:data.Name

            Remove-Item -Path $tempFilePath -Force

        }

        if ($Script:data.VMWareSettings.DataCenterName)

        {

            Add-LabVMWareSettings -DataCenterName $Script:data.VMWareSettings.DataCenterName `

            -DataStoreName $Script:data.VMWareSettings.DataStoreName `

            -ResourcePoolName $Script:data.VMWareSettings.ResourcePoolName `

            -VCenterServerName $Script:data.VMWareSettings.VCenterServerName `

            -Credential ([System.Management.Automation.PSSerializer]::Deserialize($Script:data.VMWareSettings.Credential))

        }

        $powerSchemeBackup = (powercfg.exe -GETACTIVESCHEME).Split(':')[1].Trim().Split()[0]

        powercfg.exe -setactive 8c5e7fda-e8bf-4a96-9a85-a6e23a8c635c

    }

    elseif($PSCmdlet.ParameterSetName -eq 'ByValue')

    {

        $Script:data = [AutomatedLab.Lab]::Import($LabBytes)

    }

    if ($PassThru)

    {

        $Script:data

    }

    Write-ScreenInfo ("Lab '{0}' hosted on '{1}' imported with {2} machines" -f $Script:data.Name, $Script:data.DefaultVirtualizationEngine ,$Script:data.Machines.Count) -Type Info

    Write-LogFunctionExit -ReturnValue $true

}

#endregion Import-Lab

#region Export-Lab

function Export-Lab

{

    # .ExternalHelp AutomatedLab.Help.xml

    [cmdletBinding()]

    param ()

    Write-LogFunctionEntry

    $lab = Get-Lab

    Remove-Item -Path $lab.LabFilePath

    Remove-Item -Path $lab.MachineDefinitionFiles[0].Path

    Remove-Item -Path $lab.DiskDefinitionFiles[0].Path

    $lab.Machines.Export($lab.MachineDefinitionFiles[0].Path)

    $lab.Disks.Export($lab.DiskDefinitionFiles[0].Path)

    $lab.Machines.Clear()

    $lab.Disks.Clear()

    $lab.Export($lab.LabFilePath)

    $lab.Disks.AddFromFile($lab.DiskDefinitionFiles[0].Path)

    $lab.Machines.AddFromFile($lab.MachineDefinitionFiles[0].Path)

    Write-LogFunctionExit

}

#endregion Export-LabDefinition

#region Get-Lab

function Get-Lab

{

    # .ExternalHelp AutomatedLab.Help.xml

    [CmdletBinding()]

    [OutputType([AutomatedLab.Lab])]

    param (

        [switch]$List

    )

    if ($List)

    {

        $labsPath = "$([System.Environment]::GetFolderPath([System.Environment+SpecialFolder]::CommonApplicationData))\AutomatedLab\Labs"

        foreach ($path in Get-ChildItem -Path $labsPath -Directory)

        {

            $labXmlPath = Join-Path -Path $path.FullName -ChildPath Lab.xml

            if (Test-Path -Path $labXmlPath)

            {

                Split-Path -Path $path -Leaf

            }

        }    

    }

    else

    {

        if ($Script:data)

        {

            $Script:data

        }

        else

        {

            Write-Error 'Lab data not available. Use Import-Lab and reference a Lab.xml to import one.'

        }

    }

}

#endregion Get-Lab

#region Clear-Lab

function Clear-Lab

{

    # .ExternalHelp AutomatedLab.Help.xml

    [cmdletBinding()]

    param ()

    Write-LogFunctionEntry

    $Script:data = $null

    foreach ($module in $MyInvocation.MyCommand.Module.NestedModules | Where-Object ModuleType -eq 'Script')

    {

        & $module { $Script:data = $null }

    }

    Write-LogFunctionExit

}

#endregion Clear-Lab

#region Install-Lab

function Install-Lab

{

    #.ExternalHelp AutomatedLab.help.xml

    [cmdletBinding()]

    param (

        [switch]$NetworkSwitches,

        [switch]$BaseImages,

        [switch]$VMs,

        [switch]$Domains,

        [switch]$AdTrusts,

        [switch]$DHCP,

        [switch]$Routing,

        [switch]$PostInstallations,

        [switch]$SQLServers,

        [switch]$Orchestrator2012,

        [switch]$WebServers,

        [switch]$Sharepoint2013,

        [switch]$CA,

        [switch]$ADFS,

        [switch]$DSCPullServer,

        [switch]$ConfigManager2012R2,

        [switch]$VisualStudio,

        [switch]$Office2013,

        [switch]$Office2016,

        [switch]$AzureServices,

        [switch]$TeamFoundation,

        [switch]$StartRemainingMachines,

        [switch]$CreateCheckPoints,

        [int]$DelayBetweenComputers,

        [switch]$NoValidation

    )

    Write-LogFunctionEntry

    $labDiskDeploymentInProgressPath = $PSCmdlet.MyInvocation.MyCommand.Module.PrivateData.DiskDeploymentInProgressPath

    #perform full install if no role specific installation is requested

    $performAll = -not ($PSBoundParameters.Keys | Where-Object { $_ -notin ('NoValidation', 'DelayBetweenComputers' + [System.Management.Automation.Internal.CommonParameters].GetProperties().Name)}).Count

    if (-not $Global:labExported -and -not (Get-Lab -ErrorAction SilentlyContinue))

    {

        Export-LabDefinition -Force -ExportDefaultUnattendedXml

        Write-ScreenInfo -Message 'Done' -TaskEnd

    }

    if ($Global:labExported -and -not (Get-Lab -ErrorAction SilentlyContinue))

    {

        if ($NoValidation)

        {

            Import-Lab -Path (Get-LabDefinition).LabFilePath -NoValidation

        }

        else

        {

            Import-Lab -Path (Get-LabDefinition).LabFilePath

        }

    }

    if (-not $Script:data)

    {

        Write-Error 'No definitions imported, so there is nothing to test. Please use Import-Lab against the xml file'

        return

    }

    try

    {

        [AutomatedLab.LabTelemetry]::Instance.LabStarted((Get-Lab).Export(), (Get-Module AutomatedLab)[-1].Version, $PSVersionTable.BuildVersion, $PSVersionTable.PSVersion)

    }

    catch

    {

        # Nothing to catch - if an error occurs, we simply do not get telemetry.

        Write-Verbose -Message ('Error sending telemetry: {0}' -f $_.Exception)

    }

    Unblock-LabSources

    Send-ALNotification -Activity 'Lab started' -Message ('Lab deployment started with {0} machines' -f (Get-LabVM).Count) -Provider $PSCmdlet.MyInvocation.MyCommand.Module.PrivateData.NotificationProviders

    if (Get-LabVM -All -IncludeLinux | Where-Object HostType -eq 'HyperV')

    {

        Update-LabMemorySettings

    }

    if ($NetworkSwitches -or $performAll)

    {

        Write-ScreenInfo -Message 'Creating virtual networks' -TaskStart

        New-LabNetworkSwitches

        Write-ScreenInfo -Message 'Done' -TaskEnd

    }

    if (($BaseImages -or $performAll) -and (Get-LabVM -All | Where-Object HostType -eq 'HyperV'))

    {

        try

        {

            if (Test-Path -Path $labDiskDeploymentInProgressPath)

            {

                Write-ScreenInfo "Another lab disk deployment seems to be in progress. If this is not correct, please delete the file '$labDiskDeploymentInProgressPath'." -Type Warning

                Write-ScreenInfo 'Waiting until other disk deployment is finished.' -NoNewLine

                do

                {

                    Write-ScreenInfo -Message . -NoNewLine

                    Start-Sleep -Seconds 15

                } while (Test-Path -Path $labDiskDeploymentInProgressPath)

            }

            Write-ScreenInfo 'done'

            Write-ScreenInfo -Message 'Creating base images' -TaskStart

            New-Item -Path $labDiskDeploymentInProgressPath -ItemType File -Value ($Script:data).Name | Out-Null

            New-LabBaseImages        

            Write-ScreenInfo -Message 'Done' -TaskEnd

        }

        finally

        {

            Remove-Item -Path $labDiskDeploymentInProgressPath -Force

        }

    }

    if ($VMs -or $performAll)

    {

        try

        {

            if (Test-Path -Path $labDiskDeploymentInProgressPath)

            {

                Write-ScreenInfo "Another lab disk deployment seems to be in progress. If this is not correct, please delete the file '$labDiskDeploymentInProgressPath'." -Type Warning

                do

                {

                    Write-ScreenInfo -Message . -NoNewLine

                    Start-Sleep -Seconds 15

                } while (Test-Path -Path $labDiskDeploymentInProgressPath)

            }

            Write-ScreenInfo 'done'

            Write-ScreenInfo -Message 'Creating VMs' -TaskStart

            New-Item -Path $labDiskDeploymentInProgressPath -ItemType File -Value ($Script:data).Name | Out-Null

            if (Get-LabVM -All -IncludeLinux | Where-Object HostType -eq 'HyperV')

            {

                New-LabVHDX

            }

            #add a hosts entry for each lab machine

            $hostFileAddedEntries = 0

            foreach ($machine in $Script:data.Machines)

            {

                if ($machine.Hosttype -eq 'HyperV' -and $machine.NetworkAdapters[0].Ipv4Address)

                {

                    $hostFileAddedEntries += Add-HostEntry -HostName $machine.Name -IpAddress $machine.IpV4Address -Section $Script:data.Name

                    $hostFileAddedEntries += Add-HostEntry -HostName $machine.FQDN -IpAddress $machine.IpV4Address -Section $Script:data.Name

                }

            }

            if ($hostFileAddedEntries)

            {

                Write-ScreenInfo -Message "The hosts file has been added $hostFileAddedEntries records. Clean them up using 'Remove-Lab' or manually if needed" -Type Warning

            }

            if ($script:data.Machines)

            {

                New-LabVM -Name $script:data.Machines -CreateCheckPoints:$CreateCheckPoints

            }

            #VMs created, export lab definition again to update MAC addresses

            Set-LabDefinition -Machines $Script:data.Machines

            Export-LabDefinition -Force -ExportDefaultUnattendedXml -Silent        

            Write-ScreenInfo -Message 'Done' -TaskEnd

        }

        finally

        {

            Remove-Item -Path $labDiskDeploymentInProgressPath -Force

        }

    }

    #Root DCs are installed first, then the Routing role is installed in order to allow domain joined routers in the root domains

    if (($Domains -or $performAll) -and (Get-LabVM -Role RootDC))

    {

        Write-ScreenInfo -Message 'Installing Root Domain Controllers' -TaskStart

        if (Get-LabVM -Role RootDC)

        {

            Write-ScreenInfo -Message "Machines with RootDC role to be installed: '$((Get-LabVM -Role RootDC).Name -join ', ')'"

            Install-LabRootDcs -CreateCheckPoints:$CreateCheckPoints

        }

        Write-ScreenInfo -Message 'Done' -TaskEnd

    }

    if (($Routing -or $performAll) -and (Get-LabVM -Role Routing))

    {

        Write-ScreenInfo -Message 'Configuring routing' -TaskStart

        Install-LabRouting

        Write-ScreenInfo -Message 'Done' -TaskEnd

    }

    if (($DHCP -or $performAll) -and (Get-LabVM -Role DHCP))

    {

        Write-ScreenInfo -Message 'Configuring DHCP servers' -TaskStart

        Install-DHCP

        Write-ScreenInfo -Message 'Done' -TaskEnd

    }

    if (($Domains -or $performAll) -and (Get-LabVM -Role FirstChildDC))

    {

        Write-ScreenInfo -Message 'Installing Child Domain Controllers' -TaskStart

        if (Get-LabVM -Role FirstChildDC)

        {

            Write-ScreenInfo -Message "Machines with FirstChildDC role to be installed: '$((Get-LabVM -Role FirstChildDC).Name -join ', ')'"

            Install-LabFirstChildDcs -CreateCheckPoints:$CreateCheckPoints

        }

        New-LabADSubnet

        $allDcVMs = Get-LabVM -Role RootDC, FirstChildDC

        if ($allDcVMs)

        {

            if ($CreateCheckPoints)

            {

                Write-ScreenInfo -Message 'Creating a snapshot of all domain controllers'

                Checkpoint-LabVM -ComputerName $allDcVMs -SnapshotName 'Post Forest Setup'

            }

        }

        Write-ScreenInfo -Message 'Done' -TaskEnd

    }

    if (($Domains -or $performAll) -and (Get-LabVM -Role DC))

    {

        Write-ScreenInfo -Message 'Installing Additional Domain Controllers' -TaskStart

        if (Get-LabVM -Role DC)

        {

            Write-ScreenInfo -Message "Machines with DC role to be installed: '$((Get-LabVM -Role DC).Name -join ', ')'"

            Install-LabDcs -CreateCheckPoints:$CreateCheckPoints

        }

        New-LabADSubnet

        $allDcVMs = Get-LabVM -Role RootDC, FirstChildDC, DC

        if ($allDcVMs)

        {

            if ($CreateCheckPoints)

            {

                Write-ScreenInfo -Message 'Creating a snapshot of all domain controllers'

                Checkpoint-LabVM -ComputerName $allDcVMs -SnapshotName 'Post Forest Setup'

            }

        }

        Write-ScreenInfo -Message 'Done' -TaskEnd

    }

    if (($AdTrusts -or $performAll) -and ((Get-LabVM -Role RootDC | Measure-Object).Count -gt 1))

    {

        Write-ScreenInfo -Message 'Configuring DNS forwarding and AD trusts' -TaskStart

        Install-LabDnsForwarder

        Install-LabADDSTrust

        Write-ScreenInfo -Message 'Done' -TaskEnd

    }

    if (($CA -or $performAll) -and ((Get-LabVM -Role CaRoot) -or (Get-LabVM -Role CaSubordinate)))

    {

        Write-ScreenInfo -Message 'Installing Certificate Servers' -TaskStart

        Install-LabCA -CreateCheckPoints:$CreateCheckPoints

        Write-ScreenInfo -Message 'Done' -TaskEnd

    }

    if (($DSCPullServer -or $performAll) -and (Get-LabVM -Role DSCPullServer))

    {

        Start-LabVM -RoleName DSCPullServer -ProgressIndicator 15 -PostDelaySeconds 5 -Wait

        Write-ScreenInfo -Message 'Installing DSC Pull Servers' -TaskStart

        Install-LabDscPullServer

        Write-ScreenInfo -Message 'Done' -TaskEnd

    }

    if (($FailoverCluster -or $performAll) -and (Get-LabVm -Role FailoverNode,FailoverStorage))

    {

        Write-ScreenInfo -Message 'Installing Failover cluster' -TaskStart

        Start-LabVm -RoleName FailoverNode,FailoverStorage -ProgressIndicator 15 -PostDelaySeconds 5 -Wait        

        Install-LabFailoverCluster

        Write-ScreenInfo -Message 'Done' -TaskEnd

    }

    if (($SQLServers -or $performAll) -and (Get-LabVM -Role SQLServer2008, SQLServer2012, SQLServer2014, SQLServer2016, SQLServer2017))

    {

        Write-ScreenInfo -Message 'Installing SQL Servers' -TaskStart

        if (Get-LabVM -Role SQLServer2008)   { Write-ScreenInfo -Message "Machines to have SQL Server 2008 installed: '$((Get-LabVM -Role SQLServer2008).Name -join ', ')'" }

        if (Get-LabVM -Role SQLServer2008R2) { Write-ScreenInfo -Message "Machines to have SQL Server 2008 R2 installed: '$((Get-LabVM -Role SQLServer2008R2).Name -join ', ')'" }

        if (Get-LabVM -Role SQLServer2012)   { Write-ScreenInfo -Message "Machines to have SQL Server 2012 installed: '$((Get-LabVM -Role SQLServer2012).Name -join ', ')'" }

        if (Get-LabVM -Role SQLServer2014)   { Write-ScreenInfo -Message "Machines to have SQL Server 2014 installed: '$((Get-LabVM -Role SQLServer2014).Name -join ', ')'" }

        if (Get-LabVM -Role SQLServer2016)   { Write-ScreenInfo -Message "Machines to have SQL Server 2016 installed: '$((Get-LabVM -Role SQLServer2016).Name -join ', ')'" }

        if (Get-LabVM -Role SQLServer2017)   { Write-ScreenInfo -Message "Machines to have SQL Server 2017 installed: '$((Get-LabVM -Role SQLServer2017).Name -join ', ')'" }

        Install-LabSqlServers -CreateCheckPoints:$CreateCheckPoints

        Write-ScreenInfo -Message 'Done' -TaskEnd

    }

    if (($ADFS -or $performAll) -and (Get-LabVM -Role ADFS))

    {

        Write-ScreenInfo -Message 'Configuring ADFS' -TaskStart

        Install-LabAdfs

        Write-ScreenInfo -Message 'Done' -TaskEnd

        Write-ScreenInfo -Message 'Configuring ADFS Proxies' -TaskStart

        Install-LabAdfsProxy

        Write-ScreenInfo -Message 'Done' -TaskEnd

    }

    if (($WebServers -or $performAll) -and (Get-LabVM -Role WebServer))

    {

        Write-ScreenInfo -Message 'Installing Web Servers' -TaskStart

        Write-ScreenInfo -Message "Machines to have Web Server role installed: '$((Get-LabVM -Role WebServer).Name -join ', ')'"

        Install-LabWebServers -CreateCheckPoints:$CreateCheckPoints

        Write-ScreenInfo -Message 'Done' -TaskEnd

    }

    if (($Orchestrator2012 -or $performAll) -and (Get-LabVM -Role Orchestrator2012))

    {

        Write-ScreenInfo -Message 'Installing Orchestrator Servers' -TaskStart

        Install-LabOrchestrator2012

        Write-ScreenInfo -Message 'Done' -TaskEnd

    }

    if (($SharePoint2013 -or $performAll) -and (Get-LabVM -Role SharePoint2013))

    {

        Write-ScreenInfo -Message 'Installing SharePoint 2013 Servers' -TaskStart

        Install-LabSharePoint2013

        Write-ScreenInfo -Message 'Done' -TaskEnd

    }

    if (($VisualStudio -or $performAll) -and (Get-LabVM -Role VisualStudio2013))

    {

        Write-ScreenInfo -Message 'Installing Visual Studio 2013' -TaskStart

        Write-ScreenInfo -Message "Machines to have Visual Studio 2013 installed: '$((Get-LabVM -Role VisualStudio2013).Name -join ', ')'"

        Install-VisualStudio2013

        Write-ScreenInfo -Message 'Done' -TaskEnd

    }

    if (($VisualStudio -or $performAll) -and (Get-LabVM -Role VisualStudio2015))

    {

        Write-ScreenInfo -Message 'Installing Visual Studio 2015' -TaskStart

        Write-ScreenInfo -Message "Machines to have Visual Studio 2015 installed: '$((Get-LabVM -Role VisualStudio2015).Name -join ', ')'"

        Install-VisualStudio2015

        Write-ScreenInfo -Message 'Done' -TaskEnd

    }

    if (($Office2013 -or $performAll) -and (Get-LabVM -Role Office2013))

    {

        Write-ScreenInfo -Message 'Installing Office 2013' -TaskStart

        Write-ScreenInfo -Message "Machines to have Office 2013 installed: '$((Get-LabVM -Role Office2013).Name -join ', ')'"

        Install-LabOffice2013

        Write-ScreenInfo -Message 'Done' -TaskEnd

    }

    if (($Office2016 -or $performAll) -and (Get-LabVM -Role Office2016))

    {

        Write-ScreenInfo -Message 'Installing Office 2016' -TaskStart

        Write-ScreenInfo -Message "Machines to have Office 2016 installed: '$((Get-LabVM -Role Office2016).Name -join ', ')'"

        Install-LabOffice2016

        Write-ScreenInfo -Message 'Done' -TaskEnd

    }

    if (($TeamFoundation -or $performAll) -and (Get-LabVM -Role Tfs2015,Tfs2017,Tfs2018,TfsBuildWorker))

    {

        Write-ScreenInfo -Message 'Installing Team Foundation Server environment'

        Write-ScreenInfo -Message "Machines to have TFS or the build agent installed: '$((Get-LabVM -Role Tfs2015,Tfs2017,Tfs2018,TfsBuildWorker).Name -join ', ')'"

        Start-LabVm -RoleName Tfs2015,Tfs2017,Tfs2018,TfsBuildWorker -ProgressIndicator 15 -PostDelaySeconds 5 -Wait     

        Install-LabTeamFoundationEnvironment

        Write-ScreenInfo -Message 'Team Foundation Server environment deployed'

    }

    if (($StartRemainingMachines -or $performAll) -and (Get-LabVM -IncludeLinux))

    {

        Write-ScreenInfo -Message 'Starting remaining machines' -TaskStart

        Write-ScreenInfo -Message 'Waiting for machines to start up...' -NoNewLine

        if ($DelayBetweenComputers){

            $DelayBetweenComputers = ([int]((Get-LabVM -IncludeLinux).HostType -contains 'HyperV') * 30)

        }

        Start-LabVM -All -DelayBetweenComputers $DelayBetweenComputers -ProgressIndicator 30 -TimeoutInMinutes 60 -Wait

        Write-ScreenInfo -Message 'Done' -TaskEnd

    }

    if (($PostInstallations -or $performAll) -and (Get-LabVM))

    {

        $jobs = Invoke-LabCommand -PostInstallationActivity -ActivityName 'Post-installation' -ComputerName (Get-LabVM) -PassThru -NoDisplay 

        #PostInstallations can be installed as jobs or as direct calls. If there are jobs returned, wait until they are finished

        $jobs | Where-Object { $_ -is [System.Management.Automation.Job] } | Wait-Job | Out-Null

    }

    if (($AzureServices -or $performAll) -and (Get-LabAzureWebApp))

    {

        Write-ScreenInfo -Message 'Starting deployment of Azure services' -TaskStart

        Install-LabAzureServices

        Write-ScreenInfo -Message 'Done' -TaskEnd

    }

    try

    {

        [AutomatedLab.LabTelemetry]::Instance.LabFinished((Get-Lab).Export())

    }

    catch

    {

        # Nothing to catch - if an error occurs, we simply do not get telemetry.

        Write-Verbose -Message ('Error sending telemetry: {0}' -f $_.Exception)

    }

    Send-ALNotification -Activity 'Lab finished' -Message 'Lab deployment successfully finished.' -Provider $PSCmdlet.MyInvocation.MyCommand.Module.PrivateData.NotificationProviders

    Write-LogFunctionExit

}

#endregion Install-Lab

#region Remove-Lab

function Remove-Lab

{

    # .ExternalHelp AutomatedLab.Help.xml

    [CmdletBinding(DefaultParameterSetName = 'Path', ConfirmImpact = 'High', SupportsShouldProcess)]

    param (

        [Parameter(Mandatory, ParameterSetName = 'ByPath')]

        [string]$Path,

        [Parameter(Mandatory, ParameterSetName = 'ByName', Position = 1)]

        [string]$Name

    )

    Write-LogFunctionEntry

    if ($Name)

    {

        $Path = "$([System.Environment]::GetFolderPath([System.Environment+SpecialFolder]::CommonApplicationData))\AutomatedLab\Labs\$Name"

        $labName = $Name

    }

    else

    {

        $labName = $script:data.Name

    }

    if ($Path)

    {

        Import-Lab -Path $Path -NoValidation

    }

    if (-not $Script:data)

    {

        Write-Error 'No definitions imported, so there is nothing to test. Please use Import-Lab against the xml file'

        return

    }    

    if($pscmdlet.ShouldProcess((Get-Lab).Name, 'Remove the lab completely'))

    {

        Write-ScreenInfo -Message "Removing lab '$($Script:data.Name)'" -Type Warning -TaskStart

        try 

        {

            [AutomatedLab.LabTelemetry]::Instance.LabRemoved((Get-Lab).Export())

        }

        catch 

        {

            Write-Verbose -Message ('Error sending telemetry: {0}' -f $_.Exception)

        }

        Write-ScreenInfo -Message 'Removing lab sessions'

        Remove-LabPSSession -All

        Write-Verbose '...done'

        Write-ScreenInfo -Message 'Removing lab background jobs'

        $jobs = Get-Job

        Write-Verbose "Removing remaining $($jobs.Count) jobs..."

        $jobs | Remove-Job -Force -ErrorAction SilentlyContinue

        Write-Verbose '...done'

        if ((Get-LabVM | Where-Object HostType -eq Azure) -or (Get-LabAzureResourceGroup))

        {

            Write-ScreenInfo -Message "Removing Resource Group '$labName' and all resources in this group"

            #without cloning the collection, a Runtime Exceptionis thrown: An error occurred while enumerating through a collection: Collection was modified; enumeration operation may not execute

            @(Get-LabAzureResourceGroup -CurrentLab).Clone() | Remove-LabAzureResourceGroup -Force

        }

        if (Get-LabVM -IncludeLinux | Where-Object HostType -eq HyperV)

        {

            $labMachines = Get-LabVM -IncludeLinux | Where-Object HostType -eq 'HyperV'

            $labName = (Get-Lab).Name

            $removeMachines = foreach ($machine in $labMachines)

            {

                $machineMetadata = Get-LWHypervVMDescription -ComputerName $machine -ErrorAction SilentlyContinue

                $vm = Get-VM -Name $machine -ErrorAction SilentlyContinue

                if ($machineMetadata.LabName -ne $labName -and $vm)

                {

                    Write-Error -Message "Cannot remove machine '$machine' because it does not belong to this lab"

                }

                else

                {

                    $machine

                }

            }

            if ($removeMachines)

            {

                Remove-LabVM -Name $removeMachines

                $disks = Get-LabVHDX -All

                Write-Verbose "Lab knows about $($disks.Count) disks"

                if ($disks)

                {

                    Write-ScreenInfo -Message 'Removing additionally defined disks'

                    Write-Verbose 'Removing disks...'

                    foreach ($disk in $disks)

                    {

                        Write-Verbose "Removing disk '($disk.Name)'"

                        Remove-Item -Path $disk.Path

                    }

                }

                if ($Script:data.Target.Path)

                {

                    $diskPath = (Join-Path -Path $Script:data.Target.Path -ChildPath Disks)

                    #Only remove disks folder if empty

                    if ((Test-Path -Path $diskPath) -and (-not (Get-ChildItem -Path $diskPath)) )

                    {

                        Remove-Item -Path $diskPath

                    }

                }

            }

            #Only remove folder for VMs if folder is empty

            if ($Script:data.Target.Path -and (-not (Get-ChildItem -Path $Script:data.Target.Path)))

            {

                Remove-Item -Path $Script:data.Target.Path -Recurse -Force -Confirm:$false

            }

            Write-ScreenInfo -Message 'Removing entries in the hosts file'

            Clear-HostFile -Section $Script:data.Name -ErrorAction SilentlyContinue

        }        

        Write-ScreenInfo -Message 'Removing virtual networks'

        Remove-LabNetworkSwitches

        if ($Script:data.LabPath)

        {

            Write-ScreenInfo -Message 'Removing Lab XML files'

            if (Test-Path "$($Script:data.LabPath)\Lab.xml") { Remove-Item -Path "$($Script:data.LabPath)\Lab.xml" -Force -Confirm:$false }

            if (Test-Path "$($Script:data.LabPath)\Disks.xml") { Remove-Item -Path "$($Script:data.LabPath)\Disks.xml" -Force -Confirm:$false }

            if (Test-Path "$($Script:data.LabPath)\Machines.xml") { Remove-Item -Path "$($Script:data.LabPath)\Machines.xml" -Force -Confirm:$false }

            if (Test-Path "$($Script:data.LabPath)\Unattended*.xml") { Remove-Item -Path "$($Script:data.LabPath)\Unattended*.xml" -Force -Confirm:$false }

            if (Test-Path "$($Script:data.LabPath)\ks.cfg") { Remove-Item -Path "$($Script:data.LabPath)\ks.cfg" -Force -Confirm:$false }

            if (Test-Path "$($Script:data.LabPath)\autoinst.xml") { Remove-Item -Path "$($Script:data.LabPath)\autoinst.xml" -Force -Confirm:$false }

            if (Test-Path "$($Script:data.LabPath)\AzureNetworkConfig.Xml") { Remove-Item -Path "$($Script:data.LabPath)\AzureNetworkConfig.Xml" -Recurse -Force -Confirm:$false }

            if (Test-Path "$($Script:data.LabPath)\Certificates") { Remove-Item -Path "$($Script:data.LabPath)\Certificates" -Recurse -Force -Confirm:$false }

            #Only remove lab path folder if empty

            if ((Test-Path "$($Script:data.LabPath)") -and (-not (Get-ChildItem -Path $Script:data.LabPath)))

            {

                Remove-Item -Path $Script:data.LabPath

            }

        }

        $Script:data = $null

        Write-ScreenInfo -Message "Done removing lab '$labName'" -TaskEnd

    }

    Write-LogFunctionExit

}

#endregion Remove-Lab

#region Get-LabAvailableOperatingSystem

function Get-LabAvailableOperatingSystem

{

    # .ExternalHelp AutomatedLab.Help.xml

    [cmdletBinding()]

    [OutputType([AutomatedLab.OperatingSystem])]

    param

    (

        [string[]]$Path = "$labSources\ISOs",

        [switch]$UseOnlyCache,

        [switch]$NoDisplay

    )

    Write-LogFunctionEntry

    if (-not (Test-IsAdministrator))

    {

        throw 'This function needs to be called in an elevated PowerShell session.'

    }

    $type = Get-Type -GenericType AutomatedLab.ListXmlStore -T AutomatedLab.OperatingSystem

    $singleFile = Test-Path -Path $Path -PathType Leaf

    $isoFiles = Get-ChildItem -Path $Path -Filter *.iso -Recurse

    Write-Verbose "Found $($isoFiles.Count) ISO files"

    if (-not $singleFile)

    {

        #read the cache

        try

        {

            $importMethodInfo = $type.GetMethod('ImportFromRegistry', [System.Reflection.BindingFlags]::Public -bor [System.Reflection.BindingFlags]::Static)

            $cachedOsList = $importMethodInfo.Invoke($null, ('Cache', 'LocalOperatingSystems'))

            Write-ScreenInfo "found $($cachedOsList.Count) OS images in the cache"

        }

        catch

        {

            Write-Verbose 'Could not read OS image info from the cache'

        }

        if ($cachedOsList)

        {

            $cachedIsoFileSize = [long]$cachedOsList.Metadata[0]

            $actualIsoFileSize = ($isoFiles | Measure-Object -Property Length -Sum).Sum

            if ($cachedIsoFileSize -eq $actualIsoFileSize)

            {

                Write-Verbose 'Cached data is still up to date'

                Write-LogFunctionExit -ReturnValue $cachedOsList

                return $cachedOsList

            }

            else

            {

                Write-ScreenInfo -Message "ISO cache is not up to date. Analyzing all ISO files and updating the cache. This happens when running AutomatedLab for the first time and when changing contents of locations used for ISO files" -Type Warning

                Write-Verbose ('ISO file size ({0:N2}GB) does not match cached file size ({1:N2}). Reading the OS images from the ISO files and re-populating the cache' -f $actualIsoFileSize, $cachedIsoFileSize)

            }

        }

    }

    if ($UseOnlyCache)

    {

        Write-Error -Message "Get-LabAvailableOperatingSystems is used with the switch 'UseOnlyCache', however the cache is empty. Please run 'Get-LabAvailableOperatingSystems' first by pointing to your LabSources\ISOs folder" -ErrorAction Stop

    }

    $dismPattern = 'Index : (?<Index>\d{1,2})\nName : (?<Name>.+)'

    $osList = New-Object $type

    if ($singleFile)

    {

        Write-ScreenInfo -Message "Scanning ISO file '$([System.IO.Path]::GetFileName($Path))' files for operating systems..." -NoNewLine

    }

    else

    {

        Write-ScreenInfo -Message "Scanning $($isoFiles.Count) files for operating systems" -NoNewLine

    }

    foreach ($isoFile in $isoFiles)

    {

        Write-ProgressIndicator

        Write-Verbose "Mounting ISO image '$($isoFile.FullName)'"

        $drive = Mount-DiskImage -ImagePath $isoFile.FullName -StorageType ISO -PassThru

        Get-PSDrive | Out-Null #This is just to refresh the drives. Somehow if this cmdlet is not called, PowerShell does not see the new drives.

        Write-Verbose 'Getting disk image of the ISO'

        $letter = ($drive | Get-Volume).DriveLetter

        Write-Verbose "Got disk image '$letter'"

        Write-Verbose "OS ISO mounted on drive letter '$letter'"

        $standardImagePath = "$letter`:\Sources\Install.wim"    

        if (Test-Path -Path $standardImagePath)

        {

            $dismOutput = Dism.exe /Get-WimInfo /WimFile:$standardImagePath

            $dismOutput = $dismOutput -join "`n"

            $dismMatches = $dismOutput | Select-String -Pattern $dismPattern -AllMatches

            Write-Verbose "The Windows Image list contains $($dismMatches.Matches.Count) items"

            foreach ($dismMatch in $dismMatches.Matches)

            {

                Write-ProgressIndicator

                $index = $dismMatch.Groups['Index'].Value

                $imageInfo = Get-WindowsImage -ImagePath $standardImagePath -Index $index

                if (($imageInfo.Languages -notlike '*en-us*') -and -not $doNotSkipNonNonEnglishIso)

                {

                    Write-ScreenInfo "The windows image '$($imageInfo.ImageName)' in the ISO '$($isoFile.Name)' has the language(s) '$($imageInfo.Languages -join ', ')'. AutomatedLab does only support images with the language 'en-us' hence this image will be skipped." -Type Warning

                    continue

                }

                $os = New-Object -TypeName AutomatedLab.OperatingSystem($Name, $isoFile.FullName)

                $os.OperatingSystemImageName = $dismMatch.Groups['Name'].Value

                $os.OperatingSystemName = $dismMatch.Groups['Name'].Value

                $os.Size = $imageInfo.Imagesize

                $os.Version = $imageInfo.Version

                $os.PublishedDate = $imageInfo.CreatedTime

                $os.Edition = $imageInfo.EditionId

                $os.Installation = $imageInfo.InstallationType

                $os.ImageIndex = $imageInfo.ImageIndex

                $osList.Add($os)

            }

        }

        # SuSE, openSuSE et al

        $susePath = "$letter`:\content"

        if (Test-Path -Path $susePath -PathType Leaf)

        {

            $content = Get-Content -Path $susePath -Raw

            [void] ($content -match 'DISTRO\s+.+,(?<Distro>[a-zA-Z 0-9.]+)\n.*LINGUAS\s+(?<Lang>.*)\n(?:REGISTERPRODUCT.+\n){0,1}REPOID\s+.+((?<CreationTime>\d{8})|(?<Version>\d{2}\.\d{1}))\/(?<Edition>\w+)\/.*\nVENDOR\s+(?<Vendor>[a-zA-z ]+)')

            $os = New-Object -TypeName AutomatedLab.OperatingSystem($Name, $isoFile.FullName)

            $os.OperatingSystemImageName = $Matches.Distro

            $os.OperatingSystemName = $Matches.Distro            

            $os.Size = $isoFile.Length

            if($Matches.Version -like '*.*')

            {

                $os.Version = $Matches.Version

            }

            elseif ($Matches.Version)

            {

                $os.Version = [AutomatedLab.Version]::new($Matches.Version,0)

            }

            else

            {

                $os.Version = [AutomatedLab.Version]::new(0,0)

            }

            $os.PublishedDate = if($Matches.CreationTime) { [datetime]::ParseExact($Matches.CreationTime, 'yyyyMMdd', ([cultureinfo]'en-us')) } else {(Get-Item -Path $susePath).CreationTime}

            $os.Edition = $Matches.Edition

            $packages = Get-ChildItem "$letter`:\suse" -Filter *.rpm -File -Recurse | Foreach-Object {

                if ( $_.Name -match '\w(?<pack>[0-9a-z-_]+)-([0-9.-]+)(x86_64|noarch).rpm')

                {

                    $Matches.pack

                }

            }

            $os.LinuxPackageGroup = $packages

            $osList.Add($os)

        }

        # RHEL, CentOS, Fedora et al

        $rhelPath = "$letter`:\.treeinfo" # TreeInfo Syntax https://release-engineering.github.io/productmd/treeinfo-1.0.html

        $rhelDiscinfo = "$letter`:\.discinfo"

        $rhelPackageInfo = "$letter`:\repodata"

        if ((Test-Path -Path $rhelPath -PathType Leaf) -and (Test-Path -Path $rhelDiscinfo -PathType Leaf))

        {

            [void] ((Get-Content -Path $rhelPath -Raw) -match '(?s)(?<=\[general\]).*?(?=\[)') # Grab content of [general] section

            $discInfoContent = Get-Content -Path $rhelDiscinfo

            $versionInfo = ($discInfoContent[1] -split " ")[-1]

            $content = $Matches[0] -split '\n' | Where-Object -FilterScript {$_ -match '^\w+\s*=\s*\w+' } | ConvertFrom-StringData -ErrorAction SilentlyContinue

            $os = New-Object -TypeName AutomatedLab.OperatingSystem($Name, $isoFile.FullName)

            $os.OperatingSystemImageName = $content.Name            

            $os.Size = $isoFile.Length

            $packageXml = (Get-ChildItem -Path $rhelPackageInfo -Filter *comps*.xml | Select-Object -First 1).FullName

            if (-not $packageXml)

            {

                # CentOS ISO for some reason contained only GUIDs

                $packageXml = Get-ChildItem -Path $rhelPackageInfo -PipelineVariable file -File |

                Get-Content -TotalCount 2 |

                Where-Object {$_ -like "*comps*"} |

                Foreach-Object { $file.FullName } |

                Select-Object -First 1

            }

            [xml]$packageInfo = Get-Content -Path $packageXml -Raw

            $os.LinuxPackageGroup = (Select-Xml -XPath "/comps/group/id" -Xml $packageInfo).Node.InnerText

            if ($versionInfo -match '\.')

            {

                $os.Version = $versionInfo

            }

            else

            {

                $os.Version = [AutomatedLab.Version]::new($versionInfo,0)

            }

            $os.OperatingSystemName = '{0} {1}' -f $content.Family,$os.Version

            # Unix time stamp...

            $os.PublishedDate = (Get-Date 1970-01-01).AddSeconds($discInfoContent[0])

            $os.Edition = if($content.Variant) {$content.Variant}else{'Server'}

            $osList.Add($os)

        }

        Write-Verbose 'Dismounting ISO'

        Dismount-DiskImage -ImagePath $isoFile.FullName

        Write-ProgressIndicator

    }

    $osList.ToArray()

    if ($singleFile)

    {

        Write-ScreenInfo "Found $($osList.Count) OS images."

    }

    else

    {

        $osList.Timestamp = Get-Date

        $osList.Metadata.Add(($isoFiles | Measure-Object -Property Length -Sum).Sum)

        $osList.ExportToRegistry('Cache', 'LocalOperatingSystems')

        Write-ProgressIndicatorEnd

        Write-ScreenInfo "Found $($osList.Count) OS images."

    }

    Write-LogFunctionExit

}

#endregion Get-LabAvailableOperatingSystem

#region Enable-LabVMRemoting

function Enable-LabVMRemoting

{

    # .ExternalHelp AutomatedLab.Help.xml

    [cmdletBinding()]

    param (

        [Parameter(Mandatory, ValueFromPipelineByPropertyName, ParameterSetName = 'ByName')]

        [string[]]$ComputerName,

        [Parameter(Mandatory, ValueFromPipelineByPropertyName, ParameterSetName = 'All')]

        [switch]$All

    )

    Write-LogFunctionEntry

    if (-not (Get-LabVM))

    {

        Write-Error 'No machine definitions imported, so there is nothing to do. Please use Import-Lab first'

        return

    }

    if ($ComputerName)

    {

        $machines = Get-LabVM -All | Where-Object { $_.Name -in $ComputerName }

    }

    else

    {

        $machines = Get-LabVM -All

    }

    $hypervVMs = $machines | Where-Object HostType -eq 'HyperV'

    if ($hypervVMs)

    {

        Enable-LWHypervVMRemoting -ComputerName $hypervVMs

    }

    $azureVms = $machines | Where-Object HostType -eq 'Azure'

    if ($azureVms)

    {

        Enable-LWAzureVMRemoting -ComputerName $azureVms

    }

    $vmwareVms = $machines | Where-Object HostType -eq 'VmWare'

    if ($vmwareVms)

    {

        Enable-LWVMWareVMRemoting -ComputerName $vmwareVms

    }

    Write-LogFunctionExit

}

#endregion Enable-LabVMRemoting

#region Install-LabWebServers

function Install-LabWebServers

{

    # .ExternalHelp AutomatedLab.Help.xml

    [cmdletBinding()]

    param ([switch]$CreateCheckPoints)

    Write-LogFunctionEntry

    $roleName = [AutomatedLab.Roles]::WebServer

    if (-not (Get-LabVM))

    {

        Write-LogFunctionExitWithError -Message 'No machine definitions imported, so there is nothing to do. Please use Import-Lab first'

        return

    }

    $machines = Get-LabVM | Where-Object { $roleName -in $_.Roles.Name }

    if (-not $machines)

    {

        Write-ScreenInfo -Message "There is no machine with the role '$roleName'" -Type Warning

        Write-LogFunctionExit

        return

    }

    Write-ScreenInfo -Message 'Waiting for machines to start up' -NoNewline

    Start-LabVM -RoleName $roleName -Wait -ProgressIndicator 30

    Write-ScreenInfo -Message 'Waiting for Web Server role to complete installation' -NoNewLine

    $coreMachines    = $machines | Where-Object { $_.OperatingSystem.Installation -match 'Core' }

    $nonCoreMachines = $machines | Where-Object { $_.OperatingSystem.Installation -notmatch 'Core' }

    $jobs = @()

    if ($coreMachines)    { $jobs += Install-LabWindowsFeature -ComputerName $coreMachines    -AsJob -PassThru -NoDisplay -IncludeAllSubFeature -FeatureName Web-WebServer, Web-Application-Proxy, Web-Health, Web-Performance, Web-Security, Web-App-Dev, Web-Ftp-Server, Web-Metabase, Web-Lgcy-Scripting, Web-WMI, Web-Scripting-Tools, Web-Mgmt-Service, Web-WHC }

    if ($nonCoreMachines) { $jobs += Install-LabWindowsFeature -ComputerName $nonCoreMachines -AsJob -PassThru -NoDisplay -IncludeAllSubFeature -FeatureName Web-Server }

    Start-LabVm -StartNextMachines 1 -NoNewline

    Wait-LWLabJob -Job $jobs -ProgressIndicator 30 -NoDisplay

    if ($CreateCheckPoints)

    {

        Checkpoint-LabVM -ComputerName $machines -SnapshotName 'Post Web Installation'

    }

    Write-LogFunctionExit

}

#endregion Install-LabWebServers

#region Get-LabWindowsFeature

function Get-LabWindowsFeature

{

    # .ExternalHelp AutomatedLab.Help.xml

    [cmdletBinding()]

    param (

        [Parameter(Mandatory)]

        [ValidateNotNullOrEmpty()]

        [string[]]$ComputerName,

        [ValidateNotNullOrEmpty()]

        [string[]]$FeatureName,

        [switch]$UseLocalCredential,

        [int]$ProgressIndicator = 5,

        [switch]$NoDisplay   

    )

    Write-LogFunctionEntry

    $results = @()

    $machines = Get-LabVM -ComputerName $ComputerName

    if (-not $machines)

    {

        Write-LogFunctionExitWithError -Message 'The specified machines could not be found'

        return

    }

    if ($machines.Count -ne $ComputerName.Count)

    {

        $machinesNotFound = Compare-Object -ReferenceObject $ComputerName -DifferenceObject ($machines.Name)

        Write-ScreenInfo "The specified machines $($machinesNotFound.InputObject -join ', ') could not be found" -Type Warning

    }

    $activityName = "Get Windows Feature(s): '$($FeatureName -join ', ')'"

    $results = @()

    foreach ($machine in $machines)

    {

        if ($machine.OperatingSystem.Installation -eq 'Client')

        {

            #Add-Memer is required as the PSComputerName will be the IP address

            $cmd = { Get-WindowsOptionalFeature -Online | Add-Member -Name ComputerName -MemberType NoteProperty -Value (HOSTNAME.EXE) -PassThru }

        }

        else

        {

            #Add-Memer is required as the PSComputerName will be the IP address

            $cmd = {  Import-Module -Name ServerManager; Get-WindowsFeature | Add-Member -Name ComputerName -MemberType NoteProperty -Value (HOSTNAME.EXE) -PassThru }

        }

        $results += Invoke-LabCommand -ComputerName $machine -ActivityName $activityName -NoDisplay -ScriptBlock $cmd -UseLocalCredential:$UseLocalCredential -PassThru

        foreach ($result in $results)

        {

            $feature = New-Object AutomatedLab.WindowsFeature

            $feature.ComputerName =  $result.ComputerName

            #depending on whether the result is from a client or server machine, it is either the 'Name' or 'FeatureName' property

            if ([string]::IsNullOrEmpty($result.Name))

            {

                $feature.Name = $result.FeatureName

            }

            else

            {

                $feature.Name = $result.Name

            }

            #do not continue if the feature is not requested

            if ($FeatureName -and $feature.Name -notin $FeatureName)

            { continue }

            if ($result.State)

            {

                switch($result.State)

                {

                    'Disabled' { $feature.State = 'Available' }

                    'Enabled' { $feature.State = 'Installed' }

                    'DisabledWithPayloadRemoved' { $feature.State = 'Removed' }

                }

            }

            elseif ($result.InstallState)

            {

                $feature.State = [string]$result.InstallState

            }

            else

            {

                $feature.State = ?? { $result.Installed } { 'Installed' } { 'Available' }

            }

            $feature

        }

    }

    Write-LogFunctionExit

}

#endregion Get-LabWindowsFeature

#region Install-LabWindowsFeature

function Install-LabWindowsFeature

{

    # .ExternalHelp AutomatedLab.Help.xml

    [cmdletBinding()]

    param (

        [Parameter(Mandatory)]

        [ValidateNotNullOrEmpty()]

        [string[]]$ComputerName,

        [Parameter(Mandatory)]

        [ValidateNotNullOrEmpty()]

        [string[]]$FeatureName,

        [switch]$IncludeAllSubFeature,

        [switch]$IncludeManagementTools,

        [switch]$UseLocalCredential,

        [int]$ProgressIndicator = 5,

        [switch]$NoDisplay,

        [switch]$PassThru,

        [switch]$AsJob        

    )

    Write-LogFunctionEntry

    $results = @()

    $machines = Get-LabVM -ComputerName $ComputerName

    if (-not $machines)

    {

        Write-LogFunctionExitWithError -Message 'The specified machines could not be found'

        return

    }

    if ($machines.Count -ne $ComputerName.Count)

    {

        $machinesNotFound = Compare-Object -ReferenceObject $ComputerName -DifferenceObject ($machines.Name)

        Write-ScreenInfo "The specified machines $($machinesNotFound.InputObject -join ', ') could not be found" -Type Warning

    }

    Write-ScreenInfo -Message "Installing Windows Feature(s) '$($FeatureName -join ', ')' on computer(s) '$($ComputerName -join ', ')'" -TaskStart

    if ($AsJob)

    {

        Write-ScreenInfo -Message 'Windows Feature(s) is being installed in the background' -TaskEnd

    }    

    $stoppedMachines = (Get-LabVMStatus -ComputerName $ComputerName -AsHashTable).GetEnumerator() | Where-Object Value -eq Stopped

    if ($stoppedMachines)

    {

        Start-LabVM -ComputerName $stoppedMachines.Name -Wait

    }

    $hyperVMachines = Get-LabVM -ComputerName $ComputerName | Where-Object {$_.HostType -eq 'HyperV'}

    $azureMachines  = Get-LabVM -ComputerName $ComputerName | Where-Object {$_.HostType -eq 'Azure'}

    if ($hyperVMachines)

    {

        foreach ($machine in $hyperVMachines)

        {

            $isoImagePath = $machine.OperatingSystem.IsoPath

            Mount-LabIsoImage -ComputerName $machine -IsoPath $isoImagePath -SupressOutput

        }

        $jobs = Install-LWHypervWindowsFeature -Machine $hyperVMachines -FeatureName $FeatureName -UseLocalCredential:$UseLocalCredential -IncludeAllSubFeature:$IncludeAllSubFeature -IncludeManagementTools:$IncludeManagementTools -AsJob:$AsJob -PassThru:$PassThru

    }

    elseif ($azureMachines)

    {

        $jobs = Install-LWAzureWindowsFeature -Machine $azureMachines -FeatureName $FeatureName -UseLocalCredential:$UseLocalCredential -IncludeAllSubFeature:$IncludeAllSubFeature -IncludeManagementTools:$IncludeManagementTools -AsJob:$AsJob -PassThru:$PassThru

    }

    if (-not $AsJob)

    {

        if ($hyperVMachines)

        {

            Dismount-LabIsoImage -ComputerName $hyperVMachines -SupressOutput

        }

        Write-ScreenInfo -Message 'Done' -TaskEnd

    }

    if ($PassThru)

    {

        $jobs

    }

    Write-LogFunctionExit

}

#endregion Install-LabWindowsFeature

#region Install-VisualStudio2013

function Install-VisualStudio2013

{

    # .ExternalHelp AutomatedLab.Help.xml

    [cmdletBinding()]

    param (

        [int]$InstallationTimeout = $PSCmdlet.MyInvocation.MyCommand.Module.PrivateData.Timeout_VisualStudio2013Installation

    )

    Write-LogFunctionEntry

    $roleName = [AutomatedLab.Roles]::VisualStudio2013

    if (-not (Get-LabVM))

    {

        Write-ScreenInfo -Message 'No machine definitions imported, so there is nothing to do. Please use Import-Lab first' -Type Warning

        Write-LogFunctionExit

        return

    }

    $machines = Get-LabVM -Role $roleName | Where-Object HostType -eq 'HyperV'

    if (-not $machines)

    {

        return

    }

    $isoImage = $Script:data.Sources.ISOs | Where-Object Name -eq $roleName

    if (-not $isoImage)

    {

        Write-LogFunctionExitWithError -Message "There is no ISO image available to install the role '$roleName'. Please add the required ISO to the lab and name it '$roleName'"

        return

    }

    Write-ScreenInfo -Message 'Waiting for machines to startup' -NoNewline

    Start-LabVM -RoleName $roleName -Wait -ProgressIndicator 15

    $jobs = @()

    Mount-LabIsoImage -ComputerName $machines -IsoPath $isoImage.Path -SupressOutput

    foreach ($machine in $machines)

    {        

        $parameters = @{ }

        $parameters.Add('ComputerName', $machine.Name)

        $parameters.Add('ActivityName', 'InstallationVisualStudio2013')

        $parameters.Add('Verbose', $VerbosePreference)

        $parameters.Add('Scriptblock', {

                Write-Verbose 'Installing Visual Studio 2013'

                Push-Location

                Set-Location -Path (Get-WmiObject -Class Win32_CDRomDrive).Drive

                $exe = Get-ChildItem -Filter *.exe

                if ($exe.Count -gt 1)

                {

                    Write-Error 'More than one executable found, cannot proceed. Make sure you have defined the correct ISO image'

                    return

                }

                Write-Verbose "Calling '$($exe.FullName) /quiet /norestart /noweb /Log c:\VsInstall.log'"

                Invoke-Expression -Command "$($exe.FullName) /quiet /norestart /noweb /Log c:\VsInstall.log"

                Pop-Location

                Write-Verbose 'Waiting 120 seconds'

                Start-Sleep -Seconds 120

                $installationStart = Get-Date

                $installationTimeoutInMinutes = 120

                $installationFinished = $false

                Write-Verbose "Looping until '*Exit code: 0x<digits>, restarting: No' is detected in the VsInstall.log..."

                while (-not $installationFinished)

                {

                    if ((Get-Content -Path C:\VsInstall.log | Select-Object -Last 1) -match '(?<Text1>Exit code: 0x)(?<ReturnCode>\w*)(?<Text2>, restarting: No$)')

                    {

                        $installationFinished = $true

                        Write-Verbose 'Visual Studio installation finished'

                    }

                    else

                    {

                        Write-Verbose 'Waiting for the Visual Studio installation...'

                    }

                    if ($installationStart.AddMinutes($installationTimeoutInMinutes) -lt (Get-Date))

                    {

                        Write-Error "The installation of Visual Studio did not finish within the timeout of $installationTimeoutInMinutes minutes"

                        break

                    }

                    Start-Sleep -Seconds 5

                }

                $matches.ReturnCode

                Write-Verbose '...Installation seems to be done'

            }

        )

        $jobs += Invoke-LabCommand @parameters -AsJob -PassThru -NoDisplay

    }

    Write-ScreenInfo -Message 'Waiting for Visual Studio 2013 to complete installation' -NoNewline

    Wait-LWLabJob -Job $jobs -ProgressIndicator 60 -Timeout $InstallationTimeout -NoDisplay

    foreach ($job in $jobs)

    {

        $result = Receive-Job -Job $job

        if ($result -ne 0)

        {

            $ipAddress = (Get-Job -Id $job.id).Location

            $machineName = (Get-LabVM | Where-Object {$_.IpV4Address -eq $ipAddress}).Name

            Write-ScreenInfo -Type Warning "Installation generated error or warning for machine '$machineName'. Return code is: $result"

        }

    }

    Dismount-LabIsoImage -ComputerName $machines -SupressOutput

    Write-LogFunctionExit

}

#endregion Install-VisualStudio2013

#region Install-VisualStudio2015

function Install-VisualStudio2015

{

    # .ExternalHelp AutomatedLab.Help.xml

    [cmdletBinding()]

    param (

        [int]$InstallationTimeout = $PSCmdlet.MyInvocation.MyCommand.Module.PrivateData.Timeout_VisualStudio2015Installation

    )

    Write-LogFunctionEntry

    $roleName = [AutomatedLab.Roles]::VisualStudio2015

    if (-not (Get-LabVM))

    {

        Write-ScreenInfo -Message 'No machine definitions imported, so there is nothing to do. Please use Import-Lab first' -Type Warning

        Write-LogFunctionExit

        return

    }

    $machines = Get-LabVM -Role $roleName | Where-Object HostType -eq 'HyperV'

    if (-not $machines)

    {

        return

    }

    $isoImage = $Script:data.Sources.ISOs | Where-Object Name -eq $roleName

    if (-not $isoImage)

    {

        Write-LogFunctionExitWithError -Message "There is no ISO image available to install the role '$roleName'. Please add the required ISO to the lab and name it '$roleName'"

        return

    }

    Write-ScreenInfo -Message 'Waiting for machines to startup' -NoNewline

    Start-LabVM -RoleName $roleName -Wait -ProgressIndicator 15

    $jobs = @()

    Mount-LabIsoImage -ComputerName $machines -IsoPath $isoImage.Path -SupressOutput

    foreach ($machine in $machines)

    {        

        $parameters = @{ }

        $parameters.Add('ComputerName', $machine.Name)

        $parameters.Add('ActivityName', 'InstallationVisualStudio2015')

        $parameters.Add('Verbose', $VerbosePreference)

        $parameters.Add('Scriptblock', {

                Write-Verbose 'Installing Visual Studio 2015'

                Push-Location

                Set-Location -Path (Get-WmiObject -Class Win32_CDRomDrive).Drive

                $exe = Get-ChildItem -Filter *.exe

                if ($exe.Count -gt 1)

                {

                    Write-Error 'More than one executable found, cannot proceed. Make sure you have defined the correct ISO image'

                    return

                }

                Write-Verbose "Calling '$($exe.FullName) /quiet /norestart /noweb /Log c:\VsInstall.log'"

                $cmd = [scriptblock]::Create("$($exe.FullName) /quiet /norestart /noweb /Log c:\VsInstall.log")

                #there is something that does not work when invoked remotely. Hence a scheduled task is used to work around that.

                Register-ScheduledJob -ScriptBlock $cmd -Name VS2015Installation -RunNow | Out-Null

                Pop-Location

                Write-Verbose 'Waiting 120 seconds'

                Start-Sleep -Seconds 120

                $installationStart = Get-Date

                $installationTimeoutInMinutes = 120

                $installationFinished = $false

                Write-Verbose "Looping until '*Exit code: 0x<hex code>, restarting: No' is detected in the VsInstall.log..."

                while (-not $installationFinished)

                {

                    if ((Get-Content -Path C:\VsInstall.log | Select-Object -Last 1) -match '(?<Text1>Exit code: 0x)(?<ReturnCode>\w*)(?<Text2>, restarting: No$)')

                    {

                        $installationFinished = $true

                        Write-Verbose 'Visual Studio installation finished'

                    }

                    else

                    {

                        Write-Verbose 'Waiting for the Visual Studio installation...'

                    }

                    if ($installationStart.AddMinutes($installationTimeoutInMinutes) -lt (Get-Date))

                    {

                        Write-Error "The installation of Visual Studio did not finish within the timeout of $installationTimeoutInMinutes minutes"

                        break

                    }

                    Start-Sleep -Seconds 5

                }

                $matches.ReturnCode

                Write-Verbose '...Installation seems to be done'

            }

        )

        $jobs += Invoke-LabCommand @parameters -AsJob -PassThru -NoDisplay

    }

    Write-ScreenInfo -Message 'Waiting for Visual Studio 2015 to complete installation' -NoNewline

    Wait-LWLabJob -Job $jobs -ProgressIndicator 60 -Timeout $InstallationTimeout -NoDisplay

    foreach ($job in $jobs)

    {

        $result = Receive-Job -Job $job -Keep

        if ($result -notin '0', 'bc2') #0 == success, 0xbc2 == sucess but required reboot

        {

            $ipAddress = (Get-Job -Id $job.id).Location

            $machineName = (Get-LabVM | Where-Object {$_.IpV4Address -eq $ipAddress}).Name

            Write-ScreenInfo -Type Warning "Installation generated error or warning for machine '$machineName'. Return code is: $result"

        }

    }

    Dismount-LabIsoImage -ComputerName $machines -SupressOutput

    Restart-LabVM -ComputerName $machines

    Write-LogFunctionExit

}

#endregion Install-VisualStudio2015

#region Install-LabOrchestrator2012

function Install-LabOrchestrator2012

{

    # .ExternalHelp AutomatedLab.Help.xml

    [cmdletBinding()]

    param ()

    Write-LogFunctionEntry

    #region prepare setup script

    function Install-LabPrivateOrchestratorRole

    {

        param (

            [Parameter(Mandatory)]

            [string]$OrchServiceUser,

            [Parameter(Mandatory)]

            [string]$OrchServiceUserPassword,

            [Parameter(Mandatory)]

            [string]$SqlServer,

            [Parameter(Mandatory)]

            [string]$SqlDbName

        )

        Write-Verbose -Message 'Installing Orchestrator'

        $start = Get-Date

        if (-not ((Get-WindowsFeature -Name NET-Framework-Features).Installed))

        {

            Write-Error "The WindowsFeature 'NET-Framework-Features' must be installed prior of installing Orchestrator. Use the cmdlet 'Install-LabWindowsFeature' to install the missing feature."

            return

        }

        $TimeoutInMinutes = 15

        $productName = 'Orchestrator 2012'

        $installProcessName = 'Setup'

        $installProcessDescription = 'Orchestrator Setup'

        $drive = (Get-CimInstance -ClassName Win32_LogicalDisk -Filter 'DriveType = 5').DeviceID

        $computerDomain = [System.DirectoryServices.ActiveDirectory.Domain]::GetComputerDomain().Name

        $cmd = "$drive\Setup\Setup.exe /Silent /ServiceUserName:$computerDomain\$OrchServiceUser /ServicePassword:$OrchServiceUserPassword /Components:All /DbServer:$SqlServer /DbNameNew:$SqlDbName /WebServicePort:81 /WebConsolePort:82 /OrchestratorRemote /SendCEIPReports:0 /EnableErrorReporting:never /UseMicrosoftUpdate:0"

        Write-Verbose 'Logs can be found here: C:\Users\<UserName>\AppData\Local\Microsoft System Center 2012\Orchestrator\Logs'

        #--------------------------------------------------------------------------------------

        Write-Verbose "Starting setup of '$productName' with the following command"

        Write-Verbose "`t$cmd"

        Write-Verbose "The timeout is $timeoutInMinutes minutes"

        Invoke-Expression -Command $cmd

        Start-Sleep -Milliseconds 500

        $timeout = Get-Date

        $queryExpression = "`$_.Name -eq '$installProcessName'"

        if ($installProcessDescription)

        {

            $queryExpression += "-and `$_.Description -eq '$installProcessDescription'"

        }

        $queryExpression = [scriptblock]::Create($queryExpression)

        Write-Verbose 'Query expression for looking for the setup process:'

        Write-Verbose "`t$queryExpression"

        if (-not (Get-Process | Where-Object $queryExpression))

        {

            Write-Error "Installation of '$productName' did not start"

            return

        }

        else

        {

            $p = Get-Process | Where-Object $queryExpression

            Write-Verbose "Installation process is '$($p.Name)' with ID $($p.Id)"

        }

        while (Get-Process | Where-Object $queryExpression)

        {

            if ((Get-Date).AddMinutes(- $TimeoutInMinutes) -gt $start)

            {

                Write-Error "Installation of '$productName' hit the timeout of 30 minutes. Killing the setup process"

                if ($installProcessDescription)

                {

                    Get-Process |

                    Where-Object  { $_.Name -eq $installProcessName -and $_.Description -eq 'Orchestrator Setup' } |

                    Stop-Process -Force

                }

                else

                {

                    Get-Process -Name $installProcessName | Stop-Process -Force

                }

                Write-Error "Installation of $productName was not successfull"

                return

            }

            Start-Sleep -Seconds 10

        }

        $end = Get-Date

        Write-Verbose "Installation finished in $($end - $start)"

    }

    #endregion

    $roleName = [AutomatedLab.Roles]::Orchestrator2012

    if (-not (Get-LabVM))

    {

        Write-LogFunctionExitWithError -Message 'No machine definitions imported, so there is nothing to do. Please use Import-Lab first'

        return

    }

    $machines = Get-LabVM -Role $roleName

    if (-not $machines)

    {

        Write-LogFunctionExitWithError -Message "There is no machine with the role $roleName"

        return

    }

    $isoImage = $Script:data.Sources.ISOs | Where-Object { $_.Name -eq $roleName }

    if (-not $isoImage)

    {

        Write-LogFunctionExitWithError -Message "There is no ISO image available to install the role '$roleName'. Please add the required ISO to the lab and name it '$roleName'"

        return

    }

    Start-LabVM -RoleName $roleName -Wait

    Install-LabWindowsFeature -ComputerName $machines -FeatureName RSAT, NET-Framework-Core -Verbose:$false

    Mount-LabIsoImage -ComputerName $machines -IsoPath $isoImage.Path -SupressOutput

    foreach ($machine in $machines)

    {

        $role = $machine.Roles | Where-Object { $_.Name -eq $roleName }

        $createUserScript = "

            `$user = New-ADUser -Name $($role.Properties.ServiceAccount) -AccountPassword ('$($role.Properties.ServiceAccountPassword)' | ConvertTo-SecureString -AsPlainText -Force) -Description 'Orchestrator Service Account' -Enabled `$true -PassThru

            Get-ADGroup -Identity 'Domain Admins' | Add-ADGroupMember -Members `$user

        Get-ADGroup -Identity 'Administrators' | Add-ADGroupMember -Members `$user"

        $dc = Get-LabVM -All | Where-Object {

            $_.DomainName -eq $machine.DomainName -and

            $_.Roles.Name -in @([AutomatedLab.Roles]::DC, [AutomatedLab.Roles]::FirstChildDC, [AutomatedLab.Roles]::RootDC)

        } | Get-Random

        Write-Verbose "Domain controller for installation is '$($dc.Name)'"

        Invoke-LabCommand -ComputerName $dc -ScriptBlock ([scriptblock]::Create($createUserScript)) -ActivityName CreateOrchestratorServiceAccount -NoDisplay

        Invoke-LabCommand -ComputerName $machine -ActivityName Orchestrator2012Installation -NoDisplay -ScriptBlock (Get-Command Install-LabPrivateOrchestratorRole).ScriptBlock `

        -ArgumentList $Role.Properties.ServiceAccount, $Role.Properties.ServiceAccountPassword, $Role.Properties.DatabaseServer, $Role.Properties.DatabaseName

    }

    Dismount-LabIsoImage -ComputerName $machines -SupressOutput

    Write-LogFunctionExit

}

#endregion Install-LabOrchestrator2012

#region Install-LabSoftwarePackage

function Install-LabSoftwarePackage

{

    # .ExternalHelp AutomatedLab.Help.xml

    param (

        [Parameter(Mandatory, ParameterSetName = 'SinglePackage')]   

        [ValidateNotNullOrEmpty()]

        [string]$Path,

        [Parameter(Mandatory, ParameterSetName = 'SingleLocalPackage')]

        [ValidateNotNullOrEmpty()]

        [string]$LocalPath,

        [Parameter(ParameterSetName = 'SinglePackage')]

        [Parameter(ParameterSetName = 'SingleLocalPackage')]

        [ValidateNotNullOrEmpty()]

        [string]$CommandLine,

        [int]$Timeout = 10,

        [Parameter(ParameterSetName = 'SinglePackage')]

        [Parameter(ParameterSetName = 'SingleLocalPackage')]

        [bool]$CopyFolder,

        [Parameter(Mandatory, ParameterSetName = 'SinglePackage')]

        [Parameter(Mandatory, ParameterSetName = 'SingleLocalPackage')]

        [ValidateNotNullOrEmpty()]

        [string[]]$ComputerName,

        [Parameter(Mandatory, ParameterSetName = 'MulitPackage')]

        [AutomatedLab.Machine[]]$Machine,

        [Parameter(Mandatory, ParameterSetName = 'MulitPackage')]

        [AutomatedLab.SoftwarePackage]$SoftwarePackage,

        [switch]$DoNotUseCredSsp,

        [switch]$AsJob,

        [switch]$AsScheduledJob,

        [switch]$UseExplicitCredentialsForScheduledJob,

        [switch]$UseShellExecute,

        [int[]]$ExpectedReturnCodes,

        [switch]$PassThru,

        [switch]$NoDisplay,

        [int]$ProgressIndicator = 5

    )

    Write-LogFunctionEntry

    $parameterSetName = $PSCmdlet.ParameterSetName

    if ($Path)

    {

        if (Test-LabPathIsOnLabAzureLabSourcesStorage -Path $Path)

        {

            $parameterSetName = 'SingleLocalPackage'

            $LocalPath = $Path

        }

    }

    if ($parameterSetName -eq 'SinglePackage')

    {

        if (-not (Test-Path -Path $Path))

        {

            Write-Error "The file '$Path' cannot be found. Software cannot be installed"

            return

        }

        Unblock-File -Path $Path

    }

    if ($parameterSetName -like 'Single*')

    {

        $Machine = Get-LabVM -ComputerName $ComputerName

        if (-not $Machine)

        {

            Write-Error "The machine '$ComputerName' could not be found."

            return

        }

        $unknownMachines = (Compare-Object -ReferenceObject $ComputerName -DifferenceObject $Machine.Name).InputObject

        if ($unknownMachines)

        {

            Write-ScreenInfo "The machine(s) '$($unknownMachines -join ', ')' could not be found." -Type Warning

        }

        if ($AsScheduledJob -and $UseExplicitCredentialsForScheduledJob -and

        ($Machine | Group-Object -Property DomainName).Count -gt 1)

        {

            Write-Error "If you install software in a background job and require the scheduled job to run with explicit credentials, this task can only be performed on VMs being member of the same domain."

            return

        }

    }

    if ($Path)

    {

        Write-ScreenInfo -Message "Installing software package '$Path' on machines '$($ComputerName -join ', ')' " -TaskStart

    }

    else

    {

        Write-ScreenInfo -Message "Installing software package on VM '$LocalPath' on machines '$($ComputerName -join ', ')' " -TaskStart

    }

    if ('Stopped' -in (Get-LabVMStatus $ComputerName -AsHashTable).Values)

    {

        Write-ScreenInfo -Message 'Waiting for machines to start up' -NoNewLine

        Start-LabVM -ComputerName $ComputerName -Wait -ProgressIndicator 30 -NoNewline

    }

    $jobs = @()

    $parameters = @{ }

    $parameters.Add('ComputerName', $ComputerName)

    $parameters.Add('DoNotUseCredSsp', $DoNotUseCredSsp)

    $parameters.Add('PassThru', $True)

    $parameters.Add('AsJob', $True)

    $parameters.Add('ScriptBlock', (Get-Command -Name Install-SoftwarePackage).ScriptBlock)

    if ($parameterSetName -eq 'SinglePackage')

    {

        if ($CopyFolder)

        {

            $parameters.Add('DependencyFolderPath', [System.IO.Path]::GetDirectoryName($Path))

        }

        else

        {

            $parameters.Add('DependencyFolderPath', $Path)

        }

        $installPath = Join-Path -Path C:\ -ChildPath (Split-Path -Path $Path -Leaf)

    }

    elseif ($parameterSetName -eq 'SingleLocalPackage')

    {

        $installPath = $LocalPath

    }

    else

    {

        if ($SoftwarePackage.CopyFolder)

        {

            $parameters.Add('DependencyFolderPath', [System.IO.Path]::GetDirectoryName($SoftwarePackage.Path))

        }

        else

        {

            $parameters.Add('DependencyFolderPath', $SoftwarePackage.Path)

        }

        $installPath = Join-Path -Path C:\ -ChildPath (Split-Path -Path $SoftwarePackage.Path -Leaf)

    }

    $installParams = @{

        Path = $installPath

        CommandLine = $CommandLine

    }

    if ($AsScheduledJob) { $installParams.AsScheduledJob = $true }

    if ($UseShellExecute) { $installParams.UseShellExecute = $true }

    if ($AsScheduledJob -and $UseExplicitCredentialsForScheduledJob) { $installParams.Credential = $Machine[0].GetCredential((Get-Lab)) }

    if ($ExpectedReturnCodes) { $installParams.ExpectedReturnCodes = $ExpectedReturnCodes }

    $parameters.Add('ActivityName', "Installation of '$installPath'")

    Write-Verbose -Message "Starting background job for '$($parameters.ActivityName)'"

    $parameters.ScriptBlock = {

        Install-SoftwarePackage @installParams

    }

    $parameters.Add('NoDisplay', $True)

    if (-not $AsJob) 

    {

        Write-ScreenInfo -Message "Copying files and initiating setup on '$($ComputerName -join ', ')' and waiting for completion" -NoNewLine

    }

    $job = Invoke-LabCommand @parameters -Variable (Get-Variable -Name installParams) -Function (Get-Command -Name Install-SoftwarePackage)

    if (-not $AsJob)

    {

        Write-Verbose "Waiting on job ID '$($job.ID -join ', ')' with name '$($job.Name -join ', ')'"

        $results = Wait-LWLabJob -Job $job -Timeout $Timeout -ProgressIndicator 15 -NoDisplay -PassThru

        #$results = $results | Receive-Job

        Write-Verbose "Job ID '$($results.ID -join ', ')' with name '$($results.Name -join ', ')' finished"

    }

    if ($AsJob)

    {

        Write-ScreenInfo -Message 'Installation started in background' -TaskEnd

        if ($PassThru) { $job }

    }

    else

    {

        Write-ScreenInfo -Message 'Installation done' -TaskEnd

        if ($PassThru) { $results }

    }

    Write-LogFunctionExit

}

#endregion Install-LabSoftwarePackage

#region Get-LabSoftwarePackage

function Get-LabSoftwarePackage

{

    # .ExternalHelp AutomatedLab.Help.xml

    param (

        [Parameter(Mandatory)]

        [ValidateScript({

                    Test-Path -Path $_

                }

        )]

        [string]$Path,

        [string]$CommandLine,

        [int]$Timeout = 10

    )

    Write-LogFunctionEntry

    $pack = New-Object -TypeName AutomatedLab.SoftwarePackage

    $pack.CommandLine = $CommandLine

    $pack.CopyFolder = $CopyFolder

    $pack.Path = $Path

    $pack.Timeout = $timeout

    $pack

    Write-LogFunctionExit

}

#endregion Get-LabSoftwarePackage

#region Install-LabSoftwarePackages

function Install-LabSoftwarePackages

{

    # .ExternalHelp AutomatedLab.Help.xml

    param (

        [Parameter(Mandatory, ValueFromPipelineByPropertyName)]

        [AutomatedLab.Machine[]]$Machine,

        [Parameter(Mandatory, ValueFromPipelineByPropertyName)]

        [AutomatedLab.SoftwarePackage[]]$SoftwarePackage,

        [switch]$WaitForInstallation,

        [switch]$PassThru

    )

    Write-LogFunctionEntry

    $start = Get-Date

    $jobs = @()

    foreach ($m in $Machine)

    {

        Write-Verbose -Message "Install-LabSoftwarePackages: Working on machine '$m'"

        foreach ($p in $SoftwarePackage)

        {

            Write-Verbose -Message "Install-LabSoftwarePackages: Building installation package for '$p'"

            $param = @{ }

            $param.Add('Path', $p.Path)

            if ($p.CommandLine)

            {

                $param.Add('CommandLine', $p.CommandLine)

            }

            $param.Add('Timeout', $p.Timeout)

            $param.Add('ComputerName', $m.Name)

            $param.Add('PassThru', $true)

            Write-Verbose -Message "Install-LabSoftwarePackages: Calling installation package '$p'"

            $jobs += Install-LabSoftwarePackage @param

            Write-Verbose -Message "Install-LabSoftwarePackages: Installation for package '$p' finished"

        }

    }

    Write-Verbose 'Waiting for installation jobs to finish'

    if ($WaitForInstallation)

    {

        Wait-LWLabJob -Job $jobs -ProgressIndicator 10 -NoDisplay

    }

    $end = Get-Date

    Write-Verbose "Installation of all software packages took '$($end - $start)'"

    if ($PassThru)

    {

        $jobs

    }

    Write-LogFunctionExit

}

#endregion Install-LabSoftwarePackages

#region New-LabPSSession

function New-LabPSSession

{

    # .ExternalHelp AutomatedLab.Help.xml

    param (

        [Parameter(Mandatory, ParameterSetName = 'ByName', Position = 0)]

        [string[]]$ComputerName,

        [Parameter(Mandatory, ParameterSetName = 'ByMachine')]

        [AutomatedLab.Machine[]]$Machine,

        #this is used to recreate a broken session

        [Parameter(Mandatory, ParameterSetName = 'BySession')]

        [System.Management.Automation.Runspaces.PSSession]$Session,

        [switch]$UseLocalCredential,

        [switch]$DoNotUseCredSsp,

        [pscredential]$Credential,

        [int]$Retries = 2,

        [int]$Interval = 5,

        [switch]$UseSSL

    )

    begin

    {

        Write-LogFunctionEntry

        $sessions = @()

        $lab = Get-Lab

        #Due to a problem in Windows 10 not being able to reach VMs from the host

        netsh.exe interface ip delete arpcache | Out-Null

    }

    process

    {

        if ($PSCmdlet.ParameterSetName -eq 'ByName')

        {

            $Machine = Get-LabVM -ComputerName $ComputerName -IncludeLinux

            if (-not $Machine)

            {

                Write-Error "There is no computer with the name '$ComputerName' in the lab"

            }

        }

        elseif ($PSCmdlet.ParameterSetName -eq 'BySession')

        {

            $internalSession = $Session

            $Machine = Get-LabVM -ComputerName $internalSession.LabMachineName -IncludeLinux

            if ($internalSession.Runspace.ConnectionInfo.AuthenticationMechanism -ne 'Credssp')

            {

                $DoNotUseCredSsp = $true

            }

            if ($internalSession.Runspace.ConnectionInfo.Credential.UserName -like "$($Machine.Name)*")

            {

                $UseLocalCredential = $true

            }

        }

        foreach ($m in $Machine)

        {

            $machineRetries = $Retries

            if ($Credential)

            {

                $cred = $Credential

            }

            elseif ($UseLocalCredential)

            {

                $cred = $m.GetLocalCredential()

            }

            else

            {

                $cred = $m.GetCredential($lab)

            }

            $param = @{}

            $param.Add('Name', "$($m)_$([guid]::NewGuid())")

            $param.Add('Credential', $cred)

            $param.Add('UseSSL', $false)

            if ($DoNotUseCredSsp)

            {

                $param.Add('Authentication', 'Default')

            }

            else

            {

                $param.Add('Authentication', 'Credssp')

            }

            if ($m.HostType -eq 'Azure')

            {

                $param.Add('ComputerName', $m.AzureConnectionInfo.DnsName)

                $param.Add('Port', $m.AzureConnectionInfo.Port)

                if ($UseSSL)

                {

                    $param.Add('SessionOption', (New-PSSessionOption -SkipCACheck -SkipCNCheck))

                    $param.UseSSL = $true

                }

            }

            elseif ($m.HostType -eq 'HyperV' -or $m.HostType -eq 'VMWare')

            {

                $doNotUseGetHostEntry = $MyInvocation.MyCommand.Module.PrivateData.DoNotUseGetHostEntryInNewLabPSSession

                if (-not $doNotUseGetHostEntry)

                {

                    $name = (Get-HostEntry -Hostname $m).IpAddress.IpAddressToString

                }

                if ($name)

                {

                    $param.Add('ComputerName', $name)

                }

                else

                {

                    $param.Add('ComputerName', $m)

                }

                $param.Add('Port', 5985)

            }

            if ($m.OperatingSystemType -eq 'Linux')

            {

                Set-Item -Path WSMan:\localhost\Client\Auth\Basic -Value $true -Force

                $param['SessionOption'] = New-PSSessionOption -SkipCACheck -SkipCNCheck -SkipRevocationCheck

                $param['UseSSL'] = $true

                $param['Port'] = 5986

                $param['Authentication'] = 'Basic'

            }

            Write-Verbose ("Creating a new PSSession to machine '{0}:{1}' (UserName='{2}', Password='{3}', DoNotUseCredSsp='{4}')" -f $param.ComputerName, $param.Port, $cred.UserName, $cred.GetNetworkCredential().Password, $DoNotUseCredSsp)

            #session reuse. If there is a session to the machine available, return it, otherwise create a new session

            $internalSession = Get-PSSession | Where-Object {

                $_.ComputerName -eq $param.ComputerName -and

                $_.Runspace.ConnectionInfo.Port -eq $param.Port -and

                $_.Availability -eq 'Available' -and

                $_.Runspace.ConnectionInfo.AuthenticationMechanism -eq $param.Authentication -and

                $_.State -eq 'Opened' -and

                $_.Name -like "$($m)_*" -and

                $_.Runspace.ConnectionInfo.Credential.UserName -eq $param.Credential.UserName

            }

            if ($internalSession)

            {

                if ($internalSession.Runspace.ConnectionInfo.AuthenticationMechanism -eq 'CredSsp' -and

                    -not $internalSession.ALLabSourcesMapped -and

                    (Get-LabVM -ComputerName $internalSession.LabMachineName).HostType -eq 'Azure'

                )

                {

                    #remove the existing session if connecting to Azure LabSoruce did not work in case the session connects to an Azure VM.

                    Write-ScreenInfo "Removing session to '$internalSession.LabMachineName' as ALLabSourcesMapped was false" -Type Warning

                    Remove-LabPSSession -ComputerName $internalSession.LabMachineName

                    $internalSession = $null

                }

                if ($internalSession.Count -eq 1)

                {

                    Write-Verbose "Session $($internalSession.Name) is available and will be reused"

                    $sessions += $internalSession

                }

                elseif ($internalSession.Count -ne 0)

                {

                    $sessionsToRemove = $internalSession | Select-Object -Skip $MyInvocation.MyCommand.Module.PrivateData.MaxPSSessionsPerVM

                    Write-Verbose "Found orphaned sessions. Removing $($sessionsToRemove.Count) sessions: $($sessionsToRemove.Name -join ', ')"

                    $sessionsToRemove | Remove-PSSession

                    Write-Verbose "Session $($internalSession[0].Name) is available and will be reused"

                    $sessions += $internalSession | Where-Object State -eq 'Opened' | Select-Object -First 1

                }

            }

            while (-not $internalSession -and $machineRetries -gt 0)

            {

                netsh.exe interface ip delete arpcache | Out-Null

                Write-Verbose "Testing port $($param.Port) on computer '$($param.ComputerName)'"

                $portTest = Test-Port -ComputerName $param.ComputerName -Port $param.Port -TCP

                if ($portTest.Open)

                {

                    Write-Verbose 'Port was open, trying to create the session'

                    $internalSession = New-PSSession @param -ErrorAction SilentlyContinue -ErrorVariable sessionError

                    $internalSession | Add-Member -Name LabMachineName -MemberType ScriptProperty -Value { $this.Name.Substring(0, $this.Name.IndexOf('_')) }

                    if ($internalSession)

                    {

                        Write-Verbose "Session to computer '$($param.ComputerName)' created"

                        $sessions += $internalSession

                        if ((Get-LabVM -ComputerName $internalSession.LabMachineName).HostType -eq 'Azure')

                        {

                            Connect-LWAzureLabSourcesDrive -Session $internalSession

                        }

                    }

                    else

                    {

                        Write-Verbose -Message "Session to computer '$($param.ComputerName)' could not be created, waiting $Interval seconds ($machineRetries retries). The error was: '$($sessionError[0].FullyQualifiedErrorId)'"

                        if ($Retries -gt 1) { Start-Sleep -Seconds $Interval }

                        $machineRetries--

                    }

                }

                else

                {

                    Write-Verbose 'Port was NOT open, cannot create session.'

                    Start-Sleep -Seconds $Interval

                    $machineRetries--

                }

            }

            if (-not $internalSession)

            {

                if ($sessionError.Count -gt 0)

                {

                    Write-Error -ErrorRecord $sessionError[0]

                }

                elseif ($machineRetries -lt 1)

                {

                    Write-Error -Message "Could not create a session to machine '$m' in $Retries retries."

                }

            }

        }

    }

    end

    {

        Write-LogFunctionExit -ReturnValue "Session IDs: $(($sessions.ID -join ', '))"

        $sessions

    }

}

#endregion New-LabPSSession

#region Get-LabPSSession

function Get-LabPSSession

{

    # .ExternalHelp AutomatedLab.Help.xml

    [cmdletBinding()]

    [OutputType([System.Management.Automation.Runspaces.PSSession])]

    param (

        [string[]]$ComputerName,

        [switch]$DoNotUseCredSsp

    )

    $pattern = '\w+_[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{12}'

    if ($ComputerName)

    {

        $computers = Get-LabVM -ComputerName $ComputerName -IncludeLinux

    }

    else

    {

        $computers = Get-LabVM -IncludeLinux

    }

    if (-not $computers)

    {

        Write-Error 'The machines could not be found' -TargetObject $ComputerName

    }

    $sessions = foreach ($computer in $computers)

    {

        $session = Get-PSSession | Where-Object { $_.Name -match $pattern -and $_.Name -like "$($computer.Name)_*" }

        if (-not $session -and $ComputerName)

        {

            Write-Error "No session found for computer '$computer'" -TargetObject $computer

        }

        else

        {

            $session

        }

    }

    if ($DoNotUseCredSsp)

    {

        $sessions | Where-Object { $_.Runspace.ConnectionInfo.AuthenticationMechanism -ne 'CredSsp' }

    }

    else

    {

        $sessions

    }

}

#endregion Get-LabPSSession

#region Remove-LabPSSession

function Remove-LabPSSession

{

    # .ExternalHelp AutomatedLab.Help.xml

    [cmdletBinding()]

    param (

        [Parameter(Mandatory, ParameterSetName = 'ByName')]

        [string[]]$ComputerName,

        [Parameter(Mandatory, ParameterSetName = 'ByMachine')]

        [AutomatedLab.Machine[]]$Machine,

        [Parameter(ParameterSetName = 'All')]

        [switch]$All

    )

    Write-LogFunctionEntry

    $lab = Get-Lab

    $removedSessionCount = 0

    if ($PSCmdlet.ParameterSetName -eq 'ByName')

    {

        $Machine = Get-LabVM -ComputerName $ComputerName -IncludeLinux

    }

    if ($PSCmdlet.ParameterSetName -eq 'All')

    {

        $Machine = Get-LabVM -All -IncludeLinux

    }

    foreach ($m in $Machine)

    {

        $param = @{}

        if ($m.HostType -eq 'Azure')

        {

            $param.Add('ComputerName', $m.AzureConnectionInfo.DnsName)

            $param.Add('Port', $m.AzureConnectionInfo.Port)

        }

        elseif ($m.HostType -eq 'HyperV' -or $m.HostType -eq 'VMWare')

        {

            if ($doNotUseGetHostEntry = $MyInvocation.MyCommand.Module.PrivateData.DoNotUseGetHostEntryInNewLabPSSession)

            {

                $param.Add('ComputerName', $m.Name)

            }

            else

            {

                $param.Add('ComputerName', (Get-HostEntry -Hostname $m).IpAddress.IpAddressToString)

            }

            $param.Add('Port', 5985)

        }

        $sessions = Get-PSSession | Where-Object {

            $_.ComputerName -eq $param.ComputerName -and

            $_.Runspace.ConnectionInfo.Port -eq $param.Port -and

        $_.Name -like "$($m)_*" }

        $sessions | Remove-PSSession -ErrorAction SilentlyContinue

        $removedSessionCount += $sessions.Count

    }

    Write-Verbose "Removed $removedSessionCount PSSessions..."

    Write-LogFunctionExit

}

#endregion Remove-LabPSSession

#region Enter-LabPSSession

function Enter-LabPSSession

{

    # .ExternalHelp AutomatedLab.Help.xml

    param (

        [Parameter(Mandatory, ParameterSetName = 'ByName', Position = 0)]

        [string]$ComputerName,

        [Parameter(Mandatory, ParameterSetName = 'ByMachine', Position = 0)]

        [AutomatedLab.Machine]$Machine,

        [switch]$DoNotUseCredSsp,

        [switch]$UseLocalCredential

    )

    if ($PSCmdlet.ParameterSetName -eq 'ByName')

    {

        $Machine = Get-LabVM -ComputerName $ComputerName -IncludeLinux

    }

    if ($Machine)

    {

        $session = New-LabPSSession -Machine $Machine -DoNotUseCredSsp:$DoNotUseCredSsp -UseLocalCredential:$UseLocalCredential

        $session | Enter-PSSession

    }

    else

    {

        Write-Error 'The specified machine could not be found in the lab.'

    }

}

#endregion Enter-LabPSSession

#region Invoke-LabCommand

function Invoke-LabCommand

{

    # .ExternalHelp AutomatedLab.Help.xml

    [cmdletBinding()]

    param (

        [string]$ActivityName = '<unnamed>',

        [Parameter(ParameterSetName = 'PostInstallationActivity')]

        [switch]$PostInstallationActivity,

        [Parameter(Mandatory, ParameterSetName = 'ScriptBlockFileContentDependency', Position = 0)]

        [Parameter(Mandatory, ParameterSetName = 'ScriptFileContentDependency', Position = 0)]

        [Parameter(Mandatory, ParameterSetName = 'ScriptFileNameContentDependency', Position = 0)]

        [Parameter(Mandatory, ParameterSetName = 'Script', Position = 0)]

        [Parameter(Mandatory, ParameterSetName = 'ScriptBlock', Position = 0)]

        [Parameter(Mandatory, ParameterSetName = 'PostInstallationActivity', Position = 0)]

        [string[]]$ComputerName,

        [Parameter(Mandatory, ParameterSetName = 'ScriptBlockFileContentDependency', Position = 1)]

        [Parameter(Mandatory, ParameterSetName = 'ScriptBlock', Position = 1)]

        [scriptblock]$ScriptBlock,

        [Parameter(Mandatory, ParameterSetName = 'ScriptFileContentDependency')]

        [Parameter(Mandatory, ParameterSetName = 'Script')]

        [string]$FilePath,

        [Parameter(Mandatory, ParameterSetName = 'ScriptFileNameContentDependency')]

        [string]$FileName,

        [Parameter(ParameterSetName = 'ScriptFileNameContentDependency')]

        [Parameter(Mandatory, ParameterSetName = 'ScriptBlockFileContentDependency')]

        [Parameter(Mandatory, ParameterSetName = 'ScriptFileContentDependency')]

        [string]$DependencyFolderPath,

        [object[]]$ArgumentList,

        [switch]$DoNotUseCredSsp,

        [switch]$UseLocalCredential,

        [pscredential]$Credential,

        [System.Management.Automation.PSVariable[]]$Variable,

        [System.Management.Automation.FunctionInfo[]]$Function,

        [Parameter(ParameterSetName = 'ScriptBlock')]

        [Parameter(ParameterSetName = 'ScriptBlockFileContentDependency')]

        [Parameter(ParameterSetName = 'ScriptFileContentDependency')]

        [Parameter(ParameterSetName = 'Script')]

        [Parameter(ParameterSetName = 'ScriptFileNameContentDependency')]

        [int]$Retries,

        [Parameter(ParameterSetName = 'ScriptBlock')]

        [Parameter(ParameterSetName = 'ScriptBlockFileContentDependency')]

        [Parameter(ParameterSetName = 'ScriptFileContentDependency')]

        [Parameter(ParameterSetName = 'Script')]

        [Parameter(ParameterSetName = 'ScriptFileNameContentDependency')]

        [int]$RetryIntervalInSeconds,

        [int]$ThrottleLimit = 32,

        [switch]$AsJob,

        [switch]$PassThru,        

        [switch]$NoDisplay

    )

    Write-LogFunctionEntry

    $customRoleCount = 0

    if ($PSCmdlet.ParameterSetName -in 'Script', 'ScriptBlock', 'ScriptFileContentDependency', 'ScriptBlockFileContentDependency','ScriptFileNameContentDependency')

    {

        if (-not $Retries) { $Retries = $MyInvocation.MyCommand.Module.PrivateData.InvokeLabCommandRetries }

        if (-not $RetryIntervalInSeconds) { $RetryIntervalInSeconds = $MyInvocation.MyCommand.Module.PrivateData.InvokeLabCommandRetryIntervalInSeconds }

    }

    if ($AsJob)

    {

        Write-ScreenInfo -Message "Executing lab command activity: '$ActivityName' on machines '$($ComputerName -join ', ')'" -TaskStart

        Write-ScreenInfo -Message 'Activity started in background' -TaskEnd

    }

    else

    {

        Write-ScreenInfo -Message "Executing lab command activity: '$ActivityName' on machines '$($ComputerName -join ', ')'" -TaskStart

        Write-ScreenInfo -Message 'Waiting for completion'

    }

    Write-Verbose -Message "Executing lab command activity '$ActivityName' on machines '$($ComputerName -join ', ')'"

    #required to suppress verbose messages, warnings and errors

    Get-CallerPreference -Cmdlet $PSCmdlet -SessionState $ExecutionContext.SessionState

    if (-not (Get-LabVm -IncludeLinux))

    {

        Write-LogFunctionExitWithError -Message 'No machine definitions imported, so there is nothing to do. Please use Import-Lab first'

        return

    }

    if ($FilePath)

    {

        if (Test-LabPathIsOnLabAzureLabSourcesStorage -Path $FilePath)

        {

            Write-Verbose "$FilePath is on Azure. Skipping test."

        }

        elseif (-not (Test-Path -Path $FilePath))

        {

            Write-LogFunctionExitWithError -Message "$FilePath is not on Azure and does not exist"

            return

        }

    }

    if ($PostInstallationActivity)

    {

        $machines = Get-LabVM -ComputerName $ComputerName | Where-Object { $_.PostInstallationActivity }

        if (-not $machines)

        {

            Write-Verbose 'There are no machine with PostInstallationActivity defined, exiting...'

            return

        }

    }

    else

    {

        $machines = Get-LabVM -ComputerName $ComputerName -IncludeLinux

    }

    if (-not $machines)

    {

        Write-ScreenInfo "Cannot invoke the command '$ActivityName', as the specified machines ($($ComputerName -join ', ')) could not be found in the lab." -Type Warning

        return

    }

    if ('Stopped' -in (Get-LabVMStatus -ComputerName $machines).Values)

    {

        Start-LabVM -ComputerName $machines -Wait

    }

    if ($PostInstallationActivity)

    {

        Write-ScreenInfo -Message 'Performing post-installations tasks defined for each machine' -TaskStart -OverrideNoDisplay

        $results = @()

        foreach ($machine in $machines)

        {

            foreach ($item in $machine.PostInstallationActivity)

            {

                if ($item.IsCustomRole)

                {

                    Write-ScreenInfo "Installing Custom Role '$(Split-Path -Path $item.DependencyFolder -Leaf)' on machine '$machine'" -TaskStart -OverrideNoDisplay

                    $customRoleCount++

                    #if there is a HostStart.ps1 script for the role

                    $hostStartPath = Join-Path -Path $item.DependencyFolder -ChildPath 'HostStart.ps1'

                    if (Test-Path -Path $hostStartPath)

                    {

                        $hostStartScript = Get-Command -Name $hostStartPath

                        $hostStartParam = Sync-Parameter -Command $hostStartScript -Parameters $item.Properties

                        if ($hostStartScript.Parameters.ContainsKey('ComputerName'))

                        {

                            $hostStartParam['ComputerName'] = $machine.Name

                        }

                        $results += & $hostStartPath @hostStartParam

                    }

                }

                $ComputerName = $machine.Name

                $param = @{}

                $param.Add('ComputerName', $ComputerName)

                Write-Verbose "Creating session to computers) '$ComputerName'"

                $session = New-LabPSSession -ComputerName $ComputerName -DoNotUseCredSsp:$item.DoNotUseCredSsp

                if (-not $session)

                {

                    Write-LogFunctionExitWithError "Could not create a session to machine '$ComputerName'"

                    return

                }

                $param.Add('Session', $session)

                if ($item.DependencyFolder.Value) { $param.Add('DependencyFolderPath', $item.DependencyFolder.Value) }

                if ($item.ScriptFileName) { $param.Add('ScriptFileName',$item.ScriptFileName) }

                if ($item.ScriptFilePath) { $param.Add('ScriptFilePath', $item.ScriptFilePath) }

                if ($item.KeepFolder) { $param.Add('KeepFolder', $item.KeepFolder) }

                if ($item.ActivityName) { $param.Add('ActivityName', $item.ActivityName) }

                if ($Retries) { $param.Add('Retries', $Retries) }

                if ($RetryIntervalInSeconds) { $param.Add('RetryIntervalInSeconds', $RetryIntervalInSeconds) }

                $param.AsJob      = $true

                $param.PassThru   = $PassThru

                $param.Verbose    = $VerbosePreference

                if ($PSBoundParameters.ContainsKey('ThrottleLimit'))

                {

                    $param.Add('ThrottleLimit', $ThrottleLimit)

                }

                $scriptFullName = Join-Path -Path $param.DependencyFolderPath -ChildPath $param.ScriptFileName

                if ($item.Properties.Count -and (Test-Path -Path $scriptFullName))

                {

                    $script = Get-Command -Name $scriptFullName

                    $temp = Sync-Parameter -Command $script -Parameters $item.Properties

                    Add-VariableToPSSession -Session $session -PSVariable (Get-Variable -Name temp)

                    $param.ParameterVariableName = 'temp'

                }

                if ($item.IsCustomRole)

                {

                    if (Test-Path -Path $scriptFullName)

                    {

                        $results += Invoke-LWCommand @param

                    }

                }

                else

                {

                    $results += Invoke-LWCommand @param

                }

                if ($item.IsCustomRole)

                {

                    #if there is a HostEnd.ps1 script for the role

                    $hostEndPath = Join-Path -Path $item.DependencyFolder -ChildPath 'HostEnd.ps1'

                    if (Test-Path -Path $hostEndPath)

                    {

                        $hostEndScript = Get-Command -Name $hostEndPath

                        $hostEndParam = Sync-Parameter -Command $hostEndScript -Parameters $item.Properties

                        if ($hostEndScript.Parameters.ContainsKey('ComputerName'))

                        {

                            $hostEndParam['ComputerName'] = $machine.Name

                        }

                        $results += & $hostEndPath @hostEndParam

                    }

                }

            }

        }

        if ($customRoleCount)

        {

            $jobs = $results | Where-Object { $_ -is [System.Management.Automation.Job] -and $_.State -eq 'Running' }

            if ($jobs)

            {

                Write-ScreenInfo -Message "Waiting on $($results.Count) custom role installations to finish..." -NoNewLine -OverrideNoDisplay

                Wait-LWLabJob -Job $jobs -Timeout 60 -NoDisplay

            }

            else

            {

                Write-ScreenInfo -Message "$($customRoleCount) custom role installation finished." -OverrideNoDisplay

            }

        }

        Write-ScreenInfo -Message 'Post-installations done' -TaskEnd -OverrideNoDisplay

    }

    else

    {

        $param = @{}

        $param.Add('ComputerName', $machines)

        Write-Verbose "Creating session to computer(s) '$machines'"

        $session = @(New-LabPSSession -ComputerName $machines -DoNotUseCredSsp:$DoNotUseCredSsp -UseLocalCredential:$UseLocalCredential -Credential $credential)

        if (-not $session)

        {

            Write-LogFunctionExitWithError "Could not create a session to machine '$machines'"

            return

        }

        if ($Function)        

        {

            Write-Verbose "Adding functions '$($Function -join ',')' to session"

            $Function | Add-FunctionToPSSession -Session $session

        }

        if ($Variable)

        {

            Write-Verbose "Adding variables '$($Variable -join ',')' to session"

            $Variable | Add-VariableToPSSession -Session $session

        }

        $param.Add('Session', $session)

        if ($ScriptBlock)            { $param.Add('ScriptBlock', $ScriptBlock) }

        if ($Retries)                { $param.Add('Retries', $Retries) }

        if ($RetryIntervalInSeconds) { $param.Add('RetryIntervalInSeconds', $RetryIntervalInSeconds) }

        if ($FilePath)               { $param.Add('ScriptFilePath', $FilePath) }

        if ($FileName)               { $param.Add('ScriptFileName', $FileName) }

        if ($ActivityName)           { $param.Add('ActivityName', $ActivityName) }

        if ($ArgumentList)           { $param.Add('ArgumentList', $ArgumentList) }

        if ($DependencyFolderPath)   { $param.Add('DependencyFolderPath', $DependencyFolderPath) }

        $param.PassThru   = $PassThru

        $param.AsJob      = $AsJob

        $param.Verbose    = $VerbosePreference

        if ($PSBoundParameters.ContainsKey('ThrottleLimit'))

        {

            $param.Add('ThrottleLimit', $ThrottleLimit)

        }

        $results = Invoke-LWCommand @param

    }

    if ($AsJob)

    {

        Write-ScreenInfo -Message 'Activity started in background' -TaskEnd

    }

    else

    {

        Write-ScreenInfo -Message 'Activity done' -TaskEnd

    }

    if ($PassThru) { $results }

    Write-LogFunctionExit

}

#endregion Invoke-LabCommand

#region Update-LabMemorySettings

function Update-LabMemorySettings

{

    # .ExternalHelp AutomatedLab.Help.xml

    [Cmdletbinding()]

    Param ()

    Write-LogFunctionEntry

    $machines = Get-LabVM -All -IncludeLinux

    $lab = Get-LabDefinition

    if ($machines | Where-Object Memory -lt 32)

    {

        $totalMemoryAlreadyReservedAndClaimed = ((Get-VM -Name $machines -ErrorAction SilentlyContinue) | Measure-Object -Sum -Property MemoryStartup).Sum

        $machinesNotCreated = $machines | Where-Object { (-not (Get-VM -Name $_ -ErrorAction SilentlyContinue)) }

        $totalMemoryAlreadyReserved = ($machines | Where-Object { $_.Memory -ge 128 -and $_.Name -notin $machinesNotCreated.Name } | Measure-Object -Property Memory -Sum).Sum

        $totalMemory = (Get-WmiObject -Namespace Root\Cimv2 -Class win32_operatingsystem).FreePhysicalMemory * 1KB * 0.8 - $totalMemoryAlreadyReserved + $totalMemoryAlreadyReservedAndClaimed

        if ($lab.MaxMemory -ne 0 -and $lab.MaxMemory -le $totalMemory)

        {

            $totalMemory = $lab.MaxMemory

            Write-Debug -Message "Memory in lab is manually limited to: $totalmemory MB"

        }

        else

        {

            Write-Debug -Message "80% of total available (free) physical memory minus memory already reserved by machines where memory is defined: $totalmemory bytes"

        }

        $totalMemoryUnits = ($machines | Where-Object Memory -lt 32 | Measure-Object -Property Memory -Sum).Sum

        ForEach ($machine in $machines | Where-Object Memory -ge 128)

        {

            Write-Debug -Message "$($machine.Name.PadRight(20)) $($machine.Memory / 1GB)GB (set manually)"

        }

        #Test if necessary to limit memory at all

        $memoryUsagePrediction = $totalMemoryAlreadyReserved

        foreach ($machine in $machines | Where-Object Memory -lt 32)

        {

            switch ($machine.Memory)

            {

                1 { if ($lab.UseStaticMemory)

                    {

                        $memoryUsagePrediction += 768

                    }

                    else

                    {

                        $memoryUsagePrediction += 512

                    }

                }

                2 { if ($lab.UseStaticMemory)

                    {

                        $memoryUsagePrediction += 1024

                    }

                    else

                    {

                        $memoryUsagePrediction += 512

                    }

                }

                3 { if ($lab.UseStaticMemory)

                    {

                        $memoryUsagePrediction += 2048

                    }

                    else

                    {

                        $memoryUsagePrediction += 1024

                    }

                }

                4 { if ($lab.UseStaticMemory)

                    {

                        $memoryUsagePrediction += 4096

                    }

                    else

                    {

                        $memoryUsagePrediction += 1024

                    }

                }

            }

        }

        ForEach ($machine in $machines | Where-Object { $_.Memory -lt 32 -and -not (Get-VM -Name $_.Name -ErrorAction SilentlyContinue) })

        {

            $memoryCalculated = ($totalMemory / $totalMemoryUnits * $machine.Memory / 64) * 64

            if ($memoryUsagePrediction -gt $totalMemory)

            {

                $machine.Memory = $memoryCalculated

                if (-not $lab.UseStaticMemory)

                {

                    $machine.MaxMemory = $memoryCalculated * 4

                }

            }

            else

            {

                if ($lab.MaxMemory -eq 4TB)

                {

                    #If parameter UseAllMemory was used for New-LabDefinition

                    $machine.Memory = $memoryCalculated

                }

                else

                {

                    switch ($machine.Memory)

                    {

                        1 { if ($lab.UseStaticMemory)

                            {

                                $machine.Memory = 768MB

                            }

                            else

                            {

                                $machine.MinMemory = 384MB

                                $machine.Memory    = 512MB

                                $machine.MaxMemory = 1.25GB

                            }

                        }

                        2 { if ($lab.UseStaticMemory)

                            {

                                $machine.Memory = 1GB

                            }

                            else

                            {

                                $machine.MinMemory = 384MB

                                $machine.Memory    = 512MB

                                $machine.MaxMemory = 2GB

                            }

                        }

                        3 { if ($lab.UseStaticMemory)

                            {

                                $machine.Memory = 2GB

                            }

                            else

                            {

                                $machine.MinMemory = 384MB

                                $machine.Memory    = 1GB

                                $machine.MaxMemory = 4GB

                            }

                        }

                        4 { if ($lab.UseStaticMemory)

                            {

                                $machine.Memory = 4GB

                            }

                            else

                            {

                                $machine.MinMemory = 384MB

                                $machine.Memory    = 1GB

                                $machine.MaxMemory = 8GB

                            }

                        }

                    }

                }

            }

            Write-Debug -Message "$("Memory in $($machine)".PadRight(30)) $($machine.Memory / 1GB)GB (calculated)"

            if ($machine.MaxMemory)

            {

                Write-Debug -Message "$("MaxMemory in $($machine)".PadRight(30)) $($machine.MaxMemory / 1GB)GB (calculated)"

            }

            if ($memoryCalculated -lt 256)

            {

                Write-ScreenInfo -Message "Machine '$($machine.Name)' is now auto-configured with $($memoryCalculated / 1GB)GB of memory. This might give unsatisfactory performance. Consider adding memory to the host, raising the available memory for this lab or use fewer machines in this lab" -Type Warning

            }

        }

        <#

                $plannedMaxMemoryUsage = (Get-LabVM -All).MaxMemory | Measure-Object -Sum | Select-Object -ExpandProperty Sum

                if ($plannedMaxMemoryUsage -le ($totalMemory/3))

                {

                foreach ($machine in (Get-LabVM))

                {

                (Get-LabVM -ComputerName $machine).Memory *= 2

                (Get-LabVM -ComputerName $machine).MaxMemory *= 2

                }

                }

        #>

    }

    Write-LogFunctionExit

}

#endregion Update-LabMemorySettings

#region Set-LabInstallationCredential

function Set-LabInstallationCredential

{

    # .ExternalHelp AutomatedLab.Help.xml

    [CmdletBinding(DefaultParameterSetName = 'All')]

    Param (

        [Parameter(Mandatory, ParameterSetName = 'All')]

        [Parameter(Mandatory=$false, ParameterSetName = 'Prompt')]

        [ValidatePattern("^([\'\""a-zA-Z0-9]){2,15}$")]

        [string]$Username,

        [Parameter(Mandatory, ParameterSetName = 'All')]

        [Parameter(Mandatory=$false, ParameterSetName = 'Prompt')]

        [string]$Password,

        [Parameter(Mandatory, ParameterSetName = 'Prompt')]

        [switch]$Prompt

    )

    if (-not (Get-LabDefinition))

    {

        throw 'No lab defined. Please call New-LabDefinition first before calling Set-LabInstallationCredential.'

    }

    if ($PSCmdlet.ParameterSetName -eq 'All')

    {

        $user = New-Object AutomatedLab.User($Username, $Password)

        (Get-LabDefinition).DefaultInstallationCredential = $user

    }   

    else

    {

        $promptUser = Read-Host "Type desired username for admin user (or leave blank for 'Install'. Username cannot be 'Administrator' is deploying in Azure)"

        if (-not $promptUser)

        {

            $promptUser = 'Install'

        }

        do

        {

            $promptPassword = Read-Host "Type password for admin user (leave blank for 'Somepass1' or type 'x' to cancel )"

            if (-not $promptPassword)

            {

                $promptPassword = 'Somepass1'

                $checks = 5

                break

            }

            [int]$minLength  = 8

            [int]$numUpper   = 1

            [int]$numLower   = 1

            [int]$numNumbers = 1 

            [int]$numSpecial = 1

            $upper   = [regex]'[A-Z]'

            $lower   = [regex]'[a-z]'

            $number  = [regex]'[0-9]'

            $special = [regex]'[^a-zA-Z0-9]'

            $checks = 0

            if ($promptPassword.length -ge 8)                            { $checks++ }

            if ($upper.Matches($promptPassword).Count -ge $numUpper )    { $checks++ }

            if ($lower.Matches($promptPassword).Count -ge $numLower )    { $checks++ }

            if ($number.Matches($promptPassword).Count -ge $numNumbers ) { $checks++ }

            if ($checks -lt 4)

            {

                if ($special.Matches($promptPassword).Count -ge $numSpecial )  { $checks }

            }

            if ($checks -lt 4)

            {

                Write-Host 'Password must be have minimum length of 8'

                Write-Host 'Password must contain minimum one upper case character'

                Write-Host 'Password must contain minimum one lower case character'

                Write-Host 'Password must contain minimum one special character'

            }

        }

        until ($checks -ge 4 -or (-not $promptUser) -or (-not $promptPassword) -or $promptPassword -eq 'x')

        if ($checks -ge 4 -and $promptPassword -ne 'x') 

        {

            $user = New-Object AutomatedLab.User($promptUser, $promptPassword)

        }

    }

}

#endregion Set-LabInstallationCredential

#region Show-LabDeploymentSummary

function Show-LabDeploymentSummary

{

    # .ExternalHelp AutomatedLab.Help.xml

    [OutputType([System.TimeSpan])]

    [Cmdletbinding()]

    param (

        [switch]$Detailed

    )

    $ts = New-TimeSpan -Start $Global:AL_DeploymentStart -End (Get-Date)

    $hoursPlural = ''

    $minutesPlural = ''

    $secondsPlural = ''

    if ($ts.Hours   -gt 1) { $hoursPlural   = 's' }

    if ($ts.minutes -gt 1) { $minutesPlural = 's' }

    if ($ts.Seconds -gt 1) { $secondsPlural = 's' }

    $lab = Get-Lab

    $machines = Get-LabVM -IncludeLinux

    Write-ScreenInfo -Message '---------------------------------------------------------------------------'

    Write-ScreenInfo -Message ("Setting up the lab took {0} hour$hoursPlural, {1} minute$minutesPlural and {2} second$secondsPlural" -f $ts.hours, $ts.minutes, $ts.seconds)

    Write-ScreenInfo -Message "Lab name is '$($lab.Name)' and is hosted on '$($lab.DefaultVirtualizationEngine)'. There are $($machines.Count) machine(s) and $($lab.VirtualNetworks.Count) network(s) defined."

    if (-not $Detailed)

    {

        Write-ScreenInfo -Message '---------------------------------------------------------------------------'

    }    

    else

    {

        Write-ScreenInfo

        Write-ScreenInfo -Message '----------------------------- Network Summary -----------------------------'

        $networkInfo = $lab.VirtualNetworks | Format-Table -Property Name, AddressSpace, SwitchType, AdapterName, @{ Name = 'IssuedIpAddresses'; Expression = { $_.IssuedIpAddresses.Count } } | Out-String

        $networkInfo -split "`n" | ForEach-Object {

            if ($_) { Write-ScreenInfo -Message $_ }

        }

        Write-ScreenInfo -Message '----------------------------- Domain Summary ------------------------------'

        $domainInfo = $lab.Domains | Format-Table -Property Name,

        @{ Name = 'Administrator'; Expression = { $_.Administrator.UserName } },

        @{ Name = 'Password'; Expression = { $_.Administrator.Password } },

        @{ Name = 'RootDomain'; Expression = { if ($lab.GetParentDomain($_.Name).Name -ne $_.Name) { $lab.GetParentDomain($_.Name) } } } |

        Out-String

        $domainInfo -split "`n" | ForEach-Object {

            if ($_) { Write-ScreenInfo -Message $_ }

        }

        Write-ScreenInfo -Message '------------------------- Virtual Machine Summary -------------------------'

        $vmInfo = Get-LabVM -IncludeLinux | Format-Table -Property Name, DomainName, IpAddress, Roles, OperatingSystem,

        @{ Name = 'Local Admin'; Expression = { $_.InstallationUser.UserName } },

        @{ Name = 'Password'; Expression = { $_.InstallationUser.Password } } -AutoSize |

        Out-String

        $vmInfo -split "`n" | ForEach-Object {

            if ($_) { Write-ScreenInfo -Message $_ }

        }

        Write-ScreenInfo -Message '---------------------------------------------------------------------------'

        Write-ScreenInfo -Message 'Please use the following cmdlets to interact with the machines:'

        Write-ScreenInfo -Message '- Get-LabVMStatus, Get, Start, Restart, Stop, Wait, Connect, Save-LabVM and Wait-LabVMRestart (some of them provide a Wait switch)'

        Write-ScreenInfo -Message '- Invoke-LabCommand, Enter-LabPSSession, Install-LabSoftwarePackage and Install-LabWindowsFeature (do not require credentials and'

        Write-ScreenInfo -Message '  work the same way with Hyper-V and Azure)'

        Write-ScreenInfo -Message '- Checkpoint-LabVM, Restore-LabVMSnapshot and Get-LabVMSnapshot (only for Hyper-V)'

        Write-ScreenInfo -Message '- Get-LabInternetFile downloads files from the internet and places them on LabSources (locally or on Azure)'

        Write-ScreenInfo -Message '---------------------------------------------------------------------------'

    }

}

#endregion Show-LabDeploymentSummary

#region Set-LabGlobalNamePrefix

function Set-LabGlobalNamePrefix

{

    # .ExternalHelp AutomatedLab.Help.xml

    [Cmdletbinding()]

    Param (

        [Parameter(Mandatory = $false)]

        [ValidatePattern("^([\'\""a-zA-Z0-9]){1,4}$|()")]

        [string]$Name

    )

    $Global:labNamePrefix = $Name

}

#endregion Set-LabGlobalNamePrefix

#region Set-LabToolsPath

function Set-LabDefaultToolsPath

{

    # .ExternalHelp AutomatedLab.Help.xml

    [Cmdletbinding()]  

    Param(

        [Parameter(Mandatory)]

        [string]$Path

    )

    $Global:labToolsPath = $Path

}

#endregion Set-LabToolsPath

#region Set-LabDefaultOperatingSYstem

function Set-LabDefaultOperatingSystem

{

    # .ExternalHelp AutomatedLab.Help.xml

    [Cmdletbinding()]  

    Param(

        [Parameter(Mandatory)]

        [alias('Name')]

        [string]$OperatingSystem,

        [string]$Version

    )

    if (Get-LabDefinition)

    {

        if ($Version)

        {

            $os = Get-LabAvailableOperatingSystem | Where-Object {$_.OperatingSystemName -eq $OperatingSystem -and $_.Version -eq $OperatingSystemVersion}

        }

        else

        {

            $os = Get-LabAvailableOperatingSystem | Where-Object {$_.OperatingSystemName -eq $OperatingSystem}

            if ($os.Count -gt 1)

            {

                $os = $os | Sort-Object Version -Descending | Select-Object -First 1

                Write-ScreenInfo "The operating system '$OperatingSystem' is available multiple times. Choosing the one with the highest version ($($os.Version)) as default operating system" -Type Warning

            }

        }

        if (-not $os)

        {

            throw "The operating system '$OperatingSystem' could not be found in the available operating systems. Call 'Get-LabAvailableOperatingSystem' to get a list of operating systems available to the lab."

        }

        (Get-LabDefinition).DefaultOperatingSystem = $os

    }

    else

    {

        throw 'No lab defined. Please call New-LabDefinition first before calling Set-LabDefaultOperatingSystem.'

    }

}

#endregion Set-LabDefaultOperatingSystem

#region Set-LabDefaultVirtualization

function Set-LabDefaultVirtualizationEngine

{

    # .ExternalHelp AutomatedLab.Help.xml

    [Cmdletbinding()]  

    Param(

        [Parameter(Mandatory)]

        [ValidateSet('Azure', 'HyperV', 'VMware')]

        [string]$VirtualizationEngine

    )

    if (Get-LabDefinition)

    {

        (Get-LabDefinition).DefaultVirtualizationEngine = $VirtualizationEngine

    }

    else

    {

        throw 'No lab defined. Please call New-LabDefinition first before calling Set-LabDefaultOperatingSystem.'

    }

}

#endregion Set-LabDefaultVirtualizationEngine

#region Get-LabSourcesLocation

function Get-LabSourcesLocation

{

    # .ExternalHelp AutomatedLab.Help.xml

    $labSources

}

#endregion Get-LabSourcesLocation

#region Get-LabVariable

function Get-LabVariable

{

    # .ExternalHelp AutomatedLab.Help.xml

    $pattern = 'AL_([a-zA-Z0-9]{8})+[-.]+([a-zA-Z0-9]{4})+[-.]+([a-zA-Z0-9]{4})+[-.]+([a-zA-Z0-9]{4})+[-.]+([a-zA-Z0-9]{12})'

    Get-Variable -Scope Global | Where-Object Name -Match $pattern

}

#endregion Get-LabVariable

#region Remove-LabVariable

function Remove-LabVariable

{

    # .ExternalHelp AutomatedLab.Help.xml

    $pattern = 'AL_([a-zA-Z0-9]{8})+[-.]+([a-zA-Z0-9]{4})+[-.]+([a-zA-Z0-9]{4})+[-.]+([a-zA-Z0-9]{4})+[-.]+([a-zA-Z0-9]{12})'

    Get-LabVariable | Remove-Variable -Scope Global

}

#endregion Remove-LabVariable

#region Clear-LabCache

function Clear-LabCache

{

    # .ExternalHelp AutomatedLab.Help.xml

    [cmdletBinding()]

    param()

    Write-LogFunctionEntry

    Remove-Item -Path Microsoft.PowerShell.Core\Registry::HKEY_CURRENT_USER\Software\AutomatedLab\Cache -Force -ErrorAction SilentlyContinue

    Write-Verbose 'AutomatedLab cache removed'

    Write-LogFunctionExit

}

#endregion Clear-LabCache

#region function Add-LabVMUserRight

function Add-LabVMUserRight

{

    # .ExternalHelp AutomatedLab.Help.xml

    param

    (

        [Parameter(Mandatory, ValueFromPipelineByPropertyName, ParameterSetName = 'ByMachine')]

        [String[]]$ComputerName,

        [string[]]$UserName,

        [validateSet('SeNetworkLogonRight', 

                'SeRemoteInteractiveLogonRight', 

                'SeBatchLogonRight', 

                'SeInteractiveLogonRight', 

                'SeServiceLogonRight', 

                'SeDenyNetworkLogonRight', 

                'SeDenyInteractiveLogonRight', 

                'SeDenyBatchLogonRight', 

                'SeDenyServiceLogonRight', 

                'SeDenyRemoteInteractiveLogonRight', 

                'SeTcbPrivilege', 

                'SeMachineAccountPrivilege', 

                'SeIncreaseQuotaPrivilege', 

                'SeBackupPrivilege', 

                'SeChangeNotifyPrivilege', 

                'SeSystemTimePrivilege', 

                'SeCreateTokenPrivilege', 

                'SeCreatePagefilePrivilege', 

                'SeCreateGlobalPrivilege', 

                'SeDebugPrivilege', 

                'SeEnableDelegationPrivilege', 

                'SeRemoteShutdownPrivilege', 

                'SeAuditPrivilege', 

                'SeImpersonatePrivilege', 

                'SeIncreaseBasePriorityPrivilege', 

                'SeLoadDriverPrivilege', 

                'SeLockMemoryPrivilege', 

                'SeSecurityPrivilege', 

                'SeSystemEnvironmentPrivilege', 

                'SeManageVolumePrivilege', 

                'SeProfileSingleProcessPrivilege', 

                'SeSystemProfilePrivilege', 

                'SeUndockPrivilege', 

                'SeAssignPrimaryTokenPrivilege', 

                'SeRestorePrivilege', 

                'SeShutdownPrivilege', 

                'SeSynchAgentPrivilege', 

                'SeTakeOwnershipPrivilege' 

        )]

        [string[]]$Priveleges

    )

    $Job = @()

    foreach ($Computer in $ComputerName)

    {

        $param = @{}

        $param.add('UserName', $UserName)

        $param.add('Right', $Right)

        $param.add('ComputerName', $Computer)

        $Job += Invoke-LabCommand -ComputerName $Computer -ActivityName "Configure user rights '$($Priveleges -join ', ')' for user accounts: '$($UserName -join ', ')'" -NoDisplay -AsJob -PassThru -ScriptBlock {

            Add-AccountPrivilege -UserName $UserName -Privilege $Priveleges

        } -Variable (Get-Variable UserName, Priveleges) -Function (Get-Command Add-AccountPrivilege)

    }

    Wait-LWLabJob -Job $Job -NoDisplay

}

#endregion function Add-LabVMUserRight

#region New-LabSourcesFolder

function New-LabSourcesFolder

{

    [CmdletBinding(

            SupportsShouldProcess = $true,

    ConfirmImpact = 'Medium')]

    param

    (

        [Parameter(Mandatory = $false)]

        [System.String]

        $DriveLetter,

        [switch]

        $Force

    )

    $Path = (Join-Path -Path $env:SystemDrive -ChildPath LabSources)

    if ($DriveLetter)

    {

        try

        {

            $drive = [System.IO.DriveInfo]$DriveLetter

        }

        catch

        {

            throw "$DriveLetter is not a valid drive letter. Exception was ($_.Exception.Message)"

        }

        if (-not $drive.IsReady)

        {

            throw "LabSource cannot be placed on $DriveLetter. The drive is not ready."

        }

        $Path = Join-Path -Path $drive.RootDirectory -ChildPath LabSources

    }

    if ((Test-Path -Path $Path) -and -not $Force)

    {

        return $Path

    }

    Write-ScreenInfo -Message 'Downloading LabSources from GitHub. This only happens once if no LabSources folder can be found.' -Type Warning

    if ($PSCmdlet.ShouldProcess('Downloading module and creating new LabSources', $Path))

    {

        $temporaryPath = [System.IO.Path]::GetTempFileName().Replace('.tmp', '')    

        [void] (New-Item -ItemType Directory -Path $temporaryPath -Force)

        $archivePath = (Join-Path -Path $temporaryPath -ChildPath 'master.zip')

        Get-LabInternetFile -Uri 'https://github.com/AutomatedLab/AutomatedLab/archive/master.zip' -Path $archivePath -ErrorAction Stop

        Expand-Archive -Path $archivePath -DestinationPath $temporaryPath

        if (-not (Test-Path -Path $Path))

        {

            $Path = (New-Item -ItemType Directory -Path $Path).FullName

        }

        Copy-Item -Path (Join-Path -Path $temporaryPath -ChildPath AutomatedLab-master\LabSources\*) -Destination $Path -Recurse -Force:$Force

        Remove-Item -Path $temporaryPath -Recurse -Force -ErrorAction SilentlyContinue

        $Path

    }

}

#endregion

#region Telemetry

function Enable-LabTelemetry

{

    [Environment]::SetEnvironmentVariable('AUTOMATEDLAB_TELEMETRY_OPTOUT', 'false', 'Machine')

}

function Disable-LabTelemetry

{

    [Environment]::SetEnvironmentVariable('AUTOMATEDLAB_TELEMETRY_OPTOUT', 'true', 'Machine')

}

$telemetryChoice = @"

Starting with AutomatedLab v5 we are collecting telemetry to see how AutomatedLab is used

and to bring you fancy dashboards with e.g. the community's favorite roles.

We are collecting the following with Azure Application Insights:

- Your country (IP addresses are by default set to 0.0.0.0 after the location is extracted)

- Your number of lab machines

- The roles you used

- The time it took your lab to finish

- Your AutomatedLab version, OS Version and the lab's Hypervisor type

We collect no personally identifiable information.

If you change your mind later on, you can always set the environment

variable AUTOMATEDLAB_TELEMETRY_OPTOUT to no, false or 0 in order to opt in or to yes,true or 1 to opt out.

Alternatively you can use Enable-LabTelemetry and Disable-LabTelemetry to accomplish the same.

We will not ask you again while `$env:AUTOMATEDLAB_TELEMETRY_OPTOUT exists.

If you want to opt out, please select Yes.

"@

if (-not $env:AUTOMATEDLAB_TELEMETRY_OPTOUT)

{

    $choice = Read-Choice -ChoiceList 'No','Yes' -Caption 'Opt out of telemetry?' -Message $telemetryChoice -Default 0

    # This is actually enough for the telemetry client.

    [Environment]::SetEnvironmentVariable('AUTOMATEDLAB_TELEMETRY_OPTOUT', $choice, 'Machine')

    # We cannot refresh the env drive, so we add the same variable here as well.

    $env:AUTOMATEDLAB_TELEMETRY_OPTOUT = $choice 

}

#endregion

$dynamicLabSources = New-Object AutomatedLab.DynamicVariable 'global:labSources', { Get-LabSourcesLocationInternal }, { $null }

$executioncontext.SessionState.PSVariable.Set($dynamicLabSources)

Register-ArgumentCompleter -CommandName Add-LabMachineDefinition -ParameterName OperatingSystem -ScriptBlock {

    param($commandName, $parameterName, $wordToComplete, $commandAst, $fakeBoundParameter)

    Get-LabAvailableOperatingSystem -Path $labSources\ISOs -UseOnlyCache |

    Where-Object { $_.ProductKey -and $_.OperatingSystemImageName -like "*$wordToComplete*" } |

    Group-Object -Property OperatingSystemImageName |

    ForEach-Object { $_.Group | Sort-Object -Property Version -Descending | Select-Object -First 1 } |

    Sort-Object -Property OperatingSystemImageName |

    ForEach-Object {

        [System.Management.Automation.CompletionResult]::new("'$($_.OperatingSystemImageName)'", "'$($_.OperatingSystemImageName)'", 'ParameterValue', "$($_.Version) $($_.OperatingSystemImageName)")

    }

}

Register-ArgumentCompleter -CommandName Import-Lab, Remove-Lab -ParameterName Name -ScriptBlock {

    param($commandName, $parameterName, $wordToComplete, $commandAst, $fakeBoundParameter)

    $path = "$([System.Environment]::GetFolderPath([System.Environment+SpecialFolder]::CommonApplicationData))\AutomatedLab\Labs"

    Get-ChildItem -Path $path -Directory |

    ForEach-Object {

        if ($_.Name -contains ' ')

        {

            [System.Management.Automation.CompletionResult]::new("'$($_.Name)'", "'$($_.Name)'", 'ParameterValue', $_.Name)

        }

        else

        {

            [System.Management.Automation.CompletionResult]::new($_.Name, $_.Name, 'ParameterValue', $_.Name)

        }

    }

}

$commands = Get-Command -Module AutomatedLab*, PSFileTransfer | Where-Object { $_.Parameters.ContainsKey('ComputerName') }

Register-ArgumentCompleter -CommandName $commands -ParameterName ComputerName -ScriptBlock {

    param($commandName, $parameterName, $wordToComplete, $commandAst, $fakeBoundParameter)

    Get-LabVM -All -IncludeLinux |

    ForEach-Object {

        if ($_.Roles)

        {

            [System.Management.Automation.CompletionResult]::new($_.Name, $_.Name, 'ParameterValue', $_.Roles)

        }

        else

        {

            [System.Management.Automation.CompletionResult]::new($_.Name, $_.Name, 'ParameterValue', $_.Name)

        }

    }

}

Register-ArgumentCompleter -CommandName Add-LabMachineDefinition -ParameterName DomainName -ScriptBlock {

    param($commandName, $parameterName, $wordToComplete, $commandAst, $fakeBoundParameter)

    (Get-LabDefinition).Domains |

    ForEach-Object {

        [System.Management.Automation.CompletionResult]::new($_.Name, $_.Name, 'ParameterValue', $_.Name)

    }

}

Register-ArgumentCompleter -CommandName Add-LabMachineDefinition -ParameterName Roles -ScriptBlock {

    param($commandName, $parameterName, $wordToComplete, $commandAst, $fakeBoundParameter)

    [System.Enum]::GetNames([AutomatedLab.Roles]) |

    ForEach-Object {

        [System.Management.Automation.CompletionResult]::new($_, $_, 'ParameterValue', $_)

    }

}

#importing the module results in calling the following code multiple times due to module import recursion

#the following line makes sure that the following code runs only once when called from an external source

if (((Get-PSCallStack)[1].Location -notlike 'AutomatedLab*.psm1*'))

{

    Get-LabAvailableOperatingSystem -Path $labSources\ISOs -NoDisplay

}