Skip to content

Commit

Permalink
Updates
Browse files Browse the repository at this point in the history
  • Loading branch information
Xelu86 committed Jan 23, 2025
1 parent e18ba44 commit 38c8af1
Show file tree
Hide file tree
Showing 8 changed files with 177 additions and 17 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -21,10 +21,10 @@ Disable-AccelNetManagement [<CommonParameters>]

## DESCRIPTION

Disables Accelerated Networking Management cluster-wide. This doesn't turn off SR-IOV on VMs.
Disables AccelNet Management cluster-wide. This doesn't turn off SR-IOV on VMs.

Disabling this feature on the cluster won't change any configuration settings on the VMs. They will
no longer be managed by Accelerated Networking or tracked by HUD.
no longer be managed by AccelNet or tracked by HUD.

## EXAMPLES

Expand All @@ -34,7 +34,7 @@ no longer be managed by Accelerated Networking or tracked by HUD.
Disable-AccelNetManagement
```

This example disables the Accelerated Networking Management layer on the cluster.
This example disables the AccelNet Management layer on the cluster.

## PARAMETERS

Expand All @@ -55,4 +55,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable

[Enable-AccelNetManagement](enable-accelnetmanagement.md)

[Get-AccelNetManagement](get-accelnetmanagement.md)

[Get-AccelNetManagementPreReq](get-accelnetmanagementprereq.md)

[Set-AccelNetManagement](set-accelnetmanagement.md)
Original file line number Diff line number Diff line change
Expand Up @@ -22,19 +22,19 @@ Enable-AccelNetManagement [-IntentName] <String> [[-NodeReservePercentage] <UInt

## DESCRIPTION

Enables Accelerated Networking Management cluster-wide, sets the numbers of nodes to reserve, and
enables provided intent.
Enables AccelNet Management cluster-wide. Also sets the number of nodes to reserve and enables the
provided intent for AccelNet Management.

## EXAMPLES

### EXAMPLE 1

```powershell
Enable-AccelNetManagement -IntentName "MyIntent" -NodeReservePercentage 10
Enable-AccelNetManagement -IntentName "MyIntent" -NodeReservePercentage 25
```

This example enables the `MyIntent` intent for Accelerated Networking Management and reserves
**10%** of the nodes for that purpose. If the command is successful, it will return `$true`. If
This example enables the `MyIntent` intent for Accelerated Networking Management and reserves `25`
percent of the nodes for that purpose. If the command is successful, it will return `$true`. If
there is an error, it will return `$false`.

## PARAMETERS
Expand Down Expand Up @@ -93,4 +93,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
[Disable-AccelNetManagement](disable-accelnetmanagement.md)
[Get-AccelNetManagement](get-accelnetmanagement.md)
[Get-AccelNetManagementPreReq](get-accelnetmanagementprereq.md)
[Set-AccelNetManagement](set-accelnetmanagement.md)
23 changes: 20 additions & 3 deletions docset/winserver2025-ps/failoverclusters/Enable-AccelNetVM.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,12 +16,13 @@ Enables Accelerated Networking on a VM.
## SYNTAX

```
Enable-AccelNetVM [-VMName] <String> [-Performance] <PerformanceWeight> [<CommonParameters>]
Enable-AccelNetVM [-VMName] <String> [-Performance] <PerformanceWeight> [[-VM] <VirtualMachineBase>]
[<CommonParameters>]
```

## DESCRIPTION

Enables Accelerated Networking on a VM.
Enables AccelNet on a VM.

## EXAMPLES

Expand All @@ -31,7 +32,7 @@ Enables Accelerated Networking on a VM.
Enable-AccelNetVM -VMName "MyVM" -Performance High
```

This example enables Accelerated Networking with the performance level set to `High` for the VM
This example enables AccelNet with the performance level set to `High` for the VM
named `MyVM`.

## PARAMETERS
Expand Down Expand Up @@ -73,6 +74,22 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -VM
The VM object.
```yaml
Type: VirtualMachineBase
Parameter Sets: (All)
Aliases:

Required: False
Position: 3
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False
```
### CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable,
Expand Down
11 changes: 9 additions & 2 deletions docset/winserver2025-ps/failoverclusters/FailoverClusters.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ Help Version: 5.0.3.3
Locale: en-US
Module Guid: cc3e946b-9141-48c2-95d8-d9e56594416a
Module Name: FailoverClusters
ms.date: 10/21/2022
ms.date: 01/22/2025
title: FailoverClusters
---

Expand All @@ -17,7 +17,10 @@ This reference provides cmdlet descriptions and syntax for all failover cluster-
lists the cmdlets in alphabetical order based on the verb at the beginning of the cmdlet. If these
cmdlets aren't available in your PowerShell session, you may need to add the
`Failover Cluster Module for Windows PowerShell` Feature, using the following PowerShell command:
`Add-WindowsFeature RSAT-Clustering-PowerShell`.

```powershell
Add-WindowsFeature RSAT-Clustering-PowerShell
```

## FailoverClusters Cmdlets

Expand Down Expand Up @@ -395,6 +398,10 @@ Turns off maintenance for a disk resource or Cluster Shared Volume within a fail

Sets Accelerated Networking on a VM.

### [Set-AccelNetManagement](Set-AccelNetManagement.md)

Sets Accelerated Networking Management cluster-wide.

### [Set-ClusterAffinityRule](Set-ClusterAffinityRule.md)

Enabled or Disable an affinity rule, and update the rule type.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ Get-AccelNetManagement

## DESCRIPTION

Retrieves the intent enabled for Accelerated Networking Management.
Retrieves the intent enabled for AccelNet Management.

## EXAMPLES

Expand All @@ -42,3 +42,11 @@ This example retrieves the enabled intent name.
## NOTES

## RELATED LINKS

[Disable-AccelNetManagement](disable-accelnetmanagement.md)

[Enable-AccelNetManagement](enable-accelnetmanagement.md)

[Get-AccelNetManagementPreReq](get-accelnetmanagementprereq.md)

[Set-AccelNetManagement](set-accelnetmanagement.md)
4 changes: 2 additions & 2 deletions docset/winserver2025-ps/failoverclusters/Get-AccelNetVM.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ Get-AccelNetVM [[-VMName] <String>] [[-VM] <VirtualMachineBase>] [<CommonParamet

## DESCRIPTION

Get VMs with Accelerated Networking.
Retrieves VMs where AccelNet is enabled.

## EXAMPLES

Expand All @@ -33,7 +33,7 @@ Get-AccelNetVM -VMName "MyVM"

This example retrieves a VM named `MyVM`.

If no VM name is provided, all VM names are retrieved.
If the **-VMName** parameter isn't provided, all VM names are retrieved.

### EXAMPLE 2

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,8 @@ Gets the adapters on the VM that are connected to the enabled intent switch.
## SYNTAX

```
Get-VMAdaptersConnectedToEnabledIntentSwitch [[-VMName] <String>] [<CommonParameters>]
Get-VMAdaptersConnectedToEnabledIntentSwitch [[-VMName] <String>] [[-VM] <VirtualMachineBase>]
[<CommonParameters>]
```

## DESCRIPTION
Expand Down Expand Up @@ -52,6 +53,22 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -VM
The VM object.
```yaml
Type: VirtualMachineBase
Parameter Sets: (All)
Aliases:

Required: False
Position: 2
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False
```
### CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable,
Expand Down
103 changes: 103 additions & 0 deletions docset/winserver2025-ps/failoverclusters/Set-AccelNetManagement.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,103 @@
---
description: Use this topic to help manage Windows and Windows Server technologies with Windows PowerShell.
external help file: Microsoft.FailoverClusters.PowerShell.dll-Help.xml
Module Name: FailoverClusters
ms.date: 01/22/2025
online version: https://learn.microsoft.com/powershell/module/failoverclusters/set-accelnetmanagement?view=windowsserver2025-ps&wt.mc_id=ps-gethelp
schema: 2.0.0
title: Set-AccelNetManagement
---

# Set-AccelNetManagement

## SYNOPSIS
Sets Accelerated Networking Management cluster-wide.

## SYNTAX

```
Set-AccelNetManagement [[-IntentName] <String>] [[-NodeReservePercentage] <UInt32>]
[<CommonParameters>]
```

## DESCRIPTION

Sets AccelNet Management cluster-wide. Also sets the number of nodes to reserve and enables the
provided intent for AccelNet Management. Returns `$true` upon success, and `$false` otherwise.

If AccelNet Management is currently active with a certain intent, providing a value for the
`-IntentName` parameter will disable the current AccelNet Management configuration. After disabling
the current AccelNet Management configuration, AccelNet Management is reenabled based on the
configuration of the new intent.

## EXAMPLES

### EXAMPLE 1

```powershell
Set-AccelNetManagement -IntentName "LowPerformance" -NodeReservePercentage 10
```

This example enables the `LowPerformance` intent for AccelNet Management and reserves `10` percent
of the nodes for that purpose. If the command is successful, it will return `$true`. If there is an
error, it will return `$false`.

## PARAMETERS

### -IntentName

The intent name to be used for AccelNet Management. This parameter is required.

This value must be an integer greater than or equal to **0** and less than or equal to **99**.

```yaml
Type: String
Parameter Sets: (All)
Aliases:

Required: True
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -NodeReservePercentage
The percentage of cluster nodes that can be down simultaneously while still maintaining enough
virtual functions for each VM chosen for Accelerated Networking Management.
```yaml
Type: UInt32
Parameter Sets: (All)
Aliases:

Required: False
Position: 2
Default value: 0
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
## OUTPUTS
## NOTES
## RELATED LINKS
[Disable-AccelNetManagement](disable-accelnetmanagement.md)
[Enable-AccelNetManagement](enable-accelnetmanagement.md)
[Get-AccelNetManagement](get-accelnetmanagement.md)
[Get-AccelNetManagementPreReq](get-accelnetmanagementprereq.md)

0 comments on commit 38c8af1

Please sign in to comment.