New in version 2.3.
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. |
The below requirements are needed on the host that executes this module.
Parameter | Choices/Defaults | Comments |
---|---|---|
blueprint required | Blueprint Name or Id as defined in AOS. | |
get_param_list | Get the complete list of supported parameters for this blueprint and the description of those parameters. | |
name | Name of blueprint parameter, as defined by AOS design template. You can use the option get_param_list to get the complete list of supported parameters for your blueprint. | |
param_map | Defines the aos-pyez collection that will is used to map the user-defined item name into the AOS unique ID value. For example, if the caller provides an IP address pool param_value called "Server-IpAddrs", then the aos-pyez collection is 'IpPools'. Some param_map are already defined by default like logical_device_maps. | |
session required | An existing AOS session as obtained by aos_login module. | |
state |
| Indicate what is the expected state of the Blueprint Parameter (present or not). |
value | Blueprint parameter value. This value may be transformed by using the param_map field; used when the blueprint parameter requires an AOS unique ID value. |
- name: Add Logical Device Maps information in a Blueprint aos_blueprint_param: session: "{{ aos_session }}" blueprint: "my-blueprint-l2" name: "logical_device_maps" value: spine_1: CumulusVX-Spine-Switch spine_2: CumulusVX-Spine-Switch leaf_1: CumulusVX-Leaf-Switch leaf_2: CumulusVX-Leaf-Switch leaf_3: CumulusVX-Leaf-Switch state: present - name: Access Logical Device Maps information from a Blueprint aos_blueprint_param: session: "{{ aos_session }}" blueprint: "my-blueprint-l2" name: "logical_device_maps" state: present - name: Reset Logical Device Maps information in a Blueprint aos_blueprint_param: session: "{{ aos_session }}" blueprint: "my-blueprint-l2" name: "logical_device_maps" state: absent - name: Get list of all supported Params for a blueprint aos_blueprint_param: session: "{{ aos_session }}" blueprint: "my-blueprint-l2" get_param_list: yes register: params_list - debug: var=params_list - name: Add Resource Pools information in a Blueprint, by providing a param_map aos_blueprint_param: session: "{{ aos_session }}" blueprint: "my-blueprint-l2" name: "resource_pools" value: leaf_loopback_ips: ['Switches-IpAddrs'] spine_loopback_ips: ['Switches-IpAddrs'] spine_leaf_link_ips: ['Switches-IpAddrs'] spine_asns: ['Private-ASN-pool'] leaf_asns: ['Private-ASN-pool'] virtual_network_svi_subnets: ['Servers-IpAddrs'] param_map: leaf_loopback_ips: IpPools spine_loopback_ips: IpPools spine_leaf_link_ips: IpPools spine_asns: AsnPools leaf_asns: AsnPools virtual_network_svi_subnets: IpPools state: present
This module is flagged as deprecated and will be removed in version 2.9. For more information see DEPRECATED.
Hint
If you notice any issues in this documentation you can edit this document to improve it.
© 2012–2018 Michael DeHaan
© 2018 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.7/modules/aos_blueprint_param_module.html