FailoverClusters
This reference provides cmdlet descriptions and syntax for all failover cluster-specific cmdlets. It
lists the cmdlets in alphabetical order based on the verb at the beginning of the cmdlet. If these
cmdlets aren't available in your PowerShell session, you may need to add the
Failover Cluster Module for Windows PowerShell Feature, using the following PowerShell cmd:
Add-WindowsFeature RSAT-Clustering-PowerShell.
FailoverClusters
| Add-ClusterCheckpoint |
Adds a cryptographic key checkpoint or registry checkpoint for a resource. |
| Add-ClusterDisk |
Makes a new disk available for use in a failover cluster. |
| Add-ClusterExcludedAdapter |
Adds a network adapter to the list of excluded adapters. |
| Add-ClusterFileServerRole |
Creates a clustered file server resource group. |
| Add-ClusterGenericApplicationRole |
Configures high availability for an application that wasn't originally designed to run in a failover cluster. |
| Add-ClusterGenericScriptRole |
Configures an application controlled by a script that runs in Windows Script Host, within a failover cluster. |
| Add-ClusterGenericServiceRole |
Configures high availability for a service that wasn't originally designed to run in a failover cluster. |
| Add-ClusterGroup |
Adds an empty resource group to the failover cluster configuration, in preparation for adding clustered resources to the group. |
| Add-ClusterGroupSetDependency |
Adds a dependency to a cluster set. |
| Add-ClusterGroupToAffinityRule |
Adds a cluster group to an affinity rule. |
| Add-ClusterGroupToSet |
Adds a group to a set. |
| Add-ClusteriSCSITargetServerRole |
Creates a highly available iSCSI Target server. |
| Add-ClusterNode |
Adds a node (server) to a failover cluster. |
| Add-ClusterResource |
Adds a resource to a clustered role, or resource group, in a failover cluster. |
| Add-ClusterResourceDependency |
Adds a resource to the list of resources on which a particular resource depends, using AND as the connector, within a failover cluster. |
| Add-ClusterResourceType |
Adds a resource type to a failover cluster, and specifies information such as the dynamic-link library (DLL) to use with that resource type. |
| Add-ClusterScaleOutFileServerRole |
Creates a clustered file server for scale-out application data. |
| Add-ClusterSharedVolume |
Makes a volume available in Cluster Shared Volumes in a failover cluster. |
| Add-ClusterSharedVolumeToAffinityRule |
Adds a Cluster Shared Volume (CSV) to an existing affinity rule. |
| Add-ClusterVirtualMachineRole |
Creates a clustered virtual machine, that is, a virtual machine that can be failed over if necessary to a different server in the failover cluster. |
| Add-ClusterVMMonitoredItem |
Configures monitoring for a service or an Event Tracing for Windows (ETW) event so that it is monitored on a virtual machine. |
| Add-WorkgroupClusterNode |
Adds a node to a workgroup cluster. |
| Block-ClusterAccess |
Prevents the specified user or users from accessing a failover cluster. |
| Clear-ClusterDiskReservation |
Clears the persistent reservation on a disk in a failover cluster. |
| Clear-ClusterNode |
Clears the cluster configuration from a node that was evicted from a failover cluster. |
| Disable-ClusterStorageSpacesDirect |
Disables S2D. |
| Enable-ClusterStorageSpacesDirect |
Enables Storage Spaces Direct on a Fail-Over Cluster. |
| Get-Cluster |
Gets information about one or more failover clusters in a given domain. |
| Get-ClusterAccess |
Gets information about permissions that control access to a failover cluster. |
| Get-ClusterAffinityRule |
This cmdlet is used to display the given rule and what type it is. |
| Get-ClusterAvailableDisk |
Gets information about the disks that can support Failover Clustering and are visible to all nodes, but aren't yet part of the set of clustered disks. |
| Get-ClusterCheckpoint |
Retrieves a cryptographic key checkpoint or registry checkpoint for a resource. |
| Get-ClusterCredential |
Retrieves the credentials for a specified node in a failover cluster. |
| Get-ClusterDiagnosticInfo |
Gets diagnostics for a cluster a cluster that contains VMs and produces a zip file containing the data. |
| Get-ClusterExcludedAdapter |
Retrieves a network adapter from the list of excluded adapters. |
| Get-ClusterFaultDomain |
Gets the cluster fault domains in a cluster. |
| Get-ClusterFaultDomainXML |
Gets the fault domain as an XML string. |
| Get-ClusterGroup |
Gets information about one or more clustered roles (resource groups) in a failover cluster. |
| Get-ClusterGroupSet |
Gets the group sets in the cluster. |
| Get-ClusterGroupSetDependency |
Gets the cluster group sets based on dependency relationships. |
| Get-ClusterLog |
Creates a log file for all nodes, or a specific a node, in a failover cluster. |
| Get-ClusterNetwork |
Gets information about one or more networks in a failover cluster. |
| Get-ClusterNetworkInterface |
Gets information about one or more network adapters in a failover cluster. |
| Get-ClusterNode |
Gets information about one or more nodes, or servers, in a failover cluster. |
| Get-ClusterOwnerNode |
Gets information about which nodes can own a resource in a failover cluster or information about the order of preference among owner nodes for a clustered role. |
| Get-ClusterParameter |
Gets detailed information about an object in a failover cluster, such as a cluster resource. |
| Get-ClusterQuorum |
Gets information about the quorum configuration of a failover cluster. |
| Get-ClusterResource |
Gets information about one or more resources in a failover cluster. |
| Get-ClusterResourceDependency |
Gets information about the dependencies that have been configured between clustered resources in a failover cluster. |
| Get-ClusterResourceDependencyReport |
Generates a report that lists the dependencies between resources in a failover cluster. |
| Get-ClusterResourceType |
Gets information about one or more resource types in a failover cluster. |
| Get-ClusterSharedVolume |
Gets information about Cluster Shared Volumes in a failover cluster. |
| Get-ClusterSharedVolumeState |
Gets the state of Cluster Shared Volumes in a cluster. |
| Get-ClusterStorageSpacesDirect |
Gets the S2D settings from a cluster. |
| Get-ClusterVMMonitoredItem |
Gets the list of services and events currently being monitored in the virtual machine. |
| Grant-ClusterAccess |
Grants access to a failover cluster, either full access or read-only access. |
| Move-ClusterGroup |
Moves a clustered role (a resource group) from one node to another in a failover cluster. |
| Move-ClusterResource |
Moves a clustered resource from one clustered role to another within a failover cluster. |
| Move-ClusterSharedVolume |
Moves a Cluster Shared Volume (CSV) to ownership by a different node in a failover cluster. |
| Move-ClusterVirtualMachineRole |
Moves the ownership of a clustered virtual machine to a different node. |
| New-Cluster |
Creates a new failover cluster. |
| New-ClusterAffinityRule |
Creates new affinity rules. |
| New-ClusterFaultDomain |
Creates a fault domain in the cluster. |
| New-ClusterGroupSet |
Create a names set of groups in the cluster. |
| New-ClusterNameAccount |
Creates a cluster name account in Active Directory Domain Services. |
| New-WorkgroupCluster |
Creates a new workgroup cluster. |
| Remove-Cluster |
Destroys an existing failover cluster. |
| Remove-ClusterAccess |
Removes a user from the access list on the cluster. |
| Remove-ClusterAffinityRule |
Removes a specified affinity rule. |
| Remove-ClusterCheckpoint |
Removes a cryptographic key checkpoint or registry checkpoint for a resource. |
| Remove-ClusterExcludedAdapter |
Removes a network adapter from the list of excluded adapters. |
| Remove-ClusterFaultDomain |
Removes a fault domain. |
| Remove-ClusterGroup |
Removes a clustered role, also called a resource group, from a failover cluster. |
| Remove-ClusterGroupFromAffinityRule |
Removes a cluster group from an affinity rule. |
| Remove-ClusterGroupFromSet |
Removes a group from a set. |
| Remove-ClusterGroupSet |
Removes a group set from the cluster. |
| Remove-ClusterGroupSetDependency |
Removes a dependency from a group set. |
| Remove-ClusterNode |
Removes a node from a failover cluster. |
| Remove-ClusterResource |
Removes a clustered resource from the failover cluster. |
| Remove-ClusterResourceDependency |
Removes a dependency between two resources in a clustered role within a failover cluster. |
| Remove-ClusterResourceType |
Removes a resource type from a failover cluster. |
| Remove-ClusterSharedVolume |
Removes a volume from the Cluster Shared Volumes in a failover cluster, and places it in Available Storage in the cluster. |
| Remove-ClusterSharedVolumeFromAffinityRule |
Remove a cluster shared volume from an affinity rule. |
| Remove-ClusterVMMonitoredItem | |
| Remove-WorkgroupCluster |
Removes a workgroup cluster. |
| Remove-WorkgroupClusterNode |
Removes a node from a workgroup cluster. |
| Repair-ClusterNameAccount |
Repairs the Cluster Name Account and ensures that the cluster continues to function properly. |
| Repair-ClusterStorageSpacesDirect |
Repairs disks in a Storage Spaces Direct (S2D) system. |
| Reset-ClusterVMMonitoredState |
Resets the Application Critical state of a virtual machine, so that the virtual machine is no longer marked as being in a critical state in the cluster. |
| Resume-ClusterNode |
Resumes a node from the paused state or brings back drained workloads to the node or both. |
| Resume-ClusterResource |
Turns off maintenance for a disk resource or Cluster Shared Volume within a failover cluster. |
| Set-ClusterAffinityRule |
Enable or disable an affinity rule, and update the rule type. |
| Set-ClusterExcludedAdapter |
Sets a network adapter to the list of excluded adapters. |
| Set-ClusterFaultDomain |
Update an existing cluster fault domain. |
| Set-ClusterFaultDomainXML |
Sets the cluster fault domain using XML. |
| Set-ClusterGroupSet |
Updates a cluster group set. |
| Set-ClusterLog |
Sets the size and level of detail for the cluster log. |
| Set-ClusterOwnerNode |
Specifies which nodes can own a resource in a failover cluster or specifies the order of preference among owner nodes for a clustered role, or resource group. |
| Set-ClusterParameter |
Controls specific properties of an object in a failover cluster, such as a resource, a group, or a network. |
| Set-ClusterQuorum |
Configures quorum options for a failover cluster. |
| Set-ClusterResourceDependency |
Specifies the resources that a particular resource depends on within a failover cluster. |
| Set-ClusterStorageSpacesDirect |
Sets S2D cache parameters. |
| Set-ClusterStorageSpacesDirectDisk |
Configures the system to enable S2D to claim or not claim specific physical disks. |
| Set-WorkgroupClusterRemotingConfiguration |
Configures the remote management settings for a failover cluster that is part of a workgroup. |
| Start-Cluster |
Starts the Cluster service on all nodes of the cluster on which it isn't yet started. |
| Start-ClusterGroup |
Starts one or more clustered roles, also known as resource groups, on a failover cluster. |
| Start-ClusterNode |
Starts the Cluster service on a node in a failover cluster. |
| Start-ClusterResource |
Brings a resource online in a failover cluster. |
| Stop-Cluster |
Stops the Cluster service on all nodes in a failover cluster, which will stop all services and applications configured in the cluster. |
| Stop-ClusterGroup |
Stops one or more clustered roles on a failover cluster. |
| Stop-ClusterNode |
Stops the Cluster service on a node in a failover cluster. |
| Stop-ClusterResource |
Takes a resource offline in a failover cluster. |
| Suspend-ClusterNode |
Suspends activity on a failover cluster node, that is, pauses the node. |
| Suspend-ClusterResource |
Turns on maintenance for a disk resource or CSV so that you can run a disk maintenance tool without triggering failover. |
| Test-Cluster |
Runs validation tests for failover cluster hardware and settings. |
| Test-ClusterResourceFailure |
Simulates a failure of a cluster resource. |
| Test-WorkgroupCluster |
Tests the configuration of a workgroup cluster. |
| Test-WorkgroupClusterRemoting |
Tests if remoting is configured on all nodes. |
| Update-ClusterFunctionalLevel |
Updates the functional level of a mixed-version cluster. |
| Update-ClusterIPResource |
Renews or releases the DHCP lease for an IP address resource in a failover cluster. |
| Update-ClusterNetworkNameResource |
Registers existing Network Name resources with a DNS server in a way that doesn't interrupt cluster availability. |
| Update-ClusterVirtualMachineConfiguration |
Refreshes the configuration of a clustered virtual machine within a failover cluster. |