[comment]: # translation:outdated

[comment]: # ({02ea8022-02ea8022})
# usermacro.get

[comment]: # ({/02ea8022-02ea8022})

[comment]: # ({78b5ab06-28befc82})
### Beschreibung

`integer/array usermacro.get(object parameters)`

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

::: noteclassic
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](/manual/web_interface/frontend_sections/users/user_roles)
für weitere Informationen.
:::

[comment]: # ({/78b5ab06-28befc82})

[comment]: # ({0f02ef4c-141835f9})
### Parameter

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

Die Methode unterstützt die folgenden Parameter.

|Parameter|[Type](/manual/api/reference_commentary#data-types)|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`](/manual/api/reference/hostgroup/object) zurückgeben.<br><br>Wird nur beim Abrufen von Host-Makros verwendet.|
|selectHosts|query|Hosts, zu denen das Host-Makro gehört, in der Eigenschaft [`hosts`](/manual/api/reference/host/object) zurückgeben.<br><br>Wird nur beim Abrufen von Host-Makros verwendet.|
|selectTemplateGroups|query|Vorlagengruppen, zu denen das Vorlagenmakro gehört, in der Eigenschaft [`templategroups`](/manual/api/reference/templategroup/object) zurückgeben.<br><br>Wird nur beim Abrufen von Vorlagenmakros verwendet.|
|selectTemplates|query|Vorlagen, zu denen das Host-Makro gehört, in der Eigenschaft [`templates`](/manual/api/reference/template/object) zurückgeben.<br><br>Wird nur beim Abrufen von Host-Makros verwendet.|
|sortfield|string/array|Das Ergebnis nach den angegebenen Eigenschaften sortieren.<br><br>Mögliche Werte: `macro`.|
|countOutput|boolean|Diese Parameter sind in der [Referenzkommentierung](/manual/api/reference_commentary#common-get-method-parameters) beschrieben.|
|editable|boolean|^|
|excludeSearch|boolean|^|
|filter|object|^|
|limit|integer|^|
|output|query|^|
|preservekeys|boolean|^|
|search|object|^|
|searchByAny|boolean|^|
|searchWildcardsEnabled|boolean|^|
|sortorder|string/array|^|
|startSearch|boolean|^|

[comment]: # ({/0f02ef4c-141835f9})

[comment]: # ({7223bab1-7223bab1})
### Rückgabewerte

`(integer/array)` Gibt entweder Folgendes zurück:

-   ein Array von Objekten;
-   die Anzahl der abgerufenen Objekte, wenn der Parameter `countOutput` verwendet wurde.

[comment]: # ({/7223bab1-7223bab1})

[comment]: # ({b41637d2-b41637d2})
### Beispiele

[comment]: # ({/b41637d2-b41637d2})

[comment]: # ({4540e2f0-7089e052})
#### Abrufen von Host-Makros für einen Host

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

[Anfrage](/manual/api#performing-requests):

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

Antwort:

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

[comment]: # ({/4540e2f0-7089e052})

[comment]: # ({885a2441-f0872791})
#### 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.

[Anfrage](/manual/api#performing-requests):

```json
{
    "jsonrpc": "2.0",
    "method": "usermacro.get",
    "params": {
        "output": "extend",
        "hostids": "10265",
        "search": {
            "macro": "STATUS"
        }
    },
    "id": 1
}
```

Antwort:

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

[comment]: # ({/885a2441-f0872791})

[comment]: # ({93c3e1f5-29b64a7a})
#### Abrufen globaler Makros

Rufen Sie alle globalen Makros ab.

[Anfrage](/manual/api#performing-requests):

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

Antwort:

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

[comment]: # ({/93c3e1f5-29b64a7a})

[comment]: # ({26db0ec2-26db0ec2})
### Quelle

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

[comment]: # ({/26db0ec2-26db0ec2})