Модуль cisco.meraki.meraki_webhook — Управление веб-хуками, настроенными в облаке Meraki

Примечание

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

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

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

Чтобы использовать его в playbook, укажите: cisco.meraki.meraki_webhook.

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

УСТЕРЕКШЕЕ

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

Описание

Настройка и запрос информации о веб-хуках в облаке Meraki.

Параметры

Параметр	Комментарии
auth_key string / required	Ключ аутентификации, предоставленный панелью управления. Требуется, если переменная среды `MERAKI_KEY` не установлена.
host string	Имя хоста для панели управления Meraki. Может использоваться для доступа к региональным средам Meraki, таким как Китай. По умолчанию: `"api.meraki.com"`
internal_error_retry_time integer	Количество секунд для повторной попытки, если сервер возвращает внутреннюю ошибку сервера. По умолчанию: `60`
name string	Имя вебхука.
net_id string	Идентификатор сети, к которой применяется конфигурация.
net_name aliases: network 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"` ← (по умолчанию)
payload_template_id string	Идентификатор шаблона полезной нагрузки. Перезаписывает payload_template_name, если также передан.
payload_template_name string	Имя шаблона полезной нагрузки
rate_limit_retry_time integer	Количество секунд для повторной попытки, если срабатывает ограничитель скорости. По умолчанию: `165`
shared_secret string	Секретный пароль для доступа к вебхуку.
state string	Указывает, следует ли запрашивать, создавать/изменять или удалять объект. Варианты: `"absent"` `"present"` `"query"` ← (по умолчанию)
test string	Указывает, следует ли тестировать или запрашивать состояние. Варианты: `"test"`
test_id string	Идентификатор запроса теста вебхука.
timeout integer	Время ожидания для HTTP-запросов. По умолчанию: `30`
url string	URL для доступа при вызове вебхука.
use_https boolean	Если `no`, будет использоваться HTTP. В противном случае будет использоваться HTTPS. Полезно только для внутренних разработчиков Meraki. Варианты: `false` `true` ← (по умолчанию)
use_proxy boolean	Если `no`, прокси использоваться не будет, даже если он определен в переменной среды на целевых хостах. Варианты: `false` ← (по умолчанию) `true`

validate_certs boolean	Проверка сертификатов HTTP. Варианты: `false` `true` ← (по умолчанию)
webhook_id string	Уникальный идентификатор вебхука.

Примечания

Примечание

Некоторые параметры, вероятно, используются только разработчиками 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: Create webhook
  meraki_webhook:
    auth_key: abc123
    state: present
    org_name: YourOrg
    net_name: YourNet
    name: Test_Hook
    url: https://webhook.url/
    shared_secret: shhhdonttellanyone
    payload_template_name: 'Slack (included)'
  delegate_to: localhost

- name: Query one webhook
  meraki_webhook:
    auth_key: abc123
    state: query
    org_name: YourOrg
    net_name: YourNet
    name: Test_Hook
  delegate_to: localhost

- name: Query all webhooks
  meraki_webhook:
    auth_key: abc123
    state: query
    org_name: YourOrg
    net_name: YourNet
  delegate_to: localhost

- name: Delete webhook
  meraki_webhook:
    auth_key: abc123
    state: absent
    org_name: YourOrg
    net_name: YourNet
    name: Test_Hook
  delegate_to: localhost

- name: Test webhook
  meraki_webhook:
    auth_key: abc123
    state: present
    org_name: YourOrg
    net_name: YourNet
    test: test
    url: https://webhook.url/abc123
  delegate_to: localhost

- name: Get webhook status
  meraki_webhook:
    auth_key: abc123
    state: present
    org_name: YourOrg
    net_name: YourNet
    test: status
    test_id: abc123531234
  delegate_to: localhost

Значения возврата

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

Ключ	Описание
data complex	Список администраторов. Возвращается: success
id string	Уникальный идентификатор вебхука. Возвращается: success Пример: `"aHR0cHM6Ly93ZWJob22LnvpdGUvOGViNWI3NmYtYjE2Ny00Y2I4LTlmYzQtND32Mj3F5NzIaMjQ0"`
name string	Дескриптивное имя вебхука. Возвращается: success Пример: `"Test_Hook"`
networkId string	Идентификатор сети, содержащей объект вебхука. Возвращается: success Пример: `"N_12345"`
payloadTemplate string	Шаблон полезной нагрузки, используемый при отправке данных на HTTP-сервер. Возвращается: success Пример: `"{'name': 'Meraki (included)', 'payloadTemplateId': 'wpt_00001'}"`
shared_secret string	Пароль для вебхука. Возвращается: success Пример: `"VALUE_SPECIFIED_IN_NO_LOG_PARAMETER"`
status string	Статус теста вебхука. Возвращается: success, при тестировании вебхука Пример: `"enqueued"`
url string	URL конечной точки вебхука. Возвращается: success Пример: `"https://webhook.url/abc123"`

Статус

Этот модуль будет удален в версии 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_webhook_module.html