Skip to content

Agent

This is a required component to any system or edge device that you would like to be monitored by the xConnect Remote Management Platform.

This agent is responsible for collecting health information (also called telemetry) as well as securely facilitating remote management features.

graph LR A(Edge Devices) --> B(Agent) B --> A B -->|HTTPS|C(Bridge - Optional) C -->|HTTPS|D(xConnect Cloud Dashboard - Azure); style B fill:#04acec linkStyle default stroke-width:2px,fill:#2e303e,stroke:black;

Installation

If you purchased an appliance from Seneca, it may already contain the xConnect Agent.

However, it is highly recommended to always download and install the latest version available at time of setup.

Windows

  1. Open a Windows Powershell terminal with Administrative privileges

  2. Copy then Paste/run the following command into the admin powershell terminal:

    Set-ExecutionPolicy Bypass -Scope Process -Force; [Net.ServicePointManager]::SecurityProtocol = [Net.SecurityProtocolType]::Tls12; &([scriptblock]::Create((Invoke-WebRequest -useb 'https://download.senecaxconnect.com/files/Agent/xConnectInstallv3.ps1'))) -ring Stable -extraargs "--force"

Linux (Now Available!)

Contact Seneca xConnect Team for installation instructions for your linux distribution! Generic instructions will be posted soon!

Configuration (Cloud-Enablement)

  1. Access the Agent's Dashboard by going to http://localhost:8886/ (Also available by double-clicking the xConnect icon in the system tray)
  2. Click on the Settings navigation item at the top of the page.
  3. In the “Subscription ID:” field, enter the Subscription ID that was provided to you during onboarding.
  4. Click Save

Windows Service

The Agent consists of a single background Windows Service, called xConnect Agent Core.

The Agent Core service is responsible for the following functions and modules:

Telemetry Engine

This function is the telemetry collection engine that continuously polls various sensors throughout the system. It is also responsible for transmitting this telemetry to the Secure Gateway.

Telemetry Collection occurs based on the interval defined in your settings (Default: 10 Minutes)

Telemetry Submission occurs every minute

Integration Module

This module is the telemetry collection engine that continuously polls supported Video Management Systems or Content Management Systems for health and additional metadata of connected IP cameras (VMS). It is also responsible for transmitting this telemetry to the Secure Gateway.

Telemetry Collection occurs based on the interval defined in your settings (Default: 10 Minutes)

Telemetry Submission occurs every minute

Auto-Updater Module

This module handles touchless over the wire updates of the Agent. The Agent will automatically download and install updates in the background.

Checks for updates every 60 minutes

Agent Web Interface

This module provides a local (or LAN accessible) web interface for managing and configuring the Agent. Starts Automatically as part of the Agent Core and is accessible from the local machine @ http://localhost:8886 or on a networked machine @ http://IP_OF_SERVER:8886

Remote Command Module

This module handles remote commands that are securely received from the cloud. It is responsible for executing and tracking status of remotely triggered commands. We currently support Windows Command Shell and PowerShell, as well as Linux Shell (BASH/SH).

Agent RESTful API

This module provides a mechanism for 3rd party applications to ingest or transmit telemetry in and out of the Agent.

This API complies with the OpenAPI specification and guided documentation can be found at http://localhost:8886/docs