| description | external help file | Module Name | ms.date | online version | schema | title |
|---|---|---|---|---|---|---|
Use this topic to help manage Windows and Windows Server technologies with Windows PowerShell. |
Microsoft.FailoverClusters.PowerShell.dll-Help.xml |
FailoverClusters |
11/22/2022 |
2.0.0 |
Get-ClusterResource |
Gets information about one or more resources in a failover cluster.
Get-ClusterResource [[-Name] <StringCollection>] [-VMId <Guid>] [-InputObject <PSObject>]
[-Cluster <String>] [<CommonParameters>]
The Get-ClusterResource cmdlet gets information about one or more resources in a failover
cluster.
To set a common property for a clustered resource, use this cmdlet to get the object for the
clustered resource, and then set the appropriate property on that object directly. To get and set
more specific information about a clustered resource, use this cmdlet with Get-ClusterParameter
and Set-ClusterParameter.
Get-ClusterResourceThis example lists all cluster resources on the local cluster.
Get-ClusterResource -Name "Cluster Disk 2" | Format-List -Property *This example displays information about Cluster Disk 2, on the local cluster, in the form of a
list.
Get-ClusterResource -Name "Cluster Disk 2" | Get-ClusterParameterThis example displays detailed parameters for Cluster Disk 2 on the local cluster.
Get-ClusterGroup -Name FileServer1 | Get-ClusterResourceThis example lists cluster resources in cluster group named FileServer1, a clustered file server
on the local cluster.
Get-ClusterResource -Name "Cluster Disk 2" | ForEach-Object -Process {
$_.RestartDelay = 600
}This example sets the common property RestartDelay for the Cluster Disk 2 resource on the local
cluster to 600.
Get-ClusterResource -Name "cluster pool 1" | Format-List -Property OwnerNodeThis example shows how to display the owner of a cluster pooled disk.
Get-ClusterResource -Name *print-VM1 | Get-VM | Stop-VM -Verbose -Confirm:$falseThis example enumerates the cluster resources for wildcard characters *print-VM1 and stops the
corresponding virtual machines without user confirmation. Verbose mode is turned on for details of
the operation.
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.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseSpecifies the cluster node or cluster group on which to enumerate cluster resources.
Type: PSObject
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: FalseSpecifies the name of the cluster resource to get.
Type: StringCollection
Parameter Sets: (All)
Aliases:
Required: False
Position: 0
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseSpecifies the virtual machine identifier (ID).
Type: Guid
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: FalseThis cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.