-
Notifications
You must be signed in to change notification settings - Fork 603
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Initial update for failover excluded adapters
- Loading branch information
Showing
5 changed files
with
759 additions
and
0 deletions.
There are no files selected for viewing
160 changes: 160 additions & 0 deletions
160
docset/winserver2025-ps/failoverclusters/Add-ClusterExcludedAdapter.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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 <AdapterExclusionType> -ExclusionValue <String[]> | ||
[-CimSession <CimSession[]>] [-ThrottleLimit <Int32>] [-AsJob] [<CommonParameters>] | ||
``` | ||
|
||
## 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) |
143 changes: 143 additions & 0 deletions
143
docset/winserver2025-ps/failoverclusters/Get-ClusterExcludedAdapter.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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 <AdapterExclusionType> [-CimSession <CimSession[]>] | ||
[-ThrottleLimit <Int32>] [-AsJob] [<CommonParameters>] | ||
``` | ||
|
||
## 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) |
Oops, something went wrong.