====== SNMP Layer ======

The SNMP layer provides //[[https://datatracker.ietf.org/doc/html/rfc3416|rfc3416: Version 2 of the Protocol Operations for the Simple Network Management Protocol (SNMP)]]//. The SNMP layer can be placed on top of UDP layers.

===== SNMP Layer Functions =====

^                                                    Function^      Type^                                                           Description^
|                            getSnmpAllowBlockingEvent(layer)|    getter|                                  Get "Allow Blocking Event" Parameter|
|                                       getSnmpBlocked(layer)|    getter|                                               Get "Blocked" Parameter|
|                                     getSnmpCommunity(layer)|    getter|                                             Get "Community" Parameter|
|                                 getSnmpCommunityTrap(layer)|    getter|                                         Get "CommunityTrap" Parameter|
|                                getSnmpCommunityWrite(layer)|    getter|                                        Get "CommunityWrite" Parameter|
|                                 getSnmpDebugLogLevel(layer)|    getter|                                       Get "Debug Log Level" Parameter|
|                               getSnmpDestinationPeer(layer)|    getter|                                      Get "Destination Peer" Parameter|
|                                      getSnmpNoEvents(layer)|    getter|                                             Get "No Events" Parameter|
|                                   getSnmpPassthrough(layer)|    getter|                                           Get "Passthrough" Parameter|
|                                    getSnmpSysContact(layer)|    getter|                                            Get "SysContact" Parameter|
|                                getSnmpSysDescription(layer)|    getter|                                        Get "SysDescription" Parameter|
|                                   getSnmpSysLocation(layer)|    getter|                                           Get "SysLocation" Parameter|
|                                       getSnmpSysName(layer)|    getter|                                               Get "SysName" Parameter|
|                                         getSnmpWatch(layer)|    getter|                                                 Get "Watch" Parameter|
|                       getStatsSnmpAvailableInstances(layer)|    getter|                                   Get "Available Instances" Parameter|
|                     getStatsSnmpDownstreamLastPacket(layer)|    getter|                                Get "Downstream Last Packet" Parameter|
|                    getStatsSnmpDownstreamPacketCount(layer)|    getter|                               Get "Downstream Packet Count" Parameter|
|                       getStatsSnmpMaxDownstreamDelay(layer)|    getter|                                  Get "Max Downstream Delay" Parameter|
|                         getStatsSnmpMaxUpstreamDelay(layer)|    getter|                                    Get "Max Upstream Delay" Parameter|
|                      getStatsSnmpMeanDownstreamDelay(layer)|    getter|                                 Get "Mean Downstream Delay" Parameter|
|                        getStatsSnmpMeanUpstreamDelay(layer)|    getter|                                   Get "Mean Upstream Delay" Parameter|
|                       getStatsSnmpMinDownstreamDelay(layer)|    getter|                                  Get "Min Downstream Delay" Parameter|
|                         getStatsSnmpMinUpstreamDelay(layer)|    getter|                                    Get "Min Upstream Delay" Parameter|
|                                     getStatsSnmpName(layer)|    getter|                                                  Get "Name" Parameter|
|                        getStatsSnmpRateBpsDownstream(layer)|    getter|                                   Get "Rate Bps Downstream" Parameter|
|                          getStatsSnmpRateBpsUpstream(layer)|    getter|                                     Get "Rate Bps Upstream" Parameter|
|                              getStatsSnmpTimestampIn(layer)|    getter|                                          Get "Timestamp In" Parameter|
|                             getStatsSnmpTimestampOut(layer)|    getter|                                         Get "Timestamp Out" Parameter|
|                                     getStatsSnmpType(layer)|    getter|                                                  Get "Type" Parameter|
|                       getStatsSnmpUpstreamLastPacket(layer)|    getter|                                  Get "Upstream Last Packet" Parameter|
|                      getStatsSnmpUpstreamPacketCount(layer)|    getter|                                 Get "Upstream Packet Count" Parameter|
|                  getStatsSnmpVarianceDownstreamDelay(layer)|    getter|                             Get "Variance Downstream Delay" Parameter|
|                    getStatsSnmpVarianceUpstreamDelay(layer)|    getter|                               Get "Variance Upstream Delay" Parameter|
|                      setSnmpAllowBlockingEvent(layer,value)|    setter|                                  Set "Allow Blocking Event" Parameter|
|                                 setSnmpBlocked(layer,value)|    setter|                                               Set "Blocked" Parameter|
|                               setSnmpCommunity(layer,value)|    setter|                                             Set "Community" Parameter|
|                           setSnmpCommunityTrap(layer,value)|    setter|                                         Set "CommunityTrap" Parameter|
|                          setSnmpCommunityWrite(layer,value)|    setter|                                        Set "CommunityWrite" Parameter|
|                           setSnmpDebugLogLevel(layer,value)|    setter|                                       Set "Debug Log Level" Parameter|
|                                setSnmpNoEvents(layer,value)|    setter|                                             Set "No Events" Parameter|
|                             setSnmpPassthrough(layer,value)|    setter|                                           Set "Passthrough" Parameter|
|                              setSnmpSysContact(layer,value)|    setter|                                            Set "SysContact" Parameter|
|                          setSnmpSysDescription(layer,value)|    setter|                                        Set "SysDescription" Parameter|
|                             setSnmpSysLocation(layer,value)|    setter|                                           Set "SysLocation" Parameter|
|                                 setSnmpSysName(layer,value)|    setter|                                               Set "SysName" Parameter|
|                                   setSnmpWatch(layer,value)|    setter|                                                 Set "Watch" Parameter|
|                                  snmpSendGenericTrap(layer)|  function|                                                     Send Generic Trap|

===== SNMP Layer Real-Time Parameters =====

^                          Parameter^      Type^                                                           Description^
|               Allow Blocking Event|   Boolean|                                                       Blocking Events|
|                            Blocked|   Boolean|                                                     Disable Component|
|                    Debug Log Level|    Number|                                                           Debug Level|
|                        Passthrough|   Boolean|                                         High-to-Low Layer Passthrough|
|                              Watch|   Boolean|                                                           Watch Layer|

===== SNMP Layer Functions =====

^                                                    Function^      Type^                                                           Description^
|                            getSnmpAllowBlockingEvent(layer)|    getter|                                  Get "Allow Blocking Event" Parameter|
|                                       getSnmpBlocked(layer)|    getter|                                               Get "Blocked" Parameter|
|                                     getSnmpCommunity(layer)|    getter|                                             Get "Community" Parameter|
|                                 getSnmpCommunityTrap(layer)|    getter|                                         Get "CommunityTrap" Parameter|
|                                getSnmpCommunityWrite(layer)|    getter|                                        Get "CommunityWrite" Parameter|
|                                 getSnmpDebugLogLevel(layer)|    getter|                                       Get "Debug Log Level" Parameter|
|                               getSnmpDestinationPeer(layer)|    getter|                                      Get "Destination Peer" Parameter|
|                                      getSnmpNoEvents(layer)|    getter|                                             Get "No Events" Parameter|
|                                   getSnmpPassthrough(layer)|    getter|                                           Get "Passthrough" Parameter|
|                                    getSnmpSysContact(layer)|    getter|                                            Get "SysContact" Parameter|
|                                getSnmpSysDescription(layer)|    getter|                                        Get "SysDescription" Parameter|
|                                   getSnmpSysLocation(layer)|    getter|                                           Get "SysLocation" Parameter|
|                                       getSnmpSysName(layer)|    getter|                                               Get "SysName" Parameter|
|                                         getSnmpWatch(layer)|    getter|                                                 Get "Watch" Parameter|
|                       getStatsSnmpAvailableInstances(layer)|    getter|                                   Get "Available Instances" Parameter|
|                     getStatsSnmpDownstreamLastPacket(layer)|    getter|                                Get "Downstream Last Packet" Parameter|
|                    getStatsSnmpDownstreamPacketCount(layer)|    getter|                               Get "Downstream Packet Count" Parameter|
|                       getStatsSnmpMaxDownstreamDelay(layer)|    getter|                                  Get "Max Downstream Delay" Parameter|
|                         getStatsSnmpMaxUpstreamDelay(layer)|    getter|                                    Get "Max Upstream Delay" Parameter|
|                      getStatsSnmpMeanDownstreamDelay(layer)|    getter|                                 Get "Mean Downstream Delay" Parameter|
|                        getStatsSnmpMeanUpstreamDelay(layer)|    getter|                                   Get "Mean Upstream Delay" Parameter|
|                       getStatsSnmpMinDownstreamDelay(layer)|    getter|                                  Get "Min Downstream Delay" Parameter|
|                         getStatsSnmpMinUpstreamDelay(layer)|    getter|                                    Get "Min Upstream Delay" Parameter|
|                                     getStatsSnmpName(layer)|    getter|                                                  Get "Name" Parameter|
|                        getStatsSnmpRateBpsDownstream(layer)|    getter|                                   Get "Rate Bps Downstream" Parameter|
|                          getStatsSnmpRateBpsUpstream(layer)|    getter|                                     Get "Rate Bps Upstream" Parameter|
|                              getStatsSnmpTimestampIn(layer)|    getter|                                          Get "Timestamp In" Parameter|
|                             getStatsSnmpTimestampOut(layer)|    getter|                                         Get "Timestamp Out" Parameter|
|                                     getStatsSnmpType(layer)|    getter|                                                  Get "Type" Parameter|
|                       getStatsSnmpUpstreamLastPacket(layer)|    getter|                                  Get "Upstream Last Packet" Parameter|
|                      getStatsSnmpUpstreamPacketCount(layer)|    getter|                                 Get "Upstream Packet Count" Parameter|
|                  getStatsSnmpVarianceDownstreamDelay(layer)|    getter|                             Get "Variance Downstream Delay" Parameter|
|                    getStatsSnmpVarianceUpstreamDelay(layer)|    getter|                               Get "Variance Upstream Delay" Parameter|
|                      setSnmpAllowBlockingEvent(layer,value)|    setter|                                  Set "Allow Blocking Event" Parameter|
|                                 setSnmpBlocked(layer,value)|    setter|                                               Set "Blocked" Parameter|
|                               setSnmpCommunity(layer,value)|    setter|                                             Set "Community" Parameter|
|                           setSnmpCommunityTrap(layer,value)|    setter|                                         Set "CommunityTrap" Parameter|
|                          setSnmpCommunityWrite(layer,value)|    setter|                                        Set "CommunityWrite" Parameter|
|                           setSnmpDebugLogLevel(layer,value)|    setter|                                       Set "Debug Log Level" Parameter|
|                                setSnmpNoEvents(layer,value)|    setter|                                             Set "No Events" Parameter|
|                             setSnmpPassthrough(layer,value)|    setter|                                           Set "Passthrough" Parameter|
|                              setSnmpSysContact(layer,value)|    setter|                                            Set "SysContact" Parameter|
|                          setSnmpSysDescription(layer,value)|    setter|                                        Set "SysDescription" Parameter|
|                             setSnmpSysLocation(layer,value)|    setter|                                           Set "SysLocation" Parameter|
|                                 setSnmpSysName(layer,value)|    setter|                                               Set "SysName" Parameter|
|                                   setSnmpWatch(layer,value)|    setter|                                                 Set "Watch" Parameter|
|                                  snmpSendGenericTrap(layer)|  function|                                                     Send Generic Trap|