Use the Support tool to troubleshoot and fix Azure Local infrastructure problems

The Support tool (also known as AKS Arc Support Tool) is a PowerShell module that provides diagnostic and remediation capabilities for the infrastructure components used by Azure Local VMs and Azure Kubernetes Service (AKS) enabled by Azure Arc on Azure Local.

Benefits of using the Support tool

The Support tool uses simple commands to identify problems without expert product knowledge. The tool provides:

Remediation for issues pertaining to Azure Local VMs and AKS Arc: Helps to identify and remediate common issues with Azure Local infrastructure components.
Fixes for solution update problems: Identifies and attempts to fix common problems that occur during the solution update.

Before you open a support request, run the Support tool. This tool resolves a wide range of Azure Local VM issues automatically by updating the infrastructure components such as Microsoft On-Premises Cloud (MOC) to the latest patch release. Running this tool results in a faster resolution of the issue without having to file a support ticket. If the problems persist, raise a support ticket.

Common problems where the Support tool might help

Run the commands if you experience any of the following symptoms on your Azure Local instance:

Azure Local VMs runs into problems.
Solution update fails:
- In MOC binaries state.
- In Arc resource bridge stage.
MOC service doesn't stay online.
Arc resource bridge is offline.

Prerequisites

Before you begin, make sure that you:

Have access to an Azure Local instance that runs version 2311.2 or later.
Have access to a client that can connect to your Azure Local.

Connect to your Azure Local instance

Follow these steps on your client to connect to one of the machines in your Azure Local instance.

Run PowerShell as an administrator on the client that you use to connect to your system.

Open a remote PowerShell session to a machine on your Azure Local instance. Run the following command and provide the credentials for your machine when prompted:

$cred = Get-Credential
$ip = "<IP address of the Azure Local machine>"
Enter-PSSession -ComputerName $ip -Credential $cred

Note

Sign in by using your deployment account credentials. This account is created when you prepare Active Directory and use it to deploy Azure Local.

Expand this section to see an example output.

Here's an example output:

PS C:\Users\Administrator> $cred = Get-Credential
PS C:\Users\Administrator> $ip = "100.100.100.10"
cmdlet Get-Credential at command pipeline position 1
Supply values for the following parameters:
Credential
PS C:\Users\Administrator> Enter-PSSession -ComputerName $ip -Credential $cred 
[100.100.100.10]: PS C:\Users\Administrator\Documents>

Install the Support tool module

To install the Support tool module, run the following commands:

Install-Module -Name Support.AksArc
Import-Module Support.AksArc -force

Note

When you import the module, it tries to automatically update from the PowerShell gallery.

If you already have the module installed, update it by using the following cmdlet:

Remove-Module -Name Support.AksArc
Update-Module -Name Support.AksArc
Import-Module -Name Support.AksArc