NXLog User Guide
162. Templates
NXLog templates are used for Agent configuration with templates. Templates can be useful for agent mass deployment with the configuration of the template, and also for tagging. This chapter discusses the GUI configuration and management frontend provided by NXLog Manager.
To list the available NXLog templates, click on the Agent templates tab in AGENTS page. A list similar to the following should appear:
This list contains the following information:
- Template name
-
The template name is the unique name of a NXLog template. Clicking on the template name will load the Template configuration page.
- Description
-
This is the NXLog template detailed description.
- Connection address
-
This column shows the address of the NXLog agents belonging to this template are configured for connection with the NXLog Manager. Not available when the template is Unmanaged.
- Connection port
-
This column shows the port of the NXLog agents belonging to this template are configured for connection with the NXLog Manager. Not available when the template is Unmanaged.
- Created
-
This column shows the date and time when this NXLog template is created.
- Last modified
-
This column shows the date and time when this NXLog template has been last modified.
On the bottom of the list there is a row of buttons which can be used to manage the agent(s).
- Add
-
Add a new template.
- Export
-
Similarly to Export agent configuration, this action exports template configuration.
- Import
-
Similarly to Import agent configuration, this action imports template configuration.
NoteThe only difference to agents is missing certificate definition. - Delete
-
Delete the template.
NoteDeleted template must be unassigned from the agents belonging to it. If there are any, a confirmation dialog will appear:
- Clone
-
Clone a template with the same configuration.
- Create agents
-
Create agents and automatically assign this template to them.
162.1. Template configuration
As templates are used for grouping the NXLog agents configuration, this is almost the same as the Agent configuration. The only difference is the missing Certificate as this is specific to the agents themselves.
162.1.1. Tags
NXLog templates/agents can be managed by tags. Tags have role and user access permissions. To list them for a template, click on Tags tab under Template configuration page:
This list contains the following information:
- Name
-
The unique name of a tag.
- Description
-
This is the tag detailed description.
- Permissions by Role
-
This column shows the access permissions of each role which is allowed to manage NXLog agents.
- Permissions by User
-
This column shows the access permissions of each user which is allowed to manage NXLog agents.
On the bottom of the list there is a row of buttons which can be used to manage the tags(s).
To add a new tag to the system (and in parallel assign to this template), click on the Add button. An Add tag dialog will appear:
Fill in the Name and optionally description of this tag. When click on Save a new tag will be created with default access permissions, assigned to this template and will appear on the list:
Tag can be then edited by selecting it and click the Edit button. Edit dialog appears, containing two tabs: Tag and Permissions:
If permission need to be changed by user, click on by User link:
When some permissions are changed, click Update permissions button. When all done Save, to make sure all the changes will be accepted.
If tags are needed to be assigned/unassigned to the current template, click on Assign button on tag list page. The following dialog will appear:
Select the tags needed from the multi select box and Assign them.