hostprototype.get

Leírás

integer/array hostprototype.get(objektumparaméterek)

A módszer lehetővé teszi a gazdaprototípusok lekérését a megadottak szerint paramétereket.

Ez a módszer bármilyen típusú felhasználó számára elérhető. Engedélyek A metódus meghívása a felhasználói szerepkör beállításaiban visszavonható. Lásd: User roles további információért.

Paraméterek

(object) A kívánt kimenetet meghatározó paraméterek.

A módszer a következő paramétereket támogatja.

Paraméter Típus Leírás
hostids string/array Csak a megadott azonosítókkal rendelkező gazdagép prototípusokat adja vissza.
discoveryids string/array Csak olyan gazdagép prototípust ad vissza, amely az adott LLD-szabályokhoz tartozik.
inherited boolean Ha true-ra van állítva, csak a sablonból örökölt elemeket adja vissza.
selectDiscoveryRule query Vitasson vissza egy discoveryRule tulajdonságot azzal az LLD-szabállyal, amelyhez a gazdagép prototípusa tartozik.
selectInterfaces query Egy interfaces tulajdonság visszaadása a gazdagép prototípus egyéni interfészeivel.
selectGroupLinks query Vissza vissza a groupLinks tulajdonságot a gazdagép prototípusának csoporthivatkozásaival.
selectGroupPrototypes query Vissza vissza a groupPrototypes tulajdonságot a gazdagép prototípusának csoportprototípusaival.
selectMacros query Egy macros tulajdonság visszaadása gazdagép prototípus makróval.
selectParentHost query Vitasson vissza egy parentHost tulajdonságot azzal a gazdagéppel, amelyhez a gazdagép prototípusa tartozik.
selectTags query Vissza vissza a tags tulajdonságot gazdagép prototípus címkéivel.
selectTemplates query Vitasson vissza egy templates tulajdonságot a gazdagép prototípusához csatolt sablonokkal.

Támogatja a count.
sortfield string/array Rendezd az eredményt a megadott tulajdonságok szerint.

A lehetséges értékek: "hostid", "host", "name" és "status".
countOutput boolean Ezek a paraméterek, amelyek minden get metódusnál közösek, a Generic Zabbix API information oldalon találhatók.
szerkeszthető logikai
excludeSearch logikai
szűrő objektum
korlát egész szám
kimenet lekérdezés
preservekeys boolean
kereső objektum
searchByAny boolean
searchWildcardsEnabled boolean
sortorder karakterlánc/tömb
startSearch boolean

Visszatérési értékek

(integer/array) A következőket adja vissza:

  • objektumok tömbje;
  • a letöltött objektumok száma, ha a countOutput paraméter rendelkezik használtak.

Példák

Gazda prototípusainak lekérése egy LLD-szabályból

Töltse le az összes gazdagép prototípusát, csoporthivatkozásait, csoport prototípusait és címkéket egy LLD-szabályból.

Kérés:

{
    "jsonrpc": "2.0",
    "method": "hostprototype.get",
    "params": {
        "output": "kiterjesztés",
        "selectInterfaces": "extend",
        "selectGroupLinks": "extend",
        "selectGroupPrototypes": "extend",
        "selectTags": "extend",
        "discoveryids": "23554"
    },
    "auth": "038e1d7b1735c6a5436ee9eae095879e",
    "azonosító": 1
}

Válasz:

{
    "jsonrpc": "2.0",
    "eredmény": [
        {
            "hostid": "10092",
            "host": "{#HV.UUID}",
            "name": "{#HV.UUID}",
            "status": "0",
            "templateid": "0",
            "discover": "0",
            "custom_interfaces": "1",
            "inventory_mode": "-1",
            "groupLinks": [
                {
                    "group_prototypeid": "4",
                    "hostid": "10092",
                    "groupid": "7",
                    "sablon": "0"
                }
            ],
            "groupPrototypes": [
                {
                    "group_prototypeid": "7",
                    "hostid": "10092",
                    "név": "{#CLUSTER.NAME}",
                    "sablon": "0"
                }
            ],
            "címkék": [
                {
                    "tag": "Adatközpont",
                    "érték": "{#ADATOCENTR.NAME}"
                },
                {
                    "tag": "Példánytípus",
                    "érték": "{#INSTANCE_TYPE}"
                }
            ],
            "interfészek": [
                {
                    "fő": "1",
                    "type": "2",
                    "useip": "1",
                    "ip": "127.0.0.1",
                    "dns": "",
                    "port": "161",
                    "részletek": {
                        "verzió": "2",
                        "ömlesztett": "1",
                        "közösség": "{$SNMP_COMMUNITY}"
                    }
                }
            ]
        }
    ],
    "azonosító": 1
}

Lásd még

Forrás

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