À propos de CommonParameters
DESCRIPTION COURTE
Décrit les paramètres qui peuvent être utilisés avec n’importe quelle applet de commande.
DESCRIPTION DÉTAILLÉE
Les paramètres courants sont un ensemble de paramètres d’applet de commande que vous pouvez utiliser avec n’importe quelle applet de commande. Ils sont implémentés par PowerShell, et non par le développeur d’applets de commande, et ils sont automatiquement disponibles pour n’importe quelle applet de commande.
Vous pouvez utiliser les paramètres courants avec n’importe quelle applet de commande, mais ils n’ont peut-être pas d’effet sur toutes les applets de commande. Par exemple, si une applet de commande ne génère aucune sortie détaillée, l’utilisation du paramètre commun Verbose n’a aucun effet.
Les paramètres courants sont également disponibles sur les fonctions avancées qui utilisent l’attribut CmdletBinding ou l’attribut Paramètre .
Plusieurs paramètres courants remplacent les valeurs par défaut système ou les préférences que vous définissez à l’aide des variables de préférence PowerShell. Contrairement aux variables de préférence, les paramètres courants affectent uniquement les commandes dans lesquelles elles sont utilisées.
Pour plus d’informations, consultez about_Preference_Variables.
La liste suivante affiche les paramètres courants. Leurs alias sont répertoriés entre parenthèses.
- Debug (db)
- ErrorAction (ea)
- ErrorVariable (ev)
- InformationAction (infa)
- InformationVariable (iv)
- OutVariable (ov)
- OutBuffer (ob)
- PipelineVariable (pv)
- Détaillé (vb)
- WarningAction (wa)
- WarningVariable (wv)
Les paramètres Action sont des valeurs de type ActionPreference . ActionPreference est une énumération avec les valeurs suivantes :
Nom | Valeur |
---|---|
Interrompre | 5 |
Ignorer | 4 |
Inquire | 3 |
Continuer | 2 |
Arrêter | 1 |
SilentlyContinue | 0 |
Vous pouvez utiliser le nom ou la valeur avec le paramètre.
En plus des paramètres courants, de nombreuses applets de commande offrent des paramètres d’atténuation des risques. Les applets de commande qui impliquent des risques pour le système ou pour les données utilisateur offrent généralement ces paramètres.
Les paramètres d’atténuation des risques sont les suivants :
- WhatIf (wi)
- Confirmer (cf)
DESCRIPTIONS COURANTES DES PARAMÈTRES
Débogage
Affiche les détails au niveau du programmeur sur l’opération effectuée par la commande. Ce paramètre fonctionne uniquement lorsque la commande génère un message de débogage. Par exemple, ce paramètre fonctionne lorsqu’une commande contient l’applet de Write-Debug
commande.
Type: SwitchParameter
Aliases: db
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
Par défaut, les messages de débogage ne sont pas affichés, car la valeur de la $DebugPreference
variable est SilentlyContinue.
En mode interactif, le paramètre Debug remplace la valeur de la $DebugPreference
variable pour la commande actuelle, en définissant la valeur de la valeur Debug $DebugPreference
sur Inquire.
En mode non interactif, le paramètre Debug remplace la valeur de la variable pour la $DebugPreference
commande actuelle, en définissant la valeur de $DebugPreference
continuer.
-Debug:$true
a le même effet que -Debug
. Permet -Debug:$false
de supprimer l’affichage des messages de débogage lorsqu’il $DebugPreference
n’est pas silencieuxContinue, qui est la valeur par défaut.
ErrorAction
Détermine la façon dont l’applet de commande répond à une erreur de non-fin de la commande.
Ce paramètre fonctionne uniquement lorsque la commande génère une erreur de non-fin, telle que celle de l’applet Write-Error
de commande.
Type: ActionPreference
Aliases: ea
Accepted values: Suspend, Ignore, Inquire, Continue, Stop, SilentlyContinue
Required: False
Position: Named
Default value: Depends on preference variable
Accept pipeline input: False
Accept wildcard characters: False
Le paramètre ErrorAction remplace la valeur de la $ErrorActionPreference
variable pour la commande active. Étant donné que la valeur par défaut de la $ErrorActionPreference
variable est Continue, les messages d’erreur s’affichent et l’exécution continue, sauf si vous utilisez le paramètre ErrorAction .
Le paramètre ErrorAction n’a aucun effet sur la fin des erreurs (telles que les données manquantes, les paramètres qui ne sont pas valides ou les autorisations insuffisantes) qui empêchent une commande de se terminer correctement.
-ErrorAction:Continue
affichez le message d’erreur et continuez à exécuter la commande. Continue
est la valeur par défaut.
-ErrorAction:Ignore
supprime le message d’erreur et continue d’exécuter la commande. Contrairement à SilentlyContinue, Ignore n’ajoute pas le message d’erreur à la $Error
variable automatique. La valeur Ignore est introduite dans PowerShell 3.0.
-ErrorAction:Inquire
affiche le message d’erreur et vous invite à confirmer avant de poursuivre l’exécution. Cette valeur est rarement utilisée.
-ErrorAction:SilentlyContinue
supprime le message d’erreur et continue d’exécuter la commande.
-ErrorAction:Stop
affiche le message d’erreur et arrête l’exécution de la commande.
-ErrorAction:Suspend
est disponible uniquement pour les flux de travail qui ne sont pas pris en charge dans PowerShell 6 et au-delà.
Notes
Le paramètre ErrorAction remplace, mais ne remplace pas la valeur de la $ErrorAction
variable de préférence lorsque le paramètre est utilisé dans une commande pour exécuter un script ou une fonction.
ErrorVariable
ErrorVariable stocke les messages d’erreur sur la commande dans la variable spécifiée et dans la $Error
variable automatique. Pour plus d’informations, consultez about_Automatic_Variables.
Type: String
Aliases: ev
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Par défaut, les nouveaux messages d’erreur remplacent les messages d’erreur qui sont déjà stockés dans la variable. Pour ajouter le message d’erreur au contenu de la variable, tapez un signe plus (+
) avant le nom de la variable.
Par exemple, la commande suivante crée la $a
variable, puis stocke toutes les erreurs dans celle-ci :
Get-Process -Id 6 -ErrorVariable a
La commande suivante ajoute tous les messages d’erreur à la $a
variable :
Get-Process -Id 2 -ErrorVariable +a
La commande suivante affiche le contenu de $a
:
$a
Vous pouvez utiliser ce paramètre pour créer une variable qui contient uniquement des messages d’erreur à partir de commandes spécifiques et n’affecte pas le comportement de la $Error
variable automatique. La $Error
variable automatique contient des messages d’erreur de toutes les commandes de la session. Vous pouvez utiliser la notation de tableau, par $a[0]
exemple ou $error[1,2]
pour faire référence à des erreurs spécifiques stockées dans les variables.
Notes
La variable d’erreur personnalisée contient toutes les erreurs générées par la commande, y compris les erreurs des appels aux fonctions ou scripts imbriqués.
InformationAction
Introduit dans PowerShell 5.0. Dans la commande ou le script dans lequel il est utilisé, le paramètre commun InformationAction remplace la valeur de la $InformationPreference
variable de préférence, qui par défaut est définie sur SilentlyContinue. Lorsque vous utilisez Write-Information
un script avec InformationAction, Write-Information
les valeurs sont affichées en fonction de la valeur du paramètre InformationAction . Pour plus d’informations sur $InformationPreference
, consultez about_Preference_Variables.
Type: ActionPreference
Aliases: ia
Accepted values: Suspend, Ignore, Inquire, Continue, Stop, SilentlyContinue
Required: False
Position: Named
Default value: Depends on preference variable
Accept pipeline input: False
Accept wildcard characters: False
-InformationAction:Stop
arrête une commande ou un script à une occurrence de la Write-Information
commande.
-InformationAction:Ignore
supprime le message d’information et continue d’exécuter la commande. Contrairement à SilentlyContinue, ignore complètement le message informationnel; il n’ajoute pas le message informationnel au flux d’informations.
-InformationAction:Inquire
affiche le message d’information que vous spécifiez dans une Write-Information
commande, puis vous demande si vous souhaitez continuer.
-InformationAction:Continue
affiche le message d’information et continue à s’exécuter.
-InformationAction:Suspend
n’est pas pris en charge sur PowerShell Core, car il n’est disponible que pour les flux de travail.
-InformationAction:SilentlyContinue
aucun effet, car le message d’information n’est pas affiché (par défaut) et le script se poursuit sans interruption.
Notes
Le paramètre InformationAction remplace, mais ne remplace pas la valeur de la $InformationAction
variable de préférence lorsque le paramètre est utilisé dans une commande pour exécuter un script ou une fonction.
InformationVariable
Introduit dans PowerShell 5.0. Dans la commande ou le script dans lequel il est utilisé, le paramètre commun InformationVariable stocke dans une variable une chaîne que vous spécifiez en ajoutant la Write-Information
commande. Write-Information
les valeurs sont affichées en fonction de la valeur du paramètre commun InformationAction ; Si vous n’ajoutez pas le paramètre commun InformationAction , Write-Information
les chaînes sont affichées en fonction de la valeur de la $InformationPreference
variable de préférence. Pour plus d’informations sur $InformationPreference
, consultez about_Preference_Variables.
Notes
La variable d’informations contient tous les messages d’informations générés par la commande, y compris les messages d’informations des appels aux fonctions ou scripts imbriqués.
Type: String
Aliases: iv
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
OutBuffer
Détermine le nombre d’objets à accumuler dans une mémoire tampon avant l’envoi d’objets via le pipeline. Si vous omettez ce paramètre, les objets sont envoyés à mesure qu’ils sont générés.
Type: Int32
Aliases: ob
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Ce paramètre de gestion des ressources est conçu pour les utilisateurs avancés. Lorsque vous utilisez ce paramètre, PowerShell envoie des données à l’applet de commande suivante par lots de OutBuffer + 1
.
L’exemple suivant montre comment alterner entre les ForEach-Object
blocs de traitement qui utilisent l’applet de Write-Host
commande. L’affichage alterne par lots de 2 ou OutBuffer + 1
.
1..4 | ForEach-Object {
Write-Host "$($_): First"; $_
} -OutBuffer 1 | ForEach-Object {
Write-Host "$($_): Second" }
1: First
2: First
1: Second
2: Second
3: First
4: First
3: Second
4: Second
OutVariable
Stocke les objets de sortie de la commande dans la variable spécifiée en plus d’envoyer la sortie le long du pipeline.
Type: String
Aliases: ov
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Pour ajouter la sortie à la variable, au lieu de remplacer toute sortie qui peut déjà y être stockée, tapez un signe plus (+
) avant le nom de la variable.
Par exemple, la commande suivante crée la $out
variable et stocke l’objet de processus dans celui-ci :
Get-Process PowerShell -OutVariable out
La commande suivante ajoute l’objet de processus à la $out
variable :
Get-Process iexplore -OutVariable +out
La commande suivante affiche le contenu de la $out
variable :
$out
Notes
La variable créée par le paramètre OutVariable est un [System.Collections.ArrayList]
.
PipelineVariable
PipelineVariable stocke la valeur de l’élément de pipeline actuel en tant que variable, pour toute commande nommée à mesure qu’elle transite par le pipeline.
Type: String
Aliases: pv
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Les valeurs valides sont des chaînes, identiques à celles des noms de variables.
Voici un exemple de fonctionnement de PipelineVariable . Dans cet exemple, le paramètre PipelineVariable est ajouté à une Foreach-Object
commande pour stocker les résultats de la commande dans les variables. Une plage de nombres, de 1 à 10, est redirigée vers la première Foreach-Object
commande, dont les résultats sont stockés dans une variable nommée Left.
Les résultats de la première Foreach-Object
commande sont redirigés vers une deuxième Foreach-Object
commande, qui filtre les objets retournés par la première Foreach-Object
commande. Les résultats de la deuxième commande sont stockés dans une variable nommée Right.
Dans la troisième Foreach-Object
commande, les résultats des deux Foreach-Object
premières commandes redirigées, représentées par les variables Gauche et Droite, sont traités à l’aide d’un opérateur de multiplication. La commande indique aux objets stockés dans les variables Gauche et Droite d’être multipliés, et spécifie que les résultats doivent être affichés en tant que « Membre de plage gauche * Membre de plage de droite = produit ».
1..10 | Foreach-Object -PipelineVariable Left -Process { $_ } |
Foreach-Object -PV Right -Process { 1..10 } |
Foreach-Object -Process { "$Left * $Right = " + ($Left*$Right) }
1 * 1 = 1
1 * 2 = 2
1 * 3 = 3
1 * 4 = 4
1 * 5 = 5
...
Commentaires
Affiche des informations détaillées sur l’opération effectuée par la commande. Ces informations ressemblent aux informations contenues dans une trace ou dans un journal des transactions. Ce paramètre fonctionne uniquement lorsque la commande génère un message détaillé. Par exemple, ce paramètre fonctionne lorsqu’une commande contient l’applet de Write-Verbose
commande.
Type: SwitchParameter
Aliases: vb
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
Le paramètre Verbose remplace la valeur de la $VerbosePreference
variable pour la commande active. Étant donné que la valeur par défaut de la $VerbosePreference
variable est SilentlyContinue, les messages détaillés ne sont pas affichés par défaut.
-Verbose:$true
a le même effet que -Verbose
-Verbose:$false
supprime l’affichage des messages détaillés. Utilisez ce paramètre lorsque la valeur de $VerbosePreference
n’est pas SilentlyContinue (valeur par défaut).
WarningAction
Détermine la façon dont l’applet de commande répond à un avertissement de la commande. Continue est la valeur par défaut. Ce paramètre fonctionne uniquement lorsque la commande génère un message d’avertissement. Par exemple, ce paramètre fonctionne lorsqu’une commande contient l’applet de Write-Warning
commande.
Type: ActionPreference
Aliases: wa
Accepted values: Suspend, Ignore, Inquire, Continue, Stop, SilentlyContinue
Required: False
Position: Named
Default value: Depends on preference variable
Accept pipeline input: False
Accept wildcard characters: False
Le paramètre WarningAction remplace la valeur de la $WarningPreference
variable pour la commande active. Étant donné que la valeur par défaut de la $WarningPreference
variable est Continue, les avertissements sont affichés et l’exécution continue, sauf si vous utilisez le paramètre WarningAction .
-WarningAction:Continue
affiche les messages d’avertissement et poursuit l’exécution de la commande. Continue
est la valeur par défaut.
-WarningAction:Inquire
affiche le message d’avertissement et vous invite à confirmer avant de poursuivre l’exécution. Cette valeur est rarement utilisée.
-WarningAction:SilentlyContinue
supprime le message d’avertissement et poursuit l’exécution de la commande.
-WarningAction:Stop
affiche le message d’avertissement et arrête l’exécution de la commande.
Notes
Le paramètre WarningAction remplace, mais ne remplace pas la valeur de la $WarningAction
variable de préférence lorsque le paramètre est utilisé dans une commande pour exécuter un script ou une fonction.
WarningVariable
Stocke les avertissements relatifs à la commande dans la variable spécifiée.
Type: String
Aliases: wv
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Tous les avertissements générés sont enregistrés dans la variable même si les avertissements ne sont pas affichés à l’utilisateur.
Pour ajouter les avertissements au contenu de la variable, au lieu de remplacer les avertissements qui peuvent déjà y être stockés, tapez un signe plus (+
) avant le nom de la variable.
Par exemple, la commande suivante crée la $a
variable, puis stocke tous les avertissements dans celui-ci :
Get-Process -Id 6 -WarningVariable a
La commande suivante ajoute tous les avertissements à la $a
variable :
Get-Process -Id 2 -WarningVariable +a
La commande suivante affiche le contenu de $a
:
$a
Vous pouvez utiliser ce paramètre pour créer une variable qui contient uniquement des avertissements provenant de commandes spécifiques. Vous pouvez utiliser la notation de tableau, telle que $a[0]
ou $warning[1,2]
pour faire référence à des avertissements spécifiques stockés dans la variable.
Notes
La variable d’avertissement contient tous les avertissements générés par la commande, y compris les avertissements des appels aux fonctions ou scripts imbriqués.
Descriptions des paramètres de gestion des risques
WhatIf
Affiche un message qui décrit l’effet de la commande, au lieu d’exécuter la commande.
Type: SwitchParameter
Aliases: wi
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
Le paramètre WhatIf remplace la valeur de la $WhatIfPreference
variable pour la commande actuelle. Étant donné que la valeur par défaut de la $WhatIfPreference
variable est 0 (désactivée), le comportement WhatIf n’est pas effectué sans le paramètre WhatIf . Pour plus d’informations, consultez about_Preference_Variables
-WhatIf:$true
a le même effet que -WhatIf
.
-WhatIf:$false
supprime le comportement WhatIf automatique qui se produit lorsque la valeur de la $WhatIfPreference
variable est 1.
Par exemple, la commande suivante utilise le -WhatIf
paramètre dans une Remove-Item
commande :
Remove-Item Date.csv -WhatIf
Au lieu de supprimer l’élément, PowerShell répertorie les opérations qu’il effectuerait et les éléments qui seraient affectés. Cette commande génère la sortie suivante :
What if: Performing operation "Remove File" on
Target "C:\ps-test\date.csv".
Confirmer
Demande une confirmation avant d'exécuter la commande.
Type: SwitchParameter
Aliases: cf
Required: False
Position: Named
Default value: Depends on preference variable
Accept pipeline input: False
Accept wildcard characters: False
Le paramètre Confirm remplace la valeur de la $ConfirmPreference
variable pour la commande active. La valeur par défaut est true. Pour plus d’informations, consultez about_Preference_Variables
-Confirm:$true
a le même effet que -Confirm
.
-Confirm:$false
supprime la confirmation automatique, qui se produit lorsque la valeur est $ConfirmPreference
inférieure ou égale au risque estimé de l’applet de commande.
Par exemple, la commande suivante utilise le paramètre Confirm avec une Remove-Item
commande. Avant de supprimer l’élément, PowerShell répertorie les opérations qu’il effectuerait et les éléments qui seraient affectés et demande l’approbation.
PS C:\ps-test> Remove-Item tmp*.txt -Confirm
Confirm
Are you sure you want to perform this action?
Performing operation "Remove File" on Target " C:\ps-test\tmp1.txt
[Y] Yes [A] Yes to All [N] No [L] No to All [S] Suspend
[?] Help (default is "Y"):
Les options Confirmer la réponse sont les suivantes :
response | Résultats |
---|---|
Oui (Y) | Effectuez l’action. |
Oui à tous (A) | Effectuer toutes les actions et supprimer les requêtes confirm suivantes |
pour cette commande. | |
Non (N) : | N’effectuez pas l’action. |
Non à tous (L) : | N’effectuez aucune action et supprimez la confirmation suivante |
requêtes pour cette commande. | |
Suspendre (S) : | Suspendre la commande et créer une session temporaire. |
Aide (?) | Affichez l’aide pour ces options. |
L’option Suspend place la commande en attente et crée une session imbriquée temporaire dans laquelle vous pouvez travailler jusqu’à ce que vous soyez prêt à choisir une option Confirmer . L’invite de commandes de la session imbriquée comporte deux carets supplémentaires (>>) pour indiquer qu’il s’agit d’une opération enfant de la commande parente d’origine. Vous pouvez exécuter des commandes et des scripts dans la session imbriquée. Pour terminer la session imbriquée et revenir aux options De confirmation de la commande d’origine, tapez « exit ».
Dans l’exemple suivant, l’option Suspend (S) est utilisée pour arrêter temporairement une commande pendant que l’utilisateur vérifie l’aide d’un paramètre de commande. Après avoir obtenu les informations nécessaires, l’utilisateur entre « exit » pour mettre fin à l’invite imbriquée, puis sélectionne la réponse Oui (y) à la requête Confirmer.
PS C:\ps-test> New-Item -ItemType File -Name Test.txt -Confirm
Confirm
Are you sure you want to perform this action?
Performing operation "Create File" on Target "Destination:
C:\ps-test\test.txt".
[Y] Yes [A] Yes to All [N] No [L] No to All [S] Suspend [?] Help (default
is "Y"): s
PS C:\ps-test> Get-Help New-Item -Parameter ItemType
-ItemType <string>
Specifies the provider-specified type of the new item.
Required? false
Position? named
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
PS C:\ps-test> exit
Confirm
Are you sure you want to perform this action?
Performing operation "Create File" on Target "Destination: C:\ps-test\test
.txt".
[Y] Yes [A] Yes to All [N] No [L] No to All [S] Suspend [?] Help (defau
lt is "Y"): y
Directory: C:\ps-test
Mode LastWriteTime Length Name
---- ------------- ------ ----
-a--- 8/27/2010 2:41 PM 0 test.txt
MOTS-CLÉS
about_Common_Parameters