Oggetto tipo di supporto

I seguenti oggetti sono direttamente correlati all'API mediatype.

Tipo di media

L'oggetto tipo di media presenta le seguenti proprietà.

Proprietà Tipo Descrizione
mediatypeid ID ID del tipo di media.

Comportamento della proprietà:
- sola lettura
- obbligatoria per le operazioni di aggiornamento
name string Nome del tipo di media.

Comportamento della proprietà:
- obbligatoria per le operazioni di creazione
type integer Trasporto utilizzato dal tipo di media.

Valori possibili:
0 - Email;
1 - Script;
2 - SMS;
4 - Webhook.

Comportamento della proprietà:
- obbligatoria per le operazioni di creazione
exec_path string Nome del file script (ad esempio, notification.sh) che si trova nella directory specificata nel parametro di configurazione del server AlertScriptsPath.

Comportamento della proprietà:
- obbligatoria se type è impostato su "Script"
gsm_modem string Nome del dispositivo seriale del modem GSM.

Comportamento della proprietà:
- obbligatoria se type è impostato su "SMS"
passwd string Password di autenticazione.

Comportamento della proprietà:
- supportata se smtp_authentication è impostato su "Password normale"
provider integer Provider email.

Valori possibili:
0 - (predefinito) SMTP generico;
1 - Gmail;
2 - Relay Gmail;
3 - Office365;
4 - Relay Office365.
smtp_email string Indirizzo email dal quale verranno inviate le notifiche.

Comportamento della proprietà:
- obbligatoria se type è impostato su "Email"
smtp_helo string HELO SMTP.

Comportamento della proprietà:
- supportata se type è impostato su "Email"
smtp_server string server SMTP.

Comportamento della proprietà:
- obbligatoria se type è impostato su "Email"
smtp_port integer Porta del server SMTP a cui connettersi.

Predefinito: 25.

Comportamento della proprietà:
- supportata se type è impostato su "Email"
smtp_security integer Livello di sicurezza da utilizzare per la connessione SMTP.

Valori possibili:
0 - (predefinito) Nessuno;
1 - STARTTLS;
2 - SSL/TLS.

Comportamento della proprietà:
- supportata se type è impostato su "Email"
smtp_verify_host integer Verifica SSL dell'host per SMTP.

Valori possibili:
0 - (predefinito) No;
1 - Sì.

Comportamento della proprietà:
- supportata se smtp_security è impostato su "STARTTLS" o "SSL/TLS"
smtp_verify_peer integer Verifica SSL del peer per SMTP.

Valori possibili:
0 - (predefinito) No;
1 - Sì.

Comportamento della proprietà:
- supportata se smtp_security è impostato su "STARTTLS" o "SSL/TLS"
smtp_authentication integer Metodo di autenticazione SMTP da utilizzare.

Valori possibili:
0 - (predefinito) Nessuno;
1 - Password normale.

Comportamento della proprietà:
- supportata se type è impostato su "Email"
status integer Indica se il tipo di media è abilitato.

Valori possibili:
0 - (predefinito) Abilitato;
1 - Disabilitato.
username string Nome utente.

Comportamento della proprietà:
- supportata se smtp_authentication è impostato su "Password normale"
maxsessions integer Numero massimo di avvisi che possono essere elaborati in parallelo.

Valori possibili se type è impostato su "SMS": 1.

Valori possibili se type è impostato su "Email", "Script" o "Webhook": 0-100.

Predefinito: 1.
maxattempts integer Numero massimo di tentativi per l'invio di un avviso.

Valori possibili: 1-100.

Predefinito: 3.
attempt_interval string Intervallo tra i tentativi successivi.
Accetta un numero di secondi (ad esempio, 1, 60, 300) o un valore con un suffisso temporale (ad esempio, 30s, 1m, 1h).

Valori possibili: 0-1h.

Predefinito: 10s.
content_type
(deprecato)		 integer Questo parametro è deprecato; utilizzare invece message_format.
Formato del messaggio.

Valori possibili:
0 - Testo normale;
1 - (predefinito) HTML.

Comportamento della proprietà:
- supportata se type è impostato su "Email"
message_format integer Formato del messaggio.

Valori possibili:
0 - Testo normale;
1 - (predefinito) HTML.

Comportamento della proprietà:
- supportata se type è impostato su "Email"
script text Corpo dello script Webhook (JavaScript).

Comportamento della proprietà:
- obbligatoria se type è impostato su "Webhook"
timeout string Timeout dello script Webhook.
Accetta un numero di secondi (ad esempio, 1, 60) o un valore con un suffisso temporale (ad esempio, 30s, 1m).

Valori possibili: 1-60s.

Predefinito: 30s.

Comportamento della proprietà:
- supportata se type è impostato su "Webhook"
process_tags integer Elabora come tag i valori delle proprietà JSON nella risposta dello script Webhook. Questi tag vengono aggiunti ai tag del problema esistenti.

Valori possibili:
0 - (predefinito) Ignora la risposta dello script Webhook;
1 - Elabora la risposta dello script Webhook come tag.

Comportamento della proprietà:
- supportata se type è impostato su "Webhook"
show_event_menu integer Include una voce nel menu degli eventi che rimanda a un URL personalizzato. Aggiunge inoltre la proprietà urls all'output di problem.get e event.get.

Valori possibili:
0 - (predefinito) Non includere la voce nel menu degli eventi né la proprietà urls;
1 - Includere la voce nel menu degli eventi e la proprietà urls.

Comportamento della proprietà:
- supportata se type è impostato su "Webhook"
event_menu_url string URL utilizzato nella voce del menu degli eventi e nella proprietà urls restituita da problem.get e event.get.

Comportamento della proprietà:
- supportata se show_event_menu è impostato su "Includere la voce nel menu degli eventi e la proprietà urls"
event_menu_name string Nome utilizzato per la voce del menu degli eventi e nella proprietà urls restituita da problem.get e event.get.

Comportamento della proprietà:
- supportata se show_event_menu è impostato su "Includere la voce nel menu degli eventi e la proprietà urls"
parameters array Parametri del Webhook o dello script.

Comportamento della proprietà:
- supportata se type è impostato su "Webhook" o "Script"
description text Descrizione del tipo di media.

Parametri webhook

I parametri del webhook hanno le seguenti proprietà.

Proprietà Tipo Descrizione
name string Nome del parametro.

Comportamento della proprietà:
- obbligatorio
value string Valore del parametro, supporta le macro.
Le macro supportate sono descritte nella pagina Macro supportate.

Parametri dello script

I parametri dello script hanno le seguenti proprietà.

Proprietà Type Descrizione
sortorder integer L'ordine in cui i valori dei parametri verranno passati allo script come argomenti della riga di comando, a partire da 0 come primo.

Comportamento della proprietà:
- obbligatorio
value string Valore del parametro, supporta le macro.
Le macro supportate sono descritte nella pagina Macro supportate.

Modello di messaggio

L'oggetto modello di messaggio definisce un modello che verrà utilizzato come messaggio predefinito per le operazioni di azione per inviare una notifica. Ha le seguenti proprietà.

Proprietà Type Descrizione
eventsource integer Origine dell'evento.

Valori possibili:
0 - Trigger;
1 - Individuazione;
2 - Registrazione automatica;
3 - Interno;
4 - Servizi.

Comportamento della proprietà:
- obbligatoria
recovery integer Modalità operativa.

Valori possibili:
0 - Operazioni;
1 - Operazioni di ripristino;
2 - Operazioni di aggiornamento.

Comportamento della proprietà:
- obbligatoria
subject string Oggetto del messaggio.
message string Testo del messaggio.