Navigation
Guide That Contains This Content
[+] Expand All
[-] Collapse All

    Configuring gRPC for the Junos Telemetry Interface

    Starting with Junos OS Release 16.1R3 on MX Series routers and PTX3000 and PTX5000 routers, you can stream telemetry data for various network elements through gRPC, an open source framework for handling remote procedure calls based on TCP. The Junos Telemetry Interface relies on a so-called push model to deliver data asynchronously, which eliminates polling. For all Juniper devices that run a version of Junos OS with upgraded FreeBSD kernel, you must install the Junos Network Agent software package, which provides the interfaces to manage gRPC subscriptions. For Juniper Network devices that run other all other versions of the Junos OS, this functionality is embedded in the Junos OS software. For more information about installing the Junos Network Agent package, see Installing the Network Agent Package.

    The Junos Telemetry Interface and gRPC streaming are supported on QFX10000 and QFX5200 switches, and PTX1000 routers starting with Junos OS Release 17.2R1.

    The Junos Telemetry Interface and gRPC streaming are supported on QFX5110, EX4600, and EX9200 switches starting with Junos OS Release 17.3R1.

    Before you begin:

    • Install Junos OS Release 16.1R3 or later on your Juniper Networks device.
    • If your Juniper Networks device is running a version of Junos OS with an upgraded FreeBSD kernel, install the Junos Network Agent software package.
    • Install the OpenConfig for Junos module. For more information see, Installing the OpenConfig Package.

    To configure your system for gRPC services:

    1. Specify the API connection setting either as unsecured or as based on Secure Socket Layer (SSL) technology. You can specify only one type of connection.

      For example, to set the API connection as unsecured:

      [edit system services]user@host# set extension-service request-response grpc clear-text

      For example, to set the API connection based on a SSL:

      [edit system services]user@host# set extension-service request-response grpc ssl

      For an SSL-based connection, you must specify a local-certificate name. Optionally, you can specify an IP address to listen to for incoming connections (the default address is ::).

      1. Specify a local certificate-name, for example jsd_certificate:
        [edit system services extension-service request-response grpc]user@host# set ssl local-certificate jsd_certificate

        Note: Enter the name of a certificate you have configured with local certificate-name statement at the [edit security certificates] hierarchy level.

      2. (Optional) Specify an IP address to listen to for incoming connections. for example, 192.0.2.0:
        [edit system services extension-service request-response grpc]user@host# set ssl ip-address 192.0.2.0

        Note: If you do not specify an IP address, the default address of :: is used to listen for incoming connections.

    2. Specify port 50051 for accepting incoming connections through gRPC.

      Note: Port 50051 is the required port for gRPC streaming for both unsecured and SSL-based connections.

      [edit system services extension-service request-response grpc]user@host# set ssl port 50051
    3. Specify client IP addresses from which notifications are allowed, for example, 0.0.0.0, which means any IP address:
      [edit system services extension-service]user@host# set notification allow-clients address 0.0.0.0
    4. (Optional) Configure a WAN interface to your Juniper Networks device.

      Best Practice: We recommend that you use a WAN interface to connect your Juniper Networks device to the management station you configure to collect telemetry data.

    Release History Table

    Release
    Description
    The Junos Telemetry Interface and gRPC streaming are supported on QFX5110, EX4600, and EX9200 switches starting with Junos OS Release 17.3R1.
    The Junos Telemetry Interface and gRPC streaming are supported on QFX10000 and QFX5200 switches, and PTX1000 routers starting with Junos OS Release 17.2R1.
    Starting with Junos OS Release 16.1R3 on MX Series routers and PTX3000 and PTX5000 routers, you can stream telemetry data for various network elements through gRPC, an open source framework for handling remote procedure calls based on TCP.

    Modified: 2017-08-16