powershellscripts.com

Tutorials  PowerShell Cmdlet Help for Start-Transcript



NAME
Start-Transcript

SYNOPSIS
Creates a record of all or part of a Windows PowerShell session in a text file.

SYNTAX
Start-Transcript [[-Path] ] [-Append] [-Force] [-NoClobber] [-Confirm] [-WhatIf] []


DESCRIPTION
The Start-Transcript cmdlet creates a record of all or part of a Windows PowerShell session in a text file. The tra
nscript includes all command that the user types and all output that appears on the console.


PARAMETERS
-Append []
Adds the new transcript to the end of an existing file. Use the Path parameter to specify the file.

Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false

-Force []
Allows the cmdlet to append the transcript to an existing read-only file. When used on a read-only file, the cm
dlet changes the file permission to read-write. Even using the Force parameter, the cmdlet cannot override secu
rity restrictions.

Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false

-NoClobber []
Will not overwrite (replace the contents) of an existing file. By default, if a transcript file exists in the s
pecified path, Start-Transcript overwrites the file without warning.

Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false

-Path
Specifies a location for the transcript file. Enter a path to a .txt file. Wildcards are not permitted.

If you do not specify a path, Start-Transcript uses the path in the value of the $Transcript global variable. I
f you have not created this variable, Start-Transcript stores the transcripts in the $Home\My Documents directo
ry as \PowerShell_transcript..txt files.

If any of the directories in the path do not exist, the command fails.

Required? false
Position? 1
Default value
Accept pipeline input? false
Accept wildcard characters? false

-Confirm []
Prompts you for confirmation before executing the command.

Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false

-WhatIf []
Describes what would happen if you executed the command without actually executing the command.

Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false


This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer and OutVariable. For more information, type,
"get-help about_commonparameters".

INPUTS
None
You cannot pipe objects to this cmdlet.


OUTPUTS
System.String
Start-Transcript returns a string that contains a confirmation message and the path to the output file.


NOTES


To stop a transcript, use the Stop-Transcript cmdlet.

To record an entire session, add the Start-Transcript command to your profile. For more information, see about_
Profiles.


-------------------------- EXAMPLE 1 --------------------------

C:\PS>start-transcript


Description
-----------
This command starts a transcript in the default file location.





-------------------------- EXAMPLE 2 --------------------------

C:\PS>start-transcript -path c:\transcripts\transcript0.txt -noclobber


Description
-----------
This command starts a transcript in the Transcript0.txt file in C:\transcripts. The NoClobber parameter prevents an
y existing files from being overwritten. If the Transcript0.txt file already exists, the command fails.






RELATED LINKS
Online version: http://go.microsoft.com/fwlink/?LinkID=113408
Stop-Transcript