usermacro.get

说明

integer/array usermacro.get(object parameters)该方法允许根据给定的参数检索主机和全局宏。

参数

(object) 定义所需输出的参数。该方法支持以下参数。

属性 类型 说明
globalmacro flag 返回全局宏而不是主机宏。
globalmacroids string/array 仅返回具有给定ID的全局宏。
groupids string/array 只返回属于主机的主机宏或来自给定主机组的模板。
hostids string/array 仅返回属于给定主机的主机宏。
hostmacroids string/array 只返回具有给定ID的主机宏。
templateids string/array 只返回属于给定模板的主机宏。
selectGroups query 在“'groups”属性中返回主机宏所属的主机组。 仅在检索主机宏时使用。
selectHosts query 在“hosts”属性中返回主机宏所属的主机。 仅在检索主机宏时使用。
selectTemplates query
  • 一组对象;
  • 如果已经使用“countOutput”参数，则检索到的对象的计数。

示例

Retrieving host macros for a host

Retrieve all host macros defined for host “10198”.

Request:

  1. {
  2.     "jsonrpc": "2.0",
  3.     "method": "usermacro.get",
  4.     "params": {
  5.         "output": "extend",
  6.         "hostids": "10198"
  7.     },
  8.     "auth": "038e1d7b1735c6a5436ee9eae095879e",
  9.     "id": 1
  10. }

Response:

  1. {
  2.     "jsonrpc": "2.0",
  3.     "result": [
  4.         {
  5.             "hostmacroid": "9",
  6.             "hostid": "10198",
  7.             "macro": "{$INTERFACE}",
  8.             "value": "eth0"
  9.         },
  10.         {
  11.             "hostmacroid": "11",
  12.             "hostid": "10198",
  13.             "macro": "{$SNMP_COMMUNITY}",
  14.             "value": "public"
  15.         }
  16.     ],
  17.     "id": 1
  18. }

Retrieving global macros

Retrieve all global macros.

Request:

  1. {
  2.     "jsonrpc": "2.0",
  3.     "method": "usermacro.get",
  4.     "params": {
  5.         "output": "extend",
  6.         "globalmacro": true
  7.     },
  8.     "auth": "038e1d7b1735c6a5436ee9eae095879e",
  9.     "id": 1
  10. }

Response:

  1. {
  2.     "jsonrpc": "2.0",
  3.     "result": [
  4.         {
  5.             "globalmacroid": "6",
  6.             "macro": "{$SNMP_COMMUNITY}",
  7.             "value": "public"
  8.         }
  9.     ],
  10.     "id": 1
  11. }

来源

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