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.

Parameter Type Description
graphids ID/array Retorna apenas host groups que contêm hosts com os graphs informados.
groupids ID/array Retorna apenas host groups com os IDs de host group informados.
hostids ID/array Retorna apenas host groups que contêm os hosts informados.
maintenanceids ID/array Retorna apenas host groups afetados pelas manutenções informadas.
triggerids ID/array Retorna apenas host groups que contêm hosts com os triggers informados.
with_graphs boolean Retorna apenas host groups que contêm hosts com graphs.
with_graph_prototypes boolean Retorna apenas host groups que contêm hosts com graph prototypes.
with_hosts boolean Retorna apenas host groups que contêm hosts.
with_httptests boolean Retorna apenas host groups que contêm hosts com web checks.

Substitui o parâmetro with_monitored_httptests.
with_items boolean Retorna apenas host groups que contêm hosts com items.

Substitui os parâmetros with_monitored_items e with_simple_graph_items.
with_item_prototypes boolean Retorna apenas host groups que contêm hosts com item prototypes.

Substitui o parâmetro with_simple_graph_item_prototypes.
with_simple_graph_item_prototypes boolean Retorna apenas host groups que contêm hosts com item prototypes, que estão habilitados para criação e têm tipo de informação numérico.
with_monitored_httptests boolean Retorna apenas host groups que contêm hosts com web checks habilitados.
with_monitored_hosts boolean Retorna apenas host groups que contêm hosts monitorados.
with_monitored_items boolean Retorna apenas host groups que contêm hosts com items habilitados.

Substitui o parâmetro with_simple_graph_items.
with_monitored_triggers boolean Retorna apenas host groups que contêm hosts com triggers habilitados. Todos os items usados no trigger também devem estar habilitados.
with_simple_graph_items boolean Retorna apenas host groups que contêm hosts com items numéricos.
with_triggers boolean Retorna apenas host groups que contêm hosts com triggers.

Substitui o parâmetro with_monitored_triggers.
selectDiscoveryRules query Retorna uma propriedade discoveryRules com as regras de LLD que descobriram o host group.
selectGroupDiscoveries query Retorna uma propriedade groupDiscoveries com os objetos de descoberta de host group.

Cada objeto de descoberta de host group é um host group prototype vinculado ao host group descoberto e tem as seguintes propriedades:
parent_group_prototypeid - (ID) ID do host group prototype a partir do qual o host group foi descoberto;
name - (string) nome do host group prototype;
lastcheck - (timestamp) momento em que o host group foi descoberto pela última vez;
ts_delete - (timestamp) momento em que o host group que não for mais descoberto será excluído;
status - (int) status da descoberta do host group:
0 - (padrão) host group foi descoberto,
1 - host group não é mais descoberto.
selectHostPrototypes query Retorna uma propriedade hostPrototypes com os host prototypes que descobriram este host group.
selectHosts query Retorna uma propriedade hosts com os hosts que pertencem ao host group.

Suporta count.
limitSelects integer Limita o número de registros retornados pelos subselects.

Aplica-se aos seguintes subselects:
selectHosts - os resultados serão ordenados por host.
sortfield string/array Ordena 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
monitored_hosts
(deprecated)		 flag Este parâmetro está obsoleto, use with_monitored_hosts em seu lugar.
Retorna apenas host groups que contêm hosts monitorados.
real_hosts
(deprecated)		 flag Este parâmetro está obsoleto, use with_hosts em seu lugar.
Retorna apenas host groups que contêm hosts.

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 por 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

Origem

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