integer/array usermacro.get(object parameters)
Метода омогућава преузимање домаћина и глобалних макроа према датим параметрима.
Овај метод је доступан корисницима било које врсте. Дозволе за позивање методе могу се опозвати у подешавањима улоге корисника. Погледајте Корисничке улоге за више информација.
(object)
Параметри који дефинишу жељени излаз.
Метод подржава следеће параметре.
Parameter | Type | Description |
---|---|---|
globalmacro | flag | Врати глобалне макрое уместо домаћинског макроа. |
globalmacroids | ID/array | |
groupids | ID/array | Врати само до макрое који припадају домаћинима или шаблонима из датих група домаћина или група шаблона. |
hostids | ID/array | Врати само макрое који припадају датим домаћинима или шаблонима. |
hostmacroids | ID/array | Врати само домаћина макрое са датим ID-јевима. |
inherited | boolean | Ако је постављено на true врати само корисничке макрое прототипа домаћина наслеђене из шаблона. |
selectHostGroups | query | Врати групе домаћина којима припада макро домаћина у својству hostgroups .Користи се само при преузимању макроа домаћина. |
selectHosts | query | Врати домаћине којима припада макро домаћин у својству hosts .Користи се само при преузимању макроа домаћина. |
selectTemplateGroups | query | Врати групе шаблона којима припада макро шаблона у својству templategroups .Користи се само при преузимању макроа шаблона. |
selectTemplates | query | Врати шаблоне којима припада макро домаћин у својству templates .Користи се само при преузимању макроа домаћина. |
sortfield | string/array | Сортирај резултат према датим особинама. Могуће вредности: macro . |
countOutput | boolean | Ови параметри су описани у референтном коментару. |
editable | boolean | |
excludeSearch | boolean | |
filter | object | |
limit | integer | |
output | query | |
preservekeys | boolean | |
search | object | |
searchByAny | boolean | |
searchWildcardsEnabled | boolean | |
sortorder | string/array | |
startSearch | boolean |
(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
}
Retrieve host macros defined for template "10265" that contain "STATUS" in the macro name.
{
"jsonrpc": "2.0",
"method": "usermacro.get",
"params": {
"output": "extend",
"hostids": "10265",
"search": {
"macro": "STATUS"
}
},
"id": 1
}
Response:
{
"jsonrpc": "2.0",
"result": [
{
"hostmacroid": "6709",
"hostid": "10265",
"macro": "{$APACHE.STATUS.HOST}",
"value": "",
"description": "The hostname or IP address of the Apache status page host.",
"type": "0",
"automatic": "0",
"config": {
"type": "1",
"priority": "1",
"section_name": "",
"label": "Apache status host",
"description": "Hostname or IP address of the Apache status page host.",
"required": "1",
"regex": "",
"options": []
}
},
{
"hostmacroid": "814",
"hostid": "10265",
"macro": "{$APACHE.STATUS.PATH}",
"value": "server-status?auto",
"description": "The URL path of the Apache status page.",
"type": "0",
"automatic": "0",
"config": {
"type": "1",
"priority": "3",
"section_name": "",
"label": "Apache status page path",
"description": "URL path of the Apache status page.",
"required": "1",
"regex": "",
"options": []
}
},
{
"hostmacroid": "815",
"hostid": "10265",
"macro": "{$APACHE.STATUS.PORT}",
"value": "80",
"description": "The port of the Apache status page.",
"type": "0",
"automatic": "0",
"config": {
"type": "1",
"priority": "2",
"section_name": "",
"label": "Apache status page port",
"description": "In the range from 1 to 65535 inclusive.",
"required": "1",
"regex": "^-?([0-9]+|(([0-9]+)\\.([0-9]+)))$",
"options": []
}
},
{
"hostmacroid": "816",
"hostid": "10265",
"macro": "{$APACHE.STATUS.SCHEME}",
"value": "http",
"description": "The request scheme, which may be either HTTP or HTTPS.",
"type": "0",
"automatic": "0",
"config": {
"type": "2",
"priority": "4",
"section_name": "",
"label": "Request scheme",
"description": "Request scheme, which may be either HTTP or HTTPS.",
"required": "0",
"regex": "",
"options": [
{
"value": "http",
"text": "HTTP"
},
{
"value": "https",
"text": "HTTPS"
}
]
}
}
],
"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.