NEnetxms
Objects

Update node agent communication configuration

Changed on

Update the node's NetXMS agent communication settings: TCP port, proxy node, shared secret, the force-encryption and agent-over-tunnel-only flags, the agent DCI cache mode and the protocol compression mode. Merge-patch semantics: any subset of fields can be sent; omitted fields are left unchanged. sharedSecret is write-only and is 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}/agent

Request

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

Path parameters

object-idinteger required

Request body

portinteger

Agent TCP port.

proxyinteger nullable

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

sharedSecretstring nullable

Agent shared secret (write-only).

forceEncryptionboolean

Require encryption for agent communication.

tunnelOnlyboolean

Accept agent connections only through an established agent tunnel.

cacheMode'default' | 'on' | 'off'

Agent-side DCI value caching mode.

compressionMode'default' | 'enabled' | 'disabled'

Agent communication protocol compression mode.

certificateMappingMethod'subject' | 'publicKey' | 'commonName' | 'templateId'

Method used to map the agent's certificate to this node for authentication.

certificateMappingDatastring nullable

Certificate mapping data (interpretation depends on certificateMappingMethod). For publicKey method, accepts SHA-256 fingerprint of DER encoded SubjectPublicKeyInfo, hex encoded DER public key, or PEM encoded public key or certificate; always stored and returned as fingerprint (64 hex characters).

Response

Agent 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