DSCResources/DSC_OfflineDomainJoin/DSC_OfflineDomainJoin.psm1
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 |
[Diagnostics.CodeAnalysis.SuppressMessageAttribute("PSAvoidGlobalVars", "", Scope = "Function")] param ( ) $modulePath = Join-Path -Path (Split-Path -Path (Split-Path -Path $PSScriptRoot -Parent) -Parent) -ChildPath 'Modules' # Import the ComputerManagementDsc Common Modules Import-Module -Name (Join-Path -Path $modulePath ` -ChildPath (Join-Path -Path 'ComputerManagementDsc.Common' ` -ChildPath 'ComputerManagementDsc.Common.psm1')) Import-Module -Name (Join-Path -Path $modulePath -ChildPath 'DscResource.Common') # Import Localization Strings $script:localizedData = Get-LocalizedData -DefaultUICulture 'en-US' <# .SYNOPSIS Joins the computer to a domain with a domain join file. .PARAMETER IsSingleInstance Specifies the resource is a single instance, the value must be 'Yes'. This value is Not used in Get-TargetResource. .PARAMETER RequestFile The full path to the Offline Domain Join Request file to use. This value is not used in Get-TargetResource. #> function Get-TargetResource { [CmdletBinding()] [OutputType([System.Collections.Hashtable])] param ( [Parameter(Mandatory = $true)] [ValidateSet('Yes')] [System.String] $IsSingleInstance, [Parameter(Mandatory = $true)] [ValidateNotNullOrEmpty()] [System.String] $RequestFile ) Write-Verbose -Message ( @( "$($MyInvocation.MyCommand): " $($script:localizedData.GettingOfflineDomainJoinMessage) ) -join '') <# It is not possible to read the ODJ file that was used to join a domain So it has to always be returned as blank. #> $returnValue = @{ IsSingleInstance = 'Yes' RequestFile = '' } return $returnValue } # Get-TargetResource <# .SYNOPSIS Sets the current state of the offline domain join. .PARAMETER IsSingleInstance Specifies the resource is a single instance, the value must be 'Yes'. .PARAMETER RequestFile The full path to the Offline Domain Join Request file to use. #> function Set-TargetResource { [CmdletBinding()] param ( [Parameter(Mandatory = $true)] [ValidateSet('Yes')] [System.String] $IsSingleInstance, [Parameter(Mandatory = $true)] [ValidateNotNullOrEmpty()] [System.String] $RequestFile ) Write-Verbose -Message ( @( "$($MyInvocation.MyCommand): " $($script:localizedData.ApplyingOfflineDomainJoinMessage) ) -join '') # Check the ODJ Request file exists if (-not (Test-Path -Path $RequestFile)) { New-InvalidArgumentException ` -Message ($script:localizedData.RequestFileNotFoundError -f $RequestFile) ` -ArgumentName 'RequestFile' } # if <# Don't need to check if the domain is already joined because Set-TargetResource wouldn't fire unless it wasn't. #> Join-Domain -RequestFile $RequestFile } # Set-TargetResource <# .SYNOPSIS Tests the current state of the machine joining a domain using an offline domain join file. .PARAMETER IsSingleInstance Specifies the resource is a single instance, the value must be 'Yes'. .PARAMETER RequestFile The full path to the Offline Domain Join Request file to use. #> function Test-TargetResource { [CmdletBinding()] [OutputType([System.Boolean])] param ( [Parameter(Mandatory = $true)] [ValidateSet('Yes')] [System.String] $IsSingleInstance, [Parameter(Mandatory = $true)] [ValidateNotNullOrEmpty()] [System.String] $RequestFile ) # Flag to signal whether settings are correct [System.Boolean] $desiredConfigurationMatch = $true Write-Verbose -Message ( @("$($MyInvocation.MyCommand): " $($script:localizedData.CheckingOfflineDomainJoinMessage) ) -join '') # Check the ODJ Request file exists if (-not (Test-Path -Path $RequestFile)) { New-InvalidArgumentException ` -Message ($script:localizedData.RequestFileNotFoundError -f $RequestFile) ` -ArgumentName 'RequestFile' } # if $currentDomainName = Get-DomainName if ($currentDomainName) { # Domain is already joined. Write-Verbose -Message ( @( "$($MyInvocation.MyCommand): " $($script:localizedData.DomainAlreadyJoinedMessage -f $CurrentDomainName) ` ) -join '' ) } else { # Domain is not joined, so change is required. Write-Verbose -Message ( @("$($MyInvocation.MyCommand): " $($script:localizedData.DomainNotJoinedMessage) ) -join '') $desiredConfigurationMatch = $false } # if return $desiredConfigurationMatch } # Test-TargetResource <# .SYNOPSIS Uses DJoin.exe to join a Domain using a ODJ Request File. #> function Join-Domain { [CmdletBinding()] param ( [Parameter(Mandatory = $true)] [System.String] $RequestFile ) Write-Verbose -Message ( @( "$($MyInvocation.MyCommand): " $($script:localizedData.AttemptingDomainJoinMessage -f $RequestFile) ` ) -join '' ) $djoinResult = & djoin.exe @( '/REQUESTODJ' '/LOADFILE' $RequestFile '/WINDOWSPATH' $ENV:SystemRoot '/LOCALOS') if ($LASTEXITCODE -eq 0) { # Notify DSC that a reboot is required. $global:DSCMachineStatus = 1 } else { Write-Verbose -Message $djoinResult New-InvalidOperationException ` -Message ($script:localizedData.DjoinError -f $LASTEXITCODE) } # if Write-Verbose -Message ( @( "$($MyInvocation.MyCommand): " $($script:localizedData.DomainJoinedMessage -f $RequestFile) ` ) -join '' ) } # function Join-Domain <# .SYNOPSIS Returns the name of the Domain the computer is joined to or $null if not domain joined. #> function Get-DomainName { [CmdletBinding()] [OutputType([System.String])] param () # Use CIM to detect the domain name so that this will work on Nano Server. $computerSystem = Get-CimInstance -ClassName 'Win32_ComputerSystem' -Namespace root\cimv2 if ($computerSystem.Workgroup) { return $null } else { $computerSystem.Domain } } # function Get-DomainName Export-ModuleMember -Function *-TargetResource |