Skip to content

Commit 9e4b8a9

Browse files
Merge pull request #234260 from jjaygbay1/hcx-run-commands
Added new article for HCX commands
2 parents 280fce8 + bd0a0b8 commit 9e4b8a9

File tree

5 files changed

+70
-0
lines changed

5 files changed

+70
-0
lines changed
51.7 KB
Loading
369 KB
Loading
67.6 KB
Loading

articles/azure-vmware/toc.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -234,6 +234,8 @@
234234
href: enable-vmware-cds-with-azure.md
235235
- name: Upgrade HCX on Azure VMware Solution
236236
href: upgrade-hcx-azure-vmware-solutions.md
237+
- name: Use HCX Run Commands
238+
href: use-hcx-run-commands.md
237239
- name: Resources
238240
items:
239241
- name: Learning paths
Lines changed: 68 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,68 @@
1+
---
2+
title: Use HCX Run Commands
3+
description: Use HCX Run Commands in Azure VMware Solution
4+
ms.topic: how-to
5+
ms.service: azure-vmware
6+
ms.custom: engagement-fy23
7+
ms.date: 04/11/2023
8+
---
9+
10+
# Use HCX Run Commands
11+
In this article, you learn how to use HCX run commands. Use run commands to perform operations that would normally require elevated privileges through a collection of PowerShell cmdlets. This document outlines the available HCX run commands and how to use them.
12+
13+
This article describes two HCX commands: **Restart HCX Manager** and **Scale HCX Manager**.
14+
15+
## Restart HCX Manager
16+
17+
This Command checks for active HCX migrations and replications. If none are found, it restarts the HCX cloud manager (HCX VM's guest OS).
18+
19+
1. Navigate to the run Command panel in an Azure VMware private cloud on the Azure portal.
20+
21+
:::image type="content" source="media/hcx-commands/run-command-private-cloud.png" alt-text="Diagram that lists all available Run command packages and Run commands." border="false" lightbox="media/hcx-commands/run-command-private-cloud.png":::
22+
23+
1. Select the **Microsoft.AVS.Management** package dropdown menu and select the **Restart-HcxManager** command.
24+
1. Set parameters and select **Run**.
25+
Optional run command parameters.
26+
27+
If the parameters are used incorrectly, they can halt active migrations, and replications and cause other issues. Brief description of each parameter with an example of when it should be used.
28+
29+
**Hard Reboot Parameter** - Restarts the virtual machine instead of the default of a GuestOS Reboot. This command is like pulling the power plug on a machine. We don't want to risk disk corruption so this should only be used if a normal reboot fails, and we have exhausted all other options.
30+
31+
**Force Parameter** - If there are ANY active HCX migrations/replications, this parameter avoids the check for active HCX migrations/replications. If the Virtual machine is in a powered off state, this parameter powers the machine on.
32+
33+
**Scenario 1**: A customer has a migration that has been stuck in an active state for weeks and they need a restart of HCX for a separate issue. Without this parameter, the script will fail due to the detection of the active migration.
34+
**Scenario 2**: The HCX Manager is powered off and the customer would like to power it back on.
35+
36+
:::image type="content" source="media/hcx-commands/restart-command.png" alt-text="Diagram that shows run command parameters for Restart-HcxManager command." border="false" lightbox="media/hcx-commands/restart-command.png":::
37+
38+
1. Wait for command to finish. It may take few minutes for the HCX appliance to come online.
39+
40+
## Scale HCX manager
41+
Use the Scale HCX manager run command to increase the resource allocation of your HCX Manager virtual machine to 8 vCPUs and 24-GB RAM from the default setting of 4 vCPUs and 12-GB RAM, ensuring scalability.
42+
43+
**Scenario**: Mobility Optimize Networking (MON) requires HCX Scalability. For more details on [MON scaling](https://kb.vmware.com/s/article/88401)
44+
45+
>[!NOTE]
46+
> HCX cloud manager will be rebooted during this operation, and this may affect any ongoing migration processes.
47+
48+
1. Navigate to the run Command panel on in an AVS private cloud on the Azure portal.
49+
50+
1. Select the **Microsoft.AVS.Management** package dropdown menu and select the ``Set-HcxScaledCpuAndMemorySetting`` command.
51+
52+
:::image type="content" source="media/hcx-commands/set-hcx-scale.png" alt-text="Diagram that shows run command parameters for Set-HcxScaledCpuAndMemorySetting command." border="false" lightbox="media/hcx-commands/set-hcx-scale.png":::
53+
54+
1. Agree to restart HCX by toggling ``AgreeToRestartHCX`` to **True**.
55+
You must acknowledge that the virtual machine will be restarted.
56+
57+
58+
>[!NOTE]
59+
> If this required parameter is set to false that cmdlet execution will fail.
60+
61+
1. Select **Run** to execute.
62+
This process may take between 10-15 minutes.
63+
64+
>[!NOTE]
65+
> HCX cloud manager will be unavailable during the scaling.
66+
67+
## Next step
68+
To learn more about run commands, see [Run commands](concepts-run-command.md)

0 commit comments

Comments
 (0)