Table of Contents
usermacro.get
Descrição
integer/array usermacro.get(object parameters)
O método permite recuperar macros de host e globais de acordo com os parâmetros fornecidos.
Este método está disponível para usuários de qualquer tipo. As permissões para chamar o método podem ser revogadas nas configurações de função do usuário. Veja Funções de usuário para mais informações.
Parâmetros
(object) Parâmetros que definem a saída desejada.
O método suporta os seguintes parâmetros.
| Parâmetro | Tipo | Descrição |
|---|---|---|
| globalmacro | flag | Retorna macros globais em vez de macros de host. |
| globalmacroids | ID/array | Retorna apenas macros globais com os IDs fornecidos. |
| groupids | ID/array | Retorna apenas macros de host que pertencem a hosts ou templates dos grupos de hosts ou grupos de templates fornecidos. |
| hostids | ID/array | Retorna apenas macros que pertencem aos hosts ou templates fornecidos. |
| hostmacroids | ID/array | Retorna apenas macros de host com os IDs fornecidos. |
| inherited | boolean | Se definido como true, retorna apenas macros de usuário de protótipo de host herdadas de um template. |
| selectHostGroups | query | Retorna grupos de hosts aos quais a macro de host pertence na propriedade hostgroups.Usado apenas ao recuperar macros de host. |
| selectHosts | query | Retorna hosts aos quais a macro de host pertence na propriedade hosts.Usado apenas ao recuperar macros de host. |
| selectTemplateGroups | query | Retorna grupos de templates aos quais a macro de template pertence na propriedade templategroups.Usado apenas ao recuperar macros de template. |
| selectTemplates | query | Retorna templates aos quais a macro de host pertence na propriedade templates.Usado apenas ao recuperar macros de host. |
| sortfield | string/array | Ordena o resultado pelas propriedades fornecidas. Valores possíveis: macro. |
| countOutput | boolean | Estes parâmetros são descritos no comentário de referência. |
| editable | boolean | |
| excludeSearch | boolean | |
| filter | object | |
| limit | integer | |
| output | query | |
| preservekeys | boolean | |
| search | object | |
| searchByAny | boolean | |
| searchWildcardsEnabled | boolean | |
| sortorder | string/array | |
| startSearch | boolean |
Valores de retorno
(integer/array) Retorna:
- um array de objetos;
- a contagem de objetos recuperados, se o parâmetro
countOutputfoi utilizado.
Exemplos
Recuperando macros de host para um host
Recupere todas as macros de host definidas para o host "10198".
{ "jsonrpc": "2.0", "method": "usermacro.get", "params": { "output": "extend", "hostids": "10198" }, "id": 1 }Resposta:
{ "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 }Recuperando macros de host para um template
Recupere as macros de host definidas para o template "10265" que contenham "STATUS" no nome da macro.
{ "jsonrpc": "2.0", "method": "usermacro.get", "params": { "output": "extend", "hostids": "10265", "search": { "macro": "STATUS" } }, "id": 1 }Resposta:
{ "jsonrpc": "2.0", "result": [ { "hostmacroid": "6709", "hostid": "10265", "macro": "{$APACHE.STATUS.HOST}", "value": "", "description": "O nome do host ou endereço IP do host da página de status do Apache.", "type": "0", "automatic": "0", "config": { "type": "1", "priority": "1", "section_name": "", "label": "Host da página de status do Apache", "description": "Nome do host ou endereço IP do host da página de status do Apache.", "required": "1", "regex": "", "options": [] } }, { "hostmacroid": "814", "hostid": "10265", "macro": "{$APACHE.STATUS.PATH}", "value": "server-status?auto", "description": "O caminho da URL da página de status do Apache.", "type": "0", "automatic": "0", "config": { "type": "1", "priority": "3", "section_name": "", "label": "Caminho da página de status do Apache", "description": "Caminho da URL da página de status do Apache.", "required": "1", "regex": "", "options": [] } }, { "hostmacroid": "815", "hostid": "10265", "macro": "{$APACHE.STATUS.PORT}", "value": "80", "description": "A porta da página de status do Apache.", "type": "0", "automatic": "0", "config": { "type": "1", "priority": "2", "section_name": "", "label": "Porta da página de status do Apache", "description": "No intervalo de 1 a 65535 inclusive.", "required": "1", "regex": "^-?([0-9]+|(([0-9]+)\\.([0-9]+)))$", "options": [] } }, { "hostmacroid": "816", "hostid": "10265", "macro": "{$APACHE.STATUS.SCHEME}", "value": "http", "description": "O esquema de requisição, que pode ser HTTP ou HTTPS.", "type": "0", "automatic": "0", "config": { "type": "2", "priority": "4", "section_name": "", "label": "Esquema de requisição", "description": "Esquema de requisição, que pode ser HTTP ou HTTPS.", "required": "0", "regex": "", "options": [ { "value": "http", "text": "HTTP" }, { "value": "https", "text": "HTTPS" } ] } } ], "id": 1 }Recuperando macros globais
Recupere todas as macros globais.
{ "jsonrpc": "2.0", "method": "usermacro.get", "params": { "output": "extend", "globalmacro": true }, "id": 1 }Resposta:
{ "jsonrpc": "2.0", "result": [ { "globalmacroid": "6", "macro": "{$SNMP_COMMUNITY}", "value": "public", "description": "", "type": "0" } ], "id": 1 }Fonte
CUserMacro::get() em ui/include/classes/api/services/CUserMacro.php.