discoveryruleprototype.get

Opis

integer/array discoveryruleprototype.get(object parameters)

Metoda umożliwia pobranie prototypów reguł LLD zgodnie z podanymi parametrami.

Ta metoda jest dostępna dla użytkowników dowolnego typu. Uprawnienia do wywołania metody mogą zostać odebrane w ustawieniach roli użytkownika. Więcej informacji można znaleźć w sekcji Role użytkowników

Parametry

(object) Parametry definiujące oczekiwany wynik.

Metoda obsługuje następujące parametry.

Parameter Type Description
itemids ID/array Zwraca tylko prototypy reguł LLD o podanych ID.
groupids ID/array Zwraca tylko prototypy reguł LLD należące do hostów z podanych grup.
hostids ID/array Zwraca tylko prototypy reguł LLD należące do podanych hostów.
inherited boolean Jeśli ustawione na true, zwraca tylko prototypy reguł LLD odziedziczone z szablonu.
interfaceids ID/array Zwraca tylko prototypy reguł LLD używające podanych interfejsów hosta.
monitored boolean Jeśli ustawione na true, zwraca tylko włączone prototypy reguł LLD należące do monitorowanych hostów.
templated boolean Jeśli ustawione na true, zwraca tylko prototypy reguł LLD należące do szablonów.
templateids ID/array Zwraca tylko prototypy reguł LLD należące do podanych szablonów.
selectDiscoveryRule query Zwraca właściwość discoveryRule z nadrzędną regułą LLD dla prototypu reguły LLD.
selectDiscoveryRulePrototype query Zwraca właściwość discoveryRulePrototype z nadrzędnym prototypem reguły LLD dla prototypu reguły LLD.
selectDiscoveryRulePrototypes query Zwraca właściwość discoveryRulePrototypes z podrzędnymi prototypami reguł LLD należącymi do prototypu reguły LLD.

Obsługuje count.
selectFilter query Zwraca właściwość filter z danymi filtra używanego przez prototyp reguły LLD.
selectGraphs query Zwraca właściwość graphs z prototypami wykresów należącymi do prototypu reguły LLD.

Obsługuje count.
selectHostPrototypes query Zwraca właściwość hostPrototypes z prototypami hostów należącymi do prototypu reguły LLD.

Obsługuje count.
selectHosts query Zwraca właściwość hosts z tablicą hostów, do których należy prototyp reguły LLD.
selectItems query Zwraca właściwość items z prototypami pozycji należącymi do prototypu reguły LLD.

Obsługuje count.
selectTriggers query Zwraca właściwość triggers z prototypami wyzwalaczy należącymi do prototypu reguły LLD.

Obsługuje count.
selectLLDMacroPaths query Zwraca właściwość lld_macro_paths z listą makr LLD i ścieżek do wartości przypisanych do każdego odpowiadającego makra.
selectPreprocessing query Zwraca właściwość preprocessing z opcjami przetwarzania wstępnego prototypu reguły LLD.
selectOverrides query Zwraca właściwość lld_rule_overrides z listą filtrów, warunków i operacji nadpisywania wykonywanych na obiektach prototypów.
filter object Zwraca tylko te wyniki, które dokładnie pasują do podanego filtra.

Przyjmuje obiekt, w którym kluczami są nazwy właściwości, a wartościami pojedyncza wartość lub tablica wartości, z którymi ma zostać wykonane dopasowanie.

Nie obsługuje właściwości typu text data type.

Obsługuje dodatkowe właściwości:
host - techniczna nazwa hosta, do którego należy prototyp reguły LLD.
limitSelects integer Ogranicza liczbę rekordów zwracanych przez podzapytania.

Dotyczy następujących podzapytań: selectItems, selectGraphs, selectTriggers.
sortfield string/array Sortuje wynik według podanych właściwości.

Możliwe wartości: itemid, name, key_, delay, type, status.
countOutput boolean Te parametry są opisane w komentarzu referencyjnym.
editable boolean
excludeSearch boolean
limit integer
output query
preservekeys boolean
search object
searchByAny boolean
searchWildcardsEnabled boolean
sortorder string/array
startSearch boolean

Wartości zwracane

(integer/array) Zwraca:

  • tablicę obiektów;
  • liczbę pobranych obiektów, jeśli użyto parametru countOutput.

Przykłady

Pobieranie prototypów reguł wykrywania z hosta

Pobierz wszystkie prototypy reguł wykrywania dla określonego ID hosta.

Żądanie:

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

Odpowiedź:

{
    "jsonrpc": "2.0",
    "result": [
        {
            "itemid": "47253",
            "type": "23",
            "snmp_oid": "",
            "hostid": "10084",
            "name": "Wykryj tablespace dla {#DB}",
            "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
}

Zobacz także

Source

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