IPWorks SNMP 2020 Node.js Edition

Questions / Feedback?

Active Property

Enables or disables sending and receiving of SNMP packets.

Syntax

 snmptrapmgr.getActive([callback])
 snmptrapmgr.setActive( active, [callback])

Default Value

FALSE

Callback

The 'callback' parameter specifies a function which will be called when the operation completes (or an error is encountered). If the 'callback' parameter is not specified, then the method will block and will not return until the operation completes (or an error is encountered).

The callback for the getActive([callback]) method is defined as:

function(err, data){ }

'err' is the error that occurred. If there was no error, then 'err' is 'null'.

'data' is the value returned by the method.

The callback for the setActive([callback]) method is defined as:

function(err){ }

'err' is the error that occurred. If there was no error, then 'err' is 'null'.

'err' has 2 properties which hold detailed information:

err.code
err.message

Remarks

The Active property must be set to True before any SNMP requests or traps are sent or received.

Note: The class will automatically set this property to True if it is not already and you attempt to send a request or trap.

This property is not available at design time.

Data Type

Boolean

Copyright (c) 2022 /n software inc. - All rights reserved.
IPWorks SNMP 2020 Node.js Edition - Version 20.0 [Build 8202]