manage_agents

manage_agents is available in two versions:

  • a version for OSPatrol server installations
  • a version for OSPatrol agent installations

The purpose of manage_agents is to provide an easy-to-use interface to handle authentication keys for OSPatrol agents. These authentication keys are required for secure (encrypted and authenticated) communication between the OSPatrol server and its affiliated agent instances.

manage_agents argument options

-h

Display the help message.

-V

Display OSPatrol Version.

-l

List available agents.

-e <agent_id>

Extracts key for an agent (Manager only).

-i <key>

Import authentication key (Agent only).

-f <file>

Generate clients in bulk from <file> (Manager only). The file is a comma delimited file containing the IP addresses and agent names to be added. This file should be located within /var/ospatrol, and referenced by its path relative to /var/ospatrol.

Example:

# cat /var/ospatrol/k
192.168.1.2,host02
192.168.1.3,host03

# /var/ospatrol/bin/manage_agents -f /k
Bulk load file: /k
Opening: [/k]
Agent information:
   ID:002
   Name:host02
   IP Address:192.168.1.2

Agent added.
Agent information:
   ID:003
   Name:host03
   IP Address:192.168.1.3

Agent added.

Usage

The OSPatrol manual goes into details on usage of this command at Managing Agents