Enroll an agent manually

Adding an agent to NXLog Platform and enrolling it is an easy, straightforward process. Follow the steps below to install, configure, and enroll an agent.

Install and enroll an agent

Navigate to Agents from the left navigation menu. The wizard under the search bar will walk you through the steps to download, install, and configure the agent.

Select the operating system where you are installing the agent.

Click Next to proceed.
Click Download Installer to access the NXLog Agent download page, already filtered by the selected operating system. Download and run the NXLog Agent installer, following the prompts from the installation wizard.

Click Next to proceed.
Download the managed.conf file, or copy its content and paste it on the existing managed.conf file for your agent, replacing any existing configuration.

Click Next to proceed.
Follow the instructions to restart the NXLog Agent and apply the updated configuration. The agent will connect to NXLog Platform at this stage.

Click Next to proceed.
At this point NXLog Platform will try to detect a connection attempt from the agent.
Once NXLog Platform detects the connection attempt from the agent, click Enroll Agent to complete the process.

Once the agent is enrolled, the Status will change to Online, and the Deployment state will change to Configured.

The Deployment state of the NXLog Agent will only change to Configured if you have applied a configuration to it.
If you have not applied a configuration to your agent yet, the Deployment state will be Enrolled. You can apply a configuration anytime for a connected agent.

That’s it; you can now monitor and configure your agent from NXLog Platform.

Enroll a connected agent

If the agent is already installed and connected to NXLog Platform, you can enroll it directly through the Actions menu instead of going through the enrollment wizard.

To enroll an agent that is already connected, complete the following steps:

Navigate to the Agents page. You should see your agent listed in the agents table with a New deployment state.
Click the Actions menu for your agent.
Click Enroll or Enroll with template (to enroll and apply a configuration template).

Once the agent is enrolled, the Status will change to Online, and the Deployment state will change to Enrolled or Configured (if the agent has a configuration).

Unenroll an agent

If, for some reason, you need to remove the agent, you must unenroll it from NXLog Platform. Unenrolling an agent does not delete or uninstall the agent, but NXLog Platform will stop monitoring it.

To unenroll an agent:

Navigate to the Agents page.
Find the agent in the table and click the Actions menu.
Choose Unenroll.

Unenroll an NXLog Agent

You should only unenroll agents that you no longer wish to monitor. If you manually uninstall or stop the NXLog Agent and unenroll it, it will be removed from the Agents table. However, if you reinstall or start the agent again, it will reconnect to NXLog Platform as a new agent.