Skip to content

Commit 1d2dfc1

Browse files
Ruchika-mittal01Ruchika-mittal01
authoredJan 30, 2025··
Merge pull request #3925 from MicrosoftDocs/main
Publish main to live, 01/30/25, 3:30 PM PT
2 parents 604d910 + d80b8a2 commit 1d2dfc1

11 files changed

+1132
-112
lines changed
 

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

+62
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

+73
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

+100
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

+112
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)

‎docset/winserver2025-ps/failoverclusters/FailoverClusters.md

+272-112
Large diffs are not rendered by default.

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

+52
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
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/get-accelnetmanagement?view=windowsserver2025-ps&wt.mc_id=ps-gethelp
7+
schema: 2.0.0
8+
title: Get-AccelNetManagement
9+
---
10+
11+
# Get-AccelNetManagement
12+
13+
## SYNOPSIS
14+
Gets the intent enabled for Accelerated Networking Management.
15+
16+
## SYNTAX
17+
18+
```
19+
Get-AccelNetManagement
20+
```
21+
22+
## DESCRIPTION
23+
24+
Retrieves the intent enabled for AccelNet Management.
25+
26+
## EXAMPLES
27+
28+
### EXAMPLE 1
29+
30+
```powershell
31+
Get-AccelNetManagement
32+
```
33+
34+
This example retrieves the enabled intent name.
35+
36+
## PARAMETERS
37+
38+
## INPUTS
39+
40+
## OUTPUTS
41+
42+
## NOTES
43+
44+
## RELATED LINKS
45+
46+
[Disable-AccelNetManagement](disable-accelnetmanagement.md)
47+
48+
[Enable-AccelNetManagement](enable-accelnetmanagement.md)
49+
50+
[Get-AccelNetManagementPreReq](get-accelnetmanagementprereq.md)
51+
52+
[Set-AccelNetManagement](set-accelnetmanagement.md)

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

+78
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,78 @@
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/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 Accelerated Networking Management. This parameter is required.
42+
43+
This value must be an integer greater than or equal to **0** and less than or equal to **99**.
44+
45+
```yaml
46+
Type: String
47+
Parameter Sets: (All)
48+
Aliases:
49+
50+
Required: False
51+
Position: 0
52+
Default value: None
53+
Accept pipeline input: False
54+
Accept wildcard characters: False
55+
```
56+
57+
### CommonParameters
58+
59+
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable,
60+
-InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose,
61+
-WarningAction, and -WarningVariable. For more information, see
62+
[about_CommonParameters](/powershell/module/microsoft.powershell.core/about/about_commonparameters).
63+
64+
## INPUTS
65+
66+
### None
67+
68+
## OUTPUTS
69+
70+
### System.Object
71+
72+
## NOTES
73+
74+
## RELATED LINKS
75+
76+
[Disable-AccelNetManagement](disable-accelnetmanagement.md)
77+
78+
[Enable-AccelNetManagement](enable-accelnetmanagement.md)

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

+100
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/get-accelnetvm?view=windowsserver2025-ps&wt.mc_id=ps-gethelp
7+
schema: 2.0.0
8+
title: Get-AccelNetVM
9+
---
10+
11+
# Get-AccelNetVM
12+
13+
## SYNOPSIS
14+
Gets VMs with Accelerated Networking.
15+
16+
## SYNTAX
17+
18+
```
19+
Get-AccelNetVM [[-VMName] <String>] [[-VM] <VirtualMachineBase>] [<CommonParameters>]
20+
```
21+
22+
## DESCRIPTION
23+
24+
Retrieves VMs where AccelNet is enabled.
25+
26+
## EXAMPLES
27+
28+
### EXAMPLE 1
29+
30+
```powershell
31+
Get-AccelNetVM -VMName "MyVM"
32+
```
33+
34+
This example retrieves a VM named `MyVM`.
35+
36+
If the **-VMName** parameter isn't provided, all VM names are retrieved.
37+
38+
### EXAMPLE 2
39+
40+
```powershell
41+
$vm = Get-VM -Name "MyVM"
42+
Get-AccelNetVM -VM $vm
43+
```
44+
45+
This example retrieves the VM object for a VM named `MyVM`.
46+
47+
## PARAMETERS
48+
49+
### -VMName
50+
51+
The Virtual Machine name.
52+
53+
```yaml
54+
Type: String
55+
Parameter Sets: (All)
56+
Aliases:
57+
58+
Required: False
59+
Position: 1
60+
Default value: None
61+
Accept pipeline input: False
62+
Accept wildcard characters: False
63+
```
64+
65+
### -VM
66+
67+
The VM object.
68+
69+
```yaml
70+
Type: VirtualMachineBase
71+
Parameter Sets: (All)
72+
Aliases:
73+
74+
Required: False
75+
Position: 2
76+
Default value: None
77+
Accept pipeline input: True (ByValue)
78+
Accept wildcard characters: False
79+
```
80+
81+
### CommonParameters
82+
83+
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable,
84+
-InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose,
85+
-WarningAction, and -WarningVariable. For more information, see
86+
[about_CommonParameters](/powershell/module/microsoft.powershell.core/about/about_commonparameters).
87+
88+
## INPUTS
89+
90+
## OUTPUTS
91+
92+
## NOTES
93+
94+
## RELATED LINKS
95+
96+
[Disable-AccelNetVM](disable-accelnetvm.md)
97+
98+
[Enable-AccelNetVM](enable-accelnetvm.md)
99+
100+
[Set-AccelNetVM](set-accelnetvm.md)

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

+85
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,85 @@
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/get-vmadaptersconnectedtoenabledintentswitch?view=windowsserver2025-ps&wt.mc_id=ps-gethelp
7+
schema: 2.0.0
8+
title: Get-VMAdaptersConnectedToEnabledIntentSwitch
9+
---
10+
11+
# Get-VMAdaptersConnectedToEnabledIntentSwitch
12+
13+
## SYNOPSIS
14+
Gets the adapters on the VM that are connected to the enabled intent switch.
15+
16+
## SYNTAX
17+
18+
```
19+
Get-VMAdaptersConnectedToEnabledIntentSwitch [[-VMName] <String>] [[-VM] <VirtualMachineBase>]
20+
[<CommonParameters>]
21+
```
22+
23+
## DESCRIPTION
24+
25+
Retrieves the adapters on the VM that are connected to the enabled intent switch.
26+
27+
## EXAMPLES
28+
29+
### EXAMPLE 1
30+
31+
```powershell
32+
Get-VMAdaptersConnectedToEnabledIntentSwitch -VMName "MyVM"
33+
```
34+
35+
This example retrieves the network adapter connected to the enabled intent switch from the VM named
36+
`MyVM`.
37+
38+
## PARAMETERS
39+
40+
### -VMName
41+
42+
Specifies the name of the virtual machine.
43+
44+
```yaml
45+
Type: String
46+
Parameter Sets: (All)
47+
Aliases:
48+
49+
Required: False
50+
Position: 1
51+
Default value: None
52+
Accept pipeline input: False
53+
Accept wildcard characters: False
54+
```
55+
56+
### -VM
57+
58+
The VM object.
59+
60+
```yaml
61+
Type: VirtualMachineBase
62+
Parameter Sets: (All)
63+
Aliases:
64+
65+
Required: False
66+
Position: 2
67+
Default value: None
68+
Accept pipeline input: True (ByValue)
69+
Accept wildcard characters: False
70+
```
71+
72+
### CommonParameters
73+
74+
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable,
75+
-InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose,
76+
-WarningAction, and -WarningVariable. For more information, see
77+
[about_CommonParameters](/powershell/module/microsoft.powershell.core/about/about_commonparameters).
78+
79+
## INPUTS
80+
81+
## OUTPUTS
82+
83+
## NOTES
84+
85+
## RELATED LINKS

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

+103
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,103 @@
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/set-accelnetmanagement?view=windowsserver2025-ps&wt.mc_id=ps-gethelp
7+
schema: 2.0.0
8+
title: Set-AccelNetManagement
9+
---
10+
11+
# Set-AccelNetManagement
12+
13+
## SYNOPSIS
14+
Sets Accelerated Networking Management cluster-wide.
15+
16+
## SYNTAX
17+
18+
```
19+
Set-AccelNetManagement [[-IntentName] <String>] [[-NodeReservePercentage] <UInt32>]
20+
[<CommonParameters>]
21+
```
22+
23+
## DESCRIPTION
24+
25+
Sets AccelNet Management cluster-wide. Also sets the number of nodes to reserve and enables the
26+
provided intent for AccelNet Management. Returns `$true` upon success, and `$false` otherwise.
27+
28+
If AccelNet Management is currently active with a certain intent, providing a value for the
29+
`-IntentName` parameter will disable the current AccelNet Management configuration. After disabling
30+
the current AccelNet Management configuration, AccelNet Management is reenabled based on the
31+
configuration of the new intent.
32+
33+
## EXAMPLES
34+
35+
### EXAMPLE 1
36+
37+
```powershell
38+
Set-AccelNetManagement -IntentName "LowPerformance" -NodeReservePercentage 10
39+
```
40+
41+
This example enables the `LowPerformance` intent for AccelNet Management and reserves `10` percent
42+
of the nodes for that purpose. If the command is successful, it will return `$true`. If there is an
43+
error, it will return `$false`.
44+
45+
## PARAMETERS
46+
47+
### -IntentName
48+
49+
The intent name to be used for AccelNet Management. This parameter is required.
50+
51+
This value must be an integer greater than or equal to **0** and less than or equal to **99**.
52+
53+
```yaml
54+
Type: String
55+
Parameter Sets: (All)
56+
Aliases:
57+
58+
Required: True
59+
Position: 1
60+
Default value: None
61+
Accept pipeline input: False
62+
Accept wildcard characters: False
63+
```
64+
65+
### -NodeReservePercentage
66+
67+
The percentage of cluster nodes that can be down simultaneously while still maintaining enough
68+
virtual functions for each VM chosen for Accelerated Networking Management.
69+
70+
```yaml
71+
Type: UInt32
72+
Parameter Sets: (All)
73+
Aliases:
74+
75+
Required: False
76+
Position: 2
77+
Default value: 0
78+
Accept pipeline input: False
79+
Accept wildcard characters: False
80+
```
81+
82+
### CommonParameters
83+
84+
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable,
85+
-InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose,
86+
-WarningAction, and -WarningVariable. For more information, see
87+
[about_CommonParameters](/powershell/module/microsoft.powershell.core/about/about_commonparameters).
88+
89+
## INPUTS
90+
91+
## OUTPUTS
92+
93+
## NOTES
94+
95+
## RELATED LINKS
96+
97+
[Disable-AccelNetManagement](disable-accelnetmanagement.md)
98+
99+
[Enable-AccelNetManagement](enable-accelnetmanagement.md)
100+
101+
[Get-AccelNetManagement](get-accelnetmanagement.md)
102+
103+
[Get-AccelNetManagementPreReq](get-accelnetmanagementprereq.md)

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

+95
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,95 @@
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/set-accelnetvm?view=windowsserver2025-ps&wt.mc_id=ps-gethelp
7+
schema: 2.0.0
8+
title: Set-AccelNetVM
9+
---
10+
11+
# Set-AccelNetVM
12+
13+
## SYNOPSIS
14+
Sets Accelerated Networking on a VM.
15+
16+
## SYNTAX
17+
18+
```
19+
Set-AccelNetVM [-VMName] <String> [-Performance] <PerformanceWeight> [<CommonParameters>]
20+
```
21+
22+
## DESCRIPTION
23+
24+
Sets Accelerated Networking on a VM.
25+
26+
## EXAMPLES
27+
28+
### EXAMPLE 1
29+
30+
```powershell
31+
Set-AccelNetVM -VMName "MyVM" -Performance High
32+
```
33+
34+
This example sets 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+
[Enable-AccelNetVM](enable-accelnetvm.md)
94+
95+
[Get-AccelNetVM](get-accelnetvm.md)

0 commit comments

Comments
 (0)
Please sign in to comment.