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

Configlets Introduction

Release: Juniper Apstra 4.2

date_range 07-Feb-24

arrow_backward

arrow_forward

Configlets are configuration templates that augment Apstra’s reference design with non-native device configuration. They consist of one or more generators. Each generator specifies a NOS type (config style), when to render the configuration, and CLI commands (and file name as applicable). The section that you select when creating the configlet determines when the configuration is rendered.

When you want to use a configlet, you import it from the global catalog into a blueprint catalog and assign it to one or more roles and/or deployed devices. You can edit the roles and/or devices in a blueprint configlet, but if you want to change the configlet itself, you must export it to the global catalog, modify it, and re-import it into the blueprint.

You can use the same configlets across the entire enterprise, but we recommend creating and applying regionally-specific property sets instead.

Note:

Improperly configured configlets may not raise warnings or restrictions. Testing and validating configlets for correctness is the responsibility of the end user. We recommend that you test configlets on a separate dedicated service to ensure that the configlet performs exactly as intended.

Passwords and other secret keys are not encrypted in configlets.

Configlet Applications

Some applications for configlets include the following:

Syslog
SNMP access policy
TACACS / RADIUS
Management ACLs
Control plane policing
NTP
Username / password

When Not to Use Configlets

CAUTION:

Using configlets to add non-native configuration is not always appropriate or possible. Configlets are powerful, but if used improperly they pose risks to deployment stability and reference design feature interactions. Testing and validating configlets for correctness is the responsibility of the end user.

Don't use configlets to replace reference design configuration, such as for routing or connectivity. If you change interface configuration, the Apstra-intended interface configuration could be overwritten. For example, if a configlet creates a network span port, you must apply the configlet to an Unused port, or it might inadvertently overwrite one that is already in use.

On Cisco NX-OS and Arista EOS devices, do not use configlets to configure multi-line banners (such as banner motd) because of a problematic extra non-ASCII character that cannot be entered. Instead, configure multi-line banners with Cisco POAP (Power-on Auto Provisioning) or ZTP (Arista Zero Touch Provisioning) before installing the device agent. The banner configuration becomes part of the device's pristine configuration and persists throughout the Apstra configuration. Another option is to manually configure multi-line banners on the device. This method causes a configuration deviation anomaly that you can clear by accepting the new configuration as the golden config. For more information, see Configuration Deviation.

Configlet Parameters

Configlets include the following details. The selected config style (NOS type) and section determine whether template text, negation template text and filename are required:

Table 1: Configlet Parameters
Name	Description
Configlet Name	A unique name to identify the configlet, 64 characters or fewer
Config Style (NOS Type)	Junos, NX-OS, EOS, SONiC
Section: System (NX-OS, EOS, SONiC) Section: Top-Level: Hierarchical (previously called System) (Junos)	Runs commands as root user. Improper changes could break the functionality of the reference design and take down a network. When a device is unassigned from a node, the negation template text removes configuration. For example, if the template text is `username example privilege 15 secret 0 MyPassword`, the negation template text might be no username example Can use in conjunction with File configlets to restart processes or perform administrative tasks after File configlets render. System configlets can nest other configuration. For NX-OS and EOS, the appropriate configure terminal context is applied. It doesn’t need to be part of the configlet.
Section: Top-Level: Set / Delete (Junos)	Author configlets using Juniper "Set" style rather than structured JSON
Section: Interface (NX-OS, EOS) Section: Interface-Level: Hierarchical (Junos)	For physical devices only. You specify the interface when you import the configlet into a blueprint (scope).
Section: Interface-Level: Set (Junos)	Author configlets using Juniper "Set" command rather than structured JSON. Text is validated to begin with 'set'.
Section: Interface-Level: Delete (Junos)	Author configlets using Juniper "Delete" command rather than structured JSON. Text is validated to begin with 'delete'.
Section: File (SONiC)	The entire contents of the file must be present within the configlet because the entire file is overwritten; there is no versioning or storing of the original file contents, soyou can’t restore it to its original content. Improper use can take down a network. Do not use on config files of critical processes (such as `/etc/frr/frr.conf` or `/etc/network/interfaces/`). Contents are written, as root user, to the `/etc` directory file (because of Apstra’s Docker container host mount). To write to a file outside of `/etc` (`/usr` for example) build the File configlet, then use a System configlet to move the file afterwards.
Section: System Top (NX-OS, EOS)	Ensures that you can overwrite a setting to implement programmed intent. When the reference design is applied, any needed features that were “turned off” in this configlet are reenabled.
Section: FRR (SONiC)	Configlet configuration is appended to the end of the Apstra-generated `/etc/frr/frr.conf` file and becomes part of FRR intent. Configuration is incrementally included in frr-reload. Template text is not validated. Errors are likely to cause deployment errors, unintended configuration and device impact.
Template Text	CLI commands to add configuration to devices. Issued directly to devices without validation.
Negation Template Text	CLI commands to disable configlet functionality (when a device is unassigned). Issued directly to devices without validation.
Filename	For File configlets

Configuration Rendering Order

Configuration rendering order is as follows:

System Top: negation template text (NX-OS, EOS)
System Top: template text (NX-OS, EOS)
Apstra reference design
Interface: negation template text (Junos, NX-OS, EOS)
System: negation template text (Junos, NX-OS, EOS, SONiC)
File (SONiC)
System: template text (Junos, NX-OS, EOS, SONiC)
Interface: template text (Junos, NX-OS, EOS)

To control the order of operations within a section, create configlets with numeric names. For example, 01_syslog renders before 02_ntp. Configlets are then ordered based on the condition of the configlet (for example the spine or leaf role), and then by the Node ID of the configlet.

View Configlets (Design)

From the left navigation menu, navigate to Design > Configlets to go to configlets in the design (global) catalog. You can create, clone, import, export, edit and delete configlets.

arrow_backward PREVIOUS Config Templates (Freeform Design)

NEXT arrow_forward Create Configlet (Design)

Juniper Apstra 4.2.2 / 4.2.1 / 4.2.0 User Guide

ON THIS PAGE

Configlets Introduction

Configlet Applications

When Not to Use Configlets

Configlet Parameters

Configuration Rendering Order

View Configlets (Design)

Stay in touch

Helped me install or use the product
Accelerated my deployment

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

Juniper Apstra 4.2.2 / 4.2.1 / 4.2.0 User Guide

ON THIS PAGE

Configlets Introduction

Configlet Applications

When Not to Use Configlets

Configlet Parameters

Configuration Rendering Order

View Configlets (Design)

Related Documentation

Stay in touch