aos_blueprint_param - Управление параметрами шаблона AOS
Новое в версии 2.3.
УСТАРЕВШИЙ
| Удалено в Ansible: | |
|---|---|
| версия: 2.9 | |
| Почему: | Этот модуль не поддерживает AOS 2.1 и более поздние версии |
| Альтернатива: | См. новые модули по адресу https://www.ansible.com/ansible-apstra. |
Обзор
- Модуль параметров шаблона Apstra AOS позволяет легко управлять параметрами шаблона. Вы можете создавать, определять и удалять параметры шаблона. Список поддерживаемых параметров отличается для каждого шаблона. Параметр 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 или absent). |
| 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
Статус
Этот модуль помечен как устаревший и будет удален в версии 2.9. Дополнительную информацию см. в разделе УСТАРЕВШИЙ.
Автор
- jeremy@apstra.com (@jeremyschulman)
Подсказка
Если вы заметили какие-либо проблемы в этом руководстве, вы можете отредактировать этот документ, чтобы улучшить его.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.6/modules/aos_blueprint_param_module.html
