SNMP Client Read Map Edit

From Control Solutions IoTServer Documentation
Jump to navigation Jump to search

SNMP Client Read Maps are where you configure the device to query other SNMP devices for data, and store that data in local data objects. This page is where you enter the various parameters to make that happen.

Snmp read map edit 1.jpg

Map Number – Used as a reference in the map list for ordering the maps. Polling is done in round robin fashion in the order of map number.

Snmp read map edit 2.jpg

OID – A dot field character string specifying the OID to be read from the remote SNMP device using a Get request. The string must have only digits and periods and no embedded spaces.

Device – Identifies which device from the device list this map applies to, i.e., determines which IP address to try to establish a connection with.

Snmp read map edit 3.jpg

Hint – Provides direction on how to interpret data in the event the value type is Octet String. All ASN data types are interpreted according to their type; however, Octet String will default to being interpreted as a character string unless this hint says otherwise. The exceptions are hint=”1” to interpret 4-octet Octet Strings as 32-bit floating point per RFC 6340, and hint=”2” to interpret 8-octet Octet Strings as 64-bit floating point per RFC 6340. If the hint is non-zero but the Octet String length is not 4 or 8, then it will still be treated as a character string.

Snmp read map edit 4.jpg

Scale – Provides a scale factor if non-zero (has the effect of being 1 if zero). Data received from a remote SNMP device is multiplied by this factor (if non-zero) before being placed in the local object. Applies to numeric values and numeric local objects only.

Offset – Provides an offset to work in conjunction with scale factor. This value will be added to the data value received from a remote SNMP device before being placed in the local object. Applies to numeric values and numeric local objects only.

Snmp read map edit 5.jpg

Poll – Real poll time in seconds, can be fractional. The sets the rate at which the remote SNMP device will be polled. This poll time is not guaranteed to be met. Polling is done in round-robin fashion. In a very busy system, more than this time may expire before the next poll. If less than this time has expired, then the system will wait this amount of time until polling again.

Snmp read map edit 6.jpg

Local Object – Specifies which local object the result of this read operation should be placed in.

Snmp read map edit 7.jpg

Default Value – Provides the default value that the local object should be set to in the event the maxfail/failCount is exceeded.

Max Fail Count – Optional, provides a count of read failures, if non-zero, that can occur before the local object will be set to the default value given in this map. If zero, the default value will never be applied. If 1, then the default value will be applied upon the first failure (probably not recommended), and so on. The count is reset by a successful read.

Snmp read map edit 8.jpg

Index Object – Optional, allows for selectively enabling this read operation. If an index object (local object number) is given, and its value matches the indexValue, then this read operation will take place. If an indexObject is given but the local object’s value does not match the indexValue, then this read operation will be skipped.

Index Value – Optional, used in conjunction with Index Object (see note above).