IPWorks SNMP 2020 Node.js Edition

Questions / Feedback?

NodeSyntax Property

The syntax of the selected node.

Syntax

 mibbrowser.getNodeSyntax([callback])

Possible Values

  1 (stxBoolean), 
  2 (stxInteger), 
  3 (stxBitString), 
  4 (stxOctetString), 
  5 (stxNull), 
  6 (stxObjectId), 
  10 (stxEnumerated), 
  15 (stxSequenceOf), 
  16 (stxSequence), 
  17 (stxSet), 
  18 (stxChoice), 
  21 (stxNetworkAddress), 
  64 (stxIpAddress), 
  65 (stxCounter), 
  66 (stxGauge), 
  67 (stxTimeTicks), 
  68 (stxOpaque), 
  69 (stxNSAP), 
  70 (stxCounter64), 
  71 (stxUInteger), 
  59 (stxUnknown)

Default Value

6

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 getNodeSyntax([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 setNodeSyntax([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 syntax defines what type of data the selected node contains. Common data types include:

Boolean (1) Boolean variable.
Integer (2) A 32-bit signed integer.
OctetString (4) An octet string variable that is binary or textual data.
Null (5) NULL value.
ObjectId (6) Object identifier.
IpAddress (64) A 32-bit Internet address (aaa.bbb.ccc.ddd)
Counter (65) A counter that increases until it reaches a maximum value of (2^32).
Gauge (66) A non-negative int that can increase or decrease, but never exceed a maximum value.
TimeTicks (67) A counter that measures time in hundredths of a second.
Opaque (68) This type supports the capability to pass ASN.1 syntax.
Counter64 (70) A counter that increases until it reaches a maximum value of (2^64).
UInteger (71) A 32-bit unsigned integer.

Additional type definitions can be found in the SNMP RFC's.

This property is read-only.

Data Type

Integer

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