SNMP in X/2 and X/20

New
  • Published on Sep 4, 2025
  • 3 minute(s) read
  • Bryan Jones
 Prev Next

Scope

Z/IPStream X/2 and X/20 use SNMP (Simple Network Management Protocol) for configuration, to generate statistics about stream usage, and other administrative duties.

Configuration

Z/IPStream X/2 and X/20SNMP extension agent requires the Windows SNMP feature to be installed.

Due to the wide range of Windows versions and editions, it is not possible to provide a single, universal set of instructions. Configuration steps will vary depending on the specific version in use, and certain editions (e.g., Windows Home) may not support SNMP at all. For further assistance, please consult your IT department, your computer manufacturer’s documentation, or Microsoft’s official support resources.

Configure the Windows SNMP feature

Again, note differnces in Windows as noted above

  1. Open the Windows Services control panel by navigating to Start, Control Panel, Administrative Tools, and with administrative privileges, open the Services item

  2. Locate the "SNMP Service" item, right-click, and select Properties

  3. Enter Contact and Location information in the Agent tab and select the SNMP Service type.

  4. Configure the access information in the Security tab. Use the community "public" and READ_ONLY rights to set up public access.

  5. If needed, set up an IP address that will receive the generated traps in the Traps tab.

  6. Press Apply.

You may need to restart the SNMP Service for the changes to take effect.

Extension Agent Configuration

Again, note differnces in Windows as noted above

The/Z/IPStream X/2 and X/20 SNMP extension agents need to be installed into the Windows SNMP service. This can be done with the snmpdmgr.exe application that can be found in the Z/IPStream installation folder.

Please make sure to run this application from a command prompt with administrative rights.

Run the snmpdmgr.exe application without any parameters, and it will display the usage information.

  1. Use “snmpdmgr.exe register” to install the extension agent.

If successful, it will display the message “Z/IPStream Extension Agent: library registered”.

  1. After the extension agent has been installed or removed, the Windows SNMP service needs to be restarted. Please open the Services manager, and locate the “SNMP Service”.

  2. Use the restart command to reload the extension agents.

Reports

The Z/IPStream SNMP extension agent implementation uses the Enterprises group with sub-id 42463 for Telos Systems and sub-id 333 for Z/IPStream X/2. You can find the full description in the MIB file TLSCORP-Z/IPSTREAM-X20-MIB.txt located in the folder where the application was installed.

SNMP extension agent reports variables:

  • snmp-internal-link-up reports if the SNMP extension agent is connected to the Z/IPStream process.

  • product-name reports product name string (i.e. "Z/IPStream X/20").

  • product-version reports product version string (i.e. "1.08").

  • streams-count reports the number of active streams.

  • streams-errors reports the number of active streams that aren't streaming due to an error. If all streams are online, this variable should report 0.

  • audio-sources-count reports the number of active audio sources.

  • audio-sources-errors reports the number of active audio sources that aren’t working due to an error. If all audio sources are working correctly, this variable should report 0.

  • audio-sources-silence reports the number of active audio sources that have audio silence.

SNMP extension agent generates traps:

  • trap-software-link-up when the SNMP extension agent has successfully connected to the Z/IPStream X/2 process.

  • trap-software-link-down when the SNMP extension agent has lost connection to the Z/IPStream X/2 process.

  • streams-ok when the streams-errors variable has changed to 0.

  • streams-failed when the streams-errors variable has changed to number other than 0.

  • audio-sources-ok when the audio-sources-errors variable has changed to 0.

  • audio-sources-failed when the audio-sources-errors variable has changed to number other than 0.

  • silence-detect-passed when audio-sources-silence variable has changed to 0.

  • silence-detect-failed when audio-sources-silence variable has changed to number other than 0.

Usage

To query the SNMP server, you need to install SNMP client tools. The examples are given using the Net-SNMP tools which are available for download from http://net-snmp.sourceforge.net/. Before using the snmpwalk you must copy the TLSCORP-Z/IPSTREAM-X2-MIB.txt to the MIBs folder e.g. C:\usr\share\snmp\mibs\.

Query all Z/IPStream X/2 SNMP variables:

snmpwalk -v1 -cpublic 192.168.0.90 TLSCORP-Z/IPSTREAM-X2-MIB::tlsCorp.Z/IPStreamX2

TLSCORP-Z/IPSTREAM-X2-MIB::snmp-internal-link-up = INTEGER: linked(0)

TLSCORP-Z/IPSTREAM-X2-MIB::product-name = STRING: "Z/IPStream X/2"

TLSCORP-Z/IPSTREAM-X2-MIB::product-version = STRING: "1.05"

TLSCORP-Z/IPSTREAM-X2-MIB::streams-count = INTEGER: 1

TLSCORP-Z/IPSTREAM-X2-MIB::streams-errors = INTEGER: no-errors(0)

TLSCORP-Z/IPSTREAM-X2-MIB::audio-sources-count = INTEGER: 1

TLSCORP-Z/IPSTREAM-X2-MIB::audio-sources-errors = INTEGER: no-errors(0)

TLSCORP-Z/IPSTREAM-X2-MIB::audio-sources-silence = INTEGER: no-errors(0)

End of MIB

Listen to SNMP-generated traps (the listener IP address must be added to the Windows SNMP service traps receiver configuration):

snmptrapd -f –Lo

Related articles