Get-ClusterResource
Get-ClusterResource
Gets information about one or more resources in a failover cluster.
Syntax
Parameter Set: InputObject
Get-ClusterResource [[-Name] <StringCollection> ] [-Cluster <String> ] [-InputObject <PSObject> ] [-VMId <Guid> ] [ <CommonParameters>]
Detailed 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.
Parameters
-Cluster<String>
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.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-InputObject<PSObject>
Specifies the cluster node or cluster group on which to enumerate cluster resources.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
true (ByValue) |
Accept Wildcard Characters? |
false |
-Name<StringCollection>
Specifies the name of the cluster resource to get.
Aliases |
none |
Required? |
false |
Position? |
1 |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
true |
-VMId<Guid>
Specifies the virtual machine identifier (ID).
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
true (ByPropertyName) |
Accept Wildcard Characters? |
false |
<CommonParameters>
This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216).
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
- Microsoft.FailoverClusters.PowerShell.Cluster
- Microsoft.FailoverClusters.PowerShell.ClusterResource
- Microsoft.FailoverClusters.PowerShell.ClusterNode
Outputs
The output type is the type of the objects that the cmdlet emits.
- Microsoft.FailoverClusters.PowerShell.ClusterResource
Examples
EXAMPLE 1
This example lists all cluster resources on the local cluster.
PS C:\> Get-ClusterResource
EXAMPLE 2
This example displays information about Cluster Disk 2, on the local cluster, in the form of a list.
PS C:\> Get-ClusterResource –Name "Cluster Disk 2" | Format-List –Property *
EXAMPLE 3
This example displays detailed parameters for Cluster Disk 2 on the local cluster.
PS C:\> Get-ClusterResource –Name "Cluster Disk 2" | Get-ClusterParameter
EXAMPLE 4
This example lists cluster resources in cluster group named FileServer1, a clustered file server on the local cluster.
PS C:\> Get-ClusterGroup –Name FileServer1 | Get-ClusterResource
EXAMPLE 5
This example sets the common property RestartDelay for the Cluster Disk 2 resource on the local cluster to 600.
PS C:\> Get-ClusterResource –Name "Cluster Disk 2" | ForEach-Object –Process {$_.RestartDelay = 600}
Example 6
This example shows how to display the owner of a cluster pooled disk.
PS C:\> Get-ClusterResource –Name "cluster pool 1" | Format-List -Property OwnerNode
Example 7
This example enumerates the cluster resources for wildcard characters *print-VM1 and stops the corresponding virtual machines. Verbose mode is turned on for details of the operation.
PS C:\> Get-ClusterResource –Name *print-VM1 | Get-VM | Stop-VM -Verbose
[Y] Yes [N] No [S] Suspend [?] Help (default is "Y"):Y