IPWorks SNMP 2020 Node.js Edition

Questions / Feedback?

EncryptionAlgorithm Property

The encryption algorithm used for SNMPv3 packets.

Syntax

 snmptcpmgr.getEncryptionAlgorithm([callback])
 snmptcpmgr.setEncryptionAlgorithm( encryptionAlgorithm, [callback])

Possible Values

  1 (encraDES), 
  2 (encraAES), 
  3 (encra3DES), 
  4 (encraAES192), 
  5 (encraAES256)

Default Value

1

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 getEncryptionAlgorithm([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 setEncryptionAlgorithm([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

In order to use encryption, you must set the EncryptionPassword property. The supported algorithms for encryption are:

DES (1)Data Encryption Standard.
AES (2)Advanced Encryption Standard with key length of 128.
3DES (3)Triple Data Encryption Standard.
AES192 (4)Advanced Encryption Standard with key length of 192.
AES256 (5)Advanced Encryption Standard with key length of 256.

This property is not available at design time.

Data Type

Integer

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