Module - Host Agent
Module - Host Agent
Breadcrumbs

Introduction

Introduction: HOST AGENT

Overview

Factory Host Agent is an Ignition module and companion Host Client for connecting selected host-computer resources to an Ignition Gateway. The Host Client runs on a Linux, Windows, or macOS host and initiates communication with the Gateway.

After enrollment and Gateway approval, the module can:

  • report host and Host Client process observations;

  • publish status and telemetry through an Ignition tag provider;

  • monitor explicitly approved files and directories;

  • perform approved file operations;

  • expose explicitly approved serial ports; and

  • present operational status, recent activity, and command results in the Gateway.

Host enrollment does not grant general access to the host. File and serial access is controlled through resource-specific mappings that are reviewed on the host.

What Problem It Solves

Ignition projects sometimes need host-level information or controlled access to resources that are outside normal controller and tag workflows. Without a dedicated integration, teams may need separate utilities or project-specific code for host health, selected-file workflows, or locally attached serial devices.

Factory Host Agent provides a common Ignition-facing model for those tasks while keeping the host operator involved in approving file and serial access. It separates:

  • trust in the Host Client;

  • read-only telemetry;

  • file and directory permissions;

  • serial-port permissions.

Key Features and Benefits

  • Central operational visibility: Connected, pending, stale, and error states are visible from the Gateway.

  • Ignition-native consumption: Host, permission, file, and serial information is available through managed tags. Approved file operations also have a public scripting API.

  • Scoped host access: File and serial capabilities are limited to active mappings rather than broad host access.

  • Two-sided approval: A Gateway administrator can request access, while the host operator approves or declines the requested mapping.

  • Packaged onboarding: A Gateway-generated setup bundle combines the appropriate Host Client package with enrollment configuration.

  • Connection recovery: A running Host Client retries ordinary connection failures and sends fresh state after reconnection.

These are functional characteristics, not availability or performance guarantees.

Target Audience

This documentation is intended for:

  • Ignition Gateway administrators installing and operating the module;

  • system integrators designing host, file, or serial workflows;

  • Ignition developers using tags or the public scripting functions;

  • automation engineers integrating host-attached resources;

  • IT/OT personnel responsible for certificates, network access, endpoint policy, and least-privilege controls; and

  • host operators who review and approve local resource mappings.

Terminology

  • Gateway: The Ignition Gateway on which Factory Host Agent is installed.

  • Host Client: The companion application that runs on a participating host.

  • Host: A Linux, Windows, or macOS computer running the Host Client.

  • Mapping: A host-approved definition that grants read-only or read-write access to a selected file, directory, or serial resource.

  • Trusted host: A Host Client identity that has completed enrollment and has been approved by a Gateway administrator.

Last updated: