Skip to content

Commit de4eb33

Browse files
authored
Merge pull request #312687 from varunhari92/frantz-hcx-changes
run command updates
2 parents 2d3abfd + 5860ab1 commit de4eb33

2 files changed

Lines changed: 57 additions & 15 deletions

File tree

-4.76 KB
Loading

articles/azure-vmware/use-hcx-run-commands.md

Lines changed: 57 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,8 @@ title: Use VMware HCX Run Commands
33
description: Use VMware HCX Run Commands in Azure VMware Solution
44
ms.topic: how-to
55
ms.service: azure-vmware
6-
ms.custom: engagement-fy23
7-
ms.date: 3/22/2024
6+
ms.custom: engagement-fy26
7+
ms.date: 3/5/2026
88
# Customer intent: As a cloud administrator, I want to execute VMware HCX Run Commands in an Azure VMware Solution, so that I can manage and scale the HCX Manager efficiently while maintaining service integrity during operations.
99
---
1010

@@ -35,31 +35,73 @@ Optional run command parameters.
3535
1. Wait for command to finish. It can take few minutes for the VMware HCX appliance to come online.
3636

3737
## Scale VMware HCX manager
38-
Use the Scale VMware HCX Cloud Manager Run Command to increase the resource allocation of your VMware HCX Cloud Manager virtual machine to 8 vCPUs and 24-GB RAM from the default setting of 4 vCPUs and 12-GB RAM, ensuring scalability.
38+
Use the Scale VMware HCX Cloud Manager Run Command to increase the resource allocation of your VMware HCX Cloud Manager virtual machine, ensuring scalability for larger deployments and increased concurrent migrations.
39+
40+
**Supported in HCX 4.10+**
3941

4042
**Scenario**: Mobility Optimize Networking (MON) requires VMware HCX Scalability. For more details on [MON scaling](https://kb.vmware.com/s/article/88401)
4143

4244
>[!NOTE]
4345
> VMware HCX Cloud Manager will be rebooted during this operation, and this may affect any ongoing migration processes.
4446
45-
1. Navigate to the Run Command panel on in an Azure VMware Solution private cloud on the Azure portal.
47+
1. Navigate to the **Run Command** panel under **Operations** in an Azure VMware Solution private cloud on the Azure portal.
4648

47-
1. Select the **Microsoft.AVS.HCX** package dropdown menu and select the **Set-HcxScaledCpuAndMemorySetting** command.
49+
2. Select the **Microsoft.AVS.HCX** package dropdown menu and select the **Set-HcxScaledCpuAndMemorySetting** command.
4850

4951
:::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":::
5052

51-
1. Agree to restart VMware HCX by toggling ``AgreeToRestartHCX`` to **True**.
52-
You need to acknowledge that the virtual machine will be restarted.
53-
54-
55-
>[!NOTE]
56-
> If this required parameter is set to false that cmdlet execution will fail.
53+
3. Set parameters and select Run. Optional run command parameters.
5754

58-
1. Select **Run** to execute.
59-
This process takes between 10-15 minutes.
55+
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:
56+
57+
**ScaleFormFactor Parameter** - Specifies the target form factor for the HCX Manager VM — *"Medium"* or *"Large"*. Defaults to *"Medium"* if not specified. See [Form Factor Specification](use-hcx-run-commands.md) for details on each size.
58+
59+
**DiskStorageFormat Parameter** - Specifies the storage format for the new disk added during scaling — *"Thin"*, *"Thick"*, or *"EagerZeroedThick"*. Defaults to *"Thin"*. See [Disk Storage Formats] for guidance on choosing a format.
60+
61+
**AgreeToRestartHCX Parameter** (required) - Acknowledgment that the HCX Manager VM will be restarted during the scaling operation. Must be set to *True* for the command to execute. If set to *False*, the cmdlet execution will fail.
62+
63+
**Force Parameter** - Bypasses safety checks such as active migration and replication detection and existing snapshot validation. Use this parameter when a migration is stuck in an active state and you still need to proceed with scaling.
64+
65+
**SkipSnapshot Parameter** - Skips the creation of a pre-scaling snapshot. Requires the *-Force* parameter to be set. Not recommended, as the automatic snapshot provides a safety net for failure recovery.
66+
67+
4. Select **Run** to execute. This process takes between 10-15 minutes.
6068

61-
>[!NOTE]
62-
> VMware HCX cloud manager will be unavailable during the scaling.
69+
>[!NOTE]
70+
> VMware HCX Cloud Manager will be unavailable during the scaling.
71+
72+
### Form Factor Specifications
73+
74+
| Form Factor | vCPU | Memory | Disk | Use Case |
75+
| :--- | :--- | :--- | :--- | :--- |
76+
| **Small** (current default) | 4 | 12 GB | 60 GB | Small deployments, <500 VMs |
77+
| **Medium** | 8 | 24 GB | 120 GB | Medium deployments, 500-2000 VMs |
78+
| **Large** | 32 | 48 GB | 300 GB | Large deployments, >2000 VMs |
79+
>[!NOTE]
80+
>"Small" is the default form factor already deployed. It is not a selectable option in the *Set-HcxScaledCpuAndMemorySetting* command. The command only scales up to **Medium** or **Large**.
81+
82+
### Disk Storage Formats
83+
84+
| Format | Description | Performance | Space Efficiency | Use Case |
85+
| :--- | :--- | :--- | :--- | :--- |
86+
| **Thin** | Lazy-zeroed thin provisioning | Good | High | Default, most environments |
87+
| **Thick** | Eager-zeroed thick provisioning | Better | Low | Performance-critical |
88+
| **EagerZeroedThick** | Zeroed at creation | Best | Lowest | Maximum performance |
89+
90+
>[!NOTE]
91+
>Use the default "Thin" unless specific performance requirements dictate otherwise. Thin disks grow on-demand, while Thick and EagerZeroedThick allocate full space immediately.
92+
93+
### Automatic Failure Recovery
94+
If scaling fails at any point during execution, the system automatically recovers:
95+
96+
1. **Snapshot revert** - Automatically reverts to the pre-scaling snapshot.
97+
98+
2. **Power on** - Powers on HCX Manager from the snapshot state (last known good configuration).
99+
100+
3. **Error reporting** - Returns detailed error information.
101+
102+
4. **No manual intervention required** - The systems automatically recovers to a working state.
103+
104+
**Recovery time**: Typically 5-10 minutes to revert and power on.
63105

64106
## Take a snapshot of VMware HCX Cloud Manager
65107

0 commit comments

Comments
 (0)