Skip to content

Commit d80b8a2

Browse files
Xelu86Xelu86
authored
Merge pull request #3859 from Xelu86/update_accelnet
Update AccelNet cmdlets for WS25
2 parents 675c671 + f70183a commit d80b8a2

11 files changed

+1132
-112
lines changed

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

Lines changed: 62 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,62 @@
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: 01/22/2025
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 AccelNet Management cluster-wide. This doesn't turn off SR-IOV on VMs.
25+
26+
Disabling this feature on the cluster won't change any configuration settings on the VMs. They will
27+
no longer be managed by AccelNet or tracked by HUD.
28+
29+
## EXAMPLES
30+
31+
### EXAMPLE 1
32+
33+
```powershell
34+
Disable-AccelNetManagement
35+
```
36+
37+
This example disables the AccelNet Management layer on the cluster.
38+
39+
## PARAMETERS
40+
41+
### CommonParameters
42+
43+
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable,
44+
-InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose,
45+
-WarningAction, and -WarningVariable. For more information, see
46+
[about_CommonParameters](/powershell/module/microsoft.powershell.core/about/about_commonparameters).
47+
48+
## INPUTS
49+
50+
## OUTPUTS
51+
52+
## NOTES
53+
54+
## RELATED LINKS
55+
56+
[Enable-AccelNetManagement](enable-accelnetmanagement.md)
57+
58+
[Get-AccelNetManagement](get-accelnetmanagement.md)
59+
60+
[Get-AccelNetManagementPreReq](get-accelnetmanagementprereq.md)
61+
62+
[Set-AccelNetManagement](set-accelnetmanagement.md)

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

Lines changed: 73 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,73 @@
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: 01/22/2025
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+
[Get-AccelNetVM](get-accelnetvm.md)
72+
73+
[Set-AccelNetVM](set-accelnetvm.md)

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

Lines changed: 100 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,100 @@
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: 01/22/2025
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 AccelNet Management cluster-wide. Also sets the number of nodes to reserve and enables the
26+
provided intent for AccelNet Management.
27+
28+
## EXAMPLES
29+
30+
### EXAMPLE 1
31+
32+
```powershell
33+
Enable-AccelNetManagement -IntentName "MyIntent" -NodeReservePercentage 25
34+
```
35+
36+
This example enables the `MyIntent` intent for Accelerated Networking Management and reserves `25`
37+
percent 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. This parameter is required.
45+
46+
This value must be an integer greater than or equal to **0** and less than or equal to **99**.
47+
48+
```yaml
49+
Type: String
50+
Parameter Sets: (All)
51+
Aliases:
52+
53+
Required: True
54+
Position: 1
55+
Default value: None
56+
Accept pipeline input: False
57+
Accept wildcard characters: False
58+
```
59+
60+
### -NodeReservePercentage
61+
62+
The percentage of cluster nodes that can be down simultaneously while still maintaining enough
63+
virtual functions for each VM chosen for Accelerated Networking Management.
64+
65+
If this parameter is left blank, a default of **50%** will be assigned.
66+
67+
```yaml
68+
Type: UInt32
69+
Parameter Sets: (All)
70+
Aliases:
71+
72+
Required: False
73+
Position: 2
74+
Default value: $NODE_RESERVE_PERCENTAGE_DEFAULT
75+
Accept pipeline input: False
76+
Accept wildcard characters: False
77+
```
78+
79+
### CommonParameters
80+
81+
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable,
82+
-InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose,
83+
-WarningAction, and -WarningVariable. For more information, see
84+
[about_CommonParameters](/powershell/module/microsoft.powershell.core/about/about_commonparameters).
85+
86+
## INPUTS
87+
88+
## OUTPUTS
89+
90+
## NOTES
91+
92+
## RELATED LINKS
93+
94+
[Disable-AccelNetManagement](disable-accelnetmanagement.md)
95+
96+
[Get-AccelNetManagement](get-accelnetmanagement.md)
97+
98+
[Get-AccelNetManagementPreReq](get-accelnetmanagementprereq.md)
99+
100+
[Set-AccelNetManagement](set-accelnetmanagement.md)

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

Lines changed: 112 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,112 @@
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: 01/22/2025
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> [[-VM] <VirtualMachineBase>]
20+
[<CommonParameters>]
21+
```
22+
23+
## DESCRIPTION
24+
25+
Enables AccelNet on a VM.
26+
27+
## EXAMPLES
28+
29+
### EXAMPLE 1
30+
31+
```powershell
32+
Enable-AccelNetVM -VMName "MyVM" -Performance High
33+
```
34+
35+
This example enables AccelNet with the performance level set to `High` for the VM
36+
named `MyVM`.
37+
38+
## PARAMETERS
39+
40+
### -Performance
41+
42+
Sets the performance level. This parameter is required. Acceptable values are:
43+
44+
- `Low`
45+
- `Medium`
46+
- `High`
47+
48+
```yaml
49+
Type: PerformanceWeight
50+
Parameter Sets: (All)
51+
Aliases:
52+
Accepted values: Low, Medium, High
53+
54+
Required: True
55+
Position: 2
56+
Default value: None
57+
Accept pipeline input: False
58+
Accept wildcard characters: False
59+
```
60+
61+
### -VMName
62+
63+
Specifies the name of the virtual machine. This parameter is required.
64+
65+
```yaml
66+
Type: String
67+
Parameter Sets: (All)
68+
Aliases:
69+
70+
Required: True
71+
Position: 1
72+
Default value: None
73+
Accept pipeline input: False
74+
Accept wildcard characters: False
75+
```
76+
77+
### -VM
78+
79+
The VM object.
80+
81+
```yaml
82+
Type: VirtualMachineBase
83+
Parameter Sets: (All)
84+
Aliases:
85+
86+
Required: False
87+
Position: 3
88+
Default value: None
89+
Accept pipeline input: True (ByValue)
90+
Accept wildcard characters: False
91+
```
92+
93+
### CommonParameters
94+
95+
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable,
96+
-InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose,
97+
-WarningAction, and -WarningVariable. For more information, see
98+
[about_CommonParameters](/powershell/module/microsoft.powershell.core/about/about_commonparameters).
99+
100+
## INPUTS
101+
102+
## OUTPUTS
103+
104+
## NOTES
105+
106+
## RELATED LINKS
107+
108+
[Disable-AccelNetVM](disable-accelnetvm.md)
109+
110+
[Get-AccelNetVM](get-accelnetvm.md)
111+
112+
[Set-AccelNetVM](set-accelnetvm.md)

0 commit comments

Comments
 (0)