ValidateScript est un mot clé dans la declaration de paramètres d'un script ou d'une fonction, permettant de valider la valeur d'un paramètre en excutant un bloc de script qui va tester la valeur passée en paramètre. NB: il complète le mot clé ValidatePattern utilisé lui pour valider le paramètre a l'aide d'une expression regulière.
L'exemple ci-dessous est celui de la validation qu'une addresse IP donnée en paramètre est bien au format IPv4. Un message customisé est renvoyé.
[CmdletBinding()]
param(
[Parameter(Mandatory=$true,HelpMessage="IP cible")]
[ValidateScript({
$startchar = "^" # CARACTERE DE DEBUT DE REGEX
$endchar = "$" # CARACTERE DE FIN DE REGEX
$ZeroOrOneTime = '?' # CHARACTERE 0 OU 1 FOIS
$byte = "(?:25[0-5]|2[0-4][0-9]|[01]$ZeroOrOneTime[0-9][0-9]$ZeroOrOneTime)" # REGEX CORRESPONDANT A UN NOMBRE D'UNE IP
$dot = '\.' # CARACTERE '.'
$IPv4 = "$byte$dot$byte$dot$byte$dot$byte" # REGEX COMPLETE D'UNE IPv4
if($_ -match "$startchar$IPv4$endchar")
{
$true
}
else
{
write-host -B white -F red "$_ N'EST PAS UNE ADDRESSE IPV4 VALIDE. VEUILLEZ RENSEIGNER UNE ADRESSE AU FORMAT X.X.X.X (Ex: 192.168.0.1)"
EXIT 1
}
})]
$TargetIP
)
Write-Host -F Green "$TargetIP EST UNE VALEUR CORRECTE"
Si la valeur renseignée est une adresse IPv4 correcte:
Si la valeur renseignée n'est pas une adresse IPv4 correcte:
Le scriptblock éxécuté par ValidateScript peut bien sur être reutilisé comme une fonction a part entière, en dehors du bloc de paramètres.