Spec-Zone.ru › Ansible

Модуль cisco.dnac.event_webhook_update – Модуль ресурса для обновления веб-хука события

Примечание

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

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

Чтобы установить её, используйте: ansible-galaxy collection install cisco.dnac. Для использования этого модуля необходимы дополнительные требования, см. Требования для получения подробной информации.

Чтобы использовать его в плейбуке, укажите: cisco.dnac.event_webhook_update.

Новое в cisco.dnac 6.0.0

  • Описание
  • Требования
  • Параметры
  • Примечания
  • См. также
  • Примеры
  • Возвращаемые значения

Описание

  • Управление обновлением операции ресурса "Обновление веб-хука события".
  • Обновление пункта назначения веб-хука.

Примечание

Этот модуль имеет соответствующий плагин действия.

Требования

Ниже перечислены требования, необходимые на хосте, на котором выполняется этот модуль.

  • dnacentersdk >= 2.7.2
  • python >= 3.5

Параметры

Параметр

Комментарии

description

строка

Описание.

dnac_debug

логический

Флаг для Cisco DNA Center SDK для включения отладки.

Варианты:

  • false ← (по умолчанию)
  • true

dnac_host

строка / обязательно

Имя хоста Cisco DNA Center.

dnac_password

строка

Пароль Cisco DNA Center для аутентификации.

dnac_port

целое число

Порт Cisco DNA Center.

По умолчанию: 443

dnac_username

псевдонимы: user

строка

Имя пользователя Cisco DNA Center для аутентификации.

По умолчанию: "admin"

dnac_verify

логический

Флаг для включения или выключения проверки сертификата SSL.

Варианты:

  • false
  • true ← (по умолчанию)

dnac_version

строка

Уведомляет SDK, какую версию Cisco DNA Center использовать.

По умолчанию: "2.3.7.6"

headers

список / элементы=словарь

Заголовки Event Webhook Update.

defaultValue

строка

Значение по умолчанию.

encrypt

логический

Зашифровать.

Варианты:

  • false
  • true

name

строка

Имя.

value

строка

Значение.

isProxyRoute

логический

Является ли прокси-маршрутом.

Варианты:

  • false
  • true

method

строка

Метод.

name

строка

Имя.

trustCert

логический

Доверие сертификату.

Варианты:

  • false
  • true

url

строка

Url.

validate_response_schema

логический

Флаг для Cisco DNA Center SDK для включения проверки тел запросов по схеме JSON.

Варианты:

  • false
  • true ← (по умолчанию)

webhookId

строка

Требуется только для обновления конфигурации веб-хука.

Примечания

Примечание

  • Используемые методы SDK — event_management.EventManagement.update_webhook_destination,
  • Используемые пути — put /dna/intent/api/v1/event/webhook,
  • Не поддерживает check_mode
  • Плагин работает на узле управления и не использует плагины подключения ansible, а вместо этого использует встроенный менеджер подключений из Cisco DNAC SDK
  • Параметры, начинающиеся с dnac_, используются Cisco DNAC Python SDK для установления подключения

См. также

См. также

Документация Cisco DNA Center по управлению событиями UpdateWebhookDestination

Полное описание API UpdateWebhookDestination.

Примеры

- name: Update all
  cisco.dnac.event_webhook_update:
    dnac_host: "{{dnac_host}}"
    dnac_username: "{{dnac_username}}"
    dnac_password: "{{dnac_password}}"
    dnac_verify: "{{dnac_verify}}"
    dnac_port: "{{dnac_port}}"
    dnac_version: "{{dnac_version}}"
    dnac_debug: "{{dnac_debug}}"
    description: string
    headers:
    - defaultValue: string
      encrypt: true
      name: string
      value: string
    isProxyRoute: true
    method: string
    name: string
    trustCert: true
    url: string
    webhookId: string

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

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

Ключ

Описание

dnac_response

словарь

Словарь или список с ответом, возвращенным Cisco DNAC Python SDK

Возвращается: всегда

Пример: {"apiStatus": "string", "errorMessage": {"errors": ["string"]}, "statusMessage": "string"}

Авторы

  • Rafael Campos (@racampos)

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

  • Система отслеживания ошибок
  • Репозиторий (исходные коды)

© 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/dnac/event_webhook_update_module.html

Spec-Zone.ru

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