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à.

Property Type Description
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 di 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 "Normal password"
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;
2 - Token OAuth.
L'autenticazione OAuth non è consentita per il provider email Relay Office365.

Comportamento della proprietà:
- supportata se type è impostato su "Email"
redirection_url string URL del frontend Zabbix a cui reindirizzare dopo l'autorizzazione OAuth.

Predefinito:
Valore della proprietà url delle impostazioni API con la parte zabbix.php?action=oauth.authorize

Comportamento della proprietà:
- obbligatoria se smtp_authentication è impostato su "OAuth token"
client_id string Identificatore client registrato nel server di autorizzazione OAuth.

Comportamento della proprietà:
- obbligatoria se smtp_authentication è impostato su "OAuth token"
client_secret string Segreto client registrato nel server di autorizzazione OAuth. Accessibile solo agli utenti di tipo Super Admin.

Comportamento della proprietà:
- obbligatoria se smtp_authentication è impostato su "OAuth token"
authorization_url string URL OAuth, con parametri, per ottenere i token di accesso e aggiornamento.

Comportamento della proprietà:
- obbligatoria se smtp_authentication è impostato su "OAuth token"
token_url string URL OAuth per scambiare il token di autorizzazione con i token di accesso e aggiornamento.
Questo URL viene utilizzato anche dal server per aggiornare il token di accesso non valido.

Comportamento della proprietà:
- obbligatoria se smtp_authentication è impostato su "OAuth token"
tokens_status integer Maschera di bit dello stato dei token.

Valori possibili:
0 - (predefinito) Entrambi i token contengono un valore non valido
1 - Il token di accesso contiene un valore valido
2 - Il token di aggiornamento contiene un valore valido
3 - Entrambi i token contengono un valore valido.

Comportamento della proprietà:
- supportata se smtp_authentication è impostato su "OAuth token"
access_token string Valore del token di accesso OAuth.

Comportamento della proprietà:
- obbligatoria se smtp_authentication è impostato su "OAuth token"
access_token_updated timestamp Timestamp dell'ultima modifica di access_token effettuata dal server durante l'aggiornamento con refresh_token o dall'API in seguito a modifiche del token.

Comportamento della proprietà:
- supportata se smtp_authentication è impostato su "OAuth token"
access_expires_in integer Tempo, in secondi, dopo il quale access_token diventerà obsoleto e sarà necessario effettuare una richiesta a refresh_url.
Viene impostato dal server Zabbix durante l'aggiornamento di access_token o dall'API in seguito a modifiche del token.

Il timestamp viene calcolato aggiungendo il valore di access_token_updated.

Comportamento della proprietà:
- supportata se smtp_authentication è impostato su "OAuth token"
refresh_token string Valore del token di aggiornamento OAuth.

Comportamento della proprietà:
- obbligatoria se smtp_authentication è impostato su "OAuth token"
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 "Normal password"
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 inviare un avviso.

Valori possibili: 1-100.

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

Valori possibili: 0-1h.

Predefinito: 10s.
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 i valori delle proprietà JSON nella risposta dello script Webhook come tag. Questi tag vengono aggiunti a qualsiasi tag del problema esistente.

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 "Include event menu entry and urls property"
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 "Include event menu entry and urls property"
parameters array Parametri Webhook o 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.