aos_blueprint_param - Управление параметрами шаблона AOS
Новое в версии 2.3.
Описание
- Модуль Apstra AOS Blueprint Parameter позволяет легко управлять параметрами вашего шаблона. Вы можете создавать, определять и удалять параметры шаблона. Список поддерживаемых параметров отличается в зависимости от шаблона. Параметр get_param_list поможет получить список поддерживаемых параметров для вашего шаблона. Этот модуль идемпотентен и поддерживает режим check. Он использует REST API AOS.
Требования (для хоста, на котором выполняется модуль)
- aos-pyez >= 0.6.0
Параметры
| параметр | обязательно | по умолчанию | возможные значения | комментарии |
|---|---|---|---|---|
| blueprint | да | Имя или идентификатор шаблона, определенный в AOS. | ||
| get_param_list | нет | Получить полный список поддерживаемых параметров для данного шаблона и описание этих параметров. | ||
| name | нет | Имя параметра шаблона, определенное в шаблоне дизайна AOS. Вы можете использовать параметр get_param_list, чтобы получить полный список поддерживаемых параметров для вашего шаблона. | ||
| param_map | нет | Определяет коллекцию aos-pyez, которая используется для сопоставления имени элемента, определенного пользователем, с уникальным идентификатором AOS. Например, если вызывающий предоставляет пул IP-адресов param_value с именем "Server-IpAddrs", то коллекция aos-pyez будет 'IpPools'. Некоторые param_map уже определены по умолчанию, например, logical_device_maps. | ||
| session | да | Существующая сессия AOS, полученная модулем aos_login. | ||
| state | нет | present |
| Указывает ожидаемое состояние параметра шаблона (present или not). |
| value | нет | Значение параметра шаблона. Это значение может быть преобразовано с помощью поля param_map; используется, когда параметр шаблона требует уникального идентификатора AOS. |
Примеры
- 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
Статус
Этот модуль помечен как preview, что означает, что он не гарантирует обратную совместимость интерфейса.
Для помощи в разработке модулей, если у вас есть такое желание, пожалуйста, прочтите Документацию по сообществу и участию в разработке, Тестирование Ansible и Разработка модулей.
© 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_param_module.html