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 definē vēlamo izvadi.

Metode atbalsta šādus parametrus.

Parameter Type Description
groupids ID/array Atgriezt tikai tos hosts, kas pieder norādītajām grupām.
dserviceids ID/array Atgriezt tikai tos hosts, kas ir saistīti ar norādītajiem atklātajiem pakalpojumiem.
graphids ID/array Atgriezt tikai tos hosts, kuriem ir norādītie grafiki.
hostids ID/array Atgriezt tikai tos hosts ar norādītajiem host ID.
httptestids ID/array Atgriezt tikai tos hosts, kuriem ir norādītās tīmekļa pārbaudes.
interfaceids ID/array Atgriezt tikai tos hosts, kas izmanto norādītās saskarnes.
itemids ID/array Atgriezt tikai tos hosts, kuriem ir norādītie vienumi.
maintenanceids ID/array Atgriezt tikai tos hosts, kurus ietekmē norādītās apkalpes darbības.
monitored_hosts flag Atgriezt tikai uzraudzītos hosts.
proxyids ID/array Atgriezt tikai tos hosts, kurus uzrauga norādītie starpniekserveri.
proxy_groupids ID/array Atgriezt tikai tos hosts, kurus uzrauga norādītās starpniekserveru grupas.
templated_hosts flag Atgriezt gan hosts, gan veidnes.
templateids ID/array Atgriezt tikai tos hosts, kas ir saistīti ar norādītajām veidnēm.
triggerids ID/array Atgriezt tikai tos hosts, kuriem ir norādītie trigeri.
with_items flag Atgriezt tikai tos hosts, kuriem ir vienumi.

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

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

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

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

Pārraksta parametru with_monitored_triggers.
withProblemsSuppressed boolean Ja iestatīts uz true, atgriezt tikai tos hosts, kuriem ir nomāktas problēmas.
evaltype integer Tagu novērtēšanas metode.

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

Iespējamās operatora 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 hosts, kuriem norādītie tags ir arī visās to saistītajās veidnēs.

Iespējamās vērtības:
true - saistītajām veidnēm arī jābūt ar norādītajiem tags;
false - (noklusējums) saistīto veidņu tagi tiek ignorēti.
selectDiscoveries query Atgriezt discoveries īpašību ar host zema līmeņa atklāšanas noteikumiem.

Atbalsta count.
selectDiscoveryRule query Atgriezt discoveryRule īpašību ar zema līmeņa atklāšanas noteikumu, kas izveidoja host (no host prototipa VMware uzraudzībā).
selectGraphs query Atgriezt graphs īpašību ar host grafikiem.

Atbalsta count.
selectHostDiscovery query Atgriezt hostDiscovery īpašību ar host atklāšanas objekta datiem.

Host atklāšanas objekts saista atklātu host ar host prototipu vai host prototipus ar LLD noteikumu, un tam ir šādas īpašības:
host - (string) host prototipa host;
hostid - (string) atklātā host vai host prototipa ID;
parent_hostid - (string) host prototipa ID, no kura host ir izveidots;
parent_itemid - (string) LLD noteikuma ID, kas izveidoja atklāto host;
lastcheck - (timestamp) laiks, kad host pēdējo reizi tika atklāts;
status - (int) host atklāšanas statuss:
0 - (noklusējums) host ir atklāts,
1 - host vairs nav atklāts;
ts_delete - (timestamp) laiks, kad host, kas vairs nav atklāts, tiks dzēsts;
ts_disable - (timestamp) laiks, kad host, kas vairs nav atklāts, tiks atspējots;
disable_source - (int) indikators, vai host tika atspējots ar LLD noteikumu vai manuāli:
0 - (noklusējums) atspējots automātiski,
1 - atspējots ar LLD noteikumu.
selectHostGroups query Atgriezt hostgroups īpašību ar host grupu datiem, kuriem host pieder.
selectHttpTests query Atgriezt httpTests īpašību ar host tīmekļa scenārijiem.

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

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

Atbalsta count.
selectMacros query Atgriezt macros īpašību ar host makro.
selectParentTemplates query Atgriezt parentTemplates īpašību ar veidnēm, ar kurām host ir saistīts.

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

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

Atbalsta count.
selectTags query Atgriezt tags īpašību ar host tagiem.
selectInheritedTags query Atgriezt inheritedTags īpašību ar tagiem, kas ir visās veidnēs, kuras ir saistītas ar host.
selectTriggers query Atgriezt triggers īpašību ar host trigeriem.

Atbalsta count.
selectValueMaps query Atgriezt valuemaps īpašību ar host 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 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 ierakstu skaitu, ko atgriež apakšatlases.

Attiecas uz šādām apakšatlasēm:
selectParentTemplates - rezultāti tiks kārtoti pēc host;
selectInterfaces;
selectItems - kārtoti pēc name;
selectDiscoveries - 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 (nav reģistrjutīgs).

Pieņem objektu, kur atslēgas ir īpašību nosaukumi, bet vērtības ir meklējamās virknes. Ja netiek 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 hosts, kuriem ir inventāra dati, kas atbilst norādītajam paraugam (nav reģistrjutīgs).

Pieņem objektu, kur atslēgas ir īpašību nosaukumi, bet vērtības ir meklējamās virknes. Ja netiek 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
selectGroups
(deprecated)		 query Šis parametrs ir novecojis, lūdzu, izmantojiet selectHostGroups.
Atgriezt groups īpašību ar host grupu datiem, kuriem host pieder.

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
}

Hosts vienumu izgūšana

Izgūstiet vienumus hostam "Zabbix server". Pieprasījums ir ierobežots līdz vienumu ī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": "Host name of Zabbix agent running",
          "status": "0"
        },
        {
          "itemid": "42237",
          "name": "Zabbix agent ping",
          "status": "0"
        },
        {
          "itemid": "42250",
          "name": "Version of Zabbix agent running",
          "status": "0"
        },
        {
          "itemid": "42251",
          "name": "Maximum number of open file descriptors",
          "status": "0"
        },
        {
          "itemid": "42252",
          "name": "Maximum number of processes",
          "status": "0"
        },
        {
          "itemid": "69869",
          "name": "Interface enp0s3: Inbound packets discarded",
          "status": "0"
        },
        {
          "itemid": "69870",
          "name": "Interface enp0s3: Inbound packets with errors",
          "status": "0"
        },
        {
          "itemid": "69871",
          "name": "Interface enp0s3: Bits received",
          "status": "0"
        },
        {
          "itemid": "69872",
          "name": "Interface enp0s3: Outbound packets discarded",
          "status": "0"
        },
        {
          "itemid": "69873",
          "name": "Interface enp0s3: Outbound packets with errors",
          "status": "0"
        },
        {
          "itemid": "69874",
          "name": "Interface enp0s3: Bits sent",
          "status": "0"
        },
        {
          "itemid": "42253",
          "name": "Number of processes",
          "status": "0"
        },
        {
          "itemid": "42254",
          "name": "Number of running processes",
          "status": "0"
        },
        {
          "itemid": "42255",
          "name": "System boot time",
          "status": "0"
        }
      ]
    }
  ],
  "id": 1
}

Skatiet arī

Avots

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