host.get

Опис

integer/array host.get(object parameters)

Метода омогућава преузимање хостова према датим параметрима.

Ова метода је доступна корисницима било ког типа. Дозволе за позивање методе могу се опозвати у подешавањима улоге корисника. Погледајте Userroles за више информација.

Параметри

(object) Параметри који дефинишу жељени излаз.

Метод подржава следеће параметре.

Parameter Type Description
groupids ID/array Врати само домаћине који припадају датим групама.
dserviceids ID/array Врати само домаћине који су повезани са датим откривеним услугама.
graphids ID/array Врати само домаћине који имају дате графиконе.
hostids ID/array Врати само домаћине са датим ID-ијевима домаћина.
httptestids ID/array Врати само домаћине који имају дате веб провере.
interfaceids ID/array Врати само домаћине који користе дате интерфејсе.
itemids ID/array Врати само домаћине који имају дате ставке.
maintenanceids ID/array Врати само домаћине на које утиче дато одржавање.
monitored_hosts flag Врати само надгледане домаћине.
proxyids ID/array Врати само домаћине које надгледају дати проксији.
proxy_groupids ID/array Врати само домаћине које надгледају дате прокси групе.
templated_hosts flag Врати и домаћине и шаблоне.
templateids ID/array Врати само домаћине који су повезани са датим шаблонима.
triggerids ID/array Врати само домаћине који имају дате окидаче.
with_items flag Врати само домаћине који имају ставке.

Замењује параметре with_monitored_items и with_simple_graph_items.
with_item_prototypes flag Врати само домаћине који имају прототипове ставке.<br
Замењује параметар with_simple_graph_item_prototypes.
with_simple_graph_item_prototypes flag Врати само домаћине који имају прототипове ставки, који су омогућени за креирање и имају нумерички тип информација.
with_graphs flag Врати само домаћине који имају графиконе.
with_graph_prototypes flag Врати само домаћине који имају прототипове графикона.
with_httptests flag Врати само домаћине који имају веб провере.

Замењује параметар with_monitored_httptests.
with_monitored_httptests flag Врати само домаћине који су омогућили веб провере.
with_monitored_items flag Врати само хостове који су омогућили ставке.
<br >Замењује параметар with_simple_graph_items.
with_monitored_triggers flag Врати само домаћине који имају омогућене окидаче. Све ставке које се користе у покретачу такође морају бити омогућене.
with_simple_graph_items flag Врати само домаћине који имају ставке са нумеричким типом информација.
with_triggers flag Врати само домаћине који имају окидачи.

Замењује параметар with_monitored_triggers.
withProblemsSuppressed boolean Врати домаћине који имају потиснуте проблеме.

Могуће вредности:
null - (подразумевано) сви домаћини;
true - само домаћини са потиснутим проблемима;
false - само домаћини са неприкривеним проблемима.
evaltype integer Правила за претрагу ознака.

Могуће вредности:<br >0 - (подразумевано) И/Или;
2 - Или.
severities integer/array Врати домаћине који имају само проблеме са датим озбиљностима. Примењује се само ако је проблемски објекат окидач.
tags object/array Врати само домаћине са датим ознакама. Тачно подударање по ознаци и претрага која се разликује од великих или малих слова по вредности ознаке у зависности од вредности оператора.
Формат: [{"tag": "<tag>", "value": "<value>", "operator": "<operator>"}, ...].
Празан низ враћа све домаћине.

Могуће вредности оператора:
0 - (подразумевано) Садржи;<br >1 - Једнако;
2 - Није као;
3 - Није једнако;
4 - Постоји;
5 - Не постоји.
inheritedTags boolean Врати домаћине који су дали ознаке такође у свим својим повезаним шаблонима. Подразумевано:

Могуће вредности:
true - повезани шаблони такође морају да имају дате ознаке;
false - (подразумевано) повезане ознаке шаблона се занемарују.
selectDiscoveries query Врати својство discoveries са правилима откривања ниског нивоа домаћина.

Подржава count.
selectDiscoveryRule query Врати својство discoveryRule` са правилом откривања ниског нивоа које је креирало домаћина (из прототипа домаћина у VMware мониторингу).
selectGraphs query Врати graphs својство са графовима домаћина.

Подржава count.
selectHostDiscovery query Врати својство hostDiscovery са подацима објекта откривања домаћина.

Објекат откривања домаћина повезује откривеног домаћина са прототипом домаћина или прототипове домаћина са LLD правилом и има следећа својства:
host - (стринг)host of the host prototype;
hostid - (стринг) ID откривеног домаћина или прототипа домаћина;
parent_hostid - (стринг) ID прототипа домаћина од којег је домаћин креиран;
parent_itemid - * (стринг)* ID LLD правила које је креирао откривени домаћин;<br>lastcheck - (временска ознака) време када је домаћин последњи пут откривен;
status - (int) статус откривања домаћина :
0 - (подразумевано) домаћин је откривен,
1 - домаћин више није откривен;
ts_delete - (timestamp) време када ће домаћин који више није откривен бити обрисан ;
ts_disable - (timestamp) време када ће домаћин који више није откривен ће бити онемогућен;
disable_source - (int) индикатор да ли је домаћин онемогућен LLD правилом или ручно :
0 - (подразумевано) онемогућено аутоматски,<бр>1 - онемогућено LLD правилом.
selectHostGroups query Врати hostgroups својство са подацима о групама домаћина којима домаћин припада.
selectHttpTests query Врати својство httpTests са веб сценаријима домаћина.

Подржава count.
selectInterfaces query Врати својство interfaces са интерфејсима домаћина.

Подржава цоунт.
selectInventory query Врати својство inventory са подацима инвентара домаћина.
selectItems query Врати items својство са ставкама домаћина.

Подржава count.
selectMacros query Врати својство macros са макроима домаћина.
selectParentTemplates query Врати својство parentTemplates са templates са којим је домаћин повезан.

Поред поља Template објекта, садржи link_type`` -(integer)начин на који је шаблон повезан са домаћином.<br>Могуће вредности:<br>0 - *(подразумевано)* ручно повезано;<br>1 - аутоматски повезује LLD.<br> <br>Подржаваcount `.
selectDashboards query Врати својство dashboards.

Подржава count.
selectTags query Врати својство tags са ознакама домаћина.
selectInheritedTags query Врати inheritedTags својство са ознакама које се налазе на свим шаблонима који су повезани са домаћином.
selectTriggers query Врати својство triggers са покретачима домаћина.

Подржава count.
selectValueMaps query Врати својство valuemaps` са мапама вредности домаћина.
filter object Врати само оне резултати који се тачно поклапају са датим филтером.

Прихвата објекат, где су кључеви имена својстава, а вредности су или једна вредност или низ вредности за подударање.<бр><бр>Не подржава својства text data type.

Подржава додатна својства: Host interface својства.
limitSelects integer Ограничава број записа које враћају подизбори.

Примењује се на следеће подизборе:
selectParentTemplates - резултати ће бити сортирани по host;
selectInterfaces;
selectItems - сортирано по name;
selectDiscoveries - сортирано по name;
selectTriggers - сортирано по description;
selectGraphs - сортирано по name;
selectDashboards - сортирано по name.
search object Врати резултате који се поклапају са датим шаблоном (неосетљиво на велика и мала слова).

Прихвата објекат , где су кључеви имена својстава, а вредности низови за претраживање. Ако нису дате додатне опције, ово ће извршити претрагу LIKE "%…%".

Подржава само својства string и text data type.<бр><бр>Подржава додатна својства: својства Host interface.
searchInventory object Врати домаћине који имају инвентар подаци који се поклапају са датим шаблоном (неосетљив на велика и мала слова).

Прихвата објекат, где су кључеви имена својстава, а вредности низови за тражење. Ако нису дате додатне опције, ово ће извршити претрагу LIKE "%…%".

Подржава само својства string и text data type.
sortfield string/array Сортирај резултат према датим особинама.

Могуће вредности: hostid, host, name, status.
countOutput boolean Ови параметри који су заједнички за све методе get су детаљно описани у reference commentary.
editable boolean
excludeSearch boolean
limit integer
output query
preservekeys boolean
searchByAny boolean
searchWildcardsEnabled boolean
sortorder string/array
startSearch boolean

Повратне вредности

(integer/array) Враћа било:

  • низ објеката;
  • број преузетих објеката, ако је параметар countOutput коришћен.

Примери

Преузимање података по имену

Преузми све податке о два хоста под називом "Zabbix server" и "Linux server".

Request:

{
     "jsonrpc": "2.0",
     "method": "host.get",
     "params": {
     "filter": {
     "host": [
     "Zabbix server",
     "Linux server"
     ]
     }
     },
     "id": 1
}

Одговор:

{
     "jsonrpc": "2.0",
     "result": [
     {
     "hostid": "10160",
     "proxyid": "0",
     "host": "Zabbix 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": "Zabbix server",
     "flags": "0",
     "description": "The Zabbix monitoring server.",
     "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
}

Преузимање група домаћина

Преузми групе домаћина чији је домаћин "Zabbix server" члан.

Преузимање група домаћина

Преузми групе домаћина чији је хост "Заббик сервер" члан.

Request:

{
     "jsonrpc": "2.0",
     "method": "host.get",
     "params": {
     "output": ["hostid"],
     "selectHostGroups": "extend",
     "filter": {
     "host": [
     "Zabbix server"
     ]
     }
     },
     "id": 1
}

Одговор:

{
     "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
}

Преузимање повезаних шаблона

Преузмите ID-ијеве и називе шаблона повезаних са домаћином „10084“.

Request:

{
     "jsonrpc": "2.0",
     "method": "host.get",
     "params": {
     "output": ["hostid"],
     "selectParentTemplates": [
     "templateid",
     "name"
     ],
     "hostids": "10084"
     },
     "id": 1
}

Одговор:

{
     "jsonrpc": "2.0",
     "result": [
     {
     "hostid": "10084",
     "parentTemplates": [
     {
     "name": "Linux",
     "templateid": "10001"
     },
     {
     "name": "Zabbix Server",
     "templateid": "10047"
     }
     ]
     }
     ],
     "id": 1
}

Преузимање домаћина по шаблону

Преузми домаћине са којима је повезан шаблон „10001“ (Linux by Zabbix agent).

Request:

{
     "jsonrpc": "2.0",
     "method": "host.get",
     "params": {
     "output": ["hostid", "name"],
     "templateids": "10001"
     },
     "id": 1
}

Одговор:

{
     "jsonrpc": "2.0",
     "result": [
     {
     "templateid": "10001",
     "hosts": [
     {
     "hostid": "10084",
     "name": "Zabbix server"
     },
     {
     "hostid": "10603",
     "name": "Host 1"
     },
     {
     "hostid": "10604",
     "name": "Host 2"
     }
     ]
     }
     ],
     "id": 1
}

Претраживање према подацима инвентара домаћина

Преузми домаћине који садрже „ Linux“ у пољу „ OS“ инвентара домаћина.

Request:

{
     "jsonrpc": "2.0",
     "method": "host.get",
     "params": {
     "output": [
     "host"
     ],
     "selectInventory": [
     "os"
     ],
     "searchInventory": {
     "os": "Linux"
     }
     },
     "id": 1
}

Одговор:

{
     "jsonrpc": "2.0",
     "result": [
     {
     "hostid": "10084",
     "host": "Zabbix server",
     "inventory": {
     "os": "Linux Ubuntu"
     }
     },
     {
     "hostid": "10107",
     "host": "Linux server",
     "inventory": {
     "os": "Linux Mint"
     }
     }
     ],
     "id": 1
}

Претраживање по ознакама домаћина

Преузми домаћине који имају ознаку "host-name" једнаку "linux-server".

Захтев:

{
     "jsonrpc": "2.0",
     "method": "host.get",
     "params": {
      "output": ["hostid"],
     "selectTags": "extend",
     "evaltype": 0,
     "tags": [
     {
     "tag": "host-name",
     "value": "linux-server",
     "operator": 1
     }
     ]
     },
     "id": 1
}

Одговор:

{
     "jsonrpc": "2.0",
     "result": [
     {
     "hostid": "10085",
     "tags": [
     {
     "tag": "host-name",
     "value": "linux-server"
     },
     {
     "tag": "os",
     "value": "rhel-7"
     }
     ]
     }
     ],
     "id": 1
}

Преузми домаћине који имају ове ознаке не само на нивоу домаћина, већ и у њиховим повезаним родитељским шаблонима.

Request:

{
     "jsonrpc": "2.0",
     "method": "host.get",
     "params": {
     "output": ["name"],
     "tags": [
     {
     "tag": "os",
     "value": "rhel-7",
     "operator": 1
     }
     ],
     "inheritedTags": true
     },
     "id": 1
}

Одговор:

{
     "jsonrpc": "2.0",
     "result": [
     {
     "hostid": "10623",
     "name": "PC room 1"
     },
     {
     "hostid": "10601",
     "name": "Office"
     }
     ],
     "id": 1
}

Претраживање домаћина са ознакама и ознакама шаблона

Преузми домаћина са ознакама и свим ознакама које су повезане са предлошцима родитеља.

Request:

{
     "jsonrpc": "2.0",
     "method": "host.get",
     "params": {
     "output": ["name"],
     "hostids": 10502,
     "selectTags": ["tag", "value"],
     "selectInheritedTags": ["tag", "value"]
     },
     "id": 1
}

Одговор:

{
     "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
}

Претраживање домаћина према озбиљности проблема

Вратите домаћине који имају проблема са „ Disaster“.

Request:

{
     "jsonrpc": "2.0",
     "method": "host.get",
     "params": {
     "output": ["name"],
     "severities": 5
     },
     "id": 1
}

Одговор:

{
     "jsonrpc": "2.0",
     "result": [
     {
     "hostid": "10160",
     "name": "Zabbix server"
     }
     ],
     "id": 1
}

Преузми домаћине који имају "Average" и "High" проблем.

Request:`

{
     "jsonrpc": "2.0",
     "method": "host.get",
     "params": {
     "output": ["name"],
     "severities": [3, 4]
     },
     "id": 1
}

Одговор:

{
     "jsonrpc": "2.0",
     "result": [
     {
     "hostid": "20170",
     "name": "Database"
     },
     {
     "hostid": "20183",
     "name": "workstation"
     }
     ],
     "id": 1
}

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:

{
    "jsonrpc": "2.0",
    "method": "host.get",
    "params": {
        "output": ["hostid"],
        "selectItems": ["itemid","name","status"],
        "filter": {
            "host": [
                "Zabbix server"
            ]
        }
    },
    "id": 1
}

Response:

{
  "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
}

Такође погледајте

Извор

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