On this page
discoveryruleprototype.get
Beschreibung
integer/array discoveryruleprototype.get(object parameters)
Die Methode ermöglicht das Abrufen von LLD-Regelvorlagen entsprechend den angegebenen Parametern.
Diese Methode ist für Benutzer aller Typen verfügbar. Berechtigungen zum Aufruf der Methode können 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 | Typ | Beschreibung |
|---|---|---|
| itemids | ID/array | Nur LLD-Regelvorlagen mit den angegebenen IDs zurückgeben. |
| groupids | ID/array | Nur LLD-Regelvorlagen zurückgeben, die zu den Hosts aus den angegebenen Gruppen gehören. |
| hostids | ID/array | Nur LLD-Regelvorlagen zurückgeben, die zu den angegebenen Hosts gehören. |
| inherited | boolean | Wenn auf true gesetzt, nur von einer Vorlage geerbte LLD-Regelvorlagen zurückgeben. |
| interfaceids | ID/array | Nur LLD-Regelvorlagen zurückgeben, die die angegebenen Host-Schnittstellen verwenden. |
| monitored | boolean | Wenn auf true gesetzt, nur aktivierte LLD-Regelvorlagen zurückgeben, die zu überwachten Hosts gehören. |
| templated | boolean | Wenn auf true gesetzt, nur LLD-Regelvorlagen zurückgeben, die zu Vorlagen gehören. |
| templateids | ID/array | Nur LLD-Regelvorlagen zurückgeben, die zu den angegebenen Vorlagen gehören. |
| selectDiscoveryRule | query | Eine Eigenschaft discoveryRule mit der übergeordneten LLD-Regel der LLD-Regelvorlage zurückgeben. |
| selectDiscoveryRulePrototype | query | Eine Eigenschaft discoveryRulePrototype mit der übergeordneten LLD-Regelvorlage der LLD-Regelvorlage zurückgeben. |
| selectDiscoveryRulePrototypes | query | Eine Eigenschaft discoveryRulePrototypes mit untergeordneten LLD-Regelvorlagen zurückgeben, die zur LLD-Regelvorlage gehören.Unterstützt count. |
| selectFilter | query | Eine Eigenschaft filter mit den Daten des von der LLD-Regelvorlage verwendeten Filters zurückgeben. |
| selectGraphs | query | Gibt eine Eigenschaft graphs mit Diagrammvorlagen zurück, die zur LLD-Regelvorlage gehören.Unterstützt count. |
| selectHostPrototypes | query | Eine Eigenschaft hostPrototypes mit Hostvorlagen zurückgeben, die zur LLD-Regelvorlage gehören.Unterstützt count. |
| selectHosts | query | Eine Eigenschaft hosts mit einem Array von Hosts zurückgeben, zu denen die LLD-Regelvorlage gehört. |
| selectItems | query | Eine Eigenschaft items mit Datenpunktvorlagen zurückgeben, die zur LLD-Regelvorlage gehören.Unterstützt count. |
| selectTriggers | query | Eine Eigenschaft triggers mit Auslöservorlagen zurückgeben, die zur LLD-Regelvorlage gehören.Unterstützt count. |
| selectLLDMacroPaths | query | Eine Eigenschaft lld_macro_paths mit einer Liste von LLD-Makros und Pfaden zu den Werten zurückgeben, die jedem entsprechenden Makro zugewiesen sind. |
| selectPreprocessing | query | Eine Eigenschaft preprocessing mit Vorverarbeitungsoptionen der LLD-Regelvorlage zurückgeben. |
| selectOverrides | query | Eine Eigenschaft lld_rule_overrides mit einer Liste von Überschreibungsfiltern, Bedingungen und Operationen zurückgeben, die auf Vorlagenobjekte angewendet werden. |
| filter | object | Nur Ergebnisse zurückgeben, die exakt dem angegebenen Filter entsprechen. Akzeptiert ein Objekt, wobei die Schlüssel Eigenschaftsnamen sind und die Werte entweder ein einzelner Wert oder ein Array von Werten sind, mit denen verglichen werden soll. Unterstützt keine Eigenschaften vom Datentyp text.Unterstützt zusätzliche Eigenschaften: host - technischer Name des Hosts, zu dem die LLD-Regelvorlage 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 | Das Ergebnis nach den angegebenen Eigenschaften sortieren. Mögliche Werte: itemid, name, key_, delay, type, status. |
| countOutput | boolean | Diese Parameter werden in der Referenzdokumentation 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 zurück:
- ein Array von Objekten;
- die Anzahl der abgerufenen Objekte, wenn der Parameter
countOutputverwendet 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.
{
"jsonrpc": "2.0",
"method": "discoveryruleprototype.get",
"params": {
"hostids": "10084"
},
"id": 1
}
Response:
{
"jsonrpc": "2.0",
"result": [
{
"itemid": "47253",
"type": "23",
"snmp_oid": "",
"hostid": "10084",
"name": "Tabellenbereiche für {#DB} erkennen",
"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",
"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.