host.get

Beschreibung

integer/array host.get(object parameters)

Die Methode ermöglicht es Ihnen, Hosts anhand der angegebenen Parameter abzurufen.

Diese Methode ist für Benutzer aller Typen verfügbar. Die Berechtigung zum Aufruf der Methode kann in den Einstellungen der Benutzerrolle widerrufen werden. Weitere Informationen finden Sie unter Benutzerrollen.

Parameter

(object) Parameter zur Definition der gewünschten Ausgabe.

Die Methode unterstützt die folgenden Parameter.

Parameter Typ Beschreibung
groupids ID/array Gibt nur Hosts zurück, die zu den angegebenen Gruppen gehören.
dserviceids ID/array Gibt nur Hosts zurück, die mit den angegebenen erkannten Diensten verknüpft sind.
graphids ID/array Gibt nur Hosts zurück, die über die angegebenen Graphen verfügen.
hostids ID/array Gibt nur Hosts mit den angegebenen Host-IDs zurück.
httptestids ID/array Gibt nur Hosts zurück, die über die angegebenen Webtests verfügen.
interfaceids ID/array Gibt nur Hosts zurück, die die angegebenen Schnittstellen verwenden.
itemids ID/array Gibt nur Hosts zurück, die über die angegebenen Datenpunkte verfügen.
maintenanceids ID/array Gibt nur Hosts zurück, die von den angegebenen Wartungen betroffen sind.
monitored_hosts flag Gibt nur überwachte Hosts zurück.
proxyids ID/array Gibt nur Hosts zurück, die von den angegebenen Proxys überwacht werden.
proxy_groupids ID/array Gibt nur Hosts zurück, die von den angegebenen Proxy-Gruppen überwacht werden.
templated_hosts flag Gibt sowohl Hosts als auch Vorlagen zurück.
templateids ID/array Gibt nur Hosts zurück, die mit den angegebenen Vorlagen verknüpft sind.
triggerids ID/array Gibt nur Hosts zurück, die über die angegebenen Auslöser verfügen.
with_items flag Gibt nur Hosts zurück, die über Datenpunkte verfügen.

Überschreibt die Parameter with_monitored_items und with_simple_graph_items.
with_item_prototypes flag Gibt nur Hosts zurück, die über Datenpunkt-Prototypen verfügen.

Überschreibt den Parameter with_simple_graph_item_prototypes.
with_simple_graph_item_prototypes flag Gibt nur Hosts zurück, die über Datenpunkt-Prototypen verfügen, die für die Erstellung aktiviert sind und einen numerischen Informationstyp haben.
with_graphs flag Gibt nur Hosts zurück, die über Graphen verfügen.
with_graph_prototypes flag Gibt nur Hosts zurück, die über Graph-Prototypen verfügen.
with_httptests flag Gibt nur Hosts zurück, die über Webtests verfügen.

Überschreibt den Parameter with_monitored_httptests.
with_monitored_httptests flag Gibt nur Hosts zurück, die über aktivierte Webtests verfügen.
with_monitored_items flag Gibt nur Hosts zurück, die über aktivierte Datenpunkte verfügen.

Überschreibt den Parameter with_simple_graph_items.
with_monitored_triggers flag Gibt nur Hosts zurück, die über aktivierte Auslöser verfügen. Alle im Auslöser verwendeten Datenpunkte müssen ebenfalls aktiviert sein.
with_simple_graph_items flag Gibt nur Hosts zurück, die über Datenpunkte mit numerischem Informationstyp verfügen.
with_triggers flag Gibt nur Hosts zurück, die über Auslöser verfügen.

Überschreibt den Parameter with_monitored_triggers.
withProblemsSuppressed boolean Wenn auf true gesetzt, werden nur Hosts mit unterdrückten Problemen zurückgegeben.
evaltype integer Tag-Auswertungsmethode.

Mögliche Werte:
0 - (Standard) Und/Oder;
2 - Oder.
severities integer/array Gibt Hosts zurück, die nur Probleme mit den angegebenen Schweregraden haben. Gilt nur, wenn das Problemobjekt ein Auslöser ist.
tags object/array Gibt nur Hosts mit den angegebenen Tags zurück.
Format: [{"tag": "<tag>", "value": "<value>", "operator": "<operator>"}, ...].
Ein leeres Array gibt alle Hosts zurück.

Mögliche Werte für Operatoren:
0 - (Standard) Enthält;
1 - Ist gleich;
2 - Enthält nicht;
3 - Ist nicht gleich;
4 - Existiert;
5 - Existiert nicht.
inheritedTags boolean Gibt Hosts zurück, die die angegebenen tags auch in allen verknüpften Vorlagen haben.

Mögliche Werte:
true - Verknüpfte Vorlagen müssen ebenfalls die angegebenen tags haben;
false - (Standard) Tags verknüpfter Vorlagen werden ignoriert.
selectDiscoveryData query Gibt eine Eigenschaft discoveryData mit den Daten des Host-Erkennungsobjekts zurück. Das Host-Erkennungsobjekt verknüpft einen erkannten Host mit einem Host-Prototyp, aus dem er erkannt wurde.

Es verfügt über die folgenden Eigenschaften:
host - (string) ID des Hosts;
parent_hostid - (string) ID des Host-Prototyps, aus dem der Host erstellt wurde;
status - (int) Erkennungsstatus des Hosts:
0 - (Standard) Host wurde erkannt,
1 - Host wird nicht mehr erkannt;
ts_delete - (timestamp) Zeitpunkt, zu dem ein nicht mehr erkannter Host gelöscht wird;
ts_disable - (timestamp) Zeitpunkt, zu dem ein nicht mehr erkannter Host deaktiviert wird;
disable_source - (int) Gibt an, ob der Host durch eine LLD-Regel oder manuell deaktiviert wurde:
0 - (Standard) automatisch deaktiviert,
1 - durch eine LLD-Regel deaktiviert.
selectDiscoveryRule query Gibt eine Eigenschaft discoveryRule mit der Low-Level-Discovery-Regel zurück, durch die der Host erstellt wurde (aus einem Host-Prototyp bei der VMware-Überwachung).
selectDiscoveryRules query Gibt eine Eigenschaft discoveryRules mit den Host-LLD-Regeln zurück.

Unterstützt count.
selectGraphs query Gibt eine Eigenschaft graphs mit den Host-Graphen zurück.

Unterstützt count.
selectHostGroups query Gibt eine Eigenschaft hostgroups mit den Daten der Hostgruppen zurück, denen der Host angehört.
selectHttpTests query Gibt eine Eigenschaft httpTests mit den Webszenarien des Hosts zurück.

Unterstützt count.
selectInterfaces query Gibt eine Eigenschaft interfaces mit den Host-Schnittstellen zurück.

Unterstützt count.
selectInventory query Gibt eine Eigenschaft inventory mit den Inventardaten des Hosts zurück.
selectItems query Gibt eine Eigenschaft items mit den Datenpunkten des Hosts zurück.

Unterstützt count.
selectMacros query Gibt eine Eigenschaft macros mit den Host-Makros zurück.
selectParentTemplates query Gibt eine Eigenschaft parentTemplates mit den Vorlagen zurück, mit denen der Host verknüpft ist.

Zusätzlich zu den Feldern des Vorlagenobjekts enthält sie link_type - (integer) die Art der Verknüpfung der Vorlage mit dem Host.
Mögliche Werte:
0 - (Standard) manuell verknüpft;
1 - automatisch durch LLD verknüpft.

Unterstützt count.
selectDashboards query Gibt eine Eigenschaft dashboards zurück.

Unterstützt count.
selectTags query Gibt eine Eigenschaft tags mit den Host-Tags zurück.
selectInheritedTags query Gibt eine Eigenschaft inheritedTags mit Tags zurück, die sich auf allen mit dem Host verknüpften Vorlagen befinden.
selectTriggers query Gibt eine Eigenschaft triggers mit den Host-Auslösern zurück.

Unterstützt count.
selectValueMaps query Gibt eine Eigenschaft valuemaps mit den Wertzuordnungen des Hosts zurück.
filter object Gibt nur Ergebnisse zurück, die exakt mit dem angegebenen Filter übereinstimmen.

Akzeptiert ein Objekt, dessen Schlüssel Eigenschaftsnamen und dessen Werte entweder ein einzelner Wert oder ein Array von abzugleichenden Werten sind.

Unterstützt keine Eigenschaften des Datentyps text.

Unterstützt zusätzliche Eigenschaften: Eigenschaften der Host-Schnittstelle.
limitSelects integer Begrenzt die Anzahl der von Unterabfragen zurückgegebenen Datensätze.

Gilt für die folgenden Unterabfragen:
selectParentTemplates - Ergebnisse werden nach host sortiert;
selectInterfaces;
selectItems - sortiert nach name;
selectDiscoveryRules - sortiert nach name;
selectTriggers - sortiert nach description;
selectGraphs - sortiert nach name;
selectDashboards - sortiert nach name.
search object Gibt Ergebnisse zurück, die dem angegebenen Muster entsprechen (ohne Beachtung der Groß-/Kleinschreibung).

Akzeptiert ein Objekt, dessen Schlüssel Eigenschaftsnamen und dessen Werte Suchzeichenfolgen sind. Wenn keine zusätzlichen Optionen angegeben werden, wird eine Suche mit LIKE "%…%" durchgeführt.

Unterstützt nur Eigenschaften der Datentypen string und text.

Unterstützt zusätzliche Eigenschaften: Eigenschaften der Host-Schnittstelle.
searchInventory object Gibt Hosts zurück, deren Inventardaten dem angegebenen Muster entsprechen (ohne Beachtung der Groß-/Kleinschreibung).

Akzeptiert ein Objekt, dessen Schlüssel Eigenschaftsnamen und dessen Werte Suchzeichenfolgen sind. Wenn keine zusätzlichen Optionen angegeben werden, wird eine Suche mit LIKE "%…%" durchgeführt.

Unterstützt nur Eigenschaften der Datentypen string und text.
sortfield string/array Sortiert das Ergebnis nach den angegebenen Eigenschaften.

Mögliche Werte: hostid, host, name, status.
countOutput boolean Diese Parameter werden im Referenzkommentar beschrieben.
editable boolean
excludeSearch boolean
limit integer
output query
preservekeys boolean
searchByAny boolean
searchWildcardsEnabled boolean
sortorder string/array
startSearch boolean
selectDiscoveries query Gibt eine Eigenschaft discoveries mit den Low-Level-Discovery-Regeln des Hosts zurück.

Unterstützt count.

Diese Abfrage ist veraltet. Verwenden Sie stattdessen selectDiscoveryRules.
selectHostDiscovery query Gibt eine Eigenschaft hostDiscovery mit den Daten des Host-Erkennungsobjekts zurück.

Diese Abfrage ist veraltet. Verwenden Sie stattdessen selectDiscoveryData.

Rückgabewerte

(integer/array) Kann die folgenden Dinge zurück geben:

  • ein Array von Objekten;
  • die Anzahl der abgerufenen Objekte, wenn der Parameter countOutput verwendet wurde.

Beispiele

Daten nach Namen abrufen

Rufen Sie alle Daten zu zwei Hosts mit den Namen „Zabbix server“ und „Linux server“ ab.

Anfrage:

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

Antwort:

{
    "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": "Der Zabbix-Monitoring-Server.",
            "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
}

Abrufen von Hostgruppen

Rufen Sie die Hostgruppen ab, deren Mitglied der Host „Zabbix server“ ist.

Anfrage:

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

Antwort:

{
    "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
}

Verknüpfte Vorlagen abrufen

Rufen Sie die IDs und Namen der mit dem Host „10084“ verknüpften Vorlagen ab.

Anfrage:

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

Antwort:

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

Abrufen von Hosts nach Vorlage

Rufen Sie Hosts ab, mit denen die Vorlage „10001“ (Linux by Zabbix Agent) verknüpft ist.

Anfrage:

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

Antwort:

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

Suche nach Host-Inventardaten

Rufen Sie Hosts ab, die „Linux“ im Host-Inventarfeld „OS“ enthalten.

Anfrage:

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

Antwort:

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

Suche nach Host-Tags

Rufen Sie Hosts ab, deren Tag „host-name“ gleich „linux-server“ ist.

Request:

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

Antwort:

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

Rufen Sie Hosts ab, die diese Tags nicht nur auf Host-Ebene, sondern auch in ihren verknüpften übergeordneten Vorlagen haben.

Request:

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

Antwort:

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

Rufen Sie Hosts ab, ausgenommen diejenigen mit dem Tag „component“.

Request:

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

Antwort:

{
    "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
}

Host mit Tags und Vorlagen-Tags suchen

Rufen Sie einen Host mit Tags und allen Tags ab, die mit übergeordneten Vorlagen verknüpft sind.

Anfrage:

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

Antwort:

{
    "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
}

Hosts nach Problem-Schweregrad suchen

Rufen Sie Hosts ab, die Probleme mit dem Schweregrad „Katastrophal“ haben.

Anfrage:

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

Antwort:

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

Rufen Sie Hosts ab, die Probleme mit den Schweregraden „Durchschnittlich“ und „Hoch“ haben.

Anfrage:

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

Antwort:

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

Abrufen von Host-Datenpunkten

Rufen Sie Datenpunkte für den Host „Zabbix server“ ab. Die Anfrage ist auf die Datenpunkt-Eigenschaften itemid, name und status beschränkt. Aufgrund der großen Antwortgröße wird im Beispiel nur eine Teilmenge der Datenpunkte angezeigt.

Anfrage:

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

Antwort:

{
  "jsonrpc": "2.0",
  "result": [
    {
      "hostid": "10084",
      "items": [
        {
          "itemid": "42227",
          "name": "Host-Name des laufenden Zabbix Agent",
          "status": "0"
        },
        {
          "itemid": "42237",
          "name": "Zabbix Agent ping",
          "status": "0"
        },
        {
          "itemid": "42250",
          "name": "Version des laufenden Zabbix Agent",
          "status": "0"
        },
        {
          "itemid": "42251",
          "name": "Maximale Anzahl offener Dateideskriptoren",
          "status": "0"
        },
        {
          "itemid": "42252",
          "name": "Maximale Anzahl von Prozessen",
          "status": "0"
        },
        {
          "itemid": "69869",
          "name": "Schnittstelle enp0s3: Verworfen eingehende Pakete",
          "status": "0"
        },
        {
          "itemid": "69870",
          "name": "Schnittstelle enp0s3: Eingehende Pakete mit Fehlern",
          "status": "0"
        },
        {
          "itemid": "69871",
          "name": "Schnittstelle enp0s3: Empfangene Bits",
          "status": "0"
        },
        {
          "itemid": "69872",
          "name": "Schnittstelle enp0s3: Verworfen ausgehende Pakete",
          "status": "0"
        },
        {
          "itemid": "69873",
          "name": "Schnittstelle enp0s3: Ausgehende Pakete mit Fehlern",
          "status": "0"
        },
        {
          "itemid": "69874",
          "name": "Schnittstelle enp0s3: Gesendete Bits",
          "status": "0"
        },
        {
          "itemid": "42253",
          "name": "Anzahl der Prozesse",
          "status": "0"
        },
        {
          "itemid": "42254",
          "name": "Anzahl der laufenden Prozesse",
          "status": "0"
        },
        {
          "itemid": "42255",
          "name": "Systemstartzeit",
          "status": "0"
        }
      ]
    }
  ],
  "id": 1
}

Siehe auch

Quelle

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