On this page
aos_blueprint_virtnet - Manage AOS blueprint parameter values
New in version 2.3.
Synopsis
- Apstra AOS Blueprint Virtual Network module let you manage your Virtual Network easily. You can create access, define and delete Virtual Network by name or by using a JSON / Yaml file. This module is idempotent and support the check mode. It’s using the AOS REST API.
Requirements (on host that executes module)
- aos-pyez >= 0.6.0
Options
parameter | required | default | choices | comments |
---|---|---|---|---|
blueprint |
yes |
Blueprint Name or Id as defined in AOS.
|
||
content |
no |
Datastructure of the Virtual Network to manage. The data can be in YAML / JSON or directly a variable. It's the same datastructure that is returned on success in value.
|
||
name |
no |
Name of Virtual Network as part of the Blueprint.
|
||
session |
yes |
An existing AOS session as obtained by aos_login module.
|
||
state |
no | present |
|
Indicate what is the expected state of the Virtual Network (present or not).
|
Examples
- name: "Access Existing Virtual Network"
aos_blueprint_virtnet:
session: "{{ aos_session }}"
blueprint: "my-blueprint-l2"
name: "my-virtual-network"
state: present
- name: "Delete Virtual Network with JSON File"
aos_blueprint_virtnet:
session: "{{ aos_session }}"
blueprint: "my-blueprint-l2"
content: "{{ lookup('file', 'resources/virtual-network-02.json') }}"
state: absent
- name: "Create Virtual Network"
aos_blueprint_virtnet:
session: "{{ aos_session }}"
blueprint: "my-blueprint-l2"
content: "{{ lookup('file', 'resources/virtual-network-02.json') }}"
state: present
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.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.4/aos_blueprint_virtnet_module.html