SNMP Tab - Metasys - LIT-12011964 - Software Application - System Configuration Tool - 16.0

SCT: System Configuration Tool Help

Brand
Metasys
Product name
System Configuration Tool
Document type
User Guide
Document number
LIT-12011964
Version
16.0
Revision date
2023-10-02
Language
English

The SNMP tab appears on Engine or Server objects. The SNMP DDA Attributes appear on the Shared Configuration section of the SNMP Tab. The SNMP DDA Destination Configuration Attributes appear when you edit a specific SNMP destination on the SNMP tab.

Note: At Metasys Release 10.1 and later, the edit button is disabled for an ADS, ADX, or OAS. For these devices, use the Metasys UI to modify the attributes on this tab.
Table 1. SNMP DDA Shared Configuration Attributes

Attribute Name

Description

SNMP Enabled

Specifies whether the SNMP feature is enabled. Once this attribute is enabled, the ability to send and receive messages (Traps and Gets) can be enabled or disabled on an individual basis using the other SNMP DDA attributes.

SNMP Trap Version

Specifies the version used to send SNMP traps. The versions are v1, v2c, and v3.

SNMP Management Device

Specifies an IP address or Host Name on which to filter Get requests. SNMP only responds to requests from the device listed in this attribute. If this attribute is 0.0.0.0, SNMP responds to all requests.

SNMP Request Port

Specifies the port on the destination device that requests information from the Engine or Server. The direction of communication is from the destination device to the Engine or Server. Currently, this function is supported only on hardware and software-based network engines. For hardware network engines that run with a Windows operating system, changing the value of this attribute requires a restart for the change to take effect, but for engines running the Linux operating system, a restart is not required. Setting this attribute to 0 disables the Get feature of SNMP.

Contact Person

Specifies the IT person who is responsible for managing SNMP communications.

Public Community Name

A case-sensitive string used to authenticate v1 and v2c Get and Get Next messages. This attribute contains the community string used by the Network Management System to edit data in objects maintained by managed devices.

SNMP Trap Message Format

Defines the message format used for generating SNMP Traps, including the startup Trap. The options are:
  • String Based (default) - SNMP Traps are sent as a string of characters
  • MIB Based - SNMP Traps are sent using the OIDs defined in the Johnson Controls MIB (called, JCI MIB).
Table 2. SNMP DDA Destination Configuration Attributes

Attribute Name

Description

Label

The name of this destination when it appears in the Destinations list.

Trap Community Name

A case-sensitive string used to authenticate v1 and v2c SNMP Traps. This attribute contains the community string used by the Network Management System to edit data in objects maintained by managed devices.

JCI IP Address

Specifies the IP address or host name of the system that receives the traps.

Destination Port Number

Specifies the port on the destination device that receives messages from the Engine or Server. The direction of communication is from the Engine or Server to the destination device. Setting this attribute to 0 disables the Get feature of SNMP.

Enabled

Specifies whether this SNMP destination is enabled or disabled.

Filters

Specifies the rules to filter alarms. This attribute uses Alarm Value (Set 108). See Filters for more information.

Format

Allows you to select which attributes of an event are in the SNMP Trap.

The following fields are optional:
  • Acknowledge Required (not an option for pager)
  • Authorization Category
  • Item Description
  • Item Fully Qualified Reference
  • Message
  • Previous Status
  • Priority
  • Site Name
  • Value

See the Event Message Routing, Filtering, and Destinations section of Metasys SMP Help (LIT-1201793) or Facility Explorer Site Management Portal Help (LIT-12013520) for more information on this DDA.

For detailed information on SNMP, refer to the SNMP Agent Protocol Implementation appendix located in the Network and IT Guidance Technical Bulletin (LIT-12011279).