Juniper Netconf icon

Juniper Netconf

Interact with Juniper devices via NETCONF

Overview

This node enables interaction with Juniper network devices using the NETCONF protocol over SSH. It supports a variety of operations to retrieve detailed device information, configuration data, and status reports, as well as to modify interface rate limits.

A common use case is network automation where administrators need to programmatically query interface details or routing protocol statuses from Juniper devices, or apply configuration changes such as setting or removing rate limits on interfaces.

For example, you can use this node to:

  • Retrieve detailed information about a specific physical or logical interface.
  • Check for uncommitted configuration changes on the device.
  • Get summaries or detailed statistics of routing protocols like BGP or OSPF.
  • Apply or remove traffic policers (rate limits) on interfaces with optional automatic commit.

Properties

Name Meaning
Host The hostname or IP address of the Juniper device to connect to.
Port The port number for NETCONF over SSH connection (default is 830).
Interface Name Name of the physical or logical interface (e.g., xe-0/0/0). Leave empty to select all interfaces.
Logical System Logical system name; leave empty for the default system.
Routing Instance Name of the routing instance.
Level Detail level for interface information: Default, Extensive, Media, Statistics.
Level Extra Additional detail options for interface info: Brief, Default, Descriptions, Detail, PRBS Stats, Terse.
Routing Engine Routing engine selection: Backup, Both, Default, Local, Master, Other, RE0, RE1.
SNMP Index SNMP index of the interface.
Include Raw XML Boolean flag to include raw XML response in output for debugging purposes.

These properties are specifically relevant for the Get Interface Information operation.

Output

The node outputs JSON data parsed from the XML response returned by the Juniper device. The structure depends on the selected operation and parameters but generally includes:

  • Parsed device information or configuration data as JSON objects.
  • For "checkUncommittedChanges" operation, it includes flags indicating if there are uncommitted changes and optionally detailed diff information.
  • When enabled, the raw XML response from the device is included under the rawXml field for debugging.

If the operation involves configuration edits (like setting or removing interface rate limits), the output contains the results of the edit and optionally the commit operation status wrapped in a <configuration-result> structure converted to JSON.

The node does not output binary data.

Dependencies

  • Requires an API key credential for authenticating to the Juniper device via NETCONF over SSH.
  • The node uses a bundled NETCONF client library to establish connections and send RPC commands.
  • No additional external services are required beyond access to the Juniper device.

Troubleshooting

  • Missing Credentials Error: If credentials are not provided or invalid, the node will throw an error indicating missing credentials. Ensure that a valid API authentication token or key is configured.
  • Unsupported Operation or Query Type: Selecting an unsupported operation or query type will result in an error specifying the unsupported value. Verify that the chosen operation and its parameters are valid.
  • Connection Timeout or Failure: Network issues or incorrect host/port settings may cause connection failures or timeouts. Confirm connectivity and correct device address and port.
  • Invalid Subtree Path: For subtree filter type in readConfigPath operation, the path must start with "configuration". Otherwise, an error is thrown.
  • XML Parsing Issues: If the device returns unexpected XML, parsing might fail or produce incomplete JSON. Enabling raw XML output can help diagnose such issues.

Links and References


This summary focuses on the "Get Interface Information" operation of the Juniper Netconf node, describing its inputs, outputs, and behavior based on static code analysis.

Discussion