close

keyboard_arrow_left

Table of Contents Expand all

play_arrow Overview
- play_arrow NETCONF XML Management Protocol Overview
  - NETCONF XML Management Protocol and Junos XML API Overview
  - Advantages of Using the NETCONF XML Management Protocol and Junos XML API
- play_arrow NETCONF and Junos XML Tags Overview
play_arrow Manage NETCONF Sessions
- play_arrow NETCONF Session Overview
- play_arrow Manage NETCONF Sessions
- play_arrow NETCONF Tracing Operations
  - NETCONF and Junos XML Protocol Tracing Operations Overview
  - Example: Trace NETCONF and Junos XML Protocol Session Operations
- play_arrow NETCONF Protocol Operations and Attributes
- play_arrow NETCONF Request and Response Tags
- play_arrow Junos XML Protocol Elements Supported in NETCONF Sessions
- play_arrow Junos XML Protocol Element Attributes Supported in NETCONF Sessions
play_arrow Manage Configurations Using NETCONF
play_arrow Request Operational and Configuration Information Using NETCONF
- play_arrow Request Operational Information Using NETCONF
  - Request Operational Information Using NETCONF
  - Specify the Output Format for Operational Information Requests in a NETCONF Session
- play_arrow Request Configuration Information Using NETCONF
play_arrow NETCONF Utilities
- play_arrow NETCONF Perl Client
  - Understanding the NETCONF Perl Client and Sample Scripts
  - Install the NETCONF Perl Client
- play_arrow Develop NETCONF Perl Client Applications
play_arrow YANG
- play_arrow YANG Overview
- play_arrow Create and Use Non-Native YANG Modules
play_arrow OpenDaylight Integration
- play_arrow Configure OpenDaylight Integration
  - Configure Interoperability Between MX Series Routers and OpenDaylight
play_arrow Configuration Statements and Operational Commands
- Junos CLI Reference Overview

list Table of Contents

English

Use Juniper Networks YANG Modules

date_range 16-Sep-24

arrow_backward

arrow_forward

Juniper Networks publishes YANG modules that define the configuration hierarchies, RPCs, state data, and YANG extensions for Junos devices. This topic details how to obtain Juniper Networks YANG modules and how to import them into another module.

Obtain Juniper Networks YANG Data Models

You can retrieve the Juniper Networks YANG data models by:

Downloading the modules from the Juniper Networks website at https://www.juniper.net/support/downloads
Downloading the modules from the Juniper/yang GitHub repository
Generating the modules on a Junos device either through a local or remote session

In Junos OS Release 17.1 and earlier, the YANG modules for the Junos OS configuration and command hierarchies that are posted on the Juniper Networks website define the schema for all devices running that Junos OS release.

Starting in Junos OS Release 17.2, Junos OS YANG modules are specific to a device family. For a given OS and release, the YANG modules download file and GitHub repository include a separate directory for each device family as well as a common directory. Each family-specific directory contains the configuration and operational command modules that are supported on the platforms in that family, and the common directory contains the modules that are common to all device families. For more information about the device families, see Understanding Junos YANG Modules.

When you generate YANG modules on a local device, the modules include both native Junos modules as well as any standard or custom modules that have been added to the device. Starting in Junos OS Release 17.4R1, the native YANG modules generated on a local device contain family-specific schemas, which are identical across all devices in the given device family. In Junos OS Release 17.3 and earlier, the native YANG modules generated on the local device contain device-specific schemas.

Starting in Junos OS Evolved Release 23.4R1, we publish the Junos OS Evolved native YANG modules on the Juniper Networks download site and on GitHub. In earlier releases, you must generate the YANG modules on the device.

Additionally, starting in Junos OS Release 23.4R1 and Junos OS Evolved Release 23.4R1, we provide all YANG data models for a given OS and release in a single download package and GitHub repository folder. The package and repository include:

Native configuration, state, and RPC data models
OpenConfig configuration and state models supported by that OS
IETF models supported by that OS

Download YANG Modules from Juniper Networks

To download the YANG modules from the Juniper Networks site:

Access the downloads page at https://support.juniper.net/support/downloads.
Select your product.
In the drop-down menus, select the appropriate OS and version.
Expand the Tools section to display the available downloads.
In the Downloads column, click the link for the YANG modules package you want to download.
Review and accept the End User License Agreement.
Follow the instructions on the download page to download the file.

Note:

If your particular product page does not have the YANG modules available for download, you can download the modules from the Juniper/yang GitHub repository or generate the modules on the Junos device.

Generate YANG Modules on Junos Devices

To generate the YANG modules from the Junos CLI:

Log in to the Junos device.
(Optional) By default, Junos devices emit YANG modules with family-specific schemas. To generate modules with device-specific schemas instead, configure the device-specific statement.
```
[edit system services netconf]
user@host# set yang-modules device-specific
user@host# commit and-quit
```
Create the directory where the output files will be stored, if it does not already exist.
```
user@host> file make-directory /var/tmp/yang
```
(Optional) To see a list of available YANG modules, invoke the context-sensitive help.
```
user@host> show system schema module ?
```
Execute the show system schema operational mode command and specify which modules to generate and the directory for storing the output files.
```
user@host> show system schema format yang module module-name output-directory file-path
```
For example:
```
user@host> show system schema format yang module all output-directory /var/tmp/yang
```

The device generates the YANG modules in the specified output directory.

Note:

Starting in Junos OS Evolved Release 23.4R2, native YANG modules for QFX Series devices use the junos device family identifier instead of junos-qfx. To emit device-specific schemas that use the junos-qfx family identifier instead, configure the device-specific and emit-family-ns-and-module-name statements at the [edit system services netconf yang-modules] hierarchy level.

Generate YANG Modules from a Remote Session

To generate the YANG modules from a remote session:

Connect to the Junos device. For example:
```
user@server$ ssh user@host.example.net -p 830 -s netconf
```

Execute the <get-yang-schema> RPC, and specify the module or collection name and the output directory.

content_copy zoom_out_map
<rpc>
   <get-yang-schema>
      <format>yang</format>
      <identifier>all-rpc</identifier>
      <output-directory>/var/home/user</output-directory>
   </get-yang-schema>
</rpc>

The device generates the YANG modules in the specified output directory.

Tip:

You can also use the <get-schema> Network Configuration Protocol (NETCONF) operation to retrieve a YANG module from the device. For additional information, see Retrieve Schemas.

Importing Juniper Networks YANG Modules

You can use YANG-based tools to leverage the Juniper Networks YANG modules. If you are developing custom YANG modules, you can reference definitions in the Juniper Networks YANG modules by importing the modules into your custom module.

To import a Juniper Networks YANG module into an existing module:

Include the import statement, specify the module name, and assign the prefix to use with the definitions from the imported module.
```
module acme-system {
   namespace "http://acme.example.com/system";
   prefix "acme";

   import configuration {
      prefix "jc";
   }
   import junos-extension {
      prefix "junos";
   }
…
}
```
Note:
The naming convention for the module names, filenames, namespaces, and prefixes of the native Junos OS YANG modules depends on the Junos OS release.
Reference definitions in the module by using the locally defined prefix, a colon, and the node identifier or keyword.
For example, to reference the interface node defined in the configuration module, use jc:interface.

Change History Table

Feature support is determined by the platform and release you are using. Use Feature Explorer to determine if a feature is supported on your platform.

Release

Description

23.4R2-EVO

Starting in Junos OS Evolved Release 23.4R2, native YANG modules for QFX Series devices use the junos device family identifier instead of junos-qfx.

23.4R1 and 23.4R1-EVO

Starting in Junos OS Release 23.4R1 and Junos OS Evolved Release 23.4R1, we provide all YANG data models for a given OS and release in a single download package and GitHub repository folder.

23.4R1-EVO

19.1R2 and 19.2R1

Starting in Junos OS Release 19.1R2 and 19.2R1, the

show system
                  schema

command and get-yang-schema RPC must include the output-directory option to specify the directory in which to generate the output files. In earlier releases, you can omit the output-directory option when requesting a single module to display the module in standard output.

17.4R1

Starting in Junos OS Release 17.4R1, the YANG modules generated on a local device, by default, contain family-specific schemas, which are identical across all devices in the given device family.

17.2R1

Starting in Junos OS Release 17.2, Junos OS YANG modules are specific to a device family and each module’s namespace reflects the device family to which the schema in the module belongs.

arrow_backward PREVIOUS YANG Metadata Annotations for Junos Devices

NEXT arrow_forward Understanding the Management of Nonnative YANG Modules on Devices Running Junos OS

NETCONF XML Management Protocol Developer Guide

ON THIS PAGE

Use Juniper Networks YANG Modules

Obtain Juniper Networks YANG Data Models

Download YANG Modules from Juniper Networks

Generate YANG Modules on Junos Devices

Generate YANG Modules from a Remote Session

Importing Juniper Networks YANG Modules

Change History Table

Stay in touch

Helped me install or use the product
Accelerated my deployment

Discuss the product with a co-worker
Make a purchase inquiry

NETCONF XML Management Protocol Developer Guide

ON THIS PAGE

Use Juniper Networks YANG Modules

Obtain Juniper Networks YANG Data Models

Download YANG Modules from Juniper Networks

Generate YANG Modules on Junos Devices

Generate YANG Modules from a Remote Session

Importing Juniper Networks YANG Modules

Related Documentation

Change History Table

Stay in touch