Installing and Using the SNMP Agent Software

Scenario: You want to connect the SNMP Agent to Desigo CC NORIS and configure the data that will read and provided to SNMP third-party network management systems.

 

Workflow:

 

 

Prerequisites:

  • The SNMP Agent extension is installed and included in the active project. The following extension is also selected automatically:
    • Web Services
  • The SNMP website is active.
  • After installation, the SNMP_Agent.msi installer package is available in [Installation Drive]:\[Installation Folder]\GMSMainProject\AddSW\SNMP_Agent.
  • You created the required site views (logical, physical, or user-defined) in Desigo CC. For instructions, see Views.

 

Steps:

1 – Install and Start the SNMP Agent Software
  1. Install the SNMP agent software on one of the networked computer. Typically, it is installed on the Desigo CC server station:
  • Run SNMP_Agent.msi.
  • Follow the wizard instructions to complete the installation.
  1. Start the Desigo CC SNMP Agent configuration utility:
  • In the system tray, right-click and select Start SNMP Configurator.
  • The SNMP Configurator tool displays on the screen.
    The gray indicator in the status bar tells you that the project alignment is still unknown.

 

2 – Connect to SNMP Web Service Interface
  1. Start SMC.
  1. In the SMC tree, select Certificate.
  • The Certificates tab displays.
  1. Click Edit .
  1. Set the SNMP default certificate as follows:
    a. In the Default Certificates expander, click Browse.
    b. In the Select Certificate dialog box, select the required host certificate, and click OK.
    c. Click Save .
  1. In the SMC tree, expand Websites.
  1. Locate and select the SNMP website WSI.
  • The Management tab displays.
  1. In the Web Application Details expander, click Copy URL.
  1. In the Web Service Settings expander of the SNMP Configurator tool, connect to the web service interface as follows:
    a. In the Interface address field, paste the URL previously copied.
    b. Enter user name and password to configure the user credentials for the Desigo CC SNMP service to access the NORIS interface.
    c. Click Browse, select the host certificate, and then click OK.
    d. Click Connect.
    NOTE: At any subsequent connection, you will be required the password only.
  • The Created views done status is displayed bottom left of the utility page.
    The MIB configuration (if any) is retrieved and displayed in the configuration tool, and the fields are now editable.
  • The indicator in the status bar will stay gray if the configurator is empty, or data in the configurator were not yet saved (the SystemLocal.config was not yet created).
    The indicator in the status bar will turn green if project data was previuosly saved and is aligned; otherwise, it will turn red (misalignment on WSI project).

 

3 – Set SNMP Data

In this step you will specify data relevant to the SNMP protocol in the SNMP Data expander.

  1. In the Agent panel, enter the agent Port.
    NOTE: If not set, SNMP agent default port 161 will be used.
  1. In the Managers (Traps/Informs) panel, specify the list of managers that will notify the SNMP agent:
    a. Enter the manager IP.
    b. Enter Port on which all traps will be notified (default port is 162).
    c. Repeat the previous steps and click Add to add all the required managers.
    NOTE: If you do not set the IP manager, the manager of the local station will be considered. If you want to set multiple IP managers, remember to include in the list also the manager of the local station. To remove any unwanted manager, select it in the list and click Remove.
  1. (Optional) To secure SNMP V3 communication when connecting to the SNMP agent, in the SNMP V3 panel, you can optionally specify one or multiple of the following settings:
  • User who is authorized to communicate with the SNMP agent
  • Password for the user's authentication
  • Authentication protocol algorithm for message security (MD5, SHA, or None)

 

4 – Set Event Filters

In this step you will specify for which categories and disciplines the events will be exposed to third-party systems.

  • In the Event Filter Settings expander, do one or more of the following:
  • To include all the event categories, open the Category drop-down list, and then select the Categories check box.
  • To restrict the event categories, expand Categories in the Category drop-down list, and then select the check boxes that correspond to the categories you want to include.
  • To include all the event disciplines, open the Discipline drop-down list, and then select the Disciplines check box.
  • To restrict the event disciplines, expand Disciplines in the Discipline drop-down list and select the check boxes that correspond to the disciplines you want to include.
  • To disable the SNMP Agent capability to receive event traps, select the check box Skip event traps.
  • To disable the SNMP Agent capability to receive COV traps, select the check box Skip COV traps.
5 – Set Selection and Subscription

In this step you will specify for which system objects properties and events will be exposed to third-party systems.

  1. From the system view drop-down list, select the desired view.
  • A progress bar bottom right indicates loading tree nodes in progress. When completed, Desigo CC System Browser data for the selected view are displayed accordingly in the SNMP Configurator.
  1. (Optional) To narrow the list of objects for the current view, enter the appropriate criteria in the search box and click Search.
  1. Specify the way subtree or single nodes will be selected for the subscription in one of the following ways:
  • To select all the nodes for the current view, in the Node panel, select Subtree and click Select All.
    NOTE: Click Clear All to clear all selection mode configuration.
  • To select a subtree in the current view, in the Node panel, select Subtree, then in the tree view, select the check box that corresponds to the parent node of the desired subtree.
  • To select a specific individual node in the current view, in the Node panel, select Single Node, and then in the tree view, expand the tree and select the check box that corresponds to the desired node.
  1. For the specified object selection, in the Property panel, specify the type of subscription for the properties in one of the following ways:
  • To subscribe to all the properties, select All properties.
    This results in all the properties automatically selected in the list to the right of the tree view.
  • To subscribe to the default property, select Default property.
    This results in the corresponding default property automatically selected in the list to the right of the tree view.
  • To exclude all the properties from the subscription, select None.
    NOTE: This setting is disabled if Event = No.
  1. For the specified object selection, from the list of properties to the right of the tree view, select the check boxes that correspond to the object properties for which you want to be notified of any status changes.
    NOTE: To view the node properties, select the desired node. The properties visible to the SNMP Agent are the ones with DL4 set in the object model of the system object selected in the SNMP tree. Properties with DL0, DL1, DL2, DL3, or no display level are not displayed in the SNMP Configurator.
  1. For the specified object selection, in the Event panel, specify the type of subscription for the events in one of the following ways:
  • To subscribe to all the events, select Yes.
    This results in the Enable events notification check box being selected automatically.
  • To exclude all the events from the subscription, select No.
    NOTE: This setting is disabled if Property = None.
  1. To be notified of object events only, excluding status change notifications, deselect the check boxes of the properties to the right of the tree view, and select the Enable events notification check box.
  1. Repeat the previous steps for all the views you want to set.

 

6 – Finish Configuration
  1. Click Save.
  1. When prompted to save all system views, do one of the following:
  • Click Yes to save all views.
  • Click No to save the current view only.
  1. When prompted to restart the SNMP Agent service, do one of the following:
  • Click Yes.
  • Click No.
  • Changes are saved in encrypted files at SNMPAgent\Mib as follows:
    - DesigoCC.MIB (global MIB file)
    - Views MIB files (for example, DesigoCC_9.MIB)
    - Networks MIB files (for example, DesigoCC_Net_3.MIB)
  • If the indicator in the status bar was gray or red (misalignment on WSI project), it will turn green (project alignment).
    The SystemLocal.config file is created at SNMPAgent\Config, and includes the name of the project.