Help us improve your experience.

Let us know what you think.

Do you have time for a two-minute survey?

 
ON THIS PAGE
 

Generate a Support Bundle

The Support Bundle feature allows you to generate a compressed TAR file containing relevant data (logs, configs, and metric data) for troubleshooting or analysis. You can send these files to the Juniper support team to help diagnose issues with the collector. Use the flowcoll command with the --support-bundle or -s flag to generate the TAR file. When the command runs successfully, it produces a compressed TAR file named similarly to ef_support_bundle-20230831T164759.tar.gz.

Note:

If you are using config file encryption, ensure the same configuration is used to generate a support bundle.

Basic Example:

/usr/share/juniper/bin/flowcoll -s

Note: Run this command in a directory with write permissions to create the bundle.

Command Line Options

Table 1 describes the available CLI options used to generate a support bundle. If an option is not specified, its specified default value is used.

Table 1: Support Bundle CLI Options
Option Shorthand Default Value Description

--support-bundle

 -s false Enables support bundle mode.

--support-bundle-config-dir

 -sc /etc/juniper/flowcoll The path to the collector's configuration directory.

--support-bundle-logs--dir

 -sl /var/log/juniper/flowcoll The path to the collector's log directory.

--support-bundle-metrics-interval

 -si 1000 The interval, in ms, that metrics are collected.

--support-bundle-metrics-times

 -st 1 The number of times metrics is collected.

--support-bundle-output

 -so <working directory> The path where the output file is written.
Note: You can track metrics and spot trends more easily by adjusting the collection interval (-si) and times (st).

Generate a Support Bundle by Endpoint

You can generate a support bundle by using one of the following endpoints:
Type of Endpoint Description
HTTP Method POST
URL /support-bundle
Request Body All fields in the request body are optional. The defaults are used if not specified.

  • LogDirPath (string): Directory path of the log files. Default: /var/log/juniper/flowcoll

  • configDirPath (string): Directory path of the configuration file. Default: /etc/juniper
Query Parameters

  • Interval (integer): Interval at which the metrics will be fetched in ms. Default: 1000.

  • times (integer): The number of times the metrics endpoint will be fetched. Default: 1

You can track metrics and spot trends more easily by adjusting the collection interval (-si) and times (st).
Authentication Supports Basic Authentication only if the collector is specifically configured for it.

Examples

Basic Example: Using the defaults, this example demonstrates a basic example without any query parameters or request body.

curl -X POST http://localhost:8080/support-bundle -H "Content-Type: application/json" -d '{}' -O -J --insecure

Advanced Example: This example demonstrates an advanced curl request with a filled request body and query parameters.

curl -X POST -H "Content-Type: application/json" -d '{"logDirPath":"/var/log/juniper/flowcoll/","configDirPath":"/etc/juniper/"}' -O -J "http://localhost:8080/support-bundle?interval=2000&times=2"

Responses

Code Reason Description
200 OK

A successful response returns the support bundle file for download. The file is named ef_support_bundle-YYYYMMDDTHHmmss.tar.gz, with YYYYMMDDTHHmmss as the creation timestamp.
400 Bad Request

Query parameters are invalid.
500 Internal Server Error

An internal server error occurred while processing the request.