Documentation

Table of Contents

hostgroup.get

hostgroup.get

Descrição

integer/array hostgroup.get(object parameters)

O método permite recuperar grupos de hosts 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. Consulte 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
graphids	ID/array	Retorna apenas grupos de hosts que contenham hosts com os gráficos informados.
groupids	ID/array	Retorna apenas grupos de hosts com os IDs de grupos de hosts informados.
hostids	ID/array	Retorna apenas grupos de hosts que contenham os hosts informados.
maintenanceids	ID/array	Retorna apenas grupos de hosts que são afetados pelas manutenções informadas.
triggerids	ID/array	Retorna apenas grupos de hosts que contenham hosts com os triggers informados.
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 items. 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 items, que estejam habilitados para criação e tenham 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` com as regras de 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)` momento 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 foi descoberto, 1 - grupo de hosts não é mais descoberto.
selectHostPrototypes	query	Retorna uma propriedade `hostPrototypes` com os protótipos de hosts que descobriram este grupo de hosts.
selectHosts	query	Retorna uma propriedade `hosts` 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 informadas. Valores possíveis: `groupid`, `name`.
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
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.

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 dados pelo nome

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

Requisição:

{
           "jsonrpc": "2.0",
           "method": "hostgroup.get",
           "params": {
               "output": "extend",
               "filter": {
                   "name": [
                       "Zabbix servers",
                       "Linux servers"
                   ]
               }
           },
           "id": 1
       }

Resposta:

{
           "jsonrpc": "2.0",
           "result": [
               {
                   "groupid": "2",
                   "name": "Linux servers",
                   "flags": "0",
                   "uuid": "dc579cd7a1a34222933f24f52a68bcd8"
               },
               {
                   "groupid": "4",
                   "name": "Zabbix servers",
                   "flags": "0",
                   "uuid": "6f6799aa69e844b4b3918f779f2abf08"
               }
           ],
           "id": 1
       }

Veja também

Host

Fonte

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