Improves examples

Author: exchange12rocks

ScriptBlocks/Example-Finally.ps1

@@ -15,6 +15,11 @@ Write-Debug -Message ('ENTER {0}' -f $MyInvocation.MyCommand.Name)
 try {
     Write-Debug -Message ('ENTER TRY {0}' -f $MyInvocation.MyCommand.Name)
 
+    # Put here code which you want to execute at the Finally step.
+
+    # In the example below, we check if monitoring enabled for the host and, if needed, we turn it back on.
+    # As with the PreRestore step, here we use the $HostDowntime variable to pass downtime objects between step scripts.
+
     $HostDowntime = ($Variables | Where-Object -FilterScript {$_.Name -eq 'HostDowntime'}).Value
     Write-Debug -Message ('$HostDowntime: {0}' -f $HostDowntime)
     $YourFavoriteMonitoringSystemComputerName = ($Variables | Where-Object -FilterScript {$_.Name -eq 'YourFavoriteMonitoringSystemComputerName'}).Value

ScriptBlocks/Example-PostClear.ps1

@@ -17,6 +17,13 @@ Write-Debug -Message ('ENTER {0}' -f $MyInvocation.MyCommand.Name)
 try {
     Write-Debug -Message ('ENTER TRY {0}' -f $MyInvocation.MyCommand.Name)
 
+    # Put here code which you want to execute at the PostClear step.
+
+    # The example below temporarily disables monitoring (sets downtime) of the host in a fictional Your Favorite Monitoring System
+    # Note, that is this fictious monitoring system, we need the downtime object to enable monitoring of the host later.
+    # So in order to keep it, we save it into a variable ($HostDowntime) and pass that variable to the caller function.
+    # Later, on the PreRestore step, we'll use that $HostDowntime object to enable monitoring back.
+
     $CallerName = ($Variables | Where-Object -FilterScript {$_.Name -eq 'CallerName'}).Value
     Write-Debug -Message ('$CallerName = ''{0}''' -f $CallerName)
 

ScriptBlocks/Example-PostRestore.ps1

@@ -14,6 +14,8 @@ Write-Debug -Message ('ENTER {0}' -f $MyInvocation.MyCommand.Name)
 try {
     Write-Debug -Message ('ENTER TRY {0}' -f $MyInvocation.MyCommand.Name)
 
+    # Put here code which you want to execute at the PostRestore step.
+
     Write-Debug -Message ('EXIT TRY {0}' -f $MyInvocation.MyCommand.Name)
 }
 catch {

ScriptBlocks/Example-PreClear.ps1

@@ -14,6 +14,8 @@ Write-Debug -Message ('ENTER {0}' -f $MyInvocation.MyCommand.Name)
 try {
     Write-Debug -Message ('ENTER TRY {0}' -f $MyInvocation.MyCommand.Name)
 
+    # Put here code which you want to execute at the PreClear step.
+
     Write-Debug -Message ('EXIT TRY {0}' -f $MyInvocation.MyCommand.Name)
 }
 catch {

ScriptBlocks/Example-PreRestore.ps1

@@ -15,6 +15,11 @@ Write-Debug -Message ('ENTER {0}' -f $MyInvocation.MyCommand.Name)
 try {
     Write-Debug -Message ('ENTER TRY {0}' -f $MyInvocation.MyCommand.Name)
 
+    # Put here code which you want to execute at the PreRestore step.
+
+    # The example below enables back monitoring of the host in a fictional Your Favorite Monitoring System.
+    # To remove the downtime from our host, we use a downtime object from the PostClear step ($HostDowntime).
+
     $HostDowntime = ($Variables | Where-Object -FilterScript {$_.Name -eq 'HostDowntime'}).Value
     Write-Debug -Message ('$HostDowntime: {0}' -f $HostDowntime)
     $YourFavoriteMonitoringSystemComputerName = ($Variables | Where-Object -FilterScript {$_.Name -eq 'YourFavoriteMonitoringSystemComputerName'}).Value

ScriptBlocks/Example-Test.ps1

@@ -14,8 +14,10 @@ Write-Debug -Message ('ENTER {0}' -f $MyInvocation.MyCommand.Name)
 try {
     Write-Debug -Message ('ENTER TRY {0}' -f $MyInvocation.MyCommand.Name)
 
+    # Put here code which you want to execute at the Test step.
+
     Write-Debug -Message '$true'
-    $true # Really, you should put some commands here instead, which will test your node.
+    $true # Really, you should put some commands here instead, which will test readiness of your node.
 
     Write-Debug -Message ('EXIT TRY {0}' -f $MyInvocation.MyCommand.Name)
 }