Export (0) Print
Expand All
Expand Minimize
0 out of 1 rated this helpful - Rate this topic

Get-ClusterResource

Get-ClusterResource

Get information about one or more resources in a failover cluster.

Syntax

Get-ClusterResource [-InputObject <psobject>] [[-Name] <StringCollection>] [-Cluster <string>] [<CommonParameters>]
  • InputObject

  • Name

  • Cluster

Detailed Description

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

Specifies the name of the cluster to run this cmdlet on. If you type "-Cluster ." or omit the parameter, the cmdlet runs on the local cluster.

Default Value:

Data Type: string

Attributes

Name Value PSMAML Attribute

Required?

false

required

Variable Length?

false

variableLength

Accept wildcard characters?

false

globbing

Accept Pipeline Input?

false

pipelineInput

Position?

named

position

Value Attributes

Name Value PSMAML Attribute

Required?

true

required

Variable Length?

false

variableLength

InputObject

Specifies the cluster node or cluster group to enumerate cluster resources on.

Default Value:

Data Type: psobject

Attributes

Name Value PSMAML Attribute

Required?

false

required

Variable Length?

false

variableLength

Accept wildcard characters?

false

globbing

Accept Pipeline Input?

true (ByValue)

pipelineInput

Position?

named

position

Value Attributes

Name Value PSMAML Attribute

Required?

true

required

Variable Length?

false

variableLength

Name

Specifies the name of the cluster resource to get.

Default Value:

Data Type: StringCollection

Attributes

Name Value PSMAML Attribute

Required?

false

required

Variable Length?

false

variableLength

Accept wildcard characters?

true

globbing

Accept Pipeline Input?

false

pipelineInput

Position?

1

position

Value Attributes

Name Value PSMAML Attribute

Required?

true

required

Variable Length?

false

variableLength

Input Type

Microsoft.FailoverClusters.PowerShell.Cluster, Microsoft.FailoverClusters.PowerShell.ClusterResource, Microsoft.FailoverClusters.PowerShell.ClusterNode

Return Type

Microsoft.FailoverClusters.PowerShell.ClusterResource

Examples

-------------------------- EXAMPLE 1 --------------------------

Command Prompt: C:\PS>
 
Get-ClusterResource 
 
Name                State               Group               ResourceType 
----                -----               -----               ------------ 
Cluster Disk 1      Online              Cluster Group       Physical Disk 
Cluster Disk 2      Online              Available Storage   Physical Disk 
Cluster Disk 3      Online              Available Storage   Physical Disk 
Cluster Disk 4      Online              Available Storage   Physical Disk 
Cluster Disk 5      Online              Available Storage   Physical Disk 
Cluster Disk 6      Online              Available Storage   Physical Disk 
Cluster Disk 7      Online              Available Storage   Physical Disk 
Cluster IP Address  Online              Cluster Group       IP Address 
Cluster IP Addre... Online              Cluster Group       IPv6 Address 
Cluster Name        Online              Cluster Group       Network Name

Description

-----------

This command lists all cluster resources on the local cluster.

 

-------------------------- EXAMPLE 2 --------------------------

Command Prompt: C:\PS>
 
Get-ClusterResource "Cluster Disk 2" | fl * 
 
Cluster                : cluster1 
IsCoreResource         : False 
IsNetworkClassResource : False 
IsStorageClassResource : True 
OwnerNode              : node2 
ResourceType           : Physical Disk 
State                  : Online 
OwnerGroup             : Available Storage 
Name                   : Cluster Disk 2 
MaintenanceMode        : False 
MonitorProcessId       : 524 
Description            : 
SeparateMonitor        : False 
PersistentState        : 1 
LooksAlivePollInterval : 4294967295 
IsAlivePollInterval    : 4294967295 
RestartAction          : 2 
RestartThreshold       : 1 
RestartDelay           : 500 
RestartPeriod          : 900000 
RetryPeriodOnFailure   : 3600000 
PendingTimeout         : 180000 
DeadlockTimeout        : 300000 
ResourceSpecificStatus : 
Id                     : 6e394089-145a-4279-b75d-b14015cc36e4

Description

-----------

This command displays information about Cluster Disk 2 (on the local cluster) in the form of a list.

 

-------------------------- EXAMPLE 3 --------------------------

Command Prompt: C:\PS>
 
Get-ClusterResource "Cluster Disk 2" | Get-ClusterParameter 
 
Object              Name                Value               Type 
------              ----                -----               ---- 
Cluster Disk 2      DiskIdType          0                   UInt32 
Cluster Disk 2      DiskSignature       2654136047          UInt32 
Cluster Disk 2      DiskIdGuid                              String 
Cluster Disk 2      DiskRunChkDsk       0                   UInt32 
Cluster Disk 2      DiskUniqueIds       {16, 0, 0, 0...}    ByteArray 
Cluster Disk 2      DiskVolumeInfo      {1, 0, 0, 0...}     ByteArray 
Cluster Disk 2      DiskArbInterval     3                   UInt32 
Cluster Disk 2      DiskPath                                String 
Cluster Disk 2      DiskReload          0                   UInt32 
Cluster Disk 2      MaintenanceMode     0                   UInt32 
Cluster Disk 2      MaxIoLatency        1000                UInt32 
Cluster Disk 2      CsvEnforseWriteT... 0                   UInt32 
Cluster Disk 2      DiskPnpUpdate       {0, 0, 0, 0...}     ByteArray

Description

-----------

This command displays detailed parameters for Cluster Disk 2 on the local cluster.

 

-------------------------- EXAMPLE 4 --------------------------

Command Prompt: C:\PS>
 
Get-ClusterGroup FileServer1 | Get-ClusterResource 
 
Name                State               Group               ResourceType 
----                -----               -----               ------------ 
Cluster Disk 1      Online              FileServer1         Physical Disk 
Cluster IP Address  Online              FileServer1         IP Address 
Cluster IP Addre... Online              FileServer1         IPv6 Address 
FileServer1         Online              FileServer1         Network Name

Description

-----------

This command lists cluster resources in cluster group FileServer1, a clustered file server on the local cluster.

 

-------------------------- EXAMPLE 5 --------------------------

Command Prompt: C:\PS>
 
$resource = Get-ClusterResource "Cluster Disk 2"; $resource.RestartDelay = 600

Description

-----------

This command sets the common property RestartDelay for the "Cluster Disk 2" resource on the local cluster to 600. Alternatively, you can run "Get-ClusterResource "Cluster Disk 2" | %{ $_.RestartDelay = 600 }" to set that property.

See Also

Did you find this helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft. All rights reserved.