cisco.meraki.meraki_config_template – Управление шаблонами конфигурации в облаке Meraki

Примечание

Этот плагин входит в коллекцию cisco.meraki (версия 2.2.0).

Для его установки используйте: ansible-galaxy collection install cisco.meraki.

Для использования в книге задач укажите: cisco.meraki.meraki_config_template.

Новое в версии 1.0.0: из cisco.meraki

Обзор
Параметры
Примечания
Примеры
Возвращаемые значения

Обзор

Позволяет выполнять запросы, удалять, привязывать и отвязывать шаблоны конфигурации.

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
auth_key строка / обязательно		Ключ аутентификации, предоставленный панелью управления. Требуется, если переменная среды `MERAKI_KEY` не задана.
auto_bind логическое	Варианты: нет да	Необязательное логическое значение, указывающее, следует ли коммутаторам сети автоматически привязываться к профилям одной и той же модели. Этот параметр влияет только на сети коммутаторов и шаблоны коммутаторов. Автоматическая привязка недействительна, если шаблон коммутатора не содержит хотя бы один профиль и имеет не более одного профиля на модель коммутатора.
config_template строка		Имя шаблона конфигурации в организации для управления. псевдонимы: имя
host строка	Значение по умолчанию: "api.meraki.com"	Имя хоста для панели управления Meraki. Может использоваться для доступа к региональным средам Meraki, таким как Китай.
internal_error_retry_time целое число	Значение по умолчанию: 60	Количество секунд для повторной попытки, если сервер возвращает ошибку внутреннего сервера.
net_id строка		Идентификатор сети, к которой нужно привязать или отвязать шаблон конфигурации.
net_name строка		Имя сети, к которой нужно привязать или отвязать шаблон конфигурации.
org_id строка		Идентификатор организации, связанной с шаблоном конфигурации.
org_name строка		Имя организации, содержащей шаблон конфигурации. псевдонимы: организация
output_format строка	Варианты: snakecase ← camelcase	Указывает модулю, должны ли ключи ответа быть в формате snake case (например, `net_id`) или camel case (например, `netId`).
output_level строка	Варианты: отладка обычный ←	Устанавливает уровень вывода отладки во время выполнения модуля.
rate_limit_retry_time целое число	Значение по умолчанию: 165	Количество секунд для повторной попытки, если срабатывает ограничение скорости.
state строка	Варианты: отсутствует запрос ← наличие	Указывает, должен ли запрашиваться, изменяться или удаляться шаблон конфигурации.
timeout целое число	Значение по умолчанию: 30	Время ожидания для HTTP-запросов.
use_https логическое	Варианты: нет да ←	Если `no`, будет использоваться HTTP. В противном случае будет использоваться HTTPS. Полезно только для внутренних разработчиков Meraki.
use_proxy логическое	Варианты: нет ← да	Если `no`, прокси не будет использоваться, даже если он определен в переменной среды на целевых хостах.
validate_certs логическое	Варианты: нет да ←	Подтверждать ли сертификаты HTTP.

Примечания

Примечание

Модуль не является идемпотентным, так как API Meraki ограничен в предоставлении информации о шаблонах конфигурации.
API Meraki не поддерживает создание новых шаблонов конфигурации.
Чтобы использовать шаблон конфигурации, просто передайте его идентификатор через параметры net_id в модулях Meraki.
Дополнительную информацию об API Meraki можно найти на https://dashboard.meraki.com/api_docs.
Некоторые из этих параметров, вероятно, используются только разработчиками Meraki.
Начиная с Ansible 2.9, модули Meraki выводят ключи в формате snake case. Для использования camel case, установите переменную среды ANSIBLE_MERAKI_FORMAT в camelcase.
Модули Meraki Ansible перестанут поддерживать вывод в формате camel case в Ansible 2.13. Пожалуйста, обновите свои книги задач.
Режим проверки загружает текущую конфигурацию с панели управления, затем сравнивает изменения с этой загрузкой. Режим проверки сообщит о внесенных изменениях, если есть различия в конфигурациях, но не отправляет изменения в API для проверки изменений.

Примеры

- name: Query configuration templates
  meraki_config_template:
    auth_key: abc12345
    org_name: YourOrg
    state: query
  delegate_to: localhost

- name: Bind a template from a network
  meraki_config_template:
    auth_key: abc123
    state: present
    org_name: YourOrg
    net_name: YourNet
    config_template: DevConfigTemplate
  delegate_to: localhost

- name: Unbind a template from a network
  meraki_config_template:
    auth_key: abc123
    state: absent
    org_name: YourOrg
    net_name: YourNet
    config_template: DevConfigTemplate
  delegate_to: localhost

- name: Delete a configuration template
  meraki_config_template:
    auth_key: abc123
    state: absent
    org_name: YourOrg
    config_template: DevConfigTemplate
  delegate_to: localhost

Возвращаемые значения

Общие возвращаемые значения документированы здесь, следующие поля уникальны для этого модуля:

Ключ		Возвращаемое значение	Описание
data сложное		успех	Информация о запрошенном объекте.
	id целое число	успех	Уникальный идентификационный номер организации. Пример: L_2930418
	name строка	успех	Имя шаблона конфигурации. Пример: ВашШаблон
	product_types список / элементы=строка	успех	Список продуктов, которые могут существовать в сети. Пример: ['приложение', 'коммутатор']
	time_zone строка	успех	Часовой пояс, применяемый к каждой связанной сети. Пример: America/Chicago

Авторы

Kevin Breit (@kbreit)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/cisco/meraki/meraki_config_template_module.html