Skip to content

Commit 69cf938

Browse files
committed
sasaas
1 parent 05ae141 commit 69cf938

File tree

2 files changed

+20
-26
lines changed

2 files changed

+20
-26
lines changed

support/azure/virtual-machines/linux/linux-azure-guest-agent-tools-vmassist.md

Lines changed: 11 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -13,16 +13,11 @@ ms.custom: sap:zzzz
1313

1414
**Applies to:** :heavy_check_mark: Linux VMs
1515

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
2017

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.
2419

25-
#### Purpose
20+
## Purpose
2621
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.
2722

2823
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
3126

3227
The bash script will perform some basic checks and determine if running the Python script is possible and/or necessary.
3328

34-
#### Key features
35-
##### Bash checks
29+
## Key features
30+
31+
### Bash checks
32+
3633
The following checks are run in bash today:
3734

3835
- OS family detection
@@ -43,7 +40,8 @@ The following checks are run in bash today:
4340

4441
> If the bash script finds a python2 system the script will exit and display the information it has gathered.
4542
46-
##### Python analysis
43+
### Python analysis
44+
4745
If there are no issues uncovered during the base checks using bash, the Python script is called to perform a deeper analysis:
4846

4947
- 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
5553
- Basic system configuration and status checks (#Guest best practices)
5654

5755

58-
#### Prerequisites
56+
## Prerequisites
57+
5958
- VM needs to be booting to the full OS, i.e. not emergency or maintenance mode.
6059
- root-level access either through sudo or direct login/sudo -i
6160

@@ -71,7 +70,6 @@ If you open a support request, please include both of the above files to aid you
7170
- Ubuntu 24.04 has a differing architecture of the SSH service, and may flag the service even though it is operating fine.
7271

7372

74-
7573
[!INCLUDE [azure-help-support](~/includes/azure-help-support.md)]
7674

7775
[!INCLUDE [Third-party contact disclaimer](~/includes/third-party-contact-disclaimer.md)]

support/azure/virtual-machines/windows/windows-azure-guest-agent-tools-vmassist.md

Lines changed: 9 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -13,24 +13,19 @@ ms.custom: sap:zzzz
1313

1414
**Applies to:** :heavy_check_mark: Windows VMs
1515

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
2017

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.
2419

25-
#### Purpose
20+
## Purpose
2621
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.
2722

2823
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.
2924

30-
#### Key features
25+
## Key features
3126
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.
3227

33-
#### Prerequisites
28+
## Prerequisites
3429
* Windows Server 2012 R2 and later versions of Windows
3530
* Windows 11 or later versions of the client
3631
* 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
3934

4035
You can run the tool in any of the following manners.
4136

42-
### 1. Download from GitHub and run within the VM
37+
### Option 1: Download from GitHub and run within the VM
4338

4439
Download the scripts from GitHub, and then run them manually. To access the scripts, follow the resource links in the previous sections.
4540
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 -
5449
```powershell
5550
(Invoke-WebRequest -Uri https://raw.githubusercontent.com//azure/azure-support-scripts/master/vmassist/windows/vmassist.ps1 -OutFile vmassist.ps1) | .\vmassist.ps1
5651
```
57-
## Manual download and run
52+
### Option 2: Manual download and run
5853
Download:
5954
```powershell
6055
[Net.ServicePointManager]::SecurityProtocol = [Net.SecurityProtocolType]::Tls12
@@ -72,7 +67,8 @@ Set-ExecutionPolicy Bypass -Force
7267
.\vmassist.ps1
7368
```
7469

75-
## Download from browser
70+
### Option 3: Download from browser
71+
7672
1. Download the file ```vmassist.ps1``` [from a web browser.](https://github.com//azure/azure-support-scripts/blob/master/vmassist/windows/vmassist.ps1)
7773
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:
7874
```powershell

0 commit comments

Comments
 (0)