Agent Configuration Overview

The OHI Agent is a stateless component. It does not store data locally, nor does it depend on locally stored/available configuration data. This means that in order to do meaningful work the OHI Agent needs to get configuration from somewhere else. Besides a minimal set of command line parameters to start the OHI Agent application, this configuration is retrieved from the OHI Gateway. The OHI Gateway exposes a collection of REST resources for this purpose.

Effectively, there are two top level entities that hold configuration data for the OHI Agent. On one hand there are sub types for <tt>Agent Configuration</tt>, on the other there is <tt>Agent Configuration Integration</tt>.

Please note that when specific localization of the OHI Gateway is applicable, there also might be a need for localization specific Agent Configuration. Please check the localization specific section of the documentation when applicable.

Agent Configuration

An Agent Configuration record holds a particular configuration item that the OHI Agent knows how to process and use to drive a particular component that operates on premises. The standard Agent Configuration types, which are provided by the default OHI Gateway product are described in separate sections of this document.

Agent Configuration Integration

For every individual entry in Agent Configuration an association can be made with one or more integrations that actually need OHI Agent interaction. This is called an Agent Configuration Integration.

Field	Description
agentConfiguration	A reference to an Agent Configuration.
integration	A reference to a configured Integration.