Documentation

aos_blueprint - Manage AOS blueprint instance

New in version 2.3.

Synopsis

  • Apstra AOS Blueprint module let you manage your Blueprint easily. You can create create and delete Blueprint by Name or ID. You can also use it to retrieve all data from a blueprint. This module is idempotent and support the check mode. It’s using the AOS REST API.

Options

parameter required default choices comments
id
 no
AOS Id of the IP Pool to manage (can't be used to create a new IP Pool). Only one of name or id can be set.
name
 no
Name of the Blueprint to manage. Only one of name or id can be set.
reference_arch
 no
When creating a blueprint, this value identifies a known AOS reference architecture value. Refer to AOS-server documentation for available values.
session
 yes
An existing AOS session as obtained by aos_login module.
state
 no present
  • present
  • absent
  • build-ready
Indicate what is the expected state of the Blueprint.
template
 no
When creating a blueprint, this value identifies, by name, an existing engineering design template within the AOS-server.
timeout
 no 5
When state=build-ready, this timeout identifies timeout in seconds to wait before declaring a failure.

Examples

- name: Creating blueprint
  aos_blueprint:
    session: "{{ aos_session }}"
    name: "my-blueprint"
    template: "my-template"
    reference_arch: two_stage_l3clos
    state: present

- name: Access a blueprint and get content
  aos_blueprint:
    session: "{{ aos_session }}"
    name: "{{ blueprint_name }}"
    template: "{{ blueprint_template }}"
    state: present
  register: bp

- name: Delete a blueprint
  aos_blueprint:
    session: "{{ aos_session }}"
    name: "my-blueprint"
    state: absent

- name: Await blueprint build-ready, and obtain contents
  aos_blueprint:
    session: "{{ aos_session }}"
    name: "{{ blueprint_name }}"
    state: build-ready
  register: bp

Status

This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.

For help in developing on modules, should you be so inclined, please read Community Information & Contributing, Testing Ansible and Developing Modules.