This is the documentation for the development version. There are no official binaries for it; build it from the source code in git. Download links on these pages work only after the release. For the current release, see version 7.0.

NETCONF Metrics

For setup and configuration, see NETCONF.

Provided by the netconf subagent on the agent that connects to the target device. These agent metrics are separate from DCIs with origin NETCONF, which use a named query definition and an XPath expression. Both entries below accept the same arguments; the key ID is optional. The health check and capability list can reuse an existing pooled session.

Metrics

NETCONF.CheckConnection(target,login,password[,ssh_key_id])

Returns 1 when a NETCONF session is acquired, including SSH authentication, the netconf subsystem, and the NETCONF hello exchange when opening a new session. Returns 0 for connection, authentication, or handshake failure and for an invalid target address. Invalid argument syntax is reported as unsupported. No retrieval RPC is sent by this check.

Data Type

Integer

Platforms

Windows, UNIX-like systems

Table 1. Arguments
Argument Type Description

target

String

Host name or IPv4 address, optionally with :port; default port is 830

login

String

SSH user name

password

String

SSH password; supply an empty argument when using only a key

ssh_key_id

Unsigned Integer

Optional ID of an SSH key pair stored on the NetXMS server; default 0 (no key). The agent obtains the pair from the connected server.

Lists

NETCONF.Capabilities(target,login,password[,ssh_key_id])

Capability URIs announced by the device in its NETCONF hello message. A connection or target-address failure returns a collection error.

Data Type

List

Platforms

Windows, UNIX-like systems

Table 2. Arguments
Argument Type Description

target

String

Host name or IPv4 address, optionally with :port; default port is 830

login

String

SSH user name

password

String

SSH password; supply an empty argument when using only a key

ssh_key_id

Unsigned Integer

Optional ID of an SSH key pair stored on the NetXMS server; default 0 (no key). The agent obtains the pair from the connected server.