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.

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-ClusterFileServerRole	Creates a clustered file server (resource group that includes one or more disks, on which shared folders can be created for users).
Add-ClusterGenericApplicationRole	Configures high availability for an application that was not 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 was not 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-ClusteriSCSITargetServerRole	Creates a highly available iSCSI Target server.
Add-ClusterNode	Adds a node (server) to a failover cluster.
Add-ClusterPrintServerRole	Creates a clustered print server, a resource group that includes a printer and a disk for storing print job information and printer drivers.
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-ClusterServerRole	Creates a highly available basic server that contains only a client access point and storage.
Add-ClusterSharedVolume	Makes a volume available in Cluster Shared Volumes in a failover cluster.
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.
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.
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-ClusterAvailableDisk	Gets 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-ClusterCheckpoint	Retrieves a cryptographic key checkpoint or registry checkpoint for a resource.
Get-ClusterGroup	Gets information about one or more clustered roles (resource groups) in a failover cluster.
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-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.
Remove-Cluster	Destroys an existing failover cluster.
Remove-ClusterAccess	Removes a user from the access list on the cluster.
Remove-ClusterCheckpoint	Removes a cryptographic key checkpoint or registry checkpoint for a resource.
Remove-ClusterGroup	Removes a clustered role, also called a resource group, from a failover cluster.
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-ClusterVMMonitoredItem	Removes monitoring of a service or event that is currently being monitored on a virtual machine.
Repair-ClusterSharedVolume	Runs repair tools on a Cluster Shared Volume locally on a cluster node.
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-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.
Start-Cluster	Starts the Cluster service on all nodes of the cluster on which it is not 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, also known as resource groups, 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 Cluster Shared Volume (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.
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 does not interrupt cluster availability.
Update-ClusterVirtualMachineConfiguration	Refreshes the configuration of a clustered virtual machine within a failover cluster.