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 [2014/09/26 11:21]
sasha Links adapted because of a move operation
manual:api:reference:host:get [2019/07/10 08:49]
martins-v some reformatting
Line 41: Line 41:
 |withInventory|flag|Return only hosts that have inventory data.| |withInventory|flag|Return only hosts that have inventory data.|
 ^  ||| ^  |||
-|selectGroups|query|Return ​the host groups that the host belongs to in the ''​groups''​ property. | +|selectGroups|query|Return ​a ''​[[:​manual/​api/​reference/​hostgroup/​object|groups]]''​ property with host groups that the host belongs to.  
-|selectApplications|query|Return ​the applications from the host in the ''​applications''​ property. \\ \\ Support ​''​count''​. | +|selectApplications|query|Return ​an ''​[[:​manual/​api/​reference/​application/​object|applications]]''​ property ​with host applications.\\ \\ Supports ​''​count''​. | 
-|selectDiscoveries|query|Return ​the low level discoveries from the host in the ''​discoveries''​ property. \\ \\ Supports ''​count''​. | +|selectDiscoveries|query|Return ​''​[[:​manual/​api/​reference/​discoveryrule/​object|discoveries]]''​ property ​with host low-level discovery rules.\\ \\ Supports ''​count''​. | 
-| selectDiscoveryRule | query | Return the LLD rule that created the host in the ''​discoveryRule''​ property. | +|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) 
-|selectGraphs|query|Return ​the graphs from the host in the ''​graphs''​ property. \\ \\ Supports ''​count''​. | +|selectGraphs|query|Return ​''​[[:​manual/​api/​reference/​graph/​object|graphs]]''​ property ​with host graphs.\\ \\ Supports ''​count''​. | 
-| 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 ​''​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''​. |+|selectTriggers|query|Return ​''​[[:​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 61:
 |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 84:
  
 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 102:
  
 Response: Response:
-<​code ​js>+<​code ​java>
 { {
     "​jsonrpc":​ "​2.0",​     "​jsonrpc":​ "​2.0",​
Line 139: Line 138:
             "​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 178:
             "​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 195:
  
 Request: Request:
-<​code ​js>+<​code ​java>
 { {
     "​jsonrpc":​ "​2.0",​     "​jsonrpc":​ "​2.0",​
Line 203: Line 214:
  
 Response: Response:
-<​code ​js>+<​code ​java>
 { {
     "​jsonrpc":​ "​2.0",​     "​jsonrpc":​ "​2.0",​
Line 234: Line 245:
  
 Request: Request:
-<​code ​js>+<​code ​java>
 { {
     "​jsonrpc":​ "​2.0",​     "​jsonrpc":​ "​2.0",​
Line 252: Line 263:
  
 Response: Response:
-<​code ​js>+<​code ​java>
 { {
     "​jsonrpc":​ "​2.0",​     "​jsonrpc":​ "​2.0",​
Line 279: Line 290:
  
 Request: Request:
-<​code ​js>+<​code ​java>
 { {
     "​jsonrpc":​ "​2.0",​     "​jsonrpc":​ "​2.0",​
Line 300: Line 311:
  
 Response: Response:
-<​code ​js>+<​code ​java>
 { {
     "​jsonrpc":​ "​2.0",​     "​jsonrpc":​ "​2.0",​
Line 325: Line 336:
 ==== 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/​api/​classes/​CHost.php//​.+CHost::​get() in //​frontends/​php/​include/classes/​api/​services/​CHost.php//​.