On this page
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 anstelle von 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 Host-Gruppen 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 von einer Vorlage geerbte Benutzermakros von Host-Prototypen zurückgeben. |
| selectHostGroups | query | Host-Gruppen, zu denen das Host-Makro gehört, in der Eigenschaft hostgroups zurückgeben.Wird nur beim Abrufen von Host-Makros verwendet. |
| selectHosts | query | Hosts, zu denen das Host-Makro gehört, in der Eigenschaft hosts zurückgeben.Wird nur beim Abrufen von Host-Makros verwendet. |
| selectTemplateGroups | query | Vorlagengruppen, zu denen das Vorlagenmakro gehört, in der Eigenschaft templategroups zurückgeben.Wird nur beim Abrufen von Vorlagenmakros verwendet. |
| selectTemplates | query | Vorlagen, zu denen das Host-Makro gehört, in der Eigenschaft templates zurückgeben.Wird nur beim Abrufen von Host-Makros verwendet. |
| sortfield | string/array | Das Ergebnis nach den angegebenen Eigenschaften sortieren. Mögliche Werte: macro. |
| countOutput | boolean | Diese Parameter sind 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 |
Rückgabewerte
(integer/array) Gibt entweder Folgendes zurück:
- ein Array von Objekten;
- die Anzahl der abgerufenen Objekte, wenn der Parameter
countOutputverwendet wurde.
Beispiele
Abrufen von Host-Makros für einen Host
Rufen Sie alle für den Host „10198“ definierten Host-Makros ab.
{
"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 von Host-Makros für eine Vorlage
Rufen Sie die für die Vorlage „10265“ definierten Host-Makros ab, die „STATUS“ im Makronamen enthalten.
{
"jsonrpc": "2.0",
"method": "usermacro.get",
"params": {
"output": "extend",
"hostids": "10265",
"search": {
"macro": "STATUS"
}
},
"id": 1
}Antwort:
{
"jsonrpc": "2.0",
"result": [
{
"hostmacroid": "6709",
"hostid": "10265",
"macro": "{$APACHE.STATUS.HOST}",
"value": "",
"description": "Der Hostname oder die IP-Adresse des Apache-Statusseiten-Hosts.",
"type": "0",
"automatic": "0",
"config": {
"type": "1",
"priority": "1",
"section_name": "",
"label": "Apache-Status-Host",
"description": "Hostname oder IP-Adresse des Apache-Statusseiten-Hosts.",
"required": "1",
"regex": "",
"options": []
}
},
{
"hostmacroid": "814",
"hostid": "10265",
"macro": "{$APACHE.STATUS.PATH}",
"value": "server-status?auto",
"description": "Der URL-Pfad der Apache-Statusseite.",
"type": "0",
"automatic": "0",
"config": {
"type": "1",
"priority": "3",
"section_name": "",
"label": "Apache-Statusseitenpfad",
"description": "URL-Pfad der Apache-Statusseite.",
"required": "1",
"regex": "",
"options": []
}
},
{
"hostmacroid": "815",
"hostid": "10265",
"macro": "{$APACHE.STATUS.PORT}",
"value": "80",
"description": "Der Port der Apache-Statusseite.",
"type": "0",
"automatic": "0",
"config": {
"type": "1",
"priority": "2",
"section_name": "",
"label": "Apache-Statusseiten-Port",
"description": "Im Bereich von 1 bis 65535 einschließlich.",
"required": "1",
"regex": "^-?([0-9]+|(([0-9]+)\\.([0-9]+)))$",
"options": []
}
},
{
"hostmacroid": "816",
"hostid": "10265",
"macro": "{$APACHE.STATUS.SCHEME}",
"value": "http",
"description": "Das Anfrage-Schema, das entweder HTTP oder HTTPS sein kann.",
"type": "0",
"automatic": "0",
"config": {
"type": "2",
"priority": "4",
"section_name": "",
"label": "Anfrage-Schema",
"description": "Anfrage-Schema, das entweder HTTP oder HTTPS sein kann.",
"required": "0",
"regex": "",
"options": [
{
"value": "http",
"text": "HTTP"
},
{
"value": "https",
"text": "HTTPS"
}
]
}
}
],
"id": 1
}Abrufen globaler Makros
Rufen Sie alle globalen Makros ab.
{
"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.