Help us improve your experience.

Let us know what you think.

Do you have time for a two-minute survey?

header-navigation
keyboard_arrow_up
close
keyboard_arrow_left
Broadband Subscriber Services User Guide
Table of Contents Expand all
list Table of Contents
file_download PDF
{ "lLangCode": "en", "lName": "English", "lCountryCode": "us", "transcode": "en_US" }
English
keyboard_arrow_right

Configuring the Collection and Export of Local Telemetry Data on the IPFIX Mediator

date_range 06-Dec-23

You can configure the input-jti-ipfix plug-in for the IPFIX service agent to collect telemetry (gRPC) data from the local Junos Telemetry Interface (JTI) on a BNG configured as an IPFIX mediator. In addition to streaming IPFIX records from the input-ipfix plug-in, the output-ipfix plug-in also translates the gRPC data received from the input-jti-ipfix plug-into corresponding IPFIX data records.

You configure a record group for the input-jti-ipfix plug-in that consists of one or more predefined IPFIX records. Each predefined record is associated with a specific, nonconfigurable set of telemetry sensors on the BNG. You can configure the frequency at which the sensor records are exported to an IPFIX collector; the IPFIX collector is configured with the output-ipfix plug-in.

Before you begin, you must enable the IPFIX service agent by configuring at least one parameter for the input-ipfix plug-in.

To configure local telemetry data collection and reporting:

  1. Access the IPFIX service agent configuration.
    content_copy zoom_out_map
    [edit services analytics agent]
    user@host# edit service-agents ipfix
    
  2. Configure parameters for the IPFIX telemetry input plug-in.
    content_copy zoom_out_map
    [edit services analytics agent service-agents ipfix]
    user@host# edit inputs input-jti-ipfix
    
    1. Specify the name of a group of records to collect telemetry data.

      content_copy zoom_out_map
      [edit services analytics agent service-agents ipfix inputs input-jti-ipfix]
      user@host# edit parameters record-group group-name
      
    2. Specify the record that you want to add to the group.

      content_copy zoom_out_map
      [edit services analytics agent service-agents ipfix inputs input-jti-ipfix parameters record-group group-name
      user@host# set record ipfix-record-name
      
    3. (Optional) Configure a reporting interval for the record group when you do not want to use the default value (900 seconds).

      content_copy zoom_out_map
      [edit services analytics agent service-agents ipfix inputs input-jti-ipfix parameters record-group group-name]
      user@host# set reporting-interval seconds
      
  3. Configure parameters for the IPFIX output plug-in. This is the same configuration you use when you configure the IPFIX mediation.
    content_copy zoom_out_map
    [edit services analytics agent service-agents ipfix]
    user@host# edit outputs output-ipfix
    
    1. Specify the IP address of the upstream IPFIX collector. This is a mandatory option.

      content_copy zoom_out_map
      [edit services analytics agent service-agents ipfix outputs output-ipfix]
      user@host# set parameters collector-address ip-address
      
    2. (Optional) Specify the path for the certificate that is used to sign the peer certificate at the peer (IPFIX collector) level. The certificate is provided by a trusted certificate authority (CA) and is expected to be in .pem container format.

      content_copy zoom_out_map
      [edit services analytics agent service-agents ipfix outputs output-ipfix]
      user@host# set parameters collector-ca-certificate file-path
      
    3. (Optional) Specify the path for the client certificate that the server (IPFIX collector) uses to authenticate the client and to enable mutual authentication. The fully-qualified domain name (FQDN) of both the client and the server are stored in the certificate’s Subject Alternative Name field when the client and server certificates are generated. The certificate is expected to be in .pem container format.

      content_copy zoom_out_map
      [edit services analytics agent service-agents ipfix outputs output-ipfix]
      user@host# set parameters collector-certificate file-path
      
    4. (Optional) Specify the path of the private key file that is loaded to decrypt the encrypted message sent from the peer.

      content_copy zoom_out_map
      [edit services analytics agent service-agents ipfix outputs output-ipfix]
      user@host# set parameters collector-certificate-key file-path
      
    5. (Optional) Specify how many seconds the output plug-in waits before retrying the connection to the IPFIX collector. The default value is 20.

      content_copy zoom_out_map
      [edit services analytics agent service-agents ipfix outputs output-ipfix]
      user@host# set parameters collector-connection-retry-interval seconds
      
    6. (Optional) Specify the TCP port that the IPFIX mediator uses to connect to the IPFIX collector. The default value is 4740.

      content_copy zoom_out_map
      [edit services analytics agent service-agents ipfix outputs output-ipfix]
      user@host# set parameters collector-tcp-port port-number
      
    7. (Optional) Specify the name of the VRF (routing instance) in which IPFIX packets are routed to the IPFIX collector. The default value is default.

      content_copy zoom_out_map
      [edit services analytics agent service-agents ipfix outputs output-ipfix]
      user@host# set parameters collector-vrf-name vrf-name
      

The following sample configuration includes three record groups for the telemetry input plug-in, high-frequency, baseline, and background:

  • The high-frequency group subscribers to the subscriber-statistics and port-statistics record. Because statistics data is dynamic and changes frequently, the reporting interval is set to five minutes, which is much less than the default.

  • The baseline record group subscribes to the address-pool-utilization and dhcpv4-server-statistics records; the reporting interval is left at the default value, 15 minutes.

  • The background record group subscribes to the thermal and chassis-inventory records. These probably do not change frequently, so the reporting interval is set to six hours.

To enable the IPFIX plug-in, you must configure at least one parameter; in this example, the maximum number of TCP connections is set to 200.

Finally, the IP address and listening port for the IPFIX collector is configured in the output plug-in.

content_copy zoom_out_map
[edit services analytics agent service-agents ipfix]
    inputs input-jti-ipfix {
        parameters {
            record-group high-frequency {
                record subscriber-statistics;
                record port-statistics;
                reporting-interval 300;
            }
            record-group baseline {
                record address-pool-utilization;
                record dhcpv4-server-statistics;
            }
            record-group background {
                record thermal;
                record chassis-inventory;
                reporting-interval 21600;
            }
        }
    }
    inputs input-ipfix {
        parameters {
            maximum-connections 200;
        }
    }
    outputs output-ipfix {
        parameters {
            collector-address 192.0.2.2;
            collector-port 6589;
        }
    }
}

You can use the show services analytics agent command to display information about the service agents.

footer-navigation