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
|
Adds a cryptographic key checkpoint or registry checkpoint for a resource. |
Add-Cluster
|
Makes a new disk available for use in a failover cluster. |
Add-Cluster
|
Creates a clustered file server resource group. |
Add-Cluster
|
Configures high availability for an application that was not originally designed to run in a failover cluster. |
Add-Cluster
|
Configures an application controlled by a script that runs in Windows Script Host, within a failover cluster. |
Add-Cluster
|
Configures high availability for a service that was not originally designed to run in a failover cluster. |
Add-Cluster
|
Adds an empty resource group to the failover cluster configuration, in preparation for adding clustered resources to the group. |
Add-Cluster
|
Adds a dependency to a cluster set. |
Add-Cluster
|
Adds a group to a set. |
Add-Cluster
|
Adds a node (server) to a failover cluster. |
Add-Cluster
|
Adds a resource to a clustered role, or resource group, in a failover cluster. |
Add-Cluster
|
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
|
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
|
Creates a clustered file server for scale-out application data. |
Add-Cluster
|
Makes a volume available in Cluster Shared Volumes in a failover cluster. |
Add-Cluster
|
Configures monitoring for a service or an Event Tracing for Windows (ETW) event so that it is monitored on a virtual machine. |
Add-Cluster
|
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
|
Creates a highly available iSCSI Target server. |
Block-Cluster
|
Prevents the specified user or users from accessing a failover cluster. |
Clear-Cluster
|
Clears the persistent reservation on a disk in a failover cluster. |
Clear-Cluster
|
Clears the cluster configuration from a node that was evicted from a failover cluster. |
Disable-Cluster
|
Disables S2D. |
Enable-Cluster
|
Enables S2D. |
Get-Cluster |
Gets information about one or more failover clusters in a given domain. |
Get-Cluster
|
Gets information about permissions that control access to a failover cluster. |
Get-Cluster
|
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
|
Retrieves a cryptographic key checkpoint or registry checkpoint for a resource. |
Get-Cluster
|
Gets diagnostics for a cluster a cluster that contains VMs and produces a zip file containing the data. |
Get-Cluster
|
Gets the cluster fault domains in a cluster. |
Get-Cluster
|
Gets the fault domain as an XML string. |
Get-Cluster
|
Gets information about one or more clustered roles (resource groups) in a failover cluster. |
Get-Cluster
|
Gets the group sets in the cluster. |
Get-Cluster
|
Gets the cluster group sets based on dependency relationships. |
Get-Cluster
|
Creates a log file for all nodes, or a specific a node, in a failover cluster. |
Get-Cluster
|
Gets information about one or more networks in a failover cluster. |
Get-Cluster
|
Gets information about one or more network adapters in a failover cluster. |
Get-Cluster
|
Gets information about one or more nodes, or servers, in a failover cluster. |
Get-Cluster
|
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
|
Gets detailed information about an object in a failover cluster, such as a cluster resource. |
Get-Cluster
|
Gets information about the quorum configuration of a failover cluster. |
Get-Cluster
|
Gets information about one or more resources in a failover cluster. |
Get-Cluster
|
Gets information about the dependencies that have been configured between clustered resources in a failover cluster. |
Get-Cluster
|
Generates a report that lists the dependencies between resources in a failover cluster. |
Get-Cluster
|
Gets information about one or more resource types in a failover cluster. |
Get-Cluster
|
Gets information about Cluster Shared Volumes in a failover cluster. |
Get-Cluster
|
Gets the state of Cluster Shared Volumes in a cluster. |
Get-Cluster
|
Gets the S2D settings from a cluster. |
Get-Cluster
|
Gets the list of services and events currently being monitored in the virtual machine. |
Grant-Cluster
|
Grants access to a failover cluster, either full access or read-only access. |
Move-Cluster
|
Moves a clustered role (a resource group) from one node to another in a failover cluster. |
Move-Cluster
|
Moves a clustered resource from one clustered role to another within a failover cluster. |
Move-Cluster
|
Moves a Cluster Shared Volume (CSV) to ownership by a different node in a failover cluster. |
Move-Cluster
|
Moves the ownership of a clustered virtual machine to a different node. |
New-Cluster |
Creates a new failover cluster. |
New-Cluster
|
Creates a fault domain in the cluster. |
New-Cluster
|
Create a names set of groups in the cluster. |
New-Cluster
|
Creates a cluster name account in Active Directory Domain Services. |
Remove-Cluster |
Destroys an existing failover cluster. |
Remove-Cluster
|
Removes a user from the access list on the cluster. |
Remove-Cluster
|
Removes a cryptographic key checkpoint or registry checkpoint for a resource. |
Remove-Cluster
|
Removes a fault domain. |
Remove-Cluster
|
Removes a clustered role, also called a resource group, from a failover cluster. |
Remove-Cluster
|
Removes a group from a set. |
Remove-Cluster
|
Removes a group set from the cluster. |
Remove-Cluster
|
Removes a dependency from a group set. |
Remove-Cluster
|
Removes a node from a failover cluster. |
Remove-Cluster
|
Removes a clustered resource from the failover cluster. |
Remove-Cluster
|
Removes a dependency between two resources in a clustered role within a failover cluster. |
Remove-Cluster
|
Removes a resource type from a failover cluster. |
Remove-Cluster
|
Removes a volume from the Cluster Shared Volumes in a failover cluster, and places it in Available Storage in the cluster. |
Remove-Cluster
|
Removes monitoring of a service or event that is currently being monitored on a virtual machine. |
Repair-Cluster
|
Repairs S2D disks. |
Reset-Cluster
|
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
|
Resumes a node from the paused state or brings back drained workloads to the node or both. |
Resume-Cluster
|
Turns off maintenance for a disk resource or Cluster Shared Volume within a failover cluster. |
Set-Cluster
|
Update an existing cluster fault domain. |
Set-Cluster
|
Sets the cluster fault domain using XML. |
Set-Cluster
|
Updates a cluster group set. |
Set-Cluster
|
Sets the size and level of detail for the cluster log. |
Set-Cluster
|
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
|
Controls specific properties of an object in a failover cluster, such as a resource, a group, or a network. |
Set-Cluster
|
Configures quorum options for a failover cluster. |
Set-Cluster
|
Specifies the resources that a particular resource depends on within a failover cluster. |
Set-Cluster
|
Sets S2D cache parameters. |
Set-Cluster
|
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
|
Starts one or more clustered roles, also known as resource groups, on a failover cluster. |
Start-Cluster
|
Starts the Cluster service on a node in a failover cluster. |
Start-Cluster
|
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
|
Stops one or more clustered roles on a failover cluster. |
Stop-Cluster
|
Stops the Cluster service on a node in a failover cluster. |
Stop-Cluster
|
Takes a resource offline in a failover cluster. |
Suspend-Cluster
|
Suspends activity on a failover cluster node, that is, pauses the node. |
Suspend-Cluster
|
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
|
Simulates a failure of a cluster resource. |
Update-Cluster
|
Updates the functional level of a mixed-version cluster. |
Update-Cluster
|
Renews or releases the DHCP lease for an IP address resource in a failover cluster. |
Update-Cluster
|
Registers existing Network Name resources with a DNS server in a way that does not interrupt cluster availability. |
Update-Cluster
|
Refreshes the configuration of a clustered virtual machine within a failover cluster. |