template.update

Beschrijving

object template.update(object/array templates)

Deze methode maakt het mogelijk om bestaande sjablonen bij te werken.

Deze methode is alleen beschikbaar voor gebruikers met het type Admin en Super admin. Rechten om deze methode aan te roepen kunnen worden ingetrokken in de instellingen van gebruikersrollen. Zie Gebruikersrollen voor meer informatie.

Parameters

(object/array) Eigenschappen van het sjabloon die bijgewerkt moeten worden.

De eigenschap templateid moet gedefinieerd zijn voor elk sjabloon, alle andere eigenschappen zijn optioneel. Alleen de opgegeven eigenschappen worden bijgewerkt, alle andere blijven ongewijzigd.

Naast de standaard sjablooneigenschappen accepteert de methode de volgende parameters.

Parameter Type Omschrijving
groups object/array Te vervangen sjabloon groepen waartoe de sjablonen behoren.

De sjabloon groepen moeten de eigenschap groupid gedefinieerd hebben.
tags object/array Sjabloontags om de huidige sjabloontags te vervangen.
macros object/array Gebruikersmacro's om de huidige gebruikersmacro's op de opgegeven sjablonen te vervangen.
templates object/array Te vervangen sjablonen die momenteel gelinkt zijn. Sjablonen die niet worden doorgegeven, worden alleen losgekoppeld.

De sjablonen moeten de eigenschap templateid gedefinieerd hebben.
templates_clear object/array Te ontkoppelen en te wissen sjablonen van de opgegeven sjablonen.

De sjablonen moeten de eigenschap templateid gedefinieerd hebben.

Retourwaarden

(object) Retourneert een object dat de ID's van de bijgewerkte sjablonen bevat onder de eigenschap templateids.

Voorbeelden

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."
    },
    "id": 1
}

Response:

{
    "jsonrpc": "2.0",
    "result": {
        "templateids": [
            "10086"
        ]
    },
    "id": 1
}

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"
            } 
        ]
    },
    "id": 1
}

Response:

{
    "jsonrpc": "2.0",
    "result": {
        "templateids": [
            "10086"
        ]
    },
    "id": 1
}

Bijwerken van sjabloontags

Vervang alle sjabloontags door een nieuwe tag.

Aanvraag:

{
    "jsonrpc": "2.0",
    "method": "template.update",
    "params": {
        "templateid": "10086",
        "tags": [
            {
                "tag": "Hostnaam",
                "value": "{HOST.NAME}"
            }
        ]
    },
    "id": 1
}

Reactie:

{
    "jsonrpc": "2.0",
    "result": {
        "templateids": [
            "10086"
        ]
    },
    "id": 1
}

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"
            }
        ]
    },
    "id": 1
}

Response:

{
    "jsonrpc": "2.0",
    "result": {
        "templateids": [
            "10086"
        ]
    },
    "id": 1
}

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"
            }
        ]
    },
    "id": 1
}

Response:

{
    "jsonrpc": "2.0",
    "result": {
        "templateids": [
            "10086"
        ]
    },
    "id": 1
}

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"
            }
        ]
    },
    "id": 1
}

Response:

{
    "jsonrpc": "2.0",
    "result": {
        "templateids": [
            "10086"
        ]
    },
    "id": 1
}

Bron

CTemplate::update() in ui/include/classes/api/services/CTemplate.php.