Help us improve your experience.

Let us know what you think.

Do you have time for a two-minute survey?

 
 

Create Configlet

  1. From the left navigation menu, navigate to Design > Configlets and click Create Configlet.
  2. Enter a configlet name, and select a NOS type (config style).
  3. Select the section where you want the configlet to be rendered. Available choices depend on the selected config style. (As of Apstra release 4.0.0, OSPF for external routers is no longer supported. While OSPF configlets still appear in the Apstra GUI, they should not be used.)

    For Cumulus, depending on the section selected, the following applies:

    • Cumulus System: Template Text and Negation Template Text require the net commit command.
    • Cumulus Interface: net clu (NCLU) syntax is no longer used. Config line must match /etc/network/interfaces syntax exactly.
    • Cumulus File: All files are overwritten. Removing the configlet doesn’t restore original content.
    • Cumulus FRR: all configlet content is appended to the /etc/frr/frr.conf file.
  4. In the Template Text and Negation Template Text fields (as applicable), enter CLI commands. See Configlet examples in the Reference section. Avoid using shortened versions of commands. The exact commands may be validated, but after changes are pushed, they may be returned as-is in the rendered configuration.
    CAUTION:

    Using a raw text editor (OSX TextEdit, Windows Notepad++) is critical. Hidden characters can cause unforeseen issues when the configlet is deployed.
    Note:

    Instead of hard-coding data into a configlet, you can refer to a property set (key-value pairs). For an example, see the Arista NTP example in the References section.
  5. If Negation Template Text is required, enter the CLI commands to remove the configuration.
  6. For File configlets, enter the filename in the Filename field.
  7. To add another generator, click Add a style and enter details. (Tip: Configlets can contain syntax for multiple vendors. Create one single-purpose configlet with a generator for each vendor NOS type to include its own syntax.)
  8. Click Create to add the configlet to the global catalog.

When you’re ready to use the configlet in a blueprint, import it into the blueprint's catalog.