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
Next revision
Previous revision
Last revision Both sides next revision
manual:api:reference:host:get [2015/11/17 07:11]
sasha [Source] fixed path
manual:api:reference:host:get [2020/05/05 11:31]
martins-v frontends/php -> ui (ZBX-17667)
Line 31: Line 31:
 ^  ||| ^  |||
 |with_items|flag|Return only hosts that have items. \\ \\ Overrides the ''​with_monitored_items''​ and ''​with_simple_graph_items''​ parameters. | |with_items|flag|Return only hosts that have items. \\ \\ Overrides the ''​with_monitored_items''​ and ''​with_simple_graph_items''​ parameters. |
 +|with_item_prototypes|flag|Return only hosts that have item prototypes. \\ \\ Overrides the ''​with_simple_graph_item_prototypes''​ parameter. |
 +|with_simple_graph_item_prototypes|flag|Return only hosts that have item prototypes, which are enabled for creation and have numeric type of information. |
 |with_applications|flag|Return only hosts that have applications. | |with_applications|flag|Return only hosts that have applications. |
 |with_graphs|flag|Return only hosts that have graphs. | |with_graphs|flag|Return only hosts that have graphs. |
 +|with_graph_prototypes|flag|Return only hosts that have graph prototypes. |
 |with_httptests|flag|Return only hosts that have web checks. \\ \\ Overrides the ''​with_monitored_httptests''​ parameter. | |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_httptests|flag|Return only hosts that have enabled web checks. |
Line 39: Line 42:
 |with_simple_graph_items|flag|Return only hosts that have items with numeric type of information. | |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. | |with_triggers|flag|Return only hosts that have triggers. \\ \\ Overrides the ''​with_monitored_triggers''​ parameter. |
-|withInventory|flag|Return only hosts that have inventory data.|+|withProblemsSuppressed|boolean|Return ​hosts that have suppressed problems. \\ \\ Possible values: \\ ''​null''​ - (default) all hosts; \\ ''​true''​ - only hosts with suppressed problems; \\ ''​false''​ - only hosts with unsuppressed problems. | 
 +|evaltype|integer|Rules for tag searching. \\ \\ Possible values: \\ 0 - (default) And/Or; \\ 2 - Or. | 
 +|severities|integer/​array|Return ​hosts that have only problems with given severities. Applies only if problem object is trigger. | 
 +|tags|array/​object|Return only hosts with given tags. Exact match by tag and case-sensitive or case-insensitive search by tag value depending on operator value. \\ Format: ''<​nowiki>​[{"​tag":​ "<​tag>",​ "​value":​ "<​value>",​ "​operator":​ "<​operator>"​},​ ...]</​nowiki>''​.\\ An empty array returns all hosts. \\ \\ Possible operator values: \\ 0 - (default) Contains; \\ 1 - Equals. | 
 +|inheritedTags|boolean|Return hosts that have given ''​tags''​ also in all of their linked templates. Default: \\ \\ Possible values: \\ ''​true''​ - linked templates must also have given ''​tags'';​ \\ ''​false''​ - (default) linked template tags are ignored. |
 ^  ||| ^  |||
-|selectGroups|query|Return ​the host groups that the host belongs to in the ''​groups''​ property. | +|selectApplications|query|Return ​an ''​[[:​manual/​api/​reference/​application/​object|applications]]''​ property ​with host applications.\\ \\ Supports ''​count''​. | 
-|selectApplications|query|Return the applications from the host in the ''​applications''​ property. \\ \\ Supports ''​count''​. | +|selectDiscoveries|query|Return ​''​[[:​manual/​api/​reference/​discoveryrule/​object|discoveries]]''​ property ​with host low-level discovery rules.\\ \\ Supports ''​count''​. | 
-|selectDiscoveries|query|Return ​the low level discoveries from the host in the ''​discoveries''​ property. \\ \\ Supports ''​count''​. | +|selectDiscoveryRule |query|Return ​a ''​[[:​manual/​api/​reference/​discoveryrule/​object|discoveryRule]]''​ property with the low-level discovery ​rule that created the host (from host prototype ​in VMware monitoring) 
-|selectDiscoveryRule | query | Return the LLD rule that created the host in the ''​discoveryRule''​ property. | +|selectGraphs|query|Return ​''​[[:​manual/​api/​reference/​graph/​object|graphs]]''​ property ​with host graphs.\\ \\ Supports ''​count''​. | 
-|selectGraphs|query|Return ​the graphs from the host in the ''​graphs''​ property. \\ \\ Supports ''​count''​. | +|selectGroups|query|Return ​a ''​[[:​manual/​api/​reference/​hostgroup/​object|groups]]''​ property with host groups data that the host belongs to.  | 
-|selectHostDiscovery ​| query | Return ​the host discovery ​object ​in the ''​hostDiscovery''​ property. \\ \\ 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. | +|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 ​the web scenarios from the host in the ''​httpTests''​ property. \\ \\ Supports ''​count''​. | +|selectHttpTests|query|Return ​an ''​[[:​manual/​api/​reference/​httptest/​object|httpTests]]''​ property ​with host web scenarios.\\ \\ Supports ''​count''​. | 
-|selectInterfaces|query|Return ​the host interfaces in the ''​interfaces''​ property. \\ \\ Supports ''​count''​. | +|selectInterfaces|query|Return ​an ''​[[:​manual/​api/​reference/​hostinterface/​object|interfaces]]''​ property ​with host interfaces.\\ \\ Supports ''​count''​. | 
-|selectInventory|query|Return ​the host inventory from the host in the ''​inventory''​ property. | +|selectInventory|query|Return ​an ''​[[:​manual/​api/​reference/​host/​object#​host_inventory|inventory]]''​ property ​with host inventory data 
-|selectItems|query|Return ​the items from the host in the ''​items''​ property. \\ \\ Supports ''​count''​. | +|selectItems|query|Return ​an ''​[[:​manual/​api/​reference/​item/​object|items]]''​ property ​with host items.\\ \\ Supports ''​count''​. | 
-|selectMacros|query|Return ​the macros from the host in the ''​macros''​ property. | +|selectMacros|query|Return ​''​[[:​manual/​api/​reference/​usermacro/​object|macros]]''​ property ​with host macros 
-|selectParentTemplates|query|Return ​the templates that the host is linked to in the ''​parentTemplates''​ property. \\ \\ Supports ''​count''​. | +|selectParentTemplates|query|Return ​a ''​[[:​manual/​api/​reference/​template/​object|parentTemplates]]''​ property with templates that the host is linked to.\\ \\ Supports ''​count''​. | 
-|selectScreens|query|Return ​the screens from the host in the ''​screens''​ property. \\ \\ Supports ''​count''​. | +|selectScreens|query|Return ​''​[[:​manual/​api/​reference/​screen/​object|screens]]''​ property ​with host screens.\\ \\ Supports ''​count''​. | 
-|selectTriggers|query|Return ​the triggers from the host in the ''​triggers''​ property. \\ \\ Supports ''​count''​. |+|selectTags|query|Return ​a ''​[[:​manual/​api/​reference/​host/​object#​host_tag|tags]]'' ​property with host tags. | 
 +|selectInheritedTags|query| Return an ''​[[:​manual/​api/​reference/​host/​object#​host_tag|inheritedTags]]''​ property with tags that are on all templates which are linked to host. | 
 +|selectTriggers|query|Return a ''​[[:​manual/​api/​reference/​trigger/​object|triggers]]''​ property ​with host 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. | |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. |
Line 61: Line 70:
 |searchInventory | object | Return only hosts that have inventory data matching the given wildcard search. \\ \\ This parameter is affected by the same additional parameters as ''​search''​. | |searchInventory | object | Return only hosts that have inventory data matching the given wildcard search. \\ \\ This parameter is affected by the same additional parameters as ''​search''​. |
 |sortfield|string/​array| Sort the result by the given properties. \\ \\ Possible values are: ''​hostid'',​ ''​host'',​ ''​name'',​ ''​status''​. ​ | |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]]. ​ |+|countOutput|boolean|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|:::​| | editable |boolean|:::​|
-| excludeSearch |flag|:::|+| excludeSearch |boolean|:::|
 | limit |integer|:::​| | limit |integer|:::​|
 | output |query|:::| | output |query|:::|
-| preservekeys |flag|:::|+| preservekeys |boolean|:::|
 | searchByAny |boolean|:::​| | searchByAny |boolean|:::​|
 | searchWildcardsEnabled |boolean|:::​| | searchWildcardsEnabled |boolean|:::​|
 | sortorder | string/​array | ::: | | sortorder | string/​array | ::: |
-| startSearch |flag|:::|+| startSearch |boolean|:::|
 ==== Return values ==== ==== Return values ====
  
Line 84: Line 93:
  
 Request: Request:
-<​code ​js>+<​code ​java>
 { {
     "​jsonrpc":​ "​2.0",​     "​jsonrpc":​ "​2.0",​
     "​method":​ "​host.get",​     "​method":​ "​host.get",​
     "​params":​ {     "​params":​ {
-        "​output":​ "​extend",​ 
         "​filter":​ {         "​filter":​ {
             "​host":​ [             "​host":​ [
Line 103: Line 111:
  
 Response: Response:
-<​code ​js>+<​code ​java>
 { {
     "​jsonrpc":​ "​2.0",​     "​jsonrpc":​ "​2.0",​
Line 139: Line 147:
             "​jmx_error":​ "",​             "​jmx_error":​ "",​
             "​name":​ "​Zabbix server",​             "​name":​ "​Zabbix server",​
-            "​description":​ "The Zabbix monitoring server."​+            "​description":​ "The Zabbix monitoring server.", 
 +            "​tls_connect":​ "​1",​ 
 +            "​tls_accept":​ "​1",​ 
 +            "​tls_issuer":​ "",​ 
 +            "​tls_subject":​ "",​ 
 +            "​tls_psk_identity":​ "",​ 
 +            "​tls_psk":​ ""
         },         },
         {         {
Line 173: Line 187:
             "​jmx_error":​ "",​             "​jmx_error":​ "",​
             "​name":​ "Linux server",​             "​name":​ "Linux server",​
-            "​description":​ ""​+            "​description": "",​ 
 +            "​tls_connect":​ "​1",​ 
 +            "​tls_accept":​ "​1",​ 
 +            "​tls_issuer":​ "",​ 
 +            "​tls_subject":​ "",​ 
 +            "​tls_psk_identity":​ "",​ 
 +            "​tls_psk": ""​
         }         }
     ],     ],
Line 184: Line 204:
  
 Request: Request:
-<​code ​js>+<​code ​java>
 { {
     "​jsonrpc":​ "​2.0",​     "​jsonrpc":​ "​2.0",​
Line 203: Line 223:
  
 Response: Response:
-<​code ​js>+<​code ​java>
 { {
     "​jsonrpc":​ "​2.0",​     "​jsonrpc":​ "​2.0",​
Line 234: Line 254:
  
 Request: Request:
-<​code ​js>+<​code ​java>
 { {
     "​jsonrpc":​ "​2.0",​     "​jsonrpc":​ "​2.0",​
Line 252: Line 272:
  
 Response: Response:
-<​code ​js>+<​code ​java>
 { {
     "​jsonrpc":​ "​2.0",​     "​jsonrpc":​ "​2.0",​
Line 279: Line 299:
  
 Request: Request:
-<​code ​js>+<​code ​java>
 { {
     "​jsonrpc":​ "​2.0",​     "​jsonrpc":​ "​2.0",​
Line 300: Line 320:
  
 Response: Response:
-<​code ​js>+<​code ​java>
 { {
     "​jsonrpc":​ "​2.0",​     "​jsonrpc":​ "​2.0",​
Line 317: Line 337:
                 "​os":​ "Linux Mint"                 "​os":​ "Linux Mint"
             }             }
 +        }
 +    ],
 +    "​id":​ 1
 +}
 +</​code>​
 +
 +=== Searching by host tags ===
 +
 +Retrieve hosts that have tag "Host name" equal to "Linux server"​.
 +
 +Request:
 +<code java>
 +{
 +    "​jsonrpc":​ "​2.0",​
 +    "​method":​ "​host.get",​
 +    "​params":​ {
 +        "​output":​ ["​hostid"​],​
 +        "​selectTags":​ "​extend",​
 +        "​evaltype":​ 0,
 +        "​tags":​ [
 +            {
 +                "​tag":​ "Host name",
 +                "​value":​ "Linux server",​
 +                "​operator":​ 1
 +            }
 +        ]
 +    },
 +    "​auth":​ "​7f9e00124c75e8f25facd5c093f3e9a0",​
 +    "​id":​ 1
 +}
 +</​code>​
 +
 +Response:
 +<code java>
 +{
 +    "​jsonrpc":​ "​2.0",​
 +    "​result":​ [
 +        {
 +            "​hostid":​ "​10085",​
 +            "​tags":​ [
 +                {
 +                    "​tag":​ "Host name",
 +                    "​value":​ "Linux server"​
 +                },
 +                {
 +                    "​tag":​ "​OS",​
 +                    "​value":​ "RHEL 7"
 +                }
 +            ]
 +        }
 +    ],
 +    "​id":​ 1
 +}
 +</​code>​
 +
 +Retrieve hosts that have these tags not only on host level but also in their linked parent templates.
 +
 +Request:
 +<code java>
 +{
 +    "​jsonrpc":​ "​2.0",​
 +    "​method":​ "​host.get",​
 +    "​params":​ {
 +        "​output":​ ["​name"​],​
 +        "​tags":​ [{"​tag":​ "​A",​ "​value":​ "​1",​ "​operator":​ "​0"​}],​
 +        "​inheritedTags":​ true
 +    },
 +    "​auth":​ "​038e1d7b1735c6a5436ee9eae095879e",​
 +    "​id":​ 1
 +}
 +</​code>​
 +
 +Response:
 +<code java>
 +{
 +    "​jsonrpc":​ "​2.0",​
 +    "​result":​ [
 +        {
 +            "​hostid":​ "​10623",​
 +            "​name":​ "PC room 1"
 +        },
 +        {
 +            "​hostid":​ "​10601",​
 +            "​name":​ "​Office"​
 +        }
 +    ],
 +    "​id":​ 1
 +}
 +</​code>​
 +
 +=== Searching host with tags and template tags ===
 +
 +Retrieve a host with tags and all tags that are linked to parent templates.
 +
 +Request:
 +<code java>
 +{
 +    "​jsonrpc":​ "​2.0",​
 +    "​method":​ "​host.get",​
 +    "​params":​ {
 +        "​output":​ ["​name"​],​
 +        "​hostids":​ 10502,
 +        "​selectTags":​ ["​tag",​ "​value"​],​
 +        "​selectInheritedTags":​ ["​tag",​ "​value"​]
 +    },
 +    "​auth":​ "​038e1d7b1735c6a5436ee9eae095879e",​
 +    "​id":​ 1
 +}
 +</​code>​
 +
 +Response:
 +<code java>
 +{
 +    "​jsonrpc":​ "​2.0",​
 +    "​result":​ [
 +        {
 +            "​hostid":​ "​10502",​
 +            "​name":​ "​Desktop",​
 +            "​tags":​ [
 +                {
 +                    "​tag":​ "​A",​
 +                    "​value":​ "​1"​
 +                }
 +            ],
 +            "​inheritedTags":​ [
 +                {
 +                    "​tag":​ "​B",​
 +                    "​value":​ "​2"​
 +                }
 +            ]
 +        }
 +    ],
 +    "​id":​ 1
 +}
 +</​code>​
 +
 +=== Searching hosts by problem severity ===
 +
 +Retrieve hosts that have "​Disaster"​ problems.
 +
 +Request:
 +<code java>
 +{
 +    "​jsonrpc":​ "​2.0",​
 +    "​method":​ "​host.get",​
 +    "​params":​ {
 +        "​output":​ ["​name"​],​
 +        "​severities":​ 5
 +    },
 +    "​auth":​ "​038e1d7b1735c6a5436ee9eae095879e",​
 +    "​id":​ 1
 +}
 +</​code>​
 +
 +Response:
 +<code java>
 +{
 +    "​jsonrpc":​ "​2.0",​
 +    "​result":​ [
 +        {
 +            "​hostid":​ "​10160",​
 +            "​name":​ "​Zabbix server"​
 +        }
 +    ],
 +    "​id":​ 1
 +}
 +</​code>​
 +
 +Retrieve hosts that have "​Average"​ and "​High"​ problems.
 +
 +Request:
 +<code java>
 +{
 +    "​jsonrpc":​ "​2.0",​
 +    "​method":​ "​host.get",​
 +    "​params":​ {
 +        "​output":​ ["​name"​],​
 +        "​severities":​ [3, 4]
 +    },
 +    "​auth":​ "​038e1d7b1735c6a5436ee9eae095879e",​
 +    "​id":​ 1
 +}
 +</​code>​
 +
 +Response:
 +<code java>
 +{
 +    "​jsonrpc":​ "​2.0",​
 +    "​result":​ [
 +        {
 +            "​hostid":​ "​20170",​
 +            "​name":​ "​Database"​
 +        },
 +        {
 +            "​hostid":​ "​20183",​
 +            "​name":​ "​workstation"​
         }         }
     ],     ],
Line 325: Line 541:
 ==== See also ==== ==== See also ====
  
-  * [[getobjects|host.getobjects]] 
   * [[manual:​api:​reference:​hostgroup:​object#​host_group|Host group]]   * [[manual:​api:​reference:​hostgroup:​object#​host_group|Host group]]
   * [[manual:​api:​reference:​template:​object#​template|Template]]   * [[manual:​api:​reference:​template:​object#​template|Template]]
   * [[manual:​api:​reference:​usermacro:​object#​hosttemplate_level_macro|User macro]]   * [[manual:​api:​reference:​usermacro:​object#​hosttemplate_level_macro|User macro]]
   * [[manual:​api:​reference:​hostinterface:​object#​host_interface|Host interface]]   * [[manual:​api:​reference:​hostinterface:​object#​host_interface|Host interface]]
 +
 ==== Source ==== ==== Source ====
  
-CHost::​get() in //frontends/​php/​include/​classes/​api/​services/​CHost.php//​.+CHost::​get() in //ui/​include/​classes/​api/​services/​CHost.php//​.