Merge branch 'dev' into 'master'

Release v.2.9.1

See merge request fozzy-winadmins/AutomaticMaintenance!18

Author: Fedor Ershov

AutomaticMaintenance.psd1

@@ -1,6 +1,6 @@
 @{
     RootModule        = 'AutomaticMaintenance.psm1'
-    ModuleVersion     = '2.9'
+    ModuleVersion     = '2.9.1'
     GUID              = '8e34abf8-40ba-4c68-8bf8-f235cd001d82'
     Author            = 'Kirill Nikolaev'
     CompanyName       = 'Fozzy Inc.'
@@ -26,6 +26,6 @@
             LicenseUri   = 'https://github.com/FozzyHosting/AutomaticMaintenance/blob/master/LICENSE'
             ProjectUri   = 'https://github.com/FozzyHosting/AutomaticMaintenance/'
             ReleaseNotes = ''
-        }  
+        }
     }
 }

AutomaticMaintenance.psm1

@@ -29,6 +29,7 @@ $ModuleName = ($MyInvocation.MyCommand.Name).Substring(0, ($MyInvocation.MyComma
 [System.TimeSpan]$ModuleWidePreventiveLockThreshold = New-Object -TypeName 'System.TimeSpan' -ArgumentList @(1, 0, 0)
 [bool]$ModuleWideSkipPreventivelyLocked = $true
 [bool]$ModuleWideSkipNotLockable = $true
+[string]$ModuleWideSkipPreventivelyLockedFullyQualifiedErrorId = 'SkipPreventivelyLockedHost'
 
 [int]$ModuleWideInstallUpdateTimeout = 60
 [System.TimeSpan]$ModuleWideInstallUpdateThreshold = New-Object -TypeName 'System.TimeSpan' -ArgumentList @(1, 0, 0)

Private/Initialize-ComputerMaintenance.ps1

@@ -8,7 +8,8 @@ function Initialize-ComputerMaintenance {
         [Parameter(Mandatory)]
         [ref]$DestinationHostLock,
         [switch]$SkipNotLockable,
-        [switch]$SkipPreventivelyLocked
+        [switch]$SkipPreventivelyLocked,
+        [string]$SkipPreventivelyLockedFullyQualifiedErrorId
     )
 
     $ErrorActionPreference = 'Stop'
@@ -75,8 +76,8 @@ function Initialize-ComputerMaintenance {
                         Write-Debug -Message ('$SkipPreventivelyLocked: ''{0}''' -f $SkipPreventivelyLocked)
                         Write-Debug -Message 'if ($SkipPreventivelyLocked)'
                         if ($SkipPreventivelyLocked) {
-                            Write-Debug -Message 'return'
-                            return
+                            $Message = ('Skipping the computer {0} because it is locked by other sources for more than {1} already and $SkipPreventivelyLocked is {2}.' -f $ComputerName, [string]$PreventiveLockThreshold, [string]$SkipPreventivelyLocked)
+                            $PSCmdlet.ThrowTerminatingError((New-Object -TypeName 'System.Management.Automation.ErrorRecord' -ArgumentList ((New-Object -TypeName 'System.OperationCanceledException' -ArgumentList $Message), $SkipPreventivelyLockedFullyQualifiedErrorId, [System.Management.Automation.ErrorCategory]::OperationStopped, $null)))
                         }
                         else {
                             $Message = ('Computer {0} is locked by other sources for more than {1} already' -f $ComputerName, [string]$PreventiveLockThreshold)

Public/Invoke-ComputerMaintenance.ps1

@@ -6,6 +6,7 @@ function Invoke-ComputerMaintenance {
         [string]$ComputerName,
         [int]$PreventiveLockTimeout = $ModuleWidePreventiveLockTimeout,
         [System.TimeSpan]$PreventiveLockThreshold = $ModuleWidePreventiveLockThreshold,
+        [string]$SkipPreventivelyLockedFullyQualifiedErrorId = $ModuleWideSkipPreventivelyLockedFullyQualifiedErrorId,
         [switch]$SkipNotLockable = $ModuleWideSkipNotLockable,
         [switch]$SkipPreventivelyLocked = $ModuleWideSkipPreventivelyLocked,
         [switch]$EnableMaintenanceLog = $ModuleWideEnableMaintenanceLog
@@ -44,8 +45,8 @@ function Invoke-ComputerMaintenance {
             Write-Debug -Message 'if ($PendingReboot.ComponentBasedServicing)'
             if ($PendingReboot.ComponentBasedServicing) {
                 # Sometimes, when CBS requires reboot, search for updates hangs up. Therefore, we need to reboot the machine first.
-                Write-Debug -Message ('$ComputerWorkload = Initialize-ComputerMaintenance -ComputerName ''{0}'' -HostLock ([ref]$HostLock) -DestinationHostLock ([ref]$DestinationHostLock) -SkipNotLockable:${1} -SkipPreventivelyLocked:${2}' -f $ComputerName, $SkipNotLockable, $SkipPreventivelyLocked)
-                $ComputerWorkload = Initialize-ComputerMaintenance -ComputerName $ComputerName -HostLock ([ref]$HostLock) -DestinationHostLock ([ref]$DestinationHostLock) -SkipNotLockable:$SkipNotLockable -SkipPreventivelyLocked:$SkipPreventivelyLocked
+                Write-Debug -Message ('$ComputerWorkload = Initialize-ComputerMaintenance -ComputerName ''{0}'' -HostLock ([ref]$HostLock) -DestinationHostLock ([ref]$DestinationHostLock) -SkipNotLockable:${1} -SkipPreventivelyLocked:${2} -SkipPreventivelyLockedFullyQualifiedErrorId ''{3}''' -f $ComputerName, $SkipNotLockable, $SkipPreventivelyLocked, $SkipPreventivelyLockedFullyQualifiedErrorId)
+                $ComputerWorkload = Initialize-ComputerMaintenance -ComputerName $ComputerName -HostLock ([ref]$HostLock) -DestinationHostLock ([ref]$DestinationHostLock) -SkipNotLockable:$SkipNotLockable -SkipPreventivelyLocked:$SkipPreventivelyLocked -SkipPreventivelyLockedFullyQualifiedErrorId $SkipPreventivelyLockedFullyQualifiedErrorId
                 Write-Debug -Message ('$ComputerWorkload: ''{0}''' -f [string]$ComputerWorkload)
 
                 Write-Debug -Message ('$HostLock: ''{0}''' -f $HostLock)
@@ -72,8 +73,8 @@ function Invoke-ComputerMaintenance {
                 $IsMaintenanceNeeded = Test-MaintenanceNeeded -ComputerName $ComputerName
                 Write-Debug -Message ('$IsMaintenanceNeeded = ${0}' -f $IsMaintenanceNeeded)
                 if ($IsMaintenanceNeeded) {
-                    Write-Debug -Message ('$ComputerWorkload = Initialize-ComputerMaintenance -ComputerName ''{0}'' -HostLock ([ref]$HostLock) -DestinationHostLock ([ref]$DestinationHostLock) -SkipNotLockable:${1} -SkipPreventivelyLocked:${2}' -f $ComputerName, $SkipNotLockable, $SkipPreventivelyLocked)
-                    $ComputerWorkload = Initialize-ComputerMaintenance -ComputerName $ComputerName -HostLock ([ref]$HostLock) -DestinationHostLock ([ref]$DestinationHostLock) -SkipNotLockable:$SkipNotLockable -SkipPreventivelyLocked:$SkipPreventivelyLocked
+                    Write-Debug -Message ('$ComputerWorkload = Initialize-ComputerMaintenance -ComputerName ''{0}'' -HostLock ([ref]$HostLock) -DestinationHostLock ([ref]$DestinationHostLock) -SkipNotLockable:${1} -SkipPreventivelyLocked:${2} -SkipPreventivelyLockedFullyQualifiedErrorId ''{3}''' -f $ComputerName, $SkipNotLockable, $SkipPreventivelyLocked, $SkipPreventivelyLockedFullyQualifiedErrorId)
+                    $ComputerWorkload = Initialize-ComputerMaintenance -ComputerName $ComputerName -HostLock ([ref]$HostLock) -DestinationHostLock ([ref]$DestinationHostLock) -SkipNotLockable:$SkipNotLockable -SkipPreventivelyLocked:$SkipPreventivelyLocked -SkipPreventivelyLockedFullyQualifiedErrorId $SkipPreventivelyLockedFullyQualifiedErrorId
                     Write-Debug -Message ('$ComputerWorkload: ''{0}''' -f [string]$ComputerWorkload)
                     Write-Debug -Message ('$HostLock: ''{0}''' -f $HostLock)
                     Write-Debug -Message 'if ($HostLock)'
@@ -90,8 +91,8 @@ function Invoke-ComputerMaintenance {
                     # If the machine does not need any updates, but just a reboot, let's reboot it.
                     Write-Debug -Message ('$PendingReboot.IsRebootPending: ''{0}''' -f $PendingReboot.IsRebootPending)
                     if ($PendingReboot.IsRebootPending) {
-                        Write-Debug -Message ('$ComputerWorkload = Initialize-ComputerMaintenance -ComputerName ''{0}'' -HostLock ([ref]$HostLock) -DestinationHostLock ([ref]$DestinationHostLock) -SkipNotLockable:${1} -SkipPreventivelyLocked:${2}' -f $ComputerName, $SkipNotLockable, $SkipPreventivelyLocked)
-                        $ComputerWorkload = Initialize-ComputerMaintenance -ComputerName $ComputerName -HostLock ([ref]$HostLock) -DestinationHostLock ([ref]$DestinationHostLock) -SkipNotLockable:$SkipNotLockable -SkipPreventivelyLocked:$SkipPreventivelyLocked
+                        Write-Debug -Message ('$ComputerWorkload = Initialize-ComputerMaintenance -ComputerName ''{0}'' -HostLock ([ref]$HostLock) -DestinationHostLock ([ref]$DestinationHostLock) -SkipNotLockable:${1} -SkipPreventivelyLocked:${2} -SkipPreventivelyLockedFullyQualifiedErrorId ''{3}''' -f $ComputerName, $SkipNotLockable, $SkipPreventivelyLocked, $SkipPreventivelyLockedFullyQualifiedErrorId)
+                        $ComputerWorkload = Initialize-ComputerMaintenance -ComputerName $ComputerName -HostLock ([ref]$HostLock) -DestinationHostLock ([ref]$DestinationHostLock) -SkipNotLockable:$SkipNotLockable -SkipPreventivelyLocked:$SkipPreventivelyLocked -SkipPreventivelyLockedFullyQualifiedErrorId $SkipPreventivelyLockedFullyQualifiedErrorId
                         Write-Debug -Message ('$ComputerWorkload: ''{0}''' -f [string]$ComputerWorkload)
                         Write-Debug -Message ('$HostLock: ''{0}''' -f $HostLock)
                         Write-Debug -Message 'if ($HostLock)'
@@ -113,8 +114,13 @@ function Invoke-ComputerMaintenance {
     catch {
         Write-Debug -Message ('ENTER CATCH {0}' -f $MyInvocation.MyCommand.Name)
 
-        Write-Debug -Message ('{0}: $PSCmdlet.ThrowTerminatingError($_)' -f $MyInvocation.MyCommand.Name)
-        $PSCmdlet.ThrowTerminatingError($_)
+        Write-Debug -Message ('$_.FullyQualifiedErrorId: ''{0}''' -f $_.FullyQualifiedErrorId)
+        Write-Debug -Message ('if ($_.FullyQualifiedErrorId -ne ''{0}'')' -f $SkipPreventivelyLockedFullyQualifiedErrorId)
+        if ($_.FullyQualifiedErrorId -ne $SkipPreventivelyLockedFullyQualifiedErrorId) {
+
+            Write-Debug -Message ('{0}: $PSCmdlet.ThrowTerminatingError($_)' -f $MyInvocation.MyCommand.Name)
+            $PSCmdlet.ThrowTerminatingError($_)
+        }
 
         Write-Debug -Message ('EXIT CATCH {0}' -f $MyInvocation.MyCommand.Name)
     }