integer/array usermacro.get(object parameters)
Метода омогућава преузимање домаћина и глобалних макроа према датим параметрима.
Овај метод је доступан корисницима било које врсте. Дозволе за позивање методе могу се опозвати у подешавањима улоге корисника. Погледајте Корисничке улоге за више информација.
(object) Параметри који дефинишу жељени излаз.
Метод подржава следеће параметре.
| Parameter | Type | Description |
|---|---|---|
| globalmacro | flag | Врати глобалне макрое уместо макроа домаћина. |
| globalmacroids | ID/array | Врати само глобалне макрое са датим ID-ијевима. |
| groupids | ID/array | Врати само домаћине макроа који припадају домаћинима или шаблонима из датих група домаћина или група шаблона. |
| hostids | ID/array | Врати само макрое који припадају датим домаћинима или шаблонима. |
| hostmacroids | ID/array | Врати само домаћине макроа са датим ID-ијевима. |
| inherited | boolean | Ако је постављено на true врати само корисничке макрое прототипа домаћина наслеђене из шаблона. |
| selectHostGroups | query | Врати групе домаћина којима припада домаћин макроа у својству hostgroups.Користи се само при преузимању макроа домаћина. |
| selectHostGroups | query | Врати домаћине којима припада макро домаћина у својству hosts.Користи се само при преузимању макроа домаћина. |
| selectTemplateGroups | query | Врати групе шаблона којима припада макро шаблона у својству templategroups.Користи се само при преузимању макроа шаблона. |
| selectTemplates | query | Врати шаблоне којима припада макро домаћина у својству templates.Користи се само при преузимању домаћина макроа . |
| sortfield | string/array | Сортирај резултат према датим особинама. Могуће вредности: macro. |
| countOutput | boolean | Ови параметри који су заједнички за све get методе су детаљно описани на страници референтни коментар. |
| editable | boolean | |
| excludeSearch | boolean | |
| filter | object | |
| limit | integer | |
| output | query | |
| preservekeys | boolean | |
| search | object | |
| searchByAny | boolean | |
| searchWildcardsEnabled | boolean | |
| sortorder | string/array | |
| selectGroups (deprecated) |
query | Овај параметар је застарео, користите selectHostGroups или selectTemplateGroups уместо тога.Вратите групе домаћина и групе шаблона којима припада домаћин макроа у својству groups.Користи се само при преузимању макроа домаћина. |
(integer/array) Враћа било:
countOutput коришћен.Преузмите све домаћине макроа за домаћина "10198".
{
"jsonrpc": "2.0",
"method": "usermacro.get",
"params": {
"output": "extend",
"hostids": "10198"
},
"id": 1
}Одговор:
{
"jsonrpc": "2.0",
"result": [
{
"hostmacroid": "9",
"hostid": "10198",
"macro": "{$INTERFACE}",
"value": "eth0",
"description": "",
"type": "0",
"automatic": "0"
},
{
"hostmacroid": "11",
"hostid": "10198",
"macro": "{$SNMP_COMMUNITY}",
"value": "public",
"description": "",
"type": "0",
"automatic": "0"
}
],
"id": 1
}Преузимање свих глобалних макроа.
{
"jsonrpc": "2.0",
"method": "usermacro.get",
"params": {
"output": "extend",
"globalmacro": true
},
"id": 1
}Одговор:
{
"jsonrpc": "2.0",
"result": [
{
"globalmacroid": "6",
"macro": "{$SNMP_COMMUNITY}",
"value": "public",
"description": "",
"type": "0"
}
],
"id": 1
}CUserMacro::get() у ui/include/classes/api/services/CUserMacro.php.