Documentation

hostgroup.get

Descrição

integer/array hostgroup.get(object parameters)

O método permite recuperar grupos de hosts de acordo com o dado parâmetros.

Parâmetros

(object) Parâmetros que definem a saída desejada.

O método oferece suporte aos parâmetros a seguir.

|Parâmetro|Tipo|Descrição| |---------|----------------------------------- ------------|-----------| |graphids|string/array|Retorna apenas grupos de hosts que contêm hosts ou modelos com os gráficos fornecidos.| |groupids|string/array|Retorna apenas grupos de hosts com os IDs de grupos de hosts fornecidos.| |hostids|string/array|Retorna apenas grupos de hosts que contêm os hosts fornecidos.| |maintenanceids|string/array|Retorna apenas os grupos de hosts afetados pelas manutenções fornecidas.| |monitored_hosts|flag|Retorna apenas grupos de hosts que contêm hosts monitorados.| |real_hosts|flag|Retorna apenas grupos de hosts que contêm hosts.| |templated_hosts|flag|Retorna apenas grupos de hosts que contêm templates.| |templateids|string/array|Retorna apenas grupos de hosts que contêm os modelos fornecidos.| |triggerids|string/array|Retorna apenas grupos de hosts que contêm hosts ou modelos com os gatilhos fornecidos.| |with_graphs|flag|Retorna apenas grupos de hosts que contêm hosts com gráficos.| |with_graph_prototypes|flag|Retorna apenas grupos de hosts que contêm hosts com protótipos de gráficos.| |with_hosts_and_templates|flag|Retorne apenas grupos de hosts que contenham hosts ou templates.| |with_httptests|flag|Retorna apenas grupos de hosts que contêm hosts com verificações da web.

Substitui o parâmetro with_monitored_httptests.| |with_items|flag|Retorna apenas grupos de hosts que contenham hosts ou templates com itens.

Substitui os parâmetros with_monitored_items ewith_simple_graph_items.| |with_item_prototypes|flag|Retorna apenas grupos de hosts que contêm hosts com protótipos de itens.

Substitui o parâmetro with_simple_graph_item_prototypes.| |with_simple_graph_item_prototypes|flag|Retorna apenas grupos de hosts que contêm hosts com protótipos de itens, que são ativados para criação e possuem informações do tipo numérico.| |with_monitored_httptests|flag|Retorna apenas grupos de hosts que contenham hosts com verificações da web habilitadas.| |with_monitored_items|flag|Retorna apenas grupos de hosts que contenham hosts ou templates com itens habilitados.

Substitui o parâmetro with_simple_graph_items.| |with_monitored_triggers|flag|Retorna apenas grupos de hosts que contêm hosts com acionadores ativados. Todos os itens usados no gatilho também devem estar habilitados.| |with_simple_graph_items|flag|Retorna apenas grupos de hosts que contenham hosts com itens numéricos.| |with_triggers|flag|Retorna apenas grupos de hosts que contêm hosts com gatilhos.

Substitui o parâmetro with_monitored_triggers.| |selectDiscoveryRule|query|Retorne uma propriedade discoveryRule com a regra LLD que criou o grupo de hosts.| |selectGroupDiscovery|query|Retorne uma propriedade groupDiscovery com o objeto de descoberta do grupo de hosts.

O objeto de descoberta do grupo de hosts vincula um grupo de hosts descoberto a um protótipo de grupo de hosts e tem as seguintes propriedades:
groupid - (string) ID do grupo de hosts descoberto;
lastcheck - (timestamp) hora em que o grupo de hosts foi descoberto pela última vez;
name - (string) nome do protótipo do grupo de hosts;
parent_group_prototypeid - (string) ID do protótipo do grupo de hosts a partir do qual o grupo de hosts foi criado;
ts_delete - (timestamp) hora em que um grupo de hosts que é não mais descoberto será excluído.| |selectHosts|query|Retorne uma propriedade hosts com os hosts que pertencem ao grupo de hosts.

Suporta count.| |selectTemplates|query|Retorne uma propriedade templates com os templates que pertencem ao grupo de hosts.

Suporta count.| |limitSelects|integer|Limite o número de registros retornados por subseleções.

Aplica-se às seguintes subseleções:
selectHosts - os resultados serão classificados por host;
selectTemplates - resultados será ordenado por host.| |sortfield|string/array|Ordenar o resultado pelas propriedades fornecidas.

Os valores possíveis são: groupid, name.| |countOutput|boolean|Esses parâmetros sendo comuns para todos os métodos get são descritos em detalhes na página comentário de referência.| |editável|booleano|^| |excludePesquisa|boolean|^| |filtro|objeto|^| |limite|inteiro|^| |saída|consulta|^| |preservekeys|boolean|^| |pesquisar|objeto|^| |searchByAny|boolean|^| |searchWildcardsEnabled|boolean|^| |ordem de classificação|cadeia/matriz|^| |startSearch|boolean|^|

Valores de retorno

(integer/array) Retorna:

• uma matriz de objetos;
• a contagem de objetos recuperados, se o parâmetro countOutput tiver sido usado.

Exemplos

Recuperando dados por nome

Recupere todos os dados sobre dois grupos de hosts chamados "servidores Zabbix" e "Servidores Linux".

Solicitação:

{
           "jsonrpc": "2.0",
           "método": "hostgroup.get",
           "parâmetros": {
               "saída": "estender",
               "filtro": {
                   "nome": [
                       "servidores Zabbix",
                       "Servidores Linux"
                   ]
               }
           },
           "auth": "6f38cddc44cfbb6c1bd186f9a220b5a0",
           "id": 1
       }

Resposta:

{
           "jsonrpc": "2.0",
           "resultado": [
               {
                   "groupid": "2",
                   "name": "Servidores Linux",
                   "interno": "0"
               },
               {
                   "groupid": "4",
                   "name": "servidores Zabbix",
                   "interno": "0"
               }
           ],
           "id": 1
       }

Veja também

• Host
• Modelo

Fonte

CHostGroup::get() em ui/include/classes/api/services/CHostGroup.php.