template.update

Descripción

object template.update(object/array templates)

Este método permite actualizar las plantillas existentes.

Este método solo está disponible para los tipos de usuario Administrador y Superadministrador. Los permisos para llamar al método se pueden revocar en la configuración del rol de usuario. Ver Roles de usuario para obtener más información.

Parámetros

(objeto/matriz) Propiedades de la plantilla que se actualizarán.

La propiedad templateid debe definirse para cada plantilla, todas las demás Las propiedades son opcionales. Sólo se actualizarán las propiedades dadas, todas otros permanecerán sin cambios.

Además de las propiedades de plantilla estándar, el El método acepta los siguientes parámetros.

Parámetro Tipo Descripción
groups object/array Host grupos para reemplazar los grupos de hosts actuales a los que pertenecen las plantillas.

Los grupos de hosts deben tener la propiedad groupid definido.
etiquetas objeto/matriz Plantilla etiquetas para reemplazar las etiquetas de plantilla actuales.
macros object/array Macros de usuario para reemplazar las macros de usuario actuales en las plantillas dadas.
templates object/array Templates para reemplazar las plantillas actualmente vinculadas. Las plantillas que no se pasan solo se desvinculan.

Las plantillas deben tener definida la propiedad templateid.
templates_clear object/array Plantillas para desvincular y borrar de las plantillas dadas.

Las plantillas deben tener definida la propiedad templateid.

Valores de retorno

(objeto) Devuelve un objeto que contiene los ID de las plantillas actualizadas bajo la propiedad templateids.

Ejemplos

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:

{
    "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"
            } 
        ]
    },
    "auth": "038e1d7b1735c6a5436ee9eae095879e",
    "id": 1
}

Response:

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

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:

{
    "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"
            }
        ]
    },
    "auth": "038e1d7b1735c6a5436ee9eae095879e",
    "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"
            }
        ]
    },
    "auth": "038e1d7b1735c6a5436ee9eae095879e",
    "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"
            }
        ]
    },
    "auth": "038e1d7b1735c6a5436ee9eae095879e",
    "id": 1
}

Response:

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

Fuente

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