FailoverClusters

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-ClusterCheckpointAdds a cryptographic key checkpoint or registry checkpoint for a resource.
Add-ClusterDiskMakes a new disk available for use in a failover cluster.
Add-ClusterFileServerRoleCreates a clustered file server resource group.
Add-ClusterGenericApplicationRoleConfigures high availability for an application that was not originally designed to run in a failover cluster.
Add-ClusterGenericScriptRoleConfigures an application controlled by a script that runs in Windows Script Host, within a failover cluster.
Add-ClusterGenericServiceRoleConfigures high availability for a service that was not originally designed to run in a failover cluster.
Add-ClusterGroupAdds an empty resource group to the failover cluster configuration, in preparation for adding clustered resources to the group.
Add-ClusterGroupSetDependencyAdds a dependency to a cluster set.
Add-ClusterGroupToSetAdds a group to a set.
Add-ClusterNodeAdds a node (server) to a failover cluster.
Add-ClusterResourceAdds a resource to a clustered role, or resource group, in a failover cluster.
Add-ClusterResourceDependencyAdds a resource to the list of resources on which a particular resource depends, using AND as the connector, within a failover cluster.
Add-ClusterResourceTypeAdds a resource type to a failover cluster, and specifies information such as the dynamic-link library (DLL) to use with that resource type.
Add-ClusterScaleOutFileServerRoleCreates a clustered file server for scale-out application data.
Add-ClusterSharedVolumeMakes a volume available in Cluster Shared Volumes in a failover cluster.
Add-ClusterVMMonitoredItemConfigures monitoring for a service or an Event Tracing for Windows (ETW) event so that it is monitored on a virtual machine.
Add-ClusterVirtualMachineRoleCreates 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-ClusteriSCSITargetServerRoleCreates a highly available iSCSI Target server.
Block-ClusterAccessPrevents the specified user or users from accessing a failover cluster.
Clear-ClusterDiskReservationClears the persistent reservation on a disk in a failover cluster.
Clear-ClusterNodeClears the cluster configuration from a node that was evicted from a failover cluster.
Disable-ClusterStorageSpacesDirectDisables S2D.
Enable-ClusterStorageSpacesDirectEnables S2D.
Get-ClusterGets information about one or more failover clusters in a given domain.
Get-ClusterAccessGets information about permissions that control access to a failover cluster.
Get-ClusterAvailableDiskGets 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.
Get-ClusterCheckpointRetrieves a cryptographic key checkpoint or registry checkpoint for a resource.
Get-ClusterDiagnosticInfoGets diagnostics for a cluster a cluster that contains VMs and produces a zip file containing the data.
Get-ClusterFaultDomainGets the cluster fault domains in a cluster.
Get-ClusterFaultDomainXMLGets the fault domain as an XML string.
Get-ClusterGroupGets information about one or more clustered roles (resource groups) in a failover cluster.
Get-ClusterGroupSetGets the group sets in the cluster.
Get-ClusterGroupSetDependencyGets the cluster group sets based on dependency relationships.
Get-ClusterLogCreates a log file for all nodes, or a specific a node, in a failover cluster.
Get-ClusterNetworkGets information about one or more networks in a failover cluster.
Get-ClusterNetworkInterfaceGets information about one or more network adapters in a failover cluster.
Get-ClusterNodeGets information about one or more nodes, or servers, in a failover cluster.
Get-ClusterOwnerNodeGets 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-ClusterParameterGets detailed information about an object in a failover cluster, such as a cluster resource.
Get-ClusterQuorumGets information about the quorum configuration of a failover cluster.
Get-ClusterResourceGets information about one or more resources in a failover cluster.
Get-ClusterResourceDependencyGets information about the dependencies that have been configured between clustered resources in a failover cluster.
Get-ClusterResourceDependencyReportGenerates a report that lists the dependencies between resources in a failover cluster.
Get-ClusterResourceTypeGets information about one or more resource types in a failover cluster.
Get-ClusterSharedVolumeGets information about Cluster Shared Volumes in a failover cluster.
Get-ClusterSharedVolumeStateGets the state of Cluster Shared Volumes in a cluster.
Get-ClusterStorageSpacesDirectGets the S2D settings from a cluster.
Get-ClusterVMMonitoredItemGets the list of services and events currently being monitored in the virtual machine.
Grant-ClusterAccessGrants access to a failover cluster, either full access or read-only access.
Move-ClusterGroupMoves a clustered role (a resource group) from one node to another in a failover cluster.
Move-ClusterResourceMoves a clustered resource from one clustered role to another within a failover cluster.
Move-ClusterSharedVolumeMoves a Cluster Shared Volume (CSV) to ownership by a different node in a failover cluster.
Move-ClusterVirtualMachineRoleMoves the ownership of a clustered virtual machine to a different node.
New-ClusterCreates a new failover cluster.
New-ClusterFaultDomainCreates a fault domain in the cluster.
New-ClusterGroupSetCreate a names set of groups in the cluster.
New-ClusterNameAccountCreates a cluster name account in Active Directory Domain Services.
Remove-ClusterDestroys an existing failover cluster.
Remove-ClusterAccessRemoves a user from the access list on the cluster.
Remove-ClusterCheckpointRemoves a cryptographic key checkpoint or registry checkpoint for a resource.
Remove-ClusterFaultDomainRemoves a fault domain.
Remove-ClusterGroupRemoves a clustered role, also called a resource group, from a failover cluster.
Remove-ClusterGroupFromSetRemoves a group from a set.
Remove-ClusterGroupSetRemoves a group set from the cluster.
Remove-ClusterGroupSetDependencyRemoves a dependency from a group set.
Remove-ClusterNodeRemoves a node from a failover cluster.
Remove-ClusterResourceRemoves a clustered resource from the failover cluster.
Remove-ClusterResourceDependencyRemoves a dependency between two resources in a clustered role within a failover cluster.
Remove-ClusterResourceTypeRemoves a resource type from a failover cluster.
Remove-ClusterSharedVolumeRemoves a volume from the Cluster Shared Volumes in a failover cluster, and places it in Available Storage in the cluster.
Remove-ClusterVMMonitoredItemRemoves monitoring of a service or event that is currently being monitored on a virtual machine.
Repair-ClusterStorageSpacesDirectRepairs S2D disks.
Reset-ClusterVMMonitoredStateResets 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-ClusterNodeResumes a node from the paused state or brings back drained workloads to the node or both.
Resume-ClusterResourceTurns off maintenance for a disk resource or Cluster Shared Volume within a failover cluster.
Set-ClusterFaultDomainUpdate an existing cluster fault domain.
Set-ClusterFaultDomainXMLSets the cluster fault domain using XML.
Set-ClusterGroupSetUpdates a cluster group set.
Set-ClusterLogSets the size and level of detail for the cluster log.
Set-ClusterOwnerNodeSpecifies 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-ClusterParameterControls specific properties of an object in a failover cluster, such as a resource, a group, or a network.
Set-ClusterQuorumConfigures quorum options for a failover cluster.
Set-ClusterResourceDependencySpecifies the resources that a particular resource depends on within a failover cluster.
Set-ClusterStorageSpacesDirectSets S2D cache parameters.
Set-ClusterStorageSpacesDirectDiskConfigures the system to enable S2D to claim or not claim specific physical disks.
Start-ClusterStarts the Cluster service on all nodes of the cluster on which it is not yet started.
Start-ClusterGroupStarts one or more clustered roles, also known as resource groups, on a failover cluster.
Start-ClusterNodeStarts the Cluster service on a node in a failover cluster.
Start-ClusterResourceBrings a resource online in a failover cluster.
Stop-ClusterStops the Cluster service on all nodes in a failover cluster, which will stop all services and applications configured in the cluster.
Stop-ClusterGroupStops one or more clustered roles on a failover cluster.
Stop-ClusterNodeStops the Cluster service on a node in a failover cluster.
Stop-ClusterResourceTakes a resource offline in a failover cluster.
Suspend-ClusterNodeSuspends activity on a failover cluster node, that is, pauses the node.
Suspend-ClusterResourceTurns on maintenance for a disk resource or CSV so that you can run a disk maintenance tool without triggering failover.
Test-ClusterRuns validation tests for failover cluster hardware and settings.
Test-ClusterResourceFailureSimulates a failure of a cluster resource.
Update-ClusterFunctionalLevelUpdates the functional level of a mixed-version cluster.
Update-ClusterIPResourceRenews or releases the DHCP lease for an IP address resource in a failover cluster.
Update-ClusterNetworkNameResourceRegisters existing Network Name resources with a DNS server in a way that does not interrupt cluster availability.
Update-ClusterVirtualMachineConfigurationRefreshes the configuration of a clustered virtual machine within a failover cluster.