User Manual

Download Install Script
Introduction

Welcome to the IoT Edge Gateway Portal. This centralized dashboard allows you to manage Virtual Machines, monitor IoT Edge modules, and troubleshoot system health effectively.

VM Management

The Virtual Machines section provides a comprehensive list of all registered IoT Edge VMs.

  • View Status: distinct icons indicate whether a VM is Running (Green) or Stopped (Red).
  • Manage Power: Use the action menu to Start or Stop VMs directly from the portal.
  • Health Check: The portal automatically performs health checks to verify connectivity to the edge runtime.
Module Handling

The Modules and OPC Publisher sections allow deep inspection of individual workload modules.

  • Monitoring: Real-time status updates for key modules like edgeAgent, edgeHub, and opcPublisher.
  • Logs: View live logs to debug issues. The log viewer supports filtering by log level (Info, Warning, Error) and keyword search.
  • Quick Fixes: Intelligent "Quick Fix" actions can automatically resolve common issues like stuck modules or telemetry failures.
Script Execution & Installation

For setting up new IoT Edge devices or repairing existing installations, we provide a standardized PowerShell script.

Installation Steps (Linux)
  1. Download the installation script using the button below.
  2. Transfer the file to your Linux device (e.g., using scp).
  3. Make the script executable: chmod +x setup-iotedge.sh
  4. Run the script with your connection string:
    sudo ./setup-iotedge.sh "HostName=...;DeviceId=...;SharedAccessKey=..."

Get the latest installation script

Download "setup-iotedge.sh"
Need Help?

If you encounter issues not covered in this manual, please check the Logs section for error details or contact the system administrator.