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

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

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

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

El mètode permet recuperar equips i macros globals segons els paràmetres proveïts.

::: noteclassic
Aquest mètode és disponible per a usuaris de qualsevol mena. Els permisos per cridar al mètode es poden revocar a les configuracions de rols d'usuari. Per a més informació, veieu [Rols d'usuari](/manual/web_interface/frontend_sections/users/user_roles).
:::

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

[comment]: # ({665d8bba-141835f9})
### Paràmetres

`(object)` Paràmetres que defineixen la sortida esperada.

El mètode admet els paràmetres següents.

|Paràmetre|[Tipus](/manual/api/reference_commentary#data-types)|Descripció|
|--|--|------|
|globalmacro|flag|Retorna macros globals en lloc de macros d'equips.|
|globalmacroids|ID/array|Retorna només macros globals amb els ID donats.|
|groupids|ID/array|Retorna només macros d'equips que pertanyen als equips o plantilles dels grups d'equips donats.|
|hostids|ID/array|Retorna només macros que pertanyen als equips o plantilles donades.|
|hostmacroids|ID/array|Retorna només macros de l'equip amb els ID donats.|
|inherited|boolean|Si s'estableix a `true`, només retorna les macros d'usuari prototip d'equips heretades d'una plantilla.|
|selectHostGroups|query|Retorna els grups d'equips als quals pertany la macro de l'equip a la propietat [`hostgroups`](/manual/api/reference/hostgroup/object).<br><br>Només s'empra per recuperar macros d'equips.|
|selectHosts|query|Retorna els equips als quals pertany la macro de l'equip a la propietat [`hosts`](/manual/api/reference/host/object).<br><br>Només s'empra per recuperar macros d'equips.|
|selectTemplateGroups|query|Retorna els grups d'equips als quals pertany la macro de l'equip a la propietat [`templategroups`](/manual/api/reference/templategroup/object).<br><br>Només s'empra per recuperar macros d'equips.|
|selectTemplates|query|Retorna les plantilles a les quals pertany la macro de l'equip a la propietat [`templates`](/manual/api/reference/template/object).<br><br>Només s'empra per recuperar macros de l'equip.|
|sortfield|string/array|Ordena el resultat segons les propietats donades.<br><br>Valor possible: `macro`.|
|countOutput|boolean|Aquests paràmetres es descriuen amb detall a la pàgina [comentaris de referència](/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>(obsolet)|query|Aquest paràmetre és obsolet; si us plau, emprau `selectHostGroups` o `selectTemplateGroups` en el seu lloc.<br>Retorna els grups d'equips i els grups de plantilles on el trigger pertany a la propietat `groups`.<br><br>Emprat només quan es recuperen macros d'equip.|

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

[comment]: # ({7223bab1-7223bab1})
### Valors de retorn

`(integer/array)` Retorna un d'entre:

-   una taula d'objectes;
-   el recompte d'objectes recuperats, si s'empra el paràmetre `countOutput`.

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

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

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

[comment]: # ({4540e2f0-7089e052})
#### Recuperar les macros d'un equip

Recupera totes les macros definides per l'equip "10198".

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

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

Resposta:

```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})
#### Recuperar macros globals

Recupera totes les macros globals.

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

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

Resposta:

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

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

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

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

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