[comment]: # ({f8d4c2e5-f8d4c2e5}) # hostgroup.get [comment]: # ({/f8d4c2e5-f8d4c2e5}) [comment]: # ({20294517-08ff22f2}) ### Descrição `integer/array hostgroup.get(object parameters)` O método permite recuperar grupos de hosts de acordo com os parâmetros fornecidos. ::: noteclassic 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. Consulte [Funções de usuário](/manual/web_interface/frontend_sections/users/user_roles) para mais informações. ::: [comment]: # ({/20294517-08ff22f2}) [comment]: # ({5291ff51-7f042696}) ### Parâmetros `(object)` Parâmetros que definem a saída desejada. O método suporta os seguintes parâmetros. |Parâmetro|[Tipo](/manual/api/reference_commentary#data-types)|Descrição| |--|--|------| |graphids|ID/array|Retorna apenas grupos de hosts que contenham hosts com os gráficos fornecidos.| |groupids|ID/array|Retorna apenas grupos de hosts com os IDs de grupo de host fornecidos.| |hostids|ID/array|Retorna apenas grupos de hosts que contenham os hosts fornecidos.| |maintenanceids|ID/array|Retorna apenas grupos de hosts que são afetados pelas manutenções fornecidas.| |triggerids|ID/array|Retorna apenas grupos de hosts que contenham hosts com os triggers fornecidos.| |with\_graphs|boolean|Retorna apenas grupos de hosts que contenham hosts com gráficos.| |with\_graph\_prototypes|boolean|Retorna apenas grupos de hosts que contenham hosts com protótipos de gráficos.| |with\_hosts|boolean|Retorna apenas grupos de hosts que contenham hosts.| |with\_httptests|boolean|Retorna apenas grupos de hosts que contenham hosts com verificações web.

Sobrescreve o parâmetro `with_monitored_httptests`.| |with\_items|boolean|Retorna apenas grupos de hosts que contenham hosts com items.

Sobrescreve os parâmetros `with_monitored_items` e `with_simple_graph_items`.| |with\_item\_prototypes|boolean|Retorna apenas grupos de hosts que contenham hosts com protótipos de item.

Sobrescreve o parâmetro `with_simple_graph_item_prototypes`.| |with\_simple\_graph\_item\_prototypes|boolean|Retorna apenas grupos de hosts que contenham hosts com protótipos de item, que estão habilitados para criação e possuem tipo de informação numérica.| |with\_monitored\_httptests|boolean|Retorna apenas grupos de hosts que contenham hosts com verificações web habilitadas.| |with\_monitored\_hosts|boolean|Retorna apenas grupos de hosts que contenham hosts monitorados.| |with\_monitored\_items|boolean|Retorna apenas grupos de hosts que contenham hosts com items habilitados.

Sobrescreve o parâmetro `with_simple_graph_items`.| |with\_monitored\_triggers|boolean|Retorna apenas grupos de hosts que contenham hosts com triggers habilitados. Todos os items usados no trigger também devem estar habilitados.| |with\_simple\_graph\_items|boolean|Retorna apenas grupos de hosts que contenham hosts com items numéricos.| |with\_triggers|boolean|Retorna apenas grupos de hosts que contenham hosts com triggers.

Sobrescreve o parâmetro `with_monitored_triggers`.| |selectDiscoveryRules|query|Retorna uma propriedade [`discoveryRules`](/manual/api/reference/discoveryrule/object) com as regras LLD que descobriram o grupo de hosts.| |selectDiscoveryData|query|Retorna uma propriedade `discoveryData` com os objetos de descoberta de grupo de hosts.

Cada objeto de descoberta de grupo de hosts é um protótipo de grupo de hosts vinculado ao grupo de hosts descoberto e possui as seguintes propriedades:
`parent_group_prototypeid` - `(ID)` ID do protótipo de grupo de hosts a partir do qual o grupo de hosts foi descoberto;
`name` - `(string)` nome do protótipo de grupo de hosts;
`ts_delete` - `(timestamp)` hora em que o grupo de hosts que não é mais descoberto será excluído;
`status` - `(int)` status da descoberta do grupo de hosts:
0 - *(padrão)* grupo de hosts é descoberto,
1 - grupo de hosts não é mais descoberto.| |selectHostPrototypes|query|Retorna uma propriedade [`hostPrototypes`](/manual/api/reference/hostprototypes/object) com os protótipos de host que descobriram este grupo de hosts.| |selectHosts|query|Retorna uma propriedade [`hosts`](/manual/api/reference/host/object) com os hosts que pertencem ao grupo de hosts.

Suporta `count`.| |limitSelects|integer|Limita o número de registros retornados por subconsultas.

Aplica-se às seguintes subconsultas:
`selectHosts` - os resultados serão classificados por `host`.| |sortfield|string/array|Classifica o resultado pelas propriedades fornecidas.

Valores possíveis: `groupid`, `name`.| |countOutput|boolean|Estes parâmetros são descritos no [comentário de referência](/manual/api/reference_commentary#common-get-method-parameters).| |editable|boolean|^| |excludeSearch|boolean|^| |filter|object|^| |limit|integer|^| |output|query|^| |preservekeys|boolean|^| |search|object|^| |searchByAny|boolean|^| |searchWildcardsEnabled|boolean|^| |sortorder|string/array|^| |startSearch|boolean|^| |selectGroupDiscoveries|query|Retorna uma propriedade `groupDiscoveries` com os objetos de descoberta de grupo de hosts.

Cada objeto de descoberta de grupo de hosts é um protótipo de grupo de hosts vinculado ao grupo de hosts descoberto.

Esta consulta está **obsoleta**, por favor, use `selectDiscoveryData` em seu lugar.| [comment]: # ({/5291ff51-7f042696}) [comment]: # ({07ca11ca-7223bab1}) ### Valores de retorno `(integer/array)` Retorna: - um array de objetos - a contagem de objetos recuperados, se o parâmetro `countOutput` tiver sido usado [comment]: # ({/07ca11ca-7223bab1}) [comment]: # ({b41637d2-b41637d2}) ### Exemplos [comment]: # ({/b41637d2-b41637d2}) [comment]: # ({6271b06c-8ed2756a}) #### Recuperando dados por nome Recupere todos os dados sobre dois grupos de hosts chamados "Zabbix servers" e "Linux servers". [Requisição](/manual/api#performing-requests): ```json { "jsonrpc": "2.0", "method": "hostgroup.get", "params": { "output": "extend", "filter": { "name": [ "Zabbix servers", "Linux servers" ] } }, "id": 1 } ``` Resposta: ```json { "jsonrpc": "2.0", "result": [ { "groupid": "2", "name": "Linux servers", "flags": "0", "uuid": "dc579cd7a1a34222933f24f52a68bcd8" }, { "groupid": "4", "name": "Zabbix servers", "flags": "0", "uuid": "6f6799aa69e844b4b3918f779f2abf08" } ], "id": 1 } ``` [comment]: # ({/6271b06c-8ed2756a}) [comment]: # ({6a994b89-e5f0abe1}) ### Veja também - [Host](/manual/api/reference/host/object#host) [comment]: # ({/6a994b89-e5f0abe1}) [comment]: # ({1e72ea39-1e72ea39}) ### Origem CHostGroup::get() em *ui/include/classes/api/services/CHostGroup.php*. [comment]: # ({/1e72ea39-1e72ea39})