Skip to content

In a Nutshell (🌰)

  • Diagnose connection issues with Ansible, Docker, and system information
  • Run comprehensive tests to validate device connectivity
  • Troubleshoot authentication and configuration problems
  • Verify that your device meets all requirements for SSM

Overview

The diagnostic tools in SSM allow you to verify the connectivity and configuration of your devices. When you encounter issues with device management, container operations, or playbook execution, the diagnostic tab provides valuable tools to identify and resolve problems.

Diagnostic Tab
Device Diagnostic Interface

Available Diagnostic Tests

SSM offers several diagnostic tests to validate different aspects of device connectivity:

Basic Connection Tests

TestPurposeRequirements
Ansible ConnectionValidates SSH connectivity for Ansible operationsValid SSH credentials, Python on remote device
System InformationTests ability to retrieve basic system dataSSH connectivity in agentless mode
Docker ConnectionVerifies Docker engine connectivityDocker installed and running on device

Running Diagnostic Tests

1

Navigate to the device configuration page

2

Select the Diagnostic tab

3

Choose the test you want to run

4

Click the Run Test button

5

Wait for the test to complete

6

Review the results

Test results will display with a success indicator (green/red) and detailed information about any issues encountered.

Interpreting Test Results

Success Indicators

  • Green: Test passed successfully
  • Red: Test failed

Common Issues and Solutions

Ansible Connection Issues

IssueSolution
SSH Authentication FailureVerify your SSH credentials in the SSH configuration tab
Python MissingInstall Python on the remote device
Permission DeniedEnsure the SSH user has sufficient privileges

System Information Issues

IssueSolution
Connection TimeoutCheck network connectivity and firewall settings
Command Not FoundVerify system commands are available on the remote device

Docker Connection Issues

IssueSolution
Docker Not RunningStart the Docker service on the remote device
Permission DeniedAdd the SSH user to the docker group
API Version MismatchUpdate Docker to a compatible version

Advanced Diagnostic Workflow

For comprehensive troubleshooting, follow this workflow:

  1. Start with Basic Tests: Run the basic connection tests first
  2. Review Logs: Check the detailed logs for specific error messages
  3. Verify Configuration: Review your device configuration for errors
  4. Run Advanced Tests: If basic tests fail, run advanced diagnostic tests
  5. Apply Fixes: Make the necessary changes based on test results
  6. Retest: Run the tests again to verify your fixes worked

Using Diagnostic Tools Effectively

When to Run Diagnostics

Purpose: Situations where running diagnostics is recommended.

Situations:

  • After adding a new device
  • When changing device configuration
  • If container operations fail
  • When playbook execution encounters errors
  • After system updates on the device
Troubleshooting With Multiple Issues

Purpose: Approaching and resolving multiple diagnostic failures.

Proceed, in order:

  • Start with the most fundamental issue (usually SSH connectivity)
  • Resolve issues one at a time
  • Rerun tests after each fix
  • Document successful configurations for future reference

Next step

🏠
Device Configuration

Return to device configuration overview

Made with love