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.

Parameter Type Description
globalmacro flag Retornar global macros em vez de host macros.
globalmacroids ID/array Retornar apenas global macros com os IDs informados.
groupids ID/array Retornar apenas host macros que pertencem a hosts ou templates dos grupos de hosts ou grupos de templates informados.
hostids ID/array Retornar apenas macros que pertencem aos hosts ou templates informados.
hostmacroids ID/array Retornar apenas host macros com os IDs informados.
inherited boolean Se definido como true, retornar apenas macros de usuário de protótipo de host herdadas de um template.
selectHostGroups query Retornar os grupos de hosts aos quais a host macro pertence na propriedade hostgroups.

Usado apenas ao recuperar host macros.
selectHosts query Retornar os hosts aos quais a host macro pertence na propriedade hosts.

Usado apenas ao recuperar host macros.
selectTemplateGroups query Retornar os grupos de templates aos quais a template macro pertence na propriedade templategroups.

Usado apenas ao recuperar template macros.
selectTemplates query Retornar os templates aos quais a host macro pertence na propriedade templates.

Usado apenas ao recuperar host macros.
sortfield string/array Classificar o resultado pelas propriedades informadas.

Valores possíveis: macro.
countOutput boolean Esses 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
(deprecated)		 query Este parâmetro está obsoleto; use selectHostGroups ou selectTemplateGroups em seu lugar.
Retornar os grupos de hosts e grupos de templates aos quais a host macro pertence na propriedade groups.

Usado apenas ao recuperar host macros.

Valores de retorno

(integer/array) Retorna:

  • um array de objetos;
  • a contagem de objetos recuperados, se o parâmetro countOutput foi utilizado.

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.

Requisição:

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