usermacro.get

Opis

integer/array usermacro.get(object parameters)

Ta metoda umożliwia pobieranie makr hosta i makr globalnych zgodnie z podanymi parametrami.

Ta metoda jest dostępna dla użytkowników dowolnego typu. Uprawnienia do wywoływania tej metody mogą zostać cofnięte 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
globalmacro flag Zwraca globalne makra zamiast makr hosta.
globalmacroids ID/array Zwraca tylko globalne makra o podanych identyfikatorach.
groupids ID/array Zwraca tylko makra hosta należące do hostów lub szablonów z podanych grup hostów lub grup szablonów.
hostids ID/array Zwraca tylko makra należące do podanych hostów lub szablonów.
hostmacroids ID/array Zwraca tylko makra hosta o podanych identyfikatorach.
inherited boolean Jeśli ustawione na true, zwraca tylko użytkowe makra prototypu hosta odziedziczone z szablonu.
selectHostGroups query Zwraca grupy hostów, do których należy makro hosta, w właściwości hostgroups.

Używane tylko podczas pobierania makr hosta.
selectHosts query Zwraca hosty, do których należy makro hosta, w właściwości hosts.

Używane tylko podczas pobierania makr hosta.
selectTemplateGroups query Zwraca grupy szablonów, do których należy makro szablonu, w właściwości templategroups.

Używane tylko podczas pobierania makr szablonu.
selectTemplates query Zwraca szablony, do których należy makro hosta, w właściwości templates.

Używane tylko podczas pobierania makr hosta.
sortfield string/array Sortuje wynik według podanych właściwości.

Możliwe wartości: macro.
countOutput boolean Te parametry są opisane w komentarzu referencyjnym.
editable boolean
excludeSearch boolean
filter object
limit integer
output query
preservekeys boolean
search object
searchByAny boolean
searchWildcardsEnabled boolean
sortorder string/array
startSearch boolean
selectGroups
(deprecated)		 query Ten parametr jest przestarzały, zamiast niego użyj selectHostGroups lub selectTemplateGroups.
Zwraca grupy hostów i grupy szablonów, do których należy makro hosta, w właściwości groups.

Używane tylko podczas pobierania makr hosta.

Zwracane wartości

(integer/array) Zwraca:

  • tablicę obiektów;
  • liczbę pobranych obiektów, jeśli został użyty parametr countOutput.

Przykłady

Pobieranie makr hosta dla hosta

Pobierz wszystkie makra hosta zdefiniowane dla hosta „10198”.

Żądanie:

{
    "jsonrpc": "2.0",
    "method": "usermacro.get",
    "params": {
        "output": "extend",
        "hostids": "10198"
    },
    "id": 1
}

Odpowiedź:

{
    "jsonrpc": "2.0",
    "result": [
        {
            "hostmacroid": "9",
            "hostid": "10198",
            "macro": "{$INTERFACE}",
            "value": "eth0",
            "description": "",
            "type": "0",
            "automatic": "0"
        },
        {
            "hostmacroid": "11",
            "hostid": "10198",
            "macro": "{$SNMP_COMMUNITY}",
            "value": "public",
            "description": "",
            "type": "0",
            "automatic": "0"
        }
    ],
    "id": 1
}

Pobieranie makr globalnych

Pobierz wszystkie makra globalne.

Żądanie:

{
    "jsonrpc": "2.0",
    "method": "usermacro.get",
    "params": {
        "output": "extend",
        "globalmacro": true
    },
    "id": 1
}

Odpowiedź:

{
    "jsonrpc": "2.0",
    "result": [
        {
            "globalmacroid": "6",
            "macro": "{$SNMP_COMMUNITY}",
            "value": "public",
            "description": "",
            "type": "0"
        }
    ],
    "id": 1
}

Źródło

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