|
| 1 | +--- |
| 2 | +title: Support.AksArc diagnostic and remediation tool |
| 3 | +description: Learn how to run commands in the Support.AksArc PowerShell module to diagnose and remediate issues in AKS Arc environments. |
| 4 | +ms.topic: troubleshooting |
| 5 | +author: sethmanheim |
| 6 | +ms.author: sethm |
| 7 | +ms.date: 07/22/2025 |
| 8 | +ms.reviewer: sumsmith |
| 9 | +ms.lastreviewed: 07/22/2025 |
| 10 | + |
| 11 | +--- |
| 12 | + |
| 13 | +# Support.AksArc module |
| 14 | + |
| 15 | +The [**Support.AksArc**](https://www.powershellgallery.com/packages/Support.AksArc) PowerShell module provides diagnostic and remediation capabilities for AKS Arc environments. Before you open a support request, you can run the specified commands in this module to help diagnose and potentially resolve issues. |
| 16 | + |
| 17 | +You should run the commands if you experience any of the following symptoms: |
| 18 | + |
| 19 | +- Solution upgrade fails in MOC binaries state. |
| 20 | +- Solution upgrade fails in Arc Resource Bridge stage. |
| 21 | +- MOC service doesn't stay online. |
| 22 | +- Arc Resource Bridge is offline. |
| 23 | + |
| 24 | +## Commands |
| 25 | + |
| 26 | +The **Support.AksArc** module contains the following PowerShell commands: |
| 27 | + |
| 28 | +- `Test-SupportAksArcKnownIssues`: tests for known issues. |
| 29 | +- `Invoke-SupportAksArcRemediation`: fixes identified issues. |
| 30 | + |
| 31 | +## Installation |
| 32 | + |
| 33 | +To install the module, run the following commands: |
| 34 | + |
| 35 | +```powershell |
| 36 | +Install-Module -Name Support.AksArc |
| 37 | +Import-Module Support.AksArc |
| 38 | +``` |
| 39 | + |
| 40 | +## Usage |
| 41 | + |
| 42 | +> [!NOTE] |
| 43 | +> Make sure to run these PowerShell commands locally, not in a PowerShell remote session. |
| 44 | +
|
| 45 | +The following command performs a health check: |
| 46 | + |
| 47 | +```powershell |
| 48 | +Test-SupportAksArcKnownIssues |
| 49 | +``` |
| 50 | + |
| 51 | +This command performs auto-remediation (tests and fixes all issues): |
| 52 | + |
| 53 | +```powershell |
| 54 | +Invoke-SupportAksArcRemediation |
| 55 | +``` |
| 56 | + |
| 57 | +## Example output |
| 58 | + |
| 59 | +The following example output from the `Test-SupportAksArcKnownIssues` command shows the results of a failed test:: |
| 60 | + |
| 61 | +```output |
| 62 | +Test Name Status Message |
| 63 | +--------- -------------- |
| 64 | +Validate Failover Cluster Service Responsiveness Passed Failover Cluster service is responsive. |
| 65 | +Validate Missing MOC Cloud Agents Passed No missing MOC cloud agents found. |
| 66 | +Validate MOC Cloud Agent Running Passed MOC Cloud Agent is running |
| 67 | +Validate Missing MOC Node Agents Passed All MOC nodes have the Node Agent service installed and healthy. |
| 68 | +Validate Missing MOC Host Agents Passed All nodes have MOC host agents installed and healthy |
| 69 | +Validate MOC is on Latest Patch Version Failed MOC is not on the latest patch version. Current: 1.15.5.10626, Latest: 1.15.7.10719 |
| 70 | +Validate Expired Certificates Passed No expired certificates found |
| 71 | +Validate MOC Nodes Not Active Passed All MOC nodes are in the 'Active' state |
| 72 | +Validate Multiple MOC Cloud Agent Instances Passed No multiple instances of MOC Cloud Agent found |
| 73 | +Validate Windows Event Log Running Passed Windows Event Log is running |
| 74 | +Validate Gallery Image Stuck In Deleting Passed No gallery images are stuck in deleting state |
| 75 | +Validate Virtual Machine Stuck In Pending Passed No virtual machines are stuck in pending state |
| 76 | +Validate Virtual Machine Management Service Responsiveness Passed Virtual Machine Management service is responsive |
| 77 | +``` |
| 78 | + |
| 79 | +The following example output shows a successful result for all tests: |
| 80 | + |
| 81 | +```output |
| 82 | +Test Name Status Message |
| 83 | +--------- -------------- |
| 84 | +Validate Failover Cluster Service Responsiveness Passed Failover Cluster service is responsive. |
| 85 | +Validate Missing MOC Cloud Agents Passed No missing MOC cloud agents found. |
| 86 | +Validate MOC Cloud Agent Running Passed MOC Cloud Agent is running |
| 87 | +Validate Missing MOC Node Agents Passed All MOC nodes have the Node Agent service installed and healthy. |
| 88 | +Validate Missing MOC Host Agents Passed All nodes have MOC host agents installed and healthy. |
| 89 | +Validate MOC is on Latest Patch Version Passed MOC is on the latest patch version. |
| 90 | +Validate Expired Certificates Passed No expired certificates found. |
| 91 | +Validate MOC Nodes Not Active Passed All NMC nodes are in the 'Active' state. |
| 92 | +Validate NMC Nodes Sync with Cluster Nodes Passed All NMC nodes are in sync with cluster nodes. |
| 93 | +Validate Multiple NMC Cloud Agent Instances Passed No multiple instances of NMC Cloud Agent found. |
| 94 | +Validate NMC Powershell Not Stuck in Updating Passed NMC Powershell is not stuck in updating state. |
| 95 | +Validate Windows Event Log Running Passed Windows Event Log is running |
| 96 | +Validate Gallery Image Stuck In Deleting Passed No gallery images are stuck in deleting state. |
| 97 | +Validate Virtual Machine Stuck In Pending Passed No virtual machines are stuck in pending state. |
| 98 | +Validate Virtual Machine Management Service Responsiveness Passed Virtual Machine Management service is responsive. |
| 99 | +``` |
| 100 | + |
| 101 | +## Next steps |
| 102 | + |
| 103 | +[Use the diagnostic checker tool to identify common environment issues](aks-arc-diagnostic-checker.md) |
0 commit comments