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

Примечание

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

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

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

Чтобы использовать коллекцию в плейбуке, укажите: community.general.cisco_webex.

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

Краткое описание

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

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

Параметры

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

Атрибуты

Атрибут	Поддержка	Описание
check_mode	Поддержка: полная	Может выполняться в режиме `check_mode` и возвращать прогноз статуса изменений без внесения изменений в целевую систему.
diff_mode	Поддержка: нет	В режиме diff возвращает сведения об изменениях (или о том, что может потребоваться изменить в `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 string	Ответное сообщение, возвращаемое API Webex Teams. Полные пояснения к кодам ответа можно найти по адресу https://developer.webex.com/docs/api/basics. Возвращается: всегда Пример: `"OK (585 bytes)"`
status_code integer	Код ответа, возвращаемый API Webex Teams. Полные пояснения к кодам ответа можно найти по адресу https://developer.webex.com/docs/api/basics. Возвращается: всегда Пример: `200`

Авторы

Drew Rusell (@drew-russell)

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

© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/community/general/cisco_webex_module.html