You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: support/azure/virtual-machines/linux/linux-azure-guest-agent-tools-vmassist.md
+11-13Lines changed: 11 additions & 13 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -13,16 +13,11 @@ ms.custom: sap:zzzz
13
13
14
14
**Applies to:**:heavy_check_mark: Linux VMs
15
15
16
-
The Microsoft Azure Linux VM Agent is a secure, lightweight process that manages virtual machine (VM) interaction with the Azure fabric controller. The Azure Linux VM Agent has a primary role in enabling and executing Azure virtual machine extensions. VM extensions enable post-deployment configuration of VMs, such as installing and configuring software. VM extensions also enable recovery features such as resetting the administrative password of a VM. Without the Azure Linux VM Agent, you can't run VM extensions.
17
-
18
-
[Add Link]()
19
-
16
+
## Overview
20
17
21
-
## Tool overview
22
-
23
-
### VM assist
18
+
The Microsoft Azure Linux VM Agent is a secure, lightweight process that manages virtual machine (VM) interaction with the Azure fabric controller. The Azure Linux VM Agent has a primary role in enabling and executing Azure virtual machine extensions. VM extensions enable post-deployment configuration of VMs, such as installing and configuring software. VM extensions also enable recovery features such as resetting the administrative password of a VM. Without the Azure Linux VM Agent, you can't run VM extensions.
24
19
25
-
####Purpose
20
+
## Purpose
26
21
The Linux version of VM assist is comprised of bash and Python scripts used to detect potential issues with the Guest Agent in a Linux VM in addition to other issues related to the general health of the VM. Output is intended to be viewed in the serial console and provide pointers to solve well-known issues, as well as certain deviations from best practice which can affect VM availability. The intention is for engineers to provide this script to customers via GitHub, but it is possible and acceptable that a customer uses the script on their own and provides data through an SR.
27
22
28
23
Given that the output of this script is designed to be viewed in a worst-case scenario of the Azure serial console, the information displayed is minimal and condensed, with detail provided through online resources accessed via an link provided in that output - [VM assist for Linux](https://aka.ms/vmassistlinux)
@@ -31,8 +26,10 @@ VM assist is delivered in two functional scripts - one in bash and one in python
31
26
32
27
The bash script will perform some basic checks and determine if running the Python script is possible and/or necessary.
33
28
34
-
#### Key features
35
-
##### Bash checks
29
+
## Key features
30
+
31
+
### Bash checks
32
+
36
33
The following checks are run in bash today:
37
34
38
35
- OS family detection
@@ -43,7 +40,8 @@ The following checks are run in bash today:
43
40
44
41
> If the bash script finds a python2 system the script will exit and display the information it has gathered.
45
42
46
-
##### Python analysis
43
+
### Python analysis
44
+
47
45
If there are no issues uncovered during the base checks using bash, the Python script is called to perform a deeper analysis:
48
46
49
47
- Find the source (package) for the Guest Agent executable and the Python passed from bash
@@ -55,7 +53,8 @@ If there are no issues uncovered during the base checks using bash, the Python s
55
53
- Basic system configuration and status checks (#Guest best practices)
56
54
57
55
58
-
#### Prerequisites
56
+
## Prerequisites
57
+
59
58
- VM needs to be booting to the full OS, i.e. not emergency or maintenance mode.
60
59
- root-level access either through sudo or direct login/sudo -i
61
60
@@ -71,7 +70,6 @@ If you open a support request, please include both of the above files to aid you
71
70
- Ubuntu 24.04 has a differing architecture of the SSH service, and may flag the service even though it is operating fine.
Copy file name to clipboardExpand all lines: support/azure/virtual-machines/windows/windows-azure-guest-agent-tools-vmassist.md
+9-13Lines changed: 9 additions & 13 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -13,24 +13,19 @@ ms.custom: sap:zzzz
13
13
14
14
**Applies to:**:heavy_check_mark: Windows VMs
15
15
16
-
The Microsoft Azure Windows VM Agent is a secure, lightweight process that manages virtual machine (VM) interaction with the Azure fabric controller. The Azure Windows VM Agent has a primary role in enabling and executing Azure virtual machine extensions. VM extensions enable post-deployment configuration of VMs, such as installing and configuring software. VM extensions also enable recovery features such as resetting the administrative password of a VM. Without the Azure Windows VM Agent, you can't run VM extensions.
17
-
18
-
[Add Link]()
19
-
16
+
## Overview
20
17
21
-
## Tool overview
22
-
23
-
### VM assist
18
+
The Microsoft Azure Windows VM Agent is a secure, lightweight process that manages virtual machine (VM) interaction with the Azure fabric controller. The Azure Windows VM Agent has a primary role in enabling and executing Azure virtual machine extensions. VM extensions enable post-deployment configuration of VMs, such as installing and configuring software. VM extensions also enable recovery features such as resetting the administrative password of a VM. Without the Azure Windows VM Agent, you can't run VM extensions.
24
19
25
-
####Purpose
20
+
## Purpose
26
21
VM assist (Windows version) is a PowerShell script intended to be used to diagnose issues with the Azure Windows VM Guest Agent in addition to other issues related to the general health of the VM. This includes various information about the system such as firewall rules, running services, running drivers, installed software, NIC settings, and installed software, and installed Windows Updates.
27
22
28
23
Output of the checks can be viewed in the PowerShell window the script is ran in. Additionally running VM assist generates a detailed .htm report showing the results of each check it performs and suggests mitigations for issues it finds.
29
24
30
-
####Key features
25
+
## Key features
31
26
Output of the checks can be viewed in the PowerShell window the script is ran in. Additionally running VM assist generates a detailed .htm report showing the results of each check it performs and suggests mitigations for issues it finds.
32
27
33
-
####Prerequisites
28
+
## Prerequisites
34
29
* Windows Server 2012 R2 and later versions of Windows
35
30
* Windows 11 or later versions of the client
36
31
* Windows Powershell 4.0+ and PowerShell 6.0+
@@ -39,7 +34,7 @@ Output of the checks can be viewed in the PowerShell window the script is ran in
39
34
40
35
You can run the tool in any of the following manners.
41
36
42
-
### 1. Download from GitHub and run within the VM
37
+
### Option 1: Download from GitHub and run within the VM
43
38
44
39
Download the scripts from GitHub, and then run them manually. To access the scripts, follow the resource links in the previous sections.
45
40
Please see the GitHub page to see the latest instruction for how a you can [install VM assist](https://github.com//azure/azure-support-scripts/blob/master/vmassist/windows/README.md).
@@ -54,7 +49,7 @@ Or you can specify the full URL instead of the aka.ms short link -
1. Download the file ```vmassist.ps1```[from a web browser.](https://github.com//azure/azure-support-scripts/blob/master/vmassist/windows/vmassist.ps1)
77
73
1. From an elevated PowerShell window, ensure you're in the same directory that you downloaded the script to, then run the following to run the script:
0 commit comments