NEnetxms
SNMP MIB

Get MIB node by OID

Changed on

Retrieve the MIB node identified by the given OID, including its immediate children. The OID is a dotted numeric path with no leading dot (for example 1.3.6.1.2.1.1.1).

get/v1/snmp-mib/{oid}

Request

  • Base URL
    http://127.0.0.1:8000
  • URL
    http://127.0.0.1:8000/v1/snmp-mib/{oid}
  • Auth
    HTTP bearer

Path parameters

oidstring required

Dotted numeric OID without a leading dot (e.g. 1.3.6.1.2.1.1.1).

Response

MIB node retrieved successfully

oidstring

Full dotted OID for this node. Empty string for the synthetic root.

namestring nullable

Symbolic name of the node (e.g. sysDescr). Null if the node has no name (synthetic root).

type'OTHER' | 'IMPORT_ITEM' | 'OBJID' | 'BITSTRING' | 'INTEGER' | 'INTEGER32' | 'INTEGER64' | 'UNSIGNED32' | 'COUNTER' | 'COUNTER32' | 'COUNTER64' | 'GAUGE' | 'GAUGE32' | 'TIMETICKS' | 'OCTETSTR' | 'OPAQUE' | 'IPADDR' | 'PHYSADDR' | 'NETADDR' | 'NAMED_TYPE' | 'SEQID' | 'SEQUENCE' | 'CHOICE' | 'TEXTUAL_CONVENTION' | 'MACRO_DEFINITION' | 'MODCOMP' | 'TRAPTYPE' | 'NOTIFTYPE' | 'MODID' | 'NSAPADDRESS' | 'AGENTCAP' | 'UINTEGER' | 'NULL' | 'OBJGROUP' | 'NOTIFGROUP' nullable

Symbolic name of the MIB type (e.g. COUNTER32). Null if the type code is unknown.

typeCodeinteger

Numeric MIB type code as defined in nxsnmp.h (MIB_TYPE_*).

status'MANDATORY' | 'OPTIONAL' | 'OBSOLETE' | 'DEPRECATED' | 'CURRENT' nullable

Symbolic name of the MIB status. Null if the status code is unknown.

statusCodeinteger

Numeric MIB status code as defined in nxsnmp.h (MIB_STATUS_*).

access'READONLY' | 'READWRITE' | 'WRITEONLY' | 'NOACCESS' | 'NOTIFY' | 'CREATE' nullable

Symbolic name of the MIB access mode. Null if the access code is unknown.

accessCodeinteger

Numeric MIB access code as defined in nxsnmp.h (MIB_ACCESS_*).

descriptionstring nullable

DESCRIPTION clause from the MIB module.

textualConventionstring nullable

Name of the textual convention applied to this object, if any.

displayHintstring nullable

DISPLAY-HINT clause for formatting raw values.

enumValuesstring nullable

Comma-separated list of named enumeration values, if defined.

indexstring nullable

INDEX clause for SMIv2 table entries.

parentstring nullable

Full dotted OID of the parent node. Null for the synthetic root.

Changes