[comment]: # translation:outdated
[comment]: # ({65bbffce-65bbffce})
# host.get
[comment]: # ({/65bbffce-65bbffce})
[comment]: # ({54619a1f-93035b19})
### Descripció
`integer/array host.get(object parameters)`
El mètode permet recuperar 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]: # ({/54619a1f-93035b19})
[comment]: # ({f035045d-77a8fabb})
### Paràmetres
`(object)` Paràmetres definit la sortida esperada.
El mètode admet els paràmetres següents.
|Paràmetre|[Tipus](/manual/api/reference_commentary#data_types)|Descripció|
|--|--|------|
|groupids|ID/array|Retorna només els equips que pertanyen als grups donats.|
|dserviceids|ID/array|Retorna només els equips associats amb els serveis descoberts donats.|
|graphids|ID/array|Retorna només els equips que tenen els gràfics indicats.|
|hostids|ID/array|Retorna només els equips amb els ID d'equip donats.|
|httptestids|ID/array|Retorna només els equips amb els monitors web indicats.|
|interfaceids|ID/array|Retorna només els equips que empren les interfícies donades.|
|itemids|ID/array|Retorna només els equips amb els elements donats.|
|maintenanceids|ID/array|Retorna només els equips afectats pels manteniments donats.|
|monitored\_hosts|flag|Retorna només els equips monitorats.|
|proxyids|ID/array|Retorna només els equips monitorats pels proxys donats.|
|proxy_groupids|ID/array|Retorna només els equips que són monitorats per els grups de proxys donats.|
|templated\_hosts|flag|Retorna tant equips com plantilles.|
|templateids|ID/array|Retorna només els equips vinculats a les plantilles donades.|
|triggerids|ID/array|Retorna només els equips amb els triggers donats.|
|with\_items|flag|Retorna només els equips que tenen elements.
Substitueix els paràmetres `with_monitored_items` i `with_simple_graph_items`.|
|with\_item\_prototypes|flag|Retorna només els equips que tenen prototipus d'elements.
Sobreescriu el paràmetre `with_simple_graph_item_prototypes`.|
|with\_simple\_graph\_item\_prototypes|flag|Retorna només els equips que tenen prototipus d'elements, són habilitats per a la creació i tenen informació de tipus numèric.|
|with\_graph|flag|Retorna només equips amb gràfics.|
|with\_graph\_prototypes|flag|Retorna només els equips amb prototips de gràfics.|
|with\_httptests|flag|Retorna només equips amb monitoratge web.
Sobreescriu el paràmetre `with_monitored_httptests`.|
|with\_monitored\_httptests|flag|Retorna només equips amb monitors web actius.|
|with\_monitored\_items|flag|Retorna només els equips amb elements actius.
Anul·la la configuració `with_simple_graph_items`.|
|with\_monitored\_triggers|flag|Retorna només els equips amb triggers actius. També s'han d'activar tots els elements emprats al trigger.|
|with\_simple\_graph\_items|flag|Retorna només els equips amb elements que contenen informació de tipus numèric.|
|with\_triggers|flag|Retorna només els equips amb triggers.
Anul·la la configuració `with_monitored_triggers`.|
|withProblemsSuppressed|boolean|Retorna els equips amb problemes esborrats.
Valors possibles:
`null` - (per defecte) tots els equips;
`true` - només els equips amb problemes eborrats;
`false` - només els equips amb problemes no esborrats.|
|evaltype|integer|[Mètode d'avaluació](/manual/web_interface/frontend_sections/data_collection/hosts#using-filter) d'etiquetes.
Valors possibles:
0 - (per defecte) i/o;
2 - O.|
|severities|integer/array|Retorna els equips que només tenen problemes amb una gravetat determinada. S'aplica només si l'objecte problemàtic és un trigger.|
|tags|object/array|Retorna només els equips amb etiquetes donades. Concordança exacta per etiqueta i cerca entre majúscules i minúscules o no per valor d'etiqueta en funció del valor de l'operador.
Format: `[{"tag": "", "value": "< valor>", "operator": ""}, ...]`.
Una matriu buida retorna tots els equips.
Possibles valors d'[operador](/manual/web_interface/frontend_sections/data_collection/web#using-filter):
0 - (per defecte) Conté;
1 - És igual;
2 - No és com;
3 - No és igual
4 - Existeix;
5 - No existeix.|
|inheritedTags|boolean|Retorna els equips que tenen `etiquetes` donades així com en totes les seves plantilles enllaçades.
Possibles valors:
`true` - els models enllaçats també han de tenir les `etiquetes`;
`false` - *(per defecte)* les etiquetes de models enllaçats s'ignoren.
|selectDiscoveries|query|Retorna una propietat [`discoveries`](/manual/api/reference/discoveryrule/object) que conté regles de descoberta de baix nivell.
Admet `count`.|
|selectDiscoveryRule|query|Retorna una propietat [`discoveryRule`](/manual/api/reference/discoveryrule/object) amb la regla de descoberta de baix nivell que va crear l'equip (a partir del prototip d'equip al monitoratge de VMware).|
|selectGraphs|query|Retorna una propietat [`graphs`](/manual/api/reference/graph/object) amb gràfics de l'equip.
Admet `count`.|
|selectHostDiscovery|query|Retorna una propietat `hostDiscovery` amb dades de l'objecte de descoberta de l'equip.
L'objecte de descoberta de l'equip enllaça un equip descobert a un prototip o un prototip d'equips a una regla de descoberta de baix nivell i té les propietats següents:
`host` - *(string)* equip de l'equip prototip;
`hostid` - *(string)* Id de l'equip descobert o equip prototip;
`parent_hostid` - *(string)* ID del prototip d'equip a partir del qual es va crear l'equip;
`parent_itemid` - *(string)* ID de la regla de descoberta de baix nivell que va crear l'equip descobert;
`lastcheck` - *(timestamp)* hora en què es va trobar l'equip per darrer cop;
`status` - *(int)* estat de la descoberta de l'equip:
0 - *(per defecte)* l'euqip s'ha trobat,
1 - l'equip ja no es troba;
`ts_delete` - *(timestamp)* hora en què s'eliminarà un equip que ja no es descobreix;
`ts_disable` - *(timestamp)* hora quan l'equip que ja no es troba es desactivarà;
`disable_source` - *(int)* indicador sobre si l'equip s'ha deshabilitat per una regla LLD o manualment:
0 - *(per defecte)* desactivat automàticament,
1 - desactivat per una regla LLD.|
|selectHostGroups|query|Retorna una propietat [`hostgrups`](/manual/api/reference/hostgroup/object) amb els grups d'equip als quals pertany l'equip.|
|selectHttpTests|query|Retorna una propietat [`httpTests`](/manual/api/reference/httptest/object) amb escenaris web d'equip.
Admet `count`.|
|selectInterfaces|query|Retorna una propietat [`interfaces`](/manual/api/reference/hostinterface/object) amb interfícies d'equip.
Admet `count`.|
|selectInventory|query|Retorna una propietat [`inventory`](/manual/api/reference/host/object#host_inventory) amb dades d'inventari de l'equip.|
|selectItems|query|Retorna una propietat [`items`](/manual/api/reference/item/object) amb elements de l'equip.
Admet `count`.|
|selectMacros|query|Retorna una propietat de [`macros`](/manual/api/reference/usermacro/object) amb macros de l'equip.|
|selectParentTemplates|query|Retorna una propietat [`parentTemplates`](/manual/api/reference/template/object) amb les [plantilles](/manual/api/reference/template/object) a les quals està vinculat l'equip.
A més dels camps de l'objecte de la plantilla, també conté `link_type` - `(integer)` de quina manera la plantilla s'ha enllaçat a l'equip.
Valors possibles:
0 - *(per defecte)* enllaçada manualment;
1 - enllaçada automàticament per una regla LLD.
Admet `count`.|
|selectDashboards|query|Retorna una propietat [`dashboards`](/manual/api/reference/templatedashboard/object).
Admet `count`.|
|selectTags|query|Retorna una propietat [`tags`](/manual/api/reference/host/object#host_tag) amb totes les etiquetes d'equip.|
|selectInheritedTags|query|Retorna una propietat [`inheritedTags`](/manual/api/reference/host/object#host_tag) amb les etiquetes que es troben a tots els models vinculats a l'equip.|
|selectTriggers|query|Retorna una propietat [`triggers`](/manual/api/reference/trigger/object) amb triggers de l'equip.
Admet `count`.|
|selectValueMaps|query|Retorna una propietat [`valuemaps`](/manual/api/reference/valuemap/object) amb mapes de valors de l'equip.|
|filter|object|Només retorna resultats que coincideixen exactament amb el filtre donat.
Accepta un objecte, on les claus són noms de propietat i els valors són un valor únic o una matriu de valors per comparar.
No admet propietats del [tipus d'informació](/manual/api/reference_commentary#data-types) `text`.
Admet propietats addicionals: propietats d'[interfície d'equip](/manual/api/reference/hostinterface/object#host-interface-object).|
|limitSelects|integer|Limita el nombre de registres retornats per subconsultes.
S'aplica a les subconsultes següents:
`selectParentTemplates` - els resultats s'ordenaran per `host`;
`selectInterfaces`;
`selectItems` - ordenat per `name`;
`selectDiscoveries` - ordenat per `name`;
`selectTriggers` - ordenat per `description`;
`selectGraphs ` - ordenat per `name`;
`selectDashboards` - ordenat per `name`.|
|search|object|Retorna resultats que coincideixen amb la cerca genèrica donada (sensible a majúscules i minúscules).
Admet un objecte, on les claus són noms de propietat i els valors són cadenes per cercar. Si no es donen opcions addicionals, es farà una cerca de tipus `LIKE "%...%"`.
Només permet les propietats de [tipus de dades](/manual/api/reference_commentary#data-types) `string` i `text`.
Admet propietats addicionals: propietats d'[interfície d'equip](/manual/api/reference/hostinterface/object#host-interface-object).|
|searchInventory|object|Retorna només els equips les dades d'inventari dels quals coincideixen amb el patró donat (sensible a majúscules i minúscules).
Admet un objecte, on les claus són noms de propietat i els valors són cadenes per cercar. Si no es donen opcions addicionals, es farà una cerca de tipus `LIKE "%...%"`.
Només permet les propietats de [tipus de dades](/manual/api/reference_commentary#data-types) `string` i `text`.|
|sortfield|string/array|Ordena el resultat segons les propietats donades.
Valors possibles: `hostid`, `host`, `name`, `status`.|
|countOutput|boolean|Aquests paràmetres es descriuen als [comentaris de referència](/manual/api/reference_commentary#common_get_method_parameters).|
|editable|boolean|^|
|excludeSearch|boolean|^|
|limit|integer|^|
|output|query|^|
|preservekeys|boolean|^|
|searchByAny|boolean|^|
|searchWildcardsEnabled|boolean|^|
|sortorder|string/array|^|
|startSearch|boolean|^|
|selectGroups
(obsolet)|query|Aquest paràmetre és obsolet; si et plau, empra `selectHostGroups` en el seu lloc.
Retorna la propietat [`groups`](/manual/api/reference/templategroup/object) amb informació dels grups d'equips on pertany l'equip.|
[comment]: # ({/f035045d-77a8fabb})
[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]: # ({bdf49605-c6ea3cce})
#### Recuperar informació per nom
Recuperar tota la informació de dos equips anomenats "Servidor Zabbix " i "Servidor Linux".
[Petició](/manual/api#performing-requests):
```json
{
"jsonrpc": "2.0",
"method": "host.get",
"params": {
"filter": {
"host": [
"Servidor Zabbix",
"Servidor Linux"
]
}
},
"id": 1
}
```
Resposta:
```json
{
"jsonrpc": "2.0",
"result": [
{
"hostid": "10160",
"proxyid": "0",
"host": "Servidor Zabbix",
"status": "0",
"ipmi_authtype": "-1",
"ipmi_privilege": "2",
"ipmi_username": "",
"ipmi_password": "",
"maintenanceid": "0",
"maintenance_status": "0",
"maintenance_type": "0",
"maintenance_from": "0",
"name": "Servidor Zabbix",
"flags": "0",
"description": "El servidor de monitorització Zabbix.",
"tls_connect": "1",
"tls_accept": "1",
"tls_issuer": "",
"tls_subject": "",
"proxy_groupid": "0",
"monitored_by": "0",
"inventory_mode": "1",
"active_available": "1",
"assigned_proxyid": "0"
},
{
"hostid": "10167",
"proxyid": "0",
"host": "Linux server",
"status": "0",
"ipmi_authtype": "-1",
"ipmi_privilege": "2",
"ipmi_username": "",
"ipmi_password": "",
"maintenanceid": "0",
"maintenance_status": "0",
"maintenance_type": "0",
"maintenance_from": "0",
"name": "Linux server",
"flags": "0",
"description": "",
"tls_connect": "1",
"tls_accept": "1",
"tls_issuer": "",
"tls_subject": "",
"proxy_groupid": "0",
"monitored_by": "0",
"inventory_mode": "1",
"active_available": "1",
"assigned_proxyid": "0"
}
],
"id": 1
}
```
[comment]: # ({/bdf49605-c6ea3cce})
[comment]: # ({8d87c206-9078aff7})
#### Recuperar els grups d'equips
Recupera els noms dels grups on l'equip "Servidor Zabbix" n'és membre.
[Petició](/manual/api#performing-requests):
```json
{
"jsonrpc": "2.0",
"method": "host.get",
"params": {
"output": ["hostid"],
"selectHostGroups": "extend",
"filter": {
"host": [
"Servidor Zabbix"
]
}
},
"id": 1
}
```
Resposta:
```json
{
"jsonrpc": "2.0",
"result": [
{
"hostid": "10085",
"hostgroups": [
{
"groupid": "2",
"name": "Linux servers",
"flags": "0",
"uuid": "dc579cd7a1a34222933f24f52a68bcd8"
},
{
"groupid": "4",
"name": "Zabbix servers",
"flags": "0",
"uuid": "6f6799aa69e844b4b3918f779f2abf08"
}
]
}
],
"id": 1
}
```
[comment]: # ({/8d87c206-9078aff7})
[comment]: # ({3f6d4bdf-59c8a46a})
#### Recuperar les plantilles enllaçades
Recupera l'ID i els noms de les plantilles enllaçades a l'equip "10084".
[Petició](/manual/api#performing-requests):
```json
{
"jsonrpc": "2.0",
"method": "host.get",
"params": {
"output": ["hostid"],
"selectParentTemplates": [
"templateid",
"name"
],
"hostids": "10084"
},
"id": 1
}
```
Resposta:
```json
{
"jsonrpc": "2.0",
"result": [
{
"hostid": "10084",
"parentTemplates": [
{
"name": "Linux",
"templateid": "10001"
},
{
"name": "Zabbix Server",
"templateid": "10047"
}
]
}
],
"id": 1
}
```
[comment]: # ({/3f6d4bdf-59c8a46a})
[comment]: # ({9a8b8f9f-942e31bf})
#### Recuperar equips per plantilla
Recupera els equips que tenen la plantilla "10001" (*Linux amb agent Zabbix*) enllaçada.
[Petició](/manual/api#performing-requests):
```json
{
"jsonrpc": "2.0",
"method": "host.get",
"params": {
"output": ["hostid", "name"],
"templateids": "10001"
},
"id": 1
}
```
Resposta:
```json
{
"jsonrpc": "2.0",
"result": [
{
"templateid": "10001",
"hosts": [
{
"hostid": "10084",
"name": "Zabbix server"
},
{
"hostid": "10603",
"name": "Host 1"
},
{
"hostid": "10604",
"name": "Host 2"
}
]
}
],
"id": 1
}
```
[comment]: # ({/9a8b8f9f-942e31bf})
[comment]: # ({63a1e5ba-8be1d99c})
#### Cerca d'equip per les dades de l'inventari
Cerca els equips que contenen "Linux" al camp OS" de l'inventari.
[Petició](/manual/api#performing-requests):
```json
{
"jsonrpc": "2.0",
"method": "host.get",
"params": {
"output": [
"host"
],
"selectInventory": [
"os"
],
"searchInventory": {
"os": "Linux"
}
},
"id": 1
}
```
Resposta:
```json
{
"jsonrpc": "2.0",
"result": [
{
"hostid": "10084",
"host": "Zabbix server",
"inventory": {
"os": "Linux Ubuntu"
}
},
{
"hostid": "10107",
"host": "Linux server",
"inventory": {
"os": "Linux Mint"
}
}
],
"id": 1
}
```
[comment]: # ({/63a1e5ba-8be1d99c})
[comment]: # ({b6238857-b4e37e5e})
#### Cerca per etiquetes d'equip
Recupera els equips que tenen "linux-server" com a etiqueta de "host-name".
[Petició](/manual/api#performing-requests):
```json
{
"jsonrpc": "2.0",
"method": "host.get",
"params": {
"output": ["hostid"],
"selectTags": "extend",
"evaltype": 0,
"tags": [
{
"tag": "host-name",
"value": "linux-server",
"operator": 1
}
]
},
"id": 1
}
```
Resposta:
```json
{
"jsonrpc": "2.0",
"result": [
{
"hostid": "10085",
"tags": [
{
"tag": "host-name",
"value": "linux-server",
"automatic": "0"
},
{
"tag": "os",
"value": "rhel-7",
"automatic": "0"
}
]
}
],
"id": 1
}
```
Recupera els equips que tenen aquestes etiquetes no només a nivell d'equip sinó també a les seves plantilles heretades enllaçades.
[Petició](/manual/api#performing-requests):
```json
{
"jsonrpc": "2.0",
"method": "host.get",
"params": {
"output": ["name"],
"tags": [
{
"tag": "os",
"value": "rhel-7",
"operator": 1
}
],
"inheritedTags": true
},
"id": 1
}
```
Resposta:
```json
{
"jsonrpc": "2.0",
"result": [
{
"hostid": "10623",
"name": "PC room 1"
},
{
"hostid": "10601",
"name": "Office"
}
],
"id": 1
}
```
[comment]: # ({/b6238857-b4e37e5e})
[comment]: # ({c6c128e0-9ebae84e})
#### Cerca d'equips amb les etiquetes i les etiquetes de les plantilles
Cerca un equip amb les etiquetes i totes les etiquetes enllaçades a les plantilles mare.
[Petició](/manual/api#performing-requests):
```json
{
"jsonrpc": "2.0",
"method": "host.get",
"params": {
"output": ["name"],
"hostids": 10502,
"selectTags": ["tag", "value"],
"selectInheritedTags": ["tag", "value"]
},
"id": 1
}
```
Resposta:
```json
{
"jsonrpc": "2.0",
"result": [
{
"hostid": "10502",
"name": "Desktop",
"tags": [
{
"tag": "host-name",
"value": "linux-server"
},
{
"tag": "os",
"value": "rhel-7"
}
],
"inheritedTags": [
{
"tag": "class",
"value": "os"
},
{
"tag": "target",
"value": "linux"
},
{
"tag": "os",
"value": "rhel-7"
}
]
}
],
"id": 1
}
```
[comment]: # ({/c6c128e0-9ebae84e})
[comment]: # ({ee33fbef-219d4ee1})
#### Cerca d'equips per gravetat del problema
Cerca els equips que tenen problemes amb gravetat "Desastre".
[Petició](/manual/api#performing-requests):
```json
{
"jsonrpc": "2.0",
"method": "host.get",
"params": {
"output": ["name"],
"severities": 5
},
"id": 1
}
```
Resposta:
```json
{
"jsonrpc": "2.0",
"result": [
{
"hostid": "10160",
"name": "Zabbix server"
}
],
"id": 1
}
```
Recupera els equips que tenen com gravetat "Mitjana" i "Alta".
[Petició](/manual/api#performing-requests):
```json
{
"jsonrpc": "2.0",
"method": "host.get",
"params": {
"output": ["name"],
"severities": [3, 4]
},
"id": 1
}
```
Resposta:
```json
{
"jsonrpc": "2.0",
"result": [
{
"hostid": "20170",
"name": "Database"
},
{
"hostid": "20183",
"name": "workstation"
}
],
"id": 1
}
```
[comment]: # ({/ee33fbef-219d4ee1})
[comment]: # ({new-56ff1999})
#### Retrieving host items
Retrieve items for the "Zabbix server" host. The request is limited to the item properties `itemid`, `name`, and `status`. Due to the large response size, only a subset of items is shown in the example.
[Request](/manual/api#performing-requests):
```json
{
"jsonrpc": "2.0",
"method": "host.get",
"params": {
"output": ["hostid"],
"selectItems": ["itemid","name","status"],
"filter": {
"host": [
"Zabbix server"
]
}
},
"id": 1
}
```
Response:
```json
{
"jsonrpc": "2.0",
"result": [
{
"hostid": "10084",
"items": [
{
"itemid": "42227",
"name": "Host name of Zabbix agent running",
"status": "0"
},
{
"itemid": "42237",
"name": "Zabbix agent ping",
"status": "0"
},
{
"itemid": "42250",
"name": "Version of Zabbix agent running",
"status": "0"
},
{
"itemid": "42251",
"name": "Maximum number of open file descriptors",
"status": "0"
},
{
"itemid": "42252",
"name": "Maximum number of processes",
"status": "0"
},
{
"itemid": "69869",
"name": "Interface enp0s3: Inbound packets discarded",
"status": "0"
},
{
"itemid": "69870",
"name": "Interface enp0s3: Inbound packets with errors",
"status": "0"
},
{
"itemid": "69871",
"name": "Interface enp0s3: Bits received",
"status": "0"
},
{
"itemid": "69872",
"name": "Interface enp0s3: Outbound packets discarded",
"status": "0"
},
{
"itemid": "69873",
"name": "Interface enp0s3: Outbound packets with errors",
"status": "0"
},
{
"itemid": "69874",
"name": "Interface enp0s3: Bits sent",
"status": "0"
},
{
"itemid": "42253",
"name": "Number of processes",
"status": "0"
},
{
"itemid": "42254",
"name": "Number of running processes",
"status": "0"
},
{
"itemid": "42255",
"name": "System boot time",
"status": "0"
}
]
}
],
"id": 1
}
```
[comment]: # ({/new-56ff1999})
[comment]: # ({1b616a06-06c7fe93})
### Veieu també
- [Grup d'equips](/manual/api/reference/hostgroup/object#host_group)
- [Plantilla](/manual/api/reference/template/object#template)
- [Macro d'usuari](/manual/api/reference/usermacro/object#hosttemplate_level_macro)
- [Interfície d'equip](/manual/api/reference/hostinterface/object#host_interface)
- [Proxy](/manual/api/reference/proxy/object#proxy)
- [Grup de proxys](/manual/api/reference/proxygroup/object#proxy_group)
[comment]: # ({/1b616a06-06c7fe93})
[comment]: # ({55c08f7a-55c08f7a})
### Font
CHost::get() in *ui/include/classes/api/services/CHost.php*.
[comment]: # ({/55c08f7a-55c08f7a})