Zabbix Documentation 4.0

3.04.05.0 (current)| In development:5.2 (devel)| Unsupported:1.82.02.22.43.23.44.24.4Guidelines

User Tools

Site Tools


Sidebar

zh:manual:api:reference:usermacro:create

usermacro.create

说明

object usermacro.create(object/array hostMacros)

此方法允许创建新的主机宏。

Description

object usermacro.create(object/array hostMacros)

This method allows to create new host macros.

参数

(object/array)要创建的主机宏。

该方法接受有标准主机宏属性的主机宏.

Parameters

(object/array) Host macros to create.

The method accepts host macros with the standard host macro properties.

返回值

(object) 返回包含“hostMacroids”属性下创建的主机宏的ID的对象。 返回的ID的顺序与传递的主机宏的顺序相匹配。

Return values

(object) Returns an object containing the IDs of the created host macros under the hostmacroids property. The order of the returned IDs matches the order of the passed host macros.

示例

创建主机宏

在主机“10198”创建主机宏 “{$SNMP_COMMUNITY}“值为”public”。

Creating a host macro

Creat a host macro “{$SNMP_COMMUNITY}” with the value “public” on host “10198”.

Request:

{
    "jsonrpc": "2.0",
    "method": "usermacro.create",
    "params": {
        "hostid": "10198",
        "macro": "{$SNMP_COMMUNITY}",
        "value": "public"
    },
    "auth": "038e1d7b1735c6a5436ee9eae095879e",
    "id": 1
}

Response:

{
    "jsonrpc": "2.0",
    "result": {
        "hostmacroids": [
            "11"
        ]
    },
    "id": 1
}

来源

CUserMacro::create() in frontends/php/include/classes/api/services/CUserMacro.php.