Export (0) Print
Expand All
Collapse the table of content
Expand the table of content
Expand Minimize

Tee-Object

Updated: August 9, 2015

Tee-Object

Saves command output in a file or variable and also sends it down the pipeline.

Aliases

The following abbreviations are aliases for this cmdlet: 

  • tee

Syntax

Parameter Set: File
Tee-Object [-FilePath] <String> [-Append] [-InputObject <PSObject> ] [ <CommonParameters>]

Parameter Set: LiteralFile
Tee-Object -LiteralPath <String> [-InputObject <PSObject> ] [ <CommonParameters>]

Parameter Set: Variable
Tee-Object -Variable <String> [-InputObject <PSObject> ] [ <CommonParameters>]




Detailed Description

The Tee-Object cmdlet redirects output, that is, it sends the output of a command in two directions (like the letter T). It stores the output in a file or variable and also sends it down the pipeline. If Tee-Object is the last command in the pipeline, the command output is displayed at the prompt.

Parameters

-Append

Appends the output to the specified file. Without this parameter, the new content replaces any existing content in the file without warning.

This parameter was introduced in Windows PowerShell 3.0.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-FilePath<String>

Saves the object in the specified file. Wildcard characters are permitted, but must resolve to a single file.


Aliases

none

Required?

true

Position?

1

Default Value

None

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-InputObject<PSObject>

Specifies the object to be saved and displayed. Enter a variable that contains the objects or type a command or expression that gets the objects. You can also pipe an object to Tee-Object.

When you use the InputObject parameter with Tee-Object, instead of piping command results to Tee-Object, the InputObject value—even if the value is a collection that is the result of a command, such as InputObject (Get-Process)—is treated as a single object. Because InputObject cannot return individual properties from an array or collection of objects, it is recommended that if you use Tee-Object to perform operations on a collection of objects for those objects that have specific values in defined properties, you use Tee-Object in the pipeline, as shown in the examples in this topic.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

true (ByValue)

Accept Wildcard Characters?

false

-Variable<String>

Saves the object in the specified variable. Enter a variable name without the preceding dollar sign ($).


Aliases

none

Required?

true

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-LiteralPath<String>

Saves the object in the specified file. Unlike FilePath, the value of the LiteralPath parameter is used exactly as it is typed. No characters are interpreted as wildcards. If the path includes escape characters, enclose it in single quotation marks. Single quotation marks tell Windows PowerShell not to interpret any characters as escape sequences.


Aliases

PSPath

Required?

true

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

<CommonParameters>

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see    about_CommonParameters.

Inputs

The input type is the type of the objects that you can pipe to the cmdlet.

  • System.Management.Automation.PSObject

    You can pipe objects to Tee-Object.


Outputs

The output type is the type of the objects that the cmdlet emits.

  • System.Management.Automation.PSObject

    Tee-Object returns the object that it redirects.


Notes

  • You can also use the Out-File cmdlet or the redirection operator, both of which save the output in a file but do not send it down the pipeline.

  • Tee-Object uses Unicode encoding when it writes to files. As a result, the output might not be formatted properly in files with a different encoding. To specify the encoding, use the Out-File cmdlet.

Examples

Example 1: Output processes to a file and to the console

This command gets a list of the processes running on the computer and sends the result to a file. Because a second path is not specified, the processes are also displayed in the console.


PS C:\> Get-Process | Tee-Object -FilePath "C:\Test1\testfile2.txt"

Example 2: Output processes to a variable and Select-Object

This command gets a list of the processes running on the computer and sends the result to a variable named proc. It then pipes the resulting objects along to Select-Object, which selects the ProcessName and Handles property. Note that the $proc variable includes the default information returned by Get-Process.


PS C:\> Get-Process notepad | Tee-Object -Variable proc | Select-Object processname,handles

Example 3: Output system files to two log files

This command saves a list of system files in a two log files, a cumulative file and a current file.

The command uses the Get-ChildItem cmdlet to do a recursive search for system files on the D: drive. A pipeline operator (|) sends the list to Tee-Object, which appends the list to the AllSystemFiles.txt file and passes the list down the pipeline to the Out-File cmdlet, which saves the list in the NewSystemFiles.txt file.


PS C:\> Get-ChildItem –Path D: –File –System –Recurse | Tee-Object –FilePath "c:\test\AllSystemFiles.txt" –Append | Out-File c:\test\NewSystemFiles.txt

Related topics

Community Additions

ADD
Show:
© 2016 Microsoft