On-Premise Agent Server

The on-premise agent comes equipped with an optional http server. This server is default off, but it can be enabled via the config. This server contains an endpoint /info that displays information about the current on-premise agent environment and Lumos connectivity status.

Agent Configuration

The http server and its port are configurable through the various config methods the on-premise agent provides. The server is default disabled; when the server is enabled, the default port is 10002.

settings.toml file

Within the settings.toml file that exists in the decompressed Lumos On-Premise Agent files, set the keys to your desired value:

[agent-settings]
http-enable-server = true
http-server-port = 54321

Environment Variable

For both Windows and Linux Agents, the environment variables are LUMOS_ON_PREMISE_AGENT_HTTP_ENABLE_SERVER and LUMOS_ON_PREMISE_AGENT_HTTP_SERVER_PORT

🚧

Port Forwarding

Our Docker image does not forward the http server's port by default. You will need to expose the port when you run the Docker image. Please follow the Docker instructions for exposing ports.

On-Premise Agent Info

The http server has an info endpoint that returns information about the target agent.

**Example On-Premise Agent Info Response

{
  "connected": true,
  "domain_name": "lumos.com",
  "cluster_id": "prod-cluster-01",
  "operation_mode": "default",
  "connectors": [
    {
      "app_id": "activedirectory_on_prem",
      "version": "1.177.0"
    },
    ...
  ],
  "version": "0.1.37"
}

• connected (boolean) - True if the agent has a connection to lumos, False if not
• domain_name (string) - This is the domain name that the agent was last connected to
• cluster_id (string) - This is the cluster identifier if a cluster_id is set for the agent
• operation_mode (string) - This is the current operation mode set for the agent.
• connectors (dict) - This is a registry of the all the connectors that the agent recognizes. Each registry entry contains the connector name as the app_id and the version of the connector
• version (string) - This is the version of the agent