SNMP Trap Receiver Config File

From Control Solutions IoTServer Documentation
Revision as of 19:18, 22 April 2019 by Jimhogenson (talk | contribs)
Jump to navigation Jump to search

Snmp trap receiver config file 1.jpg

All of your configuration information is stored in an internal database each time you click the Save button on any page where configuration entries may be made. To make configuration portable from one device to another, and for purposes of retaining a backup copy, the configuration information may be exported and imported as XML or CSV files. This page is where your configuration file management takes place.

It is important to note that the XML file saved within any one client/server function will contain the configuration information for only that function. Depending on overall system configuration, a complete backup may involve more than one XML or CSV file.

Snmp trap receiver config file 2a.jpg

XML Files: When an XML file has been selected, click the Load button to clear the configuration database and reload configuration from the given XML file.

Select an existing name to overwrite or enter a new file name, and then click Save to write the current configuration to the file in XML format.

You may type in a new name in the file name window for purposes of saving a new file. If you click the Refresh button, the file name will be restored to the name currently loaded into the client. The name could have been changed by selecting a file from the list below, or by typing in a new name. If the displayed name has not yet been used, then Refresh will restore the file name to what was most recently loaded.

Snmp trap receiver config file 2b.jpg

CSV Files: If a CSV file is selected, the Load and Save buttons will change into load/save CSV buttons. When a CSV file has been selected, click the Load button to clear the configuration database and reload configuration from the given CSV file.

Select an existing name to overwrite or enter a new file name, and then click Save to write the current configuration to the file in CSV format.

Snmp trap receiver config file 2c.jpg

Snmptrapd.conf Files: Any time the snmptrapd.conf file is regenerated on the Snmptrapd.conf page, you will need to come here to transfer that generated file into the SNMP engine. Select the generated .conf file from the drop-down list below, and then click the Load button. You can also retrieve a copy of the snmptrapd.conf file actually in use by clicking the Save button. The content of the currently in-use snmptrapd.conf file will be transferred to the file name you have entered.

NOTE: Any time you reload the snmptrapd.conf file here, you also need to click the Restart SNMP button at the bottom of this page.

Snmp trap receiver config file 3.jpg

The drop-down list will show a list of all configuration files currently found in the device's configuration folder. When you select an XML or CSV file from this list, the name will be copied to the Load/Save section of this page for pending load or save.

You may view the selected file by simply clicking View. You can delete the file by clicking Delete.

You may upload files to the IoTServer from your PC. Start by clicking Browse, and then use the browser's file dialog to locate the file on your PC. Once a file is selected on your PC, click the "Start upload" button to initiate the transfer.

You may also download files from the IoTServer to your PC. Click the Download button to transfer the selected file to your PC.

Snmp trap receiver config file 4.jpg

Any time an XML or CSV file is loaded, an error log file is generated. The error log file will be given the same name as the loaded file, but with ".err" as the suffix instead of ".xml" or ".csv". You may view the error log by selecting it from the list and clicking View.

Status is normally displayed in a message box at the top of the screen when the load or save operation is complete. But if you want to double check the status of the previous file operation, click Check Status.

Snmp trap receiver config file 5.jpg

Select Yes to enable logging, or No to disable. When selecting Yes, provide a log name in the /home/customer/logs/ directory. All accesses to the MIB by external managers are logged here. It is recommended that you enable logging only temporarily for diagnostic purposes to avoid eventually running out of file space. NOTE: The log file enabled here is not the same log file as enabled for the SNMP Agent.

Because the snmptrapd.service does not log SNMPv3 traps to the log file, additional logging has been added to the csiTrapHandler application. If the file csiTrapReceiver_info_log is found in the /home/customer/logs/ directory, the SNMPv3 traps will be logged there instead of snmptrapd.log.

The log files can be viewed on the System -> Logs page.

Snmp trap receiver config file 6.jpg

The SNMP Trap Receiver task needs to be suspended while a file load operation is in progress to prevent acting on any partial configurations. This suspend/resume operation will normally happen automatically as part of the sequence invoked by the Load button. The task can be explicitly suspended here. The Suspend button will become a Resume button when the task is suspended. Click Resume to continue operation. The current status is always displayed here.

The SNMP Trap Receive task suspended via the Suspend button is the API task that provides the interface between the web UI and the internal task management. The SNMP Trap Engine itself is another process. Any time the trap receive rules are altered, it is necessary to restart the SNMP trap receiver (snmptrapd service). Click Restart SNMP to reload Snmptrapd with the new definition of receive rules.