Skip to content

Commit 807e16f

Browse files
Xelu86Xelu86
committed
Initial update for failover excluded adapters
1 parent 2121760 commit 807e16f

File tree

5 files changed

+759
-0
lines changed

5 files changed

+759
-0
lines changed

‎docset/winserver2025-ps/failoverclusters/Add-ClusterExcludedAdapter.md‎

Lines changed: 160 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,160 @@
1+
---
2+
external help file: ClusterExcludedAdapter.cdxml-help.xml
3+
Module Name: FailoverClusters
4+
online version:
5+
schema: 2.0.0
6+
---
7+
8+
# Add-ClusterExcludedAdapter
9+
10+
## SYNOPSIS
11+
{{ Fill in the Synopsis }}
12+
13+
## SYNTAX
14+
15+
```
16+
Add-ClusterExcludedAdapter -ExclusionType <AdapterExclusionType> -ExclusionValue <String[]>
17+
[-CimSession <CimSession[]>] [-ThrottleLimit <Int32>] [-AsJob] [<CommonParameters>]
18+
```
19+
20+
## DESCRIPTION
21+
22+
{{ Fill in the Description }}
23+
24+
## EXAMPLES
25+
26+
### Example 1
27+
28+
```powershell
29+
{{ Add example code here }}
30+
```
31+
32+
{{ Add example description here }}
33+
34+
## PARAMETERS
35+
36+
### -AsJob
37+
38+
Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to
39+
complete.
40+
41+
The cmdlet immediately returns an object that represents the job and then displays the command
42+
prompt. You can continue to work in the session while the job completes.
43+
44+
For more information about Windows PowerShell background jobs, see
45+
[about_Jobs](/powershell/module/microsoft.powershell.core/about/about_jobs).
46+
47+
```yaml
48+
Type: SwitchParameter
49+
Parameter Sets: (All)
50+
Aliases:
51+
52+
Required: False
53+
Position: Named
54+
Default value: None
55+
Accept pipeline input: False
56+
Accept wildcard characters: False
57+
```
58+
59+
### -CimSession
60+
61+
Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session
62+
object, such as the output of a [New-CimSession](/powershell/module/cimcmdlets/new-cimsession)
63+
or [Get-CimSession](/powershell/module/cimcmdlets/get-cimsession) cmdlet. The default is the
64+
current session on the local computer.
65+
66+
```yaml
67+
Type: CimSession[]
68+
Parameter Sets: (All)
69+
Aliases: Session
70+
71+
Required: False
72+
Position: Named
73+
Default value: None
74+
Accept pipeline input: False
75+
Accept wildcard characters: False
76+
```
77+
78+
### -ExclusionType
79+
80+
Specifies the type of exclusion to add to the cluster. Acceptable values are:
81+
82+
- `IPAddress`: Excludes a network adapter based on its IP address.
83+
- `NetworkName`: Excludes a network adapter based on its network name.
84+
- `SubnetMask`: Excludes a network adapter based on its subnet mask.
85+
86+
```yaml
87+
Type: AdapterExclusionType
88+
Parameter Sets: (All)
89+
Aliases:
90+
Accepted values: IPPrefix, Description, FriendlyName
91+
92+
Required: True
93+
Position: Named
94+
Default value: None
95+
Accept pipeline input: False
96+
Accept wildcard characters: False
97+
```
98+
99+
### -ExclusionValue
100+
101+
Specifies the value to use for the exclusion. The value of this parameter depends on the value of
102+
the `-ExclusionType` parameter.
103+
104+
```yaml
105+
Type: String[]
106+
Parameter Sets: (All)
107+
Aliases:
108+
109+
Required: True
110+
Position: Named
111+
Default value: None
112+
Accept pipeline input: False
113+
Accept wildcard characters: False
114+
```
115+
116+
### -ThrottleLimit
117+
118+
Specifies the maximum number of concurrent operations that can be established to run the cmdlet. If
119+
this parameter is omitted or a value of `0` is entered, then PowerShell calculates an optimum
120+
throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer.
121+
The throttle limit applies only to the current cmdlet, not to the session or to the computer.
122+
123+
```yaml
124+
Type: Int32
125+
Parameter Sets: (All)
126+
Aliases:
127+
128+
Required: False
129+
Position: Named
130+
Default value: None
131+
Accept pipeline input: False
132+
Accept wildcard characters: False
133+
```
134+
135+
### CommonParameters
136+
137+
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable,
138+
-InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose,
139+
-WarningAction, and -WarningVariable. For more information, see
140+
[about_CommonParameters](/powershell/module/microsoft.powershell.core/about/about_commonparameters).
141+
142+
## INPUTS
143+
144+
### None
145+
146+
## OUTPUTS
147+
148+
### System.Object
149+
150+
## NOTES
151+
152+
## RELATED LINKS
153+
154+
[Get-ClusterExcludedAdapter](get-clusterexcludedadapter.md)
155+
156+
[Remove-ClusterExcludedAdapter](remove-clusterexcludedadapter.md)
157+
158+
[Repair-ClusterExcludedAdapter](repair-clusterexcludedadapter.md)
159+
160+
[Set-ClusterExcludedAdapter](set-clusterexcludedadapter.md)

‎docset/winserver2025-ps/failoverclusters/Get-ClusterExcludedAdapter.md‎

Lines changed: 143 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,143 @@
1+
---
2+
external help file: ClusterExcludedAdapter.cdxml-help.xml
3+
Module Name: FailoverClusters
4+
online version: https://go.microsoft.com/fwlink/?LinkId=615932
5+
schema: 2.0.0
6+
---
7+
8+
# Get-ClusterExcludedAdapter
9+
10+
## SYNOPSIS
11+
{{ Fill in the Synopsis }}
12+
13+
## SYNTAX
14+
15+
```
16+
Get-ClusterExcludedAdapter -ExclusionType <AdapterExclusionType> [-CimSession <CimSession[]>]
17+
[-ThrottleLimit <Int32>] [-AsJob] [<CommonParameters>]
18+
```
19+
20+
## DESCRIPTION
21+
22+
{{ Fill in the Description }}
23+
24+
## EXAMPLES
25+
26+
### Example 1
27+
28+
```powershell
29+
{{ Add example code here }}
30+
```
31+
32+
{{ Add example description here }}
33+
34+
## PARAMETERS
35+
36+
### -AsJob
37+
38+
Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to
39+
complete.
40+
41+
The cmdlet immediately returns an object that represents the job and then displays the command
42+
prompt. You can continue to work in the session while the job completes.
43+
44+
For more information about Windows PowerShell background jobs, see
45+
[about_Jobs](/powershell/module/microsoft.powershell.core/about/about_jobs).
46+
47+
```yaml
48+
Type: SwitchParameter
49+
Parameter Sets: (All)
50+
Aliases:
51+
52+
Required: False
53+
Position: Named
54+
Default value: None
55+
Accept pipeline input: False
56+
Accept wildcard characters: False
57+
```
58+
59+
### -CimSession
60+
61+
Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session
62+
object, such as the output of a [New-CimSession](/powershell/module/cimcmdlets/new-cimsession)
63+
or [Get-CimSession](/powershell/module/cimcmdlets/get-cimsession) cmdlet. The default is the
64+
current session on the local computer.
65+
66+
```yaml
67+
Type: CimSession[]
68+
Parameter Sets: (All)
69+
Aliases: Session
70+
71+
Required: False
72+
Position: Named
73+
Default value: None
74+
Accept pipeline input: False
75+
Accept wildcard characters: False
76+
```
77+
78+
### -ExclusionType
79+
80+
Specifies the type of exclusion to retrieve from the cluster. Acceptable values are:
81+
82+
- `IPAddress`: Excludes a network adapter based on its IP address.
83+
- `NetworkName`: Excludes a network adapter based on its network name.
84+
- `SubnetMask`: Excludes a network adapter based on its subnet mask.
85+
86+
```yaml
87+
Type: AdapterExclusionType
88+
Parameter Sets: (All)
89+
Aliases:
90+
Accepted values: IPPrefix, Description, FriendlyName
91+
92+
Required: True
93+
Position: Named
94+
Default value: None
95+
Accept pipeline input: False
96+
Accept wildcard characters: False
97+
```
98+
99+
### -ThrottleLimit
100+
101+
Specifies the maximum number of concurrent operations that can be established to run the cmdlet. If
102+
this parameter is omitted or a value of `0` is entered, then PowerShell calculates an optimum
103+
throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer.
104+
The throttle limit applies only to the current cmdlet, not to the session or to the computer.
105+
106+
```yaml
107+
Type: Int32
108+
Parameter Sets: (All)
109+
Aliases:
110+
111+
Required: False
112+
Position: Named
113+
Default value: None
114+
Accept pipeline input: False
115+
Accept wildcard characters: False
116+
```
117+
118+
### CommonParameters
119+
120+
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable,
121+
-InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose,
122+
-WarningAction, and -WarningVariable. For more information, see
123+
[about_CommonParameters](/powershell/module/microsoft.powershell.core/about/about_commonparameters).
124+
125+
## INPUTS
126+
127+
### None
128+
129+
## OUTPUTS
130+
131+
### System.String[]
132+
133+
## NOTES
134+
135+
## RELATED LINKS
136+
137+
[Add-ClusterExcludedAdapter](add-clusterexcludedadapter.md)
138+
139+
[Remove-ClusterExcludedAdapter](remove-clusterexcludedadapter.md)
140+
141+
[Repair-ClusterExcludedAdapter](repair-clusterexcludedadapter.md)
142+
143+
[Set-ClusterExcludedAdapter](set-clusterexcludedadapter.md)

0 commit comments

Comments
 (0)