ansible.builtin._aos_blueprint (v2.8.20) — module

Install Ansible via pip

Install with pip install ansible==2.8.20

Description

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 I(check) mode. It's using the AOS REST API.

Requirements

• aos-pyez >= 0.6.0

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

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

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

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

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

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

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

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

Inputs

    
id:
    description:
    - AOS Id of the IP Pool to manage (can't be used to create a new IP Pool). Only one
      of I(name) or I(id) can be set.

name:
    description:
    - Name of the Blueprint to manage. Only one of I(name) or I(id) can be set.

state:
    choices:
    - present
    - absent
    - build-ready
    default: present
    description:
    - Indicate what is the expected state of the Blueprint.

session:
    description:
    - An existing AOS session as obtained by M(aos_login) module.
    required: true

timeout:
    default: 5
    description:
    - When I(state=build-ready), this timeout identifies timeout in seconds to wait before
      declaring a failure.

template:
    description:
    - When creating a blueprint, this value identifies, by name, an existing engineering
      design template within the AOS-server.

reference_arch:
    description:
    - When creating a blueprint, this value identifies a known AOS reference architecture
      value. I(Refer to AOS-server documentation for available values).