NEnetxms
Objects

Update node SNMP communication configuration

Changed on

Update the node's SNMP communication settings: protocol version, UDP port, proxy node, codepage, the "prevent automatic SNMP configuration changes" lock, the polling credentials, and (optionally) separate SNMP trap reception credentials. Merge-patch semantics: any subset of fields can be sent; omitted fields are left unchanged.

authName holds the community string for SNMP v1/v2c and the USM user name for SNMP v3. When version is present it is applied first (so authName is stored in the correct slot) and is clamped up to the server-wide minimum SNMP version. The v3 authMethod, privMethod, authPassword and privPassword fields are only meaningful for SNMP v3.

The trap object configures separate credentials for received SNMP traps and is itself merge-patched (creating the trap credentials if they did not exist yet); sending trap: null reverts to using the polling credentials. authPassword and privPassword are write-only and are never returned by GET unless sensitive data is explicitly requested.

This property group applies to Node objects only; sending it to any other object class returns 400.

patch/v1/objects/{object-id}/snmp

Request

  • Base URL
    http://127.0.0.1:8000
  • URL
    http://127.0.0.1:8000/v1/objects/{object-id}/snmp
  • Auth
    HTTP bearer

Path parameters

object-idinteger required

Request body

version'1' | '2c' | '3' | 'default'

SNMP protocol version used for polling. Clamped up to the server minimum SNMP version.

portinteger

SNMP UDP port.

proxyinteger nullable

ID of the node used as SNMP proxy, or 0 for no proxy.

codepagestring nullable

Codepage used to decode SNMP string values (empty for server default).

settingsLockedboolean

Prevent automatic SNMP configuration changes by configuration polls.

authNamestring nullable

Community string for SNMP v1/v2c, or USM user name for SNMP v3.

authMethod'NONE' | 'MD5' | 'SHA1' | 'SHA224' | 'SHA256' | 'SHA384' | 'SHA512'

SNMP v3 authentication method.

authPasswordstring nullable

SNMP v3 authentication password (write-only).

privMethod'NONE' | 'DES' | 'AES-128' | 'AES-192' | 'AES-256'

SNMP v3 privacy (encryption) method.

privPasswordstring nullable

SNMP v3 privacy password (write-only).

contextNamestring nullable

SNMP v3 context name.

Response

SNMP configuration updated; full updated object returned.

aliasstring

Object alias

categoryinteger

Object category ID

class'AccessPoint' | 'AgentPolicyLogParser' | 'Asset' | 'AssetGroup' | 'AssetRoot' | 'BusinessService' | 'BusinessServiceProto' | 'BusinessServiceRoot' | 'Chassis' | 'Cluster' | 'Condition' | 'Container' | 'CoolingZone' | 'Dashboard' | 'DashboardGroup' | 'DashboardRoot' | 'Facility' | 'Generic' | 'Interface' | 'MobileDevice' | 'Network' | 'NetworkMap' | 'NetworkMapGroup' | 'NetworkMapRoot' | 'NetworkService' | 'Node' | 'NodeLink' | 'PowerDomain' | 'Rack' | 'Report' | 'ReportGroup' | 'ReportRoot' | 'Room' | 'Sensor' | 'ServiceCheck' | 'ServiceRoot' | 'Subnet' | 'Template' | 'TemplateGroup' | 'TemplateRoot' | 'VPNConnector' | 'Zone'
guidstring uuid

Object GUID

idinteger

Object ID

namestring

Object name

timestampstring date-time

Object last change timestamp

timeZonestring nullable

Effective IANA time zone name (own or inherited from a parent object), null if not set.

timeZoneRulestring nullable

POSIX TZ rule of the effective time zone, null if not set.

timeZoneSourceinteger

ID of the parent object the time zone is inherited from, or 0 when the time zone is defined on this object or not set.

status0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8

Changes

  • 53fbfac7f424Revision changes
    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

  • 2827204d68d9Revision changes
    • warning

      added the new Room enum value to the response property for the response status