Agent Configuration

The RevTwo linux agent requires configuration to run. This has 2 parts, one for the model of the device, and one for the instance of the device. The path to configuration files is an argument to the agent, so running

$ R2Agent ~/rev2agent/config

will tell the agent to look in the current directory (default) and then in the specified directory for these files.

The first configuration is called appconfig.data and it contains the model of the agent. You get this file from the Models page of the web application.

linux_appconfig

This file is encrypted but still text. If you need to transfer this file to a linux target, the text can be pasted into an editor.

The second file is called userconfig.json and this contains the instance identity for the device.  Here is an example of the minimal file:

{
"uuid"          : "ac6996a9-dee7-33da-8dfe-22d2e5a76d2e",
"device_name"   : "S84T-9182",
"app_name"      : "R2Agent"
}

The uuid must be a globally unique string that identifies the device for its lifetime.

The device_name can be any string that identifies the device to your users, or application. The recommendation is to use a serial number for a product. This string should be unique within your model or searches will not be able to find the single device.

The app_name is only used if syslog_addr is specified, and the syslog entries will be organized under the app_name.

The following are optional:
The revtwodb_path is a path to a file that contains logging and other information. <Details coming soon>

The syslog_addr is the IP address of a syslog server where the agent will send messages when a session is connected.

The log_to is the path to a directory that will contain log files that record remote sessions.

The log_level specifies how much logging to do. Values are: “trace”, “debug”, “warning”, and “error” in ascending order. Only message of log_level and higher will be generated by the agent.

An example of a full userconfig.json file is:

{
"uuid"          : "ac6996a9-dee7-33da-8dfe-22d2e5a76d2e",
"device_name"   : "S84T-9182",
"revtwodb_path" : "./revtwo.db",
"syslog_addr"   : "192.168.2.36",
"app_name"      : "R2Agent",
"log_level"     : "warning",
"log_to"        : "./logs"
}

The userconfig.json file can be generated by a script in the Support Snap. An installer can always edit this file in small numbers. But to deploy the agent in large scale, this file needs to be generated with the device name corresponding to the identity of the associated product. An installation script is the best choice.