Edit

Share via

Save-CauDebugTrace

Module:
ClusterAwareUpdating Module

Saves CAU debug tracing information to a local zip file.

Syntax

Default (Default) 

Save-CauDebugTrace
    [[-ClusterName] <String>]
    [[-FilePath] <String>]
    [-Credential <PSCredential>]
    [-RunId <Guid>]
    [-Force]
    [<CommonParameters>]

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.

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.

Examples

Example 1: Save debug tracing information for the specified cluster

Save-CauDebugTrace -ClusterName "CONTOSO-FC1" -FilePath "C:\temp\testrun.zip"

This command saves the debug tracing information for the cluster named CONTOSO-FC1, to a trace file called testrun.zip in the C:\temp folder.

Parameters

-ClusterName

Specifies the name of the cluster for which to gather CAU debug tracing information. This parameter is only required when this cmdlet isn't run on a failover cluster node, or this cmdlet is used to reference a failover cluster different from where the cmdlet is run.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:0
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Credential

Specifies the administrative credentials for the target cluster.

Parameter properties

Type:PSCredential
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-FeatureUpdateLogs

Specifies the level of detail to include in the debug trace for feature updates. The acceptable values for this parameter are:

  • None: No feature update logs will be included in the debug trace.
  • FailedSetup: Only logs related to failed feature updates will be included in the debug trace.
  • All: All feature update logs will be included in the debug trace.

Parameter properties

Type:FeatureUpdateLogs
Default value:None
Accepted values:None, FailedSetup, All
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-FilePath

Specifies the name of the file to which to save the tracing information, such as MyTrace.zip.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False
Aliases:Path

Parameter sets

(All)
Position:1
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Force

Forces the command to run without asking for user confirmation.

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False
Aliases:f

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-RunId

Indicates that the cmdlet should only include debug trace files related to an updating run with the specified Run ID.

Parameter properties

Type:Guid
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

CommonParameters

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

Inputs

None

Outputs

Microsoft.ClusterAwareUpdating.ActivityIdMap

FileInfo