Start-Transcript

  • Référence
Module:
Microsoft.PowerShell.Host

Crée un enregistrement de toute ou partie d’une session PowerShell dans un fichier texte.

Syntax

Start-Transcript
     [[-Path] <String>]
     [-Append]
     [-Force]
     [-NoClobber]
     [-IncludeInvocationHeader]
     [-UseMinimalHeader]
     [-WhatIf]
     [-Confirm] 
     [<CommonParameters>]
Start-Transcript
     [[-LiteralPath] <String>]
     [-Append]
     [-Force]
     [-NoClobber]
     [-IncludeInvocationHeader]
     [-UseMinimalHeader]
     [-WhatIf]
     [-Confirm] 
     [<CommonParameters>]
Start-Transcript
     [[-OutputDirectory] <String>]
     [-Append]
     [-Force]
     [-NoClobber]
     [-IncludeInvocationHeader]
     [-UseMinimalHeader]
     [-WhatIf]
     [-Confirm] 
     [<CommonParameters>]

Description

L’applet Start-Transcript de commande crée un enregistrement de toute ou partie d’une session PowerShell dans un fichier texte. La transcription inclut toutes les commandes que l'utilisateur saisit et toutes les sorties qui s'affichent sur la console.

Par défaut, Start-Transcript stocke la transcription à l’emplacement suivant à l’aide du nom par défaut :

  • Dans la fenêtre : $HOME\Documents
  • Sur Linux ou macOS : $HOME

Le nom de fichier par défaut est PowerShell_transcript.<computername>.<random>.<timestamp>.txt.

À compter de Windows PowerShell 5.0, Start-Transcript inclut le nom d’hôte dans le nom de fichier généré de toutes les transcriptions. Le nom de fichier inclut également des caractères aléatoires dans des noms pour empêcher les remplacements potentiels ou la duplication lorsque deux transcriptions ou plus sont démarrées simultanément. L’inclusion du nom de l’ordinateur est utile si vous stockez vos transcriptions dans un emplacement centralisé. La chaîne de caractères aléatoire empêche l’estimation du nom de fichier d’obtenir un accès non autorisé au fichier.

Si le fichier cible n’a pas de marque d’ordre d’octet (BOM), Start-Transcript la valeur par défaut est Utf8NoBom d’encodage dans le fichier cible.

Exemples

Exemple 1 : Démarrer un fichier de transcription avec les paramètres par défaut

Start-Transcript

Cette commande démarre une transcription à l'emplacement du fichier par défaut.

Exemple 2 : Démarrer un fichier de transcription à un emplacement spécifique

Start-Transcript -Path "C:\transcripts\transcript0.txt" -NoClobber

Cette commande démarre une transcription dans le Transcript0.txt fichier dans C:\transcripts. Étant donné que le paramètre NoClobber est utilisé, la commande empêche tout fichier existant d’être remplacé. Si le Transcript0.txt fichier existe déjà, la commande échoue.

Exemple 3 : Démarrer un fichier de transcription avec un nom unique et le stocker sur un partage de fichiers

L’exemple suivant crée un fichier de transcription avec un nom suffisamment unique pour être stocké dans un emplacement partagé. Le nom de fichier est construit à partir du nom de l’utilisateur, du nom d’hôte de l’ordinateur exécutant PowerShell, de la version de PowerShell et de la date et de l’heure. La transcription est stockée dans le partage de \\Server01\Transcripts fichiers.

$sharepath  = '\\Server01\Transcripts'
$username   = $env:USERNAME
$hostname   = hostname
$version    = $PSVersionTable.PSVersion.ToString()
$datetime   = Get-Date -f 'yyyyMMddHHmmss'
$filename   = "Transcript-${username}-${hostname}-${version}-${datetime}.txt"
$Transcript = Join-Path -Path $sharepath -ChildPath $filename
Start-Transcript

Le chemin complet du fichier de transcription est stocké dans la $Transcript variable de préférence. Pour plus d’informations sur la $Transcript variable de préférence, consultez about_Preference_Variables.

Paramètres

-Append

Indique que cette applet de commande ajoute la nouvelle transcription à la fin d’un fichier existant. Utilisez le paramètre Path pour spécifier le fichier.

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

-Confirm

Vous demande une confirmation avant d’exécuter l’applet de commande.

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

-Force

Permet à l'applet de commande d'ajouter la transcription à un fichier en lecture seule existant. Lorsqu'elle est utilisée sur un fichier en lecture seule, l'applet de commande modifie l'autorisation du fichier en lecture-écriture. L’applet de commande ne peut pas remplacer les restrictions de sécurité lorsque ce paramètre est utilisé.

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

-IncludeInvocationHeader

Indique que cette applet de commande enregistre l’horodatage lorsque les commandes sont exécutées.

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

-LiteralPath

Spécifie un emplacement dans le fichier de transcription. Contrairement au paramètre Path , la valeur du paramètre LiteralPath est utilisée exactement comme il est typé. Aucun caractère n’est interprété en tant que caractère générique. Si le chemin d’accès inclut des caractères d’échappement, mettez-le entre des guillemets simples. Les guillemets simples informent PowerShell de ne pas interpréter de caractères comme séquences d’échappement.

Type:String
Aliases:PSPath, LP
Position:0
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-NoClobber

Indique que cette applet de commande ne remplace pas un fichier existant. Par défaut, si un fichier de transcription existe dans le chemin d’accès spécifié, Start-Transcript remplace le fichier sans avertissement.

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

-OutputDirectory

Spécifie un chemin d’accès et un dossier spécifiques dans lesquels enregistrer une transcription. PowerShell attribue automatiquement le nom de la transcription.

Type:String
Position:0
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Path

Spécifie un emplacement dans le fichier de transcription. Entrez un chemin d’accès à un .txt fichier. Les carte sauvages ne sont pas autorisées. Si l’un des répertoires du chemin d’accès n’existe pas, la commande échoue.

Si vous ne spécifiez pas de chemin d’accès, Start-Transcript utilise le chemin d’accès dans la valeur de la $Transcript variable globale. Si vous n’avez pas créé cette variable, Start-Transcript stocke les transcriptions à l’emplacement et au nom de fichier par défaut.

Type:String
Position:0
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-UseMinimalHeader

Ajoutez un en-tête court à la transcription, au lieu de l’en-tête détaillé inclus par défaut. Ce paramètre a été ajouté dans PowerShell 6.2.

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

-WhatIf

Montre ce qui se passe en cas d’exécution de l’applet de commande. L’applet de commande n’est pas exécutée.

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

Entrées

None

Vous ne pouvez pas diriger les objets vers cette applet de commande.

Sorties

String

Cette applet de commande retourne une chaîne contenant un message de confirmation et le chemin d’accès au fichier de sortie.

Notes

Pour arrêter une transcription, utilisez l’applet de Stop-Transcript commande.

Pour enregistrer une session entière, ajoutez la Start-Transcript commande à votre profil. Pour plus d’informations, consultez about_Profiles.