From a5b7e83c9a5abdf4a66052b175ec3307587750fc Mon Sep 17 00:00:00 2001 From: Xelu86 <103963494+Xelu86@users.noreply.github.com> Date: Tue, 30 Jul 2024 21:53:12 -0400 Subject: [PATCH 1/8] Updated AccelNet cmdlets --- .../Disable-AccelNetManagement.md | 55 +++++++++++ .../failoverclusters/Disable-AccelNetVM.md | 71 ++++++++++++++ .../Enable-AccelNetManagement.md | 94 +++++++++++++++++++ .../failoverclusters/Enable-AccelNetVM.md | 93 ++++++++++++++++++ .../Get-AccelNetManagementPreReq.md | 76 +++++++++++++++ .../failoverclusters/Get-EnabledIntentName.md | 44 +++++++++ ...MAdaptersConnectedToEnabledIntentSwitch.md | 68 ++++++++++++++ .../failoverclusters/Set-AccelNetVM.md | 93 ++++++++++++++++++ 8 files changed, 594 insertions(+) create mode 100644 docset/winserver2025-ps/failoverclusters/Disable-AccelNetManagement.md create mode 100644 docset/winserver2025-ps/failoverclusters/Disable-AccelNetVM.md create mode 100644 docset/winserver2025-ps/failoverclusters/Enable-AccelNetManagement.md create mode 100644 docset/winserver2025-ps/failoverclusters/Enable-AccelNetVM.md create mode 100644 docset/winserver2025-ps/failoverclusters/Get-AccelNetManagementPreReq.md create mode 100644 docset/winserver2025-ps/failoverclusters/Get-EnabledIntentName.md create mode 100644 docset/winserver2025-ps/failoverclusters/Get-VMAdaptersConnectedToEnabledIntentSwitch.md create mode 100644 docset/winserver2025-ps/failoverclusters/Set-AccelNetVM.md diff --git a/docset/winserver2025-ps/failoverclusters/Disable-AccelNetManagement.md b/docset/winserver2025-ps/failoverclusters/Disable-AccelNetManagement.md new file mode 100644 index 0000000000..e498425897 --- /dev/null +++ b/docset/winserver2025-ps/failoverclusters/Disable-AccelNetManagement.md @@ -0,0 +1,55 @@ +--- +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: 08/01/2024 +online version: https://learn.microsoft.com/powershell/module/failoverclusters/disable-accelnetmanagement?view=windowsserver2025-ps&wt.mc_id=ps-gethelp +schema: 2.0.0 +title: Disable-AccelNetManagement +--- + +# Disable-AccelNetManagement + +## SYNOPSIS +Disables Accelerated Networking Management cluster-wide. + +## SYNTAX + +``` +Disable-AccelNetManagement [] +``` + +## DESCRIPTION + +Disables Accelerated Networking Management cluster-wide. This doesn't turn off SR-IOV on VMs. + +## EXAMPLES + +### EXAMPLE 1 + +```powershell +Disable-AccelNetManagement +``` + +This example disables the Accelerated Networking Management layer on the cluster. + +## PARAMETERS + +### 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 + +[Enable-AccelNetManagement](enable-accelnetmanagement.md) + +[Get-AccelNetManagementPreReq](get-accelnetmanagementprereq.md) diff --git a/docset/winserver2025-ps/failoverclusters/Disable-AccelNetVM.md b/docset/winserver2025-ps/failoverclusters/Disable-AccelNetVM.md new file mode 100644 index 0000000000..e1f7f3a3fa --- /dev/null +++ b/docset/winserver2025-ps/failoverclusters/Disable-AccelNetVM.md @@ -0,0 +1,71 @@ +--- +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: 08/01/2024 +online version: https://learn.microsoft.com/powershell/module/failoverclusters/disable-accelnetvm?view=windowsserver2025-ps&wt.mc_id=ps-gethelp +schema: 2.0.0 +title: Disable-AccelNetVM +--- + +# Disable-AccelNetVM + +## SYNOPSIS +Disables Accelerated Networking on a VM. + +## SYNTAX + +``` +Disable-AccelNetVM [-VMName] [] +``` + +## DESCRIPTION + +Disables Accelerated Networking on a VM. + +## EXAMPLES + +### EXAMPLE 1 + +```powershell +Disable-AccelNetVM -VMName "MyVM" +``` + +This example disables Accelerated Networking for the VM named `MyVM`. + +## PARAMETERS + +### -VMName + +Specifies the name of the virtual machine. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +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 + +[Enable-AccelNetVM](enable-accelnetvm.md) + +[Set-AccelNetVM](set-accelnetvm.md) diff --git a/docset/winserver2025-ps/failoverclusters/Enable-AccelNetManagement.md b/docset/winserver2025-ps/failoverclusters/Enable-AccelNetManagement.md new file mode 100644 index 0000000000..40912b61cb --- /dev/null +++ b/docset/winserver2025-ps/failoverclusters/Enable-AccelNetManagement.md @@ -0,0 +1,94 @@ +--- +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: 08/01/2024 +online version: https://learn.microsoft.com/powershell/module/failoverclusters/enable-accelnetmanagement?view=windowsserver2025-ps&wt.mc_id=ps-gethelp +schema: 2.0.0 +title: Enable-AccelNetManagement +--- + +# Enable-AccelNetManagement + +## SYNOPSIS +Enables Accelerated Networking Management cluster-wide. + +## SYNTAX + +``` +Enable-AccelNetManagement [-IntentName] [[-NodeReservePercentage] ] + [] +``` + +## DESCRIPTION + +Enables Accelerated Networking Management cluster-wide, sets the numbers of nodes to reserve, and +enables provided intent. + +## EXAMPLES + +### EXAMPLE 1 + +```powershell +Enable-AccelNetManagement -IntentName "MyIntent" -NodeReservePercentage 10 +``` + +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 +there is an error, it will return `$false`. + +## PARAMETERS + +### -IntentName + +The intent name to be used for Accelerated Networking Management. + +```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. + +If this parameter is left blank, a default of **50%** will be selected. + +```yaml +Type: UInt32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: 2 +Default value: $NODE_RESERVE_PERCENTAGE_DEFAULT +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) + +[Get-AccelNetManagementPreReq](get-accelnetmanagementprereq.md) diff --git a/docset/winserver2025-ps/failoverclusters/Enable-AccelNetVM.md b/docset/winserver2025-ps/failoverclusters/Enable-AccelNetVM.md new file mode 100644 index 0000000000..29b07ce9d7 --- /dev/null +++ b/docset/winserver2025-ps/failoverclusters/Enable-AccelNetVM.md @@ -0,0 +1,93 @@ +--- +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: 08/01/2024 +online version: https://learn.microsoft.com/powershell/module/failoverclusters/enable-accelnetvm?view=windowsserver2025-ps&wt.mc_id=ps-gethelp +schema: 2.0.0 +title: Enable-AccelNetVM +--- + +# Enable-AccelNetVM + +## SYNOPSIS +Enables Accelerated Networking on a VM. + +## SYNTAX + +``` +Enable-AccelNetVM [-VMName] [-Performance] [] +``` + +## DESCRIPTION + +Enables Accelerated Networking on a VM. + +## EXAMPLES + +### EXAMPLE 1 + +```powershell +Enable-AccelNetVM -VMName "MyVM" -Performance High +``` + +This example enables Accelerated Networking with the performance level set to `High` for the VM +named `MyVM`. + +## PARAMETERS + +### -Performance + +Sets the performance level. Acceptable values are: + +- `Low` +- `Medium` +- `High` + +```yaml +Type: PerformanceWeight +Parameter Sets: (All) +Aliases: +Accepted values: Low, Medium, High + +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VMName + +Specifies the name of the virtual machine. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +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-AccelNetVM](disable-accelnetvm.md) + +[Set-AccelNetVM](set-accelnetvm.md) diff --git a/docset/winserver2025-ps/failoverclusters/Get-AccelNetManagementPreReq.md b/docset/winserver2025-ps/failoverclusters/Get-AccelNetManagementPreReq.md new file mode 100644 index 0000000000..a0cf3d7055 --- /dev/null +++ b/docset/winserver2025-ps/failoverclusters/Get-AccelNetManagementPreReq.md @@ -0,0 +1,76 @@ +--- +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: 08/01/2024 +online version: https://learn.microsoft.com/powershell/module/failoverclusters/get-accelnetmanagementprereq?view=windowsserver2025-ps&wt.mc_id=ps-gethelp +schema: 2.0.0 +title: Get-AccelNetManagementPreReq +--- + +# Get-AccelNetManagementPreReq + +## SYNOPSIS +Informs the user if the cluster nodes support Accelerated Networking. + +## SYNTAX + +``` +Get-AccelNetManagementPreReq [[-IntentName] ] [] +``` + +## DESCRIPTION + +Retrieves information if the cluster nodes support Accelerated Networking, including verifying OS +version and hyperthreading status. + +## EXAMPLES + +### Example 1 + +```powershell +Get-AccelNetManagementPreReq -IntentName "MyIntent" +``` + +This example checks if the cluster nodes support AccelNet for the intent named `MyIntent`. + +## PARAMETERS + +### -IntentName + +The intent name to be used for AccelNet Management. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 0 +Default value: None +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 + +### None + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS + +[Disable-AccelNetManagement](disable-accelnetmanagement.md) + +[Enable-AccelNetManagement](enable-accelnetmanagement.md) diff --git a/docset/winserver2025-ps/failoverclusters/Get-EnabledIntentName.md b/docset/winserver2025-ps/failoverclusters/Get-EnabledIntentName.md new file mode 100644 index 0000000000..a79d0ed3e3 --- /dev/null +++ b/docset/winserver2025-ps/failoverclusters/Get-EnabledIntentName.md @@ -0,0 +1,44 @@ +--- +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: 08/01/2024 +online version: https://learn.microsoft.com/powershell/module/failoverclusters/get-enabledintentname?view=windowsserver2025-ps&wt.mc_id=ps-gethelp +schema: 2.0.0 +title: Get-EnabledIntentName +--- + +# Get-EnabledIntentName + +## SYNOPSIS +Gets the intent enabled for Accelerated Networking Management. + +## SYNTAX + +``` +Get-EnabledIntentName +``` + +## DESCRIPTION + +Gets the intent enabled for Accelerated Networking Management. + +## EXAMPLES + +### EXAMPLE 1 + +```powershell +Get-EnabledIntentName +``` + +This example retrieves the enabled intent name. + +## PARAMETERS + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/docset/winserver2025-ps/failoverclusters/Get-VMAdaptersConnectedToEnabledIntentSwitch.md b/docset/winserver2025-ps/failoverclusters/Get-VMAdaptersConnectedToEnabledIntentSwitch.md new file mode 100644 index 0000000000..6222854319 --- /dev/null +++ b/docset/winserver2025-ps/failoverclusters/Get-VMAdaptersConnectedToEnabledIntentSwitch.md @@ -0,0 +1,68 @@ +--- +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: 08/01/2024 +online version: https://learn.microsoft.com/powershell/module/failoverclusters/get-vmadaptersconnectedtoenabledintentswitch?view=windowsserver2025-ps&wt.mc_id=ps-gethelp +schema: 2.0.0 +title: Get-VMAdaptersConnectedToEnabledIntentSwitch +--- + +# Get-VMAdaptersConnectedToEnabledIntentSwitch + +## SYNOPSIS +Gets the adapters on the VM that are connected to the enabled intent switch. + +## SYNTAX + +``` +Get-VMAdaptersConnectedToEnabledIntentSwitch [[-VMName] ] [] +``` + +## DESCRIPTION + +Retrieves the adapters on the VM that are connected to the enabled intent switch. + +## EXAMPLES + +### EXAMPLE 1 + +```powershell +Get-VMAdaptersConnectedToEnabledIntentSwitch -VMName "MyVM" +``` + +This example retrieves the network adapter connected to the enabled intent switch from the VM named +`MyVM`. + +## PARAMETERS + +### -VMName + +Specifies the name of the virtual machine. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 1 +Default value: None +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 diff --git a/docset/winserver2025-ps/failoverclusters/Set-AccelNetVM.md b/docset/winserver2025-ps/failoverclusters/Set-AccelNetVM.md new file mode 100644 index 0000000000..40de98bff5 --- /dev/null +++ b/docset/winserver2025-ps/failoverclusters/Set-AccelNetVM.md @@ -0,0 +1,93 @@ +--- +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: 08/01/2024 +online version: https://learn.microsoft.com/powershell/module/failoverclusters/set-accelnetvm?view=windowsserver2025-ps&wt.mc_id=ps-gethelp +schema: 2.0.0 +title: Set-AccelNetVM +--- + +# Set-AccelNetVM + +## SYNOPSIS +Sets Accelerated Networking on a VM. + +## SYNTAX + +``` +Set-AccelNetVM [-VMName] [-Performance] [] +``` + +## DESCRIPTION + +Sets Accelerated Networking on a VM. + +## EXAMPLES + +### EXAMPLE 1 + +```powershell +Set-AccelNetVM -VMName "MyVM" -Performance High +``` + +This example sets Accelerated Networking with the performance level set to `High` for the VM +named `MyVM`. + +## PARAMETERS + +### -Performance + +Sets the performance level. Acceptable values are: + +- `Low` +- `Medium` +- `High` + +```yaml +Type: PerformanceWeight +Parameter Sets: (All) +Aliases: +Accepted values: Low, Medium, High + +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VMName + +Specifies the name of the virtual machine. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +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-AccelNetVM](disable-accelnetvm.md) + +[Enable-AccelNetVM](enable-accelnetvm.md) From 6ff39b4d9eaf76dab5b165e23b02fa4537a5ae18 Mon Sep 17 00:00:00 2001 From: Xelu86 <103963494+Xelu86@users.noreply.github.com> Date: Wed, 31 Jul 2024 12:08:42 -0400 Subject: [PATCH 2/8] Updates --- .../failoverclusters/Disable-AccelNetManagement.md | 3 +++ .../failoverclusters/Enable-AccelNetManagement.md | 6 ++++-- .../winserver2025-ps/failoverclusters/Enable-AccelNetVM.md | 4 ++-- .../failoverclusters/Get-AccelNetManagementPreReq.md | 4 +++- .../failoverclusters/Get-EnabledIntentName.md | 2 +- 5 files changed, 13 insertions(+), 6 deletions(-) diff --git a/docset/winserver2025-ps/failoverclusters/Disable-AccelNetManagement.md b/docset/winserver2025-ps/failoverclusters/Disable-AccelNetManagement.md index e498425897..6e318c9f04 100644 --- a/docset/winserver2025-ps/failoverclusters/Disable-AccelNetManagement.md +++ b/docset/winserver2025-ps/failoverclusters/Disable-AccelNetManagement.md @@ -23,6 +23,9 @@ Disable-AccelNetManagement [] Disables Accelerated Networking 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. + ## EXAMPLES ### EXAMPLE 1 diff --git a/docset/winserver2025-ps/failoverclusters/Enable-AccelNetManagement.md b/docset/winserver2025-ps/failoverclusters/Enable-AccelNetManagement.md index 40912b61cb..4a65607420 100644 --- a/docset/winserver2025-ps/failoverclusters/Enable-AccelNetManagement.md +++ b/docset/winserver2025-ps/failoverclusters/Enable-AccelNetManagement.md @@ -41,7 +41,9 @@ there is an error, it will return `$false`. ### -IntentName -The intent name to be used for Accelerated Networking Management. +The intent name to be used for Accelerated Networking 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 @@ -60,7 +62,7 @@ Accept wildcard characters: False The percentage of cluster nodes that can be down simultaneously while still maintaining enough virtual functions for each VM chosen for Accelerated Networking Management. -If this parameter is left blank, a default of **50%** will be selected. +If this parameter is left blank, a default of **50%** will be assigned. ```yaml Type: UInt32 diff --git a/docset/winserver2025-ps/failoverclusters/Enable-AccelNetVM.md b/docset/winserver2025-ps/failoverclusters/Enable-AccelNetVM.md index 29b07ce9d7..31c15c2c4e 100644 --- a/docset/winserver2025-ps/failoverclusters/Enable-AccelNetVM.md +++ b/docset/winserver2025-ps/failoverclusters/Enable-AccelNetVM.md @@ -38,7 +38,7 @@ named `MyVM`. ### -Performance -Sets the performance level. Acceptable values are: +Sets the performance level. This parameter is required. Acceptable values are: - `Low` - `Medium` @@ -59,7 +59,7 @@ Accept wildcard characters: False ### -VMName -Specifies the name of the virtual machine. +Specifies the name of the virtual machine. This parameter is required. ```yaml Type: String diff --git a/docset/winserver2025-ps/failoverclusters/Get-AccelNetManagementPreReq.md b/docset/winserver2025-ps/failoverclusters/Get-AccelNetManagementPreReq.md index a0cf3d7055..39c3edfa31 100644 --- a/docset/winserver2025-ps/failoverclusters/Get-AccelNetManagementPreReq.md +++ b/docset/winserver2025-ps/failoverclusters/Get-AccelNetManagementPreReq.md @@ -38,7 +38,9 @@ This example checks if the cluster nodes support AccelNet for the intent named ` ### -IntentName -The intent name to be used for AccelNet Management. +The intent name to be used for Accelerated Networking 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 diff --git a/docset/winserver2025-ps/failoverclusters/Get-EnabledIntentName.md b/docset/winserver2025-ps/failoverclusters/Get-EnabledIntentName.md index a79d0ed3e3..5d1f8fbace 100644 --- a/docset/winserver2025-ps/failoverclusters/Get-EnabledIntentName.md +++ b/docset/winserver2025-ps/failoverclusters/Get-EnabledIntentName.md @@ -21,7 +21,7 @@ Get-EnabledIntentName ## DESCRIPTION -Gets the intent enabled for Accelerated Networking Management. +Retrieves the enabled intent for Accelerated Networking Management. ## EXAMPLES From 3a897fc0b0ca7dcb929076225296d18b4ce4fe24 Mon Sep 17 00:00:00 2001 From: Xelu86 <103963494+Xelu86@users.noreply.github.com> Date: Wed, 22 Jan 2025 14:32:41 -0500 Subject: [PATCH 3/8] Updates --- .../failoverclusters/Disable-AccelNetVM.md | 2 ++ .../failoverclusters/Enable-AccelNetVM.md | 2 ++ ...nabledIntentName.md => Get-AccelNetManagement.md} | 12 ++++++------ .../failoverclusters/Set-AccelNetVM.md | 2 ++ 4 files changed, 12 insertions(+), 6 deletions(-) rename docset/winserver2025-ps/failoverclusters/{Get-EnabledIntentName.md => Get-AccelNetManagement.md} (70%) diff --git a/docset/winserver2025-ps/failoverclusters/Disable-AccelNetVM.md b/docset/winserver2025-ps/failoverclusters/Disable-AccelNetVM.md index e1f7f3a3fa..bc27f3ca4b 100644 --- a/docset/winserver2025-ps/failoverclusters/Disable-AccelNetVM.md +++ b/docset/winserver2025-ps/failoverclusters/Disable-AccelNetVM.md @@ -68,4 +68,6 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable [Enable-AccelNetVM](enable-accelnetvm.md) +[Get-AccelNetVM](get-accelnetvm.md) + [Set-AccelNetVM](set-accelnetvm.md) diff --git a/docset/winserver2025-ps/failoverclusters/Enable-AccelNetVM.md b/docset/winserver2025-ps/failoverclusters/Enable-AccelNetVM.md index 31c15c2c4e..4e13b38722 100644 --- a/docset/winserver2025-ps/failoverclusters/Enable-AccelNetVM.md +++ b/docset/winserver2025-ps/failoverclusters/Enable-AccelNetVM.md @@ -90,4 +90,6 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable [Disable-AccelNetVM](disable-accelnetvm.md) +[Get-AccelNetVM](get-accelnetvm.md) + [Set-AccelNetVM](set-accelnetvm.md) diff --git a/docset/winserver2025-ps/failoverclusters/Get-EnabledIntentName.md b/docset/winserver2025-ps/failoverclusters/Get-AccelNetManagement.md similarity index 70% rename from docset/winserver2025-ps/failoverclusters/Get-EnabledIntentName.md rename to docset/winserver2025-ps/failoverclusters/Get-AccelNetManagement.md index 5d1f8fbace..5a354107f8 100644 --- a/docset/winserver2025-ps/failoverclusters/Get-EnabledIntentName.md +++ b/docset/winserver2025-ps/failoverclusters/Get-AccelNetManagement.md @@ -3,12 +3,12 @@ description: Use this topic to help manage Windows and Windows Server technologi external help file: Microsoft.FailoverClusters.PowerShell.dll-Help.xml Module Name: FailoverClusters ms.date: 08/01/2024 -online version: https://learn.microsoft.com/powershell/module/failoverclusters/get-enabledintentname?view=windowsserver2025-ps&wt.mc_id=ps-gethelp +online version: https://learn.microsoft.com/powershell/module/failoverclusters/get-accelnetmanagement?view=windowsserver2025-ps&wt.mc_id=ps-gethelp schema: 2.0.0 -title: Get-EnabledIntentName +title: Get-AccelNetManagement --- -# Get-EnabledIntentName +# Get-AccelNetManagement ## SYNOPSIS Gets the intent enabled for Accelerated Networking Management. @@ -16,19 +16,19 @@ Gets the intent enabled for Accelerated Networking Management. ## SYNTAX ``` -Get-EnabledIntentName +Get-AccelNetManagement ``` ## DESCRIPTION -Retrieves the enabled intent for Accelerated Networking Management. +Retrieves the intent enabled for Accelerated Networking Management. ## EXAMPLES ### EXAMPLE 1 ```powershell -Get-EnabledIntentName +Get-AccelNetManagement ``` This example retrieves the enabled intent name. diff --git a/docset/winserver2025-ps/failoverclusters/Set-AccelNetVM.md b/docset/winserver2025-ps/failoverclusters/Set-AccelNetVM.md index 40de98bff5..9cc86b1e8f 100644 --- a/docset/winserver2025-ps/failoverclusters/Set-AccelNetVM.md +++ b/docset/winserver2025-ps/failoverclusters/Set-AccelNetVM.md @@ -91,3 +91,5 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable [Disable-AccelNetVM](disable-accelnetvm.md) [Enable-AccelNetVM](enable-accelnetvm.md) + +[Get-AccelNetVM](get-accelnetvm.md) From 21bf25ba202b3b4e11c35d9ebc52459e9ca5b663 Mon Sep 17 00:00:00 2001 From: Xelu86 <103963494+Xelu86@users.noreply.github.com> Date: Wed, 22 Jan 2025 14:51:39 -0500 Subject: [PATCH 4/8] Updates --- .../failoverclusters/Disable-AccelNetManagement.md | 2 +- docset/winserver2025-ps/failoverclusters/Disable-AccelNetVM.md | 2 +- .../failoverclusters/Enable-AccelNetManagement.md | 2 +- docset/winserver2025-ps/failoverclusters/Enable-AccelNetVM.md | 2 +- .../winserver2025-ps/failoverclusters/Get-AccelNetManagement.md | 2 +- .../failoverclusters/Get-AccelNetManagementPreReq.md | 2 +- .../Get-VMAdaptersConnectedToEnabledIntentSwitch.md | 2 +- docset/winserver2025-ps/failoverclusters/Set-AccelNetVM.md | 2 +- 8 files changed, 8 insertions(+), 8 deletions(-) diff --git a/docset/winserver2025-ps/failoverclusters/Disable-AccelNetManagement.md b/docset/winserver2025-ps/failoverclusters/Disable-AccelNetManagement.md index 6e318c9f04..72a1ccf4ff 100644 --- a/docset/winserver2025-ps/failoverclusters/Disable-AccelNetManagement.md +++ b/docset/winserver2025-ps/failoverclusters/Disable-AccelNetManagement.md @@ -2,7 +2,7 @@ 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: 08/01/2024 +ms.date: 01/22/2025 online version: https://learn.microsoft.com/powershell/module/failoverclusters/disable-accelnetmanagement?view=windowsserver2025-ps&wt.mc_id=ps-gethelp schema: 2.0.0 title: Disable-AccelNetManagement diff --git a/docset/winserver2025-ps/failoverclusters/Disable-AccelNetVM.md b/docset/winserver2025-ps/failoverclusters/Disable-AccelNetVM.md index bc27f3ca4b..4c8a54dd92 100644 --- a/docset/winserver2025-ps/failoverclusters/Disable-AccelNetVM.md +++ b/docset/winserver2025-ps/failoverclusters/Disable-AccelNetVM.md @@ -2,7 +2,7 @@ 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: 08/01/2024 +ms.date: 01/22/2025 online version: https://learn.microsoft.com/powershell/module/failoverclusters/disable-accelnetvm?view=windowsserver2025-ps&wt.mc_id=ps-gethelp schema: 2.0.0 title: Disable-AccelNetVM diff --git a/docset/winserver2025-ps/failoverclusters/Enable-AccelNetManagement.md b/docset/winserver2025-ps/failoverclusters/Enable-AccelNetManagement.md index 4a65607420..c5a79b8d1a 100644 --- a/docset/winserver2025-ps/failoverclusters/Enable-AccelNetManagement.md +++ b/docset/winserver2025-ps/failoverclusters/Enable-AccelNetManagement.md @@ -2,7 +2,7 @@ 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: 08/01/2024 +ms.date: 01/22/2025 online version: https://learn.microsoft.com/powershell/module/failoverclusters/enable-accelnetmanagement?view=windowsserver2025-ps&wt.mc_id=ps-gethelp schema: 2.0.0 title: Enable-AccelNetManagement diff --git a/docset/winserver2025-ps/failoverclusters/Enable-AccelNetVM.md b/docset/winserver2025-ps/failoverclusters/Enable-AccelNetVM.md index 4e13b38722..752ba9a0c9 100644 --- a/docset/winserver2025-ps/failoverclusters/Enable-AccelNetVM.md +++ b/docset/winserver2025-ps/failoverclusters/Enable-AccelNetVM.md @@ -2,7 +2,7 @@ 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: 08/01/2024 +ms.date: 01/22/2025 online version: https://learn.microsoft.com/powershell/module/failoverclusters/enable-accelnetvm?view=windowsserver2025-ps&wt.mc_id=ps-gethelp schema: 2.0.0 title: Enable-AccelNetVM diff --git a/docset/winserver2025-ps/failoverclusters/Get-AccelNetManagement.md b/docset/winserver2025-ps/failoverclusters/Get-AccelNetManagement.md index 5a354107f8..ead71458c2 100644 --- a/docset/winserver2025-ps/failoverclusters/Get-AccelNetManagement.md +++ b/docset/winserver2025-ps/failoverclusters/Get-AccelNetManagement.md @@ -2,7 +2,7 @@ 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: 08/01/2024 +ms.date: 01/22/2025 online version: https://learn.microsoft.com/powershell/module/failoverclusters/get-accelnetmanagement?view=windowsserver2025-ps&wt.mc_id=ps-gethelp schema: 2.0.0 title: Get-AccelNetManagement diff --git a/docset/winserver2025-ps/failoverclusters/Get-AccelNetManagementPreReq.md b/docset/winserver2025-ps/failoverclusters/Get-AccelNetManagementPreReq.md index 39c3edfa31..dc797f4386 100644 --- a/docset/winserver2025-ps/failoverclusters/Get-AccelNetManagementPreReq.md +++ b/docset/winserver2025-ps/failoverclusters/Get-AccelNetManagementPreReq.md @@ -2,7 +2,7 @@ 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: 08/01/2024 +ms.date: 01/22/2025 online version: https://learn.microsoft.com/powershell/module/failoverclusters/get-accelnetmanagementprereq?view=windowsserver2025-ps&wt.mc_id=ps-gethelp schema: 2.0.0 title: Get-AccelNetManagementPreReq diff --git a/docset/winserver2025-ps/failoverclusters/Get-VMAdaptersConnectedToEnabledIntentSwitch.md b/docset/winserver2025-ps/failoverclusters/Get-VMAdaptersConnectedToEnabledIntentSwitch.md index 6222854319..59a9f75218 100644 --- a/docset/winserver2025-ps/failoverclusters/Get-VMAdaptersConnectedToEnabledIntentSwitch.md +++ b/docset/winserver2025-ps/failoverclusters/Get-VMAdaptersConnectedToEnabledIntentSwitch.md @@ -2,7 +2,7 @@ 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: 08/01/2024 +ms.date: 01/22/2025 online version: https://learn.microsoft.com/powershell/module/failoverclusters/get-vmadaptersconnectedtoenabledintentswitch?view=windowsserver2025-ps&wt.mc_id=ps-gethelp schema: 2.0.0 title: Get-VMAdaptersConnectedToEnabledIntentSwitch diff --git a/docset/winserver2025-ps/failoverclusters/Set-AccelNetVM.md b/docset/winserver2025-ps/failoverclusters/Set-AccelNetVM.md index 9cc86b1e8f..6abbc1328c 100644 --- a/docset/winserver2025-ps/failoverclusters/Set-AccelNetVM.md +++ b/docset/winserver2025-ps/failoverclusters/Set-AccelNetVM.md @@ -2,7 +2,7 @@ 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: 08/01/2024 +ms.date: 01/22/2025 online version: https://learn.microsoft.com/powershell/module/failoverclusters/set-accelnetvm?view=windowsserver2025-ps&wt.mc_id=ps-gethelp schema: 2.0.0 title: Set-AccelNetVM From 121233c6dae967dbcc2a65853187227aeaf89a32 Mon Sep 17 00:00:00 2001 From: Xelu86 <103963494+Xelu86@users.noreply.github.com> Date: Wed, 22 Jan 2025 14:54:45 -0500 Subject: [PATCH 5/8] Updates --- .../failoverclusters/Get-AccelNetVM.md | 100 ++++++++++++++++++ 1 file changed, 100 insertions(+) create mode 100644 docset/winserver2025-ps/failoverclusters/Get-AccelNetVM.md diff --git a/docset/winserver2025-ps/failoverclusters/Get-AccelNetVM.md b/docset/winserver2025-ps/failoverclusters/Get-AccelNetVM.md new file mode 100644 index 0000000000..31554fb541 --- /dev/null +++ b/docset/winserver2025-ps/failoverclusters/Get-AccelNetVM.md @@ -0,0 +1,100 @@ +--- +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/get-accelnetvm?view=windowsserver2025-ps&wt.mc_id=ps-gethelp +schema: 2.0.0 +title: Get-AccelNetVM +--- + +# Get-AccelNetVM + +## SYNOPSIS +Gets VMs with Accelerated Networking. + +## SYNTAX + +``` +Get-AccelNetVM [[-VMName] ] [[-VM] ] [] +``` + +## DESCRIPTION + +Get VMs with Accelerated Networking. + +## EXAMPLES + +### EXAMPLE 1 + +```powershell +Get-AccelNetVM -VMName "MyVM" +``` + +This example retrieves a VM named `MyVM`. + +If no VM name is provided, all VM names are retrieved. + +### EXAMPLE 2 + +```powershell +$vm = Get-VM -Name "MyVM" +Get-AccelNetVM -VM $vm +``` + +This example retrieves the VM object for a VM named `MyVM`. + +## PARAMETERS + +### -VMName + +The Virtual Machine name. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 1 +Default value: None +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, +-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-AccelNetVM](disable-accelnetvm.md) + +[Enable-AccelNetVM](enable-accelnetvm.md) + +[Set-AccelNetVM](set-accelnetvm.md) From e18ba440bda5a6d78f5951ebab73f90ec2dbd84b Mon Sep 17 00:00:00 2001 From: Xelu86 <103963494+Xelu86@users.noreply.github.com> Date: Wed, 22 Jan 2025 15:20:07 -0500 Subject: [PATCH 6/8] Updated Failover Clusters page --- .../failoverclusters/FailoverClusters.md | 364 ++++++++++++------ 1 file changed, 254 insertions(+), 110 deletions(-) diff --git a/docset/winserver2025-ps/failoverclusters/FailoverClusters.md b/docset/winserver2025-ps/failoverclusters/FailoverClusters.md index 354a0e9c2d..27ffd994bb 100644 --- a/docset/winserver2025-ps/failoverclusters/FailoverClusters.md +++ b/docset/winserver2025-ps/failoverclusters/FailoverClusters.md @@ -10,356 +10,500 @@ title: FailoverClusters --- # FailoverClusters Module + ## Description + This reference provides cmdlet descriptions and syntax for all failover cluster-specific cmdlets. It 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 cmd: +`Failover Cluster Module for Windows PowerShell` Feature, using the following PowerShell command: `Add-WindowsFeature RSAT-Clustering-PowerShell`. ## FailoverClusters Cmdlets -### [Add-ClusterCheckpoint](./Add-ClusterCheckpoint.md) + +### [Add-ClusterCheckpoint](Add-ClusterCheckpoint.md) + Adds a cryptographic key checkpoint or registry checkpoint for a resource. -### [Add-ClusterDisk](./Add-ClusterDisk.md) +### [Add-ClusterDisk](Add-ClusterDisk.md) + Makes a new disk available for use in a failover cluster. -### [Add-ClusterFileServerRole](./Add-ClusterFileServerRole.md) +### [Add-ClusterFileServerRole](Add-ClusterFileServerRole.md) + Creates a clustered file server resource group. -### [Add-ClusterGenericApplicationRole](./Add-ClusterGenericApplicationRole.md) +### [Add-ClusterGenericApplicationRole](Add-ClusterGenericApplicationRole.md) + Configures high availability for an application that wasn't originally designed to run in a failover cluster. -### [Add-ClusterGenericScriptRole](./Add-ClusterGenericScriptRole.md) +### [Add-ClusterGenericScriptRole](Add-ClusterGenericScriptRole.md) + Configures an application controlled by a script that runs in Windows Script Host, within a failover cluster. -### [Add-ClusterGenericServiceRole](./Add-ClusterGenericServiceRole.md) +### [Add-ClusterGenericServiceRole](Add-ClusterGenericServiceRole.md) + Configures high availability for a service that wasn't originally designed to run in a failover cluster. -### [Add-ClusterGroup](./Add-ClusterGroup.md) +### [Add-ClusterGroup](Add-ClusterGroup.md) + Adds an empty resource group to the failover cluster configuration, in preparation for adding clustered resources to the group. -### [Add-ClusterGroupSetDependency](./Add-ClusterGroupSetDependency.md) +### [Add-ClusterGroupSetDependency](Add-ClusterGroupSetDependency.md) + Adds a dependency to a cluster set. -### [Add-ClusterGroupToAffinityRule](./Add-ClusterGroupToAffinityRule.md) +### [Add-ClusterGroupToAffinityRule](Add-ClusterGroupToAffinityRule.md) + This command is used to add either a VM role or a group name to a cluster affinity rule. -### [Add-ClusterGroupToSet](./Add-ClusterGroupToSet.md) +### [Add-ClusterGroupToSet](Add-ClusterGroupToSet.md) + Adds a group to a set. -### [Add-ClusteriSCSITargetServerRole](./Add-ClusteriSCSITargetServerRole.md) +### [Add-ClusteriSCSITargetServerRole](Add-ClusteriSCSITargetServerRole.md) + Creates a highly available iSCSI Target server. -### [Add-ClusterNode](./Add-ClusterNode.md) +### [Add-ClusterNode](Add-ClusterNode.md) + Adds a node (server) to a failover cluster. -### [Add-ClusterResource](./Add-ClusterResource.md) +### [Add-ClusterResource](Add-ClusterResource.md) + Adds a resource to a clustered role, or resource group, in a failover cluster. -### [Add-ClusterResourceDependency](./Add-ClusterResourceDependency.md) +### [Add-ClusterResourceDependency](Add-ClusterResourceDependency.md) + Adds a resource to the list of resources on which a particular resource depends, using AND as the connector, within a failover cluster. -### [Add-ClusterResourceType](./Add-ClusterResourceType.md) +### [Add-ClusterResourceType](Add-ClusterResourceType.md) + Adds a resource type to a failover cluster, and specifies information such as the dynamic-link library (DLL) to use with that resource type. -### [Add-ClusterScaleOutFileServerRole](./Add-ClusterScaleOutFileServerRole.md) +### [Add-ClusterScaleOutFileServerRole](Add-ClusterScaleOutFileServerRole.md) + Creates a clustered file server for scale-out application data. -### [Add-ClusterSharedVolume](./Add-ClusterSharedVolume.md) +### [Add-ClusterSharedVolume](Add-ClusterSharedVolume.md) + Makes a volume available in Cluster Shared Volumes in a failover cluster. -### [Add-ClusterSharedVolumeToAffinityRule](./Add-ClusterSharedVolumeToAffinityRule.md) +### [Add-ClusterSharedVolumeToAffinityRule](Add-ClusterSharedVolumeToAffinityRule.md) + Adds a Cluster Shared Volume (CSV) to an existing Affinity Rule. -### [Add-ClusterVirtualMachineRole](./Add-ClusterVirtualMachineRole.md) +### [Add-ClusterVirtualMachineRole](Add-ClusterVirtualMachineRole.md) + Creates a clustered virtual machine, that is, a virtual machine that can be failed over if necessary to a different server in the failover cluster. -### [Add-ClusterVMMonitoredItem](./Add-ClusterVMMonitoredItem.md) +### [Add-ClusterVMMonitoredItem](Add-ClusterVMMonitoredItem.md) + Configures monitoring for a service or an Event Tracing for Windows (ETW) event so that it is monitored on a virtual machine. -### [Block-ClusterAccess](./Block-ClusterAccess.md) +### [Block-ClusterAccess](Block-ClusterAccess.md) + Prevents the specified user or users from accessing a failover cluster. -### [Clear-ClusterDiskReservation](./Clear-ClusterDiskReservation.md) +### [Clear-ClusterDiskReservation](Clear-ClusterDiskReservation.md) + Clears the persistent reservation on a disk in a failover cluster. -### [Clear-ClusterNode](./Clear-ClusterNode.md) +### [Clear-ClusterNode](Clear-ClusterNode.md) + Clears the cluster configuration from a node that was evicted from a failover cluster. -### [Disable-ClusterStorageSpacesDirect](./Disable-ClusterStorageSpacesDirect.md) +### [Disable-AccelNetManagement](Disable-AccelNetManagement.md) + +Disables Accelerated Networking Management cluster-wide. + +### [Disable-AccelNetVM](Disable-AccelNetVM.md) + +Disables Accelerated Networking on a VM. + +### [Disable-ClusterStorageSpacesDirect](Disable-ClusterStorageSpacesDirect.md) + Disables S2D. -### [Enable-ClusterStorageSpacesDirect](./Enable-ClusterStorageSpacesDirect.md) +### [Enable-AccelNetManagement](Enable-AccelNetManagement.md) + +Enables Accelerated Networking Management cluster-wide. + +### [Enable-AccelNetVM](Enable-AccelNetVM.md) + +Enables Accelerated Networking on a VM. + +### [Enable-ClusterStorageSpacesDirect](Enable-ClusterStorageSpacesDirect.md) + Enables S2D. -### [Get-Cluster](./Get-Cluster.md) +### [Get-AccelNetManagement](Get-AccelNetManagement.md) + +Gets the intent enabled for Accelerated Networking Management. + +### [Get-AccelNetManagementPreReq](Get-AccelNetManagementPreReq.md) + +Informs the user if the cluster nodes support Accelerated Networking. + +### [Get-AccelNetVM](Get-AccelNetVM.md) + +Gets VMs with Accelerated Networking. + +### [Get-Cluster](Get-Cluster.md) + Gets information about one or more failover clusters in a given domain. -### [Get-ClusterAccess](./Get-ClusterAccess.md) +### [Get-ClusterAccess](Get-ClusterAccess.md) + Gets information about permissions that control access to a failover cluster. -### [Get-ClusterAffinityRule](./Get-ClusterAffinityRule.md) +### [Get-ClusterAffinityRule](Get-ClusterAffinityRule.md) + This cmdlet is used to display the given rule and what type it is. -### [Get-ClusterAvailableDisk](./Get-ClusterAvailableDisk.md) +### [Get-ClusterAvailableDisk](Get-ClusterAvailableDisk.md) + Gets information about the disks that can support Failover Clustering and are visible to all nodes, but aren't yet part of the set of clustered disks. -### [Get-ClusterCheckpoint](./Get-ClusterCheckpoint.md) +### [Get-ClusterCheckpoint](Get-ClusterCheckpoint.md) + Retrieves a cryptographic key checkpoint or registry checkpoint for a resource. -### [Get-ClusterDiagnosticInfo](./Get-ClusterDiagnosticInfo.md) +### [Get-ClusterDiagnosticInfo](Get-ClusterDiagnosticInfo.md) + Gets diagnostics for a cluster a cluster that contains VMs and produces a zip file containing the data. -### [Get-ClusterFaultDomain](./Get-ClusterFaultDomain.md) +### [Get-ClusterFaultDomain](Get-ClusterFaultDomain.md) + Gets the cluster fault domains in a cluster. -### [Get-ClusterFaultDomainXML](./Get-ClusterFaultDomainXML.md) +### [Get-ClusterFaultDomainXML](Get-ClusterFaultDomainXML.md) + Gets the fault domain as an XML string. -### [Get-ClusterGroup](./Get-ClusterGroup.md) +### [Get-ClusterGroup](Get-ClusterGroup.md) + Gets information about one or more clustered roles (resource groups) in a failover cluster. -### [Get-ClusterGroupSet](./Get-ClusterGroupSet.md) +### [Get-ClusterGroupSet](Get-ClusterGroupSet.md) + Gets the group sets in the cluster. -### [Get-ClusterGroupSetDependency](./Get-ClusterGroupSetDependency.md) +### [Get-ClusterGroupSetDependency](Get-ClusterGroupSetDependency.md) + Gets the cluster group sets based on dependency relationships. -### [Get-ClusterLog](./Get-ClusterLog.md) +### [Get-ClusterLog](Get-ClusterLog.md) + Creates a log file for all nodes, or a specific a node, in a failover cluster. -### [Get-ClusterNetwork](./Get-ClusterNetwork.md) +### [Get-ClusterNetwork](Get-ClusterNetwork.md) + Gets information about one or more networks in a failover cluster. -### [Get-ClusterNetworkInterface](./Get-ClusterNetworkInterface.md) +### [Get-ClusterNetworkInterface](Get-ClusterNetworkInterface.md) + Gets information about one or more network adapters in a failover cluster. -### [Get-ClusterNode](./Get-ClusterNode.md) +### [Get-ClusterNode](Get-ClusterNode.md) + Gets information about one or more nodes, or servers, in a failover cluster. -### [Get-ClusterOwnerNode](./Get-ClusterOwnerNode.md) +### [Get-ClusterOwnerNode](Get-ClusterOwnerNode.md) + Gets information about which nodes can own a resource in a failover cluster or information about the order of preference among owner nodes for a clustered role. -### [Get-ClusterParameter](./Get-ClusterParameter.md) +### [Get-ClusterParameter](Get-ClusterParameter.md) + Gets detailed information about an object in a failover cluster, such as a cluster resource. -### [Get-ClusterQuorum](./Get-ClusterQuorum.md) +### [Get-ClusterQuorum](Get-ClusterQuorum.md) + Gets information about the quorum configuration of a failover cluster. -### [Get-ClusterResource](./Get-ClusterResource.md) +### [Get-ClusterResource](Get-ClusterResource.md) + Gets information about one or more resources in a failover cluster. -### [Get-ClusterResourceDependency](./Get-ClusterResourceDependency.md) +### [Get-ClusterResourceDependency](Get-ClusterResourceDependency.md) + Gets information about the dependencies that have been configured between clustered resources in a failover cluster. -### [Get-ClusterResourceDependencyReport](./Get-ClusterResourceDependencyReport.md) +### [Get-ClusterResourceDependencyReport](Get-ClusterResourceDependencyReport.md) + Generates a report that lists the dependencies between resources in a failover cluster. -### [Get-ClusterResourceType](./Get-ClusterResourceType.md) +### [Get-ClusterResourceType](Get-ClusterResourceType.md) + Gets information about one or more resource types in a failover cluster. -### [Get-ClusterSharedVolume](./Get-ClusterSharedVolume.md) +### [Get-ClusterSharedVolume](Get-ClusterSharedVolume.md) + Gets information about Cluster Shared Volumes in a failover cluster. -### [Get-ClusterSharedVolumeState](./Get-ClusterSharedVolumeState.md) +### [Get-ClusterSharedVolumeState](Get-ClusterSharedVolumeState.md) + Gets the state of Cluster Shared Volumes in a cluster. -### [Get-ClusterStorageSpacesDirect](./Get-ClusterStorageSpacesDirect.md) +### [Get-ClusterStorageSpacesDirect](Get-ClusterStorageSpacesDirect.md) + Gets the S2D settings from a cluster. -### [Get-ClusterVMMonitoredItem](./Get-ClusterVMMonitoredItem.md) +### [Get-ClusterVMMonitoredItem](Get-ClusterVMMonitoredItem.md) + Gets the list of services and events currently being monitored in the virtual machine. -### [Grant-ClusterAccess](./Grant-ClusterAccess.md) +### [Grant-ClusterAccess](Grant-ClusterAccess.md) + Grants access to a failover cluster, either full access or read-only access. -### [Move-ClusterGroup](./Move-ClusterGroup.md) +### [Move-ClusterGroup](Move-ClusterGroup.md) + Moves a clustered role (a resource group) from one node to another in a failover cluster. -### [Move-ClusterResource](./Move-ClusterResource.md) +### [Move-ClusterResource](Move-ClusterResource.md) + Moves a clustered resource from one clustered role to another within a failover cluster. -### [Move-ClusterSharedVolume](./Move-ClusterSharedVolume.md) +### [Move-ClusterSharedVolume](Move-ClusterSharedVolume.md) + Moves a Cluster Shared Volume (CSV) to ownership by a different node in a failover cluster. -### [Move-ClusterVirtualMachineRole](./Move-ClusterVirtualMachineRole.md) +### [Move-ClusterVirtualMachineRole](Move-ClusterVirtualMachineRole.md) + Moves the ownership of a clustered virtual machine to a different node. -### [New-Cluster](./New-Cluster.md) +### [New-Cluster](New-Cluster.md) + Creates a new failover cluster. -### [New-ClusterAffinityRule](./New-ClusterAffinityRule.md) +### [New-ClusterAffinityRule](New-ClusterAffinityRule.md) + Creates new affinity rules. -### [New-ClusterFaultDomain](./New-ClusterFaultDomain.md) +### [New-ClusterFaultDomain](New-ClusterFaultDomain.md) + Creates a fault domain in the cluster. -### [New-ClusterGroupSet](./New-ClusterGroupSet.md) +### [New-ClusterGroupSet](New-ClusterGroupSet.md) + Create a names set of groups in the cluster. -### [New-ClusterNameAccount](./New-ClusterNameAccount.md) +### [New-ClusterNameAccount](New-ClusterNameAccount.md) + Creates a cluster name account in Active Directory Domain Services. -### [Remove-Cluster](./Remove-Cluster.md) +### [Remove-Cluster](Remove-Cluster.md) + Destroys an existing failover cluster. -### [Remove-ClusterAccess](./Remove-ClusterAccess.md) +### [Remove-ClusterAccess](Remove-ClusterAccess.md) + Removes a user from the access list on the cluster. -### [Remove-ClusterAffinityRule](./Remove-ClusterAffinityRule.md) +### [Remove-ClusterAffinityRule](Remove-ClusterAffinityRule.md) + Removes new affinity rules. -### [Remove-ClusterCheckpoint](./Remove-ClusterCheckpoint.md) +### [Remove-ClusterCheckpoint](Remove-ClusterCheckpoint.md) + Removes a cryptographic key checkpoint or registry checkpoint for a resource. -### [Remove-ClusterFaultDomain](./Remove-ClusterFaultDomain.md) +### [Remove-ClusterFaultDomain](Remove-ClusterFaultDomain.md) + Removes a fault domain. -### [Remove-ClusterGroup](./Remove-ClusterGroup.md) +### [Remove-ClusterGroup](Remove-ClusterGroup.md) + Removes a clustered role, also called a resource group, from a failover cluster. -### [Remove-ClusterGroupFromAffinityRule](./Remove-ClusterGroupFromAffinityRule.md) +### [Remove-ClusterGroupFromAffinityRule](Remove-ClusterGroupFromAffinityRule.md) + Removes a cluster group from an affinity rule. -### [Remove-ClusterGroupFromSet](./Remove-ClusterGroupFromSet.md) +### [Remove-ClusterGroupFromSet](Remove-ClusterGroupFromSet.md) + Removes a group from a set. -### [Remove-ClusterGroupSet](./Remove-ClusterGroupSet.md) +### [Remove-ClusterGroupSet](Remove-ClusterGroupSet.md) + Removes a group set from the cluster. -### [Remove-ClusterGroupSetDependency](./Remove-ClusterGroupSetDependency.md) +### [Remove-ClusterGroupSetDependency](Remove-ClusterGroupSetDependency.md) + Removes a dependency from a group set. -### [Remove-ClusterNode](./Remove-ClusterNode.md) +### [Remove-ClusterNode](Remove-ClusterNode.md) + Removes a node from a failover cluster. -### [Remove-ClusterResource](./Remove-ClusterResource.md) +### [Remove-ClusterResource](Remove-ClusterResource.md) + Removes a clustered resource from the failover cluster. -### [Remove-ClusterResourceDependency](./Remove-ClusterResourceDependency.md) +### [Remove-ClusterResourceDependency](Remove-ClusterResourceDependency.md) + Removes a dependency between two resources in a clustered role within a failover cluster. -### [Remove-ClusterResourceType](./Remove-ClusterResourceType.md) +### [Remove-ClusterResourceType](Remove-ClusterResourceType.md) + Removes a resource type from a failover cluster. -### [Remove-ClusterSharedVolume](./Remove-ClusterSharedVolume.md) +### [Remove-ClusterSharedVolume](Remove-ClusterSharedVolume.md) + Removes a volume from the Cluster Shared Volumes in a failover cluster, and places it in Available Storage in the cluster. -### [Remove-ClusterSharedVolumeFromAffinityRule](./Remove-ClusterSharedVolumeFromAffinityRule.md) +### [Remove-ClusterSharedVolumeFromAffinityRule](Remove-ClusterSharedVolumeFromAffinityRule.md) + Remove a cluster shared volume from an affinity rule. -### [Remove-ClusterVMMonitoredItem](./Remove-ClusterVMMonitoredItem.md) +### [Remove-ClusterVMMonitoredItem](Remove-ClusterVMMonitoredItem.md) + Removes monitoring of a service or event that is currently being monitored on a virtual machine. -### [Repair-ClusterStorageSpacesDirect](./Repair-ClusterStorageSpacesDirect.md) +### [Repair-ClusterStorageSpacesDirect](Repair-ClusterStorageSpacesDirect.md) + Repairs S2D disks. -### [Reset-ClusterVMMonitoredState](./Reset-ClusterVMMonitoredState.md) +### [Reset-ClusterVMMonitoredState](Reset-ClusterVMMonitoredState.md) + Resets the Application Critical state of a virtual machine, so that the virtual machine is no longer marked as being in a critical state in the cluster. -### [Resume-ClusterNode](./Resume-ClusterNode.md) +### [Resume-ClusterNode](Resume-ClusterNode.md) + Resumes a node from the paused state or brings back drained workloads to the node or both. -### [Resume-ClusterResource](./Resume-ClusterResource.md) +### [Resume-ClusterResource](Resume-ClusterResource.md) + Turns off maintenance for a disk resource or Cluster Shared Volume within a failover cluster. -### [Set-ClusterAffinityRule](./Set-ClusterAffinityRule.md) +### [Set-AccelNetVM](Set-AccelNetVM.md) + +Sets Accelerated Networking on a VM. + +### [Set-ClusterAffinityRule](Set-ClusterAffinityRule.md) + Enabled or Disable an affinity rule, and update the rule type. -### [Set-ClusterFaultDomain](./Set-ClusterFaultDomain.md) +### [Set-ClusterFaultDomain](Set-ClusterFaultDomain.md) + Update an existing cluster fault domain. -### [Set-ClusterFaultDomainXML](./Set-ClusterFaultDomainXML.md) +### [Set-ClusterFaultDomainXML](Set-ClusterFaultDomainXML.md) + Sets the cluster fault domain using XML. -### [Set-ClusterGroupSet](./Set-ClusterGroupSet.md) +### [Set-ClusterGroupSet](Set-ClusterGroupSet.md) + Updates a cluster group set. -### [Set-ClusterLog](./Set-ClusterLog.md) +### [Set-ClusterLog](Set-ClusterLog.md) + Sets the size and level of detail for the cluster log. -### [Set-ClusterOwnerNode](./Set-ClusterOwnerNode.md) +### [Set-ClusterOwnerNode](Set-ClusterOwnerNode.md) + Specifies which nodes can own a resource in a failover cluster or specifies the order of preference among owner nodes for a clustered role, or resource group. -### [Set-ClusterParameter](./Set-ClusterParameter.md) +### [Set-ClusterParameter](Set-ClusterParameter.md) + Controls specific properties of an object in a failover cluster, such as a resource, a group, or a network. -### [Set-ClusterQuorum](./Set-ClusterQuorum.md) +### [Set-ClusterQuorum](Set-ClusterQuorum.md) + Configures quorum options for a failover cluster. -### [Set-ClusterResourceDependency](./Set-ClusterResourceDependency.md) +### [Set-ClusterResourceDependency](Set-ClusterResourceDependency.md) + Specifies the resources that a particular resource depends on within a failover cluster. -### [Set-ClusterStorageSpacesDirect](./Set-ClusterStorageSpacesDirect.md) +### [Set-ClusterStorageSpacesDirect](Set-ClusterStorageSpacesDirect.md) + Sets S2D cache parameters. -### [Set-ClusterStorageSpacesDirectDisk](./Set-ClusterStorageSpacesDirectDisk.md) +### [Set-ClusterStorageSpacesDirectDisk](Set-ClusterStorageSpacesDirectDisk.md) + Configures the system to enable S2D to claim or not claim specific physical disks. -### [Start-Cluster](./Start-Cluster.md) +### [Start-Cluster](Start-Cluster.md) + Starts the Cluster service on all nodes of the cluster on which it isn't yet started. -### [Start-ClusterGroup](./Start-ClusterGroup.md) +### [Start-ClusterGroup](Start-ClusterGroup.md) + Starts one or more clustered roles, also known as resource groups, on a failover cluster. -### [Start-ClusterNode](./Start-ClusterNode.md) +### [Start-ClusterNode](Start-ClusterNode.md) + Starts the Cluster service on a node in a failover cluster. -### [Start-ClusterResource](./Start-ClusterResource.md) +### [Start-ClusterResource](Start-ClusterResource.md) + Brings a resource online in a failover cluster. -### [Stop-Cluster](./Stop-Cluster.md) +### [Stop-Cluster](Stop-Cluster.md) + Stops the Cluster service on all nodes in a failover cluster, which will stop all services and applications configured in the cluster. -### [Stop-ClusterGroup](./Stop-ClusterGroup.md) +### [Stop-ClusterGroup](Stop-ClusterGroup.md) + Stops one or more clustered roles on a failover cluster. -### [Stop-ClusterNode](./Stop-ClusterNode.md) +### [Stop-ClusterNode](Stop-ClusterNode.md) + Stops the Cluster service on a node in a failover cluster. -### [Stop-ClusterResource](./Stop-ClusterResource.md) +### [Stop-ClusterResource](Stop-ClusterResource.md) + Takes a resource offline in a failover cluster. -### [Suspend-ClusterNode](./Suspend-ClusterNode.md) +### [Suspend-ClusterNode](Suspend-ClusterNode.md) + Suspends activity on a failover cluster node, that is, pauses the node. -### [Suspend-ClusterResource](./Suspend-ClusterResource.md) +### [Suspend-ClusterResource](Suspend-ClusterResource.md) + Turns on maintenance for a disk resource or CSV so that you can run a disk maintenance tool without triggering failover. -### [Test-Cluster](./Test-Cluster.md) +### [Test-Cluster](Test-Cluster.md) + Runs validation tests for failover cluster hardware and settings. -### [Test-ClusterResourceFailure](./Test-ClusterResourceFailure.md) +### [Test-ClusterResourceFailure](Test-ClusterResourceFailure.md) + Simulates a failure of a cluster resource. -### [Update-ClusterFunctionalLevel](./Update-ClusterFunctionalLevel.md) +### [Update-ClusterFunctionalLevel](Update-ClusterFunctionalLevel.md) + Updates the functional level of a mixed-version cluster. -### [Update-ClusterIPResource](./Update-ClusterIPResource.md) +### [Update-ClusterIPResource](Update-ClusterIPResource.md) + Renews or releases the DHCP lease for an IP address resource in a failover cluster. -### [Update-ClusterNetworkNameResource](./Update-ClusterNetworkNameResource.md) +### [Update-ClusterNetworkNameResource](Update-ClusterNetworkNameResource.md) + Registers existing Network Name resources with a DNS server in a way that does not interrupt cluster availability. -### [Update-ClusterVirtualMachineConfiguration](./Update-ClusterVirtualMachineConfiguration.md) +### [Update-ClusterVirtualMachineConfiguration](Update-ClusterVirtualMachineConfiguration.md) + Refreshes the configuration of a clustered virtual machine within a failover cluster. From 38c8af157e69a0433c990356abb91e07bac7f99a Mon Sep 17 00:00:00 2001 From: Xelu86 <103963494+Xelu86@users.noreply.github.com> Date: Thu, 23 Jan 2025 13:32:49 -0500 Subject: [PATCH 7/8] Updates --- .../Disable-AccelNetManagement.md | 10 +- .../Enable-AccelNetManagement.md | 14 ++- .../failoverclusters/Enable-AccelNetVM.md | 23 +++- .../failoverclusters/FailoverClusters.md | 11 +- .../Get-AccelNetManagement.md | 10 +- .../failoverclusters/Get-AccelNetVM.md | 4 +- ...MAdaptersConnectedToEnabledIntentSwitch.md | 19 +++- .../Set-AccelNetManagement.md | 103 ++++++++++++++++++ 8 files changed, 177 insertions(+), 17 deletions(-) create mode 100644 docset/winserver2025-ps/failoverclusters/Set-AccelNetManagement.md diff --git a/docset/winserver2025-ps/failoverclusters/Disable-AccelNetManagement.md b/docset/winserver2025-ps/failoverclusters/Disable-AccelNetManagement.md index 72a1ccf4ff..3b560d54fb 100644 --- a/docset/winserver2025-ps/failoverclusters/Disable-AccelNetManagement.md +++ b/docset/winserver2025-ps/failoverclusters/Disable-AccelNetManagement.md @@ -21,10 +21,10 @@ Disable-AccelNetManagement [] ## 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 @@ -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 @@ -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) diff --git a/docset/winserver2025-ps/failoverclusters/Enable-AccelNetManagement.md b/docset/winserver2025-ps/failoverclusters/Enable-AccelNetManagement.md index c5a79b8d1a..82cd5d4aeb 100644 --- a/docset/winserver2025-ps/failoverclusters/Enable-AccelNetManagement.md +++ b/docset/winserver2025-ps/failoverclusters/Enable-AccelNetManagement.md @@ -22,19 +22,19 @@ Enable-AccelNetManagement [-IntentName] [[-NodeReservePercentage] [-Performance] [] +Enable-AccelNetVM [-VMName] [-Performance] [[-VM] ] + [] ``` ## DESCRIPTION -Enables Accelerated Networking on a VM. +Enables AccelNet on a VM. ## EXAMPLES @@ -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 @@ -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, diff --git a/docset/winserver2025-ps/failoverclusters/FailoverClusters.md b/docset/winserver2025-ps/failoverclusters/FailoverClusters.md index 27ffd994bb..1b7f69e7fd 100644 --- a/docset/winserver2025-ps/failoverclusters/FailoverClusters.md +++ b/docset/winserver2025-ps/failoverclusters/FailoverClusters.md @@ -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 --- @@ -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 @@ -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. diff --git a/docset/winserver2025-ps/failoverclusters/Get-AccelNetManagement.md b/docset/winserver2025-ps/failoverclusters/Get-AccelNetManagement.md index ead71458c2..557db16ac0 100644 --- a/docset/winserver2025-ps/failoverclusters/Get-AccelNetManagement.md +++ b/docset/winserver2025-ps/failoverclusters/Get-AccelNetManagement.md @@ -21,7 +21,7 @@ Get-AccelNetManagement ## DESCRIPTION -Retrieves the intent enabled for Accelerated Networking Management. +Retrieves the intent enabled for AccelNet Management. ## EXAMPLES @@ -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) diff --git a/docset/winserver2025-ps/failoverclusters/Get-AccelNetVM.md b/docset/winserver2025-ps/failoverclusters/Get-AccelNetVM.md index 31554fb541..f3963e9f94 100644 --- a/docset/winserver2025-ps/failoverclusters/Get-AccelNetVM.md +++ b/docset/winserver2025-ps/failoverclusters/Get-AccelNetVM.md @@ -21,7 +21,7 @@ Get-AccelNetVM [[-VMName] ] [[-VM] ] [] [] +Get-VMAdaptersConnectedToEnabledIntentSwitch [[-VMName] ] [[-VM] ] + [] ``` ## DESCRIPTION @@ -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, diff --git a/docset/winserver2025-ps/failoverclusters/Set-AccelNetManagement.md b/docset/winserver2025-ps/failoverclusters/Set-AccelNetManagement.md new file mode 100644 index 0000000000..ac3a612062 --- /dev/null +++ b/docset/winserver2025-ps/failoverclusters/Set-AccelNetManagement.md @@ -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] ] [[-NodeReservePercentage] ] + [] +``` + +## 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) From 9ccf2f02f1cd3a62a9043e60ff8c1435948a2517 Mon Sep 17 00:00:00 2001 From: Xelu86 <103963494+Xelu86@users.noreply.github.com> Date: Thu, 23 Jan 2025 14:30:22 -0500 Subject: [PATCH 8/8] Update dependency note --- .../failoverclusters/FailoverClusters.md | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/docset/winserver2025-ps/failoverclusters/FailoverClusters.md b/docset/winserver2025-ps/failoverclusters/FailoverClusters.md index 1b7f69e7fd..752c1db973 100644 --- a/docset/winserver2025-ps/failoverclusters/FailoverClusters.md +++ b/docset/winserver2025-ps/failoverclusters/FailoverClusters.md @@ -22,6 +22,15 @@ cmdlets aren't available in your PowerShell session, you may need to add the Add-WindowsFeature RSAT-Clustering-PowerShell ``` +> [!NOTE] +> The AccelNet cmdlets have a dependency on the Hyper-V role. To learn more, see [Install or Uninstall Roles, Role Services, or Features](/windows-server/administration/server-manager/install-or-uninstall-roles-role-services-or-features). +> +> This role can also be installed using PowerShell by running the following command: +> +> ```powershell +> Enable-WindowsOptionalFeature -Online -FeatureName Microsoft-Hyper-V -All +> ``` + ## FailoverClusters Cmdlets ### [Add-ClusterCheckpoint](Add-ClusterCheckpoint.md)