aos_blueprint_virtnet - Manage AOS blueprint parameter values¶
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 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¶
The below requirements are needed on the host that executes this module.
- aos-pyez >= 0.6.0
Parameters¶
Parameter | Choices/Defaults | Comments |
---|---|---|
blueprint
required |
Blueprint Name or Id as defined in AOS.
|
|
content |
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 |
Name of Virtual Network as part of the Blueprint.
|
|
session
required |
An existing AOS session as obtained by aos_login module.
|
|
state |
|
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 deprecated and will be removed in version 2.9. For more information see DEPRECATED.
Author¶
- Damien Garros (@dgarros)
Hint
If you notice any issues in this documentation you can edit this document to improve it.