DryActiveDirectory

1.1.1

ScriptBlocks/DryAD_SB_BackupGPO_Import.ps1

# DryActiveDirectory is an AD config module for use with DryDeploy, or by itself.
#
# Copyright (C) 2021 Bjørn Henrik Formo (bjornhenrikformo@gmail.com)
# LICENSE: https://raw.githubusercontent.com/bjoernf73/DryActiveDirectory/main/LICENSE
#
# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation; either version 2 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License along
# with this program; if not, write to the Free Software Foundation, Inc.,
# 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.

[ScriptBlock] $DryAD_SB_BackupGPO_Import = {
    [CmdletBinding()]
    Param (
        [String]
        $BackupName,

        [String]
        $TargetName,

        [String]
        $Path,

        [Hashtable]
        $Replacements,

        [String]
        $Server,

        [Switch]
        $Force
    )    
    Try {
        $Status   = $False
        $DoImport = $False
        
        [Bool]$GPOExists = $False  # only true if so proven during the calling of ImportGPO()
        [Array]$RemoteMessages = @("Importing Backup-GPO '$BackupName' as target '$TargetName'")

        Function Get-RandomHex {
            [CmdletBinding()]   
            Param ([int]$Length)
            Try {
                $Hex = '0123456789ABCDEF'
                [string]$Return = $null
                For ($i=1;$i -le $Length;$i++)     {
                    $Return += $Hex.Substring((Get-Random -Minimum 0 -Maximum 16),1)
                }
                Return $Return
            }
            Catch {
                $PSCmdlet.ThrowTerminatingError($_)
            }
        }

        Function Get-RandomPath {
            [CmdletBinding()]
            Param (
                [Parameter()]
                [String]
                $FolderPath = $ENV:TEMP,
        
                [Parameter()]
                [String]
                $Extension,
        
                [Parameter()]
                [Int]
                $Length = 12
            )
            Try {
                $RandomString = Get-RandomHex -Length $Length
                If ($Extension) {
                    Return (Join-Path -Path $FolderPath -ChildPath $($RandomString + ".$Extension"))
                } 
                Else {
                    Return (Join-Path -Path $FolderPath -ChildPath $RandomString)
                }
            }
            Catch {
                $PSCmdlet.ThrowTerminatingError($_)
            }
            
        }

        Try {
            Get-GPO -Name $TargetName -Server $Server -ErrorAction Stop | Out-Null
            $GPOExists = $True
            $RemoteMessages += "Target Backup-GPO '$TargetName' exists already"
            If ($Force) {
                $RenamedGPO = "$($TargetName)-OLD-$((Get-Date -Format s).Replace(':','-'))" 
                $GPO = Get-GPO -Name $TargetName -Server $Server -ErrorAction 'Stop'
                Rename-GPO -GUID $GPO.ID -TargetName $RenamedGPO  -Server $Server -ErrorAction 'Stop' | Out-Null
                # Set this to $False so it will be imported later
                $GPOExists = $False
                $DoImport = $True
            } 
            Else {
                $RemoteMessages += "-Force not passed, so I will do nothing"
                $Status = $True
                $DoImport = $False
            }
            
        } 
        Catch { 
            If ("$($_.ToString())" -match "GPO was not found") {
                $GPOExists = $False
                $DoImport = $True
                $RemoteMessages += "Target Backup-GPO '$TargetName' does not exist - importing it."
            } 
            Else {
                $RemoteMessages += "Unexpected error running Get-GPO -Name '$TargetName' "
                $RemoteMessages += "Error: $($_.ToString()) "
                $DoImport = $False
                # Some other error record - throw a terminating error
                $Status = $False
                # $PSCmdlet.ThrowTerminatingError($_)
            } 
        } 

        If (
            ($GPOExists -eq $False) -and 
            ($DoImport -eq $True)
        ) { 
            $ImportGPOParams = @{          
                BackupGpoName  = $BackupName
                TargetName     = $TargetName
                Server         = $Server
                CreateIfNeeded = $True
                Path           = $Path
                ErrorAction    = 'Stop'
            }
            $MigTablePath = Join-Path -Path $Path -ChildPath ($BackupName + '.migtable')
            $TempMigTable = $Null
            If (Test-path -Path $MigTablePath) {
                $RemoteMessages += "The migtable '$MigTablePath' exists!"
                $TempMigTable = Get-RandomPath -extension 'migtable'
                $RemoteMessages += "Creating temporary migtable clone '$TempMigTable'"

                $MigTableContent = Get-Content -Path $MigTablePath -Raw -ErrorAction Stop
                ForEach ($Key in $Replacements.Keys) {
                    $MigTableContent = $MigTableContent -replace $Key,$Replacements["$Key"]  
                }
                $MigTableContent | Out-File -FilePath $TempMigTable -Encoding unicode -Force -ErrorAction Stop
                $ImportGPOParams += @{
                    'MigrationTable'=$TempMigTable 
                }
            } 
                   
            Try {
                Import-GPO @ImportGPOParams | Out-Null
                $Status = $True
                $RemoteMessages += "Success importing GPO '$TargetName'"
            } 
            Catch {
                $RemoteMessages += "Error importing GPO '$TargetName' using migtable '$TempMigTable'"
                Start-Sleep -Seconds 2
                # If import fails, the GPO may have been created as an
                # empty or partly configured object, if so, remove it
                $GetGPOParams   = @{
                    Name        = "$TargetName"
                    Server      = $Server
                    ErrorAction = 'Ignore'
                }
                $RemoveGPOParams = @{
                    Confirm      = $False
                    ErrorAction  = 'Ignore'
                }
                Get-GPO @GetGPOParams | Remove-GPO @RemoveGPOParams | Out-Null
                Throw $_
            }
            Finally {
                If ($TempMigTable) {
                    Remove-Item -Path $TempMigTable -Confirm:$False -Force -ErrorAction Ignore | Out-Null
                }
            }
            @($Status,$Null,$RemoteMessages)
        } 
    }
    Catch {
        @($Status,$_,$RemoteMessages)
    }
    Finally {
    }  
}