PFS On-Site Automation Guidelines
Prerequisites
Powershell V5 + and a client to run it.
Standards
All PowerShell comitted to this repo must meet the following requirements:
-
All scripts need the header as documented here. This must be present before commit and updated on each commit.
-
It must be a single script for all Prisons. Variables are defined and discovered within the script. If this is not possible, it must be documented why and be agreed with the team. A example of this
Get-ADComputer -SearchBase 'OU=Laptops,OU=Prisoners,OU=Workstations,OU=WLI,OU=Prisons,DC=WLI,DC=DPN,DC=GOV,DC=UK' -Property Name,lastLogonDate -Filter {lastLogonDate -lt $date} | Set-ADComputer -Enabled $falseShould be changed to
#What domain?
If (($env:USERDOMAIN) -eq "WLI")
{
$Global:Domain = "WLI"
}
elseif (($env:USERDOMAIN) -eq "BWI")
{
$Global:Domain = "BWI"
}
Get-ADComputer -SearchBase "OU=Laptops,OU=Prisoners,OU=Workstations,OU=$domain,OU=Prisons,DC=$domain,DC=DPN,DC=GOV,DC=UK" -Property Name,lastLogonDate -Filter {lastLogonDate -lt $date} | Set-ADComputer -Enabled $false- Audit Audit Audit! - We have a requirement to audit as much as possible in a script. The following should be used to keep things consistent.
# PowerShell function - Add-Log
# Author: Rich Dakin
Function Add-Log
{Param ([string]$logstring)
$logfile = "D:\AD-Automation\Logfile.txt"
$date = Get-date
$Global:date = $date.ToString("dd-MM-yyyy-HH-mm")
add-content $logfile -value "$date :: $logstring"
}Further examples of this is taking a one liner script that cannot be fully audited and breaking it out into more cleaner foreach
Get-ADComputer -SearchBase "OU=Laptops,OU=Prisoners,OU=Workstations,OU=$domain,OU=Prisons,DC=$domain,DC=DPN,DC=GOV,DC=UK" -Property Name,lastLogonDate -Filter {lastLogonDate -lt $date} | Set-ADComputer -Enabled $falseBecomes
$GetComputer = Get-ADComputer -SearchBase "OU=Laptops,OU=Prisoners,OU=Workstations,OU=$domain,OU=Prisons,DC=$domain,DC=DPN,DC=GOV,DC=UK" -Property Name,lastLogonDate -Filter {lastLogonDate -lt $date}
Foreach ($Computer in $GetComputer)
{
###Audit
Add-log "$Computer is being disabled"
Set-ADComputer -Identity $Computer -Enabled $False
}
- Your script must be able to run everytime. Without throwing errors. Example
New-Item -Path "c:\" -Name "logfiles" -ItemType "directory"
#The second time this script runs it will fail on the directory existing. Thus you must complete a test path and use a IF Statement.
If ((Test-path "c:\Logfiles") -ne $True)
{
New-Item -path c:\Logfiles -ItemType Directory
}
###Now the script will not fail on the subsequent runs.
-
All functions should be documented inline, as shown in point 3.
-
Code should be self documenting, with comments in the appropriate.
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent