Help us improve your experience.

Let us know what you think.

Do you have time for a two-minute survey?

 
ON THIS PAGE
 

export-profile (Junos Telemetry Interface)

Syntax

Hierarchy Level

Description

Configure the parameters of the export process for data generated through Junos Telemetry Interface sensors. You can create one or more export profiles. Each profile can be associated with one or more sensors that define the system resource to monitor and stream data. You can associate only one export profile with a specific sensor configuration.

The IP layer delivers the exported data to the remote server. The export profile configuration allows you to specify a format for exported data, a transport protocol, the rate which the system generates data, and the local source port and IP address that are used to define the transport headers in the exported packets.

To enable Junos Telemetry Interface, you must also configure a sensor that defines the parameters of the system resource to monitor and stream data, and a server to collect the data. To configure a sensor, include the sensor sensor-name statement at the [edit services analytics] hierarchy level. To configure the server that functions as a data collector, include streaming-server server-name statement at the [edit services analytics] hierarchy level.

If you are configuring the export profile for dialout, the options local-address, local-port, dscp, forwarding-class, loss-priority, payload-size, and resource-filter are not supported. Only the reporting-interval option is supported with dialout.

Note:

Junos Telemetry Interface was introduced in Junos OS Release 15.1F3 on MX Series routers with interfaces configured on MPC1 through MPC6E and on PTX Series routers with interfaces configured on FPC3. Starting in Junos OS Release 15.1F5, Junos Telemetry Interface is also supported on MPC7E, MPC8E, and MPC9E on MX Series routers.

Starting with Junos OS Release 16.1R3, FPC1 and FPC2 on PTX Series routers are also supported.

Starting with Junos OS Release 17.2R1, QFX10000 switches and PTX1000 routers are also supported.

Options

name

Name of export profile.

Note:

To associate this export profile with a configured sensor, include the name you configure for the export-profile statement at the [edit services analytics sensor sensor-name export-name] hierarchy level.
dscp value

Specify the DSCP value for the exported packets.

  • Range: 0 through 63.

  • Default: 0

    Note:

    Any interface-level DSCP rewrite rules you have configured override the DSCP value you specify for the export profile. You need to specify a DSCP value for the export profile only if you do not configure DSCP rewrite rules on the outgoing interface. For more information, see Configuring Rewrite Rules.
format

Specify the format to define the structure of exported data.

gpb

Google protocol buffers format.
gpb-gnmi

Google protocol buffers encoding support for (gRPC Network Management Interface) gNMI.
json-gnmi

Javascript Object Notation (JSON) encoding support for gNMI.
forwarding-class (assured-forwarding | best-effort | expedited-forwarding | network-control)

(Packet Forwarding Engine sensors only) Specify the forwarding class for exported packets.

  • Default: best-effort
loss-priority (high | low | medium-high | medium-low) (MX Series only)

Specify the loss priority for exported packets. Loss priority settings help determine which packets are dropped from the network during periods of congestion.
local-address ip-address

Specify the source address of exported packets.
local-port number

Specify the source port for the exported packets.
payload-size bytes (Optional)

Specify the maximum size of exported packets.

Note:

The payload-size option is supported only on the following sensors:

  • /junos/system/linecard/interface/

  • /junos/system/linecard/interface/logical/usage/

  • /junos/system/linecard/firewall/

  • Default: 5000 bytes.

  • Range: For the QFX5100 line of switches, 3000 through 9192 bytes. For Packet Forwarding Engine-related statistics (logical and physical interface and firewall statistics) on all platforms, 2000 through 9192. This is a platform limitation. For all other supported platforms, 1400 through 9192 bytes.

    Note:

    Junos Telemetry Interface does not export packets larger than 9192 bytes.

reporting-rate seconds

Specify the interval at which the Junos Telemetry Interface sensor generates data to export to the collector.

As the configured interval expires, the most recent sample collected by the sensor is gathered and forwarded to the server configured to collect data.

Note:

For Packet Forwarding Engine sensors, the minimum reporting rate is 2 seconds.

  • Range: 1 through 3600 (1 hour)
transport protocol-name

Specify the transport protocol to use to carry the telemetry data in the IP packets.

udp

User Datagram Protocol.

Required Privilege Level

interface—To view this statement in the configuration.

interface-control—To add this statement to the configuration.

Release Information

Statement introduced in Junos OS Release 15.1F3.

payload-size bytes option introduced in Junos OS Release 16.1R3.

loss-priority option introduced in Junos OS Release 17.3R1 for MX Series routers only.

Statement introduced in Junos OS Release 17.4R1 for virtual MX Series (vMX) routers.

Related Documentation