Get-ClusterDiagnosticInfo

  • Reference
Module:
FailoverClusters

Gets diagnostics for a cluster a cluster that contains VMs and produces a zip file containing the data.

Syntax

Get-ClusterDiagnosticInfo
   [[-WriteToPath] <String>]
   [[-Cluster] <String>]
   [[-ZipPrefix] <String>]
   [-HoursOfEvents <Int32>]
   [-IncludeEvents]
   [<CommonParameters>]
Get-ClusterDiagnosticInfo
   -ReadFromPath <String>
   [<CommonParameters>]

Description

The Get-ClusterDiagnosticInfo cmdlet gets diagnostics for a cluster that contains virtual machines and produces a zip file containing the data.

Examples

Example 1: Write diagnostic info to the specified path

PS C:\> Get-ClusterDiagnosticInfo -WriteToPath "C:\Users\MyUser\HealthTest\"
Writing to path : C:\Users\MyUser\HealthTest\

This command gets and writes the cluster Diagnostics to the folder C:\Users\MyUser\HealthTest.

Parameters

-Cluster

Specifies the name of the cluster the cmdlet gets.

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

-HoursOfEvents

Specifies the number of hours in the past that this cmdlet gathers system event logs.

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

-IncludeEvents

Indicates that this cmdlet gathers system event logs.

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

-ReadFromPath

Specifies the path to read from when examining previously collected log files.

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

-WriteToPath

Specifies the path to create the ZIP file that contains all of the logs.

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

-ZipPrefix

Specifies the name to prepend to the ZIP file that is produced.

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