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 os grupos de hosts aos quais a macro de host pertence na propriedade `hostgroups`. Usado apenas ao recuperar macros de host.
selectHosts	query	Retorna os hosts aos quais a macro de host pertence na propriedade `hosts`. Usado apenas ao recuperar macros de host.
selectTemplateGroups	query	Retorna os grupos de templates aos quais a macro de template pertence na propriedade `templategroups`. Usado apenas ao recuperar macros de template.
selectTemplates	query	Retorna os 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
selectGroups (obsoleto)	query	Este parâmetro está obsoleto, por favor use `selectHostGroups` ou `selectTemplateGroups` em seu lugar. Retorna grupos de hosts e grupos de templates aos quais a macro de host pertence na propriedade `groups`. Usado apenas ao recuperar macros de host.

Valores de retorno

(integer/array) Retorna:

um array de objetos;
a contagem de objetos recuperados, se o parâmetro countOutput tiver sido usado.

Exemplos

Recuperando macros de host para um host

Recupere todas as macros de host definidas para o host "10198".

Requisição:

{
           "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 globais

Recupere todas as macros globais.