Documentation
Table of Contents
template.update
Description
object template.update(object/array templates)
Cette méthode permet de mettre à jour les modèles existants.
Cette méthode est disponible uniquement pour les types d'utilisateurs Admin et Super admin. Les autorisations d'appeler la méthode peuvent être révoquées dans les paramètres de rôles utilisateur. Voir Rôles Utilisateur pour plus d'informations.
Paramètres
(object/array) Propriétés du modèle à mettre à jour.
La propriété templateid doit être définie pour chaque modèle, toutes les autres propriétés sont facultatives. Seules les propriétés données seront mises à jour, toutes les autres resteront inchangées.
En plus des propriétés de l'objet modèle standard, la méthode accepte les paramètres suivants.
| Paramètre | Type | Description |
|---|---|---|
| groups | object/array | Groupes d'hôtes en remplacement des groupes d'hôtes actuels auxquels appartiennent les modèles. Les groupes hôtes doivent avoir la propriété groupid définie. |
| tags | object/array | Tags de modèle en remplacement de ceux existants. |
| macros | object/array | Macros utilisateur en remplacement des macros utilisateur actuelles sur les modèles donnés. |
| templates | object/array | Modèles en remplacement des modèles actuellement liés. Les modèles qui ne sont pas transmis sont uniquement déliés. Les modèles doivent avoir la propriété templateid définie. |
| templates_clear | object/array | [Modèles(/manual/api/reference/template/object) à délier et à effacer des modèles donnés. Les modèles doivent avoir la propriété templateid définie. |
Valeurs retournées
(object) Retourne un objet contenant les identifiants des modèles mis à jour sous la propriété templateids.
Exemples
Changing the standard template properties
Change the technical name of the template to "Linux by Zabbix agent Custom", the visible name to "My template", and update the template description.
Request:
{
"jsonrpc": "2.0",
"method": "template.update",
"params": {
"templateid": "10086",
"host": "Linux by Zabbix agent Custom",
"name": "My template",
"description": "This is a custom Linux template."
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}Response:
Updating template groups
Replace all template groups for the given template with a different one.
Request:
{
"jsonrpc": "2.0",
"method": "template.update",
"params": {
"templateid": "10086",
"groups": [
{
"groupid": "24"
}
]
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}Response:
Updating template tags
Replace all template tags with a different one.
Request:
{
"jsonrpc": "2.0",
"method": "template.update",
"params": {
"templateid": "10086",
"tags": [
{
"tag": "Host name",
"value": "{HOST.NAME}"
}
]
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}Response:
Updating template macros
Replace all template macros with a different one.
Request:
{
"jsonrpc": "2.0",
"method": "template.update",
"params": {
"templateid": "10086",
"macros": [
{
"macro": "{$MY_MACRO}",
"value": "new_value"
}
]
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}Response:
Updating template linked templates
Unlink (without clearing) all templates from the given template and link a different one to it.
Request:
{
"jsonrpc": "2.0",
"method": "template.update",
"params": {
"templateid": "10086",
"templates": [
{
"templateid": "10087"
}
]
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}Response:
Clearing template linked templates
Unlink and clear the given template from a specific linked template.
Request:
{
"jsonrpc": "2.0",
"method": "template.update",
"params": {
"templateid": "10086",
"templates_clear": [
{
"templateid": "10087"
}
]
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}Response:
Source
CTemplate::update() dans ui/include/classes/api/services/CTemplate.php.