Модуль cisco.meraki.meraki_config_template — управление шаблонами конфигурации в облаке Meraki

Примечание

Этот модуль входит в коллекцию cisco.meraki (версия 2.23.2).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.

Чтобы установить её, используйте: ansible-galaxy collection install cisco.meraki.

Чтобы использовать её в плейбуке, укажите: cisco.meraki.meraki_config_template.

Добавлено в cisco.meraki 1.0.0

УСТАРЕЛО
Краткое описание
Параметры
Примечания
Примеры
Возвращаемые значения
Статус

УСТАРЕЛО

Удаление:: версия 3.0.0
Причина:: Выпущены обновлённые модули с расширенными возможностями
Альтернатива:: cisco.meraki.organizations_config_templates

Краткое описание

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

Параметры

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

Примечания

Примечание

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

Статус

Этот модуль будет удалён в версии 3.0.0. [устарело]
Дополнительные сведения см. в разделе УСТАРЕЛО.

Авторы

Kevin Breit (@kbreit)

Ссылки на коллекцию

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