PUDAdminCenterPrototype

0.2.0

Private/PUDAppMainFunctionTemplate.ps1

                                <#

    .SYNOPSIS

        This function starts a PowerShell Universal Dashboard (Web-based GUI) instance on the specified port on the

        localhost. The Dashboard features a Network Monitor tool that pings the specified Remote Hosts in your Domain

        every 5 seconds and reports the results to the site.

    .DESCRIPTION

        See .SYNOPSIS

    .PARAMETER Port

        This parameter is OPTIONAL, however, it has a default value of 80.

        This parameter takes an integer between 1 and 32768 that represents the port on the localhost that the site

        will run on.

    .PARAMETER InstallNmap

        This parameter is OPTIONAL, however, it has a default value of $True.

        This parameter is a switch. If used, nmap will be installed in order to guess the Operating System of

        Remote Hosts on the network.

    .PARAMETER RemoveExistingPUD

        This parameter is OPTIONAL, however, it has a default value of $True.

        This parameter is a switch. If used, all running PowerShell Universal Dashboard instances will be removed

        prior to starting the Network Monitor Dashboard.

    .EXAMPLE

        # Open an elevated PowerShell Session, import the module, and -

        PS C:\Users\zeroadmin> Get-PUDAdminCenter

#>

function Get-PUDAdminCenter {

    Param (

        [Parameter(Mandatory=$False)]

        [ValidateRange(1,32768)]

        [int]$Port = 80,

        [Parameter(Mandatory=$False)]

        [switch]$InstallNmap = $True,

        [Parameter(Mandatory=$False)]

        [switch]$RemoveExistingPUD = $True

    )

    #region >> Prep

    # Remove all current running instances of PUD

    if ($RemoveExistingPUD) {

        Get-UDDashboard | Stop-UDDashboard

    }

    # Remove All Runspaces to Remote Hosts

    Get-PSSession | Remove-PSSession

    $RunspacesToDispose = @(

        Get-Runspace | Where-Object {$_.Type -eq "Remote"}

    )

    if ($RunspacesToDispose.Count -gt 0) {

        foreach ($RSpace in $RunspacesToDispose) {$_.Dispose()}

    }

    # Define all of this Module's functions (both Public and Private) as an array of strings so that we can easily load them in different contexts/scopes

    $ThisModuleFunctionsStringArray =  $(Get-Module PUDAdminCenterPrototype).Invoke({$FunctionsForSBUse})

    # Create the $Pages ArrayList that will be used with 'New-UDDashboard -Pages'

    [System.Collections.ArrayList]$Pages = @()

    # Current Scope variable (ArrayList) containing the names of all of **Dynamic** Pages -

    # i.e. Pages where the URL contains a variable/parameter that is referenced within the Page itself.

    # For example, in this PUDAdminCenter App, the Overview Page (and all other Dynamic Pages in this list) is

    # eventually created via...

    #     New-UDPage -Url "/Overview/:RemoteHost" -Endpoint {param($RemoteHost) ...}

    # ...meaning that if a user were to navigate to http://localhost/Overview/Server01, Overview Page Endpoint scriptblock

    # code that referenced the variable $RemoteHost would contain the string value 'Server01' (unless it is specifcally

    # overriden within the Overview Page Endpoint scriptblock, which is NOT recommended).

    $DynamicPages = @(

        "PSRemotingCreds"

        "ToolSelect"

        "Overview"

        "Certificates"

        "Devices"

        "Events"

        "Files"

        "Firewall"

        "Users And Groups"

        "Network"

        "Processes"

        "Registry"

        "Roles And Features"

        "Scheduled Tasks"

        "Services"

        "Storage"

        "Updates"

    )

    # Make sure we can resolve the $DomainName

    try {

        $DomainName = $(Get-CimInstance Win32_ComputerSystem).Domain

        $ResolveDomainInfo = [System.Net.Dns]::Resolve($DomainName)

    }

    catch {

        Write-Error "Unable to resolve domain '$DomainName'! Halting!"

        $global:FunctionResult = "1"

        return

    }    

    # Create Synchronized Hashtable so that we can pass variables between Pages regardless of scope.

    # This provides benefits above and beyond Universal Dashboard's $Cache: scope for two main reasons:

    #     1) It can be referenced anywhere (not just within an -Endpoint, which is what $Cache: scope is limited to)

    #     2) It allows us to more easily communicate with our own custom Runspace(s) that handle Live (Realtime) Data. For

    #     examples of this, see uses of the 'New-Runspace' function within each of the Dynamic Pages (excluding the

    #     PSRemotingCreds and ToolSelect Pages)

    Remove-Variable -Name PUDRSSyncHT -Scope Global -Force -ErrorAction SilentlyContinue

    $global:PUDRSSyncHT = [hashtable]::Synchronized(@{})

    # Populate $PUDRSSyncHT with information that you will need for your PUD Application. This will vary depending on

    # how your application works, but at the very least, you should:

    #     1) Add a Key that will contain information that will be displayed on your HomePage (for the PUDAdminCenter App,

    #     this is the Value contained within the 'RemoteHostList' Key)

    #     2) If you are planning on using Live (Realtime) Data, ensure you add one or more keys that will contain

    #     Live Data. (For the PUDAdminCenter App, this is the LiveDataRSInfo Key that exists within a hashtable

    #     dedicated to each specific Remote Host)

    # For this PUDAdminCenterPrototype Application, the structure of the $PUDRSSyncHT will look like...

    <#

        @{

            RemoteHostList   = $null

            <RemoteHostInfo> = @{

                NetworkInfo                 = $null

                <DynamicPage>               = @{

                    <StaticInfoKey>     = $null

                    LiveDataRSInfo      = $null

                    LiveDataTracker     = @{

                        Current     = $null

                        Previous    = $null

                    }

                }

            }

        }

    #>

    # In other words. each Key within the $PUDRSSyncHT Synchronized Hashtable (with the exception of the 'RemoteHostList' key)

    # will represent a Remote Host that we intend to manage. Each RemoteHost key value will be a hashtable containing the key

    # 'NetworkInfo', as well as keys that rperesent relevant Dynamic Pages ('Overview','Certificates',etc). Each Dynamic Page

    # key value will be a hashtable containing one or more keys with value(s) representing static info that is queried at the time

    # the page loads as well as the keys 'LiveDataRSInfo', and 'LiveDataTracker'. Some key values are initially set to $null because

    # actions taken either prior to starting the UDDashboard or actions taken within the PUDAdminCenter WebApp itself on different

    # pages will set/reset their values as appropriate.

    # Let's populate $PUDRSSyncHT.RemoteHostList with information that will be needed immediately upon navigating to the $HomePage.

    # For this reason, we're gathering the info before we start the UDDashboard. (Note that the below 'GetComputerObjectInLDAP' Private

    # function gets all Computers in Active Directory without using the ActiveDirectory PowerShell Module)

    [System.Collections.ArrayList]$InitialRemoteHostListPrep = $(GetComputerObjectsInLDAP -ObjectCount 20).Name

    # Let's just get 20 of them initially. We want *something* on the HomePage but we don't want hundreds/thousands of entries. We want

    # the user to specify individual/range of hosts/devices that they want to manage.

    #$InitialRemoteHostListPrep = $InitialRemoteHostListPrep[0..20]

    if ($PSVersionTable.PSEdition -eq "Core") {

        [System.Collections.ArrayList]$InitialRemoteHostListPrep = $InitialRemoteHostListPrep | foreach {$_ -replace "CN=",""}

    }

    # Filter Out the Remote Hosts that we can't resolve

    [System.Collections.ArrayList]$InitialRemoteHostList = @()

    $null = Clear-DnsClientCache

    foreach ($HName in $InitialRemoteHostListPrep) {

        try {

            $RemoteHostNetworkInfo = ResolveHost -HostNameOrIP $HName -ErrorAction Stop

            if ($InitialRemoteHostList.FQDN -notcontains $RemoteHostNetworkInfo.FQDN) {

                $null = $InitialRemoteHostList.Add($RemoteHostNetworkInfo)

            }

        }

        catch {

            continue

        }

    }

    $PUDRSSyncHT.Add("RemoteHostList",$InitialRemoteHostList)

    # Add Keys for each of the Remote Hosts in the $InitialRemoteHostList    

    foreach ($RHost in $InitialRemoteHostList) {

        $Key = $RHost.HostName + "Info"

        $Value = @{

            NetworkInfo                 = $RHost

            CredHT                      = $null

            ServerInventoryStatic       = $null

            RelevantNetworkInterfaces   = $null

            LiveDataRSInfo              = $null

            LiveDataTracker             = @{Current = $null; Previous = $null}

        }

        foreach ($DynPage in $($DynamicPages | Where-Object {$_ -notmatch "PSRemotingCreds|ToolSelect"})) {

            $DynPageHT = @{

                LiveDataRSInfo      = $null

                LiveDataTracker     = @{Current = $null; Previous = $null}

            }

            $Value.Add($($DynPage -replace "[\s]",""),$DynPageHT)

        }

        $PUDRSSyncHT.Add($Key,$Value)

    }

    if ($InstallNmap) {

        # Install nmap

        if ($(Get-Module -ListAvailable).Name -notcontains "ProgramManagement") {Install-Module ProgramManagement}

        if ($(Get-Module).Name -notcontains "ProgramManagement") {Import-Module ProgramManagement}

        if (!$(Get-Command nmap -ErrorAction SilentlyContinue)) {

            try {

                Write-Host "Installing 'nmap'. This could take up to 10 minutes..." -ForegroundColor Yellow

                $InstallnmapResult = Install-Program -ProgramName nmap -CommandName nmap

            }

            catch {

                Write-Error $_

                $global:FunctionResult = "1"

                return

            }

        }

        if (!$(Get-Command nmap -ErrorAction SilentlyContinue)) {

            Write-Error "Unable to find the command 'nmap'! Halting!"

            $global:FunctionResult = "1"

            return

        }

        $NmapParentDir = $(Get-Command nmap).Source | Split-Path -Parent

        [System.Collections.Arraylist][array]$CurrentEnvPathArray = $env:Path -split ';' | Where-Object {![System.String]::IsNullOrWhiteSpace($_)}

        if ($CurrentEnvPathArray -notcontains $NmapParentDir) {

            $CurrentEnvPathArray.Insert(0,$NmapParentDir)

            $env:Path = $CurrentEnvPathArray -join ';'

        }

        $SystemPathInRegistry = 'HKLM:\System\CurrentControlSet\Control\Session Manager\Environment'

        $CurrentSystemPath = $(Get-ItemProperty -Path $SystemPathInRegistry -Name PATH).Path

        [System.Collections.Arraylist][array]$CurrentSystemPathArray = $CurrentSystemPath -split ";" | Where-Object {![System.String]::IsNullOrWhiteSpace($_)}

        if ($CurrentSystemPathArray -notcontains $NmapParentDir) {

            $CurrentSystemPathArray.Insert(0,$NmapParentDir)

            $UpdatedSystemPath = $CurrentSystemPathArray -join ';'

            Set-ItemProperty -Path $SystemPathInRegistry -Name PATH -Value $UpdatedSystemPath

        }

    }

    #endregion >> Prep

    #region >> Dynamic Pages

'Add Dynamic Pages Here'

    #endregion >> Dynamic Pages

    #region >> Static Pages

'Add Static Pages Here'

    #endregion >> Static Pages

    # Finalize the Site

    $Theme = New-UDTheme -Name "DefaultEx" -Parent Default -Definition @{

        UDDashboard = @{

            BackgroundColor = "rgb(255,255,255)"

        }

    }

    $MyDashboard = New-UDDashboard -Title "PUD Admin Center" -Pages $Pages -Theme $Theme

    # Start the Site

    Start-UDDashboard -Dashboard $MyDashboard -Port $Port

}

# SIG # Begin signature block

# MIIM3gYJKoZIhvcNAQcCoIIMzzCCDMsCAQExCzAJBgUrDgMCGgUAMGkGCisGAQQB

# gjcCAQSgWzBZMDQGCisGAQQBgjcCAR4wJgIDAQAABBAfzDtgWUsITrck0sYpfvNR

# AgEAAgEAAgEAAgEAAgEAMCEwCQYFKw4DAhoFAAQUPFyC6v4PCcHd+oXb943Nbh73

# 5DGgggpPMIIEKTCCAxGgAwIBAgITRAAAAALGGh0rrvpIiwAAAAAAAjANBgkqhkiG

# 9w0BAQsFADBAMRMwEQYKCZImiZPyLGQBGRYDbGFiMRUwEwYKCZImiZPyLGQBGRYF

# YWxwaGExEjAQBgNVBAMTCUFscGhhREMwMTAeFw0xODExMDYxNTQ2MjhaFw0yMDEx

# MDYxNTU2MjhaMEExEzARBgoJkiaJk/IsZAEZFgNsYWIxFTATBgoJkiaJk/IsZAEZ

# FgVhbHBoYTETMBEGA1UEAxMKQWxwaGFTdWJDQTCCASIwDQYJKoZIhvcNAQEBBQAD

# ggEPADCCAQoCggEBAJ0yJxQZZ7jXPnBuOefihL0ehpBF1zoZpcM30pWneQA/kk9w

# ByX9ISyKWTABstiIu8b2g6lKUjZBM8AOcLPSjl1ZMQkh+qaSQbJFVNeNYllGpjd1

# oOYvSPtr9iPpghVkAFWw9IdOgnd/4XDd4NqlddyR4Qb0g7v3+AMYrqhQCk2VzELp

# 215LEO9sy1EMy7+B29B6P43Rp7ljA9Wc4Hnl+onviFWcIxmIhd0yGdobSxOSDgv5

# SUBfwk+DW03Y9pmJJHCU9hXFFVsPnrfBEvicGrkYx0vA+/O+jh5otex4eR+Tt7eB

# 5VhrfdHKbEkZnBwrJOVz3rURZIu3BsDFSfwNd70CAwEAAaOCARkwggEVMBAGCSsG

# AQQBgjcVAQQDAgEAMB0GA1UdDgQWBBRWBfwwFO+72Ebloy7rHmHnxX3k5DAZBgkr

# BgEEAYI3FAIEDB4KAFMAdQBiAEMAQTAOBgNVHQ8BAf8EBAMCAYYwDwYDVR0TAQH/

# BAUwAwEB/zAfBgNVHSMEGDAWgBTq79v4G/Vf91c0y+vSJBWEI/vmDTA8BgNVHR8E

# NTAzMDGgL6AthitodHRwOi8vcGtpLmFscGhhLmxhYi9jZXJ0ZGF0YS9BbHBoYURD

# MDEuY3JsMEcGCCsGAQUFBwEBBDswOTA3BggrBgEFBQcwAoYraHR0cDovL3BraS5h

# bHBoYS5sYWIvY2VydGRhdGEvQWxwaGFEQzAxLmNydDANBgkqhkiG9w0BAQsFAAOC

# AQEAoE9hHZ0Y5M5tC15cnxVNJa/ILfwRmwCxzPyOAUrdBu4jbSHF2vRsKIJAXFs4

# +mwXqXpLYSUbXF5tfB86OKs2f9L7soln3BXJHj3eEs27htf7RJK1JjPtO8rs3pdn

# h7TbDO3nyjkTcywJioScFZUTdIsQj7TBm3HIQ+/ZSdIWMHlQnYV2kW13XqUZnLhv

# PRjy1NMBG1BAxUrc4bMi1X+mVxoYb/tiB59jakd95wi7ICi2H/07dXoDpi+kAQA1

# ki1/U+cuDhuH7Q8hegt64MlmKD01rO5HODVujuIG1+M5ZkGDeLNKksPHcSJ/DBSn

# KjZca16Sn9No2kLq1q9gD8X/wzCCBh4wggUGoAMCAQICE3AAAAAHhXSIXehTWisA

# AAAAAAcwDQYJKoZIhvcNAQELBQAwQTETMBEGCgmSJomT8ixkARkWA2xhYjEVMBMG

# CgmSJomT8ixkARkWBWFscGhhMRMwEQYDVQQDEwpBbHBoYVN1YkNBMB4XDTE4MTEw

# NzAzMTQyMFoXDTE5MTEwNzAzMTQyMFowTzETMBEGCgmSJomT8ixkARkWA2xhYjEV

# MBMGCgmSJomT8ixkARkWBWFscGhhMQ4wDAYDVQQDEwVVc2VyczERMA8GA1UEAxMI

# YWxwaGFkZXYwggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQCMUGwGv3p0

# prkDmSUQphU6UvIFQ57NxJFUOSmMZ7SY/nYNDy0iTN26eD0S5J8AQE8B/IGLHUno

# tKFl2AUcQ31hpaSLE1YkThR3WZ4SFUaBMUgKKLc/RQKqE0iNbAfh53N/nnGs6jyu

# 47kyuFRwWE2tZee6b5hh0dbT7YZnahLO7cLWErU4ikWWjEA98TcMK1gaNa5ThBn1

# +4bo9wuxjRKIGpkUJBP/1gq8qeSJnfNelZ34lD0EEirj7/YTzL5YkHMSXTuFMozw

# Av4lXUW/qZ1pAT9rKBalQETxBv9SuC31hU/2EiB4EYYqVFLHglFRogLd7nFZhqa/

# 2O+WdW2LsW9lAgMBAAGjggL/MIIC+zAOBgNVHQ8BAf8EBAMCB4AwHQYDVR0OBBYE

# FMy71rz8tJOXdsGvBt6SIVSKUlrkMB8GA1UdIwQYMBaAFFYF/DAU77vYRuWjLuse

# YefFfeTkMIH3BgNVHR8Ege8wgewwgemggeaggeOGgbJsZGFwOi8vL0NOPUFscGhh

# U3ViQ0EsQ049QWxwaGFTdWJDQSxDTj1DRFAsQ049UHVibGljJTIwS2V5JTIwU2Vy

# dmljZXMsQ049U2VydmljZXMsQ049Q29uZmlndXJhdGlvbixEQz1hbHBoYSxEQz1s

# YWI/Y2VydGlmaWNhdGVSZXZvY2F0aW9uTGlzdD9iYXNlP29iamVjdENsYXNzPWNS

# TERpc3RyaWJ1dGlvblBvaW50hixodHRwOi8vcGtpLmFscGhhLmxhYi9jZXJ0ZGF0

# YS9BbHBoYVN1YkNBLmNybDCB9AYIKwYBBQUHAQEEgecwgeQwgacGCCsGAQUFBzAC

# hoGabGRhcDovLy9DTj1BbHBoYVN1YkNBLENOPUFJQSxDTj1QdWJsaWMlMjBLZXkl

# MjBTZXJ2aWNlcyxDTj1TZXJ2aWNlcyxDTj1Db25maWd1cmF0aW9uLERDPWFscGhh

# LERDPWxhYj9jQUNlcnRpZmljYXRlP2Jhc2U/b2JqZWN0Q2xhc3M9Y2VydGlmaWNh

# dGlvbkF1dGhvcml0eTA4BggrBgEFBQcwAoYsaHR0cDovL3BraS5hbHBoYS5sYWIv

# Y2VydGRhdGEvQWxwaGFTdWJDQS5jcnQwPQYJKwYBBAGCNxUHBDAwLgYmKwYBBAGC

# NxUIhLycPIHG3hyBiYk0hLvpfobokGRgg9+kPoHDslgCAWQCAQIwHwYDVR0lBBgw

# FgYKKwYBBAGCNwoDDAYIKwYBBQUHAwMwKQYJKwYBBAGCNxUKBBwwGjAMBgorBgEE

# AYI3CgMMMAoGCCsGAQUFBwMDMC0GA1UdEQQmMCSgIgYKKwYBBAGCNxQCA6AUDBJh

# bHBoYWRldkBhbHBoYS5sYWIwDQYJKoZIhvcNAQELBQADggEBAIhV0GPEvq5KwIs+

# DTqLsqHcojMyJhJwrZkEim2XAJfNQFkiDrZzism7lOyXYJol6Bjz1txhos7P194+

# VyBdEZ/Q+r94hrq6SFgC2gCAReDZiy50Au/hTv958QNX/O0OFdIGBxavLqBrWbwu

# yH+RtE9E4LICSPPd0dM/5XE0xtqDMjZcl3pVkqgHpv3O3zgtsTW+FWr4b9lq3rCO

# HxsBGU1w7Eh0LLK8MLqioecr/4B1rPTJkcASXWMU5bllQgQvUmlKW0GIfhC9aM4J

# 04MeJOU1mHLjDcxwWpDD670AFmGRg/mMPxMywvY0HLUszWikcXNYxF1ph+LhlLI9

# f9R1qqkxggH5MIIB9QIBATBYMEExEzARBgoJkiaJk/IsZAEZFgNsYWIxFTATBgoJ

# kiaJk/IsZAEZFgVhbHBoYTETMBEGA1UEAxMKQWxwaGFTdWJDQQITcAAAAAeFdIhd

# 6FNaKwAAAAAABzAJBgUrDgMCGgUAoHgwGAYKKwYBBAGCNwIBDDEKMAigAoAAoQKA

# ADAZBgkqhkiG9w0BCQMxDAYKKwYBBAGCNwIBBDAcBgorBgEEAYI3AgELMQ4wDAYK

# KwYBBAGCNwIBFTAjBgkqhkiG9w0BCQQxFgQUDxS7nVhhQR8N6NKb8h90+CuNFHow

# DQYJKoZIhvcNAQEBBQAEggEAM7tUi7KSpfppLzSTtDsXAMuV85EqPDFcAdBAW1cf

# IVter0cjjsIGJHO0LNZ9QC2qotbhBKbKCVXgwhhyKvlDftVSwC8EYWSYdpBSwa2E

# l1wejm0OHKJ3GHAEyJKQrY1R2YUCJMsc9U2tlMh5u9EF/Ag148wZZGDaxFqveosK

# bDH1anw5HODc8JZDA73l4eX1i/acBRxltLPc5muY8fQ+J/IreMyMwrLPrpOFxFKM

# Ck79MNwwuEqGBk4GNstilJhUwo06gpgCt1kRZ/2VEN9Gb6nESAm6uxoMu0d3p9cr

# d/bjDxBaIf/THCJBjCN/w4FIWXX7wVziaeeUcB7I0hn5+g==

# SIG # End signature block