Skip to content

Commit a5b7e83

Browse files
Xelu86Xelu86
committed
Updated AccelNet cmdlets
1 parent 4f525f7 commit a5b7e83

File tree

8 files changed

+594
-0
lines changed

8 files changed

+594
-0
lines changed

‎docset/winserver2025-ps/failoverclusters/Disable-AccelNetManagement.md‎

Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
---
2+
description: Use this topic to help manage Windows and Windows Server technologies with Windows PowerShell.
3+
external help file: Microsoft.FailoverClusters.PowerShell.dll-Help.xml
4+
Module Name: FailoverClusters
5+
ms.date: 08/01/2024
6+
online version: https://learn.microsoft.com/powershell/module/failoverclusters/disable-accelnetmanagement?view=windowsserver2025-ps&wt.mc_id=ps-gethelp
7+
schema: 2.0.0
8+
title: Disable-AccelNetManagement
9+
---
10+
11+
# Disable-AccelNetManagement
12+
13+
## SYNOPSIS
14+
Disables Accelerated Networking Management cluster-wide.
15+
16+
## SYNTAX
17+
18+
```
19+
Disable-AccelNetManagement [<CommonParameters>]
20+
```
21+
22+
## DESCRIPTION
23+
24+
Disables Accelerated Networking Management cluster-wide. This doesn't turn off SR-IOV on VMs.
25+
26+
## EXAMPLES
27+
28+
### EXAMPLE 1
29+
30+
```powershell
31+
Disable-AccelNetManagement
32+
```
33+
34+
This example disables the Accelerated Networking Management layer on the cluster.
35+
36+
## PARAMETERS
37+
38+
### CommonParameters
39+
40+
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable,
41+
-InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose,
42+
-WarningAction, and -WarningVariable. For more information, see
43+
[about_CommonParameters](/powershell/module/microsoft.powershell.core/about/about_commonparameters).
44+
45+
## INPUTS
46+
47+
## OUTPUTS
48+
49+
## NOTES
50+
51+
## RELATED LINKS
52+
53+
[Enable-AccelNetManagement](enable-accelnetmanagement.md)
54+
55+
[Get-AccelNetManagementPreReq](get-accelnetmanagementprereq.md)

‎docset/winserver2025-ps/failoverclusters/Disable-AccelNetVM.md‎

Lines changed: 71 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,71 @@
1+
---
2+
description: Use this topic to help manage Windows and Windows Server technologies with Windows PowerShell.
3+
external help file: Microsoft.FailoverClusters.PowerShell.dll-Help.xml
4+
Module Name: FailoverClusters
5+
ms.date: 08/01/2024
6+
online version: https://learn.microsoft.com/powershell/module/failoverclusters/disable-accelnetvm?view=windowsserver2025-ps&wt.mc_id=ps-gethelp
7+
schema: 2.0.0
8+
title: Disable-AccelNetVM
9+
---
10+
11+
# Disable-AccelNetVM
12+
13+
## SYNOPSIS
14+
Disables Accelerated Networking on a VM.
15+
16+
## SYNTAX
17+
18+
```
19+
Disable-AccelNetVM [-VMName] <String> [<CommonParameters>]
20+
```
21+
22+
## DESCRIPTION
23+
24+
Disables Accelerated Networking on a VM.
25+
26+
## EXAMPLES
27+
28+
### EXAMPLE 1
29+
30+
```powershell
31+
Disable-AccelNetVM -VMName "MyVM"
32+
```
33+
34+
This example disables Accelerated Networking for the VM named `MyVM`.
35+
36+
## PARAMETERS
37+
38+
### -VMName
39+
40+
Specifies the name of the virtual machine.
41+
42+
```yaml
43+
Type: String
44+
Parameter Sets: (All)
45+
Aliases:
46+
47+
Required: True
48+
Position: 1
49+
Default value: None
50+
Accept pipeline input: False
51+
Accept wildcard characters: False
52+
```
53+
54+
### CommonParameters
55+
56+
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable,
57+
-InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose,
58+
-WarningAction, and -WarningVariable. For more information, see
59+
[about_CommonParameters](/powershell/module/microsoft.powershell.core/about/about_commonparameters).
60+
61+
## INPUTS
62+
63+
## OUTPUTS
64+
65+
## NOTES
66+
67+
## RELATED LINKS
68+
69+
[Enable-AccelNetVM](enable-accelnetvm.md)
70+
71+
[Set-AccelNetVM](set-accelnetvm.md)

‎docset/winserver2025-ps/failoverclusters/Enable-AccelNetManagement.md‎

Lines changed: 94 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,94 @@
1+
---
2+
description: Use this topic to help manage Windows and Windows Server technologies with Windows PowerShell.
3+
external help file: Microsoft.FailoverClusters.PowerShell.dll-Help.xml
4+
Module Name: FailoverClusters
5+
ms.date: 08/01/2024
6+
online version: https://learn.microsoft.com/powershell/module/failoverclusters/enable-accelnetmanagement?view=windowsserver2025-ps&wt.mc_id=ps-gethelp
7+
schema: 2.0.0
8+
title: Enable-AccelNetManagement
9+
---
10+
11+
# Enable-AccelNetManagement
12+
13+
## SYNOPSIS
14+
Enables Accelerated Networking Management cluster-wide.
15+
16+
## SYNTAX
17+
18+
```
19+
Enable-AccelNetManagement [-IntentName] <String> [[-NodeReservePercentage] <UInt32>]
20+
[<CommonParameters>]
21+
```
22+
23+
## DESCRIPTION
24+
25+
Enables Accelerated Networking Management cluster-wide, sets the numbers of nodes to reserve, and
26+
enables provided intent.
27+
28+
## EXAMPLES
29+
30+
### EXAMPLE 1
31+
32+
```powershell
33+
Enable-AccelNetManagement -IntentName "MyIntent" -NodeReservePercentage 10
34+
```
35+
36+
This example enables the `MyIntent` intent for Accelerated Networking Management and reserves
37+
**10%** of the nodes for that purpose. If the command is successful, it will return `$true`. If
38+
there is an error, it will return `$false`.
39+
40+
## PARAMETERS
41+
42+
### -IntentName
43+
44+
The intent name to be used for Accelerated Networking Management.
45+
46+
```yaml
47+
Type: String
48+
Parameter Sets: (All)
49+
Aliases:
50+
51+
Required: True
52+
Position: 1
53+
Default value: None
54+
Accept pipeline input: False
55+
Accept wildcard characters: False
56+
```
57+
58+
### -NodeReservePercentage
59+
60+
The percentage of cluster nodes that can be down simultaneously while still maintaining enough
61+
virtual functions for each VM chosen for Accelerated Networking Management.
62+
63+
If this parameter is left blank, a default of **50%** will be selected.
64+
65+
```yaml
66+
Type: UInt32
67+
Parameter Sets: (All)
68+
Aliases:
69+
70+
Required: False
71+
Position: 2
72+
Default value: $NODE_RESERVE_PERCENTAGE_DEFAULT
73+
Accept pipeline input: False
74+
Accept wildcard characters: False
75+
```
76+
77+
### CommonParameters
78+
79+
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable,
80+
-InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose,
81+
-WarningAction, and -WarningVariable. For more information, see
82+
[about_CommonParameters](/powershell/module/microsoft.powershell.core/about/about_commonparameters).
83+
84+
## INPUTS
85+
86+
## OUTPUTS
87+
88+
## NOTES
89+
90+
## RELATED LINKS
91+
92+
[Disable-AccelNetManagement](disable-accelnetmanagement.md)
93+
94+
[Get-AccelNetManagementPreReq](get-accelnetmanagementprereq.md)

‎docset/winserver2025-ps/failoverclusters/Enable-AccelNetVM.md‎

Lines changed: 93 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,93 @@
1+
---
2+
description: Use this topic to help manage Windows and Windows Server technologies with Windows PowerShell.
3+
external help file: Microsoft.FailoverClusters.PowerShell.dll-Help.xml
4+
Module Name: FailoverClusters
5+
ms.date: 08/01/2024
6+
online version: https://learn.microsoft.com/powershell/module/failoverclusters/enable-accelnetvm?view=windowsserver2025-ps&wt.mc_id=ps-gethelp
7+
schema: 2.0.0
8+
title: Enable-AccelNetVM
9+
---
10+
11+
# Enable-AccelNetVM
12+
13+
## SYNOPSIS
14+
Enables Accelerated Networking on a VM.
15+
16+
## SYNTAX
17+
18+
```
19+
Enable-AccelNetVM [-VMName] <String> [-Performance] <PerformanceWeight> [<CommonParameters>]
20+
```
21+
22+
## DESCRIPTION
23+
24+
Enables Accelerated Networking on a VM.
25+
26+
## EXAMPLES
27+
28+
### EXAMPLE 1
29+
30+
```powershell
31+
Enable-AccelNetVM -VMName "MyVM" -Performance High
32+
```
33+
34+
This example enables Accelerated Networking with the performance level set to `High` for the VM
35+
named `MyVM`.
36+
37+
## PARAMETERS
38+
39+
### -Performance
40+
41+
Sets the performance level. Acceptable values are:
42+
43+
- `Low`
44+
- `Medium`
45+
- `High`
46+
47+
```yaml
48+
Type: PerformanceWeight
49+
Parameter Sets: (All)
50+
Aliases:
51+
Accepted values: Low, Medium, High
52+
53+
Required: True
54+
Position: 2
55+
Default value: None
56+
Accept pipeline input: False
57+
Accept wildcard characters: False
58+
```
59+
60+
### -VMName
61+
62+
Specifies the name of the virtual machine.
63+
64+
```yaml
65+
Type: String
66+
Parameter Sets: (All)
67+
Aliases:
68+
69+
Required: True
70+
Position: 1
71+
Default value: None
72+
Accept pipeline input: False
73+
Accept wildcard characters: False
74+
```
75+
76+
### CommonParameters
77+
78+
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable,
79+
-InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose,
80+
-WarningAction, and -WarningVariable. For more information, see
81+
[about_CommonParameters](/powershell/module/microsoft.powershell.core/about/about_commonparameters).
82+
83+
## INPUTS
84+
85+
## OUTPUTS
86+
87+
## NOTES
88+
89+
## RELATED LINKS
90+
91+
[Disable-AccelNetVM](disable-accelnetvm.md)
92+
93+
[Set-AccelNetVM](set-accelnetvm.md)

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

Lines changed: 76 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,76 @@
1+
---
2+
description: Use this topic to help manage Windows and Windows Server technologies with Windows PowerShell.
3+
external help file: Microsoft.FailoverClusters.PowerShell.dll-Help.xml
4+
Module Name: FailoverClusters
5+
ms.date: 08/01/2024
6+
online version: https://learn.microsoft.com/powershell/module/failoverclusters/get-accelnetmanagementprereq?view=windowsserver2025-ps&wt.mc_id=ps-gethelp
7+
schema: 2.0.0
8+
title: Get-AccelNetManagementPreReq
9+
---
10+
11+
# Get-AccelNetManagementPreReq
12+
13+
## SYNOPSIS
14+
Informs the user if the cluster nodes support Accelerated Networking.
15+
16+
## SYNTAX
17+
18+
```
19+
Get-AccelNetManagementPreReq [[-IntentName] <String>] [<CommonParameters>]
20+
```
21+
22+
## DESCRIPTION
23+
24+
Retrieves information if the cluster nodes support Accelerated Networking, including verifying OS
25+
version and hyperthreading status.
26+
27+
## EXAMPLES
28+
29+
### Example 1
30+
31+
```powershell
32+
Get-AccelNetManagementPreReq -IntentName "MyIntent"
33+
```
34+
35+
This example checks if the cluster nodes support AccelNet for the intent named `MyIntent`.
36+
37+
## PARAMETERS
38+
39+
### -IntentName
40+
41+
The intent name to be used for AccelNet Management.
42+
43+
```yaml
44+
Type: String
45+
Parameter Sets: (All)
46+
Aliases:
47+
48+
Required: False
49+
Position: 0
50+
Default value: None
51+
Accept pipeline input: False
52+
Accept wildcard characters: False
53+
```
54+
55+
### CommonParameters
56+
57+
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable,
58+
-InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose,
59+
-WarningAction, and -WarningVariable. For more information, see
60+
[about_CommonParameters](/powershell/module/microsoft.powershell.core/about/about_commonparameters).
61+
62+
## INPUTS
63+
64+
### None
65+
66+
## OUTPUTS
67+
68+
### System.Object
69+
70+
## NOTES
71+
72+
## RELATED LINKS
73+
74+
[Disable-AccelNetManagement](disable-accelnetmanagement.md)
75+
76+
[Enable-AccelNetManagement](enable-accelnetmanagement.md)

0 commit comments

Comments
 (0)