Nota

Este complemento es parte del community.general collection (versión 2.0.1).

Para instalarlo use: ansible-galaxy collection install community.general.

Para usarlo en un libro de jugadas, especifique: community.general.mattermost.

  • Sinopsis
  • Parámetros
  • Ejemplos de
  • Valores devueltos

Sinopsis

Parámetros

Parámetro Opciones / Valores predeterminados Comentarios
Clave API cuerda / requerido Clave de API de webhook de Mattermost. Inicie sesión en su sitio más importante, vaya a Menú -> Integración -> Webhook entrante -> Agregar webhook entrante. Esto le dará la URL completa. api_key es la última parte. http://mattermost.example.com/hooks/API_KEY
canal cuerda Canal al que enviar el mensaje. Si está ausente, el mensaje va al canal seleccionado para el Clave API.
icon_url cuerda Defecto:
“https://www.ansible.com/favicon.ico” 		URL del icono del remitente del mensaje.
texto cuerda / requerido Texto para enviar. Tenga en cuenta que el módulo no maneja caracteres de escape.
url cuerda / requerido URL de Mattermost (es decir, http://mattermost.yourcompany.com).
nombre de usuario cuerda Defecto:
“Ansible” 		Este es el remitente del mensaje (la anulación del nombre de usuario debe ser habilitada por el administrador de mattermost, consulte el documento de mattermost.
validate_certs booleano
    Opciones:

  • no
  • sí ←
 Si no, Los certificados SSL no se validarán. Esto solo debe usarse en sitios controlados personalmente que utilicen certificados autofirmados.

Ejemplos de

- name: Send notification message via Mattermost
  community.general.mattermost:
    url: http://mattermost.example.com
    api_key: my_api_key
    text: '{{ inventory_hostname }} completed'

- name: Send notification message via Mattermost all options
  community.general.mattermost:
    url: http://mattermost.example.com
    api_key: my_api_key
    text: '{{ inventory_hostname }} completed'
    channel: notifications
    username: 'Ansible on {{ inventory_hostname }}'
    icon_url: http://www.example.com/some-image-file.png

Valores devueltos

Los valores de retorno comunes están documentados aquí, los siguientes son los campos exclusivos de este módulo:

Llave Devuelto Descripción
carga útil cuerda éxito Carga útil Mattermost
webhook_url cuerda éxito URL a la que se envía el webhook

Autores

  • Benjamín Jolivot (@bjolivot)