Get-ClusterResource
Gets information about one or more resources in a failover cluster.
Syntax
Default (Default)
Get-ClusterResource
[[-Name] <StringCollection>]
[-VMId <Guid>]
[-InputObject <PSObject>]
[-Cluster <String>]
[<CommonParameters>]
Description
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.
Examples
Example 1
Get-ClusterResource
This example lists all cluster resources on the local cluster.
Example 2
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.
Example 3
Get-ClusterResource -Name "Cluster Disk 2" | Get-ClusterParameter
This example displays detailed parameters for Cluster Disk 2 on the local cluster.
Example 4
Get-ClusterGroup -Name FileServer1 | Get-ClusterResource
This example lists cluster resources in cluster group named FileServer1, a clustered file server
on the local cluster.
Example 5
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.
Example 6
Get-ClusterResource -Name "cluster pool 1" | Format-List -Property OwnerNode
This example shows how to display the owner of a cluster pooled disk.
Example 7
Get-ClusterResource -Name *print-VM1 | Get-VM | Stop-VM -Verbose -Confirm:$false
This 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.
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 node or cluster group on which to enumerate cluster resources.
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 to get.
Parameter properties
| Type: | StringCollection |
| 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 |
-VMId
Specifies the virtual machine identifier (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: | True |
| 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.