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

Примечание

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

Примечания

Примечание

Модуль не является идемпотентным, так как 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. Пожалуйста, обновите свои playbook.
Режим проверки загружает текущую конфигурацию с панели управления, а затем сравнивает изменения с этой загрузкой. Режим проверки сообщит о изменениях, если есть различия в конфигурациях, но не отправляет изменения в 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–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/cisco/meraki/meraki_config_template_module.html