RemoteAccessChecker Tool User Guide

cancel
Showing results for 
Show  only  | Search instead for 
Did you mean: 
Remote Access Articles
5 min read
L0 Member
No ratings

Remote Access Checker User Guide

Introduction


The RemoteAccessChecker is a Python-based tool designed to verify connectivity and network prerequisites for various services, including Snap, Docker/Podman, Alero Datacenter Connectivity, and specific applications like PVWA and PSM HTML5 Gateway.

This tool helps to ensure that their systems can reach required endpoints and services, facilitating smooth operation and troubleshooting of network-related issues. 

Steps

Prerequisites

Note- Remote Access Checker Tool can be downloaded here: Remote Access Checker Tool 

Before you begin using the Remote Access Checker, ensure that your system meets the following requirements:

  • Python 3.7 or Later: The script requires Python version 3.7 or higher. You can check your Python version by running:

    python3 --version
    
  • Required Python Packages: The script depends on the requests library. Install it using:

    pip install requests
  • Network Access: Ensure your system has network access to the services and URLs you intend to check.


Configuration

1. Configuring config.json

The main configuration for the Remote Access Checker is stored in the config.json file. This file allows you to specify the URLs for your applications, such as PVWA and PSM HTML5 Gateway.

Steps to Configure:

  1. Locate config.json:

    • The config.json file should be in the same directory as your script.
  2. Open config.json for Editing:

    • Use a text editor (e.g., Notepad, Vim, Nano) to open the file.
  3. Edit the Applications Connectivity Section:

    • The file should contain a section like this:

      {
          "ApplicationsConnectivity": {
              "PVWA": {
                  "url": "PVWA URL"
              },
              "PSM_HTML5_GW": {
                  "url": "PSM HTML5 GW URL"
              }
          }
      }
      
    • Replace the placeholder URLs with your actual PVWA and PSM HTML5 Gateway URLs.

      • PVWA:

        "PVWA": {
            "url": "https://your-pvwa-url"
        }
        
      • PSM_HTML5_GW:

        "PSM_HTML5_GW": {
            "url": "https://your-psm-html5gw-url"
        }
        
  4. Save the Changes:

    • After updating the URLs, save the config.json file.

Important Notes:

  • Do Not Modify targets.json:

    • The targets.json file contains predefined targets and should not be modified. It includes the necessary endpoints for network prerequisite checks and datacenter connectivity.
  • Ensure Valid URLs:

    • Enter fully qualified URLs, including the protocol (https://). The script will handle URLs with or without the protocol, but providing the complete URL is recommended for clarity.

Running the Tool

  1. Navigate to the Script Directory:

    • Open a terminal or command prompt and navigate to the directory containing the RemoteAccessChecker.py script.
  2. Execute the Script:

    python3 RemoteAccessChecker.py
    
     
  3. Main Menu Options:

    Upon running, you will see the main menu:

    === Main Menu ===
    1 - Prerequisite Network Requirements
    2 - Alero Datacenter Connectivity
    3 - Applications Connectivity
    0 - Exit
    Enter your choice (0, 1, 2, or 3):
    

Using the Tool

1. Prerequisite Network Requirements

Select option 1 to check network prerequisites for Snap or Docker/Podman.

  • Sub-menu:

    --- Prerequisite Network Requirements ---
    1 - Snap
    2 - Docker/Podman
    0 - Back to Main Menu
    Enter your choice (0, 1, or 2):
    
  • Procedure:

    • Choose 1 for Snap or 2 for Docker/Podman.
    • The tool will perform connectivity checks to the necessary endpoints and display the results.

2. Alero Datacenter Connectivity

Select option 2 to check connectivity to various Alero Datacenters.

  • Sub-menu:

    --- Alero Datacenter Connectivity ---
    1 - US Data Center
    2 - EU Data Center
    3 - Canada Data Center
    4 - Australia Data Center
    5 - London Data Center
    6 - India Data Center
    7 - Singapore Data Center
    8 - UAE Data Center
    0 - Back to Main Menu
    Enter your choice (0, 1, 2, 3, 4, 5, 6, 7, or 8):
    
  • Procedure:

    • Choose the corresponding number for the datacenter you want to test.
    • The tool will perform a series of tests, including curl, ssh, and ssh-keyscan, to verify connectivity.
    • Results will be displayed for each service tested.

3. Applications Connectivity

Select option 3 to check connectivity to your PVWA and PSM HTML5 Gateway applications.

  • Procedure:

    • The tool will read the URLs from your config.json file.
    • It will perform curl commands to check the availability of the applications.
    • Results will indicate whether the applications are reachable and responding as expected.

4. Exiting the Tool

  • Select option 0 from any menu to exit the tool.

Understanding the Output

  • Success Messages:

    • ✅ Result: Indicates that the test was successful.
    • 🎉 All connection tests succeeded: All tests in the category passed.
  • Failure Messages:

    • ❌ Error: Indicates an error occurred during the test.
    • ⚠️ X out of Y connection tests failed: Some tests did not pass.
  • Command Display:

    • 💻 Command: Shows the exact command executed by the tool, which can be helpful for manual troubleshooting.

Logs

The Remote Access Checker generates log files to help you track the tests performed and diagnose issues.

  • Log Directory:

    • A Logs directory is created in the same directory as the script.
    • Log files are named with the timestamp of when the script was run, e.g., Remote_Access_Checker_log_20231005_123456.log.
  • Log Contents:

    • Each log file contains detailed information about the tests performed, including commands executed, results, and any errors encountered.

 

Rate this article:
  • 6695 Views
  • 0 comments
  • 0 Likes
Article Dashboard
Version history
Last Updated:
‎10-30-2025 07:06 AM
Updated by: