close

keyboard_arrow_left

Table of Contents Expand all

Introduction
Get Started
play_arrow Apstra GUI
- Log in to Apstra GUI
- Reset Apstra GUI Admin Password
play_arrow Blueprints and Dashboard
- Create Datacenter Blueprint
- Blueprint Summaries and Dashboard
- Delete Datacenter Blueprint
play_arrow Analytics (Blueprints)
- Analytics Introduction
- play_arrow Dashboards
- play_arrow Anomalies
  - Anomalies (Analytics)
- play_arrow Widgets
- play_arrow Probes
- play_arrow Predefined Reports (Tech Preview)
- play_arrow Root Causes
  - Root Causes
play_arrow Staged (Datacenter Blueprints)
- Blueprint-Wide Search
- play_arrow Physical
- play_arrow Virtual
  - play_arrow Virtual Networks
  - play_arrow Routing Zones
  - Static Routes (Virtual)
  - Protocol Sessions (Virtual)
  - play_arrow Virtual Infrastructure
  - play_arrow Statistics
- play_arrow Policies
  - play_arrow Endpoints
  - Security Policies
  - Interface Policies
  - Routing Policies
  - Routing Zone (VRF) Constraints
  - play_arrow Routing Zone Policy (4.2.0)
    - Optimize Routing Zone Resource Usage (4.2.0)
- play_arrow Data Center Interconnect (DCI)
- play_arrow Catalog
  - play_arrow Logical Devices
    - Export Logical Device
  - play_arrow Interface Maps
    - Import Interface Map
    - Delete Interface Map (Blueprint)
  - play_arrow Property Sets
  - play_arrow Configlets
  - play_arrow AAA Servers
    - AAA Servers (Datacenter Blueprint)
  - play_arrow Tags
- play_arrow Tasks
  - Tasks (Datacenter) Staged
- play_arrow Connectivity Templates
- play_arrow Fabric Settings (4.2.1)
  - play_arrow Fabric Policy (4.2.1)
    - Update Fabric MTU (4.2.1)
    - Optimize Routing Zone Resource Usage (4.2.1)
  - play_arrow Severity Preferences (4.2.1)
    - Update Severity Preferences
- play_arrow Fabric Settings (4.2.0)
  - play_arrow Fabric Policy (4.2.0)
    - Enable IPv6 Applications
    - Update Fabric MTU (4.2.0)
  - play_arrow Virtual Network Policy (4.2.0)
    - Virtual Network Policy Introduction
    - Update Virtual Network Policy
  - play_arrow Anti-Affinity Policy (4.2.0)
    - Anti-Affinity Policy
  - play_arrow Validation Policy (4.2.0)
    - Update Validation Policy (Severity Preference)
- BGP Route Tagging
play_arrow Staged (Freeform Blueprints)
- Freeform Introduction
- play_arrow Blueprints
- play_arrow Physical
- play_arrow Resource Management
  - Resource Management Introduction (Freeform)
  - play_arrow Blueprint Resources
  - play_arrow Allocation Groups
    - Create Allocation Group (Freeform)
  - play_arrow Local Pools
    - Create Local Pool (Freeform)
    - Create Local Pool Generator (Freeform)
- play_arrow Catalog
  - play_arrow Config Templates
  - play_arrow Device Profiles
    - Import Device Profile (Freeform)
    - Delete Device Profile (Freeform Blueprint)
  - play_arrow Property Sets
  - play_arrow Tags
- play_arrow Tasks
  - Tasks - Staged (Freeform)
play_arrow Uncommitted (Blueprints)
- Uncommitted Introduction
- Commit / Revert Changes to Blueprint
play_arrow Active (Datacenter Blueprints)
- Active (Datacenter Blueprint)
- play_arrow Topology (Active)
- Nodes (Active)
- Links (Active)
- Racks (Active)
- Pods (Active)
- Query
- Anomalies (Service)
play_arrow Time Voyager (Blueprints)
- Time Voyager Introduction
- Roll Back Blueprint Revision
- Keep Blueprint Revision
- Change Number of Saved Blueprint Revisions
- Update Blueprint Revision Description
- Delete Blueprint Revision
play_arrow Devices
- Device Configuration Lifecycle
- play_arrow Managed Devices
- play_arrow System Agents
- play_arrow Pristine Config
  - Edit Pristine Config
  - Update Pristine Config from Device
- play_arrow Telemetry
  - Device Telemetry Services
  - All Telemetry Services
  - play_arrow Telemetry Service Registry
    - Service Registry
  - Telemetry Streaming
  - Route Anomalies for a Host - Example
  - Juniper Telemetry Commands
  - Cisco Telemetry Commands
  - Arista Telemetry Commands
  - Linux Server Telemetry Command
  - Debugging Telemetry
  - Extensible Telemetry Guide
- play_arrow Apstra ZTP
- play_arrow Device Profiles
play_arrow Design
- play_arrow Logical Devices
- play_arrow Interface Maps
- play_arrow Rack Types
- play_arrow Templates
- play_arrow Config Templates
  - Config Templates (Freeform Design)
- play_arrow Configlets (Datacenter)
- play_arrow Property Sets (Datacenter)
- play_arrow TCP/UDP Ports
- play_arrow Tags
play_arrow Resources
- Resources Introduction
- ASNs
- VNIs
- Integers
- IPv4 Addresses
- IPv6 Addresses
play_arrow Analytics
- play_arrow Apstra Flow
  - Apstra Flow Introduction
  - System Requirements
  - play_arrow Dashboards
    - Apstra Flow Dashboards
  - play_arrow Supported Flow Records
  - play_arrow Flow Enrichment
  - play_arrow Monitor Flow Data
    - Metrics
  - play_arrow Configuration Reference
  - play_arrow API
    - API Endpoints Options
  - play_arrow Additional Documentation
  - play_arrow Knowledge Base
play_arrow External Systems (RBAC Providers)
- play_arrow Providers
- play_arrow Provider Role Mapping
play_arrow Platform
- play_arrow User / Role Management
  - User / Role Management Introduction
  - play_arrow Users
  - play_arrow Roles
- play_arrow Security
- Syslog Configuration (Platform)
- Receivers (Platform)
- Global Statistics (Platform)
- Event Log (Audit Log)
- play_arrow Apstra VM Clusters
- play_arrow Developers
- play_arrow Technical Support
- Check Apstra Versions and Patent Numbers
Favorites & User
play_arrow Apstra Server Management
- Apstra Server Introduction
- Monitor Apstra Server via CLI
- Restart Apstra Server
- Reset Apstra Server VM Password
- Reinstall Apstra Server
- Apstra Database Overview
- Back up Apstra Database
- Restore Apstra Database
- Reset Apstra Database
- Migrate Apstra Database
- Replace SSL Certificate on Apstra Server with Signed One
- Replace SSL Certificate on Apstra Server with Self-Signed One
- Change Apstra Server Hostname
Apstra CLI Utility
play_arrow Guides
- 5-Stage Clos Architecture
- Juniper EVPN Support
- Intent-Based Analytics with apstra-cli Utility
- AOSOM-Streaming Guide
play_arrow References
- play_arrow Feature Matrix
  - Apstra 4.2.1 Feature Matrix
  - Apstra 4.2.0 Feature Matrix
- play_arrow Devices
- play_arrow Analytics
- Configlet Examples (Design)
- play_arrow Apstra CLI Commands
  - Apstra CLI Commands
- Apstra EVPN Support Addendum
- Apstra Server Configuration File
- Graph
- Juniper Apstra Technology Preview

list Table of Contents

English

keyboard_arrow_right

Generate a Support Bundle

Release: Juniper Apstra 4.2

date_range 05-Sep-24

arrow_backward

arrow_forward

The support bundle allows you to generate a compressed TAR file containing relevant data (logs, configs, and metric data) for troubleshooting or analysis. If needed, you can send these bundled files to your Apstra support team to help diagnose issues with the collector.

To use the support bundle command line tool, run the flowcoll command with the --support-bundle or -s flag as shown in the following examples:

Basic Example

content_copy zoom_out_map
sudo /usr/share/juniper/bin/flowcoll -s

Advanced Example

content_copy zoom_out_map
sudo /usr/share/juniper/bin/flowcoll -s -sc /my/config/dir -sl /my/log/dir -st 3 -si 3000

When the command runs successfully, the tool generates a compressed TAR file in the directory /home named similarly to ef_support_bundle-20230831T164759.tar.gz.

Command Line Options

If you do not specify an option, its specified default value is used as shown in the following table:

Table 1: CLI Default Options
Option	Shorthand	Default Value	Description
`support-bundle`	`-s`	`false`	Enables support bundle mode.
`support-bundle-config-dir`	`-sc`	`/etc/flowcoll`	The path to the collector's configuration directory.
`--support-bundle-logs-dir`	`-sl`	`/var/log/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 numbers of times metrics are collected.
`--support-bundle-output`	`-so`	`<Working directory>`	The path where the output file is written to.

Note:

Adjusting the collection interval (-si) and times (st), makes it easier to track and spot trends in metrics over time.

Generate Support Bundle by Endpoint

You can generate a support bundle by using the following methods:

HTTP Method: POST
URL: /support-bundle

Request Body

All fields in the request boy are optional. The defaults are used if none are specified.

logDirPath (string): Directory path of the log files. The default path is: /var/log/juniper/flowcoll
configDirPath (string): Directory path of the configuration file. The default path is: /etc/juniper

Query Parameters

Interval (integer): Interval at which the metrics are fetched (in ms).The default interval is: 1000 ms.
Times
(Integer): The number of times the metrics endpoint is fetched. The default is 1.

Authentication: This endpoint supports basic authentication only if the collector is specifically configured for it. For configuration details, see the API options under the Common Options section.

Examples of Support Bundles by Endpoint

Basic Example

Using the default settings, the following example shows a basic example without any query parameters or request body.

content_copy zoom_out_map
curl -X POST \
  -H "Content-Type: application/json" \
  -O -J \
  http://localhost:8080/support-bundle

Advanced Example

The following example shows an advanced curl request that includes the request body and query parameters.

content_copy zoom_out_map
curl -X POST \
  -H "Content-Type: application/json" \
  -d '{
    "logDirPath": "/path/to/log/dir",
    "configDirPath": "/path/to/log/dir"
  }' \
  -O -J \
  http://localhost:8080/support-bundle?interval=2000&times=2

Responses

Table 2 shows the codes and responses you might see when you generate a support bundle by endpoint.

Table 2: Support Bundle Code and Responses
Code	Reason	Description
200	OK	A successful response returns the support bundle file for download. The file has the following naming convention: `ef_support_bundle-YYYYMMDDTHHmmss.tar.gz`, where `YYYYMMDDTHHmmss` is a timestamp that indicates the time the bundle was created.
400	Bad request	Indicates that the query parameters are invalid.
500	Internal Server Error	An internal server error occurred while processing the request.

arrow_backward PREVIOUS Configure the hsflowd sFlow Agent

NEXT arrow_forward Installation

Juniper Apstra 4.2.2 / 4.2.1 / 4.2.0 User Guide

Generate a Support Bundle

Generate Support Bundle by Endpoint

Examples of Support Bundles by Endpoint

Stay in touch

Helped me install or use the product
Accelerated my deployment

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