about_CommonParameters

  • Article

Description courte

Décrit les paramètres qui peuvent être utilisés avec n’importe quelle applet de commande.

Description longue

Les paramètres communs 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 communs 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 Verbose paramètre commun n’a aucun effet.

Les paramètres communs sont également disponibles sur les fonctions avancées qui utilisent l’attribut CmdletBinding ou l’attribut Parameter .

Plusieurs paramètres courants remplacent les paramètres système par défaut ou 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 communs. 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)
  • Verbose (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
Break 6
Suspend 5
Ignore 4
Inquire 3
Continue 2
Stop 1
SilentlyContinue 0

Vous pouvez utiliser le nom ou la valeur avec le paramètre.

Outre les 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 les données utilisateur offrent généralement ces paramètres.

Les paramètres d’atténuation des risques sont les suivants :

  • WhatIf (wi)
  • Confirm (cf)

Descriptions courantes des paramètres

-Debug

Affiche les détails au niveau du programmeur sur l’opération effectuée par la commande. Ce paramètre ne fonctionne que lorsque la commande génère un message de débogage. Par exemple, ce paramètre fonctionne lorsqu’une commande contient l’applet Write-Debug de 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.

Le Debug paramètre remplace la valeur de la $DebugPreference variable pour la commande actuelle, en définissant la valeur sur $DebugPreferenceContinuer.

-Debug:$true a le même effet que -Debug. Permet -Debug:$false de supprimer l’affichage des messages de débogage quand $DebugPreference ce n’est pas SilentlyContinue, 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 ne fonctionne que lorsque la commande génère une erreur sans fin, telle que celle de l’applet Write-Error de commande.

Type: ActionPreference
Aliases: ea
Accepted values: Break, 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 Continuer, les messages d’erreur s’affichent et l’exécution se poursuit, 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 s’exécuter correctement.

  • Break Entre le débogueur lorsqu’une erreur se produit ou qu’une exception est déclenchée.
  • Continue affiche le message d’erreur et continue d’exécuter la commande. Continue est la valeur par défaut.
  • 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.
  • Inquire affiche le message d’erreur et vous invite à confirmer avant la poursuite de l’exécution. Cette valeur est rarement utilisée.
  • SilentlyContinue supprime le message d’erreur et continue d’exécuter la commande.
  • Stop affiche le message d’erreur et arrête l’exécution de la commande.
  • Suspend est disponible uniquement pour les flux de travail qui ne sont pas pris en charge dans PowerShell 6 et au-delà.

Remarque

Le paramètre ErrorAction remplace, mais ne remplace pas la valeur de la $ErrorActionPreference variable lorsque le paramètre est utilisé dans une commande pour exécuter un script ou une fonction.

-ErrorVariable

Les enregistrements d’erreur sont automatiquement enregistrés dans la $Error variable automatique. Pour plus d’informations, consultez about_Automatic_Variables.

Lorsque vous utilisez le paramètre ErrorVariable sur une commande, PowerShell stocke également les enregistrements d’erreur émis par la commande dans la variable spécifiée par le paramètre.

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, placez 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, telle que $a[0] ou $error[1,2] pour faire référence à des erreurs spécifiques stockées dans les variables.

Remarque

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 est définie par défaut 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: infa
Accepted values: Break, Suspend, Ignore, Inquire, Continue, Stop, SilentlyContinue
Required: False
Position: Named
Default value: Depends on preference variable
Accept pipeline input: False
Accept wildcard characters: False
  • Break Entre le débogueur à une occurrence de la Write-Information commande.
  • Stop arrête une commande ou un script à une occurrence de la Write-Information commande.
  • Ignore supprime le message d’information et continue d’exécuter la commande. Contrairement à SilentlyContinue, Ignorez complètement le message d’information ; il n’ajoute pas le message d’information au flux d’informations.
  • Inquire affiche le message d’information que vous spécifiez dans une Write-Information commande, puis vous demande si vous souhaitez continuer.
  • Continue affiche le message d’information et continue à s’exécuter.
  • Suspend n’est pas pris en charge sur PowerShell 6 et versions ultérieures, car il n’est disponible que pour les flux de travail.
  • SilentlyContinue aucun effet, car le message d’information n’est pas affiché (valeur par défaut) et le script continue sans interruption.

Remarque

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. Lorsque vous utilisez le paramètre commun InformationVariable , les enregistrements d’informations sont stockés dans la variable spécifiée par le paramètre. Et l’applet de commande PowerShell peut écrire des enregistrements d’informations dans le flux d’informations. Vous pouvez également utiliser l’applet Write-Information de commande pour écrire des enregistrements d’informations.

Les enregistrements d’informations sont affichés sous forme de messages dans la console par défaut. Vous pouvez contrôler l’affichage de l’enregistrement d’informations à l’aide du paramètre commun InformationAction . Vous pouvez également modifier le comportement à l’aide de la $InformationPreference variable de préférence. Pour plus d’informations sur $InformationPreference, consultez about_Preference_Variables.

Remarque

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

Par défaut, de nouveaux enregistrements d’informations remplacent les valeurs qui sont déjà stockées dans la variable. Pour ajouter le message d’erreur au contenu de la variable, placez un signe plus (+) avant le nom de la variable.

-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 dans les lots de OutBuffer + 1.

L’exemple suivant montre comment les autres options s’affichent 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 une sortie qui peut déjà ê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

Remarque

La variable créée par le paramètre OutVariable est un [System.Collections.ArrayList].

-PipelineVariable

PipelineVariable permet d’accéder à la valeur la plus récente passée dans le segment de pipeline suivant par la commande qui utilise ce paramètre. Toute commande du pipeline peut accéder à la valeur à l’aide du nom PipelineVariable. La valeur est affectée à la variable lorsqu’elle est passée au segment de pipeline suivant. Cela facilite l’utilisation de PipelineVariable qu’une variable temporaire spécifique, qui peut avoir besoin d’être affectée à plusieurs emplacements.

Contrairement $_ ou $PSItem, l’utilisation d’un PipelineVariable permet à n’importe quelle commande de pipeline d’accéder aux valeurs de pipeline passées (et enregistrées) par des commandes autres que la commande immédiatement précédente. Les commandes de pipeline peuvent accéder à la dernière valeur redirigée lors du traitement de l’élément suivant passant par le pipeline. Cela permet à une commande de renvoyer sa sortie à une commande précédente (ou elle-même).

Remarque

Les fonctions avancées peuvent avoir jusqu’à trois blocs de script : begin, processet end. Lorsque vous utilisez le paramètre PipelineVariable avec des fonctions avancées, seules les valeurs du premier bloc de script défini sont affectées à la variable lors de l’exécution de la fonction. Pour plus d’informations, consultez Fonctions avancées. PowerShell 7.2 corrige ce comportement.

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.

Attention

PipelineVariable est limité au pipeline dans lequel il est appelé. Les variables en dehors du pipeline, qui utilisent le même nom, sont effacées avant l’exécution du pipeline. PipelineVariable est hors de portée lorsque le pipeline se termine. Si plusieurs commandes au sein du pipeline spécifient le même PipelineVariable , il n’existe qu’une seule variable partagée. Cette variable est mise à jour avec la sortie redirigée la plus récente de la commande qui spécifie la variable.

Certaines commandes bloquantes collectent tous les éléments de pipeline avant de produire une sortie, par exemple Sort-Object ou Select-Object -Last. Tout PipelineVariable affecté dans une commande avant qu’une telle commande bloquante contienne toujours l’élément redirigé final de la commande précédente lorsqu’elle est utilisée dans une commande après la commande bloquante.

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, 1 à 5, est redirigée vers la première Foreach-Object commande, dont les résultats sont stockés dans une variable nommée $temp.

Les résultats de la première Foreach-Object commande sont redirigés vers une deuxième Foreach-Object commande, qui affiche les valeurs actuelles de $temp et $_.

# Create a variable named $temp
$temp=8
Get-Variable temp
# Note that the variable just created isn't available on the
# pipeline when -PipelineVariable creates the same variable name
1..5 | ForEach-Object -PipelineVariable temp -Begin {
    Write-Host "Step1[BEGIN]:`$temp=$temp"
} -Process {
  Write-Host "Step1[PROCESS]:`$temp=$temp - `$_=$_"
  Write-Output $_
} | ForEach-Object {
  Write-Host "`tStep2[PROCESS]:`$temp=$temp - `$_=$_"
}
# The $temp variable is deleted when the pipeline finishes
Get-Variable temp

Name                           Value
----                           -----
temp                           8

Step1[BEGIN]:$temp=
Step1[PROCESS]:$temp= - $_=1
        Step2[PROCESS]:$temp=1 - $_=1
Step1[PROCESS]:$temp=1 - $_=2
        Step2[PROCESS]:$temp=2 - $_=2
Step1[PROCESS]:$temp=2 - $_=3
        Step2[PROCESS]:$temp=3 - $_=3
Step1[PROCESS]:$temp=3 - $_=4
        Step2[PROCESS]:$temp=4 - $_=4
Step1[PROCESS]:$temp=4 - $_=5
        Step2[PROCESS]:$temp=5 - $_=5

Get-Variable: Cannot find a variable with the name 'temp'.

-Verbose

Affiche des informations détaillées sur l’opération effectuée par la commande. Ces informations ressemblent aux informations d’une trace ou dans un journal des transactions. Ce paramètre ne fonctionne que lorsque la commande génère un message détaillé. Par exemple, ce paramètre fonctionne lorsqu’une commande contient l’applet Write-Verbose de commande.

Type: SwitchParameter
Aliases: vb
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

Le Verbose paramètre remplace la valeur de la $VerbosePreference variable pour la commande actuelle. É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 ne fonctionne que lorsque la commande génère un message d’avertissement. Par exemple, ce paramètre fonctionne lorsqu’une commande contient l’applet Write-Warning de commande.

Type: ActionPreference
Aliases: wa
Accepted values: Break, 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 Continuer, les avertissements s’affichent et l’exécution se poursuit, sauf si vous utilisez le paramètre WarningAction .

  • Break entre le débogueur lorsqu’un avertissement se produit.
  • Continue affiche les messages d’avertissement et poursuit l’exécution de la commande. Continue est la valeur par défaut.
  • Inquire affiche le message d’avertissement et vous invite à confirmer avant de poursuivre l’exécution. Cette valeur est rarement utilisée.
  • SilentlyContinue supprime le message d’avertissement et continue d’exécuter la commande.
  • Stop affiche le message d’avertissement et arrête l’exécution de la commande.

Remarque

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 enregistrements d’avertissement sur 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à ê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 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.

Remarque

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é), le comportement WhatIf n’est pas effectué sans le paramètre WhatIf . Pour plus d’informations, consultez about_Preference_Variables.

  • $true a le même effet que -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".

-Confirm

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 Confirm paramètre remplace la valeur de la $ConfirmPreference variable pour la commande actuelle. La valeur par défaut est true. Pour plus d’informations, consultez about_Preference_Variables.

  • $true a le même effet que -Confirm.
  • $false supprime la confirmation automatique, qui se produit lorsque la valeur de l’applet de $ConfirmPreference commande est inférieure ou égale au risque estimé de l’applet de commande.

Par exemple, la commande suivante utilise le Confirm paramètre 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 demander 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 Confirm options de réponse sont les suivantes :

Response Result
Yes (Y) Effectuez l'action.
Yes to All (A) Effectuer toutes les actions et supprimer les opérations suivantes Confirm
requêtes pour cette commande.
No (N) : N’effectuez pas l’action.
No to All (L) : N’effectuez aucune action et supprimez les actions suivantes
Confirm requêtes pour cette commande.
Suspend (S) : Suspendez la commande et créez une session temporaire.
Help (?) 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 Confirm option. L’invite de commandes pour 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 mettre fin à la session imbriquée et revenir aux Confirm options 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 case activée l’aide d’un paramètre de commande. Après avoir obtenu les informations nécessaires, l’utilisateur tape « exit » pour mettre fin à l’invite imbriquée, puis sélectionne la réponse Oui (y) à la Confirm requête.

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

Voir aussi