Documentation
Table of Contents
> Objet Script
Les objets suivants sont directement li¨¦s ¨¤ l'API script.
Script
L'objet script a les propri¨¦t¨¦s suivantes.
| ±Ê°ù´Ç±è°ù¾±¨¦³Ù¨¦ | Type | Description |
|---|---|---|
| scriptid | string | (lecture seule) ID du script. |
| name (obligatoire) |
string | Nom du script. |
| type (obligatoire) |
integer | Type de script. Valeurs possibles : 0 - Script ; 1 - IPMI ; 2 - SSH ; 3 - Telnet ; 5 - (par d¨¦faut) Webhook. |
| command (obligatoire) |
string | Commande ¨¤ ex¨¦cuter. |
| scope | integer | Port¨¦e du script. Valeurs possibles : 1 - par d¨¦faut op¨¦ration d'action ; 2 - action manuelle sur h?te ; 4 - action manuelle sur ¨¦v¨¨nement. |
| execute_on | integer | O¨´ ex¨¦cuter le script. Utilis¨¦ si type est ¨¤ 0 (script).Valeurs possibles : 0 - ex¨¦cuter sur l'agent Áú»¢¶Ä²© ; 1 - ex¨¦cuter sur le serveur Áú»¢¶Ä²© ; 2 - (par d¨¦faut) ex¨¦cuter sur le serveur Áú»¢¶Ä²© (proxy). |
| menu_path | string | Dossiers s¨¦par¨¦s par une barre oblique qui forment un menu comme la navigation dans le frontend lorsque l'on clique sur l'h?te ou l'¨¦v¨¦nement. Utilis¨¦ si scope est ¨¤ 2 ou 4. |
| authtype | integer | M¨¦thode d'authentification utilis¨¦e pour le type de script SSH. Utilis¨¦ si type est 2.Valeurs possibles : 0 - mot de passe ; 1 - cl¨¦ publique. |
| username | string | Nom d'utilisateur utilis¨¦ pour l'authentification. Requis si type est 2 ou 3. |
| password | string | Mot de passe utilis¨¦ pour les scripts SSH avec authentification par mot de passe et les scripts Telnet. Utilis¨¦ si type est 2 et authtype est 0 ou type est 3. |
| publickey | string | Nom du fichier de cl¨¦ publique utilis¨¦ pour les scripts SSH avec authentification par cl¨¦ publique. Requis si le type est 2 et authtype est 1. |
| privatekey | string | Nom du fichier de cl¨¦ priv¨¦e utilis¨¦ pour les scripts SSH avec authentification par cl¨¦ publique. Requis si le type est 2 et authtype est 1. |
| port | string | Num¨¦ro de port utilis¨¦ pour les scripts SSH et Telnet. Utilis¨¦ si le type est '2' ou '3'. |
| groupid | string | ID du groupe d'h?tes sur lequel le script peut ¨ºtre ex¨¦cut¨¦. Si la valeur est 0, le script sera disponible sur tous les groupes h?tes. Par d¨¦faut : 0. |
| usrgrpid | string | ID du groupe d'utilisateurs qui sera autoris¨¦ ¨¤ ex¨¦cuter le script. S'il est d¨¦fini sur 0, le script sera disponible pour tous les groupes d'utilisateurs. Utilis¨¦ si scope est 2 ou 4.Par d¨¦faut : 0. |
| host_access | integer | Autorisations de l'h?te requises pour ex¨¦cuter le script. Utilis¨¦ si scope est 2 ou 4.Valeurs possibles : 2 - (par d¨¦faut) lecture ; 3 - ¨¦criture. |
| confirmation | string | Texte contextuel de confirmation. La fen¨ºtre contextuelle appara?t lorsque vous essayez d'ex¨¦cuter le script ¨¤ partir de l'interface Áú»¢¶Ä²©. Utilis¨¦ si scope est 2 ou 4. |
| timeout | string | D¨¦lai d'ex¨¦cution du script Webhook en secondes. Les suffixes horaires sont pris en charge, par ex. 30s, 1m. Requis si type est 5.Valeurs possibles : 1-60s Valeur par d¨¦faut : 30s |
| description | string | Description du script. |
Notez que pour certaines m¨¦thodes (mise ¨¤ jour, suppression) la combinaison de param¨¨tres requise/optionnelle est diff¨¦rente.
Param¨¨tres du Webhook
Les param¨¨tres transmis au script webhook lorsqu'il est appel¨¦ ont les propri¨¦t¨¦s suivantes.
| ±Ê°ù´Ç±è°ù¾±¨¦³Ù¨¦ | Type | Description |
|---|---|---|
| name (obligatoire) |
string | Nom du param¨¨tre. |
| value | string | Valeur du param¨¨tre. Supporte les macros. |
Debug
Informations de debug du script Webhook ex¨¦cut¨¦. L'objet de debug a les propri¨¦t¨¦s suivantes.
| ±Ê°ù´Ç±è°ù¾±¨¦³Ù¨¦ | Type | Description |
|---|---|---|
| logs | array | Tableau de entr¨¦es de journal. |
| ms | string | Dur¨¦e d'ex¨¦cution du script en millisecondes. |
Entr¨¦e de journal
L'objet d'entr¨¦e de journal a les propri¨¦t¨¦s suivantes.
| ±Ê°ù´Ç±è°ù¾±¨¦³Ù¨¦ | Type | Description |
|---|---|---|
| level | integer | Niveau de journal. |
| ms | string | Le temps ¨¦coul¨¦ en millisecondes depuis l'ex¨¦cution du script avant l'ajout de l'entr¨¦e de journal. |
| message | string | Message de journal. |