Edit

Share via

Test-ClusterResourceFailure

Module:
FailoverClusters Module

Simulates a failure of a cluster resource.

Syntax

Default (Default) 

Test-ClusterResourceFailure
    [[-Name] <String>]
    [-InputObject <PSObject>]
    [-Cluster <String>]
    [<CommonParameters>]

Description

The Test-ClusterResourceFailure cmdlet simulates a failure of a cluster resource.

Based on the failover and failback policies, when this cmdlet runs, the Cluster service moves the clustered role, or resource group, and attempts to bring the clustered resource online. This cmdlet can be used to simulate what actions the Cluster service will take when a resource fails.

Examples

Example 1: Simulate a failure

PS C:\> Test-ClusterResourceFailure -Name "Cluster Disk 4"
Name                State               Group               ResourceType
----                -----               -----               ------------
Cluster Disk 4      Failed              cluster12FS         Physical Disk

This example simulates a failure in cluster resource named Cluster Disk 4.

Parameters

-Cluster

Specifies the name of the cluster on which to run this cmdlet. If the input for this parameter is . or it is omitted, then the cmdlet runs on the local cluster.

Parameter properties

Type:String
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

-InputObject

Specifies the cluster resource of which to simulate failure.

Parameter properties

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

Parameter sets

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

-Name

Specifies the name of the cluster resource of which to simulate failure.

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

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.