diff --git a/docset/winserver2025-ps/failoverclusters/Add-ClusterExcludedAdapter.md b/docset/winserver2025-ps/failoverclusters/Add-ClusterExcludedAdapter.md new file mode 100644 index 0000000000..ed05c61577 --- /dev/null +++ b/docset/winserver2025-ps/failoverclusters/Add-ClusterExcludedAdapter.md @@ -0,0 +1,160 @@ +--- +external help file: ClusterExcludedAdapter.cdxml-help.xml +Module Name: FailoverClusters +online version: +schema: 2.0.0 +--- + +# Add-ClusterExcludedAdapter + +## SYNOPSIS +{{ Fill in the Synopsis }} + +## SYNTAX + +``` +Add-ClusterExcludedAdapter -ExclusionType -ExclusionValue + [-CimSession ] [-ThrottleLimit ] [-AsJob] [] +``` + +## DESCRIPTION + +{{ Fill in the Description }} + +## EXAMPLES + +### Example 1 + +```powershell +{{ Add example code here }} +``` + +{{ Add example description here }} + +## 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: + +- `IPAddress`: Excludes a network adapter based on its IP address. +- `NetworkName`: Excludes a network adapter based on its network name. +- `SubnetMask`: Excludes a network adapter based on its subnet mask. + +```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-ClusterExcludedAdapter](repair-clusterexcludedadapter.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..926b665b63 --- /dev/null +++ b/docset/winserver2025-ps/failoverclusters/Get-ClusterExcludedAdapter.md @@ -0,0 +1,143 @@ +--- +external help file: ClusterExcludedAdapter.cdxml-help.xml +Module Name: FailoverClusters +online version: https://go.microsoft.com/fwlink/?LinkId=615932 +schema: 2.0.0 +--- + +# Get-ClusterExcludedAdapter + +## SYNOPSIS +{{ Fill in the Synopsis }} + +## SYNTAX + +``` +Get-ClusterExcludedAdapter -ExclusionType [-CimSession ] + [-ThrottleLimit ] [-AsJob] [] +``` + +## DESCRIPTION + +{{ Fill in the Description }} + +## EXAMPLES + +### Example 1 + +```powershell +{{ Add example code here }} +``` + +{{ Add example description here }} + +## 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: + +- `IPAddress`: Excludes a network adapter based on its IP address. +- `NetworkName`: Excludes a network adapter based on its network name. +- `SubnetMask`: Excludes a network adapter based on its subnet mask. + +```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-ClusterExcludedAdapter](repair-clusterexcludedadapter.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..2d69319fca --- /dev/null +++ b/docset/winserver2025-ps/failoverclusters/Remove-ClusterExcludedAdapter.md @@ -0,0 +1,160 @@ +--- +external help file: ClusterExcludedAdapter.cdxml-help.xml +Module Name: FailoverClusters +online version: https://go.microsoft.com/fwlink/?LinkId=691107 +schema: 2.0.0 +--- + +# Remove-ClusterExcludedAdapter + +## SYNOPSIS +{{ Fill in the Synopsis }} + +## SYNTAX + +``` +Remove-ClusterExcludedAdapter -ExclusionType -ExclusionValue + [-CimSession ] [-ThrottleLimit ] [-AsJob] [] +``` + +## DESCRIPTION + +{{ Fill in the Description }} + +## EXAMPLES + +### Example 1 + +```powershell +{{ Add example code here }} +``` + +{{ Add example description here }} + +## 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: + +- `IPAddress`: Excludes a network adapter based on its IP address. +- `NetworkName`: Excludes a network adapter based on its network name. +- `SubnetMask`: Excludes a network adapter based on its subnet mask. + +```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-ClusterExcludedAdapter](repair-clusterexcludedadapter.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..b229303dce --- /dev/null +++ b/docset/winserver2025-ps/failoverclusters/Repair-ClusterNameAccount.md @@ -0,0 +1,136 @@ +--- +external help file: Microsoft.FailoverClusters.PowerShell.dll-Help.xml +Module Name: FailoverClusters +online version: https://go.microsoft.com/fwlink/?linkid=2204048 +schema: 2.0.0 +--- + +# Repair-ClusterNameAccount + +## SYNOPSIS +{{ Fill in the Synopsis }} + +## SYNTAX + +### InputObject (Default) + +``` +Repair-ClusterNameAccount [-Credentials ] [-Domain ] [-InputObject ] + [-Cluster ] [] +``` + +### Credentials + +``` +Repair-ClusterNameAccount [-Credentials ] [-Domain ] [-Cluster ] + [] +``` + +## DESCRIPTION + +{{ Fill in the Description }} + +## EXAMPLES + +### Example 1 + +```powershell +{{ Add example code here }} +``` + +{{ Add example description here }} + +## 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. + +```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..fbb65657fa --- /dev/null +++ b/docset/winserver2025-ps/failoverclusters/Set-ClusterExcludedAdapter.md @@ -0,0 +1,160 @@ +--- +external help file: ClusterExcludedAdapter.cdxml-help.xml +Module Name: FailoverClusters +online version: https://go.microsoft.com/fwlink/?LinkId=691107 +schema: 2.0.0 +--- + +# Set-ClusterExcludedAdapter + +## SYNOPSIS +{{ Fill in the Synopsis }} + +## SYNTAX + +``` +Set-ClusterExcludedAdapter -ExclusionType -ExclusionValue + [-CimSession ] [-ThrottleLimit ] [-AsJob] [] +``` + +## DESCRIPTION + +{{ Fill in the Description }} + +## EXAMPLES + +### Example 1 + +```powershell +{{ Add example code here }} +``` + +{{ Add example description here }} + +## 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: + +- `IPAddress`: Excludes a network adapter based on its IP address. +- `NetworkName`: Excludes a network adapter based on its network name. +- `SubnetMask`: Excludes a network adapter based on its subnet mask. + +```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-ClusterExcludedAdapter](repair-clusterexcludedadapter.md)