diff --git a/docset/winserver2025-ps/failoverclusters/Add-ClusterExcludedAdapter.md b/docset/winserver2025-ps/failoverclusters/Add-ClusterExcludedAdapter.md new file mode 100644 index 0000000000..a8b2c62334 --- /dev/null +++ b/docset/winserver2025-ps/failoverclusters/Add-ClusterExcludedAdapter.md @@ -0,0 +1,167 @@ +--- +description: Use this topic to help manage Windows and Windows Server technologies with Windows PowerShell. +external help file: Microsoft.FailoverClusters.PowerShell.dll-Help.xml +Module Name: FailoverClusters +ms.date: 08/28/2024 +online version: https://learn.microsoft.com/powershell/module/failoverclusters/add-clusterexcludedadapter?view=windowsserver2025-ps&wt.mc_id=ps-gethelp +schema: 2.0.0 +title: Add-ClusterExcludedAdapter +--- + +# Add-ClusterExcludedAdapter + +## SYNOPSIS +Adds a network adapter to the list of excluded adapters. + +## SYNTAX + +``` +Add-ClusterExcludedAdapter -ExclusionType -ExclusionValue + [-CimSession ] [-ThrottleLimit ] [-AsJob] [] +``` + +## DESCRIPTION + +The `Add-ClusterExcludedAdapter` cmdlet adds a network adapter to a list of network adapters that +should be excluded from use by the Failover Cluster. By default, the cluster will use all available +network adapters, but in some cases you may want to reserve certain adapters as backup or +management, such as Dell iDRAC or HPE iLO. + +## EXAMPLES + +### Example 1 + +```powershell +Add-ClusterExcludedAdapter -ExclusionType "IPPrefix" -ExclusionValue "10.10.20.25" +``` + +This example excludes the network adapter based on the IP Address `10.10.20.25` from use by the +cluster. + +## PARAMETERS + +### -AsJob + +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. You can continue to work in the session while the job completes. + +For more information about Windows PowerShell background jobs, see +[about_Jobs](/powershell/module/microsoft.powershell.core/about/about_jobs). + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CimSession + +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](/powershell/module/cimcmdlets/new-cimsession) +or [Get-CimSession](/powershell/module/cimcmdlets/get-cimsession) cmdlet. The default is the +current session on the local computer. + +```yaml +Type: CimSession[] +Parameter Sets: (All) +Aliases: Session + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExclusionType + +Specifies the type of exclusion to add to the cluster. Acceptable values are: + +- `IPPrefix`: Excludes a network adapter based on its IP address. +- `Description`: Excludes a network adapter based on its description. +- `FriendlyName`: Excludes a network adapter based on its friendly name. + +```yaml +Type: AdapterExclusionType +Parameter Sets: (All) +Aliases: +Accepted values: IPPrefix, Description, FriendlyName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExclusionValue + +Specifies the value to use for the exclusion. The value of this parameter depends on the value of +the `-ExclusionType` parameter. + +```yaml +Type: String[] +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ThrottleLimit + +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, then PowerShell calculates an optimum +throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. +The throttle limit applies only to the current cmdlet, not to the session or to the computer. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters + +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, +-InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, +-WarningAction, and -WarningVariable. For more information, see +[about_CommonParameters](/powershell/module/microsoft.powershell.core/about/about_commonparameters). + +## INPUTS + +### None + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS + +[Get-ClusterExcludedAdapter](get-clusterexcludedadapter.md) + +[Remove-ClusterExcludedAdapter](remove-clusterexcludedadapter.md) + +[Repair-ClusterNameAccount](repair-clusternameaccount.md) + +[Set-ClusterExcludedAdapter](set-clusterexcludedadapter.md) diff --git a/docset/winserver2025-ps/failoverclusters/Get-ClusterExcludedAdapter.md b/docset/winserver2025-ps/failoverclusters/Get-ClusterExcludedAdapter.md new file mode 100644 index 0000000000..a04d02e84d --- /dev/null +++ b/docset/winserver2025-ps/failoverclusters/Get-ClusterExcludedAdapter.md @@ -0,0 +1,150 @@ +--- +description: Use this topic to help manage Windows and Windows Server technologies with Windows PowerShell. +external help file: Microsoft.FailoverClusters.PowerShell.dll-Help.xml +Module Name: FailoverClusters +ms.date: 08/28/2024 +online version: https://learn.microsoft.com/powershell/module/failoverclusters/get-clusterexcludedadapter?view=windowsserver2025-ps&wt.mc_id=ps-gethelp +schema: 2.0.0 +title: Get-ClusterExcludedAdapter +--- + +# Get-ClusterExcludedAdapter + +## SYNOPSIS +Retrieves a network adapter from the list of excluded adapters. + +## SYNTAX + +``` +Get-ClusterExcludedAdapter -ExclusionType [-CimSession ] + [-ThrottleLimit ] [-AsJob] [] +``` + +## DESCRIPTION + +The `Get-ClusterExcludedAdapter` cmdlet retrieves a network adapter from a list of network adapters +that should be excluded from use by the Failover Cluster. By default, the cluster will use all +available network adapters, but in some cases you may want to reserve certain adapters as backup or +management, such as Dell iDRAC or HPE iLO. + +## EXAMPLES + +### Example 1 + +```powershell +Get-ClusterExcludedAdapter -ExclusionType "FriendlyName" +``` + +This example retrieves a list of network adapters that have been excluded from use by the cluster +based on the friendly name. + +## PARAMETERS + +### -AsJob + +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. You can continue to work in the session while the job completes. + +For more information about Windows PowerShell background jobs, see +[about_Jobs](/powershell/module/microsoft.powershell.core/about/about_jobs). + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CimSession + +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](/powershell/module/cimcmdlets/new-cimsession) +or [Get-CimSession](/powershell/module/cimcmdlets/get-cimsession) cmdlet. The default is the +current session on the local computer. + +```yaml +Type: CimSession[] +Parameter Sets: (All) +Aliases: Session + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExclusionType + +Specifies the type of exclusion to retrieve from the cluster. Acceptable values are: + +- `IPPrefix`: Excludes a network adapter based on its IP address. +- `Description`: Excludes a network adapter based on its description. +- `FriendlyName`: Excludes a network adapter based on its friendly name. + +```yaml +Type: AdapterExclusionType +Parameter Sets: (All) +Aliases: +Accepted values: IPPrefix, Description, FriendlyName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ThrottleLimit + +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, then PowerShell calculates an optimum +throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. +The throttle limit applies only to the current cmdlet, not to the session or to the computer. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters + +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, +-InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, +-WarningAction, and -WarningVariable. For more information, see +[about_CommonParameters](/powershell/module/microsoft.powershell.core/about/about_commonparameters). + +## INPUTS + +### None + +## OUTPUTS + +### System.String[] + +## NOTES + +## RELATED LINKS + +[Add-ClusterExcludedAdapter](add-clusterexcludedadapter.md) + +[Remove-ClusterExcludedAdapter](remove-clusterexcludedadapter.md) + +[Repair-ClusterNameAccount](repair-clusternameaccount.md) + +[Set-ClusterExcludedAdapter](set-clusterexcludedadapter.md) diff --git a/docset/winserver2025-ps/failoverclusters/Remove-ClusterExcludedAdapter.md b/docset/winserver2025-ps/failoverclusters/Remove-ClusterExcludedAdapter.md new file mode 100644 index 0000000000..ac93ba27f4 --- /dev/null +++ b/docset/winserver2025-ps/failoverclusters/Remove-ClusterExcludedAdapter.md @@ -0,0 +1,167 @@ +--- +description: Use this topic to help manage Windows and Windows Server technologies with Windows PowerShell. +external help file: Microsoft.FailoverClusters.PowerShell.dll-Help.xml +Module Name: FailoverClusters +ms.date: 08/28/2024 +online version: https://learn.microsoft.com/powershell/module/failoverclusters/remove-clusterexcludedadapter?view=windowsserver2025-ps&wt.mc_id=ps-gethelp +schema: 2.0.0 +title: Remove-ClusterExcludedAdapter +--- + +# Remove-ClusterExcludedAdapter + +## SYNOPSIS +Removes a network adapter from the list of excluded adapters. + +## SYNTAX + +``` +Remove-ClusterExcludedAdapter -ExclusionType -ExclusionValue + [-CimSession ] [-ThrottleLimit ] [-AsJob] [] +``` + +## DESCRIPTION + +The `Remove-ClusterExcludedAdapter` cmdlet removes a network adapter from a list of network +adapters that should be excluded from use by the Failover Cluster. By default, the cluster will use +all available network adapters, but in some cases you may want to reserve certain adapters as +backup or management, such as Dell iDRAC or HPE iLO. + +## EXAMPLES + +### Example 1 + +```powershell +Remove-ClusterExcludedAdapter -ExclusionType "IPPrefix" -ExclusionValue "10.10.20.25" +``` + +This example removes the network adapter based on the IP Address `10.10.20.25` from the list of +excluded adapters. + +## PARAMETERS + +### -AsJob + +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. You can continue to work in the session while the job completes. + +For more information about Windows PowerShell background jobs, see +[about_Jobs](/powershell/module/microsoft.powershell.core/about/about_jobs). + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CimSession + +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](/powershell/module/cimcmdlets/new-cimsession) +or [Get-CimSession](/powershell/module/cimcmdlets/get-cimsession) cmdlet. The default is the +current session on the local computer. + +```yaml +Type: CimSession[] +Parameter Sets: (All) +Aliases: Session + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExclusionType + +Specifies the type of exclusion to remove from the cluster. Acceptable values are: + +- `IPPrefix`: Excludes a network adapter based on its IP address. +- `Description`: Excludes a network adapter based on its description. +- `FriendlyName`: Excludes a network adapter based on its friendly name. + +```yaml +Type: AdapterExclusionType +Parameter Sets: (All) +Aliases: +Accepted values: IPPrefix, Description, FriendlyName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExclusionValue + +Specifies the value to use for the exclusion. The value of this parameter depends on the value of +the `-ExclusionType` parameter. + +```yaml +Type: String[] +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ThrottleLimit + +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, then PowerShell calculates an optimum +throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. +The throttle limit applies only to the current cmdlet, not to the session or to the computer. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters + +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, +-InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, +-WarningAction, and -WarningVariable. For more information, see +[about_CommonParameters](/powershell/module/microsoft.powershell.core/about/about_commonparameters). + +## INPUTS + +### None + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS + +[Add-ClusterExcludedAdapter](add-clusterexcludedadapter.md) + +[Get-ClusterExcludedAdapter](get-clusterexcludedadapter.md) + +[Repair-ClusterNameAccount](repair-clusternameaccount.md) + +[Set-ClusterExcludedAdapter](set-clusterexcludedadapter.md) diff --git a/docset/winserver2025-ps/failoverclusters/Repair-ClusterNameAccount.md b/docset/winserver2025-ps/failoverclusters/Repair-ClusterNameAccount.md new file mode 100644 index 0000000000..00e5a2d80b --- /dev/null +++ b/docset/winserver2025-ps/failoverclusters/Repair-ClusterNameAccount.md @@ -0,0 +1,156 @@ +--- +description: Use this topic to help manage Windows and Windows Server technologies with Windows PowerShell. +external help file: Microsoft.FailoverClusters.PowerShell.dll-Help.xml +Module Name: FailoverClusters +ms.date: 08/28/2024 +online version: https://learn.microsoft.com/powershell/module/failoverclusters/repair-clusternameaccount?view=windowsserver2025-ps&wt.mc_id=ps-gethelp +schema: 2.0.0 +title: Repair-ClusterNameAccount +--- + +# Repair-ClusterNameAccount + +## SYNOPSIS +Repairs the Cluster Name Account and ensures that the cluster continues to function properly. + +## SYNTAX + +### InputObject (Default) + +``` +Repair-ClusterNameAccount [-Credentials ] [-Domain ] [-InputObject ] + [-Cluster ] [] +``` + +### Credentials + +``` +Repair-ClusterNameAccount [-Credentials ] [-Domain ] [-Cluster ] + [] +``` + +## DESCRIPTION + +The `Repair-ClusterNameAccount` cmdlet repairs or updates the Cluster Name Account used for +authentication and authorization on a Failover Cluster. The Cluster Name Account is used to create +Highly Available applications or Virtual Computer Objects (VCOs) in the cluster. + +To learn more about cluster accounts in domain environments, see +[Configuring cluster accounts in Active Directory](/windows-server/failover-clustering/configure-ad-accounts). + +## EXAMPLES + +### Example 1 + +```powershell +Repair-ClusterNameAccount -Cluster "Cluster01" +``` + +This example repairs or updates the Cluster Name Account for the cluster named `Cluster01`. + +### Example 2 + +```powershell +$cred = Get-Credential +Repair-ClusterNameAccount -Cluster "Cluster01" -Credentials $cred -Domain "contoso.com" +``` + +This example repairs or updates the Cluster Name Account for the cluster named `Cluster01` using +the specified credentials and domain. The `Get-Credential` cmdlet is used to create a PSCredential +object for the `-Credentials` parameter. + +## PARAMETERS + +### -Cluster + +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. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Credentials + +Specifies the credentials that this cmdlet uses when it connects to Active Directory Domain +Services. + +```yaml +Type: PSCredential +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Domain + +Specifies the name of the domain in which to repair the cluster name account. This should be the +fully qualified domain name (FQDN) of the domain that the cluster is in. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject + +Specifies the cluster name account to repair. + +```yaml +Type: PSObject +Parameter Sets: InputObject +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### CommonParameters + +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, +-InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, +-WarningAction, and -WarningVariable. For more information, see +[about_CommonParameters](/powershell/module/microsoft.powershell.core/about/about_commonparameters). + +## INPUTS + +### System.Management.Automation.PSObject + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS + +[Add-ClusterExcludedAdapter](add-clusterexcludedadapter.md) + +[Get-ClusterExcludedAdapter](get-clusterexcludedadapter.md) + +[Remove-ClusterExcludedAdapter](remove-clusterexcludedadapter.md) + +[Set-ClusterExcludedAdapter](set-clusterexcludedadapter.md) diff --git a/docset/winserver2025-ps/failoverclusters/Set-ClusterExcludedAdapter.md b/docset/winserver2025-ps/failoverclusters/Set-ClusterExcludedAdapter.md new file mode 100644 index 0000000000..354b7bd1d5 --- /dev/null +++ b/docset/winserver2025-ps/failoverclusters/Set-ClusterExcludedAdapter.md @@ -0,0 +1,168 @@ +--- +description: Use this topic to help manage Windows and Windows Server technologies with Windows PowerShell. +external help file: Microsoft.FailoverClusters.PowerShell.dll-Help.xml +Module Name: FailoverClusters +ms.date: 08/28/2024 +online version: https://learn.microsoft.com/powershell/module/failoverclusters/set-clusterexcludedadapter?view=windowsserver2025-ps&wt.mc_id=ps-gethelp +schema: 2.0.0 +title: Set-ClusterExcludedAdapter +--- + +# Set-ClusterExcludedAdapter + +## SYNOPSIS +Sets a network adapter to the list of excluded adapters. + +## SYNTAX + +``` +Set-ClusterExcludedAdapter -ExclusionType -ExclusionValue + [-CimSession ] [-ThrottleLimit ] [-AsJob] [] +``` + +## DESCRIPTION + +The `Set-ClusterExcludedAdapter` cmdlet configures a network adapter in a list of network adapters +that should be excluded from use by the Failover Cluster. By default, the cluster will use all +available network adapters, but in some cases you may want to reserve certain adapters as backup or +management, such as Dell iDRAC or HPE iLO. + +## EXAMPLES + +### Example 1 + +```powershell +Set-ClusterExcludedAdapter -ExclusionType "Description" -ExclusionValue "Node-1-FL1","Node-1-FL2" +``` + +This example sets the list of excluded network adapters for the cluster. After running this +command, the cluster will no longer use `Node-1-FL1` or `Node-1-FL2` for cluster communications, +ensuring that they are available for management or backup purposes. + +## PARAMETERS + +### -AsJob + +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. You can continue to work in the session while the job completes. + +For more information about Windows PowerShell background jobs, see +[about_Jobs](/powershell/module/microsoft.powershell.core/about/about_jobs). + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CimSession + +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](/powershell/module/cimcmdlets/new-cimsession) +or [Get-CimSession](/powershell/module/cimcmdlets/get-cimsession) cmdlet. The default is the +current session on the local computer. + +```yaml +Type: CimSession[] +Parameter Sets: (All) +Aliases: Session + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExclusionType + +Specifies the type of exclusion to remove from the cluster. Acceptable values are: + +- `IPPrefix`: Excludes a network adapter based on its IP address. +- `Description`: Excludes a network adapter based on its description. +- `FriendlyName`: Excludes a network adapter based on its friendly name. + +```yaml +Type: AdapterExclusionType +Parameter Sets: (All) +Aliases: +Accepted values: IPPrefix, Description, FriendlyName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExclusionValue + +Specifies the value to use for the exclusion. The value of this parameter depends on the value of +the `-ExclusionType` parameter. + +```yaml +Type: String[] +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ThrottleLimit + +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, then PowerShell calculates an optimum +throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. +The throttle limit applies only to the current cmdlet, not to the session or to the computer. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters + +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, +-InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, +-WarningAction, and -WarningVariable. For more information, see +[about_CommonParameters](/powershell/module/microsoft.powershell.core/about/about_commonparameters). + +## INPUTS + +### None + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS + +[Add-ClusterExcludedAdapter](add-clusterexcludedadapter.md) + +[Get-ClusterExcludedAdapter](get-clusterexcludedadapter.md) + +[Remove-ClusterExcludedAdapter](remove-clusterexcludedadapter.md) + +[Repair-ClusterNameAccount](repair-clusternameaccount.md)