hostgroup.get

Apraksts

integer/array hostgroup.get(object parameters)

Metode ļauj izgūt hostu grupas atbilstoši norādītajiem parametriem.

Šī metode ir pieejama jebkura tipa lietotājiem. Atļaujas izsaukt šo metodi var tikt atsauktas lietotāja lomas iestatījumos. Plašāku informāciju skatiet sadaļā Lietotāju lomas.

Parametri

(object) Parametri, kas definē vēlamo izvadi.

Metode atbalsta šādus parametrus.

Parameter Type Description
graphids ID/array Atgriezt tikai hostu grupas, kas satur hostus ar norādītajiem grafikiem.
groupids ID/array Atgriezt tikai hostu grupas ar norādītajiem hostu grupu ID.
hostids ID/array Atgriezt tikai hostu grupas, kas satur norādītos hostus.
maintenanceids ID/array Atgriezt tikai hostu grupas, kuras ietekmē norādītās apkalpošanas darbības.
triggerids ID/array Atgriezt tikai hostu grupas, kas satur hostus ar norādītajiem trigeriem.
with_graphs boolean Atgriezt tikai hostu grupas, kas satur hostus ar grafikiem.
with_graph_prototypes boolean Atgriezt tikai hostu grupas, kas satur hostus ar grafiku prototipiem.
with_hosts boolean Atgriezt tikai hostu grupas, kas satur hostus.
with_httptests boolean Atgriezt tikai hostu grupas, kas satur hostus ar tīmekļa pārbaudēm.

Pārraksta with_monitored_httptests parametru.
with_items boolean Atgriezt tikai hostu grupas, kas satur hostus ar vienumiem.

Pārraksta with_monitored_items un with_simple_graph_items parametrus.
with_item_prototypes boolean Atgriezt tikai hostu grupas, kas satur hostus ar vienumu prototipiem.

Pārraksta with_simple_graph_item_prototypes parametru.
with_simple_graph_item_prototypes boolean Atgriezt tikai hostu grupas, kas satur hostus ar vienumu prototipiem, kuri ir iespējoti izveidei un kuriem ir skaitlisks informācijas tips.
with_monitored_httptests boolean Atgriezt tikai hostu grupas, kas satur hostus ar iespējotām tīmekļa pārbaudēm.
with_monitored_hosts boolean Atgriezt tikai hostu grupas, kas satur uzraudzītus hostus.
with_monitored_items boolean Atgriezt tikai hostu grupas, kas satur hostus ar iespējotiem vienumiem.

Pārraksta with_simple_graph_items parametru.
with_monitored_triggers boolean Atgriezt tikai hostu grupas, kas satur hostus ar iespējotiem trigeriem. Visiem trigerī izmantotajiem vienumiem arī jābūt iespējotiem.
with_simple_graph_items boolean Atgriezt tikai hostu grupas, kas satur hostus ar skaitliskiem vienumiem.
with_triggers boolean Atgriezt tikai hostu grupas, kas satur hostus ar trigeriem.

Pārraksta with_monitored_triggers parametru.
selectDiscoveryRules query Atgriezt discoveryRules īpašību ar LLD noteikumiem, kas atklāja hostu grupu.
selectGroupDiscoveries query Atgriezt groupDiscoveries īpašību ar hostu grupas atklāšanas objektiem.

Katrs hostu grupas atklāšanas objekts ir hostu grupas prototips, kas saistīts ar atklāto hostu grupu, un tam ir šādas īpašības:
parent_group_prototypeid - (ID) hostu grupas prototipa ID, no kura tika atklāta hostu grupa;
name - (string) hostu grupas prototipa nosaukums;
lastcheck - (timestamp) laiks, kad hostu grupa pēdējo reizi tika atklāta;
ts_delete - (timestamp) laiks, kad tiks dzēsta hostu grupa, kas vairs netiek atklāta;
status - (int) hostu grupas atklāšanas statuss:
0 - (noklusējums) hostu grupa ir atklāta,
1 - hostu grupa vairs nav atklāta.
selectHostPrototypes query Atgriezt hostPrototypes īpašību ar hostu prototipiem, kas atklāja šo hostu grupu.
selectHosts query Atgriezt hosts īpašību ar hostiem, kas pieder hostu grupai.

Atbalsta count.
limitSelects integer Ierobežo ierakstu skaitu, ko atgriež apakšatlases.

Attiecas uz šādām apakšatlasēm:
selectHosts - rezultāti tiks kārtoti pēc host.
sortfield string/array Kārtot rezultātu pēc norādītajām īpašībām.

Iespējamās vērtības: groupid, name.
countOutput boolean Šie parametri ir aprakstīti atsauces komentāros.
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 Šis parametrs ir novecojis, lūdzu, izmantojiet with_monitored_hosts.
Atgriezt tikai hostu grupas, kas satur uzraudzītus hostus.
real_hosts
(deprecated)		 flag Šis parametrs ir novecojis, lūdzu, izmantojiet with_hosts.
Atgriezt tikai hostu grupas, kas satur hostus.

Atgrieztās vērtības

(integer/array) Atgriež:

  • objektu masīvu
  • iegūto objektu skaitu, ja ir izmantots parametrs countOutput

Piemēri

Datu izgūšana pēc nosaukuma

Izgūstiet visus datus par divām hostu grupām ar nosaukumiem "Zabbix servers" un "Linux servers".

Pieprasījums:

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

Atbilde:

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

Skatiet arī

Avots

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