Skip to content

Commit ea4ef19

Browse files
committed
Learn Editor: Update use-hcx-run-commands.md
1 parent e8e8361 commit ea4ef19

File tree

1 file changed

+56
-3
lines changed

1 file changed

+56
-3
lines changed

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

Lines changed: 56 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,6 @@ ms.date: 3/22/2024
1010
# Use VMware HCX Run Commands
1111
In this article, learn how to use VMware 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 VMware HCX Run Commands and how to use them.
1212

13-
This article describes two VMware HCX commands: **Restart HCX Manager** and **Scale HCX Manager**.
14-
1513
## Restart VMware HCX Manager
1614

1715
This Command checks for active VMware HCX migrations and replications. If none are found, it restarts the VMware HCX Cloud Manager (VMware HCX VM's guest OS).
@@ -45,7 +43,7 @@ Use the Scale VMware HCX Cloud Manager Run Command to increase the resource allo
4543
4644
1. Navigate to the Run Command panel on in an Azure VMware Solution private cloud on the Azure portal.
4745

48-
1. Select the **Microsoft.AVS.HCX** package dropdown menu and select the ``Set-HcxScaledCpuAndMemorySetting`` command.
46+
1. Select the **Microsoft.AVS.HCX** package dropdown menu and select the **Set-HcxScaledCpuAndMemorySetting** command.
4947

5048
:::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":::
5149

@@ -62,5 +60,60 @@ Use the Scale VMware HCX Cloud Manager Run Command to increase the resource allo
6260
>[!NOTE]
6361
> VMware HCX cloud manager will be unavailable during the scaling.
6462
63+
## Take a snapshot of VMware HCX Cloud Manager
64+
65+
1. Navigate to the Run Command panel on in an Azure VMware Solution private cloud on the Azure portal.
66+
67+
2. Select the **Microsoft.AVS.HCX** package dropdown menu and select the **New-HCXManagerSnapshot** command.
68+
69+
3. Specify Optional Command parameters as needed. Available command parameters available are as below:
70+
**Description** - A description for the snapshot.
71+
**Force** - Force parameter bypasses the alert of active HCX migrations or replications, allowing the snapshot to be created even if these processes are in progress. If any warnings are triggered, the snapshot creation proceeds regardless of the detected conditions.
72+
**Memory** - Memory snapshots preserve the live state of a virtual machine, allowing for precise recovery if an upgrade or change does not go as expected. They do not require quiescing, ensuring an exact capture of the VM's running state. If memory is not included, the snapshot saves only disk data, which remains crash-consistent unless explicitly quiesced.
73+
**Quiesce** - Quiescing a virtual machine ensures that its file system is in a consistent state when a snapshot is taken. This is useful for automated or periodic backups, especially when the VM's activity is unknown. Quiesced snapshots require VMware Tools and are unavailable if the VM is powered off or has large-capacity disks.
74+
75+
4. Select **Run** to execute.
76+
77+
>[!NOTE]
78+
> Snapshots created via run commands are retained for 72 hours and will be automatically deleted without prior notice.
79+
80+
## List all snapshots on VMware HCX Cloud Manager
81+
82+
1. Navigate to the Run Command panel on in an Azure VMware Solution private cloud on the Azure portal.
83+
84+
1. Select the **Microsoft.AVS.HCX** package dropdown menu and select the **Get-HCXManagerSnapshot** command.
85+
86+
1. Select **Run** to execute.
87+
88+
1. The snapshot details will be displayed under the **Output** tab. <br>
89+
90+
91+
## Update the description of the existing snapshot for VMware HCX Cloud Manager.
92+
93+
1. Navigate to the Run Command panel on in an Azure VMware Solution private cloud on the Azure portal.
94+
95+
2. Select the **Microsoft.AVS.HCX** package dropdown menu and select the **Update-HCXManagerSnapshotDescription** command.
96+
97+
3. Specify mandatory Command parameters as described below:
98+
**SnapshotName** - Name of the snapshot. You can use **Get-HCXManagerSnaphot** run command to list existing snapshots.
99+
**NewDescription** - A description for the snapshot.
100+
101+
4. Select **Run** to execute.
102+
103+
## Delete VMware HCX Cloud Manager snapshot
104+
105+
1. Navigate to the Run Command panel on in an Azure VMware Solution private cloud on the Azure portal.
106+
107+
2. Select the **Microsoft.AVS.HCX** package dropdown menu and select the **Remove-HCXManagerSnapshot** command.
108+
109+
3. Specify mandatory Command parameters as described below:
110+
**SnapshotName** - Name of the snapshot.
111+
112+
4. Specify Optional Command parameters as needed. Available command parameters available are as below:
113+
**RunAsync** - Indicates that the command returns immediately without waiting for the task to complete. In this mode, the output of the cmdlet is a Task object.
114+
**Force** - If any warnings are triggered, the snapshot deletion proceeds regardless of the detected conditions.
115+
**EnableDebug** - Indicates that the cmdlet is run only to display the changes that would be made and actually no objects are modified.
116+
117+
65118
## Next step
66119
To learn more about Run Commands, see [Run Commands](using-run-command.md)

0 commit comments

Comments
 (0)