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

Примечание

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

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

Чтобы использовать его в книге задач, укажите: cisco.meraki.meraki_config_template.

Добавлено в версии 1.0.0: модуля cisco.meraki

Описание
Параметры
Примечания
Примеры
Значения возврата

Описание

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

Параметры

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

Примечания

Примечание

Модуль не идемпотентный, так как API Meraki ограничен в предоставлении информации о шаблонах конфигурации.
API Meraki не поддерживает создание новых шаблонов конфигурации.
Для использования шаблона конфигурации просто передайте его ID через параметры 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 строка	успех	Название шаблона конфигурации. Пример: YourTemplate
	product_types список / элементы=строка	успех	Список продуктов, которые могут существовать в сети. Пример: ['appliance', 'switch']
	time_zone строка	успех	Часовой пояс, примененный к каждой связанной сети. Пример: America/Chicago

Авторы

Kevin Breit (@kbreit)

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