Agents

Agents are logical identifiers created on the Hotrod Server and have a unique name and id property. If an id is not specified the system will auto generate a uuid for the agent, this is recommended, as the name property is used as a friendly name that you can choose and also change at any time without impacting any of the other Hotrod functionality.

Agent names and ids must be unique.

Listing Agents

List the current agents on the server.

$ hotrod agents list

 name          | id      | tags | pipes | last seen
---------------+---------+------+-------+-----------
 <AGENT NAME>  | <UUID>  |      |       |

Deleting Agents

$ hotrod agents remove <AGENTS NAME>

agent <AGENT NAME> (<UUID>) removed

Creating Agents

$ hotrod agents add <AGENT NAME>

agent <AGENT NAME> has id <UUID>

Updating Agents

Agents are the logical identifiers used to instantiate pipes, to that extent an end user can add or remove pipes from a agent in two different ways:

• Firstly by manually adding pipes to a specific agent (see "Managing pipes and agents" below).
• Secondly add pipes to all agents that match a specific tag, this allows bulk addition and removal of pipes (see "Managing tags and agents" below).

Managing pipes and agents

To manually add and remove pipes from an agent, follow the steps below:

Add a pipe to an agent

$ hotrod agents update <AGENT NAME> --add-pipe <PIPE NAME>

[INFO] user=admin adding pipe=<PIPE NAME> to agent=<AGENT NAME>

Remove a pipe from an agent

$ hotrod agents update <AGENT NAME> --remove-pipe <PIPE NAME>

[INFO] user=admin removing pipe=<PIPE NAME> from agent=<AGENT NAME>

Managing tags and agents

To add and remove pipes from an agent in bulk, add tags to the agent by following the steps below:

Add a tag to an agent

$ hotrod agents update <AGENT NAME> --add-tag <TAG NAME>

[INFO] user=admin added tag <TAG NAME> to agent=<AGENT NAME>

Remove a tag from an agent

$ hotrod agents update <AGENT NAME> --remove-tag <TAG NAME>

[INFO] user=admin removing tag <TAG NAME> from agent id=<AGENT NAME>