Templates/PowerShell.Template.Script.ps1
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 |
<#
.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 <Outputs if any, otherwise state None - example: 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 goes here. Repeat this attribute for more than one example> #> #---------------------------------------------------------[Initialisations]-------------------------------------------------------- #Set Error Action to Silently Continue $ErrorActionPreference = "SilentlyContinue" #Dot Source required Function Libraries . "C:\Scripts\Functions\Logging_Functions.ps1" #----------------------------------------------------------[Declarations]---------------------------------------------------------- $HostServer = $ENV:ComputerName $Date = Get-Date -UFormat "%Y.%m.%d @ %R" $ScriptName = $MyInvocation.MyCommand.Name #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>{ [CmdletBinding()] Param() Begin{ Log-Write -LogPath $sLogFile -LineValue "<description of what is going on>..." } Process{ Try{ <code goes here> } Catch{ Log-Error -LogPath $sLogFile -ErrorDesc $_.Exception -ExitGracefully $True Break } } End{ IF($?){ Log-Write -LogPath $sLogFile -LineValue "Completed Successfully." Log-Write -LogPath $sLogFile -LineValue " " } } } #> #-----------------------------------------------------------[Execution]------------------------------------------------------------ #Log-Start -LogPath $sLogPath -LogName $sLogName -ScriptVersion $sScriptVersion #Script Execution goes here #Log-Finish -LogPath $sLogFile |