about_Redirection

  • Article

Description courte

Explique comment rediriger la sortie de PowerShell vers des fichiers texte.

Description longue

Par défaut, PowerShell envoie la sortie à l’hôte PowerShell. Il s’agit généralement de l’application console. Toutefois, vous pouvez rediriger la sortie vers un fichier texte et rediriger la sortie d’erreur vers le flux de sortie standard.

Vous pouvez utiliser les méthodes suivantes pour rediriger la sortie :

  • Utilisez l’applet de commande, qui envoie la Out-File sortie de commande à un fichier texte. En règle générale, vous utilisez l’applet Out-File de commande lorsque vous devez utiliser ses paramètres, tels que les paramètres , ou WidthEncodingForceNoClobber les paramètres.

  • Utilisez l’applet de commande, qui envoie la Tee-Object sortie de commande à un fichier texte, puis l’envoie au pipeline.

  • Utilisez les opérateurs de redirection PowerShell. L’utilisation de l’opérateur de redirection avec une cible de fichier est fonctionnellement équivalente au piping vers Out-File lequel aucun paramètre supplémentaire n’est utilisé.

Pour plus d’informations sur les flux, consultez about_Output_Streams.

Flux de sortie pouvant être redirigés

PowerShell prend en charge la redirection des flux de sortie suivants.

Flux # Description Introduite dans Écrire une applet de commande
1 Succès Flux PowerShell 2.0 Write-Output
2 Erreur Flux PowerShell 2.0 Write-Error
3 Avertissement Flux PowerShell 3.0 Write-Warning
4 Verbose Flux PowerShell 3.0 Write-Verbose
5 Debug Flux PowerShell 3.0 Write-Debug
6 Informations Flux PowerShell 5.0 Write-Information
* Tous les flux PowerShell 3.0

Il existe également un flux de progression dans PowerShell, mais il ne prend pas en charge la redirection.

Important

Les flux de réussite et d’erreur sont similaires aux flux stdout et stderr d’autres interpréteurs de commandes. Toutefois, stdin n’est pas connecté au pipeline PowerShell pour l’entrée.

Opérateurs de redirection PowerShell

Les opérateurs de redirection PowerShell sont les suivants, où n représente le numéro de flux. Le flux de réussite ( 1 ) est la valeur par défaut si aucun flux n’est spécifié.

Opérateur Description Syntaxe
> Envoyer le flux spécifié à un fichier. n>
>> Ajoutez le flux spécifié à un fichier. n>>
>&1 Redirige le flux spécifié vers le flux de réussite . n>&1

Notes

Contrairement à certains interpréteurs de commandes Unix, vous ne pouvez rediriger que d’autres flux vers le flux de réussite .

Exemples

Exemple 1 : Rediriger les erreurs et la sortie vers un fichier

Cet exemple s’exécute dir sur un élément qui réussira et un élément qui échouera.

dir 'C:\', 'fakepath' 2>&1 > .\dir.log

Il utilise 2>&1 pour rediriger le flux d’erreurs vers le flux de réussite et > pour envoyer le flux de réussite résultant à un fichier appelé dir.log

Exemple 2 : Envoyer toutes les données de flux de réussite à un fichier

Cet exemple envoie toutes les données de flux de réussite à un fichier appelé script.log.

.\script.ps1 > script.log

Exemple 3 : Envoyer des flux de réussite, d’avertissement et d’erreur à un fichier

Cet exemple montre comment combiner des opérateurs de redirection pour obtenir un résultat souhaité.

&{
   Write-Warning "hello"
   Write-Error "hello"
   Write-Output "hi"
} 3>&1 2>&1 > C:\Temp\redirection.log
  • 3>&1 redirige le flux d’avertissement vers le flux de réussite .
  • 2>&1 redirige le flux d’erreurs vers le flux de réussite (qui inclut également toutes les données de flux d’avertissement )
  • > redirige le flux de réussite (qui contient désormais des flux d’avertissement et d’erreur ) vers un fichier appelé C:\temp\redirection.log)

Exemple 4 : Rediriger tous les flux vers un fichier

Cet exemple envoie toutes les sorties de flux d’un script appelé script.ps1 à un fichier appelé script.log

.\script.ps1 *> script.log

Exemple 5 : Supprimer toutes les données de flux d’informations et de Write-Host

Cet exemple supprime toutes les données de flux d’informations. Pour en savoir plus sur les applets de commande de flux d’informations , consultez Write-Host et Write-Information

&{
   Write-Host "Hello"
   Write-Information "Hello" -InformationAction Continue
} 6> $null

Exemple 6 : Afficher l’effet des préférences d’action

Les variables et paramètres de préférence d’action peuvent modifier ce qui est écrit dans un flux particulier. Le script de cet exemple montre comment la valeur affecte $ErrorActionPreference ce qui est écrit dans le flux d’erreurs .

$ErrorActionPreference = 'Continue'
$ErrorActionPreference > log.txt
get-item /not-here 2>&1 >> log.txt

$ErrorActionPreference = 'SilentlyContinue'
$ErrorActionPreference >> log.txt
get-item /not-here 2>&1 >> log.txt

$ErrorActionPreference = 'Stop'
$ErrorActionPreference >> log.txt
Try {
    get-item /not-here 2>&1 >> log.txt
}
catch {
    "`tError caught!" >> log.txt
}
$ErrorActionPreference = 'Ignore'
$ErrorActionPreference >> log.txt
get-item /not-here 2>&1 >> log.txt

$ErrorActionPreference = 'Inquire'
$ErrorActionPreference >> log.txt
get-item /not-here 2>&1 >> log.txt

$ErrorActionPreference = 'Continue'

Lorsque nous exécutons ce script, nous recevons une invite quand $ErrorActionPreference il est défini Inquiresur .

PS C:\temp> .\test.ps1

Confirm
Cannot find path 'C:\not-here' because it does not exist.
[Y] Yes  [A] Yes to All  [H] Halt Command  [S] Suspend  [?] Help (default is "Y"): H
Get-Item: C:\temp\test.ps1:23
Line |
  23 |  get-item /not-here 2>&1 >> log.txt
     |  ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
     | The running command stopped because the user selected the Stop option.

Lorsque nous examinons le fichier journal, nous voyons ce qui suit :

PS C:\temp> Get-Content .\log.txt
Continue

Get-Item: C:\temp\test.ps1:3
Line |
   3 |  get-item /not-here 2>&1 >> log.txt
     |  ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
     | Cannot find path 'C:\not-here' because it does not exist.

SilentlyContinue
Stop
    Error caught!
Ignore
Inquire

Notes

Les opérateurs de redirection qui n’ajoutent pas de données (> et n>) remplacent le contenu actuel du fichier spécifié sans avertissement.

Toutefois, si le fichier est un fichier en lecture seule, masqué ou système, la redirection échoue. Les opérateurs de redirection Append (>> et n>>) n’écrivent pas dans un fichier en lecture seule, mais ils ajoutent du contenu à un fichier système ou masqué.

Pour forcer la redirection du contenu vers un fichier système, masqué ou en lecture seule, utilisez l’applet Out-File de commande avec son Force paramètre.

Lorsque vous écrivez dans des fichiers, les opérateurs de redirection utilisent UTF8NoBOM l’encodage. Si le fichier a un encodage différent, la sortie peut ne pas être mise en forme correctement. Pour écrire dans des fichiers avec un encodage différent, utilisez l’applet Out-File de commande avec son Encoding paramètre.

Largeur de la sortie lors de l’écriture dans un fichier

Lorsque vous écrivez dans un fichier à l’aide de l’un ou l’autre Out-File des opérateurs de redirection, PowerShell met en forme la sortie de table vers le fichier en fonction de la largeur de la console dans laquelle elle s’exécute. Par exemple, lors de la journalisation de la sortie de table dans un fichier à l’aide d’une commande comme Get-ChildItem Env:\Path > path.log sur un système où la largeur de la console est définie sur 80 colonnes, la sortie du fichier est tronquée à 80 caractères :

Name                         Value
----                         -----
Path                         C:\Program Files\PowerShell\7-preview;C:\WINDOWS…

Compte tenu du fait que la largeur de la console peut être définie arbitrairement sur les systèmes sur lesquels votre script est exécuté, vous préférerez peut-être que la sortie de table de format PowerShell s’appuie sur une largeur que vous spécifiez à la place.

L’applet Out-File de commande fournit un paramètre Width qui vous permet de définir la largeur souhaitée pour la sortie de la table. Au lieu d’ajouter -Width 2000 partout où vous appelez Out-File, vous pouvez utiliser la $PSDefaultParameterValues variable pour définir cette valeur pour toutes les utilisations de l’applet Out-File de commande dans un script. Et étant donné que les opérateurs de redirection (> et >>) sont effectivement des alias pour Out-File, la définition du Out-File:Width paramètre pour l’ensemble du script affecte également la largeur de mise en forme pour les opérateurs de redirection. Placez la commande suivante en haut de votre script à définir Out-File:Width pour l’ensemble du script :

$PSDefaultParameterValues['out-file:width'] = 2000

L’augmentation de la largeur de la sortie augmente la consommation de mémoire lors de la journalisation de la sortie mise en forme de la table. Si vous journalisationz un grand nombre de données tabulaires dans un fichier et que vous savez que vous pouvez obtenir avec une largeur plus petite, utilisez la plus petite largeur.

Dans certains cas, comme la sortie, afin d’utiliser Get-Service la largeur supplémentaire, vous devez diriger la sortie Format-Table -AutoSize avant de sortir dans le fichier.

$PSDefaultParameterValues['out-file:width'] = 2000
Get-Service | Format-Table -AutoSize > services.log

Pour plus d’informations sur $PSDefaultParameterValues, consultez about_Preference_Variables.

Confusion potentielle avec les opérateurs de comparaison

L’opérateur > ne doit pas être confondu avec l’opérateur de comparaison supérieur à (souvent indiqué comme > dans d’autres langages de programmation).

Selon les objets comparés, la sortie utilisée > peut sembler correcte (car 36 n’est pas supérieure à 42).

PS> if (36 > 42) { "true" } else { "false" }
false

Toutefois, une vérification du système de fichiers local peut voir qu’un fichier appelé 42 a été écrit, avec le contenu 36.

PS> dir

Mode                LastWriteTime         Length Name
----                -------------         ------ ----
------          1/02/20  10:10 am              3 42

PS> cat 42
36

La tentative d’utilisation de la comparaison < inverse (inférieure à), génère une erreur système :

PS> if (36 < 42) { "true" } else { "false" }
ParserError:
Line |
   1 |  if (36 < 42) { "true" } else { "false" }
     |         ~
     | The '<' operator is reserved for future use.

Si la comparaison numérique est l’opération requise et -lt-gt doit être utilisée. Pour plus d’informations, consultez l’opérateur -gt dans about_Comparison_Operators.

Voir aussi