NXLog Docs

Agent Management

At the bottom of the agent list is a row of actions used to manage agents.

Refresh status: This will send a query to the agent to retrieve status information. You need to select at least one Online agent with the checkbox to be able to use this.

Start

Start all stopped modules. You need to select at least one Online agent with the checkbox to be able to use this.

The xm_soapadmin module responsible for the agent manager connection must be always running, so this is module not affected. The NXLog process cannot be stopped and/or started from the NXLog Manager management interface.

Stop

Stop all modules. You need to select at least one Online agent with the checkbox to be able to use this.

Export: Export agent configuration in XML text format. When activated on the selected agent, the export action dialog appears. In this dialog, the manager allows separate parts to be exported. When the export is finished, the browser downloads it.

Import

Import an agent configuration, typically one previously exported.

There is the option to override and define new global configuration such as new manager address.

When triggered, the browser redirects to import options (if global config has been overridden, this section is skipped):

Agent import options

Similar to the Clone agent function, choose the XML file to import the new agent(s) configuration. When this is done, the manager also allows separate parts of the configuration to be imported:

Agent import settings

Update config: After the agent settings were changed, use this button to push the new configuration to the agent. All configuration related files, including pattern database files and certificates will be pushed to the agent. You will most probably want to Reload the agent after updating the configuration in order for the new settings to take effect. You need to select at least one Online agent with the checkbox to be able to use this.

Reload

This forces the agent to stop and shutdown all modules, reload the configuration and then reinitalize and start all. This should be used after a new configuration was pushed to the agent in order for the new setting to take effect. You need to select at least one Online agent with the checkbox to be able to use this.

This is not a process/service level restart but rather a reload. The xm_soapadmin module responsible for the agent manager connection must be always running, so this module is not affected. The NXLog process cannot be stopped and/or started from the NXLog Manager management interface.

Configure: This button will load the Agent Configuration page. You need to select exactly one agent with the checkbox to be able to use this.

Add

Add a new agent.

An agent will appear in the list without a configuration after successfully connecting to the agent manager even if it does not exist in the agent list. It is possible to add a new agent by creating a certificate, deploying the installer, and starting the NXLog service. The new agent entry should appear automatically.

Delete

Delete the agent.

There is no confirmation dialog, be careful when clicking on this button.

The agent will reappear if it has a valid certificate and can successfully authenticate to the agent manager. Make sure to revoke the certificate and stop the NXLog service before you delete the entry with this button. If the NXLog service is not stopped and removed, it will try to reconnect (if it was configured so).

Clone: Clone the agent. The cloned agent(s) will have all the modules and routes of the original one. You need to select exactly one agent with the checkbox to be able to use this.

Download config: Downloads the agent configuration in zip file to ease agents deployment locally. For each agent there will be folder in the archive with it’s name containing all the necessary configuration files and certificates. You must select at least one agent with the checkbox to be able to use this.

View log: View the log of an agent. By the default it is limited to 100K of the last log. You need to select exactly one agent with the checkbox to be able to use this.

Assign template

Assign template to agent(s). The selected agents will lose their configuration and now will have the template one.

This button is only visible if there are existing templates.

You must select at least one agent with the checkbox to be able to use this.

Issue certificate: Issue certificate for the selected agent(s). If the checkbox Update connected agents remains checked, the manager will also issue Update config command. You must select at least one agent which doesn’t have certificate already with the checkbox to be able to use this.

Renew certificate

Renew certificate for the selected agent(s) due to expiry or other reason. If the checkbox Update connected agents remains checked, the manager will also issue Update config command.

If a selected agent already has a valid certificate, it will be revoked