discoveryruleprototype.get

Beschreibung

integer/array discoveryruleprototype.get(object parameters)

Mit dieser Methode können LLD-Regelprototypen entsprechend den angegebenen Parametern abgerufen werden.

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

Parameter

(object) Parameter, die die gewünschte Ausgabe definieren.

Die Methode unterstützt die folgenden Parameter.

Parameter Type Beschreibung
discoveryids ID/array Gibt nur LLD-Regelprototypen zurück, die zu den angegebenen LLD-Regeln oder LLD-Regelprototypen gehören.
itemids ID/array Gibt nur LLD-Regelprototypen mit den angegebenen IDs zurück.
groupids ID/array Gibt nur LLD-Regelprototypen zurück, die zu den Hosts aus den angegebenen Gruppen gehören.
hostids ID/array Gibt nur LLD-Regelprototypen zurück, die zu den angegebenen Hosts gehören.
inherited boolean Wenn auf true gesetzt, werden nur LLD-Regelprototypen zurückgegeben, die von einer Vorlage geerbt wurden.
interfaceids ID/array Gibt nur LLD-Regelprototypen zurück, die die angegebenen Host-Schnittstellen verwenden.
monitored boolean Wenn auf true gesetzt, werden nur aktivierte LLD-Regelprototypen zurückgegeben, die zu überwachten Hosts gehören.
templated boolean Wenn auf true gesetzt, werden nur LLD-Regelprototypen zurückgegeben, die zu Vorlagen gehören.
templateids ID/array Gibt nur LLD-Regelprototypen zurück, die zu den angegebenen Vorlagen gehören.
selectDiscoveryRule query Gibt eine Eigenschaft discoveryRule mit der übergeordneten LLD-Regel des LLD-Regelprototyps zurück.
Wenn das übergeordnete Element ein Discovery-Regelprototyp ist, wird eine leere Antwort zurückgegeben.
selectDiscoveryRulePrototype query Gibt eine Eigenschaft discoveryRulePrototype mit dem übergeordneten LLD-Regelprototyp des LLD-Regelprototyps zurück.
Wenn das übergeordnete Element eine Discovery-Regel (kein Prototyp) ist, wird eine leere Antwort zurückgegeben.
selectDiscoveryRulePrototypes query Gibt eine Eigenschaft discoveryRulePrototypes mit untergeordneten LLD-Regelprototypen zurück, die zum LLD-Regelprototyp gehören.

Unterstützt count.
selectFilter query Gibt eine Eigenschaft filter mit Daten des Filters zurück, der vom LLD-Regelprototyp verwendet wird.
selectGraphs query Gibt eine Eigenschaft graphs mit Graphprototypen zurück, die zum LLD-Regelprototyp gehören.

Unterstützt count.
selectHostPrototypes query Gibt eine Eigenschaft hostPrototypes mit Host-Prototypen zurück, die zum LLD-Regelprototyp gehören.

Unterstützt count.
selectHosts query Gibt eine Eigenschaft hosts mit einem Array von Hosts zurück, zu denen der LLD-Regelprototyp gehört.
selectItems query Gibt eine Eigenschaft items mit Datenpunktprototypen zurück, die zum LLD-Regelprototyp gehören.

Unterstützt count.
selectTriggers query Gibt eine Eigenschaft triggers mit Auslöserprototypen zurück, die zum LLD-Regelprototyp gehören.

Unterstützt count.
selectLLDMacroPaths query Gibt eine Eigenschaft lld_macro_paths mit einer Liste von LLD-Makros und Pfaden zu Werten zurück, die jedem entsprechenden Makro zugewiesen sind.
selectPreprocessing query Gibt eine Eigenschaft preprocessing mit Vorverarbeitungsoptionen des LLD-Regelprototyps zurück.
selectOverrides query Gibt eine Eigenschaft lld_rule_overrides mit einer Liste von Override-Filtern, Bedingungen und Operationen zurück, die auf Prototyp-Objekte angewendet werden.
filter object Gibt nur die Ergebnisse zurück, die exakt dem angegebenen Filter entsprechen.

Akzeptiert ein Objekt, bei dem die Schlüssel Eigenschaftsnamen sind und die Werte entweder ein einzelner Wert oder ein Array von Werten sind, mit denen abgeglichen werden soll.

Unterstützt keine Eigenschaften vom Datentyp text.

Unterstützt zusätzliche Eigenschaften:
host - technischer Name des Hosts, zu dem der LLD-Regelprototyp gehört.
limitSelects integer Begrenzt die Anzahl der von Unterabfragen zurückgegebenen Datensätze.

Gilt für die folgenden Unterabfragen: selectItems, selectGraphs, selectTriggers.
sortfield string/array Sortiert das Ergebnis nach den angegebenen Eigenschaften.

Mögliche Werte: itemid, name, key_, delay, type, status.
countOutput boolean Diese Parameter sind in der Referenzkommentierung beschrieben.
editable boolean
excludeSearch boolean
limit integer
output query
preservekeys boolean
search object
searchByAny boolean
searchWildcardsEnabled boolean
sortorder string/array
startSearch boolean

Rückgabewerte

(integer/array) gibt entweder Folgendes zurück:

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

Beispiele

Abrufen von Prototypen für Discovery-Regeln von einem Host

Rufen Sie alle Prototypen für Discovery-Regeln für eine bestimmte Host-ID ab.

Anfrage:

{
    "jsonrpc": "2.0",
    "method": "discoveryruleprototype.get",
    "params": {
        "hostids": "10084"
    },
    "id": 1
}

Antwort:

{
    "jsonrpc": "2.0",
    "result": [
        {
            "itemid": "47253",
            "type": "23",
            "snmp_oid": "",
            "hostid": "10084",
            "name": "Tablespaces für {#DB} ermitteln",
            "key_": "db.tablespace.discovery[{#DB}]",
            "delay": "0",
            "history": "31d",
            "trends": "365d",
            "status": "0",
            "value_type": "4",
            "trapper_hosts": "",
            "units": "",
            "logtimefmt": "",
            "templateid": "0",
            "valuemapid": "0",
            "params": "",
            "ipmi_sensor": "",
            "authtype": "0",
            "username": "",
            "password": "",
            "publickey": "",
            "privatekey": "",
            "flags": "3",
            "interfaceid": "0",
            "description": "",
            "inventory_link": "0",
            "lifetime": "7d",
            "jmx_endpoint": "",
            "master_itemid": "0",
            "timeout": "",
            "url": "",
            "query_fields": [],
            "posts": "",
            "status_codes": "200",
            "follow_redirects": "1",
            "post_type": "0",
            "http_proxy": "",
            "headers": [],
            "retrieve_mode": "0",
            "request_method": "0",
            "output_format": "0",
            "ssl_cert_file": "",
            "ssl_key_file": "",
            "ssl_key_password": "",
            "verify_peer": "0",
            "verify_host": "0",
            "allow_traps": "0",
            "discover": "0",
            "uuid": "",
            "lifetime_type": "0",
            "enabled_lifetime_type": "2",
            "enabled_lifetime": "0",
            "parameters": []
        }
    ],
    "id": 1
}

Siehe auch

Quelle

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