usermacro.get

Opis

integer/array usermacro.get(object parameters)

Ta metoda pozwala na pobieranie makr hosta i globalnych zgodnie z podanymi parametrami.

Ta metoda jest dostępna dla użytkowników dowolnego typu. Uprawnienia do wywoływania metody można odebrać w ustawieniach roli użytkownika. Zobacz Role użytkownika aby uzyskać więcej informacji.

Parametry

(object) Parametry definiujące pożądany wynik.

Metoda obsługuje następujące parametry.

Parametr	Typ	Opis
globalmacro	flag	Zwróć globalne makra zamiast makr hosta.
globalmacroids	string/array	Zwróć tylko globalne makra o podanych identyfikatorach.
groupids	string/array	Zwróć tylko makra hosta należące do hostów lub szablonów z podanych grup hostów.
hostids	string/array	Zwróć tylko makra należące do podanych hostów lub szablonów.
hostmacroids	string/array	Zwróć tylko makra hosta o podanych identyfikatorach.
inherited	boolean	Jeśli ustawione na `true`, zwróć tylko prototypowe makra użytkownika hosta dziedziczone z szablonu.
selectGroups	query	Zwróć grupy hostów, do których należy makro hosta w właściwości groups. Używane tylko podczas pobierania makr hosta.
selectHosts	query	Zwróć hosty, do których należy makro hosta w właściwości hosts. Używane tylko podczas pobierania makr hosta.
selectTemplates	query	Zwróć szablony, do których należy makro hosta w właściwości templates. Używane tylko podczas pobierania makr hosta.
sortfield	string/array	Posortuj wynik według podanych właściwości. Możliwa wartość: `macro`.
countOutput	boolean	Te parametry, będące wspólne dla wszystkich metod `get`, są szczegółowo opisane na stronie komentarza referencyjnego.
editable	boolean
excludeSearch	boolean
filter	object
limit	integer
output	query
preservekeys	boolean
search	object
searchByAny	boolean
searchWildcardsEnabled	boolean
sortorder	string/array
startSearch	boolean

Zwracane wartości

(integer/array) Zwraca jedną z opcji:

tablicę obiektów;
liczbę pobranych obiektów, jeśli parametr countOutput został wykorzystany.

Przykłady

Pobieranie makr hosta dla hosta

Pobierz wszystkie makra hosta zdefiniowane dla hosta "10198".

Zapytanie:

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

Odpowiedź:

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

Pobieranie globalnych makr

Pobierz wszystkie globalne makra.