TechNet
Products
IT Resources
Downloads
Training
Support
Products
Windows
Windows Server
System Center
Microsoft Edge
Office
Office 365
Exchange Server
SQL Server
SharePoint Products
Skype for Business
See all products »
Resources
Channel 9 Video
Evaluation Center
Learning Resources
Microsoft Tech Companion App
Microsoft Technical Communities
Microsoft Virtual Academy
Script Center
Server and Tools Blogs
TechNet Blogs
TechNet Flash Newsletter
TechNet Gallery
TechNet Library
TechNet Magazine
TechNet Wiki
Windows Sysinternals
Virtual Labs
Solutions
Networking
Cloud and Datacenter
Security
Virtualization
Updates
Service Packs
Security Bulletins
Windows Update
Trials
Windows Server 2016
System Center 2016
Windows 10 Enterprise
SQL Server 2016
See all trials »
Related Sites
Microsoft Download Center
Microsoft Evaluation Center
Drivers
Windows Sysinternals
TechNet Gallery
Training
Expert-led, virtual classes
Training Catalog
Class Locator
Microsoft Virtual Academy
Free Windows Server 2012 courses
Free Windows 8 courses
SQL Server training
Microsoft Official Courses On-Demand
Certifications
Certification overview
Special offers
MCSE Cloud Platform and Infrastructure
MCSE: Mobility
MCSE: Data Management and Analytics
MCSE Productivity
Other resources
Microsoft Events
Exam Replay
Born To Learn blog
Find technical communities in your area
Azure training
Official Practice Tests
Support options
For business
For developers
For IT professionals
For technical support
Support offerings
More support
Microsoft Premier Online
TechNet Forums
MSDN Forums
Security Bulletins & Advisories
Not an IT pro?
Microsoft Customer Support
Microsoft Community Forums
Sign in
Home
Library
Wiki
Learn
Gallery
Downloads
Support
Forums
Blogs
Resources For IT Professionals
United States (English)
Россия (Pусский)
中国(简体中文)
Brasil (Português)
Skip to locale bar
Post an article
Translate this page
Powered by
Microsoft® Translator
Wikis - Page Details
First published by
PramodK
When:
18 Jun 2010 4:19 AM
Last revision by
Richard Mueller
(cMVP, Microsoft Community Contributo)
When:
17 Sep 2013 10:06 AM
Revisions:
5
Comments:
1
Options
Subscribe to Article (RSS)
Share this
Can You Improve This Article?
Positively!
Click Sign In to add the tip, solution, correction or comment that will help other users.
Report inappropriate content using
these instructions
.
Wiki
>
TechNet Articles
>
Windows Server 2008 R2 Failover Cluster PowerShell Command Reference
Windows Server 2008 R2 Failover Cluster PowerShell Command Reference
Article
History
Windows Server 2008 R2 Failover Cluster PowerShell Command Reference
CommandLet
Add-ClusterDisk
Description
Make a new disk available for use in a failover cluster. The disk (LUN) must be exposed to all nodes in the failover cluster, and should not be exposed to any other servers.
Example 1:
C:\PS>Get-ClusterAvailableDisk | Add-ClusterDisk
Name State Group ResourceType
---- ----- ----- ------------
Cluster Disk 7 OnlinePending Available Storage Physical Disk
Cluster Disk 8 OnlinePending Available Storage Physical Disk
Description
This command identifies the disks that are ready to be added to the cluster, and then adds them to Available Storage.
Example 2:
C:\PS>Get-ClusterAvailableDisk | ?{ $_.ScsiAddress -eq 50331651 } | Add-ClusterDisk
Name State Group ResourceType
---- ----- ----- ------------
Cluster Disk 4 OnlinePending Available Storage Physical Disk
Description
This command examines disks that are ready to be added to the cluster, find
s the disk with a specific SCSI address, and adds it to Available Storage.
CommandLet
Add-ClusterFileServerRole
Description
Create a clustered file server (resource group that includes one or more disks, on which you can create shared folders for users).
Example 1:
C:\PS>Add-ClusterFileServerRole -Storage "Cluster Disk 8"
Name OwnerNode State
---- --------- ----
cluster1FS node1 Online
Description
This command creates a clustered file server using Cluster Disk 8, and assigns a default name.
Example 2:
C:\PS>Add-ClusterFileServerRole -Storage "Cluster Disk 6" -Name cluster1FS12
Name OwnerNode State
---- ---------
-----
cluster1FS12 node1 Online
Description
This command creates a clustered file server using Cluster Disk 6, and assigns the name cluster1FS12.
Example 3:
C:\PS>Add-ClusterFileServerRole -Storage "Cluster Disk 8" -Wait 0
Name OwnerNode State
---- ---------
-----
cluster1FS node1 Pending
Description
This command creates a clustered file server using Cluster Disk 8, and assigns a default name. The command completes without waiting for all resources to come online.
CommandLet
Add-ClusterGenericApplicationRole
Description
Configure high availability for an application that was not originally designed to run in a failover cluster.
Example 1:
C:\PS>Add-ClusterGenericApplicationRole -CommandLine NewApplication.exe
Name OwnerNode State
---- --------- - ----
cluster1GenApp node2 Online
Description
This command configures NewApplication.exe as a generic clustered application. A default name will be used for client access and this application requires no storage.
Example 2:
C:\PS>Add-ClusterGenericApplicationRole -CommandLine NewApplication.exe -Storage "Cluster Disk 4" -Name NewApplication
Name OwnerNode State
---- --------- - ----
NewApplication node2 Online
Description
This command configures NewApplication.exe as a generic clustered application using Cluster Disk 4, and assigns the name NewApplication.
Example 3:
C:\PS>Add-ClusterGenericApplicationRole -CommandLine NewApplication.exe -Wait 0
Name OwnerNode State
---- --------- ----
cluster1GenApp node2 Pending
Description
This command configures NewApplication.exe as a generic clustered application and assigns the name NewApplication. The command completes without waiting for all resources to come online.
CommandLet
Add-ClusterGenericScriptRole
Description
Configure an application controlled by a script that runs in Windows Script Host, within a failover cluster.
Example 1:
C:\PS>Add-ClusterGenericScriptRole -ScriptFilePath script1.vbs
Name OwnerNode State
---- --------- -----
cluster1GenScript node2 Online
Description
This command configures script1.vbs to run within a failover cluster, using defaults for the name and IP address, and does not assign a disk.
Example 2:
C:\PS>Add-ClusterGenericScriptRole -ScriptFilePath script1.vbs -Storage "Cluster Disk 4" -Name script1
Name OwnerNode State
---- --------- -----
script1 node2 Online
Description
This command configures script1.vbs to run within a failover cluster and use Cluster Disk 4. The command assigns the clustered script the name script1.
Example 3:
C:\PS>Add-ClusterGenericScriptRole -ScriptFilePath script1.vbs -Wait 0
Name OwnerNode State
---- --------- -----
cluster1GenScript node2 Pending
Description
This command configures script1.vbs to run within a failover cluster, using defaults for the name and IP address, and does not assign a disk. The command completes without waiting for all resources to come online.
CommandLet
Add-ClusterGenericServiceRole
Description
Configure high availability for a service that was not originally designed to run in a failover cluster.
Example 1:
C:\PS>Add-ClusterGenericServiceRole -ServiceName Service1
Name OwnerNode State
---- --------- -----
cluster1GenSvc node1 Online
Description
-----------
This command configures Service1 as a generic clustered service, using defaults for the name and IP address, and does not assign a disk.
Example 2:
C:\PS>Add-ClusterGenericServiceRole -ServiceName Service1 -Storage "Cluster Disk 6"
Name OwnerNode State
---- ---------
-----
cluster1GenSvc node1 Online
Description
-----------
This command configures Service1 as a generic clustered service using Cluster Disk 6, and assigns defaults for the name and IP address.
CommandLet
Add-ClusterGroup
Description
Add an empty resource group to the failover cluster configuration, in preparation for adding clustered resources to the group.
Example 1:
C:\PS>Add-ClusterGroup Group1
Name OwnerNode State
---- --------- -----
Group1 node1 Online
Description
-----------
This command adds an empty resource group called Group1 to the failover cluster.
CommandLet
Add-ClusterNode
Description
Add a node (server) to a failover cluster. Before adding the new node, you should run validation tests on the existing nodes together with the proposed new node.
Example 1:
C:\PS>Add-ClusterNode node4
Name State
---- -----
node4 Up
Description
-----------
This command adds node4 to the local cluster.
Example 2:
C:\PS>Get-Cluster cluster1 | Add-ClusterNode node3
Name State
---- - ----
node3 Up
Description
-----------
This command adds node3 to cluster1.
CommandLet
Add-ClusterPrintServerRole
Description
Create a clustered print server (a resource group that includes a printer and a disk for storing print job information and printer drivers).
Example 1:
C:\PS>Add-ClusterPrintServerRole -Storage "Cluster Disk 5"
Name OwnerNode State
---- --------- - ----
cluster1PS node1 Online
Description
-----------
This command creates a clustered print server using Cluster Disk 5, and assigns a default name.
Example 2:
C:\PS>Add-ClusterPrintServerRole -Storage "Cluster Disk 5" -Name MyPrintServer
Name OwnerNode State
---- --------- -----
MyPrintServer node1 Online
Description
-----------
This command creates a clustered print server using Cluster Disk 5, and assigns the name MyPrintServer.
CommandLet
Add-ClusterResource
Description
Add a resource to a clustered service or application (resource group) in a
failover cluster.
Example 1:
C:\PS>Add-ClusterResource -Name resource1 -ResourceType "IP Address" -Group
ClusterSrv1
Name State Group ResourceType
---- ----- ----- ------------
resource1 Offline ClusterSrv1 IP Address
Description
-----------
This command creates a new IP Address resource called resource1 on the local cluster. It configures the resource as part of the clustered server (resource group) called ClusterSrv1.
CommandLet
Add-ClusterResourceDependency
Description
Add a resource to the list of resources that a particular resource depends
on (using AND as the connector) within a failover cluster. Existing dependencies will remain in the list.
Example 1:
C:\PS>Add-ClusterResourceDependency "FileServer-(cluster1FS12)(Cluster Disk
2)" "Cluster Disk 4"
Name State Group ResourceType
---- ----- ----- ------------
FileServer-(clus... Online cluster1FS12 File Server
Description
-----------
This command adds the resource Cluster Disk 4 to the list of resources that
resource "FileServer-(cluster1FS12)(Cluster Disk 2)" depends on (using AND
as the connector).
CommandLet
Add-ClusterResourceType
Description
Add a resource type to a failover cluster, and specify information such as
the dynamic-link library (DLL) to use with that resource type.
Example 1:
C:\PS>Add-ClusterResourceType ResType3 %systemdrive%\res3.dll
Name DisplayName
---- -----------
ResType3 ResType3
Description
-----------
This command creates ResType3 on the local cluster using res3.dll located on %systemdrive%.
Example 2:
C:\PS>Add-ClusterResourceType ResType4 %systemdrive%\res4.dll -DisplayName
"Resource Type 4"
Name DisplayName
---- -----------
ResType4 Resource Type 4
Description
-----------
This command creates ResType4 on the local cluster using res4.dll located on %systemdrive%. The display name of the resource type is "Resource Type 4.
"
CommandLet
Add-ClusterServerRole
Description
Add a group containing only a client access point and storage to the failover cluster configuration.
Example 1:
C:\PS>Add-ClusterServerRole
Name OwnerNode State
---- ---------
-----
cluster1Other node2 Online
Description
-----------
This command establishes a default name for a clustered server. It does not
specify any storage. Storage and other resources can be added later.
Example 2:
C:\PS>Add-ClusterServerRole -Storage "Cluster Disk 3" -Name MainSrv1
Name OwnerNode State
---- ---------
-----
MainSrv1 node2 Online
Description
-----------
This command creates a clustered service or application using Cluster Disk
3, and assigns the name MainSrv1.
Example 3:
C:\PS>Add-ClusterServerRole -Storage "Cluster Disk 4","Cluster Disk 5" -Name MainSrv2
Name OwnerNode State
---- ---------
-----
MainSrv2 node2 Online
Description
-----------
This command creates a clustered service or application using Cluster Disk
4 and Cluster Disk 5, and assigns the name MainSrv2.
CommandLet
Add-ClusterSharedVolume
Description
Make a volume available in Cluster Shared Volumes in a failover cluster.
Example 1:
C:\PS>Add-ClusterSharedVolume "Cluster Disk 4"
Name State Node
---- ----- ----
Cluster Disk 4 Online node2
Description
-----------
This command adds Cluster Disk 4 to the Cluster Shared Volumes on the local
cluster.
CommandLet
Add-ClusterVirtualMachineRole
Description
Create a clustered virtual machine, that is, a virtual machine that can be
failed over if necessary to a different server in the failover cluster.
Example 1:
C:\PS>Add-ClusterVirtualMachineRole -VirtualMachine VM1
Name OwnerNode State
---- ---------
-----
Virtual Machine node1 Offline
Description
-----------
This command configures VM1 as a clustered virtual machine, and assigns a default name.
Example 2:
C:\PS>Add-ClusterVirtualMachineRole -VirtualMachine VM1 -Name "MainServer1"
Name OwnerNode State
---- ---------
-----
MainServer1 node1 Oofline
Description
-----------
This command configures VM1 as a clustered virtual machine, and assigns the
name MainServer1.
CommandLet
Block-ClusterAccess
Description
Prevent the specified user or users from accessing a failover cluster.
Example 1:
C:\PS>Block-ClusterAccess CONTOSO\user2
Description
-----------
This command prevents the user CONTOSO\user2 from gaining access to the local cluster.
CommandLet
Clear-ClusterDiskReservation
Description
Clear the persistent reservation on a disk in a failover cluster.
Example 1:
C:\PS>Clear-ClusterDiskReservation -Disk 5
Description
-----------
This command clears the persistent reservation on Disk 5 on the local node
after asking for user confirmation.
Example 2:
C:\PS>Clear-ClusterDiskReservation -Disk 6 -Node node2 -Force
Description
-----------
This command clears the persistent reservation on Disk 6 on node2 without asking for user confirmation.
CommandLet
Clear-ClusterNode
Description
Clear the cluster configuration from a node that was evicted from a failover cluster.
Example 1:
C:\PS>Clear-ClusterNode node4 -Force
Description
-----------
This command removes cluster configuration information from node4 without asking for user confirmation.
Example 2:
C:\PS>Clear-ClusterNode
Description
-----------
After prompting for confirmation, this command removes cluster configuration information from the local node.
CommandLet
Get-Cluster
Description
Get information about one or more failover clusters in a given domain.
Example 1:
C:\PS>Get-Cluster | fl *
Domain : contoso.com
Name : cluster1
FixQuorum : 0
SharedVolumesRoot : C:\ClusterStorage
DefaultNetworkRole : 2
Description :
QuorumArbitrationTimeMax : 20
ClusSvcHangTimeout : 60
ClusSvcRegroupStageTimeout : 7
ClusSvcRegroupOpeningTimeout : 5
ClusSvcRegroupPruningTimeout : 5
ClusSvcRegroupTickInMilliseconds : 300
HangRecoveryAction : 3
SameSubnetDelay : 1000
CrossSubnetDelay : 1000
SameSubnetThreshold : 5
PlumbAllCrossSubnetRoutes : 0
CrossSubnetThreshold : 5
BackupInProgress : 0
RequestReplyTimeout : 60
WitnessRestartInterval : 15
SecurityLevel : 1
ClusterLogLevel : 3
ClusterLogSize : 100
WitnessDatabaseWriteTimeout : 300
AddEvictDelay : 60
EnableSharedVolumes : Enabled
Id : 655d3640-2845-4077-a396-9f317f2df60e
Description
-----------
This command displays state and property information for the local cluster
in the form of a list.
Example 2:
C:\PS>Get-Cluster cluster1
Name
----
cluster1
Description
-----------
This command gets information about a cluster named cluster1.
Example 3:
C:\PS>Get-Cluster -domain contoso.com
Name
----
cluster1
cluster2
cluster3
Description
-----------
This command gets information about each of the clusters in the contoso.com
domain.
Example 4:
C:\PS>$cluster = Get-Cluster; $cluster.CrossSubnetDelay = 1500
Description
-----------
This command sets the common property CrossSubnetDelay for the local cluster to 1500. Alternatively, you can run "Get-Cluster | %{ $_.CrossSubnetDelay
= 1500 }" to set that property.
CommandLet
Get-ClusterAccess
Description
Get information about permissions that control access to a failover cluster
.
Example 1:
C:\PS>Get-ClusterAccess
IdentityReference AccessControlType ClusterRights
----------------- ----------------- ---------
----
CONTOSO\user1 Deny Full
NT AUTHORITY\SYSTEM Allow Full
NT AUTHORITY\NETWORK SE... Allow Full
BUILTIN\Administrators Allow Full
CONTOSO\user2 Allow Read
NT SERVICE\MSDTC Allow Full
Description
-----------
This command lists the level of permissions that have been assigned to users of this cluster, including users who are blocked from access.
CommandLet
Get-ClusterAvailableDisk
Description
Get information about the disks that can support failover clustering and are visible to all nodes, but are not yet part of the set of clustered disks.
Example 1:
C:\PS>Get-ClusterAvailableDisk
Cluster : cluster1
Id : 2654136007
Name : Cluster Disk 4
Number : 7
ScsiAddress : 50331651
Size : 2097152000
Partitions : {\\?\GLOBALROOT\Device\Harddisk7\Partition1\}
Cluster : cluster1
Id : 2654136015
Name : Cluster Disk 5
Number : 9
ScsiAddress : 67108867
Size : 2097152000
Partitions : {\\?\GLOBALROOT\Device\Harddisk9\Partition1\}
Description
-----------
This command lists the disks that are ready to be added to the cluster.
Example 2:
C:\PS>Get-ClusterAvailableDisk | Add-ClusterDisk
Name State Group ResourceType
---- ----- ----- ------------
Cluster Disk 4 OnlinePending Available Storage Physical Disk
Cluster Disk 5 OnlinePending Available Storage Physical Disk
Description
-----------
This command adds all disks that are ready to be added to the local cluster
.
CommandLet
Get-ClusterGroup
Description
Get information about one or more clustered services or applications (resource groups) in a failover cluster.
Example 1:
C:\PS>Get-ClusterGroup
Name OwnerNode State
---- ---------
-----
Available Storage node1 Online Cluster Group node2 Online cluster1FS node1 Online cluster1FS-Other node1 Online
Description
-----------
This command lists the state and owner node of each clustered service or application (resource group) in the local cluster.
Example 2:
C:\PS>Get-ClusterGroup "Cluster Group" | Get-ClusterResource
Name State Group ResourceType
---- ----- ----- ------------
Cluster Disk 1 Online Cluster Group 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 the resources in "Cluster Group" on the local cluster.
Example 3:
C:\PS>Get-ClusterNode node1 | Get-ClusterGroup
Name OwnerNode State
---- ---------
-----
Cluster Group node1 Online
Description
-----------
This command lists the clustered services and applications (resource groups
) that are currently owned by node1 in the local cluster.
Example 4:
C:\PS>Get-ClusterGroup FileServer1 | fl *
Cluster : Cluster1
IsCoreGroup : False
OwnerNode : node1
State : Online
Name : FileServer1
Description :
PersistentState : 0
FailoverThreshold : 4294967295
FailoverPeriod : 6
AutoFailbackType : 0
FailbackWindowStart : 4294967295
FailbackWindowEnd : 4294967295
AntiAffinityClassNames : {}
Id : 189ec8ad-1831-4f57-9bb0-3ffb9cbb9227
Description
-----------
This command displays the properties of a clustered file server (resource group) called FileServer1, in the form of a list.
CommandLet
Get-ClusterLog
Description
Create a log file for all nodes (or a specific a node) in a failover cluster.
Example 1:
C:\PS>Get-ClusterLog
Mode LastWriteTime Length Name
---- ------------- ------ ----
-a--- 9/4/2008 3:53 PM 2211301 Cluster.log
-a--- 9/4/2008 3:53 PM 1261025 Cluster.log
Description
-----------
This command creates a log file for the local cluster in the cluster reports folder on each node of the cluster.
Example 2:
C:\PS>Get-ClusterLog -Destination .
Mode LastWriteTime Length Name
---- ------------- ------ ----
-a--- 9/4/2008 3:55 PM 2211301 node1_cluster.log
-a--- 9/4/2008 3:55 PM 1261025 node2_cluster.log
Description
-----------
This command creates a log file for each node of the local cluster, and copies all logs to the local folder.
Example 3:
C:\PS>Get-ClusterLog -TimeSpan 5
Mode LastWriteTime Length Name
---- ------------- ------ ----
-a--- 9/4/2008 3:58 PM 128299 Cluster.log
-a--- 9/4/2008 3:58 PM 104181 Cluster.log
Description
-----------
This command creates a log file for the local cluster in the cluster reports folder on each node of the cluster. The log covers the last 5 minutes.
CommandLet
Get-ClusterNetwork
Description
Get information about one or more networks in a failover cluster.
Example 1:
C:\PS>Get-ClusterNetwork
Name State
---- -----
Cluster Network 1 Up
Cluster Network 2 Up
Cluster Network 3 Up
Description
-----------
This command gets information about the networks used by the local cluster.
CommandLet
Get-ClusterNetworkInterface
Description
Get information about one or more network adapters in a failover cluster.
Example 1:
C:\PS>Get-ClusterNetworkInterface
Name Node Network State
---- ---- ------- -----
node1 - Local A ... node1 Cluster Network 1 Up
node2 - Local A ... node2 Cluster Network 1 Up
node1 - Local A ... node1 Cluster Network 2 Up
node2 - Local A ... node2 Cluster Network 2 Up
Description
-----------
This command displays information about the network adapters used by the local cluster.
Example 2:
C:\PS>Get-ClusterNode node1 | Get-ClusterNetworkInterface
Name Node Network State
---- ---- ------- -----
node1 - Local A ... node1 Cluster Network 1 Up
node1 - Local A ... node1 Cluster Network 2 Up
Description
-----------
This command displays information about the network adapters used by node1
in the local cluster. It is equivalent to "Get-ClusterNetworkInterface -node node1".
CommandLet
Get-ClusterNode
Description
Get information about one or more nodes (servers) in a failover cluster.
Example 1:
C:\PS>Get-ClusterNode
Name State
---- -----
node1 Up
node2 Up
node3 Up
node4 Up
Description
-----------
This command displays the name and state of each node (server) in the local
cluster.
Example 2:
C:\PS>Get-ClusterNode -Cluster cluster1
Name State
---- -----
node1 Up
node2 Up
Description
-----------
This command displays the name and state of each node (server) in cluster1.
Example 3:
C:\PS>Get-ClusterNode node1 | Get-ClusterResource
Name State Group ResourceType
---- ----- ----- ------------
Cluster Disk 1 Online Cluster Group 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
File Share Witness Offline Cluster Group File Share Witness
Description
-----------
This command lists all cluster resources that are currently owned by node1 on the local cluster.
CommandLet
Get-ClusterOwnerNode
Description
For a resource in a failover cluster, get information about which nodes can own the resource. For a clustered service or application (a resource group ), get information about the order of preference among owner nodes.
Example 1:
C:\PS>Get-ClusterResource "Cluster Disk 1" | Get-ClusterOwnerNode
ClusterObject OwnerNodes
------------- ----------
Cluster Disk 1 {node1, node2}
Description
-----------
This command lists the possible owners for Cluster Disk 1 in the local cluster.
Example 2:
C:\PS>Get-ClusterGroup cluster1FS12 | Get-ClusterOwnerNode
ClusterObject OwnerNodes
------------- ----------
cluster1FS12 {}
Description
-----------
This command lists the preferred owners for the clustered file server (resource group) called cluster1FS12 on the local cluster.
CommandLet
Get-ClusterParameter
Description
Get detailed information about an object in a failover cluster, such as a cluster resource. This cmdlet is used to manage private properties for a cluster object. To get and set common properties for a cluster object, use the appropriate Get-Cluster* cmdlet to get the cluster object of interest and then set the property of interest on that cluster object directly.
Example 1:
C:\PS>Get-ClusterResource cluster1FS | Get-ClusterParameter
Object Name Value Type
------ ---- ----- ----
cluster1FS Name cluster1FS String
cluster1FS DnsName cluster1FS String
cluster1FS RemapPipeNames 0 UInt32
cluster1FS HostRecordTTL 1200 UInt32
cluster1FS RegisterAllProvi... 0 UInt32
cluster1FS PublishPTRRecords 0 UInt32
cluster1FS TimerCallbackAdd... 5 UInt32
cluster1FS ResourceData {1, 0, 0, 0...} ByteArray
cluster1FS StatusNetBIOS 0 UInt32
cluster1FS StatusDNS 0 UInt32
cluster1FS StatusKerberos 0 UInt32
cluster1FS CreatingDC \\DOMAIN12-DC-05... String
cluster1FS LastDNSUpdateTime 10/15/2008 9:50:... DateTime
cluster1FS ObjectGUID 8054680893fd5943... String
Description
-----------
This command gets the parameters (detailed information) for the cluster resource cluster1FS on the local cluster. Parameters vary according to the type of resource being viewed.
Example 2:
C:\PS>Get-ClusterResource cluster1FS | Get-ClusterParameter HostRecordTTL
Object Name Value Type
------ ---- ----- ----
cluster1FS HostRecordTTL 1200 UInt32
Description
-----------
This command displays the HostRecordTTL parameter for the cluster resource cluster1FS on the local cluster, if that parameter is applicable to cluster1FS.
CommandLet
Get-ClusterQuorum
Description
Get information about the quorum configuration of a failover cluster.
Example 1:
C:\PS>Get-ClusterQuorum
Cluster QuorumResource Quorum Type
------- -------------- ------ ----
cluster1 Cluster Disk 1 NodeAndDiskMajo rity
Description
-----------
This command displays the quorum configuration for the local cluster.
Example 2:
C:\PS>Get-ClusterQuorum -Cluster Cluster1
Cluster QuorumResource Quorum
Type
------- -------------- ------
----
mycluster NodeMajo rity
Description
-----------
This command displays the quorum configuration for Cluster1.
CommandLet
Get-ClusterResource
Description
Get information about one or more resources in a failover cluster.
Example 1:
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:
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:
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:
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:
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.
CommandLet
Get-ClusterResourceDependency
Description
Get information about the dependencies that have been configured between clustered resources in a failover cluster.
Example 1:
C:\PS>Get-ClusterResourceDependency cluster1FS12
Resource DependencyExpression
-------- --------------------
cluster1FS12 [IP Address 172.24.11.0] or [IP Add
...
Description
-----------
This command displays the dependencies for the resource called cluster1FS12
.
Example 2:
C:\PS>Get-ClusterGroup cluster1FS12 | Get-ClusterResource | Get-ClusterResourceDependency
Resource DependencyExpression
-------- --------------------
cluster1FS12 [IP Address 172.24.11.0] or [IP Add
...
Cluster Disk 6
IP Address 157.56.48.0
IP Address 2001:4898:9:2::
IP Address 2002:9d38:31ca:8::
Description
-----------
This command displays the dependencies for each resource in the clustered file server (resource group) called cluster1FS12. Some resources do not have dependencies.
CommandLet
Get-ClusterResourceDependencyReport
Description
Generate a report that lists the dependencies between resources in a failov
er cluster.
Example 1:
C:\PS>Get-ClusterResourceDependencyReport -Group cluster1FS12
Mode LastWriteTime Length Name
---- ------------- ------ ----
-a--- 10/15/2008 6:29 PM 59299 fb509e66-8d02-4881-8184-6be5b1bfa4
c2.mht
Description
-----------
This command creates a dependency report file for the clustered file server (resource group) cluster1FS12 on the local cluster.
Example 2:
C:\PS>Get-ClusterResourceDependencyReport -Group cluster1FS12 | Copy-Item - Destination c:\users\user1
Description
-----------
This command creates a dependency report file for the clustered file server (resource group) cluster1FS12 on the local cluster. The dependency report is copied to c:\users\user1.
Example 3:
C:\PS>Get-ClusterGroup | Get-ClusterResourceDependencyReport | Copy-Item -D estination \\fileserver\share
Description
-----------
This command creates a dependency report file for each clustered service or application (resource group) on the local cluster, and copies all reports to \\fileserver\share.
CommandLet
Get-ClusterResourceType
Description
Get information about one or more resource types in a failover cluster.
Example 1:
C:\PS>Get-ClusterResourceType
Name DisplayName
---- -----------
DFS Replicated Folder DFS Replicated Folder
DHCP Service DHCP Service
Distributed File System Distributed File System
Distributed Transaction Coordinator Distributed Transaction Coordinator
File Server File Server
File Share Witness File Share Quorum Witness
Generic Application Generic Application
Generic Script Generic Script
Generic Service Generic Service
IP Address IP Address
IPv6 Address IPv6 Address
IPv6 Tunnel Address IPv6 Tunnel Address
Microsoft iSNS iSNSClusRes
MSMQ (Resource Type Unavailable)
MSMQTriggers (Resource Type Unavailable)
Network Name Network Name
NFS Share NFS Share
Physical Disk Physical Disk
Print Spooler Print Spooler
Virtual Machine Virtual Machine
Virtual Machine Configuration Virtual Machine Configuration
Volume Shadow Copy Service Task Volume Shadow Copy Service Task
WINS Service WINS Service
Description
-----------
This command lists all the resource types that can be used in configurations on the local cluster.
Example 2:
C:\PS>Get-ClusterResourceType "File Server" | fl *
Cluster : Cluster1
DisplayName : File Server
Name : file server
DllName : clusres.dll
Description :
AdminExtensions : {}
LooksAlivePollInterval : 5000
IsAlivePollInterval : 60000
PendingTimeout : 180000
DeadlockTimeout : 300000
Id : f582c84f-0066-0069-6c65-207365727665
Description
-----------
This command gets information about the File Server resource type on the local cluster, and displays the information in the form of a list.
CommandLet
Get-ClusterSharedVolume
Description
Get information about Cluster Shared Volumes in a failover cluster.
Example 1:
C:\PS>Get-ClusterSharedVolume
Name State Node
---- ----- ----
Cluster Disk 3 Online node1
Cluster Disk 4 Online node2
Description
-----------
This command lists all the Cluster Shared Volumes on the local cluster.
Example 2:
C:\PS>Get-ClusterSharedVolume -Cluster cluster1
Name State Node
---- ----- ----
Cluster Disk 1 Online node4
Description
-----------
This command lists all the Cluster Shared Volumes on cluster1.
Example 3:
C:\PS>Get-ClusterSharedVolume "Cluster Disk 4"
Name State Node
---- ----- ----
Cluster Disk 4 Online node2
Description
-----------
This command displays the state of the Cluster Shared Volume called Cluster Disk 4.
CommandLet
Grant-ClusterAccess
Description
Grant access to a failover cluster, either full access or read-only access.
Example 1:
C:\PS>Grant-ClusterAccess CONTOSO\user1
Description
-----------
This command grants full access to the local cluster to user1 in the CONTOS O domain.
Example 2:
C:\PS>Grant-ClusterAccess CONTOSO\user1 -readonly
Description
-----------
This command grants read-only access to the local cluster to user1 in the C
ONTOSO domain.
CommandLet
Move-ClusterGroup
Description
Move a clustered service or application (a resource group) from one node to another in a failover cluster.
Example 1:
C:\PS>Move-ClusterGroup MyPrintServer
Name OwnerNode State
---- ---------
-----
MyPrintServer node1 Online
Description
-----------
This command moves the clustered service called MyPrintServer from the current owner node to any other node.
Example 2:
C:\PS>Move-ClusterGroup MyPrintServer -Node node2
Name OwnerNode State
---- ---------
-----
MyPrintServer node2 Online
Description
-----------
This command moves the clustered service called MyPrintServer from the current owner node to node2.
Example 3:
C:\PS>Get-ClusterNode node3 | Get-ClusterGroup | Move-ClusterGroup
Name OwnerNode State
---- ---------
-----
Available Storage node4 Online Cluster Group node1 Online MyPrintServer node1 Online
Description
-----------
This command moves all clustered services and applications (resource groups ) that are currently owned by node3 to other nodes. You can use this command before performing maintenance on the specified node.
Example 4:
C:\PS>Move-ClusterGroup MyPrintServer -Node node2 -Wait 0
Name OwnerNode State
---- ---------
-----
MyPrintServer node2 Pen
ding
Description
-----------
This command moves the clustered service (resource group) called MyPrintServer from the current owner node to node2. Information about MyPrintServer is displayed immediately, while it is in the process of being moved.
CommandLet
Move-ClusterResource
Description
Move a clustered resource from one clustered service or application to another within a failover cluster.
Example 1:
C:\PS>Move-ClusterResource resource1 group2
Name State Group ResourceType
---- ----- ----- ------------
resource1 Offline group2 IP Address
Description
-----------
This command moves the cluster resource called resource1 to the clustered service or application called group2 on the local cluster.
CommandLet
Move-ClusterSharedVolume
Description
Move a Cluster Shared Volume to ownership by a different node in a failover cluster.
Example 1:
C:\PS>Move-ClusterSharedVolume "Cluster Disk 3"
Name State Node
---- ----- ----
Cluster Disk 3 Online node2
Description
-----------
This command moves the Cluster Shared Volume called Cluster Disk 3 to any other cluster node.
Example 2:
C:\PS>Move-ClusterSharedVolume "Cluster Disk 3" -Node node1
Name State Node
---- ----- ----
Cluster Disk 3 Online node1
Description
-----------
This command moves the Cluster Shared Volume called Cluster Disk 3 to node1
.
CommandLet
Move-ClusterVirtualMachineRole
Description
Move the ownership of a clustered virtual machine to a different node.
Example 1:
C:\PS>Move-ClusterVirtualMachineRole "Virtual Machine1" -Node node2
Name OwnerNode State
---- --------- -----
Virtual Machine1 node2 Online
Description
-----------
This command performs a live migration of Virtual Machine1 to node2. The prompt does not return until the action is complete.
Example 2:
C:\PS>Get-ClusterGroup "Virtual Machine1" | Move-ClusterVirtualMachineRole -Node node2 -Wait 0
Name OwnerNode State
---- ---------
-----
Virtual Machine1 node2 Online
Description
-----------
This command performs a live migration of Virtual Machine1 to node2. The prompt returns as soon as the action has been initiated.
Example 3:
C:\PS>Move-ClusterVirtualMachineRole "Virtual Machine1" -Cancel
Name OwnerNode State
---- ---------
-----
Virtual Machine1 node1 Online
Description
-----------
This command cancels the live migration in progress for Virtual Machine1.
Example 4:
C:\PS>$groups = Get-ClusterNode node1 | Get-ClusterGroup | ?{ $_ | Get-Clus terResource | ?{ $_.ResourceType -like "Virtual Machine" } } foreach ( $group in $groups ) { $group | Move-ClusterVirtualMachineRole -No
de node2 }
Name OwnerNode State
---- ---------
-----
Virtual Machine1 node2 Online Virtual Machine2 node2 Online Virtual Machine3 node2 Online
Description
-----------
This command performs a live migration of all clustered virtual machines that are currently owned by node1 to node2. The migration of each VM should complete before the next one is started. You can use this command before performing maintenance on the specified node.
CommandLet
New-Cluster
Description
Create a new failover cluster. Before you can create a cluster, you must connect the hardware (servers, networks, and storage), and run the validationtests.
Example 1:
C:\PS>New-Cluster -Name cluster1 -Node node1,node2,node3,node4
Name
----
cluster1
Description
-----------
This command creates a four-node cluster named cluster1, using default sett
ings for IP addressing.
Example 2:
C:\PS>New-Cluster -Name cluster1 -Node node1,node2 -NoStorage
Name
----
cluster1
Description
-----------
This command creates a two-node cluster named cluster1. The cluster will not have any clustered storage (disk resources). You can add storage later using Get-ClusterAvailableDisk with Add-ClusterDisk.
Example 3:
C:\PS>New-Cluster -Name cluster1 -Node node1,node2,node3,node4 -StaticAddress 2.0.0.123
Name
----
cluster1
Description
-----------
This command creates a four-node cluster named cluster1 that uses the stati
c IP address 2.0.0.123.
Example 4:
C:\PS>New-Cluster -Name cluster1 -Node node1,node2,node3,node4 -StaticAddress 2.0.0.123,3.0.0.123
Name
----
cluster1
Description
-----------
This command creates a four-node cluster named cluster1 that uses the static IP addresses 2.0.0.123 3.0.0.123.
Example 5:
C:\PS>New-Cluster -Name cluster1 -Node node1,node2,node3,node4 -IgnoreNetwork 2.0.0.0/8
Name
----
cluster1
Description
-----------
This command creates a four-node cluster named cluster1. The cluster uses default settings for IP addressing, and does not use the network 2.0.0.0/8.
Example 6:
C:\PS>New-Cluster -Name cluster1 -Node node1,node2,node3,node4 -StaticAddress 2.0.0.123 -IgnoreNetwork 3.0.0.0/8
Name
----
cluster1
Description
-----------
This command creates a four-node cluster named cluster1. The cluster uses the static IP address 2.0.0.123, and does not use the network 3.0.0.0/8.
CommandLet
Remove-Cluster
Description
Destroy an existing failover cluster. The affected servers will no longer function together as a cluster.
Example 1:
C:\PS>Remove-Cluster
Description
-----------
After prompting for confirmation, this command destroys the local failover cluster and removes cluster configuration information from the cluster node
s.
Example 2:
C:\PS>Remove-Cluster -Force
Description
-----------
This command destroys the local failover cluster and removes cluster configuration information from the cluster nodes. The command does not prompt for
confirmation.
Example 3:
C:\PS>Get-Cluster Cluster1 | Remove-Cluster -Force -CleanupAD
Description
-----------
This command destroys Cluster1, removes cluster configuration information from the cluster nodes, and deletes the cluster objects in Active Directory.The command does not prompt for confirmation.
CommandLet
Remove-ClusterAccess
Description
Removes a user from the access list on the cluster.
Example 1:
C:\PS>Remove-ClusterAccess CONTOSO\user2
Description
-----------
This command removes the user CONTOSO\user2 from the access list of the local cluster. After this command runs, the user might still have access to the cluster if the user is part of another user group granted access to the cluster.
CommandLet
Remove-ClusterGroup
Description
Remove a clustered service or application (also called a resource group) from a failover cluster.
Example 1:
C:\PS>Remove-ClusterGroup MyPrintServer
Description
-----------
After prompting for confirmation, this command removes the clustered service MyPrintServer, if the resources have first been removed from it.
Example 2:
C:\PS>Remove-ClusterGroup MyPrintServer -Force
Description
-----------
This command removes the clustered service MyPrintServer, if the resources have first been removed from it. The command does not prompt for confirmation.
Example 3:
C:\PS>Remove-ClusterGroup MyPrintServer -Force -RemoveResources
Description
-----------
This command removes the clustered service MyPrintServer, without prompting for confirmation. Cluster resources in MyPrintServer will be deleted.
CommandLet
Remove-ClusterNode
Description
Remove a node from a failover cluster. After the node is removed, it no longer functions as part of the cluster unless you add it back to the cluster.
Example 1:
C:\PS>Remove-ClusterNode node4
Description
-----------
This command removes node4 from the local cluster.
Example 2:
C:\PS>Remove-ClusterNode node4 -force
Description
-----------
This command removes node4 from the local cluster without prompting for con
firmation.
CommandLet
Remove-ClusterResource
Description
Remove a clustered resource from the failover cluster.
Example 1:
C:\PS>Remove-ClusterResource "Cluster Disk 4"
Description
-----------
After prompting for confirmation, this command deletes Cluster Disk 4 from
the local cluster.
Example 2:
C:\PS>Remove-ClusterResource "Cluster Disk 5" -force
Description
-----------
This command deletes Cluster Disk 5 from the local cluster without prompting for confirmation.
CommandLet
Remove-ClusterResourceDependency
Description
Remove a dependency between two resources in a clustered service or application within a failover cluster.
Example 1:
C:\PS>Remove-ClusterResourceDependency -Resource cluster1FS -Provider "IP Address 2001:4898:9:2:: (3)"
Name State Group ResourceType
---- ----- ----- ------------
cluster1FS Online cluster1FS Network Name
Description
-----------
This command removes the dependency between cluster resource cluster1FS and resource "IP Address 2001:4898:9:2:: (3)".
Example 2:
C:\PS>Get-ClusterResource cluster1FS | Remove-ClusterResourceDependency "IP Address 2001:4898:9:2:: (3)"
Name State Group ResourceType
---- ----- ----- ------------
cluster1FS Online cluster1FS Network Name
Description
-----------
This command removes the dependency between cluster resource cluster1FS and resource "IP Address 2001:4898:9:2:: (3)".
CommandLet
Remove-ClusterResourceType
Description
Remove a resource type from a failover cluster.
Example 1:
C:\PS>Remove-ClusterResourceType ResType1
Description
-----------
This command removes the registered resource type ResType1 on the local cluster.
CommandLet
Remove-ClusterSharedVolume
Description
Remove a volume from the Cluster Shared Volumes in a failover cluster, and place it in Available Storage in the cluster.
Example 1:
C:\PS>Remove-ClusterSharedVolume "Cluster Disk 3"
Name State Group ResourceType
---- ----- ----- ------------
Cluster Disk 3 Online Available Storage Physical Disk
Description
-----------
This command removes Cluster Disk 3 from the Cluster Shared Volumes on the local cluster, and places it in Available Storage.
Example 2:
C:\PS>Get-ClusterSharedVolume "Cluster Disk 4" | Remove-ClusterSharedVolume
Name State Group ResourceType
---- ----- ----- ------------
Cluster Disk 4 Online Available Storage Physical Disk
Description
-----------
This command removes Cluster Disk 4 from the Cluster Shared Volumes on the local cluster, and places it in Available Storage.
CommandLet
Repair-ClusterSharedVolume
Description
Run repair tools on a Cluster Shared Volume locally on a cluster node.
Example 1:
C:\PS>Repair-ClusterSharedVolume C:\ClusterStorage\Volume1 -Defrag
Description
-----------
This command runs defrag.exe on Cluster Shared Volume C:\ClusterStorage\Volume1.
Example 2:
C:\PS>Repair-ClusterSharedVolume C:\ClusterStorage\Volume1 -ChkDsk -Parameters "/F"
Description
-----------
This command runs chkdsk.exe on Cluster Shared Volume C:\ClusterStorage\Volume1 and passes "/F" to the chkdsk.exe command line.
CommandLet
Resume-ClusterNode
Description
Resume activity on a failover cluster node after you have suspended it (that is, paused it).
Example 1:
C:\PS>Resume-ClusterNode node1
Name State
---- -----
node1 Up
Description
-----------
This command resumes node1 on the local cluster.
Example 2:
C:\PS>Resume-ClusterNode node2 -Cluster mycluster
Name State
----
-----
node2
Up
Description
-----------
This command resumes node2 on the cluster called mycluster.
Example 3:
C:\PS>Get-ClusterNode | Resume-ClusterNode
Name State
---- -----
node1 Up
Description
-----------
This command resumes all cluster nodes that are suspended (paused) on the local cluster.
CommandLet
Resume-ClusterResource
Description
Turn off maintenance for a disk resource or Cluster Shared Volume within a failover cluster.
Example 1:
C:\PS>Resume-ClusterResource "Cluster Disk 2"
Name State Group ResourceType
---- ----- ----- ------------
Cluster Disk 2 Online Available Storage Physical Disk
Description
-----------
This command turns off maintenance for Cluster Disk 2.
Example 2:
C:\PS>Get-ClusterSharedVolume "Cluster Disk 5" | Resume-ClusterResource
Name State Node
---- ----- ----
Cluster Disk 5 Online node2
Description
-----------
This command turns off maintenance for all volumes on the Cluster Shared Volume "Cluster Disk 5."
CommandLet
Set-ClusterLog
Description
Set the size and level of detail for the cluster log.
Example 1:
C:\PS>Set-ClusterLog -Level 1
Name
----
cluster1
Description
-----------
This command sets the cluster log to level 1 of detail.
Example 2:
C:\PS>Set-ClusterLog -Size 1024
Name
----
cluster1
Description
-----------
This command sets the cluster log size to 1024MB.
CommandLet
Set-ClusterOwnerNode
Description
For a resource in a failover cluster, specify which nodes can own the resource. For a clustered service or application (a resource group), specify information about the order of preference among owner nodes.
Example 1:
C:\PS>Get-ClusterResource "Cluster Disk 3" | Set-ClusterOwnerNode -Owners node1,node2
Description
-----------
This command sets the possible owners for Cluster Disk 3 on the local cluster to node1 and node2.
Example 2:
C:\PS>Set-ClusterOwnerNode -Group cluster12FS -Owners node3,node2
Description
-----------
This command sets the preferred owners for the clustered service cluster12FS to node3 followed by node2 on the local cluster.
CommandLet
Set-ClusterParameter
Description
Control specific properties of an object in a failover cluster, such as a resource, a group, or a network.
Example 1:
C:\PS>Get-ClusterResource cluster1FS | Set-ClusterParameter HostRecordTTL 300
Description
-----------
This command configures the clustered resource called cluster1FS on the local cluster, by setting the value of HostRecordTTL to 300.
Example 2:
C:\PS>$res = Get-ClusterResource "IP Address"
$param1 = New-Object Microsoft.FailoverClusters.PowerShell.ClusterParameter
$res,Address,10.55.88.46
$param2 = New-Object Microsoft.FailoverClusters.PowerShell.ClusterParameter
$res,SubnetMask,255.0.0.0
$params = $param1,$param2
$params | Set-ClusterParameter
Description
-----------
This command configures the clustered resource called "IP Address" to use a new static IP. Because the new address and subnet mask are required, both parameters must be passed to Set-ClusterParameter together.
CommandLet
Set-ClusterQuorum
Description
Configure quorum options for a failover cluster.
Example 1:
C:\PS>Set-ClusterQuorum -NodeMajority
Cluster QuorumResource Quorum Type
------- -------------- ------ ----
cluster1 NodeMajority
Description
-----------
This command changes the quorum configuration to Node Majority on the local cluster.
Example 2:
C:\PS>Set-ClusterQuorum -NodeAndDiskMajority "Cluster Disk 7"
Cluster QuorumResource Quorum Type
------- -------------- ------ ----
cluster1 Cluster Disk 7 NodeAndDiskMajority
Description
-----------
This command changes the quorum configuration to Node and Disk Majority on the local cluster, using Cluster Disk 7 for the disk witness.
Example 3:
C:\PS>Set-ClusterQuorum -NodeAndFileShareMajority \\fileserver\fsw
Cluster QuorumResource Quorum Type
------- -------------- ------ ----
cluster1 File Share Witness NodeAndFileShareMajority
Description
-----------
This command changes the quorum configuration to Node and File Share Majority on the local cluster, using \\fileserver\fsw for the file share witness.
CommandLet
Set-ClusterResourceDependency
Description
Specify the resources that a particular resource depends on within a failover cluster. Existing dependencies will be overwritten by the dependencies that you specify.
Example 1:
C:\PS>Set-ClusterResourceDependency cluster1FS12 "[IP Address 151.56.48.0]"
Description
-----------
This command makes the resource called cluster1FS12 dependent on [IP Address 151.56.48.0].
Example 2:
C:\PS>Set-ClusterResourceDependency cluster1FS12 "[IP Address 151.56.48.0] or [New IP Address]"
Description
-----------
This command makes the resource called cluster1FS12 dependent on either [IP Address 151.56.48.0] or [New IP Address].
Example 3:
C:\PS>Set-ClusterResourceDependency cluster1FS12 ""
Description
-----------
This command clears the dependency list for the resource cluster1FS12, so that it no longer depends on any other resources.
CommandLet
Start-Cluster
Description
Start the Cluster service on all nodes of the cluster on which it is not yet started.
Example 1:
C:\PS>Start-Cluster
Name
----
mycluster
Description
-----------
This command starts all cluster nodes on the local cluster.
Example 2:
C:\PS>Start-Cluster node2
Name
----
mycluster
Description
-----------
This command starts all cluster nodes on the cluster which node node2 is part of. A node name is required if all cluster nodes are stopped. If the cluster is already up, then the cluster name (assuming the cluster name resource is online) can be used instead of the node name.
CommandLet
Start-ClusterGroup
Description
Bring one or more clustered services and applications (also known as resource groups) online on a failover cluster.
Example 1:
C:\PS>Start-ClusterGroup FileServer1
Name OwnerNode State
---- --------- -----
FileServer1 node1 Online
Description
-----------
This command brings the clustered file server (resource group) called FileServer1 online.
Example 2:
C:\PS>Start-ClusterGroup FileServer1 -Wait 0
Name OwnerNode State
---- ---------
-----
FileServer1 node1 Pen
ding
Description
-----------
This command brings the clustered file server (resource group) called FileS erver1 online. The prompt returns as soon as the action has been initiated.
CommandLet
Start-ClusterNode
Description
Start the Cluster service on a node in a failover cluster.
Example 1:
C:\PS>Start-ClusterNode node3
Name State
---- -----
node3 Joining
Description
-----------
This command starts the Cluster service on node3 of the local cluster.
Example 2:
C:\PS>Start-ClusterNode node1 -Cluster cluster2
Name State
---- -----
node1 Joining
Description
-----------
This command starts the Cluster service on node1 of cluster2.
Example 3:
C:\PS>Start-ClusterNode -FixQuorum
Name State
----
-----
node1 Joi
ning
Description
-----------
This command forces the local node and the local cluster to start, even if quorum has not been achieved. If quorum has not been achieved, the copy of the cluster configuration that is on the local node will be treated as the authoritative copy and will be replicated to all other nodes. This command should be considered a last resort, because some cluster configuration changes could be lost.
CommandLet
Start-ClusterResource
Description
Bring a resource online in a failover cluster.
Example 1:
C:\PS>Start-ClusterResource "IP Address 172.24.11.0"
Name State Group ResourceType
---- ----- ----- ------------
IP Address 172.2... Online cluster1FS12 IP Address
Description
-----------
This command brings the resource called "IP Address 172.24.11.0" online on the local cluster. Before bringing the resource online, it brings online any resources that the resource depends on.
Example 2:
C:\PS>Start-ClusterResource "IP Address 172.24.11.0" -Wait 0
Name State Group ResourceType
---- ----- ----- ------------
IP Address 172.2... OnlinePending cluster1FS12 IP Address
Description
-----------
This command brings the resource called "IP Address 172.24.11.0" online on the local cluster. Before bringing the resource online, it brings online any resources that the resource depends on. The prompt returns as soon as the action has been initiated.
CommandLet
Stop-Cluster
Description
Stop the Cluster service on all nodes in a failover cluster, which will stop all services and applications configured in the cluster.
Example 1:
C:\PS>Stop-Cluster
Description
-----------
This command stops the Cluster service on all nodes in the local cluster, which will stop all services and applications configured in the cluster.
Example 2:
C:\PS>Stop-Cluster cluster1
Description
-----------
This command stops the Cluster service on all nodes in cluster1, which will stop all services and applications configured in the cluster.
CommandLet
Stop-ClusterGroup
Description
Take one or more clustered services and applications (also known as resource groups) offline on a failover cluster.
Example 1:
C:\PS>Stop-ClusterGroup FileServer1
Name OwnerNode State
---- ---------
-----
FileServer1 node1 Of
fline
Description
-----------
This command takes the clustered file server (resource group) called FileServer1 offline on the local cluster.
CommandLet
Stop-ClusterNode
Description
Stop the Cluster service on a node in a failover cluster.
Example 1:
C:\PS>Stop-ClusterNode node3
Name State
----
-----
node3 Down
Description
-----------
This command stops the Cluster service on node3 of the local cluster.
Example 2:
C:\PS>Stop-ClusterNode node1 -Cluster cluster2
Name State
----
-----
node1
Down
Description
-----------
This command stops the Cluster service on node1 of cluster2.
CommandLet
Stop-ClusterResource
Description
Take a resource offline in a failover cluster.
Example 1:
C:\PS>Stop-ClusterResource "IP Address 172.24.11.0"
Name State Group ResourceType
---- ----- ----- ------------
IP Address 172.2... Offline cluster1FS12 IP Address
Description
-----------
This command takes the resource called "IP Address 172.24.11.0" offline on the local cluster. Before taking the resource offline, it takes offline any dependent resources.
CommandLet
Suspend-ClusterNode
Description
Suspend activity on a failover cluster node, that is, pause the node.
Example 1:
C:\PS>Suspend-ClusterNode node1
Name State
----
-----
node1 Pa
used
Description
-----------
This command pauses node1 on the local cluster.
Example 2:
C:\PS>Suspend-ClusterNode node2 -Cluster cluster2
Name State
----
-----
node2 Pa
used
Description
-----------
This command pauses node2 on cluster2.
CommandLet
Suspend-ClusterResource
Description
Turn on maintenance for a disk resource or Cluster Shared Volume so that you can run a disk maintenance tool without triggering failover.
Example 1:
C:\PS>Suspend-ClusterResource "Cluster Disk 2"
Name State Group ResourceType
---- ----- ----- ------------
Cluster Disk 2 Online(Maintenance) Available Storage Physical Disk
Description
-----------
This command turns on maintenance for Cluster Disk 2 so that you can run a disk maintenance tool without triggering failover.
Example 2:
C:\PS>Get-ClusterSharedVolume "Cluster Disk 5" | Suspend-ClusterResource
Name State Node
---- ----- ----
Cluster Disk 5 Online node2
Description
-----------
This command turns on maintenance for all volumes on the Cluster Shared Volume "Cluster Disk 5."
CommandLet
Test-Cluster
Description
Run validation tests for failover cluster hardware and settings. Tests can be run both before and after a cluster is set up.
Example 1:
C:\PS>Test-Cluster
Mode LastWriteTime Length Name
---- ------------- ------ ----
-a--- 10/10/2008 6:31 PM 1132255 Test-Cluster on 2008.10.10 At 18.2 2.53.mht
Description
-----------
This command runs all applicable cluster validation tests on the local cluster.
Example 2:
C:\PS>Test-Cluster -Node node1,node2
Mode LastWriteTime Length Name
---- ------------- ------ ----
-a--- 10/10/2008 6:18 PM 998032 Test-Cluster on 2008.10.10 At 18.0 8.24.mht
Description
-----------
This command runs all cluster validation tests on node1 and node2. If either node1 or node2 is already a member of a cluster, the tests will include all nodes in that cluster.
Example 3:
C:\PS>Test-Cluster -List
Category DisplayName Description
-------- ----------- -----------
Cluster Configuration List Cluster Core Groups List information about...
Cluster Configuration List Cluster Network In... List cluster-specific ...
Cluster Configuration List Cluster Resources List the resources tha...
Cluster Configuration List Cluster Volumes List information for ...
Cluster Configuration List Clustered Services... List information about...
Cluster Configuration Validate Quorum Configu... Validate that the curr...
Cluster Configuration Validate Resource Status Validate that cluster ...
Cluster Configuration Validate Service Princi... Validate that a Servic...
Cluster Configuration Validate Volume Consist... If any volumes are fla...
Inventory List BIOS Information List BIOS information ...
Inventory List Environment Variables List environment varia...
Inventory List Fibre Channel Host... List Fibre Channel hos...
Inventory List iSCSI Host Bus Ada... List iSCSI host bus ad...
Inventory List Memory Information List memory informatio...
Inventory List Operating System I... List information about...
Inventory List Plug and Play Devices List Plug and Play dev...
Inventory List Running Processes List the running proce...
Inventory List SAS Host Bus Adapters List Serial Attached S...
Inventory List Services Information List information about...
Inventory List Software Updates List software updates ...
Inventory List System Drivers List the system driver...
Inventory List System Information List system informatio...
Inventory List Unsigned Drivers List the unsigned driv...
Network List Network Binding Order List the order in whic...
Network Validate Cluster Networ... Validate the cluster n...
Network Validate IP Configuration Validate that IP addre...
Network Validate Multiple Subne... For clusters using mul...
Network Validate Network Commun... Validate that servers ...
Network Validate Windows Firewa... Validate that the Wind...
Storage List All Disks List all disks visible...
Storage List Potential Cluster ... List disks visible to ...
Storage Validate Disk Access La... Validate acceptable la...
Storage Validate Disk Arbitration Validate that a node t...
Storage Validate Disk Failover Validate that a disk c...
Storage Validate File System Validate that the file...
Storage Validate Microsoft MPIO... Validate that Microsof...
Storage Validate Multiple Arbit... Validate that in a mul...
Storage Validate SCSI device Vi... Validate that storage ...
Storage Validate SCSI-3 Persist... Validate that storage ...
Storage Validate Simultaneous F... Validate that disks ca...
System Configuration Validate Active Directo... Validate that all the ...
System Configuration Validate All Drivers Si... Validate that tested s...
System Configuration Validate Cluster Servic... Validate startup sett i...
System Configuration Validate Memory Dump Se... Validate that none of ...
System Configuration Validate Operating Syst... Validate that the oper...
System Configuration Validate Required Services Validate that service s...
System Configuration Validate Same Processor... Validate that all ser v...
System Configuration Validate Service Pack L... Validate that all ser v...
System Configuration Validate Software Updat... Validate that all test...
System Configuration Validate System Drive V... Validate that all node...
Description
-----------
This command lists the names of all tests and categories in cluster validation. You can then specify these test names with -Ignore or -Include to run specific tests.
Example 4:
C:\PS>Test-Cluster -Node node1,node2 -Include Storage
Mode LastWriteTime Length Name
---- ------------- ------ ----
-a--- 10/10/2008 6:20 PM 37818 Test-Cluster on 2008.10.10 At 18.2
0.52.mht
Description
-----------
This command runs the storage validation tests on node1 and node2. If either node1 or node2 is already a member of a cluster, the tests will include all nodes in that cluster.
Example 5:
C:\PS>Test-Cluster -Node node1,node2 -Ignore Inventory
Mode LastWriteTime Length Name
---- ------------- ------ ----
-a--- 10/10/2008 6:20 PM 732889 Test-Cluster on 2008.10.10 At
18.1
9.47.mht
Description
-----------
This command runs all validation tests except the Inventory tests on node1 and node2. If either node1 or node2 is already a member of a cluster, the tests will include all nodes in that cluster.
Example 6:
C:\PS>Test-Cluster -Include "List Potential Cluster Disks"
Mode LastWriteTime Length Name
---- ------------- ------ ----
-a--- 10/15/2008 2:58 PM 36119 Test-Cluster on 2008.10.15 At 14.5 8.44.mht
Description
-----------
This command runs the test called "List Potential Cluster Disks" on the local cluster.
Example 7:
C:\PS>Test-Cluster -Include "List System Drivers","List Unsigned Drivers"
Mode LastWriteTime Length Name
---- ------------- ------ ----
-a--- 10/15/2008 3:00 PM 266571 Test-Cluster on 2008.10.15 At
15.0
0.08.mht
Description
-----------
This command runs the tests called "List System Drivers" and "List Unsigned Drivers" on the local cluster.
CommandLet
Test-ClusterResourceFailure
Description
Simulate a failure of a cluster resource.
Example 1:
C:\PS>Test-ClusterResourceFailure "Cluster Disk 4"
Name State Group ResourceType
---- ----- ----- ------------
Cluster Disk 4 Failed cluster12FS Physical Disk
Description
-----------
This command simulates a failure in cluster resource "Cluster Disk 4".
CommandLet
Update-ClusterIPResource
Description
Renew or release the DHCP lease for an IP address resource in a failover cluster.
Example 1:
C:\PS>Update-ClusterIPResource "Cluster IP Address"
Name State Group ResourceType
---- ----- ----- ------------
Cluster IP Address Online Cluster Group IP Address
Description
-----------
This command updates the DHCP lease for the resource called "Cluster IP Address" if this resource is DHCP assigned.
Example 2:
C:\PS>Get-ClusterResource | ?{ $_.ResourceType.Name -eq "IP Address" } | Update-ClusterIPResource
Name State Group ResourceType
---- ----- ----- ------------
Cluster IP Address Online Cluster Group IP Address
IP Address 172.2... Online cluster1-Other IP Address
IP Address 172.2... Online cluster1-FS IP Address
Description
-----------
This command updates the DHCP lease for all the clustered IP resource(s) that are DHCP assigned.
Example 3:
C:\PS>Get-ClusterResource "IP Address 172.24.11.0" | Stop-ClusterResource |
Update-ClusterIPResource -Release
Name State Group ResourceType
---- ----- ----- ------------
IP Address 172.2... Offline cluster1-Other IP Address
Description
-----------
This command takes the resource "IP Address 172.24.11.0" offline, and releases the DHCP lease for that resource.
CommandLet
Update-ClusterVirtualMachineConfiguration
Description
Refresh the configuration of a clustered virtual machine within a failover cluster.
Example 1:
C:\PS>Update-ClusterVirtualMachineConfiguration "Virtual Machine Configuration VM1"
Name State Group ResourceType
---- ----- ----- ------------
Virtual Machine ... Online Virtual Machine Virtual Machine
...
Description
-----------
This command refreshes "Virtual Machine Configuration VM1" on the local cluster.
Example 2:
C:\PS>Update-ClusterVirtualMachineConfiguration "Virtual Machine Configuration VM2" -Cluster cluster1
Name State Group ResourceType
---- ----- ----- ------------
Virtual Machine ... Online Virtual Machine Virtual Machine
...
Description
-----------
This command refreshes "Virtual Machine Configuration VM2" on cluster1.