-
-
Save antiphasis/8ad52bae0d219577c778243a9d22f403 to your computer and use it in GitHub Desktop.
PowerShell: Script Template Version 2 (with logging)
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
#requires -version 4 | |
<# | |
.SYNOPSIS | |
<Overview of script> | |
.DESCRIPTION | |
<Brief description of script> | |
.PARAMETER <Parameter_Name> | |
<Brief description of parameter input required. Repeat this attribute if required> | |
.INPUTS | |
<Inputs if any, otherwise state None> | |
.OUTPUTS Log File | |
The script log file stored in C:\Windows\Temp\<name>.log | |
.NOTES | |
Version: 1.0 | |
Author: <Name> | |
Creation Date: <Date> | |
Purpose/Change: Initial script development | |
.EXAMPLE | |
<Example explanation goes here> | |
<Example goes here. Repeat this attribute for more than one example> | |
#> | |
#---------------------------------------------------------[Script Parameters]------------------------------------------------------ | |
Param ( | |
#Script parameters go here | |
) | |
#---------------------------------------------------------[Initialisations]-------------------------------------------------------- | |
#Set Error Action to Silently Continue | |
$ErrorActionPreference = 'SilentlyContinue' | |
#Import Modules & Snap-ins | |
Import-Module PSLogging | |
#----------------------------------------------------------[Declarations]---------------------------------------------------------- | |
#Script Version | |
$sScriptVersion = '1.0' | |
#Log File Info | |
$sLogPath = 'C:\Windows\Temp' | |
$sLogName = '<script_name>.log' | |
$sLogFile = Join-Path -Path $sLogPath -ChildPath $sLogName | |
#-----------------------------------------------------------[Functions]------------------------------------------------------------ | |
<# | |
Function <FunctionName> { | |
Param () | |
Begin { | |
Write-LogInfo -LogPath $sLogFile -Message '<description of what is going on>...' | |
} | |
Process { | |
Try { | |
<code goes here> | |
} | |
Catch { | |
Write-LogError -LogPath $sLogFile -Message $_.Exception -ExitGracefully | |
Break | |
} | |
} | |
End { | |
If ($?) { | |
Write-LogInfo -LogPath $sLogFile -Message 'Completed Successfully.' | |
Write-LogInfo -LogPath $sLogFile -Message ' ' | |
} | |
} | |
} | |
#> | |
#-----------------------------------------------------------[Execution]------------------------------------------------------------ | |
Start-Log -LogPath $sLogPath -LogName $sLogName -ScriptVersion $sScriptVersion | |
#Script Execution goes here | |
Stop-Log -LogPath $sLogFile |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment