Zabbix Documentation 2.2

3.04.05.0 (current)| In development:5.2 (devel)| Unsupported:1.82.02.22.43.23.44.24.4Guidelines

User Tools

Site Tools


manual:api:reference:host:get

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
Previous revision
manual:api:reference:host:get [2015/06/03 08:23]
manual:api:reference:host:get [2019/02/05 12:46]
martins-v adding useful links to referenced object pages
Line 1: Line 1:
 +===== host.get =====
  
 +==== Description ====
 +
 +''​integer/​array host.get(object **parameters**)''​
 +
 +The method allows to retrieve hosts according to the given parameters.
 +
 +==== Parameters ====
 +
 +''​(object)''​ Parameters defining the desired output. ​
 +
 +The method supports the following parameters.
 +
 +^Parameter^Type^Description^
 +|groupids|string/​array| Return only hosts that belong to the given groups. | 
 +|applicationids|string/​array| Return only hosts that have the given applications. |
 +|dserviceids|string/​array| Return only hosts that are related to the given discovered services.|
 +|graphids|string/​array| Return only hosts that have the given graphs. |
 +|hostids|string/​array| Return only hosts with the given host IDs. |
 +|httptestids|string/​array| Return only hosts that have the given web checks.|
 +|interfaceids|string/​array| Return only hosts that use the given interfaces. |
 +|itemids|string/​array| Return only hosts that have the given items. |
 +|maintenanceids|string/​array| Return only hosts that are affected by the given maintenances. |
 +|monitored_hosts|flag| Return only monitored hosts. |
 +|proxy_hosts|flag| Return only proxies. |
 +|proxyids|string/​array| Return only hosts that are monitored by the given proxies. |
 +|templated_hosts|flag| Return both hosts and templates. |
 +|templateids|string/​array| Return only hosts that are linked to the given templates. |
 +|triggerids|string/​array| Return only hosts that have the given triggers. |
 +^  |||
 +|with_items|flag|Return only hosts that have items. \\ \\ Overrides the ''​with_monitored_items''​ and ''​with_simple_graph_items''​ parameters. |
 +|with_applications|flag|Return only hosts that have applications. |
 +|with_graphs|flag|Return only hosts that have graphs. |
 +|with_httptests|flag|Return only hosts that have web checks. \\ \\ Overrides the ''​with_monitored_httptests''​ parameter. |
 +|with_monitored_httptests|flag|Return only hosts that have enabled web checks. |
 +|with_monitored_items|flag|Return only hosts that have enabled items. \\ \\ Overrides the ''​with_simple_graph_items''​ parameter. |
 +|with_monitored_triggers|flag|Return only hosts that have enabled triggers. All of the items used in the trigger must also be enabled. |
 +|with_simple_graph_items|flag|Return only hosts that have items with numeric type of information. |
 +|with_triggers|flag|Return only hosts that have triggers. \\ \\ Overrides the ''​with_monitored_triggers''​ parameter. |
 +|withInventory|flag|Return only hosts that have inventory data.|
 +^  |||
 +|selectGroups|query|Return a ''​groups''​ property with host [[:​manual/​api/​reference/​hostgroup/​object|groups]] that the host belongs to.  |
 +|selectApplications|query|Return an ''​applications''​ property with host [[:​manual/​api/​reference/​application/​object|applications]].\\ \\ Supports ''​count''​. |
 +|selectDiscoveries|query|Return a ''​discoveries''​ property with host low-level discovery [[:​manual/​api/​reference/​discoveryrule/​object|rules]].\\ \\ Supports ''​count''​. |
 +|selectDiscoveryRule |query|Return a ''​discoveryRule''​ property with the low-level discovery [[:​manual/​api/​reference/​discoveryrule/​object|rule]] that created the host (from host prototype in VMware monitoring). ​ |
 +|selectGraphs|query|Return a ''​graphs''​ property with host [[:​manual/​api/​reference/​graph/​object|graphs]].\\ \\ Supports ''​count''​. |
 +|selectHostDiscovery |query|Return a ''​hostDiscovery''​ property with host discovery object data.\\ \\ The host discovery object links a discovered host to a host prototype or a host prototypes to an LLD rule and has the following properties: \\ ''​host''​ - //​(string)//​ host of the host prototype; \\  ''​hostid''​ - //​(string)//​ ID of the discovered host or host prototype; \\ ''​parent_hostid''​ - //​(string)//​ ID of the host prototype from which the host has been created; \\ ''​parent_itemid''​ - //​(string)//​ ID of the LLD rule that created the discovered host; \\ ''​lastcheck''​ - //​(timestamp)//​ time when the host was last discovered; \\ ''​ts_delete''​ - //​(timestamp)//​ time when a host that is no longer discovered will be deleted. |
 +|selectHttpTests|query|Return an ''​httpTests''​ property with host [[:​manual/​api/​reference/​httptest/​object|web scenarios]].\\ \\ Supports ''​count''​. |
 +|selectInterfaces|query|Return an ''​interfaces''​ property with host [[:​manual/​api/​reference/​hostinterface/​object|interfaces]].\\ \\ Supports ''​count''​. |
 +|selectInventory|query|Return an ''​inventory''​ property with host [[:​manual/​api/​reference/​host/​object#​host_inventory|inventory]] data.  |
 +|selectItems|query|Return an ''​items''​ property with host [[:​manual/​api/​reference/​item/​object|items]].\\ \\ Supports ''​count''​. |
 +|selectMacros|query|Return a ''​macros''​ property with host [[:​manual/​api/​reference/​usermacro/​object|macros]]. ​ |
 +|selectParentTemplates|query|Return a ''​parentTemplates''​ property with [[:​manual/​api/​reference/​template/​object|templates]] that the host is linked to.\\ \\ Supports ''​count''​. |
 +|selectScreens|query|Return a ''​screens''​ property with host [[:​manual/​api/​reference/​screen/​object|screens]].\\ \\ Supports ''​count''​. |
 +|selectTriggers|query|Return a ''​triggers''​ property with host [[:​manual/​api/​reference/​trigger/​object|triggers]].\\ \\ Supports ''​count''​. |
 +^  |||
 +|filter ​ | object |Return only those results that exactly match the given filter.\\ \\ Accepts an array, where the keys are property names, and the values are either a single value or an array of values to match against. \\ \\ Allows filtering by interface properties. |
 +| limitSelects | integer | Limits the number of records returned by subselects. \\  \\ Applies to the following subselects: \\ ''​selectParentTemplates''​ - results will be sorted by ''​host'';​ \\ ''​selectInterfaces'';​ \\ ''​selectItems''​ - sorted by ''​name'';​ \\ ''​selectDiscoveries''​ - sorted by ''​name'';​ \\ ''​selectTriggers''​ - sorted by ''​description'';​ \\ ''​selectGraphs''​ - sorted by ''​name'';​ \\ ''​selectApplications''​ - sorted by ''​name'';​ \\ ''​selectScreens''​ - sorted by ''​name''​. |
 +|search ​ | object |Return results that match the given wildcard search.\\ \\ Accepts an array, where the keys are property names, and the values are strings to search for. If no additional options are given, this will perform a ''​LIKE "​%…%"''​ search.\\ \\ Allows searching by interface properties. Works only with text fields. |
 +|sortfield|string/​array| Sort the result by the given properties. \\ \\ Possible values are: ''​hostid'',​ ''​host'',​ ''​name'',​ ''​status''​. ​ |
 +|countOutput|flag|These parameters being common for all ''​get''​ methods are described in detail in the [[manual:​api:​reference_commentary#​common_get_method_parameters|reference commentary]]. ​ |
 +| editable |boolean|:::​|
 +| excludeSearch |flag|:::|
 +| limit |integer|:::​|
 +| nodeids |string/​array|:::​|
 +| output |query|:::|
 +| preservekeys |flag|:::|
 +| searchByAny |boolean|:::​|
 +| searchWildcardsEnabled |boolean|:::​|
 +| sortorder | string/​array | ::: |
 +| startSearch |flag|:::|
 +==== Return values ====
 +
 +''​(integer/​array)''​ Returns either:
 +  * an array of objects;
 +  * the count of retrieved objects, if the ''​countOutput''​ parameter has been used.
 +
 +==== Examples ====
 +
 +=== Retrieving data by name ===
 +
 +Retrieve all data about two hosts named "​Zabbix server"​ and "Linux server"​.
 +
 +Request:
 +<code java>
 +{
 +    "​jsonrpc":​ "​2.0",​
 +    "​method":​ "​host.get",​
 +    "​params":​ {
 +        "​filter":​ {
 +            "​host":​ [
 +                "​Zabbix server",​
 +                "Linux server"​
 +            ]
 +        }
 +    },
 +    "​auth":​ "​038e1d7b1735c6a5436ee9eae095879e",​
 +    "​id":​ 1
 +}
 +</​code>​
 +
 +Response:
 +<code java>
 +{
 +    "​jsonrpc":​ "​2.0",​
 +    "​result":​ [
 +        {
 +            "​maintenances":​ [],
 +            "​hostid":​ "​10160",​
 +            "​proxy_hostid":​ "​0",​
 +            "​host":​ "​Zabbix server",​
 +            "​status":​ "​0",​
 +            "​disable_until":​ "​0",​
 +            "​error":​ "",​
 +            "​available":​ "​0",​
 +            "​errors_from":​ "​0",​
 +            "​lastaccess":​ "​0",​
 +            "​ipmi_authtype":​ "​-1",​
 +            "​ipmi_privilege":​ "​2",​
 +            "​ipmi_username":​ "",​
 +            "​ipmi_password":​ "",​
 +            "​ipmi_disable_until":​ "​0",​
 +            "​ipmi_available":​ "​0",​
 +            "​snmp_disable_until":​ "​0",​
 +            "​snmp_available":​ "​0",​
 +            "​maintenanceid":​ "​0",​
 +            "​maintenance_status":​ "​0",​
 +            "​maintenance_type":​ "​0",​
 +            "​maintenance_from":​ "​0",​
 +            "​ipmi_errors_from":​ "​0",​
 +            "​snmp_errors_from":​ "​0",​
 +            "​ipmi_error":​ "",​
 +            "​snmp_error":​ "",​
 +            "​jmx_disable_until":​ "​0",​
 +            "​jmx_available":​ "​0",​
 +            "​jmx_errors_from":​ "​0",​
 +            "​jmx_error":​ "",​
 +            "​name":​ "​Zabbix server"​
 +        },
 +        {
 +            "​maintenances":​ [],
 +            "​hostid":​ "​10167",​
 +            "​proxy_hostid":​ "​0",​
 +            "​host":​ "Linux server",​
 +            "​status":​ "​0",​
 +            "​disable_until":​ "​0",​
 +            "​error":​ "",​
 +            "​available":​ "​0",​
 +            "​errors_from":​ "​0",​
 +            "​lastaccess":​ "​0",​
 +            "​ipmi_authtype":​ "​-1",​
 +            "​ipmi_privilege":​ "​2",​
 +            "​ipmi_username":​ "",​
 +            "​ipmi_password":​ "",​
 +            "​ipmi_disable_until":​ "​0",​
 +            "​ipmi_available":​ "​0",​
 +            "​snmp_disable_until":​ "​0",​
 +            "​snmp_available":​ "​0",​
 +            "​maintenanceid":​ "​0",​
 +            "​maintenance_status":​ "​0",​
 +            "​maintenance_type":​ "​0",​
 +            "​maintenance_from":​ "​0",​
 +            "​ipmi_errors_from":​ "​0",​
 +            "​snmp_errors_from":​ "​0",​
 +            "​ipmi_error":​ "",​
 +            "​snmp_error":​ "",​
 +            "​jmx_disable_until":​ "​0",​
 +            "​jmx_available":​ "​0",​
 +            "​jmx_errors_from":​ "​0",​
 +            "​jmx_error":​ "",​
 +            "​name":​ "Linux server"​
 +        }
 +    ],
 +    "​id":​ 1
 +}
 +</​code>​
 +
 +=== Retrieving host groups ===
 +
 +Retrieve names of the groups host "​Zabbix server"​ is member of, but no host details themselves.
 +
 +Request:
 +<code java>
 +{
 +    "​jsonrpc":​ "​2.0",​
 +    "​method":​ "​host.get",​
 +    "​params":​ {
 +        "​output":​ ["​hostid"​],​
 +        "​selectGroups":​ "​extend",​
 +        "​filter":​ {
 +            "​host":​ [
 +                "​Zabbix server"​
 +            ]
 +        }
 +    },
 +    "​auth":​ "​038e1d7b1735c6a5436ee9eae095879e",​
 +    "​id":​ 2
 +}
 +</​code>​
 +
 +Response:
 +<code java>
 +{
 +    "​jsonrpc":​ "​2.0",​
 +    "​result":​ [
 +        {
 +            "​hostid":​ "​10085",​
 +            "​groups":​ [
 +                {
 +                    "​groupid":​ "​2",​
 +                    "​name":​ "Linux servers",​
 +                    "​internal":​ "​0",​
 +                    "​flags":​ "​0"​
 +                },
 +                {
 +                    "​groupid":​ "​4",​
 +                    "​name":​ "​Zabbix servers",​
 +                    "​internal":​ "​0",​
 +                    "​flags":​ "​0"​
 +                }
 +            ]
 +        }
 +    ],
 +    "​id":​ 2
 +}
 +</​code>​
 +
 +=== Retrieving linked templates ===
 +
 +Retrieve the IDs and names of templates linked to host "​10084"​.
 +
 +Request:
 +<code java>
 +{
 +    "​jsonrpc":​ "​2.0",​
 +    "​method":​ "​host.get",​
 +    "​params":​ {
 +        "​output":​ ["​hostid"​],​
 +        "​selectParentTemplates":​ [
 +            "​templateid",​
 +            "​name"​
 +        ],
 +        "​hostids":​ "​10084"​
 +    },
 +    "​id":​ 1,
 +    "​auth":​ "​70785d2b494a7302309b48afcdb3a401"​
 +}
 +</​code>​
 +
 +Response:
 +<code java>
 +{
 +    "​jsonrpc":​ "​2.0",​
 +    "​result":​ [
 +        {
 +            "​hostid":​ "​10084",​
 +            "​parentTemplates":​ [
 +                {
 +                    "​name":​ "​Template OS Linux",​
 +                    "​templateid":​ "​10001"​
 +                },
 +                {
 +                    "​name":​ "​Template App Zabbix Server",​
 +                    "​templateid":​ "​10047"​
 +                }
 +            ]
 +        }
 +    ],
 +    "​id":​ 1
 +}
 +</​code>​
 +==== See also ====
 +
 +  * [[getobjects|host.getobjects]]
 +  * [[manual:​api:​reference:​hostgroup:​object#​host_group|Host group]]
 +  * [[manual:​api:​reference:​template:​object#​template|Template]]
 +  * [[manual:​api:​reference:​usermacro:​object#​hosttemplate_level_macro|User macro]]
 +  * [[manual:​api:​reference:​hostinterface:​object#​host_interface|Host interface]]
 +==== Source ====
 +
 +CHost::​get() in //​frontends/​php/​api/​classes/​CHost.php//​.