SNMP Client Write Map Edit

From Control Solutions IoTServer Documentation
Revision as of 03:52, 9 April 2019 by Jimhogenson (talk | contribs) (Created page with "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. Device – Identifies which devic...")
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search

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.

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.

Local Object – Specifies the local object number that contains the data that should be sent by this write map.

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

ASN – Specifies how data should be formatted in the Set request. The code given here is a selector, not the actual ASN code. The selection is made from the following table:

ASN select ASN type used Hint assumed Description 1 ASN Integer 0 32-bit signed integer 2 ASN Timeticks 0 32-bit unsigned integer 3 ASN Gauge 0 32-bit unsigned integer 4 ASN Counter 0 32-bit unsigned integer 5 ASN Octet String 0 String of 8-bit bytes 6 ASN Counter64 0 64-bit unsigned integer 7 ASN Opaque Float 0 Net-SNMP floating point 8 ASN Opaque Double 0 Net-SNMP floating point 9 ASN Opaque U64 0 64-bit unsigned integer 10 ASN Opaque I64 0 64-bit signed integer 11 ASN Opaque Counter64 0 64-bit unsigned integer 12 ASN Bit String 0 Bit string per standard ASN 13 ASN Object ID 0 Object ID per standard ASN 14 ASN IP Address 0 IP address per standard ASN 15 ASN Octet String 1 (RFC 6340 Float) RFC 6340 32-bit IEEE 754 16 ASN Octet String 2 (RFC 6340 Double) RFC 6340 64-bit IEEE 754

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

Offset – Provides an offset to work in conjunction with scale factor. This value is added to the value retrieved from the local object (after being multiplied by scale) before being sent to the remote SNMP device. Applies to numeric values and numeric local objects only.

Poll Time - Real poll time in seconds, can be fractional. 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. The sets the rate at which the remote SNMP device will be updated, provided “Send Periodic” has been enabled. This poll time will be disregarded if Send Periodic is not enabled.

Send Periodic – Select On/Off, with On to enable periodic sending of the Set request at the poll rate given by Poll Time.

Max Quiet Time – Real time in seconds, can be fractional. If a Set request has not been made either as a result of poll timing or value changing by delta within this time period, then a Set request will be made anyway. This specifies the maximum amount of time that should expire without any Set request being made for any reason.

Enable Max Quiet Time – Select On/Off, with On to enable the Max Quiet Time feature. If disabled, the Max Quiet Time will be disregarded.

Minimum Quiet Time – Real time in seconds, can be fractional. This specifies the minimum amount of time that should elapse between sending of Set requests for this write map. The minimum quiet time has the effect of throttling network traffic.

Delta – Specifies the margin by which the local object value should change before sending another Set request to send the new value to a remote SNMP device. Once the changed value has been sent, the new local value is retained for future comparison in determining subsequent additional change. The delta value is disregarded if Send Delta is not enabled.

Send Delta – Select On/Off, with On to enable the “send on delta” feature where Set requests are made based on changes in the local object value (see delta above).

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

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