Skip to main content
Version: Next

Agents

Agents are logical identifiers created on the Server, each possessing their own unique name and id property. When an id is not specified, the system will automatically generate an id, a UUID, for the Agent. The Agent name can be changed at any time without impacting functionality.

note

The Agent name and id must be unique!

Listing Agents​

$> 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 components used to manage Pipes. You can add or remove Pipes from an Agent:

  • manually adding Pipes to a specific Agent

  • adding Pipes to Agents that match a specific Tag

  • Tags allow bulk addition and removal of Pipes

Managing Pipes and Agents​

Follow these steps to manually add and remove Pipes from an Agent.

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, follow these steps.

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>