Esta é uma tradução da página de documentação original em inglês. Ajude-nos a torná-la melhor.

Sidebar

Zabbix Summit 2022
Register for Zabbix Summit 2022

host.get

Descrição

integer/array host.get(object parameters)

O método permite recuperar hosts de acordo com os parâmetros fornecidos.

Este método está disponível para usuários de qualquer tipo. Permissões para chamar o método pode ser revogado nas configurações de função do usuário. Veja Usuário funções Para maiores informações.

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| |---------|----------------------------------- ------------|-----------| |groupids|string/array|Retorna apenas hosts que pertencem aos grupos indicados.| |dserviceids|string/array|Retorna apenas hosts relacionados aos serviços descobertos fornecidos.| |graphids|string/array|Retorna apenas hosts que possuem os gráficos fornecidos.| |hostids|string/array|Retorna apenas hosts com os IDs de host fornecidos.| |httptestids|string/array|Retorna apenas hosts que possuem as verificações da web fornecidas.| |interfaceids|string/array|Retorna apenas hosts que usam as interfaces fornecidas.| |itemids|string/array|Retorna apenas hosts que possuem os itens fornecidos.| |maintenanceids|string/array|Retorna apenas os hosts afetados pelas manutenções fornecidas.| |monitored_hosts|flag|Retorna apenas hosts monitorados.| |proxy_hosts|flag|Retorna apenas proxies.| |proxyids|string/array|Retorna apenas os hosts monitorados pelos proxies fornecidos.| |templated_hosts|flag|Retorne tanto hosts quanto templates.| |templateids|string/array|Retorna apenas hosts que estão vinculados aos modelos fornecidos.| |triggerids|string/array|Retorna apenas hosts que possuem os gatilhos fornecidos.| |with_items|flag|Retorna apenas hosts que possuem itens.

Substitui os parâmetros with_monitored_items e with_simple_graph_items.| |with_item_prototypes|flag|Retorna apenas hosts que possuem protótipos de itens.

Substitui o parâmetro with_simple_graph_item_prototypes.| |with_simple_graph_item_prototypes|flag|Retorna apenas hosts que possuem protótipos de itens, que são habilitados para criação e possuem tipo numérico de informação.| |with_graphs|flag|Retorna apenas hosts que possuem gráficos.| |with_graph_prototypes|flag|Retorna apenas hosts que possuem protótipos de grafos.| |with_httptests|flag|Retorna apenas hosts que possuem verificações da web.

Substitui o parâmetro with_monitored_httptests.| |with_monitored_httptests|flag|Retorna apenas hosts que habilitaram verificações da web.| |with_monitored_items|flag|Retorna apenas hosts que tenham itens habilitados.

Substitui o parâmetro with_simple_graph_items.| |with_monitored_triggers|flag|Retorna apenas os hosts que possuem triggers habilitados. Todos os itens usados ​​no gatilho também devem estar habilitados.| |with_simple_graph_items|flag|Retorna apenas hosts que possuem itens com tipo numérico de informação.| |with_triggers|flag|Retorna apenas hosts que possuem triggers.

Substitui o parâmetro with_monitored_triggers.| |withProblemsSuppressed|boolean|Retorna hosts que suprimiram problemas.

Valores possíveis:
null - (padrão) todos os hosts;
true - somente hosts com problemas suprimidos;
false - somente hosts com problemas não suprimidos.| |evaltype|integer|Regras para pesquisa de tags.

Valores possíveis:
0 - (padrão) E/Ou;
2 - Ou.| |severities|integer/array|Anfitriões de retorno que têm apenas problemas com determinadas gravidades. Aplica-se apenas se o objeto do problema for acionador.| |tags|array/object|Retorna apenas hosts com as tags fornecidas. Correspondência exata por tag e pesquisa com distinção entre maiúsculas e minúsculas por valor de tag, dependendo do valor do operador.
Formato: [{"tag": "<tag>", "value": "<value>", " operator": "<operator>"}, ...].
Um array vazio retorna todos os hosts.

Possíveis valores de operador:
0 - (padrão) Contém;
1 - Igual;
2 - Não gosto;
3 - Não igual
4 - Existe;
5 - Não existe.| |inheritedTags|boolean|Retorna hosts que deram tags também em todos os seus templates vinculados. Padrão:

Valores possíveis:
true - templates vinculados também devem ter dado tags;
false - (padrão) tags de templates vinculados são ignoradas.| |selectDiscoveries|query|Retorne uma propriedade discoveries com regras de descoberta de baixo nível do host.

Suporta count.| |selectDiscoveryRule|query|Retorne uma propriedade discoveryRule com a regra de descoberta de baixo nível que criou o host (do protótipo do host no monitoramento VMware).| |selectGraphs|query|Retorne uma propriedade graphs com gráficos de host.

Suporta count.| |selectGroups|query|Retorne uma propriedade groups com dados de grupos de hosts aos quais o host pertence.| |selectHostDiscovery|query|Retorne uma propriedade hostDiscovery com dados do objeto de descoberta de host.

O objeto de descoberta de host vincula um host descoberto a um protótipo de host ou protótipos de host a uma regra LLD e tem as seguintes propriedades:< br>host - (string) host do protótipo do host;
hostid - (string) ID do host ou protótipo do host descoberto;
parent_hostid - (string) ID do protótipo do host a partir do qual o host foi criado;
parent_itemid - (string) ID da regra LLD que criou o host descoberto;
lastcheck - (timestamp) hora em que o host foi descoberto pela última vez;
ts_delete - (timestamp) hora em que um host que não é longer descoberto será excluído.| |selectHttpTests|query|Retorne uma propriedade httpTests com cenários da web do host.

Suporta count.| |selectInterfaces|query|Retorna uma propriedade de interfaces com interfaces de host.

Suporta count.| |selectInventory|query|Retorne uma propriedade de inventário com dados de inventário do host.| |selectItems|query|Retorne uma propriedade items com itens do host.

Suporta count.| |selectMacros|query|Retorne uma propriedade macros com macros do host.| |selectParentTemplates|query|Retorne uma propriedade parentTemplates com modelos aos quais o host está vinculado.

Suporta count.| |selectDashboards|query|Retorna uma propriedade de painéis.

Suporta count.| |selectTags|query|Retorne uma propriedade tags com tags de host.| |selectInheritedTags|query|Retorne uma propriedade inheritedTags com tags que estão em todos os templates que estão vinculados ao host.| |selectTriggers|query|Retorne uma propriedade triggers com acionadores de host.

Suporta count.| |selectValueMaps|query|Retorne uma propriedade valuemaps com mapas de valor do host.| |filter|object|Retorna apenas os resultados que correspondem exatamente ao filtro fornecido.

Aceita uma matriz, em que as chaves são nomes de propriedades e os valores são um único valor ou uma matriz de valores para correspondência.

Permite filtrar por propriedades da interface.| |limitSelects|integer|Limite o número de registros retornados por subseleções.

Aplica-se às seguintes subseleções:
selectParentTemplates - os resultados serão classificados por host;
selectInterfaces;< br>selectItems - ordenado por name;
selectDiscoveries - ordenado por name;
selectTriggers - ordenado por description;
selectGraphs - ordenado por name ;
selectDashboards - ordenado por name.| |pesquisa|objeto|Retorna resultados que correspondam à pesquisa de curinga fornecida.

Aceita uma matriz, em que as chaves são nomes de propriedades e os valores são strings a serem pesquisadas. Se nenhuma opção adicional for fornecida, isso fará uma pesquisa LIKE "%…%".

Permite pesquisar pelas propriedades da interface. Funciona apenas com campos de texto.| |searchInventory|object|Retorna apenas hosts que tenham dados de inventário que correspondam à pesquisa de curinga fornecida.

Este parâmetro é afetado pelos mesmos parâmetros adicionais que search.| |sortfield|string/array|Ordenar o resultado pelas propriedades fornecidas.

Os valores possíveis são: hostid, host, name, status.| |countOutput|boolean|Esses parâmetros sendo comuns para todos os métodos get são descritos em detalhes no comentário de referência.| |editável|booleano|^| |excludePesquisa|boolean|^| |limite|inteiro|^| |saída|consulta|^| |preservekeys|boolean|^| |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 hosts chamados "servidor Zabbix" e "Linux servidor".

Solicitação:

{
           "jsonrpc": "2.0",
           "método": "host.get",
           "parâmetros": {
               "filtro": {
                   "hospedeiro": [
                       "servidor Zabbix",
                       "Servidor Linux"
                   ]
               }
           },
           "auth": "038e1d7b1735c6a5436ee9eae095879e",
           "id": 1
       }

Resposta:

{
           "jsonrpc": "2.0",
           "resultado": [
               {
                   "manutenção": [],
                   "hostid": "10160",
                   "proxy_hostid": "0",
                   "host": "servidor Zabbix",
                   "estado": "0",
                   "lastaccess": "0",
                   "ipmi_authtype": "-1",
                   "ipmi_privilege": "2",
                   "ipmi_username": "",
                   "ipmi_password": "",
                   "ipmi_disable_until": "0",
                   "snmp_disable_until": "0",
                   "manutençãoid": "0",
                   "maintenance_status": "0",
                   "maintenance_type": "0",
                   "maintenance_from": "0",
                   "nome": "servidor Zabbix",
                   "description": "O servidor de monitoramento Zabbix.",
                   "tls_connect": "1",
                   "tls_accept": "1",
                   "tls_issuer": "",
                   "tls_subject": ""
               },
               {
                   "manutenção": [],
                   "hostid": "10167",
                   "proxy_hostid": "0",
                   "host": "Servidor Linux",
                   "estado": "0",
                   "lastaccess": "0",
                   "ipmi_authtype": "-1",
                   "ipmi_privilege": "2",
                   "ipmi_username": "",
                   "ipmi_password": "",
                   "ipmi_disable_until": "0",
                   "snmp_disable_until": "0",
                   "manutençãoid": "0",
                   "maintenance_status": "0",
                   "maintenance_type": "0",
                   "maintenance_from": "0",
                   "nome": "Servidor Linux",
                   "Descrição": "",
                   "tls_connect": "1",
                   "tls_accept": "1",
                   "tls_issuer": "",
                   "tls_subject": ""
               }
           ],
           "id": 1
       }

Recuperando grupos de hosts

Recupere os nomes dos grupos que o host "Zabbix server" é membro, mas não detalhes do host em si.

Solicitação:

{
           "jsonrpc": "2.0",
           "método": "host.get",
           "parâmetros": {
               "saída": ["hostid"],
               "selectGroups": "estender",
               "filtro": {
                   "hospedeiro": [
                       "servidor Zabbix"
                   ]
               }
           },
           "auth": "038e1d7b1735c6a5436ee9eae095879e",
           "id": 2
       }

Resposta:

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

Recuperando modelos vinculados

Recupere os IDs e os nomes dos modelos vinculados ao host "10084".

Solicitação:

{
           "jsonrpc": "2.0",
           "método": "host.get",
           "parâmetros": {
               "saída": ["hostid"],
               "selectParentTemplates": [
                   "modelo",
                   "nome"
               ],
               "hostids": "10084"
           },
           "id": 1,
           "auth": "70785d2b494a7302309b48afcdb3a401"
       }

Resposta:

{
           "jsonrpc": "2.0",
           "resultado": [
               {
                   "hostid": "10084",
                   "parentModelos": [
                       {
                           "nome": "Linux",
                           "templateid": "10001"
                       },
                       {
                           "nome": "Servidor Zabbix",
                           "templateid": "10047"
                       }
                   ]
               }
           ],
           "id": 1
       }

Pesquisando por dados de inventário do host

Recupere hosts que contenham "Linux" no campo "OS" do inventário de hosts.

Solicitação:

{
           "jsonrpc": "2.0",
           "método": "host.get",
           "parâmetros": {
               "saída": [
                   "hospedeiro"
               ],
               "selectInventário": [
                   "os"
               ],
               "pesquisarInventário": {
                   "os": "Linux"
               }
           },
           "id": 2,
           "auth": "7f9e00124c75e8f25facd5c093f3e9a0"
       }

Resposta:

{
           "jsonrpc": "2.0",
           "resultado": [
               {
                   "hostid": "10084",
                   "host": "servidor Zabbix",
                   "inventário": {
                       "os": "Linux Ubuntu"
                   }
               },
               {
                   "hostid": "10107",
                   "host": "Servidor Linux",
                   "inventário": {
                       "os": "Linux Mint"
                   }
               }
           ],
           "id": 1
       }

Pesquisando por tags de host

Recupere os hosts que possuem a tag "Nome do host" igual a "Servidor Linux".

Solicitação:

{
           "jsonrpc": "2.0",
           "método": "host.get",
           "parâmetros": {
               "saída": ["hostid"],
               "selectTags": "estender",
               "evaltype": 0,
               "Tag": [
                   {
                       "tag": "Nome do host",
                       "value": "Servidor Linux",
                       "operador": 1
                   }
               ]
           },
           "auth": "7f9e00124c75e8f25facd5c093f3e9a0",
           "id": 1
       }

Resposta:

{
           "jsonrpc": "2.0",
           "resultado": [
               {
                   "hostid": "10085",
                   "Tag": [
                       {
                           "tag": "Nome do host",
                           "value": "Servidor Linux"
                       },
                       {
                           "tag": "SO",
                           "valor": "RHEL 7"
                       }
                   ]
               }
           ],
           "id": 1
       }

Recupere hosts que tenham essas tags não apenas em nível de host, mas também em seus modelos pai vinculados.

Solicitação:

{
           "jsonrpc": "2.0",
           "método": "host.get",
           "parâmetros": {
               "saída": ["nome"],
               "tags": [{"tag": "A", "value": "1", "operator": "0"}],
               "herdadoTags": verdadeiro
           },
           "auth": "038e1d7b1735c6a5436ee9eae095879e",
           "id": 1
       }

Resposta:

{
           "jsonrpc": "2.0",
           "resultado": [
               {
                   "hostid": "10623",
                   "name": "Sala de PC 1"
               },
               {
                   "hostid": "10601",
                   "nome": "Escritório"
               }
           ],
           "id": 1
       }

Pesquisando host com tags e tags de modelo

Recuperar um host com tags e todas as tags vinculadas ao pai modelos.

Solicitação:

{
           "jsonrpc": "2.0",
           "método": "host.get",
           "parâmetros": {
               "saída": ["nome"],
               "hostids": 10502,
               "selectTags": ["tag", "valor"],
               "selectInheritedTags": ["tag", "valor"]
           },
           "auth": "038e1d7b1735c6a5436ee9eae095879e",
           "id": 1
       }

Resposta:

{
           "jsonrpc": "2.0",
           "resultado": [
               {
                   "hostid": "10502",
                   "nome": "Área de trabalho",
                   "Tag": [
                       {
                           "marca": "A",
                           "valor": "1"
                       }
                   ],
                   "herdadoTags": [
                       {
                           "marca": "B",
                           "valor": "2"
                       }
                   ]
               }
           ],
           "id": 1
       }

Pesquisando hosts por gravidade do problema

Recupere hosts que tenham problemas de "Desastre".

Solicitação:

{
           "jsonrpc": "2.0",
           "método": "host.get",
           "parâmetros": {
               "saída": ["nome"],
               "gravidades": 5
           },
           "auth": "038e1d7b1735c6a5436ee9eae095879e",
           "id": 1
       }

Resposta:

{
           "jsonrpc": "2.0",
           "resultado": [
               {
                   "hostid": "10160",
                   "name": "servidor Zabbix"
               }
           ],
           "id": 1
       }

Recupere hosts que tenham problemas "Average" e "High".

Solicitação:

{
           "jsonrpc": "2.0",
           "método": "host.get",
           "parâmetros": {
               "saída": ["nome"],
               "gravidades": [3, 4]
           },
           "auth": "038e1d7b1735c6a5436ee9eae095879e",
           "id": 1
       }

Resposta:

{
           "jsonrpc": "2.0",
           "resultado": [
               {
                   "hostid": "20170",
                   "nome": "Banco de dados"
               },
               {
                   "hostid": "20183",
                   "nome": "estação de trabalho"
               }
           ],
           "id": 1
       }

Veja também

Fonte

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