Juniper Networks Apstra Ansible Collection

This repository contains the Juniper Apstra Ansible Collection, which provides a set of Ansible modules for network management via the Juniper Apstra platform. See the Apstra version compatibility matrix below for supported Apstra versions.

Support

As a Red Hat Ansible Certified Content, this collection is entitled to support through Ansible Automation Platform (AAP).

If you are a Red Hat customer using this collection via Ansible Automation Hub, please open a support case using the Create Issue link in Automation Hub.

If a support case cannot be opened with Red Hat and the collection has been obtained either from Galaxy or GitHub, there is community support available at no charge.

You can join us on #network:ansible.com room or the Ansible Forum Network Working Group.

For more information you can check the communication section below.

Communication

• Join the Ansible forum:
• Get Help: get help or help others.
• Posts tagged with 'juniper': subscribe to participate in collection-related conversations.
• Ansible Network Automation Working Group: by joining the team you will automatically get subscribed to the posts tagged with network.
• Social Spaces: gather and interact with fellow enthusiasts.

• News & Announcements: track project-wide announcements including social events.

• The Ansible Bullhorn newsletter: used to announce releases and important changes.

For more information about communication, see the Ansible communication guide.

Ansible version compatibility

This collection has been tested against following Ansible versions: >=2.16.14.

Apstra version compatibility

The following matrix shows which collection version to use with each Juniper Apstra release:

Note: Collection versions prior to v1.0.5 are not recommended for production use.

Included Content

Modules

Click the Content button to see the list of content included in this collection.

Installation

You can install the Juniper Networks Apstra collection with the Ansible Galaxy CLI:

ansible-galaxy collection install juniper.apstra

You can also include it in a requirements.yml file and install it with ansible-galaxy collection install -r requirements.yml, using the format:

---
collections:
  - name: juniper.apstra

You can ensure that the required packages are installed via pip. For example, if your collection is installed in the default location:

pip install -r ~/.ansible/collections/ansible_collections/juniper/apstra/requirements.txt

Usage

You can call modules by their Fully Qualified Collection Namespace (FQCN), such as juniper.apstra.authenticate. The following example plays show how to log in to Apstra, create a blueprint and gather facts.

The collection is simply an Ansible interface to specific Apstra API. This is why

Login

- name: Connect to Apstra
  juniper.apstra.authenticate:
    api_url: "https://my-apstra/api"
    username: "admin"
    password: "password"
    logout: false
  register: auth

Gather facts

- name: Run apstra_facts module
  juniper.apstra.apstra_facts:
    gather_network_facts: 'all'
    available_network_facts: true
    auth_token: "{{ auth.token }}"
  register: apstra_facts

Create blueprint

- name: Create/get blueprint
  juniper.apstra.blueprint:
    body:
      label: "test_blueprint"
      design: "two_stage_l3clos"
    lock_state: "locked"
    auth_token: "{{ auth.token }}"
  register: bp

Contributing to this collection

We welcome community contributions to this collection. If you find problems, please open an issue or create a PR against the Juniper Networks Apstra collection repository. See Contributing to Ansible-maintained collections for complete details.

You can also join us on:

• IRC - the #ansible-network irc.libera.chat channel
• Slack - ansiblenetwork.slack.com

See the Ansible Community Guide for details on contributing to Ansible.

Code of Conduct

This collection follows the Ansible project's Code of Conduct. Please read and familiarize yourself with this document.

Release Notes

Release notes are available here.

Roadmap

• Expand coverage of Apstra freeform blueprint resources.
• Add support for additional design-level objects (rack types, interface groups).
• Provide idempotent management of system agent profiles.
• Improve diff output to surface per-field change details for all modules.
• Publish dedicated documentation pages for design, fabric_settings, interface_map, and system_agents modules.

More Information

• Ansible network resources
• Ansible Collection overview
• Ansible User guide
• Ansible Developer guide
• Ansible Community code of conduct

Licensing

This collection is available under multiple licenses depending on the component. See LICENSE for the full text.

Primary license: Apache-2.0. Additional licenses used in this project: MIT, GPL-3.0-or-later, BSD-3-Clause.