Save-CauDebugTrace
Save-CauDebugTrace
Saves Cluster-Aware Updating (CAU) debug tracing information to a local zip file.
Syntax
Parameter Set: Default
Save-CauDebugTrace [[-ClusterName] <String> ] [[-FilePath] <String> ] [-Credential <PSCredential> ] [-Force] [-RunId <Guid> ] [ <CommonParameters>]
Detailed Description
The Save-CauDebugTrace cmdlet saves Cluster-Aware Updating (CAU) debug tracing information to a local zip file. The tracing information is mainly intended for use by developers and support engineers. Specify the file name with the FilePath parameter.
Note: To run this cmdlet, Windows PowerShell® remoting must be enabled on each node. To do this, run the Enable-PSRemoting cmdlet. In addition, ensure that the Windows Remote Management - Compatibility Mode (HTTP-In) firewall exception is enabled on each node.
Parameters
-FilePath<String>
Specifies the name of the file to which to save the tracing information, such as MyTrace.zip.
Aliases |
none |
Required? |
false |
Position? |
2 |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-Force
Specifies that when the file specified by the FilePath parameter exists, it is overwritten without prompting for confirmation. If Force is not specified, then when the file specified by the FilePath parameter exists, the cmdlet returns an error.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-ClusterName<String>
Specifies the name of the cluster for which to gather CAU debug tracing information. This parameter is only required when this cmdlet is not run on a failover cluster node, or this cmdlet is used to reference a failover cluster different from where the cmdlet is run.
Aliases |
none |
Required? |
false |
Position? |
1 |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-Credential<PSCredential>
Specifies the administrative credentials for the target cluster.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-RunId<Guid>
Indicates that the cmdlet should only include debug trace files related to an Updating Run with the specified Run ID.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
<CommonParameters>
This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216).
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
- None
Outputs
The output type is the type of the objects that the cmdlet emits.
- None
Examples
EXAMPLE 1
This example saves the debug tracing information, for the cluster called CONTOSO-FC1, to a trace file called testrun.zip in the C:\temp folder.
PS C:\> Save-CauDebugTrace –ClusterName CONTOSO-FC1 -FilePath C:\temp\testrun.zip