Skip to content

Migrate module to Invoke-CimMethod #13

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
realslacker wants to merge 7 commits into
base: master
Choose a base branch
from
Open

Migrate module to Invoke-CimMethod #13

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
3d1e254
Update PendingReboot.psd1
Aug 3, 2023
9e688ce
Migrate to Invoke-CimMethod
Aug 3, 2023
9da3354
added statement for multi-string values in reg key
3vent-Horiz0n Oct 13, 2023
716c4a1
changed parameter Name to MethodName
3vent-Horiz0n Oct 13, 2023
7d8abb9
improved formatting for code and output
3vent-Horiz0n Oct 13, 2023
e435484
added comments
3vent-Horiz0n Oct 15, 2023
c57296e
Merge pull request #1 from 3vent-Horiz0n/master
realslacker Jul 18, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion source/PendingReboot.psd1
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@
PowerShellVersion = '4.0'

# Functions to export from this module
FunctionsToExport = @()
FunctionsToExport = '*'

# Cmdlets to export from this module
CmdletsToExport = @()
Expand Down
147 changes: 88 additions & 59 deletions source/Public/Test-PendingReboot.ps1
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -133,108 +133,137 @@ function Test-PendingReboot

process
{
foreach ($computer in $ComputerName)
foreach ($ComputerNameItem in $ComputerName)
{
try
{
$invokeWmiMethodParameters = @{
Namespace = 'root/default'
Class = 'StdRegProv'
Name = 'EnumKey'
ComputerName = $computer
ErrorAction = 'Stop'
}

$hklm = [UInt32] "0x80000002"

## Establish a CimSession
$CredentialSplat = @{}
if ($PSBoundParameters.ContainsKey('Credential'))
{
$invokeWmiMethodParameters.Credential = $Credential
$CredentialSplat.Credential = $Credential
}
$CimSession = New-CimSession -ComputerName $ComputerNameItem @CredentialSplat -ErrorAction Stop

$InvokeCimMethodSplat = @{
CimSession = $CimSession
Namespace = 'root\CIMv2'
ClassName = 'StdRegProv'
MethodName = 'EnumKey'
Arguments = @{
hDefKey = [UInt32] "0x80000002" # HKLM
sSubKeyName = $null
}
}

## Query the Component Based Servicing Reg Key
$invokeWmiMethodParameters.ArgumentList = @($hklm, 'SOFTWARE\Microsoft\Windows\CurrentVersion\Component Based Servicing\')
$registryComponentBasedServicing = (Invoke-WmiMethod @invokeWmiMethodParameters).sNames -contains 'RebootPending'
$InvokeCimMethodSplat.Arguments.sSubKeyName = 'SOFTWARE\Microsoft\Windows\CurrentVersion\Component Based Servicing'
$RegistryComponentBasedServicing = (Invoke-CimMethod @InvokeCimMethodSplat).sNames -contains 'RebootPending'

## Query WUAU from the registry
$invokeWmiMethodParameters.ArgumentList = @($hklm, 'SOFTWARE\Microsoft\Windows\CurrentVersion\WindowsUpdate\Auto Update\')
$registryWindowsUpdateAutoUpdate = (Invoke-WmiMethod @invokeWmiMethodParameters).sNames -contains 'RebootRequired'
$InvokeCimMethodSplat.Arguments.sSubKeyName = 'SOFTWARE\Microsoft\Windows\CurrentVersion\WindowsUpdate\Auto Update'
$RegistryWindowsUpdateAutoUpdate = (Invoke-CimMethod @InvokeCimMethodSplat).sNames -contains 'RebootRequired'

## Query JoinDomain key from the registry - These keys are present if pending a reboot from a domain join operation
$invokeWmiMethodParameters.ArgumentList = @($hklm, 'SYSTEM\CurrentControlSet\Services\Netlogon')
$registryNetlogon = (Invoke-WmiMethod @invokeWmiMethodParameters).sNames
$pendingDomainJoin = ($registryNetlogon -contains 'JoinDomain') -or ($registryNetlogon -contains 'AvoidSpnSet')
$InvokeCimMethodSplat.Arguments.sSubKeyName = 'SYSTEM\CurrentControlSet\Services\Netlogon'
$RegistryNetlogon = (Invoke-CimMethod @InvokeCimMethodSplat).sNames
$PendingDomainJoin = ($RegistryNetlogon -contains 'JoinDomain') -or ($RegistryNetlogon -contains 'AvoidSpnSet')

## Query ComputerName and ActiveComputerName from the registry and setting the MethodName to GetMultiStringValue
$invokeWmiMethodParameters.Name = 'GetMultiStringValue'
$invokeWmiMethodParameters.ArgumentList = @($hklm, 'SYSTEM\CurrentControlSet\Control\ComputerName\ActiveComputerName\', 'ComputerName')
$registryActiveComputerName = Invoke-WmiMethod @invokeWmiMethodParameters
## Query ComputerName and ActiveComputerName from the registry and setting the MethodName to GetStringValue
$InvokeCimMethodSplat.MethodName = 'GetStringValue'

$invokeWmiMethodParameters.ArgumentList = @($hklm, 'SYSTEM\CurrentControlSet\Control\ComputerName\ComputerName\', 'ComputerName')
$registryComputerName = Invoke-WmiMethod @invokeWmiMethodParameters
$InvokeCimMethodSplat.Arguments.sSubKeyName = 'SYSTEM\CurrentControlSet\Control\ComputerName\ActiveComputerName'
$InvokeCimMethodSplat.Arguments.sValueName = 'ComputerName'
$RegistryActiveComputerName = (Invoke-CimMethod @InvokeCimMethodSplat).sValue

$pendingComputerRename = $registryActiveComputerName -ne $registryComputerName -or $pendingDomainJoin
$InvokeCimMethodSplat.Arguments.sSubKeyName = 'SYSTEM\CurrentControlSet\Control\ComputerName\ComputerName'
$InvokeCimMethodSplat.Arguments.sValueName = 'ComputerName'
$RegistryComputerName = (Invoke-CimMethod @InvokeCimMethodSplat).sValue

## Query PendingFileRenameOperations from the registry
$PendingComputerRename = $RegistryActiveComputerName -ne $RegistryComputerName -or $PendingDomainJoin

## Query PendingFileRenameOperations from the registry and trying with MethodName GetStringValue
if (-not $PSBoundParameters.ContainsKey('SkipPendingFileRenameOperationsCheck'))
{
$invokeWmiMethodParameters.ArgumentList = @($hklm, 'SYSTEM\CurrentControlSet\Control\Session Manager\', 'PendingFileRenameOperations')
$registryPendingFileRenameOperations = (Invoke-WmiMethod @invokeWmiMethodParameters).sValue
$registryPendingFileRenameOperationsBool = [bool]$registryPendingFileRenameOperations
$InvokeCimMethodSplat.Arguments.sSubKeyName = 'SYSTEM\CurrentControlSet\Control\Session Manager'
$InvokeCimMethodSplat.Arguments.sValueName = 'PendingFileRenameOperations'
$RegistryPendingFileRenameOperations = (Invoke-CimMethod @InvokeCimMethodSplat).sValue

### If the query returns $null then retry with MethodName GetMultiStringValue
if ($null -eq $RegistryPendingFileRenameOperations)
{
$InvokeCimMethodSplat.MethodName = 'GetMultiStringValue'
$RegistryPendingFileRenameOperations = (Invoke-CimMethod @InvokeCimMethodSplat).sValue
}

### If the query returned something then remove empty lines from the list and remove leading characters from the path strings
if ($null -ne $RegistryPendingFileRenameOperations)
{
$RegistryPendingFileRenameOperations = ($RegistryPendingFileRenameOperations | Where-Object {$_ -match '\S'}).TrimStart("\?")
}

$RegistryPendingFileRenameOperationsBool = [bool]$RegistryPendingFileRenameOperations
}

## Query ClientSDK for pending reboot status, unless SkipConfigurationManagerClientCheck is present
if (-not $PSBoundParameters.ContainsKey('SkipConfigurationManagerClientCheck'))
{
$invokeWmiMethodParameters.NameSpace = 'ROOT\ccm\ClientSDK'
$invokeWmiMethodParameters.Class = 'CCM_ClientUtilities'
$invokeWmiMethodParameters.Name = 'DetermineifRebootPending'
$invokeWmiMethodParameters.Remove('ArgumentList')
$InvokeCimMethodSplat = @{
CimSession = $CimSession
Namespace = 'root\ccm\ClientSDK'
ClassName = 'CCM_ClientUtilities'
MethodName = 'DetermineifRebootPending'
}

try
$SCCMClientSDKError = $null
$SCCMClientSDK = Invoke-CimMethod @InvokeCimMethodSplat -ErrorAction SilentlyContinue -ErrorVariable SCCMClientSDKError

if ($SCCMClientSDKError)
{
$sccmClientSDK = Invoke-WmiMethod @invokeWmiMethodParameters
$systemCenterConfigManager = $sccmClientSDK.ReturnValue -eq 0 -and ($sccmClientSDK.IsHardRebootPending -or $sccmClientSDK.RebootPending)
$SystemCenterConfigManager = $null
Write-Verbose $SCCMClientSDKError.Exception.Message
Write-Verbose ($script:localizedData.invokeWmiClientSDKError -f $ComputerNameItem)
}
catch
else
{
$systemCenterConfigManager = $null
Write-Verbose -Message ($script:localizedData.invokeWmiClientSDKError -f $computer)
$SystemCenterConfigManager = $SCCMClientSDK.ReturnValue -eq 0 -and ($SCCMClientSDK.IsHardRebootPending -or $SCCMClientSDK.RebootPending)
}
}

$isRebootPending = $registryComponentBasedServicing -or `
$pendingComputerRename -or `
$pendingDomainJoin -or `
$registryPendingFileRenameOperationsBool -or `
$systemCenterConfigManager -or `
$registryWindowsUpdateAutoUpdate
$IsRebootPending = $RegistryComponentBasedServicing -or
$PendingComputerRename -or
$PendingDomainJoin -or
$RegistryPendingFileRenameOperations -or
$SystemCenterConfigManager -or
$RegistryWindowsUpdateAutoUpdate

if ($PSBoundParameters.ContainsKey('Detailed'))
{
[PSCustomObject]@{
ComputerName = $computer
ComponentBasedServicing = $registryComponentBasedServicing
PendingComputerRenameDomainJoin = $pendingComputerRename
PendingFileRenameOperations = $registryPendingFileRenameOperationsBool
PendingFileRenameOperationsValue = $registryPendingFileRenameOperations
SystemCenterConfigManager = $systemCenterConfigManager
WindowsUpdateAutoUpdate = $registryWindowsUpdateAutoUpdate
IsRebootPending = $isRebootPending
ComputerName = $ComputerNameItem
ComponentBasedServicing = $RegistryComponentBasedServicing
PendingComputerRenameDomainJoin = $PendingComputerRename
PendingFileRenameOperations = $registryPendingFileRenameOperationsBool
PendingFileRenameOperationsValue = $registryPendingFileRenameOperations
SystemCenterConfigManager = $SystemCenterConfigManager
WindowsUpdateAutoUpdate = $RegistryWindowsUpdateAutoUpdate
IsRebootPending = $IsRebootPending
}
}
else
{
[PSCustomObject]@{
ComputerName = $computer
IsRebootPending = $isRebootPending
ComputerName = $ComputerNameItem
IsRebootPending = $IsRebootPending
}
}
}

catch
finally
{
Write-Verbose "$Computer`: $_"
if ($null -ne $CimSession)
{
Remove-CimSession -CimSession $CimSession
}
}
}
}
Expand Down