Documentation
Table of Contents
Objeto media type
Os seguintes objetos estão diretamente relacionados à API mediatype.
Tipo de mídia
O objeto tipo de mídia possui as seguintes propriedades.
| Propriedade | Tipo | Descrição |
|---|---|---|
| mediatypeid | ID | ID do tipo de mídia. Comportamento da propriedade: - somente leitura - obrigatório para operações de atualização |
| name | string | Nome do tipo de mídia. Comportamento da propriedade: - obrigatório para operações de criação |
| type | integer | Transporte utilizado pelo tipo de mídia. Valores possíveis: 0 - E-mail; 1 - Script; 2 - SMS; 4 - Webhook. Comportamento da propriedade: - obrigatório para operações de criação |
| exec_path | string | Nome do arquivo de script (por exemplo, notification.sh) que está localizado no diretório especificado no parâmetro de configuração do servidor AlertScriptsPath. Comportamento da propriedade: - obrigatório se type estiver definido como "Script" |
| gsm_modem | string | Nome do dispositivo serial do modem GSM. Comportamento da propriedade: - obrigatório se type estiver definido como "SMS" |
| passwd | string | Senha de autenticação. Comportamento da propriedade: - suportado se smtp_authentication estiver definido como "Senha normal" |
| provider | integer | Provedor de e-mail. Valores possíveis: 0 - (padrão) SMTP genérico; 1 - Gmail; 2 - Gmail relay; 3 - Office365; 4 - Office365 relay. |
| smtp_email | string | Endereço de e-mail a partir do qual as notificações serão enviadas. Comportamento da propriedade: - obrigatório se type estiver definido como "E-mail" |
| smtp_helo | string | SMTP HELO. Comportamento da propriedade: - suportado se type estiver definido como "E-mail" |
| smtp_server | string | Servidor SMTP. Comportamento da propriedade: - obrigatório se type estiver definido como "E-mail" |
| smtp_port | integer | Porta do servidor SMTP para conectar. Padrão: 25. Comportamento da propriedade: - suportado se type estiver definido como "E-mail" |
| smtp_security | integer | Nível de segurança da conexão SMTP a ser usado. Valores possíveis: 0 - (padrão) Nenhum; 1 - STARTTLS; 2 - SSL/TLS. Comportamento da propriedade: - suportado se type estiver definido como "E-mail" |
| smtp_verify_host | integer | Verificar host SSL para SMTP. Valores possíveis: 0 - (padrão) Não; 1 - Sim. Comportamento da propriedade: - suportado se smtp_security estiver definido como "STARTTLS" ou "SSL/TLS" |
| smtp_verify_peer | integer | Verificar peer SSL para SMTP. Valores possíveis: 0 - (padrão) Não; 1 - Sim. Comportamento da propriedade: - suportado se smtp_security estiver definido como "STARTTLS" ou "SSL/TLS" |
| smtp_authentication | integer | Método de autenticação SMTP a ser usado. Valores possíveis: 0 - (padrão) Nenhum; 1 - Senha normal. Comportamento da propriedade: - suportado se type estiver definido como "E-mail" |
| status | integer | Se o tipo de mídia está habilitado. Valores possíveis: 0 - (padrão) Habilitado; 1 - Desabilitado. |
| username | string | Nome de usuário. Comportamento da propriedade: - suportado se smtp_authentication estiver definido como "Senha normal" |
| maxsessions | integer | O número máximo de alertas que podem ser processados em paralelo. Valores possíveis se type estiver definido como "SMS": 1.Valores possíveis se type estiver definido como "E-mail", "Script" ou "Webhook": 0-100.Padrão: 1. |
| maxattempts | integer | O número máximo de tentativas de envio de um alerta. Valores possíveis: 1-100. Padrão: 3. |
| attempt_interval | string | O intervalo entre as tentativas de reenvio. Aceita segundos e unidade de tempo com sufixo. Valores possíveis: 0-1h. Padrão: 10s. |
| content_type (obsoleto) |
integer | Este parâmetro está obsoleto, por favor use message_format em seu lugar.Formato da mensagem. Valores possíveis: 0 - Texto simples; 1 - (padrão) HTML. Comportamento da propriedade: - suportado se type estiver definido como "E-mail" |
| message_format | integer | Formato da mensagem. Valores possíveis: 0 - Texto simples; 1 - (padrão) HTML. Comportamento da propriedade: - suportado se type estiver definido como "E-mail" |
| script | text | Corpo do script do webhook (JavaScript). Comportamento da propriedade: - obrigatório se type estiver definido como "Webhook" |
| timeout | string | Timeout do script do webhook. Aceita segundos e unidade de tempo com sufixo. Valores possíveis: 1-60s. Padrão: 30s. Comportamento da propriedade: - suportado se type estiver definido como "Webhook" |
| process_tags | integer | Processar valores de propriedades JSON na resposta do script do webhook como tags. Essas tags são adicionadas a quaisquer tags de problema existentes. Valores possíveis: 0 - (padrão) Ignorar resposta do script do webhook; 1 - Processar resposta do script do webhook como tags. Comportamento da propriedade: - suportado se type estiver definido como "Webhook" |
| show_event_menu | integer | Inclui uma entrada no menu de evento que vincula a uma URL personalizada. Também adiciona a propriedade urls à saída de problem.get e event.get.Valores possíveis: 0 - (padrão) Não incluir entrada no menu de evento ou propriedade urls;1 - Incluir entrada no menu de evento e propriedade urls.Comportamento da propriedade: - suportado se type estiver definido como "Webhook" |
| event_menu_url | string | URL usada na entrada do menu de evento e na propriedade urls retornada por problem.get e event.get.Comportamento da propriedade: - suportado se show_event_menu estiver definido como "Incluir entrada no menu de evento e propriedade urls" |
| event_menu_name | string | Nome usado para a entrada do menu de evento e na propriedade urls retornada por problem.get e event.get.Comportamento da propriedade: - suportado se show_event_menu estiver definido como "Incluir entrada no menu de evento e propriedade urls" |
| parameters | array | Parâmetros de webhook ou script. Comportamento da propriedade: - suportado se type estiver definido como "Webhook" ou "Script" |
| description | text | Descrição do tipo de mídia. |
Parâmetros do webhook
Os parâmetros do webhook possuem as seguintes propriedades.
| Propriedade | Tipo | Descrição |
|---|---|---|
| name | string | Nome do parâmetro. Comportamento da propriedade: - obrigatório |
| value | string | Valor do parâmetro, suporta macros. As macros suportadas estão descritas na página Macros suportadas. |
Parâmetros do script
Os parâmetros do script possuem as seguintes propriedades.
| Propriedade | Tipo | Descrição |
|---|---|---|
| sortorder | integer | A ordem em que os valores dos parâmetros serão passados para o script como argumentos de linha de comando, começando com 0 como o primeiro. Comportamento da propriedade: - obrigatório |
| value | string | Valor do parâmetro, suporta macros. As macros suportadas estão descritas na página Macros suportadas. |
Modelo de mensagem
O objeto de modelo de mensagem define um modelo que será usado como mensagem padrão para operações de ação para enviar uma notificação. Ele possui as seguintes propriedades.
| Propriedade | Tipo | Descrição |
|---|---|---|
| eventsource | integer | Fonte do evento. Valores possíveis: 0 - Triggers; 1 - Descoberta; 2 - Autoregistro; 3 - Interno; 4 - Serviços. Comportamento da propriedade: - obrigatório |
| recovery | integer | Modo de operação. Valores possíveis: 0 - Operações; 1 - Operações de recuperação; 2 - Operações de atualização. Comportamento da propriedade: - obrigatório |
| subject | string | Assunto da mensagem. |
| message | string | Texto da mensagem. |