Failover Clusters

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-Cluster Checkpoint

Adds a cryptographic key checkpoint or registry checkpoint for a resource.

Add-Cluster Disk

Makes a new disk available for use in a failover cluster.

Add-Cluster File Server Role

Creates a clustered file server resource group.

Add-Cluster Generic Application Role

Configures high availability for an application that was not originally designed to run in a failover cluster.

Add-Cluster Generic Script Role

Configures an application controlled by a script that runs in Windows Script Host, within a failover cluster.

Add-Cluster Generic Service Role

Configures high availability for a service that was not originally designed to run in a failover cluster.

Add-Cluster Group

Adds an empty resource group to the failover cluster configuration, in preparation for adding clustered resources to the group.

Add-Cluster Group Set Dependency

Adds a dependency to a cluster set.

Add-Cluster Group ToSet

Adds a group to a set.

Add-Cluster Node

Adds a node (server) to a failover cluster.

Add-Cluster Resource

Adds a resource to a clustered role, or resource group, in a failover cluster.

Add-Cluster Resource Dependency

Adds a resource to the list of resources on which a particular resource depends, using AND as the connector, within a failover cluster.

Add-Cluster Resource Type

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-Cluster Scale Out File Server Role

Creates a clustered file server for scale-out application data.

Add-Cluster Shared Volume

Makes a volume available in Cluster Shared Volumes in a failover cluster.

Add-Cluster VMMonitored Item

Configures monitoring for a service or an Event Tracing for Windows (ETW) event so that it is monitored on a virtual machine.

Add-Cluster Virtual Machine Role

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-Clusteri SCSITarget Server Role

Creates a highly available iSCSI Target server.

Block-Cluster Access

Prevents the specified user or users from accessing a failover cluster.

Clear-Cluster Disk Reservation

Clears the persistent reservation on a disk in a failover cluster.

Clear-Cluster Node

Clears the cluster configuration from a node that was evicted from a failover cluster.

Disable-Cluster Storage Spaces Direct

Disables S2D.

Enable-Cluster Storage Spaces Direct

Enables S2D.

Get-Cluster

Gets information about one or more failover clusters in a given domain.

Get-Cluster Access

Gets information about permissions that control access to a failover cluster.

Get-Cluster Available Disk

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-Cluster Checkpoint

Retrieves a cryptographic key checkpoint or registry checkpoint for a resource.

Get-Cluster Diagnostic Info

Gets diagnostics for a cluster a cluster that contains VMs and produces a zip file containing the data.

Get-Cluster Fault Domain

Gets the cluster fault domains in a cluster.

Get-Cluster Fault DomainXML

Gets the fault domain as an XML string.

Get-Cluster Group

Gets information about one or more clustered roles (resource groups) in a failover cluster.

Get-Cluster Group Set

Gets the group sets in the cluster.

Get-Cluster Group Set Dependency

Gets the cluster group sets based on dependency relationships.

Get-Cluster Log

Creates a log file for all nodes, or a specific a node, in a failover cluster.

Get-Cluster Network

Gets information about one or more networks in a failover cluster.

Get-Cluster Network Interface

Gets information about one or more network adapters in a failover cluster.

Get-Cluster Node

Gets information about one or more nodes, or servers, in a failover cluster.

Get-Cluster Owner Node

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-Cluster Parameter

Gets detailed information about an object in a failover cluster, such as a cluster resource.

Get-Cluster Quorum

Gets information about the quorum configuration of a failover cluster.

Get-Cluster Resource

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

Get-Cluster Resource Dependency

Gets information about the dependencies that have been configured between clustered resources in a failover cluster.

Get-Cluster Resource Dependency Report

Generates a report that lists the dependencies between resources in a failover cluster.

Get-Cluster Resource Type

Gets information about one or more resource types in a failover cluster.

Get-Cluster Shared Volume

Gets information about Cluster Shared Volumes in a failover cluster.

Get-Cluster Shared Volume State

Gets the state of Cluster Shared Volumes in a cluster.

Get-Cluster Storage Spaces Direct

Gets the S2D settings from a cluster.

Get-Cluster VMMonitored Item

Gets the list of services and events currently being monitored in the virtual machine.

Grant-Cluster Access

Grants access to a failover cluster, either full access or read-only access.

Move-Cluster Group

Moves a clustered role (a resource group) from one node to another in a failover cluster.

Move-Cluster Resource

Moves a clustered resource from one clustered role to another within a failover cluster.

Move-Cluster Shared Volume

Moves a Cluster Shared Volume (CSV) to ownership by a different node in a failover cluster.

Move-Cluster Virtual Machine Role

Moves the ownership of a clustered virtual machine to a different node.

New-Cluster

Creates a new failover cluster.

New-Cluster Fault Domain

Creates a fault domain in the cluster.

New-Cluster Group Set

Create a names set of groups in the cluster.

New-Cluster Name Account

Creates a cluster name account in Active Directory Domain Services.

Remove-Cluster

Destroys an existing failover cluster.

Remove-Cluster Access

Removes a user from the access list on the cluster.

Remove-Cluster Checkpoint

Removes a cryptographic key checkpoint or registry checkpoint for a resource.

Remove-Cluster Fault Domain

Removes a fault domain.

Remove-Cluster Group

Removes a clustered role, also called a resource group, from a failover cluster.

Remove-Cluster Group From Set

Removes a group from a set.

Remove-Cluster Group Set

Removes a group set from the cluster.

Remove-Cluster Group Set Dependency

Removes a dependency from a group set.

Remove-Cluster Node

Removes a node from a failover cluster.

Remove-Cluster Resource

Removes a clustered resource from the failover cluster.

Remove-Cluster Resource Dependency

Removes a dependency between two resources in a clustered role within a failover cluster.

Remove-Cluster Resource Type

Removes a resource type from a failover cluster.

Remove-Cluster Shared Volume

Removes a volume from the Cluster Shared Volumes in a failover cluster, and places it in Available Storage in the cluster.

Remove-Cluster VMMonitored Item

Removes monitoring of a service or event that is currently being monitored on a virtual machine.

Repair-Cluster Storage Spaces Direct

Repairs S2D disks.

Reset-Cluster VMMonitored State

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-Cluster Node

Resumes a node from the paused state or brings back drained workloads to the node or both.

Resume-Cluster Resource

Turns off maintenance for a disk resource or Cluster Shared Volume within a failover cluster.

Set-Cluster Fault Domain

Update an existing cluster fault domain.

Set-Cluster Fault DomainXML

Sets the cluster fault domain using XML.

Set-Cluster Group Set

Updates a cluster group set.

Set-Cluster Log

Sets the size and level of detail for the cluster log.

Set-Cluster Owner Node

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-Cluster Parameter

Controls specific properties of an object in a failover cluster, such as a resource, a group, or a network.

Set-Cluster Quorum

Configures quorum options for a failover cluster.

Set-Cluster Resource Dependency

Specifies the resources that a particular resource depends on within a failover cluster.

Set-Cluster Storage Spaces Direct

Sets S2D cache parameters.

Set-Cluster Storage Spaces Direct Disk

Configures the system to enable S2D to claim or not claim specific physical disks.

Start-Cluster

Starts the Cluster service on all nodes of the cluster on which it is not yet started.

Start-Cluster Group

Starts one or more clustered roles, also known as resource groups, on a failover cluster.

Start-Cluster Node

Starts the Cluster service on a node in a failover cluster.

Start-Cluster Resource

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-Cluster Group

Stops one or more clustered roles on a failover cluster.

Stop-Cluster Node

Stops the Cluster service on a node in a failover cluster.

Stop-Cluster Resource

Takes a resource offline in a failover cluster.

Suspend-Cluster Node

Suspends activity on a failover cluster node, that is, pauses the node.

Suspend-Cluster Resource

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-Cluster Resource Failure

Simulates a failure of a cluster resource.

Update-Cluster Functional Level

Updates the functional level of a mixed-version cluster.

Update-Cluster IPResource

Renews or releases the DHCP lease for an IP address resource in a failover cluster.

Update-Cluster Network Name Resource

Registers existing Network Name resources with a DNS server in a way that does not interrupt cluster availability.

Update-Cluster Virtual Machine Configuration

Refreshes the configuration of a clustered virtual machine within a failover cluster.