Documentation
Table of Contents
usermacro.get
§°§á§Ú§ã§Ñ§ß§Ú§Ö
integer/array usermacro.get(§á§Ñ§â§Ñ§Þ§Ö§ä§â§í §à§Ò§ì§Ö§Ü§ä§Ñ)
§®§Ö§ä§à§Õ §á§à§Ù§Ó§à§Ý§ñ§Ö§ä §á§à§Ý§å§é§Ú§ä§î §ç§à§ã§ä§à§Ó§í§Ö §Ú §Ô§Ý§à§Ò§Ñ§Ý§î§ß§í§Ö §Þ§Ñ§Ü§â§à§ã§í §Ó §ã§à§à§ä§Ó§Ö§ä§ã§ä§Ó§Ú§Ú §ã §Ù§Ñ§Õ§Ñ§ß§ß§í§Þ§Ú §á§Ñ§â§Ñ§Þ§Ö§ä§â§Ñ§Þ§Ú.
§¿§ä§à§ä §Þ§Ö§ä§à§Õ §Õ§à§ã§ä§å§á§Ö§ß §á§à§Ý§î§Ù§à§Ó§Ñ§ä§Ö§Ý§ñ§Þ §Ý§ð§Ò§à§Ô§à §ä§Ú§á§Ñ. §²§Ñ§Ù§â§Ö§ê§Ö§ß§Ú§ñ §ß§Ñ §Ó§í§Ù§à§Ó §Þ§Ö§ä§à§Õ§Ñ §Þ§à§Ø§ß§à §à§ä§à§Ù§Ó§Ñ§ä§î §Ó §ß§Ñ§ã§ä§â§à§Û§Ü§Ñ§ç §â§à§Ý§Ö§Û §á§à§Ý§î§Ù§à§Ó§Ñ§ä§Ö§Ý§ñ. §¥§à§á§à§Ý§ß§Ú§ä§Ö§Ý§î§ß§å§ð §Ú§ß§æ§à§â§Þ§Ñ§è§Ú§ð §ã§Þ. §Ó §â§Ñ§Ù§Õ§Ö§Ý§Ö §²§à§Ý§Ú §á§à§Ý§î§Ù§à§Ó§Ñ§ä§Ö§Ý§Ö§Û.
§±§Ñ§â§Ñ§Þ§Ö§ä§â§í
(§à§Ò§ì§Ö§Ü§ä) §±§Ñ§â§Ñ§Þ§Ö§ä§â§í §Ù§Ñ§Õ§Ñ§ð§ä §Ø§Ö§Ý§Ñ§Ö§Þ§í§Û §Ó§í§Ó§à§Õ.
§¿§ä§à§ä §Þ§Ö§ä§à§Õ §á§à§Õ§Õ§Ö§â§Ø§Ú§Ó§Ñ§Ö§ä §ã§Ý§Ö§Õ§å§ð§ë§Ú§Ö §á§Ñ§â§Ñ§Þ§Ö§ä§â§í.
| §±§Ñ§â§Ñ§Þ§Ö§ä§â | §´§Ú§á | §´§Ú§á |
|---|---|---|
| globalmacro | §æ§Ý§Ñ§Ô | §£§à§Ù§Ó§â§Ñ§ä §Ô§Ý§à§Ò§Ñ§Ý§î§ß§í§ç §Þ§Ñ§Ü§â§à§ã§à§Ó §Ó§Þ§Ö§ã§ä§à §Þ§Ñ§Ü§â§à§ã§à§Ó §å§Ù§Ý§Ñ §ã§Ö§ä§Ú. |
| globalmacroids | §ã§ä§â§à§Ü§Ñ/§Þ§Ñ§ã§ã§Ú§Ó | §£§à§Ù§Ó§â§Ñ§ä §Ô§Ý§à§Ò§Ñ§Ý§î§ß§í§ç §Þ§Ñ§Ü§â§à§ã§à§Ó §ä§à§Ý§î§Ü§à §ã §Ù§Ñ§Õ§Ñ§ß§ß§í§Þ§Ú ID. |
| groupids | §ã§ä§â§à§Ü§Ñ/§Þ§Ñ§ã§ã§Ú§Ó | §£§à§Ù§Ó§â§Ñ§ä §ä§à§Ý§î§Ü§à §ä§Ö§ç §Þ§Ñ§Ü§â§à§ã§à§Ó §å§Ù§Ý§Ñ §ã§Ö§ä§Ú, §Ü§à§ä§à§â§í§Ö §á§â§Ú§ß§Ñ§Õ§Ý§Ö§Ø§Ñ§ä §å§Ù§Ý§Ñ§Þ §ã§Ö§ä§Ú §Ú§Ý§Ú §ê§Ñ§Ò§Ý§à§ß§Ñ§Þ §Ú§Ù §Ù§Ñ§Õ§Ñ§ß§ß§í§ç §Ô§â§å§á§á §å§Ù§Ý§à§Ó §ã§Ö§ä§Ú. |
| hostids | §ã§ä§â§à§Ü§Ñ/§Þ§Ñ§ã§ã§Ú§Ó | §£§à§Ù§Ó§â§Ñ§ä §ä§à§Ý§î§Ü§à §ä§Ö§ç §Þ§Ñ§Ü§â§à§ã§à§Ó, §Ü§à§ä§à§â§í§Ö §á§â§Ú§ß§Ñ§Õ§Ý§Ö§Ø§Ñ§ä §Ù§Ñ§Õ§Ñ§ß§ß§í§Þ §å§Ù§Ý§Ñ§Þ §ã§Ö§ä§Ú §Ú§Ý§Ú §ê§Ñ§Ò§Ý§à§ß§Ñ§Þ. |
| hostmacroids | §ã§ä§â§à§Ü§Ñ/§Þ§Ñ§ã§ã§Ú§Ó | §£§à§Ù§Ó§â§Ñ§ä §Þ§Ñ§Ü§â§à§ã§à§Ó §å§Ù§Ý§Ñ §ã§Ö§ä§Ú §ä§à§Ý§î§Ü§à §ã §Ù§Ñ§Õ§Ñ§ß§ß§í§Þ§Ú ID. |
| selectGroups | §Ù§Ñ§á§â§à§ã | §£§à§Ù§Ó§â§Ñ§ä §Ô§â§å§á§á §å§Ù§Ý§à§Ó §ã§Ö§ä§Ú, §Ü§à§ä§à§â§í§Þ §á§â§Ú§ß§Ñ§Õ§Ý§Ö§Ø§Ñ§ä §Þ§Ñ§Ü§â§à§ã§í §å§Ù§Ý§Ñ §ã§Ö§ä§Ú, §Ó §ã§Ó§à§Û§ã§ä§Ó§Ö groups.§ª§ã§á§à§Ý§î§Ù§å§Ö§ä§ã§ñ §ä§à§Ý§î§Ü§à §á§â§Ú §á§à§Ý§å§é§Ö§ß§Ú§Ú §Þ§Ñ§Ü§â§à§ã§à§Ó §å§Ù§Ý§Ñ §ã§Ö§ä§Ú. |
| selectHosts | §Ù§Ñ§á§â§à§ã | §£§à§Ù§Ó§â§Ñ§ä §å§Ù§Ý§à§Ó §ã§Ö§ä§Ú, §Ü§à§ä§à§â§í§Þ §á§â§Ú§ß§Ñ§Õ§Ý§Ö§Ø§Ñ§ä §Þ§Ñ§Ü§â§à§ã§í §å§Ù§Ý§Ñ §ã§Ö§ä§Ú, §Ó §ã§Ó§à§Û§ã§ä§Ó§Ö hosts.§ª§ã§á§à§Ý§î§Ù§å§Ö§ä§ã§ñ §ä§à§Ý§î§Ü§à §á§â§Ú §á§à§Ý§å§é§Ö§ß§Ú§Ú §Þ§Ñ§Ü§â§à§ã§à§Ó §å§Ù§Ý§Ñ §ã§Ö§ä§Ú. |
| selectTemplates | §Ù§Ñ§á§â§à§ã | §£§à§Ù§Ó§â§Ñ§ä §ê§Ñ§Ò§Ý§à§ß§à§Ó, §Ü§à§ä§à§â§í§Þ §á§â§Ú§ß§Ñ§Õ§Ý§Ö§Ø§Ñ§ä §Þ§Ñ§Ü§â§à§ã§í §å§Ù§Ý§Ñ §ã§Ö§ä§Ú, §Ó §ã§Ó§à§Û§ã§ä§Ó§Ö templates.§ª§ã§á§à§Ý§î§Ù§å§Ö§ä§ã§ñ §ä§à§Ý§î§Ü§à §á§â§Ú §á§à§Ý§å§é§Ö§ß§Ú§Ú §Þ§Ñ§Ü§â§à§ã§à§Ó §å§Ù§Ý§Ñ §ã§Ö§ä§Ú. |
| sortfield | §ã§ä§â§à§Ü§Ñ/§Þ§Ñ§ã§ã§Ú§Ó | §³§à§â§ä§Ú§â§à§Ó§Ü§Ñ §â§Ö§Ù§å§Ý§î§ä§Ñ§ä§Ñ §Ó §ã§à§à§ä§Ó§Ö§ä§ã§ä§Ó§Ú§Ú §ã §Ù§Ñ§Õ§Ñ§ß§ß§í§Þ§Ú §ã§Ó§à§Û§ã§ä§Ó§Ñ§Þ§Ú. §£§à§Ù§Þ§à§Ø§ß§í§Ö §Ù§ß§Ñ§é§Ö§ß§Ú§ñ: macro. |
| countOutput | §Ý§à§Ô§Ú§é§Ö§ã§Ü§Ú§Û | §¿§ä§Ú §á§Ñ§â§Ñ§Þ§Ö§ä§â§í §ñ§Ó§Ý§ñ§ð§ä§ã§ñ §à§Ò§ë§Ú§Þ§Ú §Õ§Ý§ñ §Ó§ã§Ö§ç §Þ§Ö§ä§à§Õ§à§Ó get §Ú §à§ß§Ú §à§á§Ú§ã§Ñ§ß§í §Ó §ã§á§â§Ñ§Ó§à§é§ß§í§ç §Ü§à§Þ§Þ§Ö§ß§ä§Ñ§â§Ú§ñ§ç. |
| editable | §Ý§à§Ô§Ú§é§Ö§ã§Ü§Ú§Û | |
| excludeSearch | §Ý§à§Ô§Ú§é§Ö§ã§Ü§Ú§Û | |
| filter | §à§Ò§ì§Ö§Ü§ä | |
| limit | §è§Ö§Ý§à§Ö §é§Ú§ã§Ý§à | |
| output | §Ù§Ñ§á§â§à§ã | |
| preservekeys | §Ý§à§Ô§Ú§é§Ö§ã§Ü§Ú§Û | |
| search | §à§Ò§ì§Ö§Ü§ä | |
| searchByAny | §Ý§à§Ô§Ú§é§Ö§ã§Ü§Ú§Û | |
| searchWildcardsEnabled | §Ý§à§Ô§Ú§é§Ö§ã§Ü§Ú§Û | |
| sortorder | §ã§ä§â§à§Ü§Ñ/§Þ§Ñ§ã§ã§Ú§Ó | |
| startSearch | §Ý§à§Ô§Ú§é§Ö§ã§Ü§Ú§Û |
§£§à§Ù§Ó§â§Ñ§ë§Ñ§Ö§Þ§í§Ö §Ù§ß§Ñ§é§Ö§ß§Ú§ñ
(§è§Ö§Ý§à§Ö §é§Ú§ã§Ý§à/§Þ§Ñ§ã§ã§Ú§Ó) §£§à§Ù§Ó§â§Ñ§ë§Ñ§Ö§ä §Ý§Ú§Ò§à:
- ¡¤ §Þ§Ñ§ã§ã§Ú§Ó §à§Ò§ì§Ö§Ü§ä§à§Ó;
- ¡¤ §Ü§à§Ý§Ú§é§Ö§ã§ä§Ó§à §Ú§Ù§Ó§Ý§Ö§é§Ö§ß§ß§í§ç §à§Ò§ì§Ö§Ü§ä§à§Ó, §Ö§ã§Ý§Ú §Ú§ã§á§à§Ý§î§Ù§à§Ó§Ñ§Ý§ã§ñ §á§Ñ§â§Ñ§Þ§Ö§ä§â
countOutput.
§±§â§Ú§Þ§Ö§â§í
§±§à§Ý§å§é§Ö§ß§Ú§Ö §Þ§Ñ§Ü§â§à§ã§à§Ó §å§Ù§Ý§Ñ §ã§Ö§ä§Ú §ã §å§Ù§Ý§Ñ §ã§Ö§ä§Ú
§±§à§Ý§å§é§Ö§ß§Ú§Ö §Ó§ã§Ö§ç §Õ§à§Ò§Ñ§Ó§Ý§Ö§ß§ß§í§ç §Þ§Ñ§Ü§â§à§ã§à§Ó §å§Ù§Ý§Ñ §ã§Ö§ä§Ú §ã §å§Ù§Ý§Ñ §ã§Ö§ä§Ú "10198".
§©§Ñ§á§â§à§ã:
{
"jsonrpc": "2.0",
"method": "usermacro.get",
"params": {
"output": "extend",
"hostids": "10198"
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}§°§ä§Ó§Ö§ä:
{
"jsonrpc": "2.0",
"result": [
{
"hostmacroid": "9",
"hostid": "10198",
"macro": "{$INTERFACE}",
"value": "eth0"
},
{
"hostmacroid": "11",
"hostid": "10198",
"macro": "{$SNMP_COMMUNITY}",
"value": "public"
}
],
"id": 1
}§±§à§Ý§å§é§Ö§ß§Ú§Ö §Ô§Ý§à§Ò§Ñ§Ý§î§ß§í§ç §Þ§Ñ§Ü§â§à§ã§à§Ó
§±§à§Ý§å§é§Ö§ß§Ú§Ö §Ó§ã§Ö§ç §Ô§Ý§à§Ò§Ñ§Ý§î§ß§í§ç §Þ§Ñ§Ü§â§à§ã§à§Ó.
§©§Ñ§á§â§à§ã:
{
"jsonrpc": "2.0",
"method": "usermacro.get",
"params": {
"output": "extend",
"globalmacro": true
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}§°§ä§Ó§Ö§ä:
{
"jsonrpc": "2.0",
"result": [
{
"globalmacroid": "6",
"macro": "{$SNMP_COMMUNITY}",
"value": "public"
}
],
"id": 1
}§ª§ã§ä§à§é§ß§Ú§Ü
CUserMacro::get() §Ó ui/include/classes/api/services/CUserMacro.php.