Help us improve your experience.

Let us know what you think.

Do you have time for a two-minute survey?


Download and Install the NETCONF Java Toolkit

SUMMARY Download and install NETCONF Java Toolkit Release 1.0.1 or earlier.

A configuration management server is a PC or workstation that is used to configure a router, switch, or security device remotely. To use the NETCONF Java toolkit, download and install the toolkit on the configuration management server. The toolkit contains the Netconf.jar library, which is compatible with Java Version 1.4 and later.


The instructions in this section apply to NETCONF Java Toolkit Release 1.0.1 and earlier. To install later releases, see the file in the netconf-java GitHub repository.

Downloading the NETCONF Java Toolkit

To download the NETCONF Java toolkit to the configuration management server:

  1. Access the GitHub download page at .
  2. Download the Netconf.jar file.

Installing the NETCONF Java Toolkit

To install the NETCONF Java toolkit on the configuration management server:

  1. Include the Netconf.jar file in the CLASSPATH of your local Java development environment.
  2. Ensure SSHv2/NETCONF connectivity to the device on which the NETCONF server is running.

Satisfying Requirements for SSHv2 Connections

The NETCONF server communicates with client applications within the context of a NETCONF session. The server and client explicitly establish a connection and session before exchanging data, and close the session and connection when they are finished.

The NETCONF Java toolkit accesses the NETCONF server using the SSH protocol and uses the standard SSH authentication mechanism. To establish an SSHv2 connection with a device running Junos OS, you must ensure that the following requirements are met:

  • The client application has a user account and can log in to each device where a NETCONF session will be established.

  • The login account used by the client application has an SSH public/private key pair or a text-based password.

  • The client application can access the public/private keys or text-based password.

  • The NETCONF service over SSH is enabled on each device where a NETCONF session will be established.

For information about enabling NETCONF on a device running Junos OS and satisfying the requirements for establishing an SSH session, see the NETCONF XML Management Protocol Developer Guide.

For information about NETCONF over SSH, see RFC 4742, Using the NETCONF Configuration Protocol over Secure SHell (SSH), which is available at .