[comment]: # translation:outdated

[comment]: # ({f8d4c2e5-f8d4c2e5})
# hostgroup.get

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

[comment]: # ({8b2356a0-08ff22f2})
### Descripció

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

El mètode permet recuperar grups d'equips 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]: # ({/8b2356a0-08ff22f2})

[comment]: # ({eb406af9-7f042696})
### Paràmetres

`(object)` Paràmetres definint la sortida esperada.

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

|Paràmetre|[Tipus](/manual/api/reference_commentary#data_types)|Descripció|
|--|--|------|
|graphids|ID/array|Retorna només grups d'equips que contenen equips o patrons amb els gràfics donats.|
|groupids|ID/array|Retorna només els grups d'equips amb els ID de grup d'equips donats.|
|hostids|ID/array|Retorna només els grups d'equips que contenen els equips donats.|
|maintenanceids|ID/array|Retorna només els grups d'equips afectats pels manteniments donats.|
|triggerids|ID/array|Retorna només grups d'equips que contenen equips o patrons amb els triggers donats.|
|with\_graphs|flag|Retorna només grups d'equips que contenen equips amb gràfics.|
|with\_graph\_prototypes|flag|Retorna només grups d'equips que contenen equips amb prototips de gràfics.|
|with\_hosts\|flag|Retorna només grups d'equips que contenen equips.|
|with\_httptests|flag|Retorna només grups d'equips que contenen equips amb comprovacions web.<br><br>Anul·la la configuració `with_monitored_httptests`.|
|with\_items|flag|Retorna només grups d'equips que contenen equips o plantilles amb elements.<br><br>Substitueix la configuració `with_monitored_items` i `with_simple_graph_items`.|
|with\_item\_prototypes|flag|Retorna només grups d'equips que contenen equips o plantilles amb prototips d'elements.<br><br>Sobreescriu el paràmetre `with_simple_graph_item_prototypes`.|
|with\_simple\_graph\_item\_prototypes|marcador|Retorna només grups d'equips que contenen equips amb prototips d'elements, activats en crear-los i amb informació de tipus numèric.|
|with\_monitored\_httptests|flag|Retorna només grups d'equips que contenen equips amb monitors web activats.|
|with\_monitored\_hosts|flag|Retorna només grups d'equips que contenen equips monitorats.|
|with\_monitored\_items|flag|Retorna només grups d'equips que contenen equips o plantilles amb elements activats.<br><br>Sobreescriu la configuració `with_simple_graph_items`.|
|with\_monitored\_triggers|flag|Retorna només grups d'equips que contenen equips amb triggers activats. També s'han d'activar tots els elements emprats al trigger.|
|with\_simple\_graph\_items|flag|Retorna només grups d'equips que contenen equips amb elements numèrics.|
|with\_triggers|flag|Retorna només grups d'equips que contenen equips amb triggers.<br><br>Sobreescriu la configuració `with_monitored_triggers`.|
|selectDiscoveryRules|query|Retorna una propietat [`discoveryRules`](/manual/api/reference/drule/object) que conté la regla de descobriment de baix nivell que va crear el grup d'equips.|
|selectGroupDiscoveries|query|Retorna la propietat `groupDiscoveries` que conté l'objecte de descoberta del grup d'equips.<br><br>L'objecte de descoberta del grup d'equips enllaça un grup d'equips descobert a un grup d'equips prototip i té les propietats següents:<br>`parent_group_prototypeid` - `(ID)` ID del prototip del grup d'equips a partir del qual es va crear l'equip;<br>`name` - `(string)` nom del prototip del grup d'equips;<br>`lastcheck` - `(timestamp)` moment en que es ba trobar el darrer grup d'equips;<br>`groupid` - `(cadena)` identificador del grup d'equips descobert;<br>`lastcheck` - `(timestamp)` moment en que es ba trobar el darrer grup d'equips;<br>`ts_delete' - `(timestamp)` hora en què un grup d'equips que ja no es descobreix s'esborrarà;<br>`status` - `(int)` estat de la descoberta del grup d'equips:<br>0 - *(per defecte)* el grup d'equips s'ha trobat,<br>1 - el grup d'equips ja no es troba.|
|selectHostPrototypes|query|Retorna una propietat [`hostPrototypes`](/manual/api/reference/hostprototypes/object) que conté els prototipus d'equips que ha trobat aquest grup d'equips.|
|selectHosts|query|Retorna una propietat [`hosts`](/manual/api/reference/host/object) que conté els equips que pertanyen al grup d'equips.<br><br>Admet `count`.|
|limitSelects|integer|Limita el nombre de registres retornats per les subconsultes.<br><br>S'aplica a les subconsultes següents:<br>`selectHosts` - els resultats s'ordenaran per `host`.|
|sortfield|string/array|Ordena el resultat per les propietats donades.<br><br>Els valors possibles són: `groupid`, `name`.|
|countOutput|boolean|Aquests paràmetres es descriuen als [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|^|
|monitored\_hosts(obsolet)|flag|Aquest paràmetre és obsolet; empreu `with_monitored_hosts` en el seu lloc.<br>Retorna només grups d'equips que contenen equips monitorats.|
|real\_hosts<br>(obsolet)|flag|Aquest paràmetre és obsolet; empreu `with_hosts` en el seu lloc.<br>Retorna només grups d'equips que contenen equips.|

[comment]: # ({/eb406af9-7f042696})

[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]: # ({a2908ef0-8ed2756a})
#### recupear informació per nom

Recupera tota la informació dels grups d'equips anomenats "Servidors Zabbix" i "Servidors Linux".

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

```json
{
    "jsonrpc": "2.0",
    "method": "hostgroup.get",
    "params": {
        "output": "extend",
        "filter": {
            "name": [
                "Servidors Zabbix",
                "Servidors Linux"
            ]
        }
    },
    "id": 1
}
```

Resposta:

```json
{
    "jsonrpc": "2.0",
    "result": [
        {
            "groupid": "2",
            "name": "Linux servers",
            "internal": "0"
        },
        {
            "groupid": "4",
            "name": "Zabbix servers",
            "internal": "0"
        }
    ],
    "id": 1
}
```

[comment]: # ({/a2908ef0-8ed2756a})

[comment]: # ({6a994b89-e5f0abe1})
### Veieu també

-   [Equip](/manual/api/reference/host/object#host)

[comment]: # ({/6a994b89-e5f0abe1})

[comment]: # ({1e72ea39-1e72ea39})
### Font

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

[comment]: # ({/1e72ea39-1e72ea39})
