host.get

Apraksts

integer/array host.get(object parameters)

Šī metode ļauj iegūt hostus 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 nosaka vēlamo izvadi.

Metode atbalsta šādus parametrus.

Parametrs Tips Apraksts
groupids ID/array Atgriezt tikai hostus, kas pieder norādītajām grupām.
dserviceids ID/array Atgriezt tikai hostus, kas ir saistīti ar norādītajiem atklātajiem servisiem.
graphids ID/array Atgriezt tikai hostus, kuriem ir norādītie grafiki.
hostids ID/array Atgriezt tikai hostus ar norādītajiem hostu ID.
httptestids ID/array Atgriezt tikai hostus, kuriem ir norādītās tīmekļa pārbaudes.
interfaceids ID/array Atgriezt tikai hostus, kas izmanto norādītās saskarnes.
itemids ID/array Atgriezt tikai hostus, kuriem ir norādītie vienumi.
maintenanceids ID/array Atgriezt tikai hostus, kurus ietekmē norādītās apkopes.
monitored_hosts flag Atgriezt tikai uzraudzītos hostus.
proxyids ID/array Atgriezt tikai hostus, kurus uzrauga norādītie starpniekserveri.
proxy_groupids ID/array Atgriezt tikai hostus, kurus uzrauga norādītās starpniekserveru grupas.
templated_hosts flag Atgriezt gan hostus, gan veidnes.
templateids ID/array Atgriezt tikai hostus, kas ir sasaistīti ar norādītajām veidnēm.
triggerids ID/array Atgriezt tikai hostus, kuriem ir norādītie trigeri.
with_items flag Atgriezt tikai hostus, kuriem ir vienumi.

Pārraksta parametrus with_monitored_items un with_simple_graph_items.
with_item_prototypes flag Atgriezt tikai hostus, kuriem ir vienumu prototipi.

Pārraksta parametru with_simple_graph_item_prototypes.
with_simple_graph_item_prototypes flag Atgriezt tikai hostus, kuriem ir vienumu prototipi, kas ir iespējoti izveidei un kuriem ir skaitlisks informācijas tips.
with_graphs flag Atgriezt tikai hostus, kuriem ir grafiki.
with_graph_prototypes flag Atgriezt tikai hostus, kuriem ir grafiku prototipi.
with_httptests flag Atgriezt tikai hostus, kuriem ir tīmekļa pārbaudes.

Pārraksta parametru with_monitored_httptests.
with_monitored_httptests flag Atgriezt tikai hostus, kuriem ir iespējotas tīmekļa pārbaudes.
with_monitored_items flag Atgriezt tikai hostus, kuriem ir iespējoti vienumi.

Pārraksta parametru with_simple_graph_items.
with_monitored_triggers flag Atgriezt tikai hostus, kuriem ir iespējoti trigeri. Visiem vienumiem, kas tiek izmantoti trigerī, arī jābūt iespējotiem.
with_simple_graph_items flag Atgriezt tikai hostus, kuriem ir vienumi ar skaitlisku informācijas tipu.
with_triggers flag Atgriezt tikai hostus, kuriem ir trigeri.

Pārraksta parametru with_monitored_triggers.
withProblemsSuppressed boolean Ja iestatīts uz true, atgriezt tikai hostus ar apspiestām problēmām.
evaltype integer Birkas novērtēšanas metode.

Iespējamās vērtības:
0 - (noklusējums) Un/Vai;
2 - Vai.
severities integer/array Atgriezt hostus, kuriem ir tikai problēmas ar norādītajām nopietnības pakāpēm. Piemērojams tikai tad, ja problēmas objekts ir trigeris.
tags object/array Atgriezt tikai hostus ar norādītajām birkām.
Formāts: [{"tag": "<tag>", "value": "<value>", "operator": "<operator>"}, ...].
Tukšs masīvs atgriež visus hostus.

Iespējamās operator vērtības:
0 - (noklusējums) Satur;
1 - Vienāds ar;
2 - Nesatur;
3 - Nav vienāds ar;
4 - Eksistē;
5 - Neeksistē.
inheritedTags boolean Atgriezt hostus, kuriem norādītās tags ir arī visās ar tiem sasaistītajās veidnēs.

Iespējamās vērtības:
true - sasaistītajām veidnēm arī jābūt ar norādītajām tags;
false - (noklusējums) sasaistīto veidņu birkas tiek ignorētas.
selectDiscoveryData query Atgriezt discoveryData īpašību ar hosta atklāšanas objekta datiem. Hosta atklāšanas objekts sasaista atklātu hostu ar hosta prototipu, no kura tas tika atklāts.

Tam ir šādas īpašības:
host - (string) hosta ID;
parent_hostid - (string) hosta prototipa ID, no kura hosts tika izveidots;
status - (int) hosta atklāšanas statuss:
0 - (noklusējums) hosts ir atklāts,
1 - hosts vairs nav atklāts;
ts_delete - (timestamp) laiks, kad hosts, kas vairs netiek atklāts, tiks dzēsts;
ts_disable - (timestamp) laiks, kad hosts, kas vairs netiek atklāts, tiks atspējots;
disable_source - (int) indikators, vai hosts tika atspējots ar LLD kārtulu vai manuāli:
0 - (noklusējums) atspējots automātiski,
1 - atspējots ar LLD kārtulu.
selectDiscoveryRule query Atgriezt discoveryRule īpašību ar zema līmeņa atklāšanas kārtulu, kas izveidoja hostu (no hosta prototipa VMware uzraudzībā).
selectDiscoveryRules query Atgriezt discoveryRules īpašību ar hosta LLD kārtulām.

Atbalsta count.
selectGraphs query Atgriezt graphs īpašību ar hosta grafikiem.

Atbalsta count.
selectHostGroups query Atgriezt hostgroups īpašību ar to hostu grupu datiem, kurām hosts pieder.
selectHttpTests query Atgriezt httpTests īpašību ar hosta tīmekļa scenārijiem.

Atbalsta count.
selectInterfaces query Atgriezt interfaces īpašību ar hosta saskarnēm.

Atbalsta count.
selectInventory query Atgriezt inventory īpašību ar hosta inventāra datiem.
selectItems query Atgriezt items īpašību ar hosta vienumiem.

Atbalsta count.
selectMacros query Atgriezt macros īpašību ar hosta makrosiem.
selectParentTemplates query Atgriezt parentTemplates īpašību ar veidnēm, ar kurām hosts ir sasaistīts.

Papildus Veidnes objekta laukiem tā satur link_type - (integer) veidu, kādā veidne ir sasaistīta ar hostu.
Iespējamās vērtības:
0 - (noklusējums) sasaistīta manuāli;
1 - automātiski sasaistīta ar LLD.

Atbalsta count.
selectDashboards query Atgriezt dashboards īpašību.

Atbalsta count.
selectTags query Atgriezt tags īpašību ar hosta birkām.
selectInheritedTags query Atgriezt inheritedTags īpašību ar birkām, kas ir visās veidnēs, kuras ir sasaistītas ar hostu.
selectTriggers query Atgriezt triggers īpašību ar hosta trigeriem.

Atbalsta count.
selectValueMaps query Atgriezt valuemaps īpašību ar hosta vērtību kartēm.
filter object Atgriezt tikai tos rezultātus, kas precīzi atbilst norādītajam filtram.

Pieņem objektu, kur atslēgas ir īpašību nosaukumi, bet vērtības ir vai nu viena vērtība, vai vērtību masīvs, ar ko salīdzināt.

Neatbalsta text datu tipa īpašības.

Atbalsta papildu īpašības: Host interface īpašības.
limitSelects integer Ierobežo apakšatlases vaicājumu atgriezto ierakstu skaitu.

Attiecas uz šādām apakšatlasēm:
selectParentTemplates - rezultāti tiks kārtoti pēc host;
selectInterfaces;
selectItems - kārtoti pēc name;
selectDiscoveryRules - kārtoti pēc name;
selectTriggers - kārtoti pēc description;
selectGraphs - kārtoti pēc name;
selectDashboards - kārtoti pēc name.
search object Atgriezt rezultātus, kas atbilst norādītajam paraugam (reģistrnejutīgi).

Pieņem objektu, kur atslēgas ir īpašību nosaukumi, bet vērtības ir virknes, ko meklēt. Ja nav norādītas papildu opcijas, tiks veikta LIKE "%…%" meklēšana.

Atbalsta tikai string un text datu tipa īpašības.

Atbalsta papildu īpašības: Host interface īpašības.
searchInventory object Atgriezt hostus, kuriem ir inventāra dati, kas atbilst norādītajam paraugam (reģistrnejutīgi).

Pieņem objektu, kur atslēgas ir īpašību nosaukumi, bet vērtības ir virknes, ko meklēt. Ja nav norādītas papildu opcijas, tiks veikta LIKE "%…%" meklēšana.

Atbalsta tikai string un text datu tipa īpašības.
sortfield string/array Kārtot rezultātu pēc norādītajām īpašībām.

Iespējamās vērtības: hostid, host, name, status.
countOutput boolean Šie parametri ir aprakstīti atsauces komentārā.
editable boolean
excludeSearch boolean
limit integer
output query
preservekeys boolean
searchByAny boolean
searchWildcardsEnabled boolean
sortorder string/array
startSearch boolean
selectDiscoveries query Atgriezt discoveries īpašību ar hosta zema līmeņa atklāšanas kārtulām.

Atbalsta count.

Šis vaicājums ir novecojis, lūdzu, izmantojiet selectDiscoveryRules.
selectHostDiscovery query Atgriezt hostDiscovery īpašību ar hosta atklāšanas objekta datiem.

Šis vaicājums ir novecojis, lūdzu, izmantojiet selectDiscoveryData.

Atgrieztās vērtības

(integer/array) Atgriež vienu no šīm vērtībām:

  • 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 diviem hostiem ar nosaukumiem "Zabbix server" un "Linux server".

Pieprasījums:

{
    "jsonrpc": "2.0",
    "method": "host.get",
    "params": {
        "filter": {
            "host": [
                "Zabbix server",
                "Linux server"
            ]
        }
    },
    "id": 1
}

Atbilde:

{
    "jsonrpc": "2.0",
    "result": [
        {
            "hostid": "10160",
            "proxyid": "0",
            "host": "Zabbix server",
            "status": "0",
            "ipmi_authtype": "-1",
            "ipmi_privilege": "2",
            "ipmi_username": "",
            "ipmi_password": "",
            "maintenanceid": "0",
            "maintenance_status": "0",
            "maintenance_type": "0",
            "maintenance_from": "0",
            "name": "Zabbix server",
            "flags": "0",
            "description": "Zabbix uzraudzības serveris.",
            "tls_connect": "1",
            "tls_accept": "1",
            "tls_issuer": "",
            "tls_subject": "",
            "proxy_groupid": "0",
            "monitored_by": "0",
            "inventory_mode": "1",
            "active_available": "1",
            "assigned_proxyid": "0"
        },
        {
            "hostid": "10167",
            "proxyid": "0",
            "host": "Linux server",
            "status": "0",
            "ipmi_authtype": "-1",
            "ipmi_privilege": "2",
            "ipmi_username": "",
            "ipmi_password": "",
            "maintenanceid": "0",
            "maintenance_status": "0",
            "maintenance_type": "0",
            "maintenance_from": "0",
            "name": "Linux server",
            "flags": "0",
            "description": "",
            "tls_connect": "1",
            "tls_accept": "1",
            "tls_issuer": "",
            "tls_subject": "",
            "proxy_groupid": "0",
            "monitored_by": "0",
            "inventory_mode": "1",
            "active_available": "1",
            "assigned_proxyid": "0"
        }
    ],
    "id": 1
}

Hostu grupu izgūšana

Izgūstiet hostu grupas, kuru dalībnieks ir hosts "Zabbix server".

Pieprasījums:

{
    "jsonrpc": "2.0",
    "method": "host.get",
    "params": {
        "output": ["hostid"],
        "selectHostGroups": "extend",
        "filter": {
            "host": [
                "Zabbix server"
            ]
        }
    },
    "id": 1
}

Atbilde:

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

Saistīto veidņu izgūšana

Izgūstiet hostam "10084" saistīto veidņu ID un nosaukumus.

Pieprasījums:

{
    "jsonrpc": "2.0",
    "method": "host.get",
    "params": {
        "output": ["hostid"],
        "selectParentTemplates": [
            "templateid",
            "name"
        ],
        "hostids": "10084"
    },
    "id": 1
}

Atbilde:

{
    "jsonrpc": "2.0",
    "result": [
        {
            "hostid": "10084",
            "parentTemplates": [
                {
                    "name": "Linux",
                    "templateid": "10001"
                },
                {
                    "name": "Zabbix Server",
                    "templateid": "10047"
                }
            ]
        }
    ],
    "id": 1
}

Hostu izgūšana pēc veidnes

Izgūstiet hostus, kuriem ir piesaistīta veidne "10001" (Linux by Zabbix aģents).

Pieprasījums:

{
    "jsonrpc": "2.0",
    "method": "host.get",
    "params": {
        "output": ["hostid", "name"],
        "templateids": "10001"
    },
    "id": 1
}

Atbilde:

{
    "jsonrpc": "2.0",
    "result": [
        {
            "templateid": "10001",
            "hosts": [
                {
                    "hostid": "10084",
                    "name": "Zabbix server"
                },
                {
                    "hostid": "10603",
                    "name": "Host 1"
                },
                {
                    "hostid": "10604",
                    "name": "Host 2"
                }
            ]
        }
    ],
    "id": 1
}

Meklēšana pēc hosta inventāra datiem

Iegūstiet hostus, kuru hosta inventāra lauks "OS" satur "Linux".

Pieprasījums:

{
    "jsonrpc": "2.0",
    "method": "host.get",
    "params": {
        "output": [
            "host"
        ],
        "selectInventory": [
            "os"
        ],
        "searchInventory": {
            "os": "Linux"
        }
    },
    "id": 1
}

Atbilde:

{
    "jsonrpc": "2.0",
    "result": [
        {
            "hostid": "10084",
            "host": "Zabbix server",
            "inventory": {
                "os": "Linux Ubuntu"
            }
        },
        {
            "hostid": "10107",
            "host": "Linux server",
            "inventory": {
                "os": "Linux Mint"
            }
        }
    ],
    "id": 1
}

Meklēšana pēc hostu tagiem

Iegūstiet hostus, kuriem tags "host-name" ir vienāds ar "linux-server".

Pieprasījums:

{
    "jsonrpc": "2.0",
    "method": "host.get",
    "params": {
        "output": ["hostid"],
        "selectTags": "extend",
        "evaltype": 0,
        "tags": [
            {
                "tag": "host-name",
                "value": "linux-server",
                "operator": 1
            }
        ]
    },
    "id": 1
}

Atbilde:

{
    "jsonrpc": "2.0",
    "result": [
        {
            "hostid": "10085",
            "tags": [
                {
                    "tag": "host-name",
                    "value": "linux-server",
                    "automatic": "0"
                },
                {
                    "tag": "os",
                    "value": "rhel-7",
                    "automatic": "0"
                }
            ]
        }
    ],
    "id": 1
}

Iegūstiet hostus, kuriem šie tagi ir ne tikai hosta līmenī, bet arī to piesaistītajās vecākveidnēs.

Pieprasījums:

{
    "jsonrpc": "2.0",
    "method": "host.get",
    "params": {
        "output": ["name"],
        "tags": [
            {
                "tag": "os",
                "value": "rhel-7",
                "operator": 1
            }
        ],
        "inheritedTags": true
    },
    "id": 1
}

Atbilde:

{
    "jsonrpc": "2.0",
    "result": [
        {
            "hostid": "10623",
            "name": "PC room 1"
        },
        {
            "hostid": "10601",
            "name": "Office"
        }
    ],
    "id": 1
}

Iegūstiet hostus, izslēdzot tos, kuriem ir tags "component".

Pieprasījums:

{
    "jsonrpc": "2.0",
    "method": "host.get",
    "params": {
        "output": ["hostid"],
        "selectTags": "extend",
        "evaltype": 0,
        "tags": [
            {
                "tag": "component",
                "value": "",
                "operator": 5
            }
        ]
    },
    "id": 1
}

Atbilde:

{
    "jsonrpc": "2.0",
    "result": [
        {
            "hostid": "10084",
            "tags": [
                {
                    "tag": "class",
                    "value": "os",
                    "automatic": "0"
                },
                {
                    "tag": "target",
                    "value": "linux",
                    "automatic": "0"
                }
            ]
        },
        {
            "hostid": "10629",
            "tags": [
                {
                    "tag": "class",
                    "value": "application",
                    "automatic": "0"
                },
                {
                    "tag": "target",
                    "value": "browser",
                    "automatic": "0"
                }
            ]
        }
    ],
    "id": 1
}

Hosta meklēšana ar birkām un veidnes birkām

Iegūstiet hostu ar birkām un visām birkām, kas ir saistītas ar vecākveidnēm.

Pieprasījums:

{
    "jsonrpc": "2.0",
    "method": "host.get",
    "params": {
        "output": ["name"],
        "hostids": 10502,
        "selectTags": ["tag", "value"],
        "selectInheritedTags": ["tag", "value"]
    },
    "id": 1
}

Atbilde:

{
    "jsonrpc": "2.0",
    "result": [
        {
            "hostid": "10502",
            "name": "Desktop",
            "tags": [
                {
                    "tag": "host-name",
                    "value": "linux-server"
                },
                {
                    "tag": "os",
                    "value": "rhel-7"
                }
            ],
            "inheritedTags": [
                {
                    "tag": "class",
                    "value": "os"
                },
                {
                    "tag": "target",
                    "value": "linux"
                },
                {
                    "tag": "os",
                    "value": "rhel-7"
                }
            ]
        }
    ],
    "id": 1
}

Hostu meklēšana pēc problēmas nopietnības pakāpes

Iegūstiet hostus, kuriem ir "Disaster" problēmas.

Pieprasījums:

{
    "jsonrpc": "2.0",
    "method": "host.get",
    "params": {
        "output": ["name"],
        "severities": 5
    },
    "id": 1
}

Atbilde:

{
    "jsonrpc": "2.0",
    "result": [
        {
            "hostid": "10160",
            "name": "Zabbix server"
        }
    ],
    "id": 1
}

Iegūstiet hostus, kuriem ir "Average" un "High" problēmas.

Pieprasījums:

{
    "jsonrpc": "2.0",
    "method": "host.get",
    "params": {
        "output": ["name"],
        "severities": [3, 4]
    },
    "id": 1
}

Atbilde:

{
    "jsonrpc": "2.0",
    "result": [
        {
            "hostid": "20170",
            "name": "Database"
        },
        {
            "hostid": "20183",
            "name": "workstation"
        }
    ],
    "id": 1
}

Hosta vienumu izgūšana

Izgūstiet vienumus hostam "Zabbix server". Pieprasījums ir ierobežots ar vienuma īpašībām itemid, name un status. Lielā atbildes apjoma dēļ piemērā ir parādīta tikai daļa no vienumiem.

Pieprasījums:

{
    "jsonrpc": "2.0",
    "method": "host.get",
    "params": {
        "output": ["hostid"],
        "selectItems": ["itemid","name","status"],
        "filter": {
            "host": [
                "Zabbix server"
            ]
        }
    },
    "id": 1
}

Atbilde:

{
  "jsonrpc": "2.0",
  "result": [
    {
      "hostid": "10084",
      "items": [
        {
          "itemid": "42227",
          "name": "Darbojošā Zabbix aģenta hosta nosaukums",
          "status": "0"
        },
        {
          "itemid": "42237",
          "name": "Zabbix aģenta ping",
          "status": "0"
        },
        {
          "itemid": "42250",
          "name": "Darbojošā Zabbix aģenta versija",
          "status": "0"
        },
        {
          "itemid": "42251",
          "name": "Maksimālais atvērto failu deskriptoru skaits",
          "status": "0"
        },
        {
          "itemid": "42252",
          "name": "Maksimālais procesu skaits",
          "status": "0"
        },
        {
          "itemid": "69869",
          "name": "Saskarne enp0s3: atmestās ienākošās paketes",
          "status": "0"
        },
        {
          "itemid": "69870",
          "name": "Saskarne enp0s3: ienākošās paketes ar kļūdām",
          "status": "0"
        },
        {
          "itemid": "69871",
          "name": "Saskarne enp0s3: saņemtie biti",
          "status": "0"
        },
        {
          "itemid": "69872",
          "name": "Saskarne enp0s3: atmestās izejošās paketes",
          "status": "0"
        },
        {
          "itemid": "69873",
          "name": "Saskarne enp0s3: izejošās paketes ar kļūdām",
          "status": "0"
        },
        {
          "itemid": "69874",
          "name": "Saskarne enp0s3: nosūtītie biti",
          "status": "0"
        },
        {
          "itemid": "42253",
          "name": "Procesu skaits",
          "status": "0"
        },
        {
          "itemid": "42254",
          "name": "Darbojošos procesu skaits",
          "status": "0"
        },
        {
          "itemid": "42255",
          "name": "Sistēmas sāknēšanas laiks",
          "status": "0"
        }
      ]
    }
  ],
  "id": 1
}

Skatiet arī

Avots

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