Documentation
Table of Contents
Акциони објекат
Следећи објекти су директно повезани са action API-јем.
Акција
Акциони објекат има следећа својства.
| Property | Type | Description |
|---|---|---|
| actionid | ID | ID акције. Property behavior: - само за читање - обавезно за операције ажурирања |
| esc_period | string | Подразумевано трајање корака операције. Мора бити најмање 60 секунди. Прихвата секунде, временску јединицу са суфиксом или кориснички макро. Property behavior: - подржано ако је eventsource подешен на "догађај креиран окидачем", "интерни догађај" или "догађај креиран при ажурирању статуса услуге" |
| eventsource | integer | Тип догађаја које ће акција обрађивати. Погледајте event source property за листу подржаних типова догађаја.Property behavior: - константа - обаезно за операције креирања |
| name | string | Назив акције. Property behavior: - обавезно за креирање операција |
| status | integer | Одређује да ли је акција омогућена или онемогућена. Могуће вредности: 0 - (подразумевано) омогућено; 1 - онемогућено. |
| pause_symptoms | integer | Одређује да ли да треба паузирати ескалацију ако је догађај симптом. Могуће вредности: 0 - Немојте паузирати ескалацију због проблема са симптомима; 1 - (подразумевано) Паузирајте ескалацију због проблема са симптомима. Понашање својства: - подржано ако је eventsource подешен на "догађај креиран окидачем " |
| pause_suppressed | integer | Да ли паузирати ескалацију током периода одржавања или не. Могуће вредности: 0 - Не паузирај ескалацију; 1 - (подразумевано) Паузирај ескалацију. Property behavior: - подржано ако је eventsource подешен на "догађај креиран окидачем" |
| notify_if_canceled | integer | Да ли да се обавештава када је ескалација отказана. Могуће вредности: 0 - Не обавештавај када је ескалација отказана; 1 - (подразумевано) Обавести када је ескалација отказана. Property behavior: - подржано ако је eventsource подешен на "догађај креиран окидачем" |
Операција акције
Објекат операције акције дефинише операцију која ће бити изведена када се нека акција изврши. Има следећа својства.
| Property | Type | Description |
|---|---|---|
| operationtype | integer | Тип операције. Могуће вредности: 0 - пошаљи поруку; 1 - глобални скрипт; 2 - додај домаћина; 3 - уклони домаћина; 4 - додај у групу домаћина; 5 - уклони из групе домаћина; 6 - шаблон везе; 7 - шаблон за престанак везе; 8 - омогући домаћина; 9 - онемогући домаћина; 10 - подесите режим инвентара домаћина; 13 - додајте ознаке домаћина; 14 - уклоните ознаке домаћина. Могуће вредности ако је eventsource од Action object подешен на "догађај креиран окидачем" или "догађај креиран при ажурирању статуса услуге":0 – "пошаљи поруку"; 1 – "глобални скрипт". Могуће вредности ако eventsource за Action object је подешен на "интерни догађај":0 - "пошаљи поруку". Property behavior: - обавезно |
| esc_period | string | Трајање корака ескалације у секундама. Мора бити дуже од 60 секунди. Прихвата секунде, временску јединицу са суфиксом или кориснички макро. Ако је подешено на 0 или 0с, користиће се подразумевани период ескалације радње. Подразумевано: 0с. Property behavior: - подржано ако је eventsource од Action object подешен на "догађај креиран окидачем", "интерни догађај" или "догађај креиран при ажурирању статуса услуге" |
| esc_step_from | integer | Корак за почетак ескалације на. Подразумевано: 1. Property behavior: - подржано ако је eventsource од Action object подешен на "догађај креиран окидачем", "интерни догађај" или "догађај креиран при ажурирању статуса услуге" |
| esc_step_to | integer | Корак за завршетак ескалације на. Подразумевано: 1. Property behavior: - подржано ако је eventsource од Action object подешен на "догађај креиран окидачем", "интерни догађај" или "догађај креиран при ажурирању статуса услуге" |
| evaltype | integer | Метода процене услова операције. Могуће вредности: 0 - (подразумевано) И / ИЛИ;<бр>1 - И; 2 - ИЛИ. |
| opcommand | object | Глобална скрипта за извршавање. Глобална скрипта мора имати дефинисано својство scriptid.Property behavior : - обавезно ако је operationtype подешен на "глобални скрипт" |
| opcommand_grp | array | Групе домаћина за покретање глобалних скрипти. Групе домаћина морају имати дефинисано својство groupid.Property behavior: - обавезно ако је operationtype подешен на "глобални скрипт" и opcommand_hst није подешен |
| opconditions | array | Домаћин за покретање глобалних скрипти. Домаћини морају имати дефинисано својство hostid.Property behavior: - обавезно ако је operationtype подешен на "глобални скрипт" и opcommand_grp није подешен |
| opconditions | array | Операцијски услови који се користе за акције окидача. Објекат услова операције је described in detail below. |
| opgroup | array | Групе домаћина за додавање домаћина. Групе домаћина морају имати дефинисано својство groupid.Property behavior: - обавезно ако је operationtype подешен на "додај у групу домаћина" или "уклони из групе домаћина" |
| opmessage | object | Објекат који садржи податке о поруци послатој операцијом. Објекат поруке операције је described in detail below. Property behavior: - обавезно ако је operationtype подешен на "пошаљи поруку" |
| opmessage_grp | array | Групе корисника којима се шаљу поруке. Корисничке групе морају имати дефинисано својство usrgrpid.Property behavior: - обавезно ако је operationtype подешен на "пошаљи поруку" и opmessage_usr није подешен |
| opmessage_usr | array | Корисници којима ће слати поруке. Корисници морају имати дефинисано својство userid.Property behavior: - обавезно ако је operationtype подешен на "пошаљи поруку" и opmessage_grp није подешен |
| optemplate | array | Шаблони за повезивање са домаћинима. Шаблони морају имати дефинисано својство templateid.Property behavior: - обавезно ако је operationtypeподешен на "шаблон везе" или "шаблон за престанак везе" |
| opinventory | object | Режим инвентара који је подешен за домаћина. Инвентар мора имати дефинисано својство inventory_mode.Property behavior : - обавезно ако је operationtype подешен на "set host inventory mode" |
| optag | array | Ознаке домаћина за додавање или уклањање. Ознаке морају имати дефинисано својство tag. Својство value је опционо. Property behavior: - подржано ако је operationtype подешен на "додај ознаке домаћина" или "уклони ознаке домаћина". |
Порука о операцији акције
Објекат операције слања поруке садржи податке о поруци која ће бити послат операцијом. Има следећа својства.
| Property | Type | Description |
|---|---|---|
| default_msg | integer | Да ли ће да се користи подразумевани текст и наслов поруке акције. Могуће вредности: 0 - користи податке из операције; 1 - (подразумевано) користи податке из типа медија. |
| mediatypeid | ID | ID типа медија који ће се користити за слање поруке. Понашање својства: - подржано ако је operationtype за Action operation object, Action recovery operation object или Action update operation object је постављен на " пошаљи поруку", или ако је operationtype за Action update operation object подешен на "обавести све укључене" |
| message | string | Текст поруке о операцији. Property behavior: - подржано ако је default_msg подешен на "користи податке од операције" |
| subject | string | Наслов поруке операције. Property behavior: - подржано ако је default_msg подешен на "користи податке од операције" |
Услов за операцију акције
Објекат услова операције акције дефинише услов који мора бити испуњен да би се извршила тренутна операција. Има следећа својства.
| Property | Type | Description |
|---|---|---|
| conditiontype | integer | Тип услова. Могуће вредности: 14 - догађај је потврђен. Property behavior:< br>- обавезно |
| value | string | Вредност за поређење. Property behavior: - обавезно |
| operator | integer | Условни оператор. Могуће вредности: 0 - (подразумевано) = |
Следећи оператори и вредности су подржани за сваку операцију тип стања.
|Condition|Condition name|Supported operators|Expected value| |--------|--------------|-------------------|---- ----------| |14|Догађај је потврђен|=|Да ли је догађај потврђен.
Могуће вредности:
0 - није потврђено;
1 - потврђено.|
Операција опоравка акције
Објекат операције опоравка дефинише операцију која ће се извршити када се проблем реши. Операције опоравка су могуће само за окидаче, интерне и сервисне акције. Имају следећа својства.
| Property | Type | Description |
|---|---|---|
| operationtype | integer | Тип операције. Могуће вредности ако је eventsource од Action object подешен на "догађај креиран окидачем" или "догађај креиран при ажурирању статуса сервиса": 0 - пошаљи поруку; 1 - глобална скрипта; 11 - обавести све укључене. Могуће вредности ако је eventsource за Action object подешен на " интерни догађај":0 - пошаљи поруку; 11 - обавести све укључене. Property behavior: - обавезно |
| opcommand | object | Глобална скрипта за извршавање. Глобална скрипта мора имати дефинисано својство scriptid.Property behavior : - обавезно ако је operationtype подешен на "глобални скрипт" |
| opcommand_grp | array | Групе домаћина за покретање глобалних скрипти. Групе домаћина морају имати дефинисано својство groupid.Property behavior: - обавезно ако је eventsource за Action object подешен на "догађај креиран окидачем", а operationtype је подешен на "глобални скрипт" и opcommand_grp није подешен |
| opcommand_hst | array | Домаћин за покретање глобалних скрипти. Домаћини морају имати дефинисано својство hostid.Property behavior: - обавезно ако је eventsource за Action object подешен на "догађај креиран окидачем", а operationtype је подешен на "глобални скрипт", а opcommand_grp није постављен |
| opmessage | објекат | Објекат који садржи податке о поруци послатој операцијом опоравка. Објекат поруке операције је детаљно описан горе. Property behavior: - обавезно ако је operationtype подешен на "пошаљи поруку" |
| opmessage_grp | object | Групе корисника којима се шаљу поруке. Корисничке групе морају имати дефинисано својство usrgrpid.Property behavior: - обавезно ако је operationtype подешен на "пошаљи поруку" и opmessage_usr није подешен |
| opmessage_usr | array | Корисници којима се шаљу поруке. Корисници морају имати дефинисано својство userid.Property behavior: - обавезно је ако је operationtype подешен на "пошаљи поруку" и opmessage_grp није подешен |
Операција ажурирања акције
Објекат операције ажурирања дефинише операцију која ће се извршити када се проблем ажурира (коментарише, потврди, промени озбиљност или ручно затвори). Операције ажурирања су могуће само за акције окидача и сервиса. Имају следећа својства.
| Property | Type | Description |
|---|---|---|
| operationtype | integer | Тип операције. Могуће вредности: 0 - пошаљи поруку; 1 - глобална скрипта; 12 - обавести све укључене. Property behavior: - обавезно |
| opcommand | object | Глобална скрипта за извршавање. Глобална скрипта мора имати дефинисано својство scriptid.Property behavior : - обавезно ако је operationtypeподешен на "глобални скрипт" |
| opcommand_grp | array | Групе домаћина за покретање глобалних скрипти. Групе домаћина морају имати дефинисано својство groupid.Property behavior: - обавезно ако је eventsource за Action object подешен на "догађај креиран окидачем", а operationtype је подешен на "глобални скрипт" и opcommand_hst није подешен |
| opcommand_hst | array | Домаћин за покретање глобалних скрипти. Домаћини морају имати дефинисано својство hostid.Property behavior: - обавезно ако је eventsource за Action object подешен на "догађај креиран окидачем", а operationtype је подешен на "глобални скрипт", а opcommand_grp није постављен |
| opmessage | object | Објекат који садржи податке о поруци посланој операцијом ажурирања. Објекат поруке операције је described in detail above. |
| opmessage_grp | array | Групе корисника којима се шаљу поруке. Корисничке групе морају имати дефинисано својство usrgrpid.Property behavior: - обавезно ако је operationtype подешен на "пошаљи поруку" и opmessage_usr није подешен |
| opmessage_usr | array | Корисници којима се шаљу поруке. Корисници морају имати дефинисано својство userid.Property behavior: - обавезно ако је operationtype подешен на "пошаљи поруку" и opmessage_grp није подешен |
Филтер акције
Објекат филтера акција дефинише скуп услова који морају бити испуњени да би се извршиле конфигурисане операције акције. Има следећа својства.
| Property | Type | Description |
|---|---|---|
| conditions | array | Set of filter conditions који се користи за филтрирање резултата. Услови ће бити сортирани по редоследу њиховог постављања у формулу. Property behavior: - обавезно |
| evaltype | цео број | Метод процене услова филтрирања. Могуће вредности: 0 - и/или; 1 - и; 2 - или; 3 - прилагођени израз. Понашање својства: - обавезно |
| eval_formula | integer | Генерисани израз који ће се користити за процену услова филтера. Израз садржи ID-ијеве који упућују на специфичне услове филтера по својој formulaid. Вредност eval_formula је једнака вредностиformula за филтере са прилагођеним изразом.Property behavior: - * само за читање* |
| formula | string | Кориснички дефинисан израз који ће се користити за процену услова филтера са прилагођеним изразом. Израз мора да садржи ID-ијеве који упућују на специфичне услове филтера по својој formulaid. ID-ијеве који су коришћени у изразу морају се тачно подударати са онима дефинисаним у условима филтера: ниједан услов не може остати неискоришћен или изостављен.Property behavior:<br >- обавезно ако је evaltype подешен на "прилагођени израз" |
Услов филтера акције
Објекат услова филтера акције дефинише одређени услов који мора бити проверен пре покретања операција акције.
| Property | Type | Description |
|---|---|---|
| conditiontype | integer | Тип услова. Могуће вредности ако је eventsource од Action object подешен на "догађај креиран од стране окидача":0 - група домаћина; 1 - домаћин; 2 - окидач; 3 - назив догађаја; 4 - озбиљност окидача; 6 - временски период; 13 - шаблон домаћина; 16 - проблем је потиснут; 25 - ознака догађаја; 26 - вредност ознаке догађаја. Могуће вредности ако је eventsource од Action object подешен на "догађај креиран правилом откривања" :7 - IP адреса домаћина; 8 - тип откривене услуге; 9 - порт откривене услуге;< br>10 - статус откривања; 11 - трајање рада или прекида; 12 - примљена вредност; 18 - правило откривања; 19 - верификација откривања; 20 - прокси;<br >21 - објекат откривања. Могуће вредности ако је eventsource од Action object подешен на "догађај креиран аутоматском регистрацијом активног агента" :20 - прокси; 22 - име домаћина; 24 - метаподаци домаћина . Могуће вредности ако је eventsource oд Action object подешен на "унутрашњи догађај":0 - група домаћина; 1 - домаћин; 13 - шаблон домаћина; 23 - тип догађаја; 25 - ознака догађаја; 26 - вредност догађаја. Могуће вредности ако је eventsource oд Action object подешен на "догађај креиран ажурирањем статуса услуге":25 - ознака догађаја; 26 - вредност ознаке догађаја; 27 - сервис;<br >28 - назив сервиса. Понашање својства: - обавезно |
| value | string | Вредност за поређење. Property behavior: - обавезно |
| value2 |
string | Секундарна вредност за поређење. Property behavior је: - обавезна ако је eventsource од Action object подешен на "догађај креиран окидачем", conditiontype је подешен на било коју вредност акција окидача, тип услова (види доле) је "26"- обавезан је ако је eventsource од Action object подешен на "унутрашњи догађај", conditiontype је подешен на било коју од вредности унутрашњих акција и тип услова је ( види доле) "26"- обавезан ако је eventsource одAction object подешен на било коју могућу вредност сервисних акција и типа услова (види доле) "26" |
| formulaid | string | Произвољно јединсвен ID се користи за референцу услова у прилагођеном изразу. Може садржати само велика слова. ID мора бити дефинисам од стране корисника при модификацији услова филтера, али ће бити генерисам поново када се захтева |
| operator | integer | Оператор услова. Могуће вредности: 0 - (подразумевано) једнако; 1 - није једнако; 2 - садржи; 3 - не садржи; 4 - у; 5 - веће или једнако; 6 - мање или једнако; 7 - није у; 8 - подудара се; 9 - не подудара се; 10 - Да; 11 - Не. |
За боље разумевање како користити филтере са различитим типовима израза, погледајте примере на странама метода action.get и action.create.
Следећи оператори и услови су подржани за сваки тип услова.
| Condition | Condition name | Supported operators | Expected value | |
|---|---|---|---|---|
| 0 | Host group | једнако, није једнако |
ID групе домаћина. | |
| 1 | Host | једнако, није једнако |
ID домаћина. | |
| 2 | Trigger | једнако, није једнако |
ID окидача. | |
| 3 | Event name | садржи, не садржи |
Назив догађаја. | |
| 4 | Trigger severity | једнако, није једнако, веће или једнако, мање или једнако |
Озбиљност окидача. Погледајте на trigger severity property за листу подржаних својстава окидача. |
|
| 5 | Trigger value | једнако | Вредност окидача. Погледајте на trigger value property за вредност подржаних својстава окидача. |
|
| 6 | Time period | у, није у | Време када је догађај покренут као time period. | |
| 7 | Host IP | једнако, није једнако |
Један или више IP опсега за проверу, одвојених запетама. Погледајте network discovery configuration секцију за више информација о подржаним форматима IP опсега. | |
| 8 | Discovered service type | једнако, није једнако |
Тип откривеног сервиса. Тип сервиса одговара типу провере откривања коришћене за откривање сервиса. Погледајте на discovery check type property за листу подржаних типова. |
|
| 9 | Discovered service port | једнако, није једнако |
Један или више портова у распону, одвојених запетама. | |
| 10 | Discovery status | једнако | Статус откривеног објекта. Могуће вредности: 0 - домаћин или сервис активни; 1 - домаћин или сервис недоступни; 2 - домаћин или сулуга откривени; 3 - домаћин или сервис изгубљени. |
|
| 11 | Uptime or downtime duration | веће или једнако, мање или једнако |
Време које открива колико је откривени објекат у тренутном стању, у секундама. | |
| 12 | Received values | једнако, различито, веће или једнако, мање или једнако, садржи, не садржи |
Вредност враћена приликом провере откривања Zabbix агента, SNMPv1, SNMPv2 или SNMPv3. | |
| 13 | Host template | једнако, није једнако |
ID повезаног шаблона. | |
| 16 | Problem is suppressed | Да, Не | Није потребна вредност : коришћење оператора "Да" значи да је оператор потиснут, "Не" - није потиснут. | |
| 18 | Discovery rule | једнако, није једнако |
ID правила откривања. | |
| 19 | Discovery check | једнако, није једнако |
ID провере откривања. | |
| 20 | Proxy | једнако, није једнако |
ID проксија. | |
| 21 | Discovery object | једнако | Тип објекта који је покренуо догађај откривања. Могуће вредности: 1 - откривен домаћин; 2 - откривена услуга. |
|
| 22 | Host name | садржи, не садржи, поклапа се, не поклапа се |
Име домаћина. Подржано је коришћење регуларних израза код оператора поклапа се и не поклапа се у ауторегистрацијским условима. |
|
| 23 | Event type | једнако | Специфичан унутрашњи догађај. Могуће вредности: 0 - ставка у "неподржаном" стању ; 1 - ставка у "нормалном" стању; 2 - Правило Низак-Ниво-Откривања у "неподржаном" стању ; 3 - Правило Низак-Ниво-Откривања у "нормалном" стању ; 4 - Окидач у "непознатом" стању ; 5 - Окидач у "нормалном" стању. |
|
| 24 | Host metadata | садржи, не садржи, поклапа се, не поклапа се |
Метаподаци аутоматски регистрованог домаћина. Подржано је коришћење регуларних израза за операторе поклапа се и не поклапа се. |
|
| 25 | Tag | једнако, није једнако, садржи, не садржи |
Ознака догађаја. | |
| 26 | Tag value | једнако, није једнако, садржи, не садржи |
Вредност ознаке догађаја. | |
| 27 | Service | садржи, не садржи |
ID сервиса. | |
| 28 | Service name | садржи, не садржи |
Назив сервиса. |