| Table of Contents |
|---|
...
Open-AudIT Queries
| Anchor | ||||
|---|---|---|---|---|
|
The integration leverages Open-AudIT's query feature as a way of controlling the devices you want to integrate with NMIS. You can read about Open-AudIT queries in detail here.
Integration Description
An integration run has the following steps:
...
| Key | Type | Description | |||
|---|---|---|---|---|---|
| log_path | A string representing either a fully-qualified path, or a path relative to the integration's execution. | The path for the integration log. This log will contain a summary of actions that are taken for each integration, including system calls to node_admin.pl. | |||
| node_admin_path | A string representing either a fully-qualified path, or a path relative to the integration's execution. | The path to the executable for the node admin tool. All interactions with NMIS are controlled via the node admin tool. | |||
| open_audit_lookup_path | A string representing either a fully-qualified path, or a path relative to the integration's execution. | The path to the lookup file for the integration. The lookup file stores mappings between Open-AudIT devices and NMIS nodes. It is recommended to give this file a .nmis extension, as it is written in the .nmis format. | |||
| . | |||||
| open_audit_query_ids | An array of integers. | The ID/s of the Open-AudIT queries to be used for this integration. See the section about Open-AudIT queries for more. | |||
| open_audit_details.host | A string representing a URL. | The Open-AudIT server you wish to target for the integration. This should include the protocol, but should NOT include any path. | |||
| open_audit_details.user | A string. | The username of the Open-AudIT user the integration will run under. You should ensure the chosen user has access to all the devices you wish to integration with NMIS. | |||
| open_audit_details.password | A string. | The password of the Open-AudIT user. | |||
| open_audit_details.log_path | A string representing either a fully-qualified path, or a path relative to the integration's execution. | The path to the Open-AudIT log. This log will contain records of all the requests that are made to the Open-AudIT server (excluding authentication requests). |
Usage
To run the integration, simply invoke the executable and pass it a configuration file as described in the previous section. You can also invoke the tool by itself, which will look for a configuration file at conf/nmisIntegration.nmis by default.
...