Spec-Zone.ru › Ansible 2.9

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

Новое в версии 2.7.

  • Обзор
  • Параметры
  • Примечания
  • Примеры
  • Значения возврата
  • Статус

Обзор

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

Параметры

Параметр Варианты/Значения по умолчанию Комментарии
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
строка
    Варианты:
  • debug
  • normal ←
Устанавливает объем отладочного вывода во время выполнения модуля.
rate_limit_retry_time
целое число
Значение по умолчанию:
165
Количество секунд для повторной попытки, если срабатывает ограничитель скорости.
state
-
    Варианты:
  • absent
  • query ←
  • present
Указывает, нужно ли запросить информацию о шаблоне конфигурации, изменить его или удалить.
timeout
целое число
Значение по умолчанию:
30
Время ожидания для HTTP-запросов.
use_https
логическое значение
    Варианты:
  • нет
  • да ←
Если no, будет использоваться HTTP. В противном случае будет использоваться HTTPS.
Полезно только для внутренних разработчиков Meraki.
use_proxy
логическое значение
    Варианты:
  • нет
  • да
Если no, прокси не будет использоваться, даже если он определен в переменной среды на целевых хостах.
validate_certs
логическое значение
    Варианты:
  • нет
  • да ←
Выполнять ли проверку сертификатов 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. Пожалуйста, обновите ваши playbook'ы.

Примеры

- 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


Статус

  • Этот модуль не гарантирует обратной совместимости. [превью]
  • Этот модуль поддерживается сообществом Ansible. [сообщество]

Авторы

  • 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.9/modules/meraki_config_template_module.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API