Модуль community.general.cisco_webex — Отправка сообщения в комнату или к пользователю Cisco Webex Teams

Примечание

Этот модуль входит в коллекцию community.general (версия 9.5.0).

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

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

Для использования в книге задач укажите: community.general.cisco_webex.

Описание
Параметры
Атрибуты
Примечания
Примеры
Возвращаемые значения

Описание

Отправка сообщения в комнату или к пользователю Cisco Webex Teams с возможностью управления форматированием.

Псевдонимы: cisco_spark

Параметры

Параметр	Комментарии
msg строка / обязательно	Текст сообщения, которое требуется отправить.
msg_type псевдонимы: message_type строка	Указывает, как форматировать сообщение. Варианты: `"text"` ← (по умолчанию) `"markdown"`
personal_token псевдонимы: token строка / обязательно	Ваш личный токен доступа, необходимый для проверки API Webex Teams.
recipient_id строка / обязательно	Уникальный идентификатор, связанный с предоставленным `recipient_type`.
recipient_type строка / обязательно	Параметр запроса, которому нужно отправить сообщение. Сообщения можно отправлять в комнату или к пользователю (по ID или электронной почте). Варианты: `"roomId"` `"toPersonEmail"` `"toPersonId"`

Атрибуты

Атрибут	Поддержка	Описание
check_mode	Поддержка: полная	Может работать в режиме `check_mode` и возвращать прогноз о состоянии изменений без модификации целевого объекта.
diff_mode	Поддержка: отсутствует	Вернёт сведения о том, что изменилось (или, возможно, что нужно изменить в `check_mode`), в режиме сравнения.

Примечания

Примечание

Токен recipient_type должен быть валидным для предоставленного recipient_id.
Полная документация API доступна по адресу https://developer.webex.com/docs/api/basics.

Примеры

# Note: The following examples assume a variable file has been imported
# that contains the appropriate information.

- name: Cisco Webex Teams - Markdown Message to a Room
  community.general.cisco_webex:
    recipient_type: roomId
    recipient_id: "{{ room_id }}"
    msg_type: markdown
    personal_token: "{{ token }}"
    msg: "**Cisco Webex Teams Ansible Module - Room Message in Markdown**"

- name: Cisco Webex Teams - Text Message to a Room
  community.general.cisco_webex:
    recipient_type: roomId
    recipient_id: "{{ room_id }}"
    msg_type: text
    personal_token: "{{ token }}"
    msg: "Cisco Webex Teams Ansible Module - Room Message in Text"

- name: Cisco Webex Teams - Text Message by an Individuals ID
  community.general.cisco_webex:
    recipient_type: toPersonId
    recipient_id: "{{ person_id}}"
    msg_type: text
    personal_token: "{{ token }}"
    msg: "Cisco Webex Teams Ansible Module - Text Message to Individual by ID"

- name: Cisco Webex Teams - Text Message by an Individuals E-Mail Address
  community.general.cisco_webex:
    recipient_type: toPersonEmail
    recipient_id: "{{ person_email }}"
    msg_type: text
    personal_token: "{{ token }}"
    msg: "Cisco Webex Teams Ansible Module - Text Message to Individual by E-Mail"

Возвращаемые значения

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

Ключ	Описание
message строка	Сообщение ответа, возвращённое API Webex Teams. Полные объяснения кода ответа можно найти по адресу https://developer.webex.com/docs/api/basics. Возвращается: всегда Пример: `"OK (585 bytes)"`
status_code целое число	Код ответа, возвращённый API Webex Teams. Полные объяснения кода ответа можно найти по адресу https://developer.webex.com/docs/api/basics. Возвращается: всегда Пример: `200`

Авторы

Drew Rusell (@drew-russell)

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

© 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/community/general/cisco_webex_module.html