template.update

Descrição

object template.update(object/array templates)

Este método permite atualizar templates existentes.

Este método está disponível apenas para os tipos de usuário Admin e Super admin. As permissões para chamar o método podem ser revogadas nas configurações de função de usuário. Veja Funções de usuário para mais informações.

Parâmetros

(object/array) Propriedades do template a serem atualizadas.

A propriedade templateid deve ser definida para cada template, todas as outras propriedades são opcionais. Somente as propriedades fornecidas serão atualizadas, todas as outras permanecerão inalteradas.

Além das propriedades padrão do template, o método aceita os seguintes parâmetros.

Parâmetro Tipo Descrição
groups object/array Grupos de templates para substituir os grupos de templates atuais aos quais os templates pertencem.

Os grupos de templates devem ter apenas a propriedade groupid definida.
tags object/array Tags de template para substituir as tags de template atuais.
macros object/array Macros de usuário para substituir as macros de usuário atuais nos templates fornecidos.
templates object/array Templates para substituir os templates atualmente vinculados. Templates que não são passados são apenas desvinculados.

Os templates devem ter apenas a propriedade templateid definida.
templates_clear object/array Templates para desvincular e limpar dos templates fornecidos.

Os templates devem ter apenas a propriedade templateid definida.

Valores de retorno

(object) Retorna um objeto contendo os IDs dos templates atualizados na propriedade templateids.

Exemplos

Alterando as propriedades padrão do template

Altere o nome técnico do template para "Linux by Zabbix agent Custom", o nome visível para "My template" e atualize a descrição do template.

Requisição:

{
    "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
}

Resposta:

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

Atualizando grupos de templates

Substitua todos os grupos de templates do template fornecido por um diferente.

Requisição:

{
    "jsonrpc": "2.0",
    "method": "template.update",
    "params": {
        "templateid": "10086",
        "groups": [
            {
                "groupid": "24"
            } 
        ]
    },
    "id": 1
}

Resposta:

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

Atualizando vários grupos de templates

Substitua todos os grupos de templates para vários templates por outros diferentes.

Requisição:

{
    "jsonrpc": "2.0",
    "method": "template.update",
    "params": [
        {
            "templateid": "10086",
            "groups": [
                {
                    "groupid": "24"
                }
            ]
        },
        {
            "templateid": "10087",
            "groups": [
                {
                    "groupid": "1"
                },
                {
                    "groupid": "12"
                }
            ]
        },
        {
            "templateid": "10088",
            "groups": [
                {
                    "groupid": "1"
                },
                {
                    "groupid": "12"
                }
            ]
        }
    ],
    "id": 1
}

Resposta:

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

Atualizando tags de template

Substitua todas as tags de template por uma diferente.

Requisição:

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

Resposta:

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

Atualizando macros de template

Substitua todas as macros de template por uma diferente.

Requisição:

{
    "jsonrpc": "2.0",
    "method": "template.update",
    "params": {
        "templateid": "10086",
        "macros": [
            {
                "macro": "{$MY_MACRO}",
                "value": "new_value"
            }
        ]
    },
    "id": 1
}

Resposta:

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

Atualizando múltiplas macros de template

Substitua todas as macros de usuário pela macro de usuário fornecida em vários templates.

Requisição:

{
    "jsonrpc": "2.0",
    "method": "template.update",
    "params": [
            {
                "templateid": "10087",
                "macros": [
                    {
                        "macro": "{$AGENT.TIMEOUT}",
                        "value": "5m",
                        "description": "Timeout after which agent is considered unavailable. Works only for agents reachable from Zabbix server/proxy (passive mode)."
                    }
                ]
            },
            {
                "templateid": "10088",
                "macros": [
                    {
                        "macro": "{$AGENT.TIMEOUT}",
                        "value": "5m",
                        "description": "Timeout after which agent is considered unavailable. Works only for agents reachable from Zabbix server/proxy (passive mode)."
                    }
                ]
            }
        ],
    "id": 1
}

Resposta:

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

Atualizando templates vinculados ao template

Desvincule (sem limpar) todos os templates do template fornecido e vincule um diferente a ele.

Requisição:

{
    "jsonrpc": "2.0",
    "method": "template.update",
    "params": {
        "templateid": "10086",
        "templates": [
            {
                "templateid": "10001"
            }
        ]
    },
    "id": 1
}

Resposta:

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

Limpando vários templates vinculados a um template

Desvincula e limpa um template vinculado específico dos templates fornecidos.

Requisição:

{
    "jsonrpc": "2.0",
    "method": "template.update",
    "params": [
        {
            "templateid": "10087",
            "templates_clear": [
                {
                    "templateid": "10001"
                }
            ]
        },
        {
            "templateid": "10088",
            "templates_clear": [
                {
                    "templateid": "10001"
                }
            ]
        }
    ],
    "id": 1
}

Resposta:

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

Origem

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