Slack

4 min

Resumo

O módulo slack envia notificações para http://slack.com por meio da integração de um Incoming WebHook

Parâmetros

Parâmetro	Tipo	Escolhas \| Valor Padrão	Comentários
attachments	list / elements=dictionary		Defina uma lista de anexos. Esta lista reflete a API Slack JSON.Para obter mais informações, consulte https://api.slack.com/docs/attachments .
blocks	list / elements=dictionary		Defina uma lista de blocos. Esta lista reflete a API Slack JSON.Para obter mais informações, consulte https://api.slack.com/block-kit .
channel	string		Canal para o qual enviar a mensagem. Se ausente, a mensagem vai para o canal selecionado para o token .
color	string	Default: - "normal"	Permitir que o texto use cores padrão - use o padrão de 'normal' para não enviar uma barra de cores personalizada no início da mensagem.Os valores permitidos para a cor podem ser 'normal', 'bom', 'aviso', 'perigo', qualquer valor de cor hexadecimal de 3 ou 6 dígitos válido.
domain	string		Slack (sub) domínio para seu ambiente sem protocolo.
icon_emoji	string		Emoji para o remetente da mensagem. Veja a documentação do Slack para opções. (se icon_emoji estiver definido, icon_url não será usado)
icon_url	string	Default: -"https://www.atmosphere.com/favicon.ico"	Url para o ícone do remetente da mensagem.
link_names	integer	Escolhas: - 1(default) - 0	Crie automaticamente links para canais e nomes de usuário na mensagem .
message_id	string		Opcional. ID da mensagem para editar, em vez de postar uma nova mensagem. Corresponde a tsna API Slack ( https://api.slack.com/messaging/modifying ).
msg	string		Mensagem para enviar. Observe que o módulo não lida com caracteres de escape. Os colchetes angulares de texto simples e e comerciais devem ser convertidos em entidades HTML (por exemplo, & para & amp;) antes do envio. Veja a documentação do Slack ( https://api.slack.com/docs/message-formatting ) para mais.
parse	string	Escolhas: - full - none	Configuração do analisador de mensagens no Slack
thread_id	string		Opcional. Carimbo de data / hora da mensagem pai para encadear esta mensagem https://api.slack.com/docs/message-threading
token - required	string		Token de integração do Slack. Certifique-se de usar o tipo correto de token, dependendo do método usado. O Atmosphere não tem controle de quando o slack se livrará da API antiga. Lembre-se de que os tokens não são tokens de API, mas sim tokens de webhook. São encontrados na URL do webhook que são obtidos nos aplicativos e integrações. Os webhooks de entrada podem ser adicionados nessa área. Em alguns casos, isso pode ser bloqueado pelo administrador do Slack e você deve solicitar acesso. É lá que os webhooks de entrada podem ser adicionados. A chave está no final do URL fornecido a você nessa seção.Token WebAPI: o Slack WebAPI requer um token pessoal, de bot ou de aplicativo de trabalho.
username	string	Default: - "Atmosphere"	Este é o remetente da mensagem.
validate_certs	boolean	Escolhas: - yes (default) - no	Se no, os certificados SSL não serão validados. Isso só deve ser usado em sites controlados pessoalmente por meio de certificados autoassinados.

Exemplos

# Enviar mensagem de notificação via Slack
  slack:
    token: thetoken/generatedby/slack
    msg: '{{ inventory_hostname }} completed'
  delegate_to: localhost

# Enviar mensagem de notificação via Slack todas as opções
  slack:
    token: thetoken/generatedby/slack
    msg: '{{ inventory_hostname }} completed'
    channel: '#atmosphere'
    thread_id: '1539917263.000100'
    username: 'atmosphere on {{ inventory_hostname }}'
    icon_url: http://www.example.com/some-image-file.png
    link_names: 0
    parse: 'none'
  delegate_to: localhost

# Insira uma barra de cores na frente da mensagem para fins de visibilidade e use o ícone e nome do webhook padrão configurado no Slack
  slack:
    token: thetoken/generatedby/slack
    msg: '{{ inventory_hostname }} is alive!'
    color: good
    username: ''
    icon_url: ''

# Insira uma barra de cores na frente da mensagem com um valor de cor hexadecimal válido
  slack:
    token: thetoken/generatedby/slack
    msg: 'This message uses color in hex value'
    color: '#00aacc'
    username: ''
    icon_url: ''

# Use a API de anexos
  slack:
    token: thetoken/generatedby/slack
    attachments:
      - text: Display my system load on host A and B
        color: '#ff00dd'
        title: System load
        fields:
          - title: System A
            value: "load average: 0,74, 0,66, 0,63"
            short: True
          - title: System B
            value: 'load average: 5,16, 4,64, 2,43'
            short: True

# Use a API de blocos
  slack:
    token: thetoken/generatedby/slack
    blocks:
      - type: section
        text:
          type: mrkdwn
          text: |-
            *System load*
            Display my system load on host A and B
      - type: context
        elements:
        - type: mrkdwn
          text: |-
            *System A*
            load average: 0,74, 0,66, 0,63
        - type: mrkdwn
          text: |-
            *System B*
            load average: 5,16, 4,64, 2,43

# Envie uma mensagem com um link usando a marcação do Slack
  slack:
    token: thetoken/generatedby/slack
    msg: We sent this message using <https://www.atmosphere.com|atmosphere>!

# Envie uma mensagem com colchetes angulares e e comercial
  slack:
    token: thetoken/generatedby/slack
    msg: This message has &lt;brackets&gt; &amp; ampersands in plain text.

# Mensagem inicial do Slack encadeada
  slack:
    channel: '#atmosphere'
    token: xoxb-1234-56789abcdefghijklmnop
    msg: 'Starting a thread with my initial post.'
# Adicione mais informações ao tópico
  slack:
    channel: '#atmosphere'
    token: xoxb-1234-56789abcdefghijklmnop
    thread_id: "{{ slack_response['ts'] }}"
    color: good
    msg: 'And this is my threaded response!'

# Envie uma mensagem para ser editada mais tarde
  slack:
    token: thetoken/generatedby/slack
    channel: '#atmosphere'
    msg: Deploying something...
  register: slack_response
# Editar mensagem
  slack:
    token: thetoken/generatedby/slack
    channel: "{{ slack_response.channel }}"
    msg: Deployment complete!
    message_id: "{{ slack_response.ts }}"

Valores retornados

Parâmetro	Tipo	Retornado quando	Comentários
status	string	Sempre	Retorno da API
message	string	Sucesso	Mensagem de sucesso