FailoverClusters

https://learn.microsoft.com/en-us/powershell/module/failoverclusters
Admin
FailoverClusters is a Windows PowerShell module that provides cmdlets for configuring, managing, and...
Tokens:216,228
Snippets:1,568
Trust Score:10
Update:1 week ago
Show doc for...
Tokens:
Raw
### Start-Cluster - Example 1: Start all nodes on local cluster

Source: https://learn.microsoft.com/en-us/powershell/module/failoverclusters/start-cluster

Starts all cluster nodes on the local cluster. This is the simplest usage of the cmdlet.

```powershell
Start-Cluster

```

--------------------------------

### Start-Cluster - Example 2: Start cluster by node name

Source: https://learn.microsoft.com/en-us/powershell/module/failoverclusters/start-cluster

Starts all cluster nodes on the cluster of which the node named 'node2' is a part. A node name is required if all cluster nodes are stopped; if the cluster is already running, the cluster name can be used instead.

```powershell
Start-Cluster -Name node2

```

--------------------------------

### Example 1: Write diagnostic info to the specified path

Source: https://learn.microsoft.com/en-us/powershell/module/failoverclusters/get-clusterdiagnosticinfo

This example writes cluster diagnostics to the folder C:\Users\MyUser\HealthTest\ using the -WriteToPath parameter.

```powershell
Get-ClusterDiagnosticInfo -WriteToPath "C:\Users\MyUser\HealthTest\"

```

--------------------------------

### Example 1: Create a cluster group set

Source: https://learn.microsoft.com/en-us/powershell/module/failoverclusters/new-clustergroupset

Example 1: Creates a cluster group set named Set001 that contains the group Group001.

```powershell
New-ClusterGroupSet -Name "Set001" -Group "Group001"
```

--------------------------------

### Test-WorkgroupClusterRemoting Example

Source: https://learn.microsoft.com/en-us/powershell/module/failoverclusters/test-workgroupclusterremoting

Tests remoting on Node1 and Node2 using the credentials in $cred1 and $cred2.

```powershell
Test-WorkgroupClusterRemoting -Node "Node1", "Node2" -Credentials $cred1, $cred2

```

--------------------------------

### Get-ClusterNode - Example 1

Source: https://learn.microsoft.com/en-us/powershell/module/failoverclusters/get-clusternode

Displays the name, id, and state of each node in the local cluster.

```powershell
Get-ClusterNode
```

--------------------------------

### Reset-ClusterVMMonitoredState

Source: https://learn.microsoft.com/en-us/powershell/module/failoverclusters/reset-clustervmmonitoredstate

Documentation for the Reset-ClusterVMMonitoredState cmdlet, including syntax, parameters, and examples.

```APIDOC
## Reset-ClusterVMMonitoredState

### Description
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. This cmdlet can only be run locally on the virtual machine or through Windows PowerShell remoting to the virtual machine.

### Syntax
```powershell
Reset-ClusterVMMonitoredState
    [-Wait <Int32>]
    [<CommonParameters>]
```

### Parameters
#### -Wait
- Type: Int32
- Default value: None
- Mandatory: False
- Position: Named
- Description: Specifies the time in seconds to wait for the cmdlet. If not specified, the cmdlet waits for completion. If `-Wait 0` is specified, the call is initiated and the cmdlet returns without waiting.

#### CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable.

### Inputs
None

### Outputs
None

### Examples
#### Example 1
```powershell
Reset-ClusterVMMoniteredState
```
This example resets the state of the virtual machine and clears the critical state.
```

--------------------------------

### Set-ClusterFaultDomainXML

Source: https://learn.microsoft.com/en-us/powershell/module/failoverclusters/set-clusterfaultdomainxml

Documentation for the Set-ClusterFaultDomainXML cmdlet, including syntax, parameters, and an example.

```APIDOC
## Set-ClusterFaultDomainXML

### Description
Sets the cluster fault domain using XML.

### Syntax
```powershell
Set-ClusterFaultDomainXML
    [-XML] <String>
    [-Flags <UInt32>]
    [-CimSession <CimSession[]>]
    [-ThrottleLimit <Int32>]
    [-AsJob]
    [<CommonParameters>]
```

### Parameters
- **-XML** (String) - Required - The XML string that defines the cluster fault domain topology.
- **-Flags** (UInt32) - Optional - Flags to control the operation.
- **-CimSession** (CimSession[]) - Optional - Runs the cmdlet in a remote session or on a remote computer.
- **-ThrottleLimit** (Int32) - Optional - Specifies the maximum number of concurrent operations that can be established to run the cmdlet.
- **-AsJob** (SwitchParameter) - Optional - Runs the cmdlet as a background job.

### Examples
#### Example 1
```powershell
Set-ClusterFaultDomainXML -XML @"
<Topology>
 <Site Name="site1" Description="Site 1 with 4 nodes" Location="Site 1">
  <rack name="rack1_in_site_1" description="the only rack in site 1">
   <Node Name="K0617-VM02"/>
   <Node Name="K0617-VM03"/>
   <Node Name="K0617-VM04"/>
   <Node Name="K0617-VM05"/>
  </rack>
 </Site>
 <Site Name="site2" Description="Site 2 with 4 nodes" Location="Site 2">
  <rack name="rack1_in_site_2" description="the only rack in site 2">
   <Node Name="K0617-VM12"/>
   <Node Name="K0617-VM13"/>
   <Node Name="K0617-VM14"/>
   <Node Name="K0617-VM15"/>
  </rack>
 </Site>
 <Site Name="site3" Description="Site 3 with 4 nodes" Location="Site 3">
  <rack name="rack1_in_site_3" description="the only rack in site 3">
   <Node Name="K0621-VM17"/>
   <Node Name="K0621-VM18"/>
   <Node Name="K0621-VM19"/>
   <Node Name="K0621-VM20"/>
  </rack>
 </Site>
 <Site Name="site4" Description="Site 4 with 4 nodes" Location="Site 4">
  <rack name="rack1_in_site_4" description="the only rack in site 4">
   <Node Name="K0629-VM07"/>
   <Node Name="K0629-VM08"/>
   <Node Name="K0629-VM09"/>
   <Node Name="K0629-VM10"/>
  </rack>
 </Site>
</Topology>
"@
```
This command sets the cluster fault domain using the XML in the example.
```

--------------------------------

### Get-ClusterAccess

Source: https://learn.microsoft.com/en-us/powershell/module/failoverclusters/get-clusteraccess

Documentation for the Get-ClusterAccess cmdlet, including syntax, parameters, inputs, outputs, and an example.

```APIDOC
## Get-ClusterAccess

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

### Syntax
```powershell
Get-ClusterAccess
    [[-User] <StringCollection>]
    [-InputObject <PSObject>]
    [-Cluster <String>]
    [<CommonParameters>]
```

### Parameters
#### -Cluster
- **Type:** String
- **Position:** Named
- **Mandatory:** False
- **Default value:** None
- **Supports wildcards:** False
- **Description:** Specifies the name of the cluster on which to run this cmdlet. If the input for this parameter is `.` or it is omitted, then the cmdlet runs on the local cluster.

#### -InputObject
- **Type:** PSObject
- **Position:** Named
- **Mandatory:** False
- **Default value:** None
- **Supports wildcards:** False
- **Value from pipeline:** True
- **Description:** Specifies the cluster on which to enumerate cluster access details.

#### -User
- **Type:** StringCollection
- **Position:** 0
- **Mandatory:** False
- **Default value:** None
- **Supports wildcards:** False
- **Description:** Specifies the user for which to get cluster access.

#### CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

### Inputs
- **Microsoft.FailoverClusters.PowerShell.Cluster**

### Outputs
- **Microsoft.FailoverClusters.PowerShell.ClusterAccessRule**

### Examples
#### Example 1
```powershell
Get-ClusterAccess
```
This example lists the level of permissions that have been assigned to users of this cluster, including users who are blocked from access.

```

--------------------------------

### Get-ClusterSharedVolumeState example

Source: https://learn.microsoft.com/en-us/powershell/module/failoverclusters/get-clustersharedvolumestate

Gets the state of Cluster Shared Volumes on the local cluster.

```powershell
Get-ClusterSharedVolumeState
```

--------------------------------

### Start-ClusterGroup syntax (Default parameter set)

Source: https://learn.microsoft.com/en-us/powershell/module/failoverclusters/start-clustergroup

Shows the full syntax of the Start-ClusterGroup cmdlet with all parameters in the Default parameter set. Use this as a reference for constructing valid commands.

```powershell
Start-ClusterGroup
    [[-Name] <String>]
    [-IgnoreLocked]
    [-ChooseBestNode]
    [-Wait <Int32>]
    [-InputObject <PSObject>]
    [-Cluster <String>]
    [<CommonParameters>]

```

--------------------------------

### Start-Cluster syntax (Default parameter set)

Source: https://learn.microsoft.com/en-us/powershell/module/failoverclusters/start-cluster

Shows the full syntax of the Start-Cluster cmdlet with the -Name, -IgnorePersistentState, and -Wait parameters. Use this as a reference for the command's structure.

```powershell
Start-Cluster
    [[-Name] <String>]
    [-IgnorePersistentState]
    [-Wait <Int32>]
    [<CommonParameters>]

```

--------------------------------

### Get all group sets in the cluster

Source: https://learn.microsoft.com/en-us/powershell/module/failoverclusters/get-clustergroupset

Example 1: Enumerates all group sets in the cluster by calling Get-ClusterGroupSet without any parameters.

```powershell
Get-ClusterGroupSet

```

--------------------------------

### Start-ClusterResource -Name example

Source: https://learn.microsoft.com/en-us/powershell/module/failoverclusters/start-clusterresource

Brings the resource named 'IP Address 172.24.11.0' online on the local cluster. Any dependent resources are brought online first.

```powershell
Start-ClusterResource -Name "IP Address 172.24.11.0"
```

--------------------------------

### Get-ClusterParameter Example 1

Source: https://learn.microsoft.com/en-us/powershell/module/failoverclusters/get-clusterparameter

Gets the parameters for the cluster resource named cluster1FS on the local cluster. The displayed parameters vary according to the resource type.

```powershell
Get-ClusterResource -Name cluster1FS | Get-ClusterParameter

```

--------------------------------

### Test workgroup cluster with Test-WorkgroupCluster

Source: https://learn.microsoft.com/en-us/powershell/module/failoverclusters/test-workgroupcluster

Example that tests the configuration of a workgroup cluster with Node1 and Node2 using the credentials in $cred1 and $cred2, along with additional parameters. Use this to validate the workgroup cluster setup.

```PowerShell
Test-WorkgroupCluster -Node "Node1", "Node2" -Credentials $cred1, $cred2

```

--------------------------------

### Start-ClusterResource -Name -Wait 0 example

Source: https://learn.microsoft.com/en-us/powershell/module/failoverclusters/start-clusterresource

Brings the resource named 'IP Address 172.24.11.0' online and returns the prompt as soon as the action is initiated, without waiting for completion.

```powershell
Start-ClusterResource -Name "IP Address 172.24.11.0" -Wait 0
```

--------------------------------

### Enable-AccelNetVM Example

Source: https://learn.microsoft.com/en-us/powershell/module/failoverclusters/enable-accelnetvm

Enables AccelNet with the performance level set to High for the VM named MyVM.

```powershell
Enable-AccelNetVM -VMName "MyVM" -Performance High

```

--------------------------------

### Get all fault domains

Source: https://learn.microsoft.com/en-us/powershell/module/failoverclusters/get-clusterfaultdomain

Gets all fault domains in the cluster.

```powershell
Get-ClusterFaultDomain
```

--------------------------------

### Start-ClusterGroup

Source: https://learn.microsoft.com/en-us/powershell/module/failoverclusters/start-clustergroup

Documentation for the Start-ClusterGroup cmdlet from the FailoverClusters module, including syntax, parameters, inputs, outputs, and examples.

```APIDOC
## Start-ClusterGroup

### Description
Starts one or more clustered roles, also known as resource groups, on a failover cluster. This cmdlet can be used to start a clustered role again after stopping it for maintenance or diagnosis.

### Syntax
```powershell
Start-ClusterGroup
    [[-Name] <String>]
    [-IgnoreLocked]
    [-ChooseBestNode]
    [-Wait <Int32>]
    [-InputObject <PSObject>]
    [-Cluster <String>]
    [<CommonParameters>]
```

### Parameters
#### -ChooseBestNode
- Type: SwitchParameter
- Default value: None
- Mandatory: False
- Position: Named
- Description: Specifies that the cmdlet should choose the best node for the clustered role.

#### -Cluster
- Type: String
- Default value: None
- Mandatory: False
- Position: Named
- Description: Specifies the name of the cluster on which to run this cmdlet. If the input for this parameter is `.` or it is omitted, then the cmdlet runs on the local cluster.

#### -IgnoreLocked
- Type: SwitchParameter
- Default value: None
- Mandatory: False
- Position: Named
- Description: Specifies that locked groups are ignored when running the cmdlet.

#### -InputObject
- Type: PSObject
- Default value: None
- Mandatory: False
- Position: Named
- Accepts pipeline input: True (by value)
- Description: Specifies the clustered role to start.

#### -Name
- Type: String
- Default value: None
- Mandatory: False
- Position: 0
- Description: Specifies the name of the clustered role to start.

#### -Wait
- Type: Int32
- Default value: None
- Mandatory: False
- Position: Named
- Description: Specifies the time in seconds to wait for the cmdlet. If the **Wait** parameter isn't specified, then the cmdlet waits for completion. If `-Wait 0` is specified, then the call is initiated and the cmdlet returns without waiting.

### CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

### Inputs
- Microsoft.FailoverClusters.PowerShell.ClusterGroup

### Outputs
- Microsoft.FailoverClusters.PowerShell.ClusterGroup

### Examples
#### Example 1
```powershell
Start-ClusterGroup FileServer1
```
This example starts the clustered file server, or resource group, called `FileServer1`.

#### Example 2
```powershell
Start-ClusterGroup FileServer1 -Wait 0
```
This example starts the clustered file server, or resource group, called `FileServer1`. The Windows PowerShell prompt returns as soon as the action has been initiated.
```

--------------------------------

### Get-Cluster - Get Clusters in Domain

Source: https://learn.microsoft.com/en-us/powershell/module/failoverclusters/get-cluster

Gets information about each cluster in the contoso.com domain.

```powershell
Get-Cluster -Domain contoso.com

```

--------------------------------

### Get-Cluster - Get Cluster by Name

Source: https://learn.microsoft.com/en-us/powershell/module/failoverclusters/get-cluster

Gets information about a cluster named cluster1.

```powershell
Get-Cluster -Name cluster1

```

--------------------------------

### Get-ClusterNetworkInterface (Example 1)

Source: https://learn.microsoft.com/en-us/powershell/module/failoverclusters/get-clusternetworkinterface

Run without parameters to display information about the physical network adapters used by the local cluster.

```powershell
Get-ClusterNetworkInterface

```

--------------------------------

### Get-ClusterGroupSetDependency

Source: https://learn.microsoft.com/en-us/powershell/module/failoverclusters/get-clustergroupsetdependency

Gets the cluster group sets based on dependency relationships. You can get all sets that are dependent on a specific set.

```APIDOC
## Get-ClusterGroupSetDependency

### Description
Gets the cluster group sets based on dependency relationships. You can get all sets that are dependent on a specific set.

### Syntax
```powershell
Get-ClusterGroupSetDependency
    [-ContainedGroup <String>]
    [-Name <String>]
    [-Provider <String>]
    [-DependentGroup <String>]
    [-CimSession <CimSession[]>]
    [-ThrottleLimit <Int32>]
    [-AsJob]
    [<CommonParameters>]
```

### Parameters
#### ContainedGroup
- **Type**: String
- **Required**: Optional
- **Description**: Specifies the contained group.

#### Name
- **Type**: String
- **Required**: Optional
- **Description**: Specifies the name of the group set.

#### Provider
- **Type**: String
- **Required**: Optional
- **Description**: Specifies the provider group set.

#### DependentGroup
- **Type**: String
- **Required**: Optional
- **Description**: Specifies the dependent group.

#### CimSession
- **Type**: CimSession[]
- **Required**: Optional
- **Description**: Runs the cmdlet in a remote session or on a remote computer.

#### ThrottleLimit
- **Type**: Int32
- **Required**: Optional
- **Description**: Specifies the maximum number of concurrent operations that can be established to run the cmdlet.

#### AsJob
- **Type**: SwitchParameter
- **Required**: Optional
- **Description**: Runs the cmdlet as a background job.

### Examples
#### Example 1: Get all the group sets that are provided by the specified set
```powershell
Get-ClusterGroupSetDependency -Provider "Set2"
```
This command gets all the group sets that are provided by set named `Set2`.

```

--------------------------------

### Stop-ClusterGroup example: stop FileServer1

Source: https://learn.microsoft.com/en-us/powershell/module/failoverclusters/stop-clustergroup

Stops the clustered role named FileServer1 on the local cluster. This is the example from the documentation.

```powershell
Stop-ClusterGroup FileServer1

```

--------------------------------

### Set-WorkgroupClusterRemotingConfiguration -Verbose example

Source: https://learn.microsoft.com/en-us/powershell/module/failoverclusters/set-workgroupclusterremotingconfiguration

Runs the cmdlet with the Verbose parameter to display detailed information about the current workgroup cluster remoting configuration.

```powershell
Set-WorkgroupClusterRemotingConfiguration -Verbose
```

--------------------------------

### Get File Server resource type details

Source: https://learn.microsoft.com/en-us/powershell/module/failoverclusters/get-clusterresourcetype

Gets information about the File Server resource type on the local cluster and displays it as a list.

```powershell
Get-ClusterResourceType -Name "File Server" | Format-List -Property *
```

--------------------------------

### Configure an application with storage and name using splatting

Source: https://learn.microsoft.com/en-us/powershell/module/failoverclusters/add-clustergenericapplicationrole

Configures NewApplication.exe as a generic clustered application using Cluster Disk 4 and assigns the name NewApplication. Uses splatting to pass parameters.

```powershell
$parameters = @{
    CommandLine = 'NewApplication.exe'
    Storage = 'Cluster Disk 4'
    Name = 'NewApplication'
}
Add-ClusterGenericApplicationRole @parameters

```

--------------------------------

### Set-AccelNetVM example with -VMName and -Performance

Source: https://learn.microsoft.com/en-us/powershell/module/failoverclusters/set-accelnetvm

Sets Accelerated Networking with the performance level set to High for the VM named MyVM.

```powershell
Set-AccelNetVM -VMName "MyVM" -Performance High

```

--------------------------------

### Get S2D settings from a specific node

Source: https://learn.microsoft.com/en-us/powershell/module/failoverclusters/get-clusterstoragespacesdirect

Gets the Storage Spaces Direct (S2D) settings from the specified cluster node. Replace the node name with your actual cluster node.

```powershell
Get-ClusterStorageSpacesDirect -Node "K0617-C1.contoso.com"

```

--------------------------------

### New-ClusterFaultDomain syntax

Source: https://learn.microsoft.com/en-us/powershell/module/failoverclusters/new-clusterfaultdomain

Shows the full syntax of the New-ClusterFaultDomain cmdlet with all parameters, including -Name, -FaultDomain, -FaultDomainType, -Description, -Location, -Flags, -CimSession, -ThrottleLimit, and -AsJob.

```powershell
New-ClusterFaultDomain
    -Name <String>
    [-FaultDomain <String>]
    -FaultDomainType <FaultDomainType>
    [-Description <String>]
    [-Location <String>]
    [-Flags <UInt32>]
    [-CimSession <CimSession[]>]
    [-ThrottleLimit <Int32>]
    [-AsJob]
    [<CommonParameters>]
```

--------------------------------

### Remove-WorkgroupCluster syntax and example

Source: https://learn.microsoft.com/en-us/powershell/module/failoverclusters/remove-workgroupcluster

The syntax block defines the default parameter set of Remove-WorkgroupCluster. The example removes the cluster from two nodes with explicit credentials; if communication is lost or membership is incomplete, manual cleanup may be required.

```powershell
Remove-WorkgroupCluster
    [[-Node] <String[]>]
    [[-Credentials] <PSCredential[]>]
    [-Force]
    [-Confirm]
    [-WhatIf]
    [<CommonParameters>]
```

```powershell
Remove-WorkgroupCluster -Node "Node1", "Node2" -Credentials $cred1, $cred2
```

--------------------------------

### Get-ClusterFaultDomain

Source: https://learn.microsoft.com/en-us/powershell/module/failoverclusters/get-clusterfaultdomain

Gets the cluster fault domains in a cluster.

```APIDOC
## Get-ClusterFaultDomain

### Description
Gets the cluster fault domains in a cluster.

### Syntax
```
Get-ClusterFaultDomain
    [[-Name] <String[]>]
    [-Type <FaultDomainType[]>]
    [-Id <String[]>]
    [-CimSession <CimSession[]>]
    [-ThrottleLimit <Int32>]
    [-AsJob]
    [<CommonParameters>]
```

### Parameters
#### -Name
- Type: String[]
- Position: 0
- Accept pipeline input: True (ByPropertyName)
- Description: Specifies the name of the fault domain to get.

#### -Type
- Type: FaultDomainType[]
- Description: Specifies the type of fault domains to get. Valid values are: Unknown, Site, Rack, Chassis, Node, StorageEnclosure, StorageScaleUnit.

#### -Id
- Type: String[]
- Description: Specifies the ID of the fault domain to get.

#### -CimSession
- Type: CimSession[]
- Description: Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session object, such as the output of a New-CimSession or Get-CimSession cmdlet.

#### -ThrottleLimit
- Type: Int32
- Description: Specifies the maximum number of concurrent operations that can be established to run the cmdlet. If this parameter is omitted or a value of 0 is entered, Windows PowerShell calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets running on the computer. The throttle limit applies only to the current cmdlet, not to the session or to the computer.

#### -AsJob
- Type: SwitchParameter
- Description: Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to complete.

### Examples
#### Example 1: Get all fault domains in the cluster
```powershell
Get-ClusterFaultDomain
```
This command gets all the fault domains in the cluster.

```

--------------------------------

### Get-ClusterQuorum Example 1: Display quorum for local cluster

Source: https://learn.microsoft.com/en-us/powershell/module/failoverclusters/get-clusterquorum

Displays the quorum configuration for the local cluster.

```powershell
Get-ClusterQuorum

```

--------------------------------

### Enable-AccelNetManagement Example

Source: https://learn.microsoft.com/en-us/powershell/module/failoverclusters/enable-accelnetmanagement

Enables the 'MyIntent' intent for Accelerated Networking Management and reserves 25 percent of nodes. Returns $true on success, $false on error.

```powershell
Enable-AccelNetManagement -IntentName "MyIntent" -NodeReservePercentage 25

```

--------------------------------

### Install required features for rolling OS upgrade

Source: https://learn.microsoft.com/en-us/powershell/module/failoverclusters/update-clusterfunctionallevel

Installs the Hyper-V role and Failover-Clustering feature with management tools, as part of the rolling OS upgrade procedure. Run these commands after performing an in-place upgrade of the OS and before adding the node back to the cluster.

```powershell
Install-WindowsFeature -Name Hyper-V -IncludeManagementTools
Install-WindowsFeature -Name Failover-Clustering -IncludeManagementTools

```

--------------------------------

### Start-ClusterGroup FileServer1 -Wait 0

Source: https://learn.microsoft.com/en-us/powershell/module/failoverclusters/start-clustergroup

Starts the clustered file server FileServer1 and returns immediately without waiting for the action to complete. The -Wait 0 parameter initiates the call and the prompt returns as soon as the action has been initiated.

```powershell
Start-ClusterGroup FileServer1 -Wait 0

```

--------------------------------

### Get-ClusterNetwork

Source: https://learn.microsoft.com/en-us/powershell/module/failoverclusters/get-clusternetwork

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

```APIDOC
## Get-ClusterNetwork

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

### Syntax
```
Get-ClusterNetwork
    [[-Name] <StringCollection>]
    [-InputObject <PSObject>]
    [-Cluster <String>]
    [<CommonParameters>]
```

### Parameters
#### -Cluster
- **Type**: String
- **Position**: Named
- **Mandatory**: False
- **Description**: Specifies the name of the cluster on which to run this cmdlet. If the input for this parameter is `.` or it is omitted, then the cmdlet runs on the local cluster.

#### -InputObject
- **Type**: PSObject
- **Position**: Named
- **Mandatory**: False
- **Description**: Specifies the cluster on which to enumerate the cluster networks.

#### -Name
- **Type**: StringCollection
- **Position**: 0
- **Mandatory**: False
- **Description**: Specifies the name of the cluster network to get.

#### CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

### Inputs
- Microsoft.FailoverClusters.PowerShell.Cluster

### Outputs
- Microsoft.FailoverClusters.PowerShell.ClusterNetwork

### Examples
#### Example 1
```powershell
Get-ClusterNetwork
```
This example gets information about the networks used by the local cluster.

#### Example 2
```powershell
(Get-ClusterNetwork -Name "Cluster Network 1").Name = "Cluster Network 3"
```
This example renames `Cluster Network 1` to `Cluster Network 3`.

```

--------------------------------

### Repair-ClusterStorageSpacesDirect

Source: https://learn.microsoft.com/en-us/powershell/module/failoverclusters/repair-clusterstoragespacesdirect

Documentation for the Repair-ClusterStorageSpacesDirect cmdlet, including parameters and an example.

```APIDOC
## Repair-ClusterStorageSpacesDirect

### Description
Repairs Storage Spaces Direct (S2D) disks. This cmdlet is used to repair S2D on all nodes or on specific nodes, and can optionally disable storage maintenance mode, recover unbound drives, or skip disk recovery.

### Method
Cmdlet

### Endpoint
Repair-ClusterStorageSpacesDirect

### Parameters
#### -AsJob
- Type: SwitchParameter
- Required: False
- Description: Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to complete. The cmdlet immediately returns an object that represents the job and then displays the command prompt.

#### -CimSession
- Type: CimSession[]
- Required: False
- Aliases: Session
- Description: Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session object, such as the output of a New-CimSession or Get-CimSession cmdlet. The default is the current session on the local computer.

#### -Confirm
- Type: SwitchParameter
- Required: False
- Aliases: cf
- Description: Prompts you for confirmation before running the cmdlet.

#### -DisableStorageMaintenanceMode
- Type: SwitchParameter
- Required: False
- Description: Indicates that this cmdlet disables storage maintenance mode. You can use this parameter to clean the storage maintenance mode setting on physical disks.

#### -Node
- Type: String
- Required: False
- Description: Specifies a node on which the cmdlet performs the operation. If you don't specify a value, all nodes are used.

#### -RecoverUnboundDrives
- Type: SwitchParameter
- Required: False
- Description: Indicates that this cmdlet recovers physical disks that are unbound. This parameter can be used when disks are reported to be in a lost communication state. When this parameter is specified, S2D attempts to reestablish the binding between disks in slow and fast tiers, making disks accessible again.

#### -SkipDiskRecovery
- Type: SwitchParameter
- Required: False
- Description: Indicates that this cmdlet recovers disks so they can be reevaluated to be claimed when repairing Storage Spaces Direct.

### Request Example
```powershell
Repair-ClusterStorageSpacesDirect -Verbose -Confirm:$False
```

### Response
This cmdlet does not return any output. It repairs Storage Spaces Direct disks.
```

--------------------------------

### Enable-AccelNetVM Syntax

Source: https://learn.microsoft.com/en-us/powershell/module/failoverclusters/enable-accelnetvm

Shows the full syntax of the Enable-AccelNetVM cmdlet, including the required -VMName and -Performance parameters and the optional -VM parameter.

```powershell
Enable-AccelNetVM
    [-VMName] <String>
    [-Performance] <PerformanceWeight>
    [[-VM] <VirtualMachineBase>]
    [<CommonParameters>]

```

--------------------------------

### Get-ClusterAvailableDisk example

Source: https://learn.microsoft.com/en-us/powershell/module/failoverclusters/get-clusteravailabledisk

Lists the disks that are ready to be added to the cluster.

```powershell
Get-ClusterAvailableDisk

```

--------------------------------

### Configure application with no wait for resources

Source: https://learn.microsoft.com/en-us/powershell/module/failoverclusters/add-clustergenericapplicationrole

Configures NewApplication.exe as a generic clustered application and assigns the name NewApplication. The cmdlet completes without waiting for all resources to come online.

```powershell
Add-ClusterGenericApplicationRole -CommandLine NewApplication.exe -Wait 0

```

--------------------------------

### Disable-ClusterStorageSpacesDirect Example

Source: https://learn.microsoft.com/en-us/powershell/module/failoverclusters/disable-clusterstoragespacesdirect

Disables S2D on the cluster with a simple command.

```powershell
Disable-ClusterStorageSpacesDirect

```
Tokens:
Raw