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

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

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

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

Metode ļauj izgūt hosta un globālos makrosus atbilstoši
norādītajiem parametriem.

::: noteclassic
Šī metode ir pieejama jebkura tipa lietotājiem. Atļaujas
izsaukt šo metodi var tikt atsauktas lietotāja lomas iestatījumos. Plašāku informāciju skatiet sadaļā [Lietotāju
lomas](/manual/web_interface/frontend_sections/users/user_roles).
:::

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

[comment]: # ({665d8bba-141835f9})
### Parametri

`(object)` Parametri, kas nosaka vēlamo izvadi.

Metode atbalsta šādus parametrus.

|Parameter|[Type](/manual/api/reference_commentary#data-types)|Description|
|--|--|------|
|globalmacro|flag|Atgriezt globālos makro, nevis host makro.|
|globalmacroids|ID/array|Atgriezt tikai globālos makro ar norādītajiem ID.|
|groupids|ID/array|Atgriezt tikai host makro, kas pieder hostiem vai veidnēm no norādītajām host grupām vai veidņu grupām.|
|hostids|ID/array|Atgriezt tikai makro, kas pieder norādītajiem hostiem vai veidnēm.|
|hostmacroids|ID/array|Atgriezt tikai host makro ar norādītajiem ID.|
|inherited|boolean|Ja iestatīts uz `true`, atgriezt tikai host prototipa lietotāja makro, kas mantoti no veidnes.|
|selectHostGroups|query|Atgriezt host grupas, kurām host makro pieder, [`hostgroups`](/manual/api/reference/hostgroup/object) īpašībā.<br><br>Izmanto tikai, izgūstot host makro.|
|selectHosts|query|Atgriezt hostus, kuriem host makro pieder, [`hosts`](/manual/api/reference/host/object) īpašībā.<br><br>Izmanto tikai, izgūstot host makro.|
|selectTemplateGroups|query|Atgriezt veidņu grupas, kurām veidnes makro pieder, [`templategroups`](/manual/api/reference/templategroup/object) īpašībā.<br><br>Izmanto tikai, izgūstot veidņu makro.|
|selectTemplates|query|Atgriezt veidnes, kurām host makro pieder, [`templates`](/manual/api/reference/template/object) īpašībā.<br><br>Izmanto tikai, izgūstot host makro.|
|sortfield|string/array|Kārtot rezultātu pēc norādītajām īpašībām.<br><br>Iespējamās vērtības: `macro`.|
|countOutput|boolean|Šie parametri ir aprakstīti [atsauces komentārā](/manual/api/reference_commentary#common-get-method-parameters).|
|editable|boolean|^|
|excludeSearch|boolean|^|
|filter|object|^|
|limit|integer|^|
|output|query|^|
|preservekeys|boolean|^|
|search|object|^|
|searchByAny|boolean|^|
|searchWildcardsEnabled|boolean|^|
|sortorder|string/array|^|
|startSearch|boolean|^|
|selectGroups<br>(deprecated)|query|Šis parametrs ir novecojis, lūdzu, tā vietā izmantojiet `selectHostGroups` vai `selectTemplateGroups`.<br>Atgriezt host grupas un veidņu grupas, kurām host makro pieder, `groups` īpašībā.<br><br>Izmanto tikai, izgūstot host makro.|

[comment]: # ({/665d8bba-141835f9})

[comment]: # ({7223bab1-7223bab1})
### Atgrieztās vērtības

`(integer/array)` Atgriež vienu no šīm vērtībām:

-   objektu masīvu;
-   izgūto objektu skaitu, ja ir izmantots parametrs `countOutput`.

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

[comment]: # ({b41637d2-b41637d2})
### Piemēri

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

[comment]: # ({4540e2f0-7089e052})
#### Hosta makrosu izgūšana hostam

Izgūstiet visus hosta makrosus, kas definēti hostam "10198".

[Pieprasījums](/manual/api#performing-requests):

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

Atbilde:

```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]: # ({93c3e1f5-29b64a7a})
#### Globālo makrosu izgūšana

Izgūstiet visus globālos makrosus.

[Pieprasījums](/manual/api#performing-requests):

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

Atbilde:

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

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

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

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

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