Documentation
7.2 (current)
Català
Table of Contents
Objecte de tipus de suport
Els següents objectes són relacionats amb l'API mediatype.
Tipus de suport
L'objecte de tipus de suport té les propietats següents.
| Propietat | Tipus | Descripció |
|---|---|---|
| mediatypeid | ID | ID del tipus de suport. Comportament de la propietat: - només lectura - obligatori per operacions d'actualització |
| name | string | Nom del tipus de suport. Comportament de la propietat: - obligatori en operacions de creació |
| type | integer | Transport emprat pel tipus de suport. Valors possibles: 0 - correu-e; 1 - script; 2 - SMS; 4 - Webhook. Comportament de la propietat: - obligatori en operacions de creació |
| exec_path | string | Nom de l'arxiu d'script (com ara, notification.sh) que és a la carpeta especificada al paràmetre de configuració del servidor AlertScriptsPath. Comportament de la propietat: - obligatori si type és "Script" |
| gsm_modem | string | Nom del dispositiu sèrie del mòdem GSM. Comportament de la propietat: - obligatori si type és "SMS" |
| passwd | string | Mot de pas d'autenticació. Comportament de la propietat: - admès si smtp_authentication és "Paraula de pas normal" |
| provider | number | Proveïdor de correu electrònic. Valors possibles: 0 - (per defecte) SMTP genèric; 1 - Gmail; 2 - retransmissió de Gmail; 3 - Office365; 4 - retransmissió d'Office365. |
| smtp_email | string | Adreça de correu-e des de la que s'enviaran les notificacions. Comportament de la propietat: - obligatori si type és "Correu-e" |
| smtp_helo | string | SMTP HELO. Comportament de la propietat: - admès si type és "Correu-e" |
| smtp_server | string | Servidor SMTP. Comportament de la propietat: - obligatori si type és "Correu-e" |
| smtp_port | integer | Port del servidor SMTP per connectar-se. Per defecte: 25. Comportament de la propietat: - admès si type és "Correu-e" |
| smtp_security | integer | Nivell de seguretat de la connexió SMTP que cal emprar. Valors possibles: 0 - Cap; 1 - STARTTLS; 2 - SSL/TLS. Comportament de la propietat: - admès si type és "Correu-e" |
| smtp_verify_host | integer | SSL verifica l'equip per a SMTP. Valors possibles: 0 - (per defecte) No; 1 - Sí. Comportament de la propietat: - admès si smtp_security és "SSL/TLS" |
| smtp_verify_peer | integer | SSL verifica el parell per a SMTP. Valors possibles: 0 - (per defecte) No; 1 - Sí. Comportament de la propietat: - admès si smtp_security és "SSL/TLS" |
| smtp_authentication | integer | Mètode d'autenticació SMTP que cal emprar. Valors possibles: 0 - (per defecte) Cap; 1 - Mot de pas normal. Comportament de la propietat: - admès si type és "Correu-e" |
| status | integer | Si el tipus de suport és habilitat. Valors possibles: 0 - (per defecte) activat; 1 - desactivat. |
| username | string | Nom d'usuari. Comportament de la propietat: - admès si smtp_authentication és "Paraula de pas normal" |
| maxsessions | integer | El nombre màxim d'alertes que es poden processar en paral·lel. Valors possibles si type és "SMS": 1.Valors possibles si type és "Correu-e", "Script" o "Webhook": 0-100.Valor per defecte: 1. |
| maxattempts | integer | El nombre màxim d'intents per enviar una alerta. Valors possibles: 1-100 Valor per defecte: 3 |
| attempt_interval | string | L'interval de reintent. Accepta segons i unitat de temps amb sufix. Valors possibles: 0-1h Valor per defecte: 10s |
| message_format | integer | Format del missatge. Valors possibles: 0 - text pla; 1 - (per defecte) html. Comportament de la propietat: - admès si type és "Correu-e" |
| script | text | Cos de JavaScript de l'script del tipus de suport webhook. Comportament de la propietat: - obligatori si type és "Webhook" |
| timeout | string | Temps d'espera de l'script del tipus de suport Webhook. Accepta segons i unitat de temps amb sufix. Valors possibles: 1-60s Valor per defecte: 30s. Comportament de la propietat: - obligatori si type és "Webhook" |
| process_tags | integer | Defineix si la resposta de l'script webhook s'ha d'interpretar com a etiquetes i aquestes etiquetes s'han d'afegir a l'esdeveniment associat. Valors possibles: 0 - (per defecte) Ignora la resposta de l'script webhook. 1 - Tracta la resposta de l'script webhook com a etiquetes. Comportament de la propietat: - obligatori si type és "Webhook" |
| show_event_menu | enteger | Inclou una entrada al menú d'esdeveniment que enllaça amb un URL personalitzat. També afegeix la propietat urls a la sortida de problem.get i event.get.Valors possibles: 0 - (per defecte) No inclogui l'entrada del menú d'esdeveniments ni la propietat brls i l'esdeveniment ; propietat.types'estableix en "Webhook"| |event\_menu\_url|string|URL utilitzat a l'entrada [event menu](/manual/web_interface/menu/event_menu) i a la propietaturlsretornada per [problem.get](/manual/api/reference/problem/get) i [event.get](/manual/api/getReference).show_event_menuestà establert a "Inclou l'entrada del menú d'esdeveniments i la propietaturls"| |event\_menu\_name|string|Nom utilitzat per a l'entrada [event menu](/manual/web_interface/menu/event_menu) i a la propietaturlsretornada per [problem.get](/manual/api/reference/problem/get) i [event.get](/manual/api/getReference).show_event_menuestà establert a "Inclou l'entrada del menú d'esdeveniments i la propietaturls"| |parameters|array|Matriu de [paràmetres d'entrada del webhook](#webhook-parameters) o de l'[script](#script-parameters).type` s'estableix en "Webhook" |
| description | string | Descripció del tipus de suport. |
Paràmetres Webhook
Els paràmetres webhook tenen les propietats següents.
| Propietat | Tipus | Descripció |
|---|---|---|
| name | string | Nom del paràmetre. Comportament de la propietat: - obligatori |
| value | string | Valor del paràmetre, admet macros. Admet les macros descrites a la pàgina de macros admeses. |
Paràmetres d'scripts
Els paràmetres d'script tenen les propietats següents.
| Propietat | Tipus | Descripció |
|---|---|---|
| sortorder | L'ordre en que els valors dels paràmetres es passaran a l'script com a arguments de línia de comandes. Comença amb un 0 per al primer. Comportament de la propietat: - obligatori |
|value|cadena|Valor del paràmetre. Admet macros.
Admet les macros descrites a la pàgina de macros admeses.|
Plantilla de missatge
L'objecte defineix una plantilla que s'emprarà com a missatge predeterminat per a les operacions d'acció per enviar una notificació. Té les següents propietats.
| Propietat | Tipus | Descripció |
|---|---|---|
| eventsource | integer | Font de l'esdeveniment. Valors possibles: 0 - Triggers; 1 - Descoberta; 2 - Enregistrament automàtic;< br>3 - Intern; 4 - Serveis. Comportament de la propietat: - obligatori |
| recovery | integer | Mode d'operació. Valors possibles: 0 - Operacions; 1 - Operacions de recuperació; 2 - Operacions d'actualització. Comportament de la propietat: - obligatori |
| subject | string | Assumpte del missatge. |
| message | string | Text del missatge. |