Oggetto Script

I seguenti oggetti sono direttamente correlati all'API script.

Script

L'oggetto script ha le seguenti proprietà.

Proprietà Type Descrizione
scriptid ID ID dello script.

Comportamento della proprietà:
- sola lettura
- obbligatoria per le operazioni di aggiornamento
name string Nome dello script.

Comportamento della proprietà:
- obbligatoria per le operazioni di creazione
type integer Tipo di script.

Valori possibili se scope è impostato su "action operation":
0 - Script;
1 - IPMI;
2 - SSH;
3 - TELNET;
5 - Webhook.

Valori possibili se scope è impostato su "manual host action" o "manual event action":
6 - URL.

Comportamento della proprietà:
- obbligatoria per le operazioni di creazione
command string Comando da eseguire.

Comportamento della proprietà:
- obbligatoria se type è impostato su "Script", "IPMI", "SSH", "TELNET" o "Webhook"
scope integer Ambito dello script.

Valori possibili:
1 - action operation;
2 - manual host action;
4 - manual event action.

Comportamento della proprietà:
- obbligatoria per le operazioni di creazione
execute_on integer Dove eseguire lo script.

Valori possibili:
0 - esegui su Zabbix agent;
1 - esegui su Zabbix server. È supportato solo se l'esecuzione degli script globali è abilitata su Zabbix server;
2 - (predefinito) esegui su Zabbix server o proxy.

Comportamento della proprietà:
- supportato se type è impostato su "Script"
menu_path string Cartelle separate da slash che formano una navigazione simile a un menu nel frontend quando si fa clic su host o evento.

Comportamento della proprietà:
- supportato se scope è impostato su "manual host action" o "manual event action"
authtype integer Metodo di autenticazione usato per il tipo di script SSH.

Valori possibili:
0 - password;
1 - chiave pubblica.

Comportamento della proprietà:
- supportato se type è impostato su "SSH"
username string Nome utente usato per l'autenticazione.

Comportamento della proprietà:
- obbligatoria se type è impostato su "SSH" o "TELNET"
password string Password usata per gli script SSH con autenticazione tramite password e per gli script TELNET.

Comportamento della proprietà:
- supportato se type è impostato su "SSH" e authtype è impostato su "password", oppure type è impostato su "TELNET"
publickey string Nome del file della chiave pubblica usato per gli script SSH con autenticazione tramite chiave pubblica.

Comportamento della proprietà:
- obbligatoria se type è impostato su "SSH" e authtype è impostato su "public key"
privatekey string Nome del file della chiave privata usato per gli script SSH con autenticazione tramite chiave pubblica.

Comportamento della proprietà:
- obbligatoria se type è impostato su "SSH" e authtype è impostato su "public key"
port string Numero di porta usato per gli script SSH e TELNET.

Comportamento della proprietà:
- supportato se type è impostato su "SSH" o "TELNET"
groupid ID ID del gruppo host su cui lo script può essere eseguito.

Se impostato su "0", lo script sarà disponibile per tutti i gruppi host.

Predefinito: 0.
usrgrpid ID ID del gruppo utenti a cui sarà consentito eseguire lo script.

Se impostato su "0", lo script sarà disponibile per tutti i gruppi utenti.

Predefinito: 0.

Comportamento della proprietà:
- supportato se scope è impostato su "manual host action" o "manual event action"
host_access integer Permessi host necessari per eseguire lo script.

Valori possibili:
2 - (predefinito) lettura;
3 - scrittura.

Comportamento della proprietà:
- supportato se scope è impostato su "manual host action" o "manual event action"
confirmation string Testo del popup di conferma.
Il popup apparirà quando si tenta di eseguire lo script dal frontend di Zabbix.

Comportamento della proprietà:
- supportato se scope è impostato su "manual host action" o "manual event action"
timeout string Timeout di esecuzione dello script webhook in secondi. I suffissi temporali sono supportati (ad esempio, 30s, 1m).

Valori possibili: 1-60s.

Predefinito: 30s.

Comportamento della proprietà:
- obbligatoria se type è impostato su "Webhook"
parameters array Array dei parametri di input del webhook.

Comportamento della proprietà:
- supportato se type è impostato su "Webhook"
description string Descrizione dello script.
url string URL definito dall'utente.

Comportamento della proprietà:
- obbligatoria se type è impostato su "URL"
new_window integer Apri URL in una nuova finestra.

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

Comportamento della proprietà:
- supportato se type è impostato su "URL"
manualinput integer Indica se lo script accetta input fornito dall'utente.

Valori possibili:
0 - (predefinito) Disabilitato;
1 - Abilitato;

Comportamento della proprietà:
- supportato se scope è impostato su "manual host action" o "manual event action"
manualinput_prompt string Testo del prompt per l'input manuale.

Comportamento della proprietà:
- obbligatoria se manualinput è impostato su "Enabled"
manualinput_validator string Campo stringa usato per convalidare l'input fornito dall'utente. La stringa consiste in un'espressione regolare oppure in un insieme di valori separati da virgole.

Comportamento della proprietà:
- obbligatoria se manualinput è impostato su "Enabled"
manualinput_validator_type integer Determina il tipo di input utente previsto.

Valori possibili:
0 - (predefinito) Stringa. Indica che manualinput_validator deve essere trattato come un'espressione regolare;
1 - Elenco. Indica che manualinput_validator deve essere trattato come un elenco separato da virgole dei possibili valori di input.

Comportamento della proprietà:
- supportato se manualinput è impostato su "Enabled"
manualinput_default_value string Valore predefinito per il riempimento automatico dell'input utente.

Comportamento della proprietà:
- supportato se manualinput_validator_type è impostato su "String"

Parametri del webhook

I parametri passati allo script webhook quando viene chiamato hanno le seguenti proprietà.

Proprietà Tipo Descrizione
name string Nome del parametro.

Comportamento della proprietà:
- obbligatorio
value string Valore del parametro. Supporta le macro.

Debug

Informazioni di debug dello script webhook eseguito. L'oggetto debug ha le seguenti proprietà.

Proprietà Type Descrizione
logs array Array di voci di log.
ms string Durata dell'esecuzione dello script in millisecondi.

Voce di log

L'oggetto voce di log ha le seguenti proprietà.

Proprietà Type Descrizione
level integer Livello di log.
ms string Il tempo trascorso in millisecondi dall'esecuzione dello script prima che la voce di log fosse aggiunta.
message string Messaggio di log.