Documentation
  • Docs »
  • aos_blueprint – Manage AOS blueprint instance

aos_blueprint – Manage AOS blueprint instance

New in version 2.3.

DEPRECATED

Removed in Ansible:
 version: 2.9
Why:This module does not support AOS 2.1 or later
Alternative:See new modules at https://www.ansible.com/ansible-apstra.

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.

Requirements

The below requirements are needed on the host that executes this module.

  • aos-pyez >= 0.6.0

Parameters

Parameter Choices/Defaults Comments
id
-
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
-
Name of the Blueprint to manage. Only one of name or id can be set.
reference_arch
-
When creating a blueprint, this value identifies a known AOS reference architecture value. Refer to AOS-server documentation for available values.
session
- / required
An existing AOS session as obtained by aos_login module.
state
-
    Choices:
  • present ←
  • absent
  • build-ready
Indicate what is the expected state of the Blueprint.
template
-
When creating a blueprint, this value identifies, by name, an existing engineering design template within the AOS-server.
timeout
-
Default:
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 will be removed in version 2.9. [deprecated]
  • For more information see DEPRECATED.

Authors

Hint

If you notice any issues in this documentation you can edit this document to improve it.