usermacro.get

Beschreibung

integer/array usermacro.get(object parameters)

Mit dieser Methode können Host- und globale Makros entsprechend den angegebenen Parametern abgerufen werden.

Diese Methode ist für Benutzer aller Typen verfügbar. Die Berechtigungen zum Aufrufen der Methode können in den Einstellungen der Benutzerrolle entzogen werden. Siehe Benutzerrollen für weitere Informationen.

Parameter

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

Die Methode unterstützt die folgenden Parameter.

Parameter Type Beschreibung
globalmacro flag Globale Makros statt Host-Makros zurückgeben.
globalmacroids ID/array Nur globale Makros mit den angegebenen IDs zurückgeben.
groupids ID/array Nur Host-Makros zurückgeben, die zu Hosts oder Vorlagen aus den angegebenen Hostgruppen oder Vorlagengruppen gehören.
hostids ID/array Nur Makros zurückgeben, die zu den angegebenen Hosts oder Vorlagen gehören.
hostmacroids ID/array Nur Host-Makros mit den angegebenen IDs zurückgeben.
inherited boolean Wenn auf true gesetzt, nur geerbte Benutzer-Makros von Host-Prototypen zurückgeben, die von einer Vorlage übernommen wurden.
selectHostGroups query Hostgruppen zurückgeben, zu denen das Host-Makro in der Eigenschaft hostgroups gehört.

Nur bei der Abfrage von Host-Makros verwendet.
selectHosts query Hosts zurückgeben, zu denen das Host-Makro in der Eigenschaft hosts gehört.

Nur bei der Abfrage von Host-Makros verwendet.
selectTemplateGroups query Vorlagengruppen zurückgeben, zu denen das Vorlagen-Makro in der Eigenschaft templategroups gehört.

Nur bei der Abfrage von Vorlagen-Makros verwendet.
selectTemplates query Vorlagen zurückgeben, zu denen das Host-Makro in der Eigenschaft templates gehört.

Nur bei der Abfrage von Host-Makros verwendet.
sortfield string/array Das Ergebnis nach den angegebenen Eigenschaften sortieren.

Mögliche Werte: macro.
countOutput boolean Diese Parameter werden in der Referenzkommentierung beschrieben.
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 Dieser Parameter ist veraltet, bitte verwenden Sie stattdessen selectHostGroups oder selectTemplateGroups.
Hostgruppen und Vorlagengruppen zurückgeben, zu denen das Host-Makro in der Eigenschaft groups gehört.

Nur bei der Abfrage von Host-Makros verwendet.

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 Host-Makros für einen Host

Rufen Sie alle für den Host „10198“ definierten Host-Makros ab.

Anfrage:

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

Antwort:

{
    "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
}

Abrufen globaler Makros

Rufen Sie alle globalen Makros ab.

Anfrage:

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

Antwort:

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

Quelle

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